job list types (#389)

Adds ability to list jobs by type.

Author: KoningJasper

databricks_cli/jobs/api.py

@@ -30,8 +30,8 @@ def __init__(self, api_client):
     def create_job(self, json, headers=None):
         return self.client.client.perform_query('POST', '/jobs/create', data=json, headers=headers)
 
-    def list_jobs(self, headers=None):
-        resp = self.client.list_jobs(headers=headers)
+    def list_jobs(self, job_type=None, headers=None):
+        resp = self.client.list_jobs(job_type, headers=headers)
         if 'jobs' not in resp:
             resp['jobs'] = []
         return resp

databricks_cli/jobs/cli.py

@@ -95,11 +95,12 @@ def _jobs_to_table(jobs_json):
 @click.command(context_settings=CONTEXT_SETTINGS,
                short_help='Lists the jobs in the Databricks Job Service.')
 @click.option('--output', default=None, help=OutputClickType.help, type=OutputClickType())
+@click.option('--type', 'job_type', default=None, help='The type of job to list', type=str)
 @debug_option
 @profile_option
 @eat_exceptions
 @provide_api_client
-def list_cli(api_client, output):
+def list_cli(api_client, output, job_type):
     """
     Lists the jobs in the Databricks Job Service.
 
@@ -114,7 +115,7 @@ def list_cli(api_client, output):
     In table mode, the jobs are sorted by their name.
     """
     jobs_api = JobsApi(api_client)
-    jobs_json = jobs_api.list_jobs()
+    jobs_json = jobs_api.list_jobs(job_type)
     if OutputClickType.is_json(output):
         click.echo(pretty_format(jobs_json))
     else:

databricks_cli/sdk/service.py

@@ -138,9 +138,12 @@ def get_job(self, job_id, headers=None):
             _data['job_id'] = job_id
         return self.client.perform_query('GET', '/jobs/get', data=_data, headers=headers)
 
-    def list_jobs(self, headers=None):
+    def list_jobs(self, job_type=None, headers=None):
         _data = {}
 
+        if job_type is not None:
+            _data['job_type'] = job_type
+
         return self.client.perform_query('GET', '/jobs/list', data=_data, headers=headers)
 
     def run_now(self, job_id=None, jar_params=None, notebook_params=None, python_params=None,

tests/jobs/test_cli.py

@@ -123,6 +123,18 @@ def test_list_jobs_output_json(jobs_api_mock):
         assert echo_mock.call_args[0][0] == pretty_format(LIST_RETURN)
 
 
+@provide_conf
+def test_list_jobs_type_pipeline(jobs_api_mock):
+    with mock.patch('databricks_cli.jobs.cli.click.echo') as echo_mock:
+        jobs_api_mock.list_jobs.return_value = LIST_RETURN
+        runner = CliRunner()
+        runner.invoke(cli.list_cli, ['--type', 'PIPELINE'])
+        assert jobs_api_mock.list_jobs.call_args[0][0] == 'PIPELINE'
+        rows = [(2, 'a'), (1, 'b'), (30, 'C')]
+        assert echo_mock.call_args[0][0] == \
+            tabulate(rows, tablefmt='plain', disable_numparse=True)
+
+
 RUN_NOW_RETURN = {
     "number_in_job": 1,
     "run_id": 1