ctm-python-client 2.3.7__py3-none-any.whl → 2.4.0__py3-none-any.whl

aapi/bases.py

@@ -2,6 +2,9 @@ import attrs
 import enum
 import typing
 import json
+import random
+from ctm_python_client.core.comm import Environment
+from ctm_python_client.core.monitoring import RunMonitor
 
 class AAPIJob:
     pass
@@ -57,4 +60,42 @@ class AAPIObject:
 
     def as_dict(self):        
         return attrs.asdict(self)
-    
+    
+    def run_on_demand(self, environment: Environment, inpath: str = f'run_on_demand{random.randint(100,999)}', controlm_server: str = None, 
+                      run_as: str = None, host: str = None, application: str = None, sub_application: str = None, skip_login: bool = False, 
+                      file_path: str = None, delete_afterwards: bool = True, open_in_browser: str = None) -> RunMonitor:        
+        # Import circular dependency
+        from ctm_python_client.core.workflow import Workflow, WorkflowDefaults
+        from aapi import Job, Folder
+        
+        if isinstance(self, Job) or (hasattr(self, 'job_list') and self.job_list is not None and len(self.job_list) > 0):
+            try:
+                on_demand_workflow = Workflow(
+                    environment,
+                    WorkflowDefaults(
+                        controlm_server=controlm_server,
+                        run_as=run_as,
+                        host=host,
+                        application=application,
+                        sub_application=sub_application
+                    )
+                )
+                if isinstance(self, Folder):
+                    on_demand_workflow.add(self)
+                else:
+                    on_demand_workflow.add(self, inpath=inpath)
+                
+                on_demand_workflow.run_on_demand(
+                    skip_login=skip_login, 
+                    file_path=file_path, 
+                    delete_afterwards=delete_afterwards,
+                    open_in_browser=open_in_browser
+                    )
+            except Exception as e:
+                errors = [err.get('message', '') + ' ' + err.get('item', '')
+                    for err in json.loads(e.body)['errors']]
+                raise RuntimeError(f"AAPI request failed: {', '.join(errors)}")
+            finally:
+                on_demand_workflow.clear_all()
+        else:
+            raise Exception('Run is not allowed for json without jobs')

clients/ctm_api_client/api/run_api.py

@@ -3413,6 +3413,112 @@ class RunApi(object):
             collection_formats=collection_formats,
         )
 
