Finish CLI function implementations

python/lib/client/dmod/client/_version.py

@@ -1 +1 @@
-__version__ = '0.4.3'
+__version__ = '0.5.0'

python/lib/client/dmod/client/request_clients.py

@@ -5,6 +5,9 @@
 from dmod.communication.dataset_management_message import DatasetManagementMessage, DatasetManagementResponse, \
     MaaSDatasetManagementMessage, MaaSDatasetManagementResponse, QueryType, DatasetQuery
 from dmod.communication.data_transmit_message import DataTransmitMessage, DataTransmitResponse
+from dmod.communication.maas_request.job_message import (JobControlAction, JobControlRequest, JobControlResponse,
+                                                         JobInfoRequest, JobInfoResponse, JobListRequest,
+                                                         JobListResponse)
 from dmod.core.exception import DmodRuntimeError
 from dmod.core.meta_data import DataCategory, DataDomain
 from dmod.core.serializable import BasicResultIndicator, ResultIndicator
@@ -24,6 +27,67 @@ def __init__(self, transport_client: TransportLayerClient, auth_client: AuthClie
         self._transport_client: TransportLayerClient = transport_client
         self._auth_client: AuthClient = auth_client
 
+    async def _job_control_request(self, job_id, action: JobControlAction) -> JobControlResponse:
+        """
+        Helper function for centralizing/parameterizing different job control actions possible via the public interface.
+
+        Parameters
+        ----------
+        job_id
+            The job to request action on.
+        action
+            The type of action to request.
+
+        Returns
+        -------
+        JobControlResponse
+            A response object indicating success or failure of the action request, as well as relevant details.
+        """
+        raw_response = None
+        try:
+            raw_response = await self._submit_job_request(JobControlRequest(job_id=job_id, action=action))
+            response = JobControlResponse.factory_init_from_deserialized_json(json.loads(raw_response))
+            if response is not None:
+                return response
+            else:
+                return JobControlResponse(job_id=job_id, action=action, success=False,
+                                          reason="Response Deserializing Failed", data={"raw_response": raw_response},
+                                          message="Unable to deserialize JSON to response object")
+        except Exception as e:
+            return JobControlResponse(job_id=job_id, action=action, success=False, reason=e.__class__.__name__,
+                                      message=str(e), data={"raw_response": raw_response} if raw_response else None)
+
+    async def _job_info_request(self, job_id: str, status_only: bool) -> JobInfoResponse:
+        """
+        Single central helper function for handling job info request scenarios supported by the public interface.
+
+        Parameters
+        ----------
+        job_id
+            The job for which to request state details.
+        status_only
+            Whether only the job's status is being requested, as opposed to the full state of the job object.
+
+        Returns
+        -------
+        JobInfoResponse
+            A response object indicating success or failure and containing the requested state info when successful.
+        """
+        raw_response = None
+        try:
+            raw_response = await self._submit_job_request(request=JobInfoRequest(job_id=job_id,
+                                                                                 status_only=status_only))
+            response = JobInfoResponse.factory_init_from_deserialized_json(json.loads(raw_response))
+            if response is not None:
+                return response
+            else:
+                return JobInfoResponse(job_id=job_id, status_only=status_only, success=False,
+                                       reason="Response Deserializing Failed", data={"raw_response": raw_response},
+                                       message=f"Unable to deserialize JSON to {JobInfoResponse.__class__.__name__}")
+        except Exception as e:
+            return JobInfoResponse(job_id=job_id, status_only=status_only, success=False, reason=e.__class__.__name__,
+                                   message=str(e), data={"raw_response": raw_response} if raw_response else None)
+
     async def _submit_job_request(self, request) -> str:
         if await self._auth_client.apply_auth(request):
             # Some clients may be async context managers
@@ -37,7 +101,7 @@ async def _submit_job_request(self, request) -> str:
         else:
             msg = f"{self.__class__.__name__} could not use {self._auth_client.__class__.__name__} to authenticate " \
                   f"{request.__class__.__name__}"
-            raise RuntimeError(msg)
+            raise DmodRuntimeError(msg)
 
     async def get_jobs_list(self, active_only: bool) -> List[str]:
         """
@@ -71,8 +135,7 @@ async def get_jobs_list(self, active_only: bool) -> List[str]:
         else:
             return indicator.data
 
-    # TODO: this is going to need some adjustments to the type hinting
-    async def request_job_info(self, job_id: str, *args, **kwargs) -> ResultIndicator:
+    async def request_job_info(self, job_id: str, *args, **kwargs) -> JobInfoResponse:
         """
         Request the full state of the provided job, formatted as a JSON dictionary.
 
@@ -87,14 +150,13 @@ async def request_job_info(self, job_id: str, *args, **kwargs) -> ResultIndicato
 
         Returns
         -------
-        ResultIndicator
-            An indicator of success of the request that, when successful, contains he full state of the provided job,
+        JobInfoResponse
+            An indicator of success of the request that, when successful, contains the full state of the provided job,
             formatted as a JSON dictionary, in the ``data`` attribute.
         """
-        # TODO: implement
-        raise NotImplementedError('{} function "request_job_info" not implemented yet'.format(self.__class__.__name__))
+        return await self._job_info_request(job_id=job_id, status_only=False)
 
-    async def request_job_release(self, job_id: str, *args, **kwargs) -> ResultIndicator:
+    async def request_job_release(self, job_id: str, *args, **kwargs) -> JobControlResponse:
         """
         Request the allocated resources for the provided job be released.
 
@@ -109,13 +171,32 @@ async def request_job_release(self, job_id: str, *args, **kwargs) -> ResultIndic
 
         Returns
         -------
-        ResultIndicator
+        JobControlResponse
             An indicator of whether there had been allocated resources for the job, all of which are now released.
         """
-        # TODO: implement
-        raise NotImplementedError('{} function "request_job_release" not implemented yet'.format(self.__class__.__name__))
+        return await self._job_control_request(job_id=job_id, action=JobControlAction.RELEASE)
 
-    async def request_job_status(self, job_id: str, *args, **kwargs) -> BasicResultIndicator:
+    async def request_job_restart(self, job_id: str, *args, **kwargs) -> JobControlResponse:
+        """
+        Request a job - expected be stopped - be resumed; i.e., transitioned from ``STOPPED`` to ``RUNNING` exec step.
+
+        Parameters
+        ----------
+        job_id : str
+            The id of the job in question.
+        args
+            (Unused) variable positional args.
+        kwargs
+            (Unused) variable keyword args.
+
+        Returns
+        -------
+        JobControlResponse
+            An indicator of whether the job was restarted as requested.
+        """
+        return await self._job_control_request(job_id=job_id, action=JobControlAction.RESTART)
+
+    async def request_job_status(self, job_id: str, *args, **kwargs) -> JobInfoResponse:
         """
         Request the status of the provided job.
 
@@ -133,13 +214,12 @@ async def request_job_status(self, job_id: str, *args, **kwargs) -> BasicResultI
 
         Returns
         -------
-        BasicResultIndicator
-            An indicator that, when successful, includes as ``data`` the serialized status string of the provided job.
+        JobInfoResponse
+            An indicator that, when successful, includes as ``data`` the serialized status of the provided job.
         """
-        # TODO: implement
-        raise NotImplementedError('{} function "request_job_status" not implemented yet'.format(self.__class__.__name__))
+        return await self._job_info_request(job_id=job_id, status_only=True)
 
-    async def request_job_stop(self, job_id: str, *args, **kwargs) -> ResultIndicator:
+    async def request_job_stop(self, job_id: str, *args, **kwargs) -> JobControlResponse:
         """
         Request the provided job be stopped; i.e., transitioned to the ``STOPPED`` exec step.
 
@@ -154,13 +234,12 @@ async def request_job_stop(self, job_id: str, *args, **kwargs) -> ResultIndicato
 
         Returns
         -------
-        ResultIndicator
+        JobControlResponse
             An indicator of whether the job was stopped as requested.
         """
-        # TODO: implement
-        raise NotImplementedError('{} function "request_job_stop" not implemented yet'.format(self.__class__.__name__))
+        return await self._job_control_request(job_id=job_id, action=JobControlAction.STOP)
 
-    async def request_jobs_list(self, jobs_list_active_only: bool, *args, **kwargs) -> BasicResultIndicator:
+    async def request_jobs_list(self, jobs_list_active_only: bool, *args, **kwargs) -> JobListResponse:
         """
         Request a list of ids of existing jobs.
 
@@ -177,15 +256,26 @@ async def request_jobs_list(self, jobs_list_active_only: bool, *args, **kwargs)
 
         Returns
         -------
-        BasicResultIndicator
+        JobListResponse
             An indicator that, when successful, includes as ``data`` the list of ids of existing jobs.
 
         See Also
         -------
         get_jobs_list
         """
-        # TODO: implement
-        raise NotImplementedError('{} function "request_jobs_list" not implemented yet'.format(self.__class__.__name__))
+        raw_response = None
+        try:
+            raw_response = await self._submit_job_request(request=JobListRequest(only_active=jobs_list_active_only))
+            response = JobListResponse.factory_init_from_deserialized_json(json.loads(raw_response))
+            if response is not None:
+                return response
+            else:
+                return JobListResponse(only_active=jobs_list_active_only, success=False,
+                                       reason="Response Deserializing Failed", data={"raw_response": raw_response},
+                                       message=f"Unable to deserialize JSON to {JobInfoResponse.__class__.__name__}")
+        except Exception as e:
+            return JobListResponse(only_active=jobs_list_active_only, success=False, reason=e.__class__.__name__,
+                                   message=str(e), data={"raw_response": raw_response} if raw_response else None)
 
     async def submit_ngen_request(self, **kwargs) -> NGENRequestResponse:
         return NGENRequestResponse.factory_init_from_deserialized_json(

python/lib/client/setup.py

@@ -22,7 +22,7 @@
     license='',
     include_package_data=True,
     #install_requires=['websockets', 'jsonschema'],vi
-    install_requires=['dmod-core>=0.11.0', 'websockets>=8.1', 'pydantic>=1.10.8,~=1.10', 'dmod-communication>=0.16.0',
-                      'dmod-externalrequests>=0.3.0'],
+    install_requires=['dmod-core>=0.11.0', 'websockets>=8.1', 'pydantic>=1.10.8,~=1.10', 'dmod-communication>=0.17.0',
+                      'dmod-externalrequests>=0.6.0'],
     packages=find_namespace_packages(include=['dmod.*'], exclude=['dmod.test'])
 )

python/lib/communication/dmod/communication/_version.py

@@ -1 +1 @@
-__version__ = '0.16.2'
+__version__ = '0.17.0'