Add activation module

* Added module to manage activation
* Added module to gather information about activation
* tests

.config/dictionary.txt

@@ -60,3 +60,4 @@ Alina
 Buzachis
 alinabuzachis
 hdrs
+testuser

meta/runtime.yml

@@ -4,5 +4,7 @@
 requires_ansible: ">=2.15.0" # AAP 2.4 or newer
 action_groups:
   eda:
+    - activation
+    - activation_info
     - credential_type
     - credential_type_info

plugins/module_utils/controller.py

@@ -81,6 +81,12 @@ def fail_wanted_one(self, response, endpoint, query_params):
         msg = f"Request to {display_endpoint} returned {response.json['count']} items, expected 1"
         raise EDAError(msg)
 
+    def get_exactly_one(self, endpoint, name=None, **kwargs):
+        return self.get_one_or_many(endpoint, name=name, allow_none=False, **kwargs)
+
+    def resolve_name_to_id(self, endpoint, name):
+        return self.get_exactly_one(endpoint, name)["id"]
+
     def get_one_or_many(
         self,
         endpoint,

plugins/modules/activation.py

@@ -0,0 +1,349 @@
+#!/usr/bin/python
+# coding: utf-8 -*-
+
+# 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: activation
+author:
+  - "Nikhil Jain (@jainnikhil30)"
+  - "Alina Buzachis (@alinabuzachis)"
+short_description: Manage rulebook activations in the EDA Controller
+description:
+  - This module allows the user to create or delete activations in the EDA Controller.
+options:
+  name:
+    description:
+      - The name of the rulebook activation.
+    type: str
+    required: true
+  description:
+    description:
+      - The description of the rulebook activation.
+    type: str
+  project_name:
+    description:
+      - The name of the project associated with the rulebook activation.
+    type: str
+    aliases:
+      - project
+  rulebook_name:
+    description:
+      - The name of the rulebook associated with the rulebook activation.
+    type: str
+    aliases:
+      - rulebook
+  extra_vars:
+    description:
+      - The extra variables for the rulebook activation.
+    type: str
+  restart_policy:
+    description:
+      - The restart policy for the rulebook activation.
+    default: "on-failure"
+    choices: ["on-failure", "always", "never"]
+    type: str
+  enabled:
+    description:
+      - Whether the rulebook activation is enabled or not.
+    type: bool
+    default: true
+  decision_environment_name:
+    description:
+      - The name of the decision environment associated with the activation.
+    type: str
+    aliases:
+      - decision_environment
+      - env_name
+  awx_token_name:
+    description:
+      - The token ID of the AWX controller.
+    type: int
+    aliases:
+      - awx_token
+      - token
+  organization_name:
+    description:
+      - The name of the organization.
+    type: int
+    aliases:
+      - organization
+  eda_credentials:
+    description:
+      - A list of IDs for EDA credentials used by the activation.
+    type: list
+    elements: str
+    aliases:
+      - credentials
+  k8s_service_name:
+    description:
+      - The name of the Kubernetes service associated with this activation.
+    type: str
+  webhooks:
+    description:
+      - A list of webhook IDs associated with the activation.
+    type: list
+    elements: str
+  swap_single_source:
+    description:
+      - Allow swapping of single sources in a rulebook without name match
+    type: bool
+    default: true
+  event_streams:
+    description:
+      -  A list of IDs representing the event streams that this activation listens to.
+    type: list
+    elements: int
+  log_level:
+    description:
+      - Allow setting the desired log level.
+    type: str
+    default: "debug"
+    choices: ["debug", "info", "error"]
+  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 a rulebook activation
+  ansible.eda.activation:
+    name: "Example Activation"
+    description: "Example Activation description"
+    project_name: "Example Project"
+    rulebook_name: "hello_controller.yml"
+    decision_environment_name: "Default Decision Environment"
+    enabled: False
+    awx_token_name: "Example Token"
+
+- name: Delete a rulebook activation
+  ansible.eda.activation:
+    name: "Example Activation"
+    state: absent
+"""
+
+
+RETURN = """
+id:
+  description: ID of the rulebook activation.
+  returned: when exists
+  type: int
+  sample: 37
+"""
+
+
+from ansible.module_utils.basic import AnsibleModule
+
+from ..module_utils.arguments import AUTH_ARGSPEC
+from ..module_utils.client import Client
+from ..module_utils.controller import Controller
+from ..module_utils.errors import EDAError
+
+
+def lookup(module, controller, endpoint, name):
+    result = None
+    try:
+        result = controller.resolve_name_to_id(endpoint, name)
+    except EDAError as e:
+        module.fail_json(msg=f"Failed to lookup resource: {e}")
+    return result
+
+
+def create_params(module, controller):
+    activation_params = {}
+
+    # Get the project id
+    project_id = None
+    if module.params.get("project"):
+        project_id = lookup(module, controller, "projects", module.params["project"])
+    if project_id is not None:
+        activation_params["project_id"] = project_id
+
+    # Get the rulebook id
+    rulebook_id = None
+    if module.params.get("rulebook_name"):
+        rulebook_id = lookup(
+            module, controller, "rulebooks", module.params["rulebook_name"]
+        )
+    if rulebook_id is not None:
+        activation_params["rulebook_id"] = rulebook_id
+
+    # Get the decision environment id
+    decision_environment_id = None
+    if module.params.get("decision_environment_name"):
+        decision_environment_id = lookup(
+            module,
+            controller,
+            "decision-environments",
+            module.params["decision_environment_name"],
+        )
+    if decision_environment_id is not None:
+        activation_params["decision_environment_id"] = decision_environment_id
+
+    # Get the organization id
+    organization_id = None
+    if module.params.get("organization_name"):
+        organization_id = lookup(
+            module, controller, "organizations", module.params["organization_name"]
+        )
+    if organization_id is not None:
+        activation_params["organization_id"] = organization_id
+
+    if module.params.get("description"):
+        activation_params["description"] = module.params["description"]
+
+    if module.params.get("extra_vars"):
+        activation_params["extra_var"] = module.params["extra_vars"]
+
+    # Get the AWX token id
+    awx_token_id = None
+    if module.params.get("awx_token_name"):
+        awx_token_id = lookup(
+            module, controller, "/users/me/awx-tokens/", module.params["awx_token_name"]
+        )
+    if awx_token_id is not None:
+        activation_params["awx_token_id"] = awx_token_id
+
+    if module.params.get("restart_policy"):
+        activation_params["restart_policy"] = module.params["restart_policy"]
+
+    if module.params.get("enabled"):
+        activation_params["is_enabled"] = module.params["enabled"]
+
+    if module.params.get("event_streams"):
+        activation_params["event_streams"] = module.params["event_streams"]
+
+    # Get the eda credential ids
+    eda_credential_ids = None
+    if module.params.get("eda_credentials"):
+        eda_credential_ids = []
+        for item in module.params["eda_credentials"]:
+            cred_id = lookup(module, controller, "eda-credentials", item)
+            if cred_id is not None:
+                eda_credential_ids.append(cred_id)
+
+    if eda_credential_ids is not None:
+        activation_params["eda_credentials"] = eda_credential_ids
+
+    if module.params.get("k8s_service_name"):
+        activation_params["k8s_service_name"] = module.params["k8s_service_name"]
+
+    # Get the webhook ids
+    webhooks_ids = None
+    if module.params.get("webhooks"):
+        webhooks_ids = []
+        for item in module.params["webhooks"]:
+            webhook_id = lookup(module, controller, "webhooks", item)
+            if webhook_id is not None:
+                webhooks_ids.append(webhook_id)
+    if webhooks_ids is not None:
+        activation_params["webhooks"] = webhooks_ids
+
+    if module.params.get("log_level"):
+        activation_params["log_level"] = module.params["log_level"]
+
+    if module.params.get("swap_single_source"):
+        activation_params["swap_single_source"] = module.params["swap_single_source"]
+
+    return activation_params
+
+
+def main():
+    argument_spec = dict(
+        name=dict(type="str", required=True),
+        description=dict(type="str"),
+        project_name=dict(type="str", aliases=["project"]),
+        rulebook_name=dict(type="str", aliases=["rulebook"]),
+        extra_var=dict(type="str"),
+        restart_policy=dict(
+            type="str",
+            default="on-failure",
+            choices=[
+                "on-failure",
+                "always",
+                "never",
+            ],
+        ),
+        enabled=dict(type="bool", default=True),
+        decision_environment_name=dict(
+            type="str", aliases=["decision_environment", "env_name"]
+        ),
+        awx_token_name=dict(type="str", aliases=["awx_token", "token"]),
+        organization_name=dict(type="str", aliases=["organization"]),
+        event_streams=dict(type="list", elements="int"),
+        eda_credentials=dict(type="list", elements="str", aliases=["credentials"]),
+        k8s_service_name=dict(type="str"),
+        webhooks=dict(type="list", elements="str"),
+        swap_single_source=dict(type=bool, default=True),
+        log_level=dict(type="str", choices=["debug", "info", "error"], default="debug"),
+        state=dict(choices=["present", "absent", "exists"], default="present"),
+    )
+
+    argument_spec.update(AUTH_ARGSPEC)
+
+    required_if = [
+        ("state", "present", ("name", "rulebook_name", "decision_environment_name"))
+    ]
+
+    module = AnsibleModule(
+        argument_spec=argument_spec, required_if=required_if, 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")
+    state = module.params.get("state")
+
+    controller = Controller(client, module)
+
+    # Attempt to find rulebook activation based on the provided name
+    try:
+        activation = controller.get_one_or_many("activations", name=name)
+    except EDAError as e:
+        module.fail_json(msg=f"Failed to get activation: {e}")
+
+    if state == "absent":
+        try:
+            result = controller.delete_if_needed(activation, endpoint="activations")
+            module.exit_json(**result)
+        except EDAError as e:
+            module.fail_json(msg=f"Failed to delete activation: {e}")
+
+    # Activation Data that will be sent for create/update
+    activation_params = create_params(module, controller)
+    activation_params["name"] = module.get_item_name(activation) if activation else name
+
+    # If the state was present and we can let the module build or update the
+    # existing activation, this will return on its own
+    try:
+        result = controller.create_or_update_if_needed(
+            activation,
+            activation_params,
+            endpoint="activations",
+            item_type="activation",
+        )
+        module.exit_json(**result)
+    except EDAError as e:
+        module.fail_json(msg=f"Failed to create/update activation: {e}")
+
+
+if __name__ == "__main__":
+    main()