oc-cdtapi 3.26.1__py3-none-any.whl → 3.27.2__py3-none-any.whl

oc_cdtapi/ForemanAPI.py

@@ -11,7 +11,8 @@ from datetime import datetime, timedelta
 from packaging import version
 
 class ForemanAPIError(HttpAPIError):
-    pass
+    def __str__(self):
+        return self.text
 
 
 class ForemanAPI(HttpAPI):
@@ -22,7 +23,10 @@ class ForemanAPI(HttpAPI):
     _error = ForemanAPIError
     _env_prefix = "FOREMAN"
 
-    headers = {"Accept": "version=2,application/json", "Content-Type": "application/json"}
+    headers = {
+        "Accept": "application/json;version=2",
+        "Content-Type": "application/json"
+    }
 
     def __init__(self, *args, **kwargs):
         """
@@ -69,7 +73,7 @@ class ForemanAPI(HttpAPI):
         return self.__foreman_version_major
 
     def re(self, req):
-        if not req.startswith("foreman_puppet"):
+        if not req.startswith(("foreman_puppet", "ansible")):
             return posixpath.join(self.root, "api", req)
         else:
             return posixpath.join(self.root, req)
@@ -285,10 +289,10 @@ class ForemanAPI(HttpAPI):
             default_params.update(custom)
 
         if not default_params["is_owned_by"]:
-            raise ForemanAPIError("The owner id is not specified")
+            raise ForemanAPIError(code=400, text="The owner id is not specified")
 
         if not default_params["name"]:
-            raise ForemanAPIError("The hostname is not specified")
+            raise ForemanAPIError(code=400, text="The hostname is not specified")
 
         logging.debug("ForemanAPI is about to send the following payload:")
         logging.debug(default_params)
@@ -343,10 +347,10 @@ class ForemanAPI(HttpAPI):
             default_params.update(custom)
 
         if not default_params["is_owned_by"]:
-            raise ForemanAPIError("The owner id is not specified")
+            raise ForemanAPIError(code=400, text="The owner id is not specified")
 
         if not default_params["name"]:
-            raise ForemanAPIError("The hostname is not specified")
+            raise ForemanAPIError(code=400, text="The hostname is not specified")
 
         if not default_params.get('hostgroup_id'):
             hostgroup = self.get_hostgroup_id('stands')
@@ -628,7 +632,7 @@ class ForemanAPI(HttpAPI):
         """
         logging.debug('Reached override_smart_class_v1')
         request = self.post(posixpath.join("smart_class_parameters", str(scid),
-            "override_values"), headers=self.headers, data=params)
+                                           "override_values"), headers=self.headers, data=params)
 
     def override_smart_class_v2(self, scid, params):
         """
@@ -699,7 +703,8 @@ class ForemanAPI(HttpAPI):
         """
         logging.debug('Reached add_puppet_class_to_host_v2')
         logging.debug('Params to be sent: %s' % params)
-        response = self.post(posixpath.join('foreman_puppet', 'api', 'hosts', hostname, 'puppetclass_ids'), headers=self.headers, data=params)
+        response = self.post(posixpath.join('foreman_puppet', 'api', 'hosts', hostname, 'puppetclass_ids'),
+                             headers=self.headers, data=params)
 
     def get_subnets(self):
         """
@@ -804,7 +809,7 @@ class ForemanAPI(HttpAPI):
         actions = ["start", "stop"]
 
         if action not in actions:
-            raise ForemanAPIError("500 - Incorrect power action was provided")
+            raise ForemanAPIError(code=500, text="Incorrect power action was provided")
 
         params = json.dumps({"power_action": action})
         request = self.put(posixpath.join("hosts", hostname, "power"), headers=self.headers, data=params)
@@ -816,7 +821,7 @@ class ForemanAPI(HttpAPI):
         logging.debug('Reached host_power_v2')
         actions = ["on", "off"]
         if action not in actions:
-            raise ForemanAPIError("500 - Incorrect power action was provided")
+            raise ForemanAPIError(code=500, text="Incorrect power action was provided")
         params = json.dumps({"power_action": action})
         request = self.put(posixpath.join('hosts', hostname, "power"), headers=self.headers, data=params)
         if not request.status_code == 200:
@@ -876,7 +881,7 @@ class ForemanAPI(HttpAPI):
 
         for hostgroup in hostgroups:
             if hostgroup.get("name") == hostgroup_name:
-                return hostgroup.get ('id')
+                return hostgroup.get('id')
 
         logging.debug("Hostgroup [%s] not found, returning None" % hostgroup_name)
         return None
@@ -1061,7 +1066,7 @@ class ForemanAPI(HttpAPI):
         """
         logging.debug('Reached get_flavor_id_v1')
         flavors_list = self.get(posixpath.join("compute_resources", str(compute_resource_id),
-            "available_flavors")).json()["results"]
+                                               "available_flavors")).json()["results"]
 
         try:
             flavor_id = next(flavor["id"] for flavor in flavors_list if flavor["name"] == flavor_name)