+    def run_on_demand(self, definitions_file, annotation=None, **kwargs):  # noqa: E501
+        """Run a job on demand  # noqa: E501
+
+        Run a job on demand  # noqa: E501
+        This method makes a synchronous HTTP request by default. To make an
+        asynchronous HTTP request, please pass async_req=True
+        >>> thread = api.run_on_demand(definitions_file, async_req=True)
+        >>> result = thread.get()
+
+        :param async_req bool
+        :param file definitions_file: A file that contains jobs definitions to be run on demand (required)
+        :param file deploy_descriptor_file: Deploy Descriptor JSON file.
+        :param annotation - user annotation
+        :return: RunResult
+                 If the method is called asynchronously,
+                 returns the request thread.
+        """
+        kwargs['_return_http_data_only'] = True
+        if kwargs.get('async_req'):
+            return self.run_on_demand_with_http_info(definitions_file, annotation, **kwargs)  # noqa: E501
+        else:
+            (data) = self.run_on_demand_with_http_info(definitions_file, annotation, **kwargs)  # noqa: E501
+            return data
+ 
+
+    def run_on_demand_with_http_info(self, definitions_file, annotation, **kwargs):  # noqa: E501
+        """Run a job on demand  # noqa: E501
+
+        Run a job on demand  # noqa: E501
+        This method makes a synchronous HTTP request by default. To make an
+        asynchronous HTTP request, please pass async_req=True
+        >>> thread = api.run_on_demand_with_http_info(definitions_file, async_req=True)
+        >>> result = thread.get()
+
+        :param async_req bool
+        :param file definitions_file: A file that contains jobs definitions to be run on demand (required)
+        :param file deploy_descriptor_file: Deploy Descriptor JSON file.
+        :param annotation - user annotation
+        :return: RunResult
+                 If the method is called asynchronously,
+                 returns the request thread.
+        """
+
+        all_params = ['definitions_file', 'deploy_descriptor_file']  # noqa: E501
+        all_params.append('async_req')
+        all_params.append('_return_http_data_only')
+        all_params.append('_preload_content')
+        all_params.append('_request_timeout')
+
+        params = locals()
+        for key, val in six.iteritems(params['kwargs']):
+            if key not in all_params:
+                raise TypeError(
+                    "Got an unexpected keyword argument '%s'"
+                    " to method run_on_demand" % key
+                )
+            params[key] = val
+        del params['kwargs']
+        # verify the required parameter 'definitions_file' is set
+        if self.api_client.client_side_validation and ('definitions_file' not in params or
+                                                       params['definitions_file'] is None):  # noqa: E501
+            raise ValueError("Missing the required parameter `definitions_file` when calling `run_on_demand`")  # noqa: E501
+
+        collection_formats = {}
+
+        path_params = {}
+
+        query_params = []
+
+        header_params = annotation.get_annotation() if annotation else {}
+
+        form_params = []
+        local_var_files = {}
+        if 'definitions_file' in params:
+            local_var_files['definitionsFile'] = params['definitions_file']  # noqa: E501
+        if 'deploy_descriptor_file' in params:
+            local_var_files['deployDescriptorFile'] = params['deploy_descriptor_file']  # noqa: E501
+
+        body_params = None
+        # HTTP header `Accept`
+        header_params['Accept'] = self.api_client.select_header_accept(
+            ['application/json'])  # noqa: E501
+
+        # HTTP header `Content-Type`
+        header_params['Content-Type'] = self.api_client.select_header_content_type(  # noqa: E501
+            ['multipart/form-data'])  # noqa: E501
+
+        # Authentication setting
+        auth_settings = ['ApiKeyAuth', 'Bearer']  # noqa: E501
+
+        return self.api_client.call_api(
+            '/run/ondemand', 'POST',
+            path_params,
+            query_params,
+            header_params,
+            body=body_params,
+            post_params=form_params,
+            files=local_var_files,
+            response_type='RunResult',  # noqa: E501
+            auth_settings=auth_settings,
+            async_req=params.get('async_req'),
+            _return_http_data_only=params.get('_return_http_data_only'),
+            _preload_content=params.get('_preload_content', True),
+            _request_timeout=params.get('_request_timeout'),
+            collection_formats=collection_formats)
+
     def run_now(self, job_id, **kwargs):  # noqa: E501
         """Bypass scheduling cretirias and start the job  # noqa: E501
 

clients/ctm_saas_client/api/run_api.py

@@ -2723,6 +2723,112 @@ class RunApi(object):
             _request_timeout=params.get('_request_timeout'),
             collection_formats=collection_formats)
 
+    def run_on_demand(self, definitions_file, annotation=None, **kwargs):  # noqa: E501
+        """Run a job on demand  # noqa: E501
+
+        Run a job on demand  # noqa: E501
+        This method makes a synchronous HTTP request by default. To make an
+        asynchronous HTTP request, please pass async_req=True
+        >>> thread = api.run_on_demand(definitions_file, async_req=True)
+        >>> result = thread.get()
+
+        :param async_req bool
+        :param file definitions_file: A file that contains jobs definitions to be run on demand (required)
+        :param file deploy_descriptor_file: Deploy Descriptor JSON file.
+        :param annotation - user annotation
+        :return: RunResult
+                 If the method is called asynchronously,
+                 returns the request thread.
+        """
+        kwargs['_return_http_data_only'] = True
+        if kwargs.get('async_req'):
+            return self.run_on_demand_with_http_info(definitions_file, annotation, **kwargs)  # noqa: E501
+        else:
+            (data) = self.run_on_demand_with_http_info(definitions_file, annotation, **kwargs)  # noqa: E501
+            return data
+ 
+
+    def run_on_demand_with_http_info(self, definitions_file, annotation, **kwargs):  # noqa: E501
+        """Run a job on demand  # noqa: E501
+
+        Run a job on demand  # noqa: E501
+        This method makes a synchronous HTTP request by default. To make an
+        asynchronous HTTP request, please pass async_req=True
+        >>> thread = api.run_on_demand_with_http_info(definitions_file, async_req=True)
+        >>> result = thread.get()
+
+        :param async_req bool
+        :param file definitions_file: A file that contains jobs definitions to be run on demand (required)
+        :param file deploy_descriptor_file: Deploy Descriptor JSON file.
+        :param annotation - user annotation
+        :return: RunResult
+                 If the method is called asynchronously,
+                 returns the request thread.
+        """
+
+        all_params = ['definitions_file', 'deploy_descriptor_file']  # noqa: E501
+        all_params.append('async_req')
+        all_params.append('_return_http_data_only')
+        all_params.append('_preload_content')
+        all_params.append('_request_timeout')
+
+        params = locals()
+        for key, val in six.iteritems(params['kwargs']):
+            if key not in all_params:
+                raise TypeError(
+                    "Got an unexpected keyword argument '%s'"
+                    " to method run_on_demand" % key
+                )
+            params[key] = val
+        del params['kwargs']
+        # verify the required parameter 'definitions_file' is set
+        if self.api_client.client_side_validation and ('definitions_file' not in params or
+                                                       params['definitions_file'] is None):  # noqa: E501
+            raise ValueError("Missing the required parameter `definitions_file` when calling `run_on_demand`")  # noqa: E501
+
+        collection_formats = {}
+
+        path_params = {}
+
+        query_params = []
+
+        header_params = annotation.get_annotation() if annotation else {}
+
+        form_params = []
+        local_var_files = {}
+        if 'definitions_file' in params:
+            local_var_files['definitionsFile'] = params['definitions_file']  # noqa: E501
+        if 'deploy_descriptor_file' in params:
+            local_var_files['deployDescriptorFile'] = params['deploy_descriptor_file']  # noqa: E501
+
+        body_params = None
+        # HTTP header `Accept`
+        header_params['Accept'] = self.api_client.select_header_accept(
+            ['application/json'])  # noqa: E501
+
+        # HTTP header `Content-Type`
+        header_params['Content-Type'] = self.api_client.select_header_content_type(  # noqa: E501
+            ['multipart/form-data'])  # noqa: E501
+
+        # Authentication setting
+        auth_settings = ['ApiKeyAuth', 'Bearer']  # noqa: E501
+
+        return self.api_client.call_api(
+            '/run/ondemand', 'POST',
+            path_params,
+            query_params,
+            header_params,
+            body=body_params,
+            post_params=form_params,
+            files=local_var_files,
+            response_type='RunResult',  # noqa: E501
+            auth_settings=auth_settings,
+            async_req=params.get('async_req'),
+            _return_http_data_only=params.get('_return_http_data_only'),
+            _preload_content=params.get('_preload_content', True),
+            _request_timeout=params.get('_request_timeout'),
+            collection_formats=collection_formats)
+
     def run_now(self, job_id, **kwargs):  # noqa: E501
         """Bypass scheduling cretirias and start the job  # noqa: E501
 

