Add project module (#238)

* new module for managing project
* new module for listing project info
* tests

Signed-off-by: Abhijeet Kasurde <[email protected]>

.config/dictionary.txt

@@ -55,3 +55,4 @@ auths
 Passw
 AUTHS
 EDAHTTP
+refspec

plugins/modules/project.py

@@ -0,0 +1,180 @@
+#!/usr/bin/python
+# -*- coding: utf-8 -*-
+
+# Copyright: Contributors to the Ansible project
+# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
+
+from __future__ import absolute_import, division, print_function
+
+__metaclass__ = type
+
+DOCUMENTATION = """
+---
+module: project
+author:
+    - Nikhil Jain (@jainnikhil30)
+    - Abhijeet Kasurde (@akasurde)
+short_description: Create, update or delete project in EDA Controller
+description:
+    - This module allows user to create, update or delete project in a EDA controller.
+version_added: '2.0.0'
+options:
+    name:
+      description:
+        - The name of the project.
+      type: str
+      required: true
+    new_name:
+      description:
+        - Setting this option will change the existing name.
+      type: str
+    description:
+      description:
+        - The description of the project.
+      type: str
+    url:
+      description:
+        - The git URL of the project.
+      type: str
+    credential:
+      description:
+        - The name of the credential to associate with the project.
+      type: str
+    state:
+      description:
+        - Desired state of the resource.
+      default: "present"
+      choices: ["present", "absent"]
+      type: str
+extends_documentation_fragment:
+    - ansible.eda.eda_controller.auths
+"""
+
+EXAMPLES = """
+- name: Create EDA Projects
+  ansible.eda.project:
+    controller_host: https://my_eda_host/
+    controller_username: admin
+    controller_password: MySuperSecretPassw0rd
+    name: "Example Project"
+    description: "Example project description"
+    url: "https://example.com/project1"
+    state: present
+
+- name: Update the name of the project
+  ansible.eda.project:
+    controller_host: https://my_eda_host/
+    controller_username: admin
+    controller_password: MySuperSecretPassw0rd
+    name: "Example Project"
+    new_name: "Latest Example Project"
+    description: "Example project description"
+    url: "https://example.com/project1"
+    state: present
+
+- name: Delete the project
+  ansible.eda.project:
+    controller_host: https://my_eda_host/
+    controller_username: admin
+    controller_password: MySuperSecretPassw0rd
+    name: "Example Project"
+    state: absent
+"""
+
+from ansible.module_utils.basic import AnsibleModule
+from ansible_collections.ansible.eda.plugins.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
+from ansible_collections.ansible.eda.plugins.module_utils.errors import EDAError
+
+
+def main():
+    argument_spec = dict(
+        name=dict(required=True),
+        new_name=dict(),
+        description=dict(),
+        url=dict(),
+        credential=dict(),
+        state=dict(choices=["present", "absent"], default="present"),
+    )
+
+    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"),
+    )
+
+    project_endpoint = "projects"
+    controller = Controller(client, module)
+
+    project_name = module.params.get("name")
+    new_name = module.params.get("new_name")
+    description = module.params.get("description")
+    url = module.params.get("url")
+    state = module.params.get("state")
+    credential = module.params.get("credential")
+    ret = {}
+
+    try:
+        project_type = controller.get_one_or_many(project_endpoint, name=project_name)
+    except EDAError as eda_err:
+        module.fail_json(msg=str(eda_err))
+
+    if state == "absent":
+        # If the state was absent we can let the module delete it if needed, the module will handle exiting from this
+        try:
+            ret = controller.delete_if_needed(project_type, endpoint=project_endpoint)
+        except EDAError as eda_err:
+            module.fail_json(msg=str(eda_err))
+        module.exit_json(**ret)
+
+    project_type_params = {}
+    if description:
+        project_type_params["description"] = description
+    if url:
+        project_type_params["url"] = url
+
+    credential_id = None
+    if credential:
+        try:
+            credential_id = controller.get_one_or_many(
+                "eda-credentials", name=credential
+            )
+        except EDAError as eda_err:
+            module.fail_json(msg=str(eda_err))
+
+    if credential_id is not None:
+        # this is resolved earlier, so save an API call and don't do it again
+        # in the loop above
+        project_type_params["eda_credential_id"] = credential_id["id"]
+
+    if new_name:
+        project_type_params["name"] = new_name
+    elif project_type:
+        project_type_params["name"] = controller.get_item_name(project_type)
+    else:
+        project_type_params["name"] = project_name
+
+    # If the state was present and we can let the module build or update the existing project type,
+    # this will return on its own
+    try:
+        ret = controller.create_or_update_if_needed(
+            project_type,
+            project_type_params,
+            endpoint=project_endpoint,
+            item_type="project type",
+        )
+    except EDAError as eda_err:
+        module.fail_json(msg=str(eda_err))
+
+    module.exit_json(**ret)
+
+
+if __name__ == "__main__":
+    main()

plugins/modules/project_info.py