@@ -1230,11 +1235,10 @@ class ForemanAPI(HttpAPI):
             owner_type = 'Usergroup'
 
         if not owner_id:
-            raise ForemanAPIError(f"The owner [{owner}] is not found")
+            raise ForemanAPIError(code=404, text=f"The owner [{owner}] is not found")
 
         self.update_host(hostname, {"host": {"owner_id": owner_id, "owner_type": owner_type}})
 
-
     def set_host_owner_id(self, hostname, owner_id):
         """
         Change host owner_id
@@ -1282,7 +1286,7 @@ class ForemanAPI(HttpAPI):
 
         template_id = self._template_cache.get(template_name)
         if not template_id:
-            raise ForemanAPIError(f"Job template '{template_name}' not found")
+            raise ForemanAPIError(code=404, text=f"Job template '{template_name}' not found")
 
         logging.debug(f"Template id for [{template_name}] is [{template_id}]")
         return template_id
@@ -1305,7 +1309,7 @@ class ForemanAPI(HttpAPI):
 
         config = task_configs.get(task_name)
         if not config:
-            raise ForemanAPIError(f"Unknown task: {task_name}")
+            raise ForemanAPIError(code=404, text=f"Unknown task: {task_name}")
 
         logging.debug(f"config for [{task_name}] is [{config}]")
 
@@ -1345,7 +1349,7 @@ class ForemanAPI(HttpAPI):
         start_time = time.time()
         while True:
             if time.time() - start_time > timeout:
-                raise ForemanAPIError(f"Job {job_id} timed out after {timeout} seconds")
+                raise ForemanAPIError(code=500, text=f"Job {job_id} timed out after {timeout} seconds")
             response = self.get(posixpath.join("job_invocations", str(job_id)))
             is_pending = bool(response.json().get("pending", False))
             if not is_pending:
@@ -1409,4 +1413,144 @@ class ForemanAPI(HttpAPI):
             return
 
         logging.debug(f"updating {parameter_name}")
-        self.put(posixpath.join("hosts", hostname, "parameters", parameter_name), headers=self.headers, json=payload)
+        self.put(posixpath.join("hosts", hostname, "parameters", parameter_name), headers=self.headers, json=payload)
+
+    def get_host_ansible_roles(self, hostname):
+        """
+        Get ansible role from host.
+        :param hostname: str
+        """
+        logging.debug('Reached get_host_ansible_roles')
+
+        response = self.get(posixpath.join("hosts", hostname, "ansible_roles"), headers=self.headers)
+        roles = response.json()
+
+        return roles
+
+    def get_ansible_role(self, roles=None):
+        """
+        Get ansible role id by its name.
+        :param role_name: str
+        """
+        logging.debug('Reached get_ansible_role')
+
+        if not roles:
+            params = {'per_page': 'all'}
+            response = self.get(posixpath.join("ansible", "api", "ansible_roles"), params=params, headers=self.headers).json()
+
+            logging.debug(f"About to return {response.get('subtotal')} roles")
+            return response.get("results")
+
+        params = {'search': None}
+
+        if isinstance(roles, (str, int)):
+            roles = [roles]
+
+        query = []
+        for role in roles:
+            if isinstance(role, str):
+                query.append(f"name={role}")
+            elif isinstance(role, int):
+                query.append(f"id={role}")
+            else:
+                raise ForemanAPIError(f"Invalid role type: {type(role)}")
+
+        params["search"] = " or ".join(query)
+
+        logging.debug(f"Search param is {params.get('search')}")
+        response = self.get(posixpath.join("ansible", "api", "ansible_roles"), params=params, headers=self.headers).json()
+
+        logging.debug(f"About to return {response.get('subtotal')} roles")
+        return response.get("results")
+
+    def assign_ansible_roles(self, hostname, roles):
+        """
+        Assign an ansible roles and override value by given role_id and kwargs to specific hostname.
+        :param hostname: str
+        :param roles: list/str/int
+        """
+        logging.debug('Reached assign_ansible_roles')
+        logging.debug(f'Hostname: [{hostname}]')
+        logging.debug(f'Roles: [{roles}]')
+
+        role_ids = []
+        role_names = []
+
+        if isinstance(roles, (str, int)):
+            roles = [roles]
+
+        roles = self.get_ansible_role(roles)
+        for role in roles:
+            role_ids.append(role.get("id"))
+            role_names.append(role.get("name"))
+
+        payload = {
+            "ansible_role_ids": role_ids
+        }
+
+        # Assign ansible roles
+        logging.debug(f'About to set roles {role_names}')
+        self.post(posixpath.join("hosts", hostname, "assign_ansible_roles"), headers=self.headers, json=payload)
+
+    def assign_ansible_roles_and_override(self, hostname, roles):
+        """
+        Assign an ansible roles and override value by given role_id and kwargs to specific hostname.
+        :param hostname: str
+        :param roles: dict
+        """
+        logging.debug('Reached assign_ansible_roles_and_override')
+        logging.debug(f'Hostname: [{hostname}]')
+        logging.debug(f'Roles: [{roles}]')
+
+        role_ids = []
+        updated_dict = {}
+
+        if not isinstance(roles, dict):
+            raise ForemanAPIError(code=400, text="Input must be in dict")
+
+        temp_roles = []
+        for role, variable in roles.items():
+            temp_roles.append(role)
+
+        new_roles = self.get_ansible_role(temp_roles)
+        for new_role in new_roles:
+            role_ids.append(new_role.get("id"))
+            if not roles.get(new_role.get("id")):
+                continue
+
+            roles[new_role.get("name")] = roles.pop(new_role.get("id"))
+
+        payload = {
+            "ansible_role_ids": role_ids
+        }
+
+        for key, values in roles.items():
+            params = {"search": f"ansible_role={key}", "per_page": "all"}
+
+            variables = self.get(posixpath.join("ansible", "api", "ansible_variables"), params=params).json()["results"]
+            valid_params = {v["parameter"]: v["id"] for v in variables}
+
+            missing = [p for p in values.keys() if p not in valid_params]
+            if missing:
+                raise ForemanAPIError(code=400, text=f"Role '{key}' missing variables: {', '.join(missing)}")
+
+            for param_name, param_value in values.items():
+                variable_id = valid_params[param_name]
+                updated_dict[f"{variable_id}-{param_name}"] = param_value
+
+        # Assign ansible roles
+        logging.debug(f'About to set roles {roles}')
+        self.post(posixpath.join("hosts", hostname, "assign_ansible_roles"), headers=self.headers, json=payload)
+
+        for key, value in updated_dict.items():
+            payload = {
+                "ansible_variable_id": key,
+                "override_value": {
+                    "match": f"fqdn={hostname}",
+                    "value": value
+                }
+            }
+            logging.debug(f'About to override ansible variables {key} with value {value}')
+
+            self.post(posixpath.join("ansible", "api", "ansible_override_values"), headers=self.headers, json=payload)
+            sleep(1)

{oc_cdtapi-3.26.1.dist-info → oc_cdtapi-3.27.2.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: oc-cdtapi
-Version: 3.26.1
+Version: 3.27.2
 Summary: Custom Development python API libraries
 License: Apache2.0
 Requires-Python: >=3.6

{oc_cdtapi-3.26.1.dist-info → oc_cdtapi-3.27.2.dist-info}/RECORD

@@ -3,7 +3,7 @@ oc_cdtapi/Dbsm2API.py,sha256=WDBst1dCAmDVU9d9Ogzwp2nkjtKZ4thU2xG4sAPI_Nk,9963
 oc_cdtapi/DevPIAPI.py,sha256=9WND9ld66eHmC5qoLJq3KDYSoO-pP69UqOQsGZNLZYg,1835
 oc_cdtapi/DmsAPI.py,sha256=eNFdwQLhCbPvHB5SUtP4QcZZtSdjkgt_Cxn3oQ3iJ5s,15605
 oc_cdtapi/DmsGetverAPI.py,sha256=ZPU4HlF59fngKu5mSFhtss3rlBuduffDOSm_y3XWrxk,15556
-oc_cdtapi/ForemanAPI.py,sha256=kKzYKnh3aEL5OsJgXXiVe0dRw-kj-LXqIG03Oz61qcI,51123
+oc_cdtapi/ForemanAPI.py,sha256=Qj20vsX1HNj_N0B4Y6kmah7vx4b_xdgiq97uJA3zQiY,56435
 oc_cdtapi/JenkinsAPI.py,sha256=lZ8pe3a4eb_6h53JE7QLuzOSlu7Sqatc9PQwWhio9Vg,15748
 oc_cdtapi/NexusAPI.py,sha256=uU12GtHvKlWorFaPAnFcQ5AGEc94MZ5SdmfM2Pw3F7A,26122
 oc_cdtapi/PgAPI.py,sha256=URSz7qu-Ir7AOj0jI3ucTXn2PM-nC96nmPZI746OLjA,14356
@@ -12,9 +12,9 @@ oc_cdtapi/RundeckAPI.py,sha256=O3LmcFaHSz8UqeUyIHTTEMJncDD191Utd-iZaeJay2s,24243
 oc_cdtapi/TestServer.py,sha256=HV97UWg2IK4gOYAp9yaMdwFUWsw9v66MxyZdI3qQctA,2715
 oc_cdtapi/VaultAPI.py,sha256=P-x_PsWe_S0mGUKTCmR1KhUjdfs7GmyaltjGQcnWj_s,2967
 oc_cdtapi/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-oc_cdtapi-3.26.1.data/scripts/nexus.py,sha256=4teqZ_KtCSrwHDJVgA7lkreteod4Xt5XJFZNbwb7E6E,6858
-oc_cdtapi-3.26.1.dist-info/licenses/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
-oc_cdtapi-3.26.1.dist-info/METADATA,sha256=sWydrThH2AFpyQA_eRTzJ5cxbMqcIpC4cxKHSMsHP8o,504
-oc_cdtapi-3.26.1.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-oc_cdtapi-3.26.1.dist-info/top_level.txt,sha256=d4-5-D-0CSeSXYuLCP7-nIFCpjkfmJr-Y_muzds8iVU,10
-oc_cdtapi-3.26.1.dist-info/RECORD,,
+oc_cdtapi-3.27.2.data/scripts/nexus.py,sha256=4teqZ_KtCSrwHDJVgA7lkreteod4Xt5XJFZNbwb7E6E,6858
+oc_cdtapi-3.27.2.dist-info/licenses/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
+oc_cdtapi-3.27.2.dist-info/METADATA,sha256=dNcbqIpG8PQlNEElLXIsaomDuk0X82Q8tuUwJ5U-Xjw,504
+oc_cdtapi-3.27.2.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+oc_cdtapi-3.27.2.dist-info/top_level.txt,sha256=d4-5-D-0CSeSXYuLCP7-nIFCpjkfmJr-Y_muzds8iVU,10
+oc_cdtapi-3.27.2.dist-info/RECORD,,