fix(matrix_token_login): fix regression in required module args

52785ab768 refactored required and
mutually exclusive module parameters and meanwhile dropped some
arguments required for our matrix_token_login module. The change
made sense for most of our modules, but the matrix_token_login as the
only one doesn't need token or password, but definitely needs a key.

plugins/module_utils/matrix.py

@@ -32,7 +32,8 @@ except ImportError:
 
 
 class AnsibleNioModule:
-    def __init__(self,
+    def __init__(
+        self,
         custom_spec=None,
         bypass_checks=False,
         no_log=False,
@@ -43,23 +44,39 @@ class AnsibleNioModule:
         add_file_common_args=False,
         supports_check_mode=True,
         required_if=None,
-                 user_logout=None):
+        user_logout=None,
-
+        add_default_arguments=True,
+    ):
+        if add_default_arguments:
             if required_by is None:
-            required_by = {'password': 'user_id'}
+                required_by = {"password": "user_id"}
 
             if required_one_of is None:
-            required_one_of = [['password', 'token']]
+                required_one_of = [["password", "token"]]
 
             if mutually_exclusive is None:
-            mutually_exclusive = [['password', 'token']]
+                mutually_exclusive = [["password", "token"]]
+
+            if custom_spec is None:
+                custom_spec = {}
+
+            custom_spec = AnsibleNioModule.__common_argument_spec(custom_spec)
+        else:
+            if required_by is None:
+                required_by = {}
+
+            if required_one_of is None:
+                required_one_of = []
+
+            if mutually_exclusive is None:
+                mutually_exclusive = []
 
             if custom_spec is None:
                 custom_spec = {}
 
         # Create the Ansible module
         self.module = AnsibleModule(
-            argument_spec=AnsibleNioModule.__common_argument_spec(custom_spec),
+            argument_spec=custom_spec,
             bypass_checks=bypass_checks,
             no_log=no_log,
             mutually_exclusive=mutually_exclusive,
@@ -73,7 +90,7 @@ class AnsibleNioModule:
 
         if user_logout is None:
             # If a user/password login is provided, should we logout when exiting?
-            self.user_logout = self.module.params['token'] is not None
+            self.user_logout = self.module.params.get('token') is not None
         else:
             self.user_logout = user_logout
 
@@ -88,12 +105,12 @@ class AnsibleNioModule:
 
     async def matrix_login(self):
         # Login with token or supplied user account
-        if self.module.params['token'] is None:
+        if self.module.params.get('token') is None:
-            self.client = AsyncClient(self.module.params['hs_url'], self.module.params['user_id'])
+            self.client = AsyncClient(self.module.params.get('hs_url'), self.module.params.get('user_id'))
-            login_response = await self.client.login(password=self.module.params['password'])
+            login_response = await self.client.login(password=self.module.params.get('password'))
         else:
-            self.client = AsyncClient(self.module.params['hs_url'])
+            self.client = AsyncClient(self.module.params.get('hs_url'))
-            login_response = await self.client.login(token=self.module.params['token'])
+            login_response = await self.client.login(token=self.module.params.get('token'))
         if isinstance(login_response, LoginResponse):
             self.access_token = login_response.access_token
             self.device_id = login_response.device_id
@@ -112,13 +129,13 @@ class AnsibleNioModule:
                 self.module.fail_json(**result)
 
     async def exit_json(self, **result):
-        if self.module.params['token'] is None and self.user_logout is True:
+        if self.module.params.get('token') is None and self.user_logout is True:
             await self.matrix_logout()
         await self.client.close()
         self.module.exit_json(**result)
 
     async def fail_json(self, **result):
-        if self.module.params['token'] is None and self.user_logout is True:
+        if self.module.params.get('token') is None and self.user_logout is True:
             await self.matrix_logout()
         await self.client.close()
         self.module.fail_json(**result)

plugins/modules/matrix_token_login.py

@@ -32,26 +32,16 @@ options:
     user_id:
         description:
             - The user id of the user
-        required: false
+        required: true
         type: str
-    password:
-        description:
-            - The password to log in with
-        required: false
-        type: str
-    token:
-        description:
-            - Authentication token for the API call
-        required: false
-        type: str
-    admin:
-        description:
-            - Whether to set the user as admin during login
-        type: bool
     key:
         description: Login key to use
         type: str
         required: true
+    admin:
+        description:
+            - Whether to set the user as admin during login
+        type: bool
 requirements:
     -  matrix-nio (Python library)
     -  jwcrypto (Python library)
@@ -107,8 +97,10 @@ except ImportError:
 
 async def run_module():
     module_args = dict(
-        key=dict(type='str', required=True, no_log=True),
+        hs_url=dict(type="str", required=True),
-        admin=dict(type='bool', required=False),
+        user_id=dict(type="str", required=True),
+        key=dict(type="str", required=True, no_log=True),
+        admin=dict(type="bool", required=False),
     )
 
     result = dict(
@@ -116,7 +108,14 @@ async def run_module():
         msg="",
     )
 
-    module = AnsibleNioModule(module_args, user_logout=False)
+    args = {
+        "add_default_arguments": False,
+        "required_by": {},
+        "required_one_of": [],
+        "mutually_exclusive": [],
+    }
+
+    module = AnsibleNioModule(module_args, user_logout=False, **args)
     if not HAS_JWCRYPTO:
         await module.fail_json(msg=missing_required_lib("jwcrypto"))
     if not HAS_NIO: