list artifacts

Author: kossak

paperspace/cli/jobs.py

@@ -128,3 +128,15 @@ def get_artifacts(job_id, api_key=None):
     jobs_api = client.API(config.CONFIG_HOST, api_key=api_key)
     command = jobs_commands.ArtifactsGetCommand(api=jobs_api)
     command.execute(job_id)
+
+
+@artifacts.command("list", help="List job's artifacts")
+@click.argument("job_id")
+@click.option("--size", "-s", "size", help="Show file size", is_flag=True)
+@click.option("--links", "-l", "links", help="Show file URL", is_flag=True)
+@click.option("--files", "files", help="Get only given file (use at the end * as a wildcard)")
+@api_key_option
+def list_artifacts(job_id, size, links, files, api_key=None):
+    jobs_api = client.API(config.CONFIG_HOST, api_key=api_key)
+    command = jobs_commands.ArtifactsListCommand(api=jobs_api)
+    command.execute(job_id=job_id, size=size, links=links, files=files)

paperspace/commands/jobs.py

@@ -4,11 +4,10 @@
 from click import style
 
 from paperspace import config, client
-from paperspace.commands import CommandBase
+from paperspace.commands import common
 from paperspace.exceptions import BadResponseError
 from paperspace.utils import get_terminal_lines
 from paperspace.workspace import S3WorkspaceHandler
-from paperspace.commands import common
 
 
 class JobsCommandBase(common.CommandBase):
@@ -171,3 +170,47 @@ def _log_artifacts(self, response):
                     '{}: {}'.format(artifacts_json['error']['status'], artifacts_json['error']['message']))
         except (ValueError, KeyError, BadResponseError) as e:
             self.logger.error("Error occurred while getting artifacts: {}".format(str(e)))
+
+
+class ArtifactsListCommand(common.ListCommand):
+    kwargs = {}
+
+    def execute(self, **kwargs):
+        self.kwargs = kwargs
+        return super(ArtifactsListCommand, self).execute(**kwargs)
+
+    @property
+    def request_url(self):
+        return '/jobs/artifactsList'
+
+    def _get_request_params(self, kwargs):
+        params = {'jobId': kwargs['job_id']}
+
+        files = kwargs.get('files')
+        if files:
+            params['files'] = files
+        size = kwargs.get('size', False)
+        if size:
+            params['size'] = size
+        links = kwargs.get('links', False)
+        if links:
+            params['links'] = links
+
+        return params
+
+    def _get_table_data(self, artifacts):
+        columns = ['Files']
+        if self.kwargs.get('size'):
+            columns.append('Size (in bytes)')
+        if self.kwargs.get('links'):
+            columns.append('URL')
+
+        data = [tuple(columns)]
+        for artifact in artifacts:
+            row = [artifact.get('file')]
+            if 'size' in artifact.keys():
+                row.append(artifact['size'])
+            if 'url' in artifact.keys():
+                row.append(artifact['url'])
+            data.append(tuple(row))
+        return data

tests/functional/test_jobs.py

@@ -1,4 +1,5 @@
 import mock
+import pytest
 from click.testing import CliRunner
 
 from paperspace.cli import cli
@@ -267,7 +268,8 @@ def test_should_send_valid_post_request_when_destroying_artifacts_with_files_spe
         post_patched.return_value = MockResponse(status_code=200)
         job_id = "some_job_id"
         file_names = "some_file_names"
-        result = self.runner.invoke(cli.cli, ["jobs", "artifacts", "destroy", job_id, "--files", file_names, "--apiKey", "some_key"])
+        result = self.runner.invoke(cli.cli, ["jobs", "artifacts", "destroy", job_id, "--files", file_names, "--apiKey",
+                                              "some_key"])
 
         post_patched.assert_called_with("{}/jobs/{}/artifactsDestroy".format(self.URL, job_id),
                                         files=None,
@@ -300,3 +302,41 @@ def test_should_send_send_valid_get_request_and_receive_json_response(self, get_
                                        json=None,
                                        params={"jobId": job_id})
         assert result.exit_code == 0
+
+    @mock.patch("paperspace.client.requests.get")
+    def test_should_send_valid_get_request_with_all_parameters_for_a_list_of_artifacts(self, get_patched):
+        get_patched.return_value = MockResponse(status_code=200)
+        job_id = "some_job_id"
+        result = self.runner.invoke(cli.cli,
+                                    ["jobs", "artifacts", "list", job_id, "--apiKey", "some_key", "--size", "--links",
+                                     "--files", "foo"])
+
+        get_patched.assert_called_with("{}/jobs/artifactsList".format(self.URL),
+                                       headers=self.EXPECTED_HEADERS_WITH_CHANGED_API_KEY,
+                                       json=None,
+                                       params={"jobId": job_id,
+                                               "size": True,
+                                               "links": True,
+                                               "files": "foo"})
+        assert result.exit_code == 0
+
+    @mock.patch("paperspace.client.requests.get")
+    @pytest.mark.parametrize('option,param', [("--size", "size"),
+                                              ("-s", "size"),
+                                              ("--links", "links"),
+                                              ("-l", "links")])
+    def test_should_send_valid_get_request_with_valid_param_for_a_list_of_artifacts_for_both_formats_of_param(self,
+                                                                                                              get_patched,
+                                                                                                              option,
+                                                                                                              param):
+        get_patched.return_value = MockResponse(status_code=200)
+        job_id = "some_job_id"
+        result = self.runner.invoke(cli.cli,
+                                    ["jobs", "artifacts", "list", job_id, "--apiKey", "some_key"] + [option])
+
+        get_patched.assert_called_with("{}/jobs/artifactsList".format(self.URL),
+                                       headers=self.EXPECTED_HEADERS_WITH_CHANGED_API_KEY,
+                                       json=None,
+                                       params={"jobId": job_id,
+                                               param: True})
+        assert result.exit_code == 0