Add 'projects list' command

BartoszCki · BartoszCki · commit eb4caa02d488 · 2019-04-25T19:14:40.000+02:00
diff --git a/paperspace/cli/cli.py b/paperspace/cli/cli.py
@@ -6,6 +6,7 @@
 from paperspace import constants, client, config
 from paperspace.cli.common import api_key_option, del_if_value_is_none
 from paperspace.cli.jobs import jobs_group
+from paperspace.cli.projects import projects_group
 from paperspace.cli.types import ChoiceType, json_string
 from paperspace.cli.validators import validate_mutually_exclusive, validate_email
 from paperspace.commands import experiments as experiments_commands, deployments as deployments_commands, \
@@ -1052,3 +1053,4 @@ def version():
 
 
 cli.add_command(jobs_group)
+cli.add_command(projects_group)
diff --git a/paperspace/cli/projects.py b/paperspace/cli/projects.py
@@ -0,0 +1,18 @@
+import click
+
+from paperspace import client, config
+from paperspace.commands import projects as projects_commands
+from . import common
+
+
+@click.group("projects", help="Manage projects")
+def projects_group():
+    pass
+
+
+@projects_group.command("list", help="List projects")
+@common.api_key_option
+def delete_job(api_key):
+    projects_api = client.API(config.CONFIG_HOST, api_key=api_key)
+    command = projects_commands.ListProjectsCommand(api=projects_api)
+    command.execute()
diff --git a/paperspace/commands/projects.py b/paperspace/commands/projects.py
@@ -0,0 +1,58 @@
+import pydoc
+
+import terminaltables
+
+from paperspace import client, config, version, logger
+from paperspace.utils import get_terminal_lines
+
+default_headers = {"X-API-Key": config.PAPERSPACE_API_KEY,
+                   "ps_client_name": "paperspace-python",
+                   "ps_client_version": version.version}
+deployments_api = client.API(config.CONFIG_HOST, headers=default_headers)
+
+
+class ProjectsCommandBase(object):
+    def __init__(self, api=deployments_api, logger_=logger):
+        self.api = api
+        self.logger = logger_
+
+
+class ListProjectsCommand(ProjectsCommandBase):
+    def execute(self):
+        # TODO: PS_API should not require teamId but it does now, so change the following line
+        # TODO: to `json_ = None` or whatever works when PS_API is fixed:
+        json_ = {"teamId": 666}
+        response = self.api.get("/projects/", json=json_)
+
+        try:
+            data = response.json()
+            if not response.ok:
+                self.logger.log_error_response(data)
+                return
+        except (ValueError, KeyError) as e:
+            self.logger.log("Error while parsing response data: {}".format(e))
+        else:
+            self._log_projects_list(data)
+
+    def _log_projects_list(self, data):
+        if not data.get("data"):
+            self.logger.log("No projects found")
+        else:
+            table_str = self._make_table(data["data"])
+            if len(table_str.splitlines()) > get_terminal_lines():
+                pydoc.pager(table_str)
+            else:
+                self.logger.log(table_str)
+
+    @staticmethod
+    def _make_table(projects):
+        data = [("ID", "Name", "Repository")]
+        for project in projects:
+            id_ = project.get("handle")
+            name = project.get("name")
+            repo_url = project.get("repoUrl")
+            data.append((id_, name, repo_url))
+
+        ascii_table = terminaltables.AsciiTable(data)
+        table_string = ascii_table.table
+        return table_string
diff --git a/paperspace/main.py b/paperspace/main.py
@@ -8,7 +8,8 @@
 
 
 def main():
-    if len(sys.argv) >= 2 and sys.argv[1] in ('experiments', 'deployments', 'machines', 'login', 'logout', 'version'):
+    if len(sys.argv) >= 2 and sys.argv[1] in ('experiments', 'deployments', 'machines', 'login', 'logout', 'version',
+                                              'projects', 'jobs'):
         cli(sys.argv[1:])
 
     args = sys.argv[:]