@@ -0,0 +1,121 @@
+#!/usr/bin/python
+# -*- coding: utf-8 -*-
+
+# Copyright: Contributors to the Ansible project
+# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
+
+from __future__ import absolute_import, division, print_function
+
+__metaclass__ = type
+
+DOCUMENTATION = """
+---
+module: project_info
+author:
+    - Abhijeet Kasurde (@akasurde)
+short_description: List projects in EDA Controller
+description:
+    - This module allows user to list project in a EDA controller.
+version_added: '2.0.0'
+options:
+    name:
+      description:
+        - The name of the project.
+        - Return information about particular project available on EDA Controller.
+      type: str
+extends_documentation_fragment:
+    - ansible.eda.eda_controller.auths
+"""
+
+EXAMPLES = """
+- name: List a particular project
+  ansible.eda.project_info:
+    controller_host: https://my_eda_host/
+    controller_username: admin
+    controller_password: MySuperSecretPassw0rd
+    name: "Example"
+    register: r
+
+- name: List all projects
+  ansible.eda.project_info:
+    controller_host: https://my_eda_host/
+    controller_username: admin
+    controller_password: MySuperSecretPassw0rd
+    register: r
+"""
+
+RETURN = """
+projects:
+  description: List of dicts containing information about projects
+  returned: success
+  type: list
+  sample: [
+      {
+          "created_at": "2024-08-12T20:35:28.367702Z",
+          "description": "",
+          "eda_credential_id": null,
+          "git_hash": "417b4dbe9b3472fd64212ef8233b865585e5ade3",
+          "id": 17,
+          "import_error": null,
+          "import_state": "completed",
+          "modified_at": "2024-08-12T20:35:28.367724Z",
+          "name": "Sample Example Project",
+          "organization_id": 1,
+          "proxy": "",
+          "scm_branch": "",
+          "scm_refspec": "",
+          "scm_type": "git",
+          "signature_validation_credential_id": null,
+          "url": "https://github.com/ansible/ansible-ui",
+          "verify_ssl": true
+      },
+  ]
+"""  # NOQA
+
+from ansible.module_utils.basic import AnsibleModule
+from ansible_collections.ansible.eda.plugins.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
+from ansible_collections.ansible.eda.plugins.module_utils.errors import EDAError
+
+
+def main():
+    argument_spec = dict(
+        name=dict(),
+    )
+
+    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"),
+    )
+
+    project_endpoint = "projects"
+    controller = Controller(client, module)
+
+    project_name = module.params.get("name")
+
+    ret = {}
+
+    try:
+        ret = controller.get_one_or_many(
+            project_endpoint, name=project_name, want_one=False
+        )
+    except EDAError as eda_err:
+        module.fail_json(msg=str(eda_err))
+
+    if ret is None:
+        ret = []
+    if not isinstance(ret, list):
+        ret = [ret]
+    module.exit_json(projects=ret)
+
+
+if __name__ == "__main__":
+    main()

tests/integration/targets/project/tasks/create.yml

@@ -0,0 +1,81 @@
+---
+# Copyright: Contributors to the Ansible project
+# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
+
+- name: Create project in check mode
+  ansible.eda.project:
+    controller_host: "{{ controller_host }}"
+    controller_username: "{{ controller_user }}"
+    validate_certs: "{{ validate_certs }}"
+    name: "{{ project_name }}"
+    url: "{{ url }}"
+    description: "Example project description"
+    state: present
+  check_mode: true
+  register: r
+
+- name: Check project creation in check mode
+  assert:
+    that:
+      - r.changed
+
+- name: Create project
+  ansible.eda.project:
+    controller_host: "{{ controller_host }}"
+    controller_username: "{{ controller_user }}"
+    validate_certs: "{{ validate_certs }}"
+    name: "{{ project_name }}"
+    url: "{{ url }}"
+    description: "Example project description"
+    state: present
+  register: r
+
+- name: Check project creation
+  assert:
+    that:
+      - r.changed
+
+- name: Create project again
+  ansible.eda.project:
+    controller_host: "{{ controller_host }}"
+    controller_username: "{{ controller_user }}"
+    validate_certs: "{{ validate_certs }}"
+    name: "{{ project_name }}"
+    url: "{{ url }}"
+    description: "Example project description"
+    state: present
+  register: r
+
+- name: Check project is not created again
+  assert:
+    that:
+      - not r.changed
+
+- name: Delete project in check mode
+  ansible.eda.project:
+    controller_host: "{{ controller_host }}"
+    controller_username: "{{ controller_user }}"
+    validate_certs: "{{ validate_certs }}"
+    name: "{{ project_name }}"
+    state: absent
+  check_mode: true
+  register: r
+
+- name: Check if delete project in check mode
+  assert:
+    that:
+      - r.changed
+
+- name: Delete project
+  ansible.eda.project:
+    controller_host: "{{ controller_host }}"
+    controller_username: "{{ controller_user }}"
+    validate_certs: "{{ validate_certs }}"
+    name: "{{ project_name }}"
+    state: absent
+  register: r
+
+- name: Check if delete project
+  assert:
+    that:
+      - r.changed