oc-cdtapi 3.22.1__py3-none-any.whl → 3.24.2__py3-none-any.whl

oc_cdtapi/ForemanAPI.py

@@ -2,6 +2,8 @@ import json
 import logging
 import posixpath
 import re
+import time
+from time import sleep
 
 from oc_cdtapi.API import HttpAPI, HttpAPIError
 from collections import namedtuple, defaultdict
@@ -71,7 +73,7 @@ class ForemanAPI(HttpAPI):
             return posixpath.join(self.root, "api", req)
         else:
             return posixpath.join(self.root, req)
-            
+
     def get_host_by_owner(self, owner):
         """
         wrapper for api v1/v2
@@ -84,7 +86,7 @@ class ForemanAPI(HttpAPI):
         elif self.apiversion == 2:
             logging.debug('Passing to get_host_by_owner_v2')
             return self.get_host_by_owner_v2(owner)
-        
+
     def get_host_by_owner_v2(self, owner):
         logging.debug('Reached get_host_by_owner_v2')
         logging.debug('owner = [%s]' % owner)
@@ -95,7 +97,7 @@ class ForemanAPI(HttpAPI):
         response = self.get('hosts', params=params).json()
         results = response.get('results')
         return results
-    
+
     def get_environment(self, env_name):
         """
         wrapper for api v1/v2
@@ -243,7 +245,7 @@ class ForemanAPI(HttpAPI):
                        deploy_on, custom_json):
         """
         Creates a host using the default parameters or the ones from an external json
-        note that create_vm in engine actually sends db_task instead of hostname and custom_json, 
+        note that create_vm in engine actually sends db_task instead of hostname and custom_json,
         other parms are ignored
         """
         logging.debug('Reached create_host_v1')
@@ -780,7 +782,7 @@ class ForemanAPI(HttpAPI):
         logging.debug('Reached is_host_powered_on')
         response = self.get(posixpath.join("hosts", hostname, "power")).json()
         return response['state'] == 'on'
-    
+
     def host_power(self, hostname, action):
         """
         wrapper for api v1/v2
@@ -875,7 +877,7 @@ class ForemanAPI(HttpAPI):
         for hostgroup in hostgroups:
             if hostgroup.get("name") == hostgroup_name:
                 return hostgroup.get ('id')
-        
+
         logging.debug("Hostgroup [%s] not found, returning None" % hostgroup_name)
         return None
 
@@ -980,7 +982,7 @@ class ForemanAPI(HttpAPI):
     def set_host_expiry_v1(self, hostname, expiry):
         """
         Attempts to set host expiry date
-        :param hostname: full hostname 
+        :param hostname: full hostname
         :param expiry: expiry date in format yyyy-mm-dd
         """
         logging.debug('Reached set_host_expiry_v1')
@@ -992,7 +994,7 @@ class ForemanAPI(HttpAPI):
     def set_host_expiry_v2(self, hostname, expiry):
         """
         Attempts to set host expiry date
