oc-cdtapi 3.15.1__py3-none-any.whl → 3.31.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
@@ -9,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):
@@ -20,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):
         """
@@ -67,11 +73,11 @@ 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)
-            
+
     def get_host_by_owner(self, owner):
         """
         wrapper for api v1/v2
@@ -84,18 +90,18 @@ 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)
         params = {
-            'search': f'owner_login={owner}',
+            'search': f'owner={owner}',
             'per_page': 'all'
         }
-        response = self.get('hosts', params=params)
+        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,14 +249,14 @@ 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')
         logging.debug('hostname = [%s]' % hostname)
 
         if not exp_date:
-            exp_date = self.defs.exp_date
+            exp_date = self._set_expiration()
         if not location_id:
             location_id = self.defs.location_id
         if not hostgroup:
@@ -283,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)
@@ -303,7 +309,7 @@ class ForemanAPI(HttpAPI):
         disk = 50
         owner_id = None
 
-        exp_date = self.defs.exp_date
+        exp_date = self._set_expiration()
         location_id = self.defs.location_id
         hostgroup = self.defs.hostgroup
         deploy_on = self.defs.deploy_on
@@ -341,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')
@@ -626,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):
         """
@@ -697,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):
         """
@@ -773,6 +780,14 @@ class ForemanAPI(HttpAPI):
             logging.debug(response)
         return response
 
+    def is_host_powered_on(self, hostname):
+        """
+        Returns true if host is powered on
+        """
+        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
@@ -794,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)
@@ -806,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:
@@ -866,8 +881,8 @@ 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
 
@@ -972,7 +987,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')
@@ -984,7 +999,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')
@@ -1051,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)
@@ -1169,6 +1184,44 @@ class ForemanAPI(HttpAPI):
         logging.debug('Passing to get_host_uuid_v1')
         return self.get_host_uuid_v1(hostname)
 
+    def get_host_disk_size(self, hostname):
+        """
+        :param hostname: str
+        :return: int
+        """
+        logging.debug('Reached get_host_disk_size')
+        response = self.get(posixpath.join("hosts", hostname, "vm_compute_attributes"))
+        data = response.json()
+        try:
+            volumes = data.get("volumes_attributes", {})
+            volume = volumes.get("0") or volumes.get(0)
+            if volume and "size_gb" in volume:
+                return int(volume["size_gb"])
+            logging.error('Could not find size_gb in vm_compute_attributes for [%s]' % hostname)
+            return None
+        except (KeyError, ValueError, TypeError) as e:
+            logging.error('Error parsing disk size for [%s]: %s' % (hostname, e))
+            return None
+
+    def get_host_memory_mb(self, hostname):
+        """
+        :param hostname: str
+        :return: int
+        """
+        logging.debug('Reached get_host_memory_mb')
+        response = self.get(posixpath.join("hosts", hostname, "vm_compute_attributes"))
+        data = response.json()
+
+        try:
+            memory_mb = data.get("memory_mb")
+            if memory_mb is not None:
+                return int(memory_mb)
+            logging.error('Could not find memory_mb in vm_compute_attributes for [%s]' % hostname)
+            return None
+        except (ValueError, TypeError) as e:
+            logging.error('Error parsing memory_mb for [%s]: %s' % (hostname, e))
+            return None
+
     def get_all_users(self):
         """
         :return: list
@@ -1195,16 +1248,15 @@ 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}})
+            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):
         """