diff --git a/tests/example_responses.py b/tests/example_responses.py
@@ -1273,3 +1273,192 @@
         "billingMonth": "2019-04",
     },
 }
+
+
+LIST_PROJECTS_RESPONSE = {
+  "data": [
+    {
+      "name": "test_project",
+      "handle": "prq70zy79",
+      "dtCreated": "2019-03-18T13:24:46.666Z",
+      "dtDeleted": None,
+      "lastJobSeqNum": 2,
+      "repoNodeId": None,
+      "repoName": None,
+      "repoUrl": None,
+      "experiments": {
+        "data": [
+          {
+            "dtCreated": "2019-04-05T15:10:55.692629+00:00",
+            "dtDeleted": None,
+            "dtFinished": None,
+            "dtModified": "2019-04-05T15:10:55.692629+00:00",
+            "dtProvisioningFinished": None,
+            "dtProvisioningStarted": None,
+            "dtStarted": None,
+            "dtTeardownFinished": None,
+            "dtTeardownStarted": None,
+            "experimentError": None,
+            "experimentTemplateHistoryId": 22159,
+            "experimentTemplateId": 60,
+            "experimentTypeId": 1,
+            "handle": "estgcoux8igx32",
+            "id": 22123,
+            "projectHandle": "prq70zy79",
+            "projectId": 612,
+            "started_by_user_id": 1655,
+            "state": 1,
+            "templateHistory": {
+              "dtCreated": "2019-04-05T15:10:54.923725+00:00",
+              "dtDeleted": None,
+              "experimentTemplateId": 60,
+              "id": 22159,
+              "params": {
+                "is_preemptible": False,
+                "name": "dsfads",
+                "ports": 5000,
+                "project_handle": "prq70zy79",
+                "worker_command": "sadas",
+                "worker_container": "asd",
+                "worker_machine_type": "C2",
+                "worker_use_dockerfile": False,
+                "workspaceUrl": "example.com"
+              },
+              "triggerEvent": None,
+              "triggerEventId": None
+            }
+          }
+        ],
+        "meta": {
+          "itemGroup": {
+            "key": "projectHandle",
+            "value": "prq70zy79"
+          },
+          "totalItems": 1
+        }
+      }
+    },
+    {
+      "name": "keton",
+      "handle": "prmr22ve0",
+      "dtCreated": "2019-03-25T14:50:43.202Z",
+      "dtDeleted": None,
+      "lastJobSeqNum": 8,
+      "repoNodeId": None,
+      "repoName": None,
+      "repoUrl": None,
+      "experiments": {
+        "data": [
+          {
+            "dtCreated": "2019-04-02T15:17:03.393886+00:00",
+            "dtDeleted": None,
+            "dtFinished": "2019-04-02T17:02:54.654569+00:00",
+            "dtModified": "2019-04-02T15:17:03.393886+00:00",
+            "dtProvisioningFinished": "2019-04-02T15:17:10.978198+00:00",
+            "dtProvisioningStarted": "2019-04-02T15:17:10.978198+00:00",
+            "dtStarted": "2019-04-02T15:17:10.978198+00:00",
+            "dtTeardownFinished": "2019-04-02T17:02:54.654569+00:00",
+            "dtTeardownStarted": "2019-04-02T17:02:54.654569+00:00",
+            "experimentError": None,
+            "experimentTemplateHistoryId": 22130,
+            "experimentTemplateId": 174,
+            "experimentTypeId": 1,
+            "handle": "ehla1kvbwzaco",
+            "id": 22094,
+            "projectHandle": "prmr22ve0",
+            "projectId": 626,
+            "started_by_user_id": 1655,
+            "state": 5,
+            "templateHistory": {
+              "dtCreated": "2019-04-02T15:17:02.663449+00:00",
+              "dtDeleted": None,
+              "experimentTemplateId": 174,
+              "id": 22130,
+              "params": {
+                "is_preemptible": False,
+                "model_path": "/artifacts",
+                "model_type": "Tensorflow",
+                "name": "Test1",
+                "ports": 5000,
+                "project_handle": "prmr22ve0",
+                "worker_command": "python mnist.py --data_format=channels_last",
+                "worker_container": "tensorflow/tensorflow:1.13.1-py3",
+                "worker_machine_type": "K80",
+                "workspaceUrl": "https://github.com/Paperspace/mnist-sample"
+              },
+              "triggerEvent": None,
+              "triggerEventId": None
+            }
+          }
+        ],
+        "meta": {
+          "itemGroup": {
+            "key": "projectHandle",
+            "value": "prmr22ve0"
+          },
+          "totalItems": 1
+        }
+      }
+    },
+    {
+      "name": "paperspace-python",
+      "handle": "przhbct98",
+      "dtCreated": "2019-04-04T15:12:34.229Z",
+      "dtDeleted": None,
+      "lastJobSeqNum": 3,
+      "repoNodeId": None,
+      "repoName": None,
+      "repoUrl": None,
+      "experiments": {
+        "data": [
+          {
+            "dtCreated": "2019-04-24T10:18:30.523193+00:00",
+            "dtDeleted": None,
+            "dtFinished": "2019-04-24T10:18:43.613748+00:00",
+            "dtModified": "2019-04-24T10:18:30.523193+00:00",
+            "dtProvisioningFinished": "2019-04-24T10:18:35.010792+00:00",
+            "dtProvisioningStarted": "2019-04-24T10:18:35.010792+00:00",
+            "dtStarted": "2019-04-24T10:18:35.010792+00:00",
+            "dtTeardownFinished": "2019-04-24T10:18:43.613748+00:00",
+            "dtTeardownStarted": "2019-04-24T10:18:43.613748+00:00",
+            "experimentError": None,
+            "experimentTemplateHistoryId": 22311,
+            "experimentTemplateId": 186,
+            "experimentTypeId": 1,
+            "handle": "es47og38wzhnuo",
+            "id": 22270,
+            "projectHandle": "przhbct98",
+            "projectId": 649,
+            "started_by_user_id": 1655,
+            "state": 7,
+            "templateHistory": {
+              "dtCreated": "2019-04-24T10:18:30.523193+00:00",
+              "dtDeleted": None,
+              "experimentTemplateId": 186,
+              "id": 22311,
+              "params": {
+                "command": ". test.sh\npython2 hello.py",
+                "container": "paperspace/tensorflow-python",
+                "machineType": "G1",
+                "project": "paperspace-python",
+                "workspaceFileName": "temp.zip"
+              },
+              "triggerEvent": None,
+              "triggerEventId": None
+            }
+          }
+        ],
+        "meta": {
+          "itemGroup": {
+            "key": "projectHandle",
+            "value": "przhbct98"
+          },
+          "totalItems": 1
+        }
+      }
+    }
+  ],
+  "meta": {
+    "totalItems": 3
+  }
+}
diff --git a/tests/functional/test_projects.py b/tests/functional/test_projects.py
@@ -0,0 +1,105 @@
+import mock
+from click.testing import CliRunner
+
+import paperspace
+from paperspace.cli import cli
+from paperspace.client import default_headers
+from tests import example_responses, MockResponse
+
+
+class TestListProjects(object):
+    URL = "https://api.paperspace.io/projects/"
+    EXPECTED_HEADERS = default_headers.copy()
+    BASIC_COMMAND = ["projects", "list"]
+    # TODO: change to `REQUEST_JSON = None` or whatever works when PS_API is fixed
+    REQUEST_JSON = {'teamId': 666}
+    EXPECTED_RESPONSE_JSON = example_responses.LIST_PROJECTS_RESPONSE
+    EXPECTED_STDOUT = """+-----------+-------------------+------------+
+| ID        | Name              | Repository |
++-----------+-------------------+------------+
+| prq70zy79 | test_project      | None       |
+| prmr22ve0 | keton             | None       |
+| przhbct98 | paperspace-python | None       |
++-----------+-------------------+------------+
+"""
+
+    BASIC_COMMAND_WITH_API_KEY = ["projects", "list", "--apiKey", "some_key"]
+    EXPECTED_HEADERS_WITH_CHANGED_API_KEY = paperspace.client.default_headers.copy()
+    EXPECTED_HEADERS_WITH_CHANGED_API_KEY["X-API-Key"] = "some_key"
+
+    RESPONSE_JSON_WITH_WRONG_API_TOKEN = {"status": 400, "message": "Invalid API token"}
+    EXPECTED_STDOUT_WITH_WRONG_API_TOKEN = "Invalid API token\n"
+
+    RESPONSE_JSON_WHEN_NO_PROJECTS_WERE_FOUND = {"data": [], "meta": {"totalItems": 0}}
+    EXPECTED_STDOUT_WHEN_NO_PROJECTS_WERE_FOUND = "No projects found\n"
+
+    @mock.patch("paperspace.cli.cli.client.requests.get")
+    def test_should_send_valid_post_request_and_print_table_when_projects_list_was_used(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)
+
+        get_patched.assert_called_with(self.URL,
+                                       headers=self.EXPECTED_HEADERS,
+                                       json=self.REQUEST_JSON,
+                                       params=None)
+        assert result.output == self.EXPECTED_STDOUT
+        assert result.exit_code == 0
+
+    @mock.patch("paperspace.cli.cli.client.requests.get")
+    def test_should_send_valid_post_request_when_projects_list_was_used_with_api_key_option(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_API_KEY)
+
+        get_patched.assert_called_with(self.URL,
+                                       headers=self.EXPECTED_HEADERS_WITH_CHANGED_API_KEY,
+                                       json=self.REQUEST_JSON,
+                                       params=None)
+        assert result.output == self.EXPECTED_STDOUT
+        assert result.exit_code == 0
+
+    @mock.patch("paperspace.cli.cli.client.requests.get")
+    def test_should_send_valid_post_request_when_projects_list_was_used_with_wrong_api_key(self, get_patched):
+        get_patched.return_value = MockResponse(json_data=self.RESPONSE_JSON_WITH_WRONG_API_TOKEN, status_code=400)
+
+        cli_runner = CliRunner()
+        result = cli_runner.invoke(cli.cli, self.BASIC_COMMAND_WITH_API_KEY)
+
+        get_patched.assert_called_with(self.URL,
+                                       headers=self.EXPECTED_HEADERS_WITH_CHANGED_API_KEY,
+                                       json=self.REQUEST_JSON,
+                                       params=None)
+        assert result.output == self.EXPECTED_STDOUT_WITH_WRONG_API_TOKEN
+        assert result.exit_code == 0
+
+    @mock.patch("paperspace.cli.cli.client.requests.get")
+    def test_should_print_error_message_when_no_project_was_not_found(self, get_patched):
+        get_patched.return_value = MockResponse(json_data=self.RESPONSE_JSON_WHEN_NO_PROJECTS_WERE_FOUND,
+                                                status_code=200)
+
+        cli_runner = CliRunner()
+        result = cli_runner.invoke(cli.cli, self.BASIC_COMMAND)
+
+        get_patched.assert_called_with(self.URL,
+                                       headers=self.EXPECTED_HEADERS,
+                                       json=self.REQUEST_JSON,
+                                       params=None)
+        assert result.output == self.EXPECTED_STDOUT_WHEN_NO_PROJECTS_WERE_FOUND
+        assert result.exit_code == 0
+
+    @mock.patch("paperspace.cli.cli.client.requests.get")
+    def test_should_print_error_message_when_error_status_code_received_but_no_content_was_provided(self, get_patched):
+        get_patched.return_value = MockResponse(status_code=400)
+
+        cli_runner = CliRunner()
+        result = cli_runner.invoke(cli.cli, self.BASIC_COMMAND)
+
+        get_patched.assert_called_with(self.URL,
+                                       headers=self.EXPECTED_HEADERS,
+                                       json=self.REQUEST_JSON,
+                                       params=None)
+        assert result.output == "Error while parsing response data: No JSON\n"
+        assert result.exit_code == 0