-        :param hostname: full hostname 
+        :param hostname: full hostname
         :param expiry: expiry date in format yyyy-mm-dd
         """
         logging.debug('Reached set_host_expiry_v2')
@@ -1222,14 +1224,14 @@ class ForemanAPI(HttpAPI):
         logging.debug('Reached set_host_owner')
         owner_id = self.get_owner(owner)
         owner_type = 'User'
-        
+
         if not owner_id:
             owner_id = self.get_usergroup_id(owner)
             owner_type = 'Usergroup'
-            
+
         if not owner_id:
             raise ForemanAPIError(f"The owner [{owner}] is not found")
-            
+
         self.update_host(hostname, {"host": {"owner_id": owner_id, "owner_type": owner_type}})
 
 
@@ -1244,3 +1246,111 @@ class ForemanAPI(HttpAPI):
         pl['host'] = {}
         pl['host']['owner_id'] = owner_id
         self.update_host(hostname, pl)
+
+    def set_backup_policy(self, hostname, backup_policy):
+        """
+        Change backup policy
+        :param hostname: str
+        :param backup_policy: str
+        """
+        logging.debug('Reached set_backup_policy')
+        payload = {
+            "parameter": {
+                "value": backup_policy
+            }
+        }
+        self.update_host(hostname=hostname, payload=payload)
+
+    def get_job_template_id(self, template_name):
+        """
+        Get template ID by name. Cache results to avoid repeated API calls.
+        :param template_name: str
+        :return template_id: int
+        """
+        logging.debug('Reached get_job_template_id')
+        if not hasattr(self, '_template_cache'):
+            self._template_cache = {}
+
+        if template_name in self._template_cache:
+            return self._template_cache[template_name]
+
+        response = self.get(posixpath.join("job_templates"), params={'per_page': 'all'})
+        templates = response.json()["results"]
+
+        for job in templates:
+            self._template_cache[job["name"]] = job["id"]
+
+        template_id = self._template_cache.get(template_name)
+        if not template_id:
+            raise ForemanAPIError(f"Job template '{template_name}' not found")
+
+        logging.debug(f"Template id for [{template_name}] is [{template_id}]")
+        return template_id
+
+    def send_job_invocation(self, task_name, vm_name, **inputs):
+        """
+        Send a job invocation for a specific task and VM.
+        :param task_name: str
+        :param vm_name: str
+        :param **inputs: kwargs
+        :return job_id
+        """
+        logging.debug('Reached send_job_invocation')
+        task_configs = {
+            "resize_partition": {
+                "template_name": "Run \"cdt-resize-partition\" role CDT",
+                "description": "Partition Resizing"
+            }
+        }
+
+        config = task_configs.get(task_name)
+        if not config:
+            raise ForemanAPIError(f"Unknown task: {task_name}")
+
+        logging.debug(f"config for [{task_name}] is [{config}]")
+
+        template_id = self.get_job_template_id(config["template_name"])
+
+        payload = {
+            "job_invocation": {
+                "job_template_id": template_id,
+                "targeting_type": "static_query",
+                "search_query": f'name = "{vm_name}"',
+                "description_format": config["description"],
+                "inputs": inputs,
+                "ansible": {
+                    "tags": "",
+                    "tags_flag": "include"
+                }
+            }
+        }
+
+        logging.debug(f"About to send job invocations with following request [{payload}]")
+        response = self.post(
+            posixpath.join("job_invocations"),
+            headers=self.headers,
+            json=payload
+        )
+
+        return response.json()["id"]
+
+    def is_job_invocation_success(self, job_id, timeout=300, poll_interval=5):
+        """
+        Get a job status by given id.
+        :param job_id: str
+        :param timeout: int
+        :param poll_interval: int
+        :return status: bool
+        """
+        start_time = time.time()
+        while True:
+            if time.time() - start_time > timeout:
+                raise ForemanAPIError(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:
+                break
+            logging.debug(f"job still pending, sleeping for {poll_interval} second")
+            sleep(poll_interval)
+
+        return bool(response.json().get("succeeded", False))

{oc_cdtapi-3.22.1.dist-info → oc_cdtapi-3.24.2.dist-info}/METADATA

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

{oc_cdtapi-3.22.1.dist-info → oc_cdtapi-3.24.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=tdD7PXGPeUq7wgwI8D3QkILB-pOICbQCQMyE9BXZhNE,45046
+oc_cdtapi/ForemanAPI.py,sha256=I8AIOkJk8_HQ_YJclhePUUn_FNRbTkKG00CXmZtuQdk,48727
 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.22.1.data/scripts/nexus.py,sha256=4teqZ_KtCSrwHDJVgA7lkreteod4Xt5XJFZNbwb7E6E,6858
-oc_cdtapi-3.22.1.dist-info/licenses/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
-oc_cdtapi-3.22.1.dist-info/METADATA,sha256=JbARpF0q8pRtbrbo0NedtjD-21ywiWteCpn8cxeHDt8,504
-oc_cdtapi-3.22.1.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-oc_cdtapi-3.22.1.dist-info/top_level.txt,sha256=d4-5-D-0CSeSXYuLCP7-nIFCpjkfmJr-Y_muzds8iVU,10
-oc_cdtapi-3.22.1.dist-info/RECORD,,
+oc_cdtapi-3.24.2.data/scripts/nexus.py,sha256=4teqZ_KtCSrwHDJVgA7lkreteod4Xt5XJFZNbwb7E6E,6858
+oc_cdtapi-3.24.2.dist-info/licenses/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
+oc_cdtapi-3.24.2.dist-info/METADATA,sha256=i8t_cC5famMxrEnhwIX_qR40f7w9NomCxNxCzHvmz_E,504
+oc_cdtapi-3.24.2.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+oc_cdtapi-3.24.2.dist-info/top_level.txt,sha256=d4-5-D-0CSeSXYuLCP7-nIFCpjkfmJr-Y_muzds8iVU,10
+oc_cdtapi-3.24.2.dist-info/RECORD,,