Add user_info module (#74)

Author: PolonaM

changelogs/fragments/user_info_module.yml

@@ -0,0 +1,3 @@
+---
+major_changes:
+  - Added user_info module. (https://github.com/ScaleComputing/HyperCoreAnsibleCollection/pull/74)

plugins/module_utils/role.py

@@ -0,0 +1,60 @@
+# -*- coding: utf-8 -*-
+# Copyright: (c) 2022, XLAB Steampunk <[email protected]>
+#
+# 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
+
+from ..module_utils.utils import PayloadMapper
+from ..module_utils.rest_client import RestClient
+
+
+class Role(PayloadMapper):
+    def __init__(self, uuid, name):
+        self.uuid = uuid
+        self.name = name
+
+    @classmethod
+    def from_ansible(cls):
+        pass
+
+    @classmethod
+    def from_hypercore(cls, role_dict):
+        if not role_dict:  # In case for get_record, return None if no result is found
+            return None
+        return cls(
+            uuid=role_dict["uuid"],
+            name=role_dict["name"],
+        )
+
+    def to_hypercore(self):
+        pass
+
+    def to_ansible(self):
+        return dict(
+            uuid=self.uuid,
+            name=self.name,
+        )
+
+    def __eq__(self, other):
+        """
+        One User is equal to another if it has ALL attributes exactly the same.
+        This method is used only in tests.
+        """
+        return all(
+            (
+                self.uuid == other.uuid,
+                self.name == other.name,
+            )
+        )
+
+    @classmethod
+    def get_role_from_uuid(cls, role_uuid, rest_client: RestClient, must_exist=False):
+        hypercore_dict = rest_client.get_record(
+            "/rest/v1/Role/{0}".format(role_uuid), must_exist=must_exist
+        )
+        role = cls.from_hypercore(hypercore_dict)
+        return role

plugins/module_utils/user.py

@@ -0,0 +1,77 @@
+# -*- coding: utf-8 -*-
+# Copyright: (c) 2023, XLAB Steampunk <[email protected]>
+#
+# 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
+
+from ..module_utils.utils import PayloadMapper
+from ..module_utils.role import Role
+from ..module_utils.rest_client import RestClient
+
+
+class User(PayloadMapper):
+    def __init__(self, uuid, username, full_name, role_uuids, session_limit):
+        self.uuid = uuid
+        self.username = username
+        self.full_name = full_name
+        self.role_uuids = role_uuids
+        self.session_limit = session_limit
+
+    @classmethod
+    def from_ansible(cls):
+        pass
+
+    @classmethod
+    def from_hypercore(cls, user_dict):
+        if not user_dict:  # In case for get_record, return None if no result is found
+            return None
+        return cls(
+            uuid=user_dict["uuid"],
+            username=user_dict["username"],
+            full_name=user_dict["fullName"],
+            role_uuids=user_dict["roleUUIDs"],
+            session_limit=user_dict["sessionLimit"],
+        )
+
+    def to_hypercore(self):
+        pass
+
+    def to_ansible(self, rest_client: RestClient):
+        return dict(
+            uuid=self.uuid,
+            username=self.username,
+            full_name=self.full_name,
+            roles=[
+                Role.get_role_from_uuid(
+                    role_uuid, rest_client, must_exist=False
+                ).to_ansible()
+                for role_uuid in self.role_uuids
+            ],
+            session_limit=self.session_limit,
+        )
+
+    def __eq__(self, other):
+        """
+        One User is equal to another if it has ALL attributes exactly the same.
+        This method is used only in tests.
+        """
+        return all(
+            (
+                self.uuid == other.uuid,
+                self.username == other.username,
+                self.full_name == other.full_name,
+                self.role_uuids == other.role_uuids,
+                self.session_limit == other.session_limit,
+            )
+        )
+
+    @classmethod
+    def get_user(cls, query, rest_client: RestClient, must_exist=False):
+        hypercore_dict = rest_client.get_record(
+            "/rest/v1/User", query, must_exist=must_exist
+        )
+        user = cls.from_hypercore(hypercore_dict)
+        return user

plugins/modules/user_info.py

@@ -0,0 +1,100 @@
+#!/usr/bin/python
+# -*- coding: utf-8 -*-
+# Copyright: (c) 2023, XLAB Steampunk <[email protected]>
+#
+# 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 = r"""
+module: user_info
+
+author:
+  - Polona Mihalič (@PolonaM)
+short_description: Returns information about the users.
+description:
+  - Returns information about the users.
+version_added: 1.2.0
+extends_documentation_fragment:
+  - scale_computing.hypercore.cluster_instance
+seealso:
+  - module: scale_computing.hypercore.user
+options:
+  username:
+    description:
+      - The user name.
+      - Serves as unique identifier.
+    type: str
+"""
+
+EXAMPLES = r"""
+- name: List all users
+  scale_computing.hypercore.user_info:
+  register: users
+
+- name: List selected user
+  scale_computing.hypercore.user_info:
+    username: my_username
+  register: user
+"""
+
+RETURN = r"""
+records:
+  description:
+    - A list of user records.
+  returned: success
+  type: list
+  sample:
+    - fullname: xlab
+      roles:
+        - uuid: 38b346c6-a626-444b-b6ab-92ecd671afc0
+          name: Admin
+        - uuid: 7224a2bd-5a08-4b99-a0de-9977089c66a4
+          name: Backup
+      session_limit: 0
+      username: xlab
+      uuid: 51e6d073-7566-4273-9196-58720117bd7f
+"""
+
+
+from ansible.module_utils.basic import AnsibleModule
+
+from ..module_utils import arguments, errors
+from ..module_utils.rest_client import RestClient
+from ..module_utils.client import Client
+from ..module_utils.user import User
+from ..module_utils.utils import get_query
+
+
+def run(module, rest_client):
+    query = get_query(
+        module.params, "username", ansible_hypercore_map=dict(username="username")
+    )
+    return [
+        User.from_hypercore(user_dict=hypercore_dict).to_ansible(rest_client)
+        for hypercore_dict in rest_client.list_records("/rest/v1/User", query)
+    ]
+
+
+def main():
+    module = AnsibleModule(
+        supports_check_mode=True,
+        argument_spec=dict(
+            arguments.get_spec("cluster_instance"), username=dict(type="str")
+        ),
+    )
+
+    try:
+        client = Client.get_client(module.params["cluster_instance"])
+        rest_client = RestClient(client)
+        records = run(module, rest_client)
+        module.exit_json(changed=False, records=records)
+
+    except errors.ScaleComputingError as e:
+        module.fail_json(msg=str(e))
+
+
+if __name__ == "__main__":
+    main()

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

@@ -0,0 +1,15 @@
+---
+- environment:
+    SC_HOST: "{{ sc_host }}"
+    SC_USERNAME: "{{ sc_username }}"
+    SC_PASSWORD: "{{ sc_password }}"
+    SC_TIMEOUT: "{{ sc_timeout }}"
+
+  block:
+    - name: Retrieve info about the users
+      scale_computing.hypercore.user_info:
+      register: users
+    - ansible.builtin.assert:
+        that:
+          - users.records != []
+          - users.records[0].keys() | sort == ['full_name', 'roles', 'session_limit', 'username', 'uuid']

tests/unit/plugins/module_utils/test_role.py

@@ -0,0 +1,83 @@
+from __future__ import absolute_import, division, print_function
+
+__metaclass__ = type
+
+import sys
+
+import pytest
+
+from ansible_collections.scale_computing.hypercore.plugins.module_utils.role import Role
+
+pytestmark = pytest.mark.skipif(
+    sys.version_info < (2, 7), reason="requires python2.7 or higher"
+)
+
+
+class TestRole:
+    def test_role_from_hypercore_dict_not_empty(self):
+        role = Role(
+            name="admin",
+            uuid="f01249a6-2369-4471-bbc2-b4997067b6a6",
+        )
+
+        hypercore_dict = dict(
+            name="admin",
+            uuid="f01249a6-2369-4471-bbc2-b4997067b6a6",
+        )
+
+        role_from_hypercore = Role.from_hypercore(hypercore_dict)
+        assert role == role_from_hypercore
+
+    def test_role_from_hypercore_dict_empty(self):
+        assert Role.from_hypercore([]) is None
+
+    def test_role_to_ansible(self):
+        role = Role(
+            name="admin",
+            uuid="f01249a6-2369-4471-bbc2-b4997067b6a6",
+        )
+
+        ansible_dict = dict(
+            name="admin",
+            uuid="f01249a6-2369-4471-bbc2-b4997067b6a6",
+        )
+
+        assert role.to_ansible() == ansible_dict
+
+    def test_role_equal_true(self):
+        role1 = Role(
+            name="admin",
+            uuid="f01249a6-2369-4471-bbc2-b4997067b6a6",
+        )
+        role2 = Role(
+            name="admin",
+            uuid="f01249a6-2369-4471-bbc2-b4997067b6a6",
+        )
+
+        assert role1 == role2
+
+    def test_role_equal_false(self):
+        role1 = Role(
+            name="admin",
+            uuid="f01249a6-2369-4471-bbc2-b4997067b6a6",
+        )
+        role2 = Role(
+            name="name",
+            uuid="f01249a6-2369-4471-bbc2-b4997067b6a6",
+        )
+
+        assert role1 != role2
+
+    def test_get_role_from_uuid(self, rest_client):
+        role_uuid = "51e6d073-7566-4273-9196-58720117bd7f"
+        rest_client.get_record.return_value = dict(
+            name="admin",
+            uuid="f01249a6-2369-4471-bbc2-b4997067b6a6",
+        )
+
+        role_from_hypercore = Role.get_role_from_uuid(role_uuid, rest_client)
+
+        assert role_from_hypercore == Role(
+            name="admin",
+            uuid="f01249a6-2369-4471-bbc2-b4997067b6a6",
+        )