Add mongodb_role module #45488

jkramarz · 2018-09-11T13:35:36Z

SUMMARY

mongodb_role module introduced in this pull request provides management capabilities for user-defined roles in MongoDB, enabling users to define custom privileges.

ISSUE TYPE

New Module Pull Request

COMPONENT NAME

mongodb_role

ANSIBLE VERSION

ansible 2.6.3
  config file = /etc/ansible/ansible.cfg
  configured module search path = [u'/home/jkramarz/.ansible/plugins/modules', u'/usr/share/ansible/plugins/modules']
  ansible python module location = /usr/lib/python2.7/site-packages/ansible
  executable location = /usr/bin/ansible
  python version = 2.7.15 (default, May 16 2018, 17:50:09) [GCC 8.1.1 20180502 (Red Hat 8.1.1-1)]

lib/ansible/modules/database/mongodb/mongodb_role.py

webknjaz · 2018-09-11T14:25:47Z

@jkramarz you'll need to fix linter errors to get this merged

Also, if you wish to be a maintainer, self-add to:
https://github.com/ansible/ansible/blob/devel/.github/BOTMETA.yml#L143-L149

webknjaz · 2018-09-12T11:29:53Z

lib/ansible/modules/database/mongodb/mongodb_role.py

+def role_find(module, client, db_name, role, authentication_restrictions_supported):
+    db = client[db_name]
+
+    if authentication_restrictions_supported:


refactor:

additional_kwargs = ( {'showAuthenticationRestrictions': True} if authentication_restrictions_supported else {} ) result = db.command( 'rolesInfo', role, showPrivileges=True, **additional_kwargs )

webknjaz · 2018-09-12T11:31:44Z

lib/ansible/modules/database/mongodb/mongodb_role.py

+    return creds
+
+
+def check_authentication_restrictions_support(client):


better name: is_authentication_restrictions_supported

webknjaz · 2018-09-12T11:32:21Z

lib/ansible/modules/database/mongodb/mongodb_role.py

