Add filtering to 'jobs list' command

Author: BartoszCki

paperspace/cli/jobs.py

@@ -15,6 +15,7 @@ def jobs_group():
     "--jobId",
     "job_id",
     required=True,
+    help="Delete job with given ID",
 )
 @common.api_key_option
 def delete_job(job_id, api_key=None):
@@ -28,6 +29,7 @@ def delete_job(job_id, api_key=None):
     "--jobId",
     "job_id",
     required=True,
+    help="Stop job with given ID",
 )
 @common.api_key_option
 def stop_job(job_id, api_key=None):
@@ -37,8 +39,24 @@ def stop_job(job_id, api_key=None):
 
 
 @jobs_group.command("list", help="List jobs with optional filtering")
+@click.option(
+    "--project",
+    "project",
+    help="Use to filter jobs by project name",
+)
+@click.option(
+    "--projectId",
+    "projectId",
+    help="Use to filter jobs by project ID",
+)
+@click.option(
+    "--experimentId",
+    "experimentId",
+    help="Use to filter jobs by experiment ID",
+)
 @common.api_key_option
-def list_jobs(api_key):
+def list_jobs(api_key, **filters):
+    common.del_if_value_is_none(filters)
     jobs_api = client.API(config.CONFIG_HOST, api_key=api_key)
     command = jobs_commands.ListJobsCommand(api=jobs_api)
-    command.execute()
+    command.execute(filters)

paperspace/commands/jobs.py

@@ -43,8 +43,9 @@ def execute(self, job_id):
 
 
 class ListJobsCommand(JobsCommandBase):
-    def execute(self):
-        response = self.api.get("/jobs/getJobs/", json=None)
+    def execute(self, filters=None):
+        json_ = filters or None
+        response = self.api.get("/jobs/getJobs/", json=json_)
 
         try:
             data = response.json()

tests/functional/test_jobs.py

@@ -39,6 +39,35 @@ class TestListJobs(object):
     RESPONSE_JSON_WHEN_NO_JOBS_WERE_FOUND = []
     EXPECTED_STDOUT_WHEN_NO_JOBS_WERE_FOUND = "No jobs found\n"
 
+    BASIC_COMMAND_WITH_FILTERING = [
+        "jobs", "list",
+        "--project", "some_project_name",
+        "--experimentId", "some_experiment_id",
+    ]
+    EXPECTED_REQUEST_JSON_WITH_FILTERING = {
+        "project": "some_project_name",
+        "experimentId": "some_experiment_id",
+    }
+
+    BASIC_COMMAND_WITH_MUTUALLY_EXCLUSIVE_FILTERS = [
+        "jobs", "list",
+        "--project", "some_project_name",
+        "--projectId", "some_project_id",
+    ]
+    EXPECTED_REQUEST_JSON_WITH_MUTUALLY_EXCLUSIVE_FILTERS = {
+        "project": "some_project_name",
+        "projectId": "some_project_id",
+    }
+    RESPONSE_JSON_WITH_MUTUALLY_EXCLUSIVE_FILTERS = {
+        "error": {
+            "name": "Error",
+            "status": 422,
+            "message": "Incompatible parameters: project and projectId cannot both be specified",
+        },
+    }
+    EXPECTED_STDOUT_WHEN_MUTUALLY_EXCLUSIVE_FILTERS = "Incompatible parameters: project and projectId " \
+                                                      "cannot both be specified\n"
+
     @mock.patch("paperspace.cli.cli.client.requests.get")
     def test_should_send_valid_post_request_and_print_table_when_jobs_list_was_used(self, get_patched):
         get_patched.return_value = MockResponse(json_data=self.EXPECTED_RESPONSE_JSON, status_code=200)
@@ -109,3 +138,32 @@ def test_should_print_error_message_when_error_status_code_received_but_no_conte
                                        params=None)
         assert result.output == "Error while parsing response data: No JSON\n"
         assert result.exit_code == 0
+
+    @mock.patch("paperspace.cli.cli.client.requests.get")
+    def test_should_send_valid_post_request_when_jobs_list_was_used_with_filter_options(self, get_patched):
+        get_patched.return_value = MockResponse(json_data=self.EXPECTED_RESPONSE_JSON, status_code=200)
+
+        cli_runner = CliRunner()
+        result = cli_runner.invoke(cli.cli, self.BASIC_COMMAND_WITH_FILTERING)
+
+        get_patched.assert_called_with(self.URL,
+                                       headers=self.EXPECTED_HEADERS,
+                                       json=self.EXPECTED_REQUEST_JSON_WITH_FILTERING,
+                                       params=None)
+        assert result.output == self.EXPECTED_STDOUT
+        assert result.exit_code == 0
+
+    @mock.patch("paperspace.cli.cli.client.requests.get")
+    def test_should_print_proper_message_when_jobs_list_was_used_with_mutually_exclusive_filters(self, get_patched):
+        get_patched.return_value = MockResponse(json_data=self.RESPONSE_JSON_WITH_MUTUALLY_EXCLUSIVE_FILTERS,
+                                                status_code=422)
+
+        cli_runner = CliRunner()
+        result = cli_runner.invoke(cli.cli, self.BASIC_COMMAND_WITH_MUTUALLY_EXCLUSIVE_FILTERS)
+
+        get_patched.assert_called_with(self.URL,
+                                       headers=self.EXPECTED_HEADERS,
+                                       json=self.EXPECTED_REQUEST_JSON_WITH_MUTUALLY_EXCLUSIVE_FILTERS,
+                                       params=None)
+        assert result.output == self.EXPECTED_STDOUT_WHEN_MUTUALLY_EXCLUSIVE_FILTERS
+        assert result.exit_code == 0