Add --apiKey for deployments commands

Author: BartoszCki

paperspace/cli.py

@@ -367,9 +367,14 @@ def deployments():
     type=int,
     required=True,
 )
-def create_deployment(**kwargs):
+@click.option(
+    "--apiKey",
+    "api_key",
+)
+def create_deployment(api_key=None, **kwargs):
     del_if_value_is_none(kwargs)
-    command = deployments_commands.CreateDeploymentCommand()
+    deployments_api = client.API(config.CONFIG_HOST, api_key=api_key)
+    command = deployments_commands.CreateDeploymentCommand(api=deployments_api)
     command.execute(kwargs)
 
 
@@ -392,8 +397,13 @@ def create_deployment(**kwargs):
     "state",
     type=ChoiceType(DEPLOYMENT_STATES_MAP, case_sensitive=False)
 )
-def get_deployments_list(**kwargs):
-    command = deployments_commands.ListDeploymentsCommand()
+@click.option(
+    "--apiKey",
+    "api_key",
+)
+def get_deployments_list(api_key=None, **kwargs):
+    deployments_api = client.API(config.CONFIG_HOST, api_key=api_key)
+    command = deployments_commands.ListDeploymentsCommand(api=deployments_api)
     command.execute(kwargs)
 
 
@@ -423,9 +433,14 @@ def get_deployments_list(**kwargs):
     "--instanceCount",
     "instanceCount",
 )
-def update_deployment_model(id=None, **kwargs):
+@click.option(
+    "--apiKey",
+    "api_key",
+)
+def update_deployment_model(id=None, api_key=None, **kwargs):
     del_if_value_is_none(kwargs)
-    command = deployments_commands.UpdateModelCommand()
+    deployments_api = client.API(config.CONFIG_HOST, api_key=api_key)
+    command = deployments_commands.UpdateModelCommand(api=deployments_api)
     command.execute(id, kwargs)
 
 
@@ -435,8 +450,13 @@ def update_deployment_model(id=None, **kwargs):
     "id",
     required=True,
 )
-def start_deployment(id):
-    command = deployments_commands.StartDeploymentCommand()
+@click.option(
+    "--apiKey",
+    "api_key",
+)
+def start_deployment(id, api_key=None):
+    deployments_api = client.API(config.CONFIG_HOST, api_key=api_key)
+    command = deployments_commands.StartDeploymentCommand(api=deployments_api)
     command.execute(id)
 
 
@@ -446,6 +466,11 @@ def start_deployment(id):
     "id",
     required=True,
 )
-def delete_deployment(id):
-    command = deployments_commands.DeleteDeploymentCommand()
+@click.option(
+    "--apiKey",
+    "api_key",
+)
+def delete_deployment(id, api_key=None):
+    deployments_api = client.API(config.CONFIG_HOST, api_key=api_key)
+    command = deployments_commands.DeleteDeploymentCommand(api=deployments_api)
     command.execute(id)

tests/functional/test_deployments.py

@@ -1,6 +1,7 @@
 import mock
 from click.testing import CliRunner
 
+import paperspace.client
 from paperspace import cli
 from paperspace.commands import deployments as deployments_commands
 from tests import example_responses, MockResponse
@@ -10,6 +11,8 @@
 
 class TestDeploymentsCreate(object):
     URL = "https://api.paperspace.io/deployments/createDeployment/"
+    EXPECTED_HEADERS_WITH_CHANGED_API_KEY = paperspace.client.default_headers.copy()
+    EXPECTED_HEADERS_WITH_CHANGED_API_KEY["X-API-Key"] = "some_key"
     BASIC_OPTIONS_COMMAND = [
         "deployments", "create",
         "--deploymentType", "tfserving",
@@ -19,6 +22,16 @@ class TestDeploymentsCreate(object):
         "--imageUrl", "https://www.latlmes.com/breaking/paperspace-now-has-a-100-bilion-valuation",
         "--instanceCount", "666",
     ]
