Patch: update GET job list to API v2

CHANGELOG.md

@@ -1,5 +1,15 @@
 ## lifebit-ai/cloudos-cli: changelog
 
+## v2.13.0 (2024-12-03)
+
+### Feature
+
+- Adds new `--archived` flag to `cloudos job list` to allow getting archived jobs list.
+
+### Patch
+
+- Updates GET job list to use API v2 endpoint.
+
 ## v2.12.0 (2024-11-27)
 
 ### Feature

cloudos/__main__.py

@@ -705,6 +705,9 @@ def job_status(apikey,
                     'value corresponds to the first page to retrieve. Default=1.'),
               type=int,
               default=1)
+@click.option('--archived',
+              help=('When this flag is used, only archived jobs list is collected.'),
+              is_flag=True)
 @click.option('--verbose',
               help='Whether to print information messages or not.',
               is_flag=True)
@@ -722,6 +725,7 @@ def list_jobs(apikey,
               all_fields,
               last_n_jobs,
               page,
+              archived,
               verbose,
               disable_ssl_verification,
               ssl_cert):
@@ -744,7 +748,7 @@ def list_jobs(apikey,
         except ValueError:
             print("[ERROR] last-n-jobs value was not valid. Please use a positive int or 'all'")
             raise
-    my_jobs_r = cl.get_job_list(workspace_id, last_n_jobs, page, verify_ssl)
+    my_jobs_r = cl.get_job_list(workspace_id, last_n_jobs, page, archived, verify_ssl)
     if output_format == 'csv':
         my_jobs = cl.process_job_list(my_jobs_r, all_fields)
         my_jobs.to_csv(outfile, index=False)

cloudos/_version.py

@@ -1 +1 @@
-__version__ = '2.12.0'
+__version__ = '2.13.0'

cloudos/clos.py

@@ -213,7 +213,8 @@ def cromwell_switch(self, workspace_id, action, verify=True):
             raise BadRequestException(r)
         return r
 
-    def get_job_list(self, workspace_id, last_n_jobs=30, page=1, verify=True):
+    def get_job_list(self, workspace_id, last_n_jobs=30, page=1, archived=False,
+                     verify=True):
         """Get jobs from a CloudOS workspace.
 
         Parameters
@@ -225,6 +226,8 @@ def get_job_list(self, workspace_id, last_n_jobs=30, page=1, verify=True):
             very large int or 'all' to get all user's jobs.
         page : int
             Response page to get.
+        archived : bool
+            When True, only the archived jobs are retrieved.
         verify: [bool|string]
             Whether to use SSL verification or not. Alternatively, if
             a string is passed, it will be interpreted as the path to
@@ -239,8 +242,12 @@ def get_job_list(self, workspace_id, last_n_jobs=30, page=1, verify=True):
             "Content-type": "application/json",
             "apikey": self.apikey
         }
-        r = retry_requests_get("{}/api/v1/jobs?teamId={}&page={}".format(self.cloudos_url,
-                                                                   workspace_id, page),
+        if archived:
+            archived_status = "true"
+        else:
+            archived_status = "false"
+        r = retry_requests_get("{}/api/v2/jobs?teamId={}&page={}&archived.status={}".format(
+                               self.cloudos_url, workspace_id, page, archived_status),
                                headers=headers, verify=verify)
         if r.status_code >= 400:
             raise BadRequestException(r)
@@ -260,7 +267,8 @@ def get_job_list(self, workspace_id, last_n_jobs=30, page=1, verify=True):
             else:
                 next_to_get = jobs_to_get
             return content['jobs'] + self.get_job_list(workspace_id, last_n_jobs=next_to_get,
-                                                       page=page+1, verify=verify)
+                                                       page=page+1, archived=archived,
+                                                       verify=verify)
         if jobs_to_get < 0:
             return content['jobs'][:jobs_to_get]
 

cloudos/queue/queue.py

@@ -51,7 +51,7 @@ def get_job_queues(self):
 
     @staticmethod
     def process_queue_list(r, all_fields=False):
-        """Process a job list from a self.get_job_list call.
+        """Process a queue list from a self.get_job_queues call.
 
         Parameters
         ----------

tests/test_clos/test_get_job_list.py

@@ -21,17 +21,18 @@ def test_get_job_list_correct_response():
     API request is mocked and replicated with json files
     """
     create_json = load_json_file(INPUT)
-    params = {"teamId": WORKSPACE_ID, "page": 1}
+    params = {"teamId": WORKSPACE_ID, "page": 1,
+              "archived.status": "false"}
     header = {
         "Accept": "application/json, text/plain, */*",
         "Content-Type": "application/json;charset=UTF-8",
         "apikey": APIKEY
     }
-    search_str = f"teamId={WORKSPACE_ID}&page=1"
+    search_str = f"teamId={WORKSPACE_ID}&page=1&archived.status=false"
     # mock GET method with the .json
     responses.add(
             responses.GET,
-            url=f"{CLOUDOS_URL}/api/v1/jobs?{search_str}",
+            url=f"{CLOUDOS_URL}/api/v2/jobs?{search_str}",
             body=create_json,
             headers=header,
             match=[matchers.query_param_matcher(params)],
@@ -54,17 +55,18 @@ def test_get_job_list_incorrect_response():
     error_message = {"statusCode": 400, "code": "BadRequest",
                      "message": "Bad Request.", "time": "2022-11-23_17:31:07"}
     error_json = json.dumps(error_message)
-    params = {"teamId": WORKSPACE_ID, "page": 1}
+    params = {"teamId": WORKSPACE_ID, "page": 1,
+              "archived.status": "false"}
     header = {
         "Accept": "application/json, text/plain, */*",
         "Content-Type": "application/json;charset=UTF-8",
         "apikey": APIKEY
     }
-    search_str = f"teamId={WORKSPACE_ID}&page=1"
+    search_str = f"teamId={WORKSPACE_ID}&page=1&archived.status=false"
     # mock GET method with the .json
     responses.add(
             responses.GET,
-            url=f"{CLOUDOS_URL}/api/v1/jobs?{search_str}",
+            url=f"{CLOUDOS_URL}/api/v2/jobs?{search_str}",
             body=error_json,
             headers=header,
             match=[matchers.query_param_matcher(params)],

tests/test_errors/test_bad_request_exception.py

@@ -22,17 +22,18 @@ def test_bad_request_exception():
     API request is mocked and replicated with json files
     """
     create_json = load_json_file(INPUT)
-    params = {"teamId": WORKSPACE_ID, "page": 1}
+    params = {"teamId": WORKSPACE_ID, "page": 1,
+              "archived.status": "false"}
     header = {
         "Accept": "application/json, text/plain, */*",
         "Content-Type": "application/json;charset=UTF-8",
         "apikey": APIKEY
     }
-    search_str = f"teamId={WORKSPACE_ID}&page=1"
+    search_str = f"teamId={WORKSPACE_ID}&page=1&archived.status=false"
     # mock GET method with the .json
     responses.add(
             responses.GET,
-            url=f"{CLOUDOS_URL}/api/v1/jobs?{search_str}",
+            url=f"{CLOUDOS_URL}/api/v2/jobs?{search_str}",
             body=create_json,
             headers=header,
             match=[matchers.query_param_matcher(params)],