@@ -1217,3 +1269,307 @@ 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(code=404, text=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(code=404, text=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(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:
+                break
+            logging.debug(f"job still pending, sleeping for {poll_interval} second")
+            sleep(poll_interval)
+
+        return bool(response.json().get("succeeded", False))
+
+    def get_parameter_value(self, hostname, parameter_name):
+        """
+        Get a parameter value by given parameter_name.
+        :param hostname: str
+        :param parameter_name: str or list/tuple - Single parameter name or list/tuple of parameter names
+        :return: dict or None - Dict of {name: value} for found parameters, None if none found
+        """
+        host_info = self.get_host_info(hostname=hostname)
+        host_parameters = host_info.get("parameters")
+        if not host_parameters:
+            return None
+
+        result = {}
+        if isinstance(parameter_name, str):
+            for host_parameter in host_parameters:
+                if host_parameter["name"] == parameter_name:
+                    result[host_parameter["name"]] = host_parameter["value"]
+                    return result
+            return None
+
+        elif isinstance(parameter_name, (list, tuple)):
+            param_set = set(parameter_name)
+            for host_parameter in host_parameters:
+                if host_parameter["name"] in param_set:
+                    result[host_parameter["name"]] = host_parameter["value"]
+            return result if result else None
+
+        return None
+
+    def set_parameter_value(self, hostname, parameter_name, parameter_value, auto_create=False):
+        """
+        Set a parameter value by given parameter_name and parameter_value.
+        Also, auto_create option will automatically create the parameter if not appear.
+        :param hostname: str
+        :param parameter_name: str
+        :param parameter_value: str
+        :param auto_create: bool
+        """
+        logging.debug('Reached set_parameter_value')
+        payload = {
+            "parameter": {
+                "name": parameter_name,
+                "value": parameter_value
+            }
+        }
+
+        if self.get_parameter_value(hostname=hostname, parameter_name=parameter_name) is None:
+            logging.debug(f"parameter {parameter_name} is not created yet")
+            if auto_create:
+                logging.debug(f"creating parameter {parameter_name}")
+                self.post(posixpath.join("hosts", hostname, "parameters"), headers=self.headers, json=payload)
+            return
+
+        logging.debug(f"updating {parameter_name}")
+        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/PgAPI.py

@@ -0,0 +1,437 @@
+import logging
+import os
+
+from oc_cdtapi import API
+from oc_cdtapi.API import HttpAPIError
+
+
+class PostgresAPI(API.HttpAPI):
+    _env_prefix = 'PSQL'
+    _env_token = 'TOKEN'
+    def __init__(self, *args, **kwargs):
+        super().__init__(*args, **kwargs)
+
+    def get_citypedms_by_citype_id(self, citype):
+        """
+        Retrieve citypedms information for a given CI type ID.
+
+        This method fetches a list of citypedms entries containing id, ci_type_id,
+        dms_id, and gav_template for the specified CI type ID.
+
+        Args:
+            citype (str): The CI type ID to query.
+
+        Returns:
+            dict: A dictionary containing citypedms information with the following keys:
+                - id: The citypedms entry ID
+                - ci_type_id: The CI type ID
+                - dms_id: The DMS ID
+                - gav_template: The GAV (Group:Artifact:Version) template
+
+        Example:
+            >>> citypedms = api.get_citypedms_by_citype_id("CI123")
+            >>> print(citypedms['id'])
+            'CP456'
+        """
+        req = f"rest/api/1/citypedms/{citype}"
+        res = self.get(req).json()
+        logging.debug(f'Using get_citypedms_by_citype_id to get information about {citype}')
+
+        return res
+
+    def get_citypedms_by_dms_id(self, dms_id):
+        """
+        Retrieve citypedms information for a given DMS ID.
+
+        This method fetches a list of citypedms entries containing id, ci_type_id,
+        dms_id, and gav_template for the specified DMS ID (component ID).
+
+        Args:
+            dms_id (str): The DMS ID (component ID) to query.
+
+        Returns:
+            dict: A dictionary containing citypedms information with the following keys:
+                - id: The citypedms entry ID
+                - ci_type_id: The CI type ID
+                - dms_id: The DMS ID
+                - gav_template: The GAV (Group:Artifact:Version) template
+
+        Example:
+            >>> citypedms = api.get_citypedms_by_dms_id("DMS789")
+            >>> print(citypedms['gav_template'])
+            'com.example:{artifact}:{version}'
+        """
+        req = f"rest/api/1/citypedms/{dms_id}?bycomponent=True"
+        res = self.get(req)
+        logging.debug(f'Using get_citypedms_by_dms_id to get information about {dms_id}')
+
+        return res.json()
+
+    def get_ci_type_by_code(self, request):
+        """
+        Retrieve a list of ci type based on the provided ci type code.
+
+        This function queries the ci database and returns a ci type
+        that match the specified code in the request.
+
+        Args:
+            code (string): A code containing search parameters. For example:
+                NSDC
+
+        Returns:
+            dict: A dict of citype object matching the search criteria.
+
+        Example:
+            >>> request = 'NSDC'
+            >>> citype = get_ci_type_by_code(request)
+            >>> print(citype)
+            {
+                "code": "NSDC",
+                "doc_artifactid": null,
+                "is_deliverable": false,
+                "is_standard": "N",
+                "name": "NetServer distribution component",
+                "rn_artifactid": null
+            }
+        """
+        req = f"rest/api/1/citype/{request}"
+        res = self.get(req)
+        logging.debug(f'Using get_ci_type_by_code to get information about citype with code {request}')
+
+        return res.json()
+
+    def get_deliveries(self, request):
+        """
+        Retrieve a list of deliveries based on the provided search criteria.
+
+        This function queries the delivery database and returns a list of deliveries
+        that match the specified parameters in the request.
+
+        Args:
+            request (dict): A dictionary containing search parameters. For example:
+                {
+                    'gav': 'somegav',
+                    'flag_approved': True
+                }
+
+        Returns:
+            list: A list of delivery objects matching the search criteria.
+
+        Example:
+            >>> request = {'gav': 'group:artifact:version', 'flag_approved': True}
+            >>> deliveries = get_delivery(request)
+            >>> print(deliveries)
+            [Delivery1, Delivery2, ...]
+        """
+        req = f"rest/api/1/deliveries"
+        res = self.get(req, params=request)
+        logging.debug(f'Using get_delivery_by_gav to get information about delivery with {request}')
+
+        return res.json()
+
+    def get_historicaldelivery(self, request):
+        """
+        Retrieve a list of historicaldelivery based on the provided search criteria.
+
+        This function queries the delivery database and returns a list of deliveries
+        that match the specified parameters in the request.
+
+        Args:
+            request (dict): A dictionary containing search parameters. For example:
+                {
+                    'gav': 'somegav',
+                    'flag_approved': True
+                }
+
+        Returns:
+            list: A list of delivery objects matching the search criteria.
+
+        Example:
+            >>> request = {'gav': 'group:artifact:version', 'flag_approved': True}
+            >>> historicaldeliveries = get_historicaldelivery(request)
+            >>> print(historicaldeliveries)
+            [HistoricalDelivery1, HistoricalDelivery1, ...]
+        """
+        req = f"rest/api/1/historicaldeliveries"
+        res = self.get(req, params=request)
+        logging.debug(f'Using get_historicaldelivery to get information about {request}')
+
+        return res.json()
+
+    def update_delivery_by_gav(self, gav, json):
+        """
+        Update delivery information for a specific GAV (Group:Artifact:Version).
+
+        This method sends a PUT request to update the delivery information
+        associated with the provided GAV.
+
+        Args:
+            gav (str): The GAV (Group:Artifact:Version) identifier of the delivery to update.
+            json (dict): A dictionary containing the updated delivery information.
+
+        Returns:
+            requests.Response: The response object from the API call.
+
+        Example:
+            >>> gav = "com.example:artifact:1.0.0"
+            >>> update_data = {"status": "approved", "version": "1.0.1"}
+            >>> response = api.update_delivery_by_gav(gav, update_data)
+            >>> print(response.status_code)
+            200
+        """
+        payload = {"gav": gav}
+        req = f"rest/api/1/deliveries"
+        res = self.put(req, json=json, params=payload)
+        logging.debug(f'Using put_delivery to update information about {gav}')
+
+        return res
+
+    def post_historicaldelivery(self, request):
+        """
+        Create a new historical delivery entry.
+
+        This method sends a POST request to create a new historical delivery
+        record with the provided information.
+
+        Args:
+            request (dict): A dictionary containing the historical delivery information to be created.
+
+        Returns:
+            dict: The JSON response from the API, typically containing the created historical delivery information.
+
+        Example:
+            >>> new_delivery = {
+            ...     "gav": "com.example:artifact:1.0.0",
+            ...     "timestamp": "2023-04-01T12:00:00Z",
+            ...     "status": "delivered"
+            ... }
+            >>> result = api.post_historicaldelivery(new_delivery)
+            >>> print(result['id'])
+            12345
+        """
+        req = f"rest/api/1/historicaldeliveries"
+        res = self.post(req, json=request)
+        logging.debug(f'Using post_historicaldelivery to create information')
+
+        return res
+
+    def post_tasks(self, request):
+        """
+        Create a new tasks entry.
+
+        This method sends a POST request to create a new tasks
+        record with the provided information.
+
+        Args:
+            request (dict): A dictionary containing the tasks information to be inserted.
+
+        Returns:
+            requests.Response: The response object from the API call.
+
+        Example:
+            >>> tasks = {
+                          ... "status": "Completed",
+                          ... "action_code": "create",
+                          ... "commentary": "",
+                          ... "task_content": {
+                          ...   "hardware": {
+                          ...     "memory_mb": 5120
+                          ...   },
+                          ...   "name": "hostname",
+                          ...   "username": "username"
+                          ... },
+                          ... "jira_verification_ticket": "ticket_id",
+                          ... "status_desc": "status"
+                        }
+            >>> result = api.post_tasks(tasks)
+            >>> print(result.status_code)
+            201
+        """
+        req = f"rest/api/1/tasks"
+        res = self.post(req, json=request)
+
+        return res
+
+    def update_task(self, task_id, request):
+        """
+        Create a new tasks entry.
+
+        This method sends a POST request to create a new tasks
+        record with the provided information.
+
+        Args:
+            request (dict): A dictionary containing the tasks information to be inserted.
+
+        Returns:
+            requests.Response: The response object from the API call.
+
+        Example:
+            >>> task_id = 2
+            >>> tasks = {
+                          ... "status": "Completed",
+                          ... "action_code": "create",
+                          ... "commentary": "",
+                          ... "task_content": {
+                          ...   "hardware": {
+                          ...     "memory_mb": 5120
+                          ...   },
+                          ...   "name": "hostname",
+                          ...   "username": "username"
+                          ... },
+                          ... "jira_verification_ticket": "ticket_id",
+                          ... "status_desc": "status"
+                        }
+            >>> result = api.update_task(tasks)
+            >>> print(result.status_code)
+            200
+        """
+        req = f"rest/api/1/tasks/{task_id}"
+        res = self.put(req, json=request)
+
+        return res
+
+    def get_task_by_id(self, task_id):
+        """
+        Get a task by id.
+
+        This method sends a GET request to get a task by desired id.
+
+        Args:
+            task_id (int): An integer of the task id.
+
+        Returns:
+            requests.Response: The response object from the API call.
+
+        Example:
+            >>> task_id = 2
+            >>> result = api.get_task_by_id(task_id)
+            >>> print(result.status_code)
+            200
+        """
+        try:
+            payload = {"id": task_id}
+            req = f"rest/api/1/tasks"
+            res = self.get(req, params=payload)
+        except HttpAPIError as e:
+            if e.code == 404:
+                return None
+            else:
+                raise HttpAPIError(e)
+
+        return res.json()[0]
+
+    def get_task_by_id_and_username(self, task_id, username):
+        """
+        Get a task by id and username.
+
+        This method sends a GET request to get a task by desired id.
+
+        Args:
+            task_id (int): An integer of the task id.
+
+        Returns:
+            requests.Response: The response object from the API call.
+
+        Example:
+            >>> task_id = 2
+            >>> result = api.get_task_by_id(task_id)
+            >>> print(result.status_code)
+            200
+        """
+        try:
+            payload = {"id": task_id, "username": username}
+            req = f"rest/api/1/tasks"
+            res = self.get(req, params=payload)
+        except HttpAPIError as e:
+            if e.code == 404:
+                return None
+            else:
+                raise HttpAPIError(e)
+
+        return res.json()[0]
+
+    def get_task_custom_filter(self, **kwargs):
+        """
+        Get a task by custom filter.
+
+        This method sends a GET request to get a task by custom filter.
+
+        Args:
+            **kwargs : Keyword arguments for filtering.
+
+        Returns:
+            requests.Response: The response object from the API call.
+
+        Example:
+            >>> task_id = 2
+            >>> param = {"id": 1, "hostname": "test.com"}
+            >>> result = api.get_task_custom_filter(**param)
+            >>> print(result.status_code)
+            200
+        """
+        try:
+            req = f"rest/api/1/tasks"
+            res = self.get(req, params=kwargs)
+        except HttpAPIError as e:
+            if e.code == 404:
+                return []
+            else:
+                raise HttpAPIError(e)
+
+        return res.json()
+
+    def get_client_by_code(self, code):
+        """
+        Get a client by code.
+
+        This method sends a GET request to get a client including the ftp upload option by code.
+
+        Args:
+            code : Client code.
+
+        Returns:
+            requests.Response: The response object from the API call.
+
+        Example:
+            >>> code = 2
+            >>> result = self.get_client_by_code(code)
+            >>> print(result.status_code)
+            200
+        """
+        req = f"rest/api/1/clients/{code}"
+        res = self.get(req)
+
+        return res.json()
+
+    def post_new_component(self, payload):
+        """
+        Post new component to the ci database.
+
+        This method sends a POST request to add new component into ci database.
+
+        Args:
+            payload : New component payload.
+
+        Returns:
+            requests.Response: The response object from the API call.
+
+        Example:
+            >>> payload = {
+                        "ci_type_id": "NEWDSTR",
+                        "ci_type_group_id": "NEW",
+                        "name": "New component",
+                        "is_standard": "Y",
+                        "is_deliverable": True,
+                        "regexp": "test.regexp.NEWDSTR:dstr:com",
+                        "loc_type_id": "NXS",
+                        "dms_id": "NEWDSTR"
+            }
+            >>> result = self.post_new_component(payload)
+            >>> print(result.status_code)
+            200
+        """
+        req = f"rest/api/1/manage_citype"
+        res = self.post(req, json=payload)
+        logging.debug(f'Using post_manage_citype to register new component')
+
+        return res

oc_cdtapi/PgQAPI.py

@@ -26,7 +26,7 @@ class PgQAPI (object):
         else:
             logging.debug('No connection provided, creating')
             self.conn = self.pg_connect(url, username, password)
-        self.message_types = ['dlartifacts', 'dlbuild', 'dlcontents', 'dlupload', 'ns']
+        self.message_types = ['dlartifacts', 'dlbuild', 'dlcontents', 'dlupload', 'ns', 'register_file', 'register_checksum']
 
     def create_queue(self, queue_code, queue_name):
         logging.debug('reached create_queue')
@@ -69,6 +69,41 @@ class PgQAPI (object):
         logging.debug(message)
         return message
 
+    def compose_dlupload(self, parms):
+        logging.debug('reached compose_dlupload')
+        logging.debug('received parms: [%s]' % parms)
+        msg = ["upload_delivery", [parms], {}]
+        logging.debug('composed: [%s]' % msg)
+        return msg
+
+    def compose_register_checksum(self, parms):
+        logging.debug('reached compose_register_checksum')
+        logging.debug('received parms: [%s]' % parms)
+        file_loc = parms.get('file_loc')
+        checksum = parms.get('checksum')
+        citype = parms.get('citype')
+        mime = parms.get('mime')
+        if file_loc is None or checksum is None or citype is None:
+            logging.error('One of mandatory parms is missing: file_loc, checksum, citype')
+            return None
+        msg = ["register_checksum", [file_loc, checksum, {"citype":citype}, mime] ]
+        return msg
+
+    def compose_register_file(self, parms):
+        logging.debug('reached compose_register_file')
+        logging.debug('received parms: [%s]' % parms)
+
+        location = parms.get("location")
+        citype = parms.get("citype")
+        depth = parms.get("depth")
+        if not location or citype is None or depth is None:
+            logging.error('location, citype, and depth must all be specified')
+            return None
+        message = ["register_file", [[*location], citype, depth], {}]
+        logging.debug('composed message')
+        logging.debug(message)
+        return message
+
     def enqueue_message(self, queue_code=None, msg_text=None, priority=50, pg_connection=None):
         logging.debug('reached enqueue_message')
         if pg_connection:
@@ -102,7 +137,7 @@ class PgQAPI (object):
     def get_msg(self, message_id):
         logging.debug('reached get_msg')
         logging.debug('getting status of message [%s]' % message_id)
-        ds = self.exec_select('select status, payload from queue_message where id = %s', (str(message_id) ) )
+        ds = self.exec_select('select status, payload from queue_message where id = %s', (str(message_id), ) )
         if ds:
             logging.debug('message found, returning [%s]', ds[0])
             return ds[0]
@@ -135,11 +170,14 @@ class PgQAPI (object):
         conn = psycopg2.connect(dsn)
         if conn:
             logging.debug('connected. [%s]' % conn)
+            logging.debug('setting autocommit to True')
+            conn.set_session(autocommit=True)
             return conn
         logging.error('failed to connect')
-        return None
+        raise ConnectionError('Failed to connect to postgres db')
 
     def msg_proc_start(self, message_id):
+        # TODO add consumer ip
         logging.debug('reached msg_proc_start')
         logging.debug('starting processing of message [%s]' % message_id)
         ds = self.get_msg(message_id)
@@ -151,6 +189,35 @@ class PgQAPI (object):
             logging.error('message [%s] is in bad status [%s]' % (str(message_id), msg_status) )
             return False
         self.exec_update('update queue_message set proc_start=now(), status=%s where id = %s', ('A', message_id) )
+        logging.debug('returning payload [%s]' % payload)
+        return payload
+
+    def msg_proc_end(self, message_id, error_message=None, comment_text=None):
+        logging.debug('reached msg_proc_end')
+        logging.debug('ending processing of message [%s]' % message_id)
+        ds = self.get_msg(message_id)
+        if not ds:
+            logging.error('message [%s] does not exist' % message_id)
+            return None
+        (msg_status, payload) = ds
+        if msg_status != 'A':
+            logging.error('message [%s] is in bad status [%s]' % (str(message_id), msg_status) )
+            return False
+        self.exec_update('update queue_message set proc_end=now(), status=%s, error_message=%s, comment_text=%s where id = %s', ('P', error_message, comment_text, message_id) )
+        return payload
+
+    def msg_proc_fail(self, message_id, error_message=None, comment_text=None):
+        logging.debug('reached msg_proc_fail')
+        logging.debug('failing processing of message [%s]' % message_id)
+        ds = self.get_msg(message_id)
+        if not ds:
+            logging.error('message [%s] does not exist' % message_id)
+            return None
+        (msg_status, payload) = ds
+        if msg_status != 'A':
+            logging.error('message [%s] is in bad status [%s]' % (str(message_id), msg_status) )
+            return False
+        self.exec_update('update queue_message set proc_end=now(), status=%s, error_message=%s, comment_text=%s where id = %s', ('F', error_message, comment_text, message_id) )
         return payload
 
     def new_msg_from_queue(self, queue_code):
@@ -160,13 +227,15 @@ class PgQAPI (object):
         if not queue_id:
             logging.error('queue [%s] does not exist' % queue_code)
             return None
-        ds = self.exec_select('select min(id), count(id) from queue_message where queue_type__oid = %s and status = %s', (queue_id, 'N') )
+        ds = self.exec_select('select min(id), count(id) from queue_message where creation_date < current_timestamp - interval \'1 minute\' and queue_type__oid = %s and status = %s', (queue_id, 'N') )
         if ds[0][1] == 0:
             logging.debug('currently no new messages in queue [%s]' % queue_code)
             return None
         msg_id = ds[0][0]
         logging.debug('found new message id [%s], [%s] new messages in queue' % (msg_id, ds[0][1]) )
-        logging.debug('setting status of message to A')
+        logging.debug('requesting payload from msg_proc_start')
         payload = self.msg_proc_start(msg_id)
-        return payload
+        logging.debug('msg_proc_start returned [%s]' % payload)
+        logging.debug('returning payload [%s] with msg_id [%s]' % (payload, msg_id) )
+        return payload,msg_id
         

oc_cdtapi/VaultAPI.py

@@ -0,0 +1,79 @@
+import logging
+import os
+
+import hvac
+from hvac.exceptions import VaultError
+
+class VaultAPI:
+    def __init__(self,
+                 vault_enable=False,
+                 vault_url=None,
+                 vault_token=None,
+                 vault_mount_point=None,
+                 verify_ssl=True):
+        self.vault_enable = vault_enable or os.getenv("VAULT_ENABLE")
+        self.vault_url = vault_url or os.getenv("VAULT_URL")
+        self.vault_token = vault_token or os.getenv("VAULT_TOKEN")
+        self.mount_point = vault_mount_point or os.getenv("VAULT_MOUNT_POINT")
+        self.use_staging_secrets = os.getenv("USE_STAGING_ENVIRONMENT", "false").lower() == "true" #Check whether we have env USE_STAGING_ENVIRONMENT true or not
+        self.verify_ssl = verify_ssl
+        self._client = None
+
+        # Create a logger instance for this class
+        self.logger = logging.getLogger(__name__)
+        
+    @property
+    def client(self):
+        if not self.vault_enable:
+            self.logger.warning("VAULT_ENABLE environment set to false, skip using vault")
+            return None
+
+        if self._client is None:
+            if not self.vault_url:
+                self.logger.warning("VAULT_URL environment variable or vault_url parameter is missing, skip using vault")
+                return None
+            if not self.vault_token:
+                self.logger.warning("VAULT_TOKEN environment variable or vault_token parameter is missing, skip using vault")
+                return None
+
+            self._client = hvac.Client(
+                url=self.vault_url,
+                token=self.vault_token,
+                verify=self.verify_ssl
+            )
+
+            if not self._client.is_authenticated():
+                self.logger.warning("Failed to authenticate with Vault - check credentials, skip using vault")
+                return None
+
+        return self._client
+
+    def parse_secret_name(self, name):
+        if 'USER' in name:
+            split_name = name.split('_USER')[0]
+            return split_name, 'USER'
+
+        if 'PASSWORD' in name:
+            split_name = name.split('_PASSWORD')[0]
+            return split_name, 'PASSWORD'
+
+        return 'OTHER', name
+
+    def get_secret_from_path(self, name):
+        client = self.client
+        if client is None:
+            return None
+
+        secret_path, credentials = self.parse_secret_name(name)
+        if self.use_staging_secrets:
+            secret_path = secret_path + "_TEST"
+
+        try:
+            response = client.secrets.kv.read_secret_version(path=secret_path, mount_point=self.mount_point)
+            return response['data']['data'].get(credentials)
+        except VaultError as e:
+            self.logger.warning(f"Failed getting data from vault for path {secret_path} and credentials {credentials}: {e}")
+            return None
+
+    def load_secret(self, name, default=None):
+        return self.get_secret_from_path(name) or os.getenv(name, default)

{oc_cdtapi-3.15.1.dist-info → oc_cdtapi-3.31.2.dist-info}/METADATA

@@ -1,6 +1,6 @@
-Metadata-Version: 2.2
+Metadata-Version: 2.4
 Name: oc-cdtapi
-Version: 3.15.1
+Version: 3.31.2
 Summary: Custom Development python API libraries
 License: Apache2.0
 Requires-Python: >=3.6
@@ -8,9 +8,12 @@ Description-Content-Type: text/plain
 License-File: LICENSE
 Requires-Dist: requests
 Requires-Dist: packaging
+Requires-Dist: psycopg2-binary
+Requires-Dist: hvac
 Dynamic: description
 Dynamic: description-content-type
 Dynamic: license
+Dynamic: license-file
 Dynamic: requires-dist
 Dynamic: requires-python
 Dynamic: summary

{oc_cdtapi-3.15.1.dist-info → oc_cdtapi-3.31.2.dist-info}/RECORD

@@ -3,16 +3,18 @@ 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=4iTez5VrrIIO9e-yO3YRLtj6uf6TNPV0gOXoYoya2zU,43958
+oc_cdtapi/ForemanAPI.py,sha256=0GsC9s9uGoYgMbsgBW5aDEGoGLGeRPJJSTAWhbelhVY,57135
 oc_cdtapi/JenkinsAPI.py,sha256=lZ8pe3a4eb_6h53JE7QLuzOSlu7Sqatc9PQwWhio9Vg,15748
 oc_cdtapi/NexusAPI.py,sha256=uU12GtHvKlWorFaPAnFcQ5AGEc94MZ5SdmfM2Pw3F7A,26122
-oc_cdtapi/PgQAPI.py,sha256=bAgwo4YVuD60uAEv7hrjTQmmAfcMP86IBlSNhlXJzWc,6882
+oc_cdtapi/PgAPI.py,sha256=URSz7qu-Ir7AOj0jI3ucTXn2PM-nC96nmPZI746OLjA,14356
+oc_cdtapi/PgQAPI.py,sha256=p2nDGrnU5juobumwq9QiVPxcsX6bHAtipUHBBxFrOeE,10312
 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.15.1.data/scripts/nexus.py,sha256=4teqZ_KtCSrwHDJVgA7lkreteod4Xt5XJFZNbwb7E6E,6858
-oc_cdtapi-3.15.1.dist-info/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
-oc_cdtapi-3.15.1.dist-info/METADATA,sha256=DYpKV3GV3Yvv-6I7JEv7UO0u7GEnufp9bwhqBzFksYk,431
-oc_cdtapi-3.15.1.dist-info/WHEEL,sha256=jB7zZ3N9hIM9adW7qlTAyycLYW9npaWKLRzaoVcLKcM,91
-oc_cdtapi-3.15.1.dist-info/top_level.txt,sha256=d4-5-D-0CSeSXYuLCP7-nIFCpjkfmJr-Y_muzds8iVU,10
-oc_cdtapi-3.15.1.dist-info/RECORD,,
+oc_cdtapi-3.31.2.data/scripts/nexus.py,sha256=4teqZ_KtCSrwHDJVgA7lkreteod4Xt5XJFZNbwb7E6E,6858
+oc_cdtapi-3.31.2.dist-info/licenses/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
+oc_cdtapi-3.31.2.dist-info/METADATA,sha256=rrW8LJY11tNQ9FXtBjY1Wc8bwIcF0rBIlniE2-j8rSM,504
+oc_cdtapi-3.31.2.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+oc_cdtapi-3.31.2.dist-info/top_level.txt,sha256=d4-5-D-0CSeSXYuLCP7-nIFCpjkfmJr-Y_muzds8iVU,10
+oc_cdtapi-3.31.2.dist-info/RECORD,,

{oc_cdtapi-3.15.1.dist-info → oc_cdtapi-3.31.2.dist-info}/WHEEL

@@ -1,5 +1,5 @@
 Wheel-Version: 1.0
-Generator: setuptools (75.8.2)
+Generator: setuptools (80.9.0)
 Root-Is-Purelib: true
 Tag: py3-none-any