+    try:
+        with open(config_file) as f:
+            config.readfp(f)
+            creds = dict(


you can probably move this statement outside of with-block

webknjaz · 2018-09-12T11:34:27Z

lib/ansible/modules/database/mongodb/mongodb_role.py

+    try:
+        with open(config_file) as f:
+            config.readfp(f)
+            creds = dict(


also, please use dict literal instead of constuctor ({'key': 'val'} instead of dict(key='val'))

webknjaz · 2018-09-12T11:35:31Z

lib/ansible/modules/database/mongodb/mongodb_role.py

+    config = configparser.RawConfigParser()
+
+    try:
+        with open(config_file) as f:


wrap these pieces of code into two try/except statements to be precise with what you're trapping.

one around with-block (with readfp call) catching IOError

the other one around creds dict constuction catching configparser.NoOptionError

webknjaz · 2018-09-12T11:37:29Z

lib/ansible/modules/database/mongodb/mongodb_role.py

+# MongoDB module specific support methods.
+#
+
+def check_compatibility(module, client):


There's a hanging PR implementing it in a nicer way: https://github.com/ansible/ansible/pull/44110/files#diff-d4702ee9f9f2977f8c82cb5b4e8b0e26R221. You may want to try borrowing some ideas from there.

webknjaz · 2018-09-12T11:40:57Z

lib/ansible/modules/database/mongodb/mongodb_role.py

+    db = client[db_name]
+
+    if authentication_restrictions_supported:
+        result = db.command('createRole',


This snippet looks just like one in role_find. It probably deserves being moved into a reusable function.

webknjaz · 2018-09-12T11:42:38Z

lib/ansible/modules/database/mongodb/mongodb_role.py

+                            )
+
+    if result['ok'] != 1:
+        module.fail_json(msg='rolesInfo failed', exception=traceback.format_exc())


This message is not very informative. Maybe there's some data you'd like to add to the returned result?

webknjaz · 2018-09-12T11:43:03Z

lib/ansible/modules/database/mongodb/mongodb_role.py

+                            roles=roles
+                            )
+
+    if result['ok'] != 1:


Well, this is also very boilerplate, which you could deduplicate.

webknjaz · 2018-09-12T11:44:18Z

lib/ansible/modules/database/mongodb/mongodb_role.py

+            and sorted(current['privileges']) == sorted(privileges) \
+            and sorted(current_restrictions) == sorted(authentication_restrictions)
+    else:
+        return sorted(current['roles']) == sorted(roles) \


This thing is also repeated.

webknjaz · 2018-09-12T11:45:15Z

lib/ansible/modules/database/mongodb/mongodb_role.py

+
+def main():
+    module = AnsibleModule(
+        argument_spec=dict(


Please rewrite dict creation using literals (with curly braces)

webknjaz · 2018-09-12T11:59:42Z

lib/ansible/modules/database/mongodb/mongodb_role.py

+            login_user=dict(default=None),
+            login_password=dict(default=None, no_log=True),
+            login_host=dict(default='localhost'),
+            login_port=dict(default='27017'),


use type='int' here and you won't have to do manual conversion or checking manually

gundalow · 2019-02-19T12:48:36Z

@jkramarz Hi, would you be able to take a look at the suggestions above?

SPR0STO · 2019-05-14T13:40:11Z

Hello
Extremely interested in the ability to manipulate MongoDB roles
When will the module be implemented?

gundalow · 2019-09-03T16:00:30Z

.github/BOTMETA.yml

@@ -141,6 +141,7 @@ files:
  $modules/crypto/: Spredzy
  $modules/crypto/acme/: resmo felixfontein
  $modules/database/influxdb/: kamsz
+  $modules/database/mongodb/mongodb_role.py: jkramarz


Not needed as you are listed in the module's author: list

gundalow · 2019-09-03T16:00:42Z

lib/ansible/modules/database/mongodb/mongodb_role.py

+short_description: Adds or removes a role from a MongoDB database.
+description:
+    - Adds or removes a role from a MongoDB database.
+version_added: "2.8"


Suggested change

version_added: "2.8"

version_added: `2.10`

gundalow · 2020-07-02T18:51:27Z

@jkramarz Hi, the mongodb modules have moved to https://github.com/ansible-collections/community.mongodb could you please raise the PR there

emanuelflp · 2020-07-15T15:44:02Z

Hello guys. Can I continue with this PR? If yes, I will create the PR in the new repo.
@gundalow @jkramarz @webknjaz

gundalow · 2020-07-15T18:20:09Z

@emanuelflp if the PR doesn't exist in the new repo yet, then yes, please proceed. Thanks!

Added mongodb_role module

714a21c

jkramarz force-pushed the feature-module-mongodb_role branch from 4432932 to 714a21c Compare September 11, 2018 13:36

webknjaz removed the needs_triage Needs a first human triage before being processed. label Sep 11, 2018

webknjaz reviewed Sep 11, 2018

View reviewed changes

lib/ansible/modules/database/mongodb/mongodb_role.py Outdated Show resolved Hide resolved

This comment has been minimized.

Sign in to view

ansibot added needs_revision This PR fails CI tests or a maintainer has requested a review/revision of the PR. and removed community_review In order to be merged, this PR must follow the community review workflow. labels Sep 11, 2018

jkramarz added 12 commits September 11, 2018 20:55

reordered copyrights

22e800e

removed not used import

b09515a

expanded imoprt from mongodb_user

a4b9b9d

removed OrderedDict import

1469f6d

fixed PEP8 E225

9bd0c5b

fixed PEP8 E302

cadae2b

removed unnecessary abbreviations

a039e18

limited number of PEP8 E501

753f00c

added version_added meta

ec8989d

added maintainer in BOTMETA

05953c9

wrapped import yaml in try except ImportError

da50116

added missing documentation

9507cf9

This comment has been minimized.

Sign in to view

ansibot added ci_verified Changes made in this PR are causing tests to fail. support:core This issue/PR relates to code supported by the Ansible Engineering Team. labels Sep 11, 2018

webknjaz reviewed Sep 12, 2018

View reviewed changes

ansibot added the stale_ci This PR has been tested by CI more than one week ago. Close and re-open this PR to get it retested. label Sep 28, 2018

dagwieers added the mongodb MongoDB community label Jan 28, 2019

dagwieers added the database Database category label Feb 13, 2019

dagwieers added the botmeta This PR modifies the BOTMETA.yml and this requires special attention! label Feb 21, 2019

gundalow reviewed Sep 3, 2019

View reviewed changes

ansibot added collection Related to Ansible Collections work collection:community.mongodb and removed support:community This issue/PR relates to code supported by the Ansible community. labels Apr 29, 2020

gundalow closed this Jul 15, 2020

ansible locked and limited conversation to collaborators Aug 12, 2020

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add mongodb_role module #45488

Add mongodb_role module #45488

jkramarz commented Sep 11, 2018

webknjaz commented Sep 11, 2018

This comment has been minimized.

This comment has been minimized.

webknjaz Sep 12, 2018

webknjaz Sep 12, 2018

webknjaz Sep 12, 2018

webknjaz Sep 12, 2018

webknjaz Sep 12, 2018

webknjaz Sep 12, 2018

webknjaz Sep 12, 2018

webknjaz Sep 12, 2018

webknjaz Sep 12, 2018

webknjaz Sep 12, 2018

webknjaz Sep 12, 2018

webknjaz Sep 12, 2018

gundalow commented Feb 19, 2019

SPR0STO commented May 14, 2019

gundalow Sep 3, 2019

gundalow Sep 3, 2019

gundalow commented Jul 2, 2020

emanuelflp commented Jul 15, 2020

gundalow commented Jul 15, 2020

		return creds


		def check_authentication_restrictions_support(client):

Add mongodb_role module #45488

Add mongodb_role module #45488

Conversation

jkramarz commented Sep 11, 2018

SUMMARY

ISSUE TYPE

COMPONENT NAME

ANSIBLE VERSION

webknjaz commented Sep 11, 2018

This comment has been minimized.

This comment has been minimized.

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

gundalow commented Feb 19, 2019

SPR0STO commented May 14, 2019

Choose a reason for hiding this comment

Choose a reason for hiding this comment

gundalow commented Jul 2, 2020

emanuelflp commented Jul 15, 2020

gundalow commented Jul 15, 2020