ctm_python_client/__init__.py

@@ -1,2 +1,2 @@
-__version__ = '2.3.7'
+__version__ = '2.4.0'
 __author__ = 'BMC Software'

ctm_python_client/core/workflow.py

@@ -67,8 +67,7 @@ class WorkflowDefaults:
     run_as: str = attrs.field(default=None, metadata={'applyon': [
                               'Folder', 'SimpleFolder', 'SubFolder', 'Job']})
     host: str = attrs.field(default=None, metadata={'applyon': ['Job']})
-    when: Job.When = attrs.field(default=None, metadata={
-                                 'applyon': ['Folder', 'Job']})
+    when: Job.When = attrs.field(default=None, metadata={'applyon': ['Folder', 'Job']})
     application: str = attrs.field(default=None, metadata={'applyon': [
                                    'Folder', 'SimpleFolder', 'SubFolder', 'Job']})
     sub_application: str = attrs.field(default=None, metadata={'applyon': [
@@ -129,7 +128,7 @@ class BaseWorkflow(AbstractWorkflow):
             pass
 
         if inpath:
-            if isinstance(obj, SubFolder) or isinstance(obj, Job):
+            if isinstance(obj, SubFolder) or isinstance(obj, Job) or isinstance(obj, AAPIJob):
                 try:
                     folder = self.get(inpath)
                 except Exception as e:
@@ -138,7 +137,7 @@ class BaseWorkflow(AbstractWorkflow):
                     else:
                         raise e
                 if folder:
-                    if isinstance(obj, Job):
+                    if isinstance(obj, Job) or isinstance(obj, AAPIJob):
                         folder.job_list.append(obj)
                     else:
                         folder.sub_folder_list.append(obj)
@@ -146,7 +145,7 @@ class BaseWorkflow(AbstractWorkflow):
                     # Folder does not exist, create folder
                     folder, parent_folder = self.create_folder_hierarchy(inpath)
                     self._apply_defaults_for_folder(folder)
-                    if isinstance(obj, Job):
+                    if isinstance(obj, Job) or isinstance(obj, AAPIJob):
                         parent_folder.job_list.append(obj)
                     else:
                         parent_folder.sub_folder_list.append(obj)
@@ -408,13 +407,40 @@ class Workflow(BaseWorkflow):
 
         try:
             res = self.aapiclient.run_api.run_jobs(fpath.resolve())
-            # return res
             run_ =  RunMonitor(res.run_id, self.aapiclient, monitor_page_uri= res.monitor_page_uri)
-            if open_in_browser:                
+            if open_in_browser:
                 run_.open_in_browser()
             return run_
         except Exception as e:
-            raise e
+            errors = [err.get('message', '') + ' ' + err.get('item', '')
+                      for err in json.loads(e.body)['errors']]
+            raise RuntimeError(f"AAPI request failed: {', '.join(errors)}")
+        finally:
+            if delete_afterwards:
+                fpath.unlink()
+
+    def run_on_demand(self, skip_login: bool = False, file_path: str = None, delete_afterwards: bool = True, open_in_browser=False) -> RunMonitor:
+        if not skip_login:
+            self.aapiclient.authenticate()
+
+        if not file_path:
+            file_path = f'{tempfile.gettempdir()}/temp_{random.randint(1000,9999)}.json'
+
+        fpath = pathlib.Path(file_path)
+
+        with open(fpath.resolve(), 'w') as f:
+            self.dump_json(f)
+
+        try:
+            res = self.aapiclient.run_api.run_on_demand(fpath.resolve())
+            run_ =  RunMonitor(res.run_id, self.aapiclient, monitor_page_uri= res.monitor_page_uri)
+            if open_in_browser:           
+                run_.open_in_browser()
+            return run_
+        except Exception as e:
+            errors = [err.get('message', '') + ' ' + err.get('item', '')
+                for err in json.loads(e.body)['errors']]
+            raise RuntimeError(f"AAPI request failed: {', '.join(errors)}")
         finally:
             if delete_afterwards:
                 fpath.unlink()

{ctm_python_client-2.3.7.dist-info → ctm_python_client-2.4.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: ctm-python-client
-Version: 2.3.7
+Version: 2.4.0
 Summary: Python Workflows for Control-M
 Author: BMC Software
 License: BSD 3-Clause

{ctm_python_client-2.3.7.dist-info → ctm_python_client-2.4.0.dist-info}/RECORD

@@ -3,7 +3,7 @@ aapi/action.py,sha256=te1lr64tU7854Oy4lUjQgh1EIlZzO82ulA-NnfiK9ko,1622
 aapi/addevents.py,sha256=maZH3TpP1C1usvM2qee4DNl1PUA6IpnAWUKki1WGUlg,793
 aapi/ai.py,sha256=3mZu6I8PSbnr0v6AKxZ3-OA8RbdHlI55qCeaqlF3iXA,2094
 aapi/basefolder.py,sha256=l6wHCwCr-RkJIaDQGzV22bbHk6DQWiNpKHKmOe0x-I4,14191
-aapi/bases.py,sha256=isZW33dtSWJ2A7fdUQNumUB0_lXk8VtDYLHZb1cA_jw,1952
+aapi/bases.py,sha256=D-U9pJgOSSe_w2gy2rusNwYhUY4PyBwdY7qk94ry23s,4053
 aapi/businessfield.py,sha256=T11iWMIp8BtQCCrkR3glp0E7dKOLI00qO3lKT6_Ngdw,373
 aapi/businessparameter.py,sha256=Ee8NBDM4TDA2wx7T2lsj1yaNRJ-Pt5FADPCwx8qa4JU,3372
 aapi/calendar.py,sha256=C6mAQhypnSs2IG1CKRbjTekLdo87AHJ5GM_a3HofF3c,9322
@@ -87,7 +87,7 @@ clients/ctm_api_client/api/config_api.py,sha256=uoWYF7hS_vHUMAWZWpncbwhZw4a3ehUO
 clients/ctm_api_client/api/deploy_api.py,sha256=SfOADZT87KtgWKnxqo6C8XrL_QjGdy6rf-iFwyvC0rU,100862
 clients/ctm_api_client/api/provision_api.py,sha256=vSKrVGMpwP5_Tn8JtEWdLcyfWJs2bNnywBSiin0r6k8,45868
 clients/ctm_api_client/api/reporting_api.py,sha256=PN0lhmNLuTMV73EvQo1MNHdAq2ka9FaJKA2yuMGcok4,16864
-clients/ctm_api_client/api/run_api.py,sha256=7xV6H0abzdM4vBE3PvoTpROAe7q0UUn8-DjFpPyeVTM,153524
+clients/ctm_api_client/api/run_api.py,sha256=KcogHTqwlHkqgs0Zznom_qS-UuRD16m5VjMkk4vmPb4,158136
 clients/ctm_api_client/api/session_api.py,sha256=lM1O-r-zFjV687Y7OjItK5-XLVFTzCmN18N0_cZTEyU,12005
 clients/ctm_api_client/models/__init__.py,sha256=VP4dbGWWe6V45cEhxBtVV-6SUOdDTCt-S0NXdiuCdhs,26274
 clients/ctm_api_client/models/actions_auth_record.py,sha256=GNFj9AGdNHfiZhKimjv2_C_CvA_SL0qx1oQs8tNxKXQ,24898
@@ -409,7 +409,7 @@ clients/ctm_saas_client/api/config_api.py,sha256=JaWStV4EOptbZfSXLsvrVxYOgGJ6JcH
 clients/ctm_saas_client/api/deploy_api.py,sha256=WRZ-JJLSgn6sQRKGCnkSTCVStJcF2NJLHzwG9pYgwOE,90990
 clients/ctm_saas_client/api/provision_api.py,sha256=CZpb84Nr43fccJiAfJQaIdULz8jGG57d88eOvrz2q0U,4826
 clients/ctm_saas_client/api/reporting_api.py,sha256=uQZ1uDxmkeH1nLYuTFUf-S9C9mgiL2moqRTMJpbwqE0,12476
-clients/ctm_saas_client/api/run_api.py,sha256=QH2bQllLlc2Cude8puPZXqR-VTgw0Btd5-TwK0dtCdk,131542
+clients/ctm_saas_client/api/run_api.py,sha256=Xi2GyfXhmdfAeWHjzJNwvfT_uI8zix3Rv2b3V3c3bew,136154
 clients/ctm_saas_client/api/usage_api.py,sha256=4KnU1HSn4Zx61Qqd8niCSXFPVnfPAkv_rOaAkHUEdGA,4173
 clients/ctm_saas_client/models/__init__.py,sha256=s0u_kaVbJMgHUifVoA6Fv2JZ1QheYS_yINoXwY_0tDY,26099
 clients/ctm_saas_client/models/actions_auth_record.py,sha256=4sj40sUgg51abuO_1-6dKRnb0Ze3dc_kZmAwDwrxa-4,21362
@@ -728,18 +728,18 @@ clients/ctm_saas_client/models/workspace_folder.py,sha256=Uxn61e8LzGzceVV6TBofuy
 clients/ctm_saas_client/models/workspace_folders.py,sha256=rpVIXVw8Fh_9W-mfuDEDClC0vYTStKQo_8zgGcGaZu8,3455
 clients/ctm_saas_client/models/zoo_keeper.py,sha256=qYqn4P4CaKqLAKSxBoJvwxm1OGUcS8cmy9BW8Ul7maI,8790
 clients/ctm_saas_client/models/zos_template_data.py,sha256=RF7S-oR4rmbwc_WJDebk2SLvkAku4uxd_a59Cq_DzVM,18096
-ctm_python_client/__init__.py,sha256=-eZ0f6luAq4x-O3DO2KG4XTaGZfxd8mqaF52EkETsP4,49
+ctm_python_client/__init__.py,sha256=_V6aCUYLW1K7XSSg3wcOLFlB_QjeIMUpBFyaXzpdYYI,49
 ctm_python_client/core/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 ctm_python_client/core/comm.py,sha256=33NSUm-dI9jo7jwQft76KSxridmQsjuX-0eNbQSH5Fo,6726
 ctm_python_client/core/credential.py,sha256=UDN1Q8IYf-ufiXUr-aHm1MDu9bVX8J0Hk8BhvlmYfKk,1009
 ctm_python_client/core/monitoring.py,sha256=62fbSTEGFpHcBrXK8R8cWejq6DlrmdaNumXbOaDa3HY,12043
-ctm_python_client/core/workflow.py,sha256=Tx-IoB3rQxOQTtw6M0NEsj5HRgWG8IAGIkTsCZwCx3Q,15018
+ctm_python_client/core/workflow.py,sha256=eA4gqbPEF9PqoYr3FXrcsbYuXRd8PbFkBzjNA0VOXes,16283
 ctm_python_client/ext/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 ctm_python_client/ext/autogen.py,sha256=Oo5UZ2HKIuMh98e2FDb9GN9dChVe1mt3kcaaOaqBNPk,6671
 ctm_python_client/ext/credential.py,sha256=2AdNAPtquq9ApH41pWi8Zt8mhlh9VNWVFXeLCNrxOfA,469
 ctm_python_client/ext/viz.py,sha256=oVY7DYP0H-nCGRQIb1nZgspc8DQdsS8yWUCAl5x_dwg,1672
-ctm_python_client-2.3.7.dist-info/LICENSE,sha256=L9eFhIgJK0TNYFm9I7tDUR1CDI8muWkBJvzpbkGCVh8,1525
-ctm_python_client-2.3.7.dist-info/METADATA,sha256=2QMTNMGbGRwtyJYsoBuDJpmPPZHrcBYA7ffwrY2oVrg,2921
-ctm_python_client-2.3.7.dist-info/WHEEL,sha256=oiQVh_5PnQM0E3gPdiz09WCNmwiHDMaGer_elqB3coM,92
-ctm_python_client-2.3.7.dist-info/top_level.txt,sha256=Dz3aBWbGmLA3lZcNMUAWX_Yhdw0FdplhI52YBid8Oe0,31
-ctm_python_client-2.3.7.dist-info/RECORD,,
+ctm_python_client-2.4.0.dist-info/LICENSE,sha256=L9eFhIgJK0TNYFm9I7tDUR1CDI8muWkBJvzpbkGCVh8,1525
+ctm_python_client-2.4.0.dist-info/METADATA,sha256=RQdSpI7wkf_Jrz0YRZyLpzRZB559yeHOGCtkr2HP8g0,2921
+ctm_python_client-2.4.0.dist-info/WHEEL,sha256=oiQVh_5PnQM0E3gPdiz09WCNmwiHDMaGer_elqB3coM,92
+ctm_python_client-2.4.0.dist-info/top_level.txt,sha256=Dz3aBWbGmLA3lZcNMUAWX_Yhdw0FdplhI52YBid8Oe0,31
+ctm_python_client-2.4.0.dist-info/RECORD,,