+    BASIC_OPTIONS_COMMAND_WITH_API_KEY = [
+        "deployments", "create",
+        "--deploymentType", "tfserving",
+        "--modelId", "some_model_id",
+        "--name", "some_name",
+        "--machineType", "HAL9000",
+        "--imageUrl", "https://www.latlmes.com/breaking/paperspace-now-has-a-100-bilion-valuation",
+        "--instanceCount", "666",
+        "--apiKey", "some_key",
+    ]
     BASIC_OPTIONS_REQUEST = {
         "machineType": u"HAL9000",
         "name": u"some_name",
@@ -48,6 +61,20 @@ def test_should_send_proper_data_and_print_message_when_create_deployment_with_b
         assert result.output == self.EXPECTED_STDOUT
         assert result.exit_code == 0
 
+    @mock.patch("paperspace.cli.deployments_commands.client.requests.post")
+    def test_should_send_different_api_key_when_api_key_parameter_was_used(self, post_patched):
+        post_patched.return_value = MockResponse(self.RESPONSE_JSON_200, 200, "fake content")
+
+        runner = CliRunner()
+        result = runner.invoke(cli.cli, self.BASIC_OPTIONS_COMMAND_WITH_API_KEY)
+
+        post_patched.assert_called_once_with(self.URL,
+                                             headers=self.EXPECTED_HEADERS_WITH_CHANGED_API_KEY,
+                                             json=self.BASIC_OPTIONS_REQUEST,
+                                             params=None)
+        assert result.output == self.EXPECTED_STDOUT
+        assert result.exit_code == 0
+
     @mock.patch("paperspace.cli.deployments_commands.client.requests.post")
     def test_should_send_proper_data_and_print_message_when_create_wrong_model_id_was_given(self, post_patched):
         post_patched.return_value = MockResponse(self.RESPONSE_JSON_404_MODEL_NOT_FOUND, 404,
@@ -65,8 +92,15 @@ def test_should_send_proper_data_and_print_message_when_create_wrong_model_id_wa
 
 
 class TestDeploymentsList(object):
+    URL = "https://api.paperspace.io/deployments/getDeploymentList/"
+
     COMMAND = ["deployments", "list"]
     LIST_JSON = example_responses.LIST_DEPLOYMENTS
+
+    COMMAND_WITH_API_KEY = ["deployments", "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"
+
     COMMAND_WITH_FILTER_WITH_STATE = ["deployments", "list", "--state", "Stopped"]
     LIST_WITH_FILTER_REQUEST_JSON = {"filter": {"where": {"and": [{"state": "Stopped"}]}}}
     LIST_WITH_FILTER_RESPONSE_JSON_WHEN_NO_DEPLOYMENTS_FOUND = {"deploymentList": [], "total": 17, "displayTotal": 0,
@@ -89,6 +123,23 @@ def test_should_send_get_request_and_print_list_of_deployments(self, get_patched
         runner = CliRunner()
         result = runner.invoke(cli.cli, self.COMMAND)
 
+        get_patched.assert_called_once_with(self.URL,
+                                            headers=EXPECTED_HEADERS,
+                                            json=None,
+                                            params=None)
+        assert result.output == self.DETAILS_STDOUT
+
+    @mock.patch("paperspace.cli.deployments_commands.client.requests.get")
+    def test_should_send_get_request_with_custom_api_key_when_api_key_parameter_was_provided(self, get_patched):
+        get_patched.return_value = MockResponse(self.LIST_JSON, 200, "fake content")
+
+        runner = CliRunner()
+        result = runner.invoke(cli.cli, self.COMMAND_WITH_API_KEY)
+
+        get_patched.assert_called_once_with(self.URL,
+                                            headers=self.EXPECTED_HEADERS_WITH_CHANGED_API_KEY,
+                                            json=None,
+                                            params=None)
         assert result.output == self.DETAILS_STDOUT
 
     @mock.patch("paperspace.cli.deployments_commands.pydoc")
@@ -101,6 +152,10 @@ def test_should_send_get_request_and_paginate_list_when_output_table_len_is_gt_l
         runner = CliRunner()
         result = runner.invoke(cli.cli, self.COMMAND)
 
+        get_patched.assert_called_once_with(self.URL,
+                                            headers=EXPECTED_HEADERS,
+                                            json=None,
+                                            params=None)
         pydoc_patched.pager.assert_called_once()
         assert result.exit_code == 0
 
@@ -126,6 +181,10 @@ def test_should_send_get_request_and_print_list_of_deployments_filtered_with_sta
         runner = CliRunner()
         result = runner.invoke(cli.cli, self.COMMAND_WITH_FILTER_WITH_STATE)
 
+        get_patched.assert_called_once_with(self.URL,
+                                            headers=EXPECTED_HEADERS,
+                                            json=self.LIST_WITH_FILTER_REQUEST_JSON,
+                                            params=None)
         assert result.output == "No deployments found\n"
 
 
@@ -138,6 +197,15 @@ class TestDeploymentsUpdate(object):
     ]
     BASIC_OPTIONS_REQUEST_JSON = {"upd": {"name": u"new_name"}, "id": u"some_id"}
 
+    COMMAND_WITH_API_KEY = [
+        "deployments", "update",
+        "--id", "some_id",
+        "--name", "new_name",
+        "--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_200 = {"upd": {"name": u"asd"}, "id": u"dennaw0wzbvvg3"}
     EXPECTED_STDOUT = "Deployment model updated.\n"
 
@@ -158,6 +226,20 @@ def test_should_send_proper_data_and_print_message_when_update_deployment(self,
         assert result.output == self.EXPECTED_STDOUT
         assert result.exit_code == 0
 
+    @mock.patch("paperspace.cli.deployments_commands.client.requests.post")
+    def test_should_send_proper_data_with_custom_api_key_when_api_key_parameter_was_provided(self, post_patched):
+        post_patched.return_value = MockResponse(self.RESPONSE_JSON_200, 200, "fake content")
+
+        runner = CliRunner()
+        result = runner.invoke(cli.cli, self.COMMAND_WITH_API_KEY)
+
+        post_patched.assert_called_once_with(self.URL,
+                                             headers=self.EXPECTED_HEADERS_WITH_CHANGED_API_KEY,
+                                             json=self.BASIC_OPTIONS_REQUEST_JSON,
+                                             params=None)
+        assert result.output == self.EXPECTED_STDOUT
+        assert result.exit_code == 0
+
     @mock.patch("paperspace.cli.deployments_commands.client.requests.post")
     def test_should_send_proper_data_and_print_message_when_update_deployment_used_with_wrong_id(self, post_patched):
         post_patched.return_value = MockResponse(self.RESPONSE_JSON_400, 400, "fake content")
@@ -199,10 +281,17 @@ class TestDeleteDeployment(object):
     URL = "https://api.paperspace.io/deployments/updateDeployment/"
     COMMAND = ["deployments", "delete",
                "--id", "some_id"]
-
     REQUEST_JSON = {"upd": {"isDeleted": True}, "id": u"some_id"}
     EXPECTED_STDOUT = "Deployment deleted.\n"
 
+    COMMAND_WITH_API_KEY = [
+        "deployments", "delete",
+        "--id", "some_id",
+        "--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_400 = {"error": {"name": "Error", "status": 400, "message": "Unable to access deployment"}}
     EXPECTED_STDOUT_WITH_WRONG_ID = "Unable to access deployment\n"
 
@@ -220,6 +309,20 @@ def test_should_send_proper_data_and_print_message_when_deployments_delete_was_u
         assert result.output == self.EXPECTED_STDOUT
         assert result.exit_code == 0
 
+    @mock.patch("paperspace.cli.deployments_commands.client.requests.post")
+    def test_should_send_proper_data_with_custom_api_key_when_api_key_parameter_was_provided(self, post_patched):
+        post_patched.return_value = MockResponse(None, 204, "fake content")
+
+        runner = CliRunner()
+        result = runner.invoke(cli.cli, self.COMMAND_WITH_API_KEY)
+
+        post_patched.assert_called_once_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.deployments_commands.client.requests.post")
     def test_should_send_proper_data_and_print_message_when_deployments_delete_used_with_wrong_id(self, post_patched):
         post_patched.return_value = MockResponse(self.RESPONSE_JSON_400, 400, "fake content")

tests/functional/test_experiments.py

@@ -3,7 +3,6 @@
 
 import paperspace.client
 from paperspace import cli, constants
-from paperspace.commands import experiments as experiments_commands
 from tests import example_responses, MockResponse