oc-cdtapi 3.25.3__py3-none-any.whl → 3.26.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):
@@ -285,10 +286,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 +344,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 +629,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 +700,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 +806,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 +818,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 +878,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 +1063,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 +1232,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 +1283,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 +1306,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 +1346,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:
@@ -1359,18 +1360,28 @@ class ForemanAPI(HttpAPI):
         """
         Get a parameter value by given parameter_name.
         :param hostname: str
-        :param parameter_name: str
-        :return value: 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
         """
-        logging.debug('Reached get_parameter_value')
         host_info = self.get_host_info(hostname=hostname)
         host_parameters = host_info.get("parameters")
         if not host_parameters:
             return None
 
-        for host_parameter in host_parameters:
-            if host_parameter["name"] == parameter_name:
-                return host_parameter["value"]
+        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
 

{oc_cdtapi-3.25.3.dist-info → oc_cdtapi-3.26.2.dist-info}/METADATA

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

{oc_cdtapi-3.25.3.dist-info → oc_cdtapi-3.26.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=8mMia9tIqKNCJ9yHzOnMgQaBmcH2IIacuS-IW2Wwy68,50546
+oc_cdtapi/ForemanAPI.py,sha256=blS0E2fyF2cgdnIT5itTrLExWRODBRzaOhAG35QnKN0,51393
 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.25.3.data/scripts/nexus.py,sha256=4teqZ_KtCSrwHDJVgA7lkreteod4Xt5XJFZNbwb7E6E,6858
-oc_cdtapi-3.25.3.dist-info/licenses/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
-oc_cdtapi-3.25.3.dist-info/METADATA,sha256=twFTNRNuw7V4yMHbtY5ylWFh6CnKMRwaP2L7IwKNK7Y,504
-oc_cdtapi-3.25.3.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-oc_cdtapi-3.25.3.dist-info/top_level.txt,sha256=d4-5-D-0CSeSXYuLCP7-nIFCpjkfmJr-Y_muzds8iVU,10
-oc_cdtapi-3.25.3.dist-info/RECORD,,
+oc_cdtapi-3.26.2.data/scripts/nexus.py,sha256=4teqZ_KtCSrwHDJVgA7lkreteod4Xt5XJFZNbwb7E6E,6858
+oc_cdtapi-3.26.2.dist-info/licenses/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
+oc_cdtapi-3.26.2.dist-info/METADATA,sha256=633OzwA9vkGtpD5kA4ebTHVzrLL12isuJXUb2gSWxgc,504
+oc_cdtapi-3.26.2.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+oc_cdtapi-3.26.2.dist-info/top_level.txt,sha256=d4-5-D-0CSeSXYuLCP7-nIFCpjkfmJr-Y_muzds8iVU,10
+oc_cdtapi-3.26.2.dist-info/RECORD,,