feat: [AAP-37428] add support for copy credential (#399)

* add support for copy credential

Author: Dostonbek1

plugins/modules/credential.py

@@ -30,6 +30,13 @@
     description:
       - Setting this option will change the existing name (lookup via name).
     type: str
+  copy_from:
+    description:
+      - Name of the existing credential to copy.
+      - If set, copies the specified credential.
+      - The new credential will be created with the name given in the C(name) parameter.
+    type: str
+    version_added: '3.0.0'
   inputs:
     description:
       - Credential inputs where the keys are var names used in templating.
@@ -75,6 +82,11 @@
   ansible.eda.credential:
     name: "Example Credential"
     state: absent
+
+- name: Copy an existing EDA Credential
+  ansible.eda.credential:
+    name: "New Copied Credential"
+    copy_from: "Existing Credential"
 """
 
 
@@ -136,6 +148,7 @@ def main() -> None:
     argument_spec = dict(
         name=dict(type="str", required=True),
         new_name=dict(type="str"),
+        copy_from=dict(type="str"),
         description=dict(type="str"),
         inputs=dict(type="dict"),
         credential_type_name=dict(type="str"),
@@ -145,13 +158,18 @@ def main() -> None:
 
     argument_spec.update(AUTH_ARGSPEC)
 
-    required_if = [
-        (
-            "state",
-            "present",
-            ("name", "credential_type_name", "inputs", "organization_name"),
-        )
-    ]
+    module = AnsibleModule(argument_spec=argument_spec, supports_check_mode=True)
+    copy_from = module.params.get("copy_from", None)
+
+    required_if = []
+    if not copy_from:
+        required_if = [
+            (
+                "state",
+                "present",
+                ("name", "credential_type_name", "inputs", "organization_name"),
+            )
+        ]
 
     module = AnsibleModule(
         argument_spec=argument_spec, required_if=required_if, supports_check_mode=True
@@ -179,7 +197,9 @@ def main() -> None:
 
     # Attempt to look up credential based on the provided name
     try:
-        credential = controller.get_exactly_one(credential_endpoint, name=name)
+        credential = controller.get_exactly_one(
+            credential_endpoint, name=copy_from if copy_from else name
+        )
     except EDAError as e:
         module.fail_json(msg=f"Failed to get credential: {e}")
 
@@ -201,6 +221,23 @@ def main() -> None:
         else (controller.get_item_name(credential) if credential else name)
     )
 
+    # we attempt to copy only when copy_from is passed
+    if copy_from:
+        try:
+            result = controller.copy_if_needed(
+                name,
+                copy_from,
+                endpoint=f"eda-credentials/{credential['id']}/copy",
+                item_type="credential",
+            )
+            module.exit_json(changed=True)
+        except KeyError as e:
+            module.fail_json(
+                msg=f"Unable to access {e} of the credential to copy from."
+            )
+        except EDAError as e:
+            module.fail_json(msg=f"Failed to copy credential: {e}")
+
     # If the state was present and we can let the module build or update the
     # existing credential, this will return on its own
     try:

tests/integration/targets/credential/tasks/main.yml

@@ -21,6 +21,7 @@
       set_fact:
         credential_name: "Test_Credential_{{ test_id }}"
         new_credential_name: "New_Test_Credential_{{ test_id }}"
+        credential_copy_name: "Test_Credential_{{ test_id }}_Copy"
         credential_type_name: "Test_CredentialType_{{ test_id }}"
 
     # CREATE
@@ -91,6 +92,68 @@
       ansible.eda.credential_info:
         name: "{{ credential_name }}"
 
+    - name: Copy credential
+      ansible.eda.credential:
+        name: "{{ credential_copy_name }}"
+        copy_from: "{{ credential_name }}"
+        organization_name: Default
+      register: _result
+
+    - name: Check credential is copied
+      assert:
+        that:
+          - _result.changed
+
+    - name: Get info about credentials
+      ansible.eda.credential_info:
+      register: _credential_info
+
+    - name: Get both created and copied credentials
+      set_fact:
+        _source_credential: "{{ _credential_info.credentials | selectattr('name', 'equalto', credential_name) | list | first }}"
+        _copied_credential: "{{ _credential_info.credentials | selectattr('name', 'equalto', credential_copy_name) | list | first }}"
+
+    - name: Assert credential fields are copied correctly
+      ansible.builtin.assert:
+        that:
+          - _source_credential | dict2items | rejectattr('key', 'in', ignored_fields) | items2dict == _copied_credential | dict2items | rejectattr('key', 'in', ignored_fields) | items2dict
+          - _source_credential.name + '_Copy' == _copied_credential.name
+      vars:
+        ignored_fields:
+          - name
+          - id
+          - created_at
+          - updated_at
+          - modified_at
+
+    - name: Copy non-existing credential
+      ansible.eda.credential:
+        name: "{{ credential_copy_name }}"
+        copy_from: "invalid_credential"
+        organization_name: Default
+      register: _result
+      ignore_errors: true
+
+    - name: Check credential copy failed
+      assert:
+        that:
+          - _result.failed
+          - "\"Unable to access 'id' of the credential to copy from\" in _result.msg"
+
+    - name: Copy credential and use existing name
+      ansible.eda.credential:
+        name: "{{ credential_copy_name }}"
+        copy_from: "{{ credential_name }}"
+        organization_name: Default
+      register: _result
+      ignore_errors: true
+
+    - name: Check credential copy failed
+      assert:
+        that:
+          - _result.failed
+          - "'eda credential with this name already exists.' in _result.msg"
+
     # UPDATE
     - name: Update credential name
       ansible.eda.credential: