Add plugins/modules/credential_type_info.py

Signed-off-by: Alina Buzachis <[email protected]>

Author: alinabuzachis

plugins/module_utils/controller.py

@@ -91,8 +91,8 @@ def fail_wanted_one(self, response, endpoint, query_params):
             total_results=response.json["count"],
         )
 
-    def get_one(
-        self, endpoint, name=None, allow_none=True, check_exists=False, **kwargs
+    def get_one_or_many(
+        self, endpoint, name=None, allow_none=True, check_exists=False, want_one=True, **kwargs
     ):
         new_kwargs = kwargs.copy()
         response = None
@@ -103,44 +103,48 @@ def get_one(
             new_data["{0}".format(name_field)] = name
             new_kwargs["data"] = new_data
 
-            response = self.get_endpoint(endpoint, **new_kwargs)
+        response = self.get_endpoint(endpoint, **new_kwargs)
 
-            if response.status != 200:
-                fail_msg = "Got a {0} when trying to get from {1}".format(
-                    response.status, endpoint
-                )
-                if "detail" in response.json:
-                    fail_msg += ",detail: {0}".format(response.json["detail"])
-                self.module.fail_json(msg=fail_msg)
+        if response.status != 200:
+            fail_msg = "Got a {0} when trying to get from {1}".format(
+                response.status, endpoint
+            )
+            if "detail" in response.json:
+                fail_msg += ",detail: {0}".format(response.json["detail"])
+            self.module.fail_json(msg=fail_msg)
 
-            if "count" not in response.json or "results" not in response.json:
-                self.module.fail_json(msg="The endpoint did not provide count, results")
+        logging.debug(response.json)
+
+        if "count" not in response.json or "results" not in response.json:
+            self.module.fail_json(msg="The endpoint did not provide count, results")
 
         if response.json["count"] == 0:
             if allow_none:
                 return None
             else:
                 self.fail_wanted_one(response, endpoint, new_kwargs.get("data"))
+        if response.json["count"] == 1:
+            return response.json["results"][0]
         elif response.json["count"] > 1:
-            if name:
-                # Since we did a name or ID search and got > 1 return
-                # something if the id matches
-                for asset in response.json["results"]:
-                    if str(asset["id"]) == name:
-                        return asset
-            # We got > 1 and either didn't find something by ID (which means
-            # multiple names)
-            # Or we weren't running with a or search and just got back too
-            # many to begin with.
-            self.fail_wanted_one(response, endpoint, new_kwargs.get("data"))
+            if want_one:
+                if name:
+                    # Since we did a name or ID search and got > 1 return
+                    # something if the id matches
+                    for asset in response.json["results"]:
+                        if str(asset["id"]) == name:
+                            return asset
+                # We got > 1 and either didn't find something by ID (which means
+                # multiple names)
+                # Or we weren't running with a or search and just got back too
+                # many to begin with.
+                self.fail_wanted_one(response, endpoint, new_kwargs.get("data"))
+            else:
+                return response.json["results"]
 
         if check_exists:
             self.json_output["id"] = response.json["results"][0]["id"]
             self.module.exit_json(**self.json_output)
 
-        return response.json["results"][0]
-
-
     def create_if_needed(
         self,
         existing_item,

plugins/modules/credential_type.py

@@ -124,7 +124,7 @@ def main():
     controller = Controller(client, module)
 
     # Attempt to look up credential_type based on the provided name
-    credential_type = controller.get_one('credential-types', name=name, check_exists=(state == 'exists'))
+    credential_type = controller.get_one_or_many('credential-types', name=name, check_exists=(state == 'exists'))
 
     if state == 'absent':
         # If the state was absent we can let the module delete it if needed, the module will handle exiting from this
@@ -136,8 +136,5 @@ def main():
     controller.create_or_update_if_needed(credential_type, credential_type_params, endpoint='credential-types', item_type='credential type')
 
 
-    module.exit_json(**credential_type)
-
-
 if __name__ == "__main__":
     main()

plugins/modules/credential_type_info.py

@@ -0,0 +1,71 @@
+DOCUMENTATION = """
+---
+module: credential_type_info
+author:
+    - Alina Buzachis (@alinabuzachis)
+short_description: List credential types in EDA Controller
+description:
+    - List credentail types in EDA controller.
+version_added: 2.0.0
+options:
+    name:
+      description:
+        - The name of the credential type.
+      type: str
+      required: false
+requirements:
+  - The 'requests' Python module must be installed.
+extends_documentation_fragment:
+    - ansible.eda.eda_controller.auths
+"""
+
+
+EXAMPLES = """
+    - name: Get information about a credential type
+      ansible.eda.credential_type_info:
+        name: "Test"
+
+    - name: List all credential types
+      ansible.eda.credential_type:
+"""
+
+
+RETURN = """ # """
+
+
+from ansible.module_utils.basic import AnsibleModule
+
+from ..module_utils.arguments import AUTH_ARGSPEC
+
+from ansible_collections.ansible.eda.plugins.module_utils.client import Client
+from ansible_collections.ansible.eda.plugins.module_utils.controller import Controller
+
+
+def main():
+    argument_spec = dict(
+        name=dict(type="str", required=False),
+    )
+
+    argument_spec.update(AUTH_ARGSPEC)
+
+    module = AnsibleModule(argument_spec=argument_spec, supports_check_mode=True)
+
+    client = Client(
+        host=module.params.get("controller_host"),
+        username=module.params.get("controller_username"),
+        password=module.params.get("controller_password"),
+        timeout=module.params.get("request_timeout"),
+        validate_certs=module.params.get("validate_certs"),
+    )
+
+    name = module.params.get('name')
+    controller = Controller(client, module)
+
+    # Attempt to look up credential_type based on the provided name
+    result = controller.get_one_or_many('credential-types', name=name, want_one=False)
+
+    module.exit_json(**result)
+
+
+if __name__ == "__main__":
+    main()