Add filtering options to 'deployments list' command

Author: BartoszCki

paperspace/cli/cli.py

@@ -401,12 +401,22 @@ def create_deployment(api_key=None, **kwargs):
     type=ChoiceType(DEPLOYMENT_STATES_MAP, case_sensitive=False),
     help="Filter by deployment state",
 )
+@click.option(
+    "--projectId",
+    "projectId",
+    help="Use to filter by project ID",
+)
+@click.option(
+    "--modelId",
+    "modelId",
+    help="Use to filter by project ID",
+)
 @api_key_option
-def get_deployments_list(api_key=None, **kwargs):
-    del_if_value_is_none(kwargs)
+def get_deployments_list(api_key=None, **filters):
+    del_if_value_is_none(filters)
     deployments_api = client.API(config.CONFIG_HOST, api_key=api_key)
     command = deployments_commands.ListDeploymentsCommand(api=deployments_api)
-    command.execute(kwargs)
+    command.execute(filters)
 
 
 @deployments.command("update", help="Update deployment properties")

paperspace/commands/deployments.py

@@ -40,25 +40,28 @@ def execute(self, kwargs):
 
 
 class ListDeploymentsCommand(_DeploymentCommandBase):
-    def execute(self, kwargs):
-        json_ = self._get_request_json(kwargs)
+    def execute(self, filters=None):
+        json_ = self._get_request_json(filters)
         response = self.api.get("/deployments/getDeploymentList/", json=json_)
 
         try:
-            deployments = self._get_deployments_list(response)
+            data = response.json()
+            if not response.ok:
+                self.logger.log_error_response(data)
+                return
+            models = self._get_deployments_list(response)
         except (ValueError, KeyError) as e:
             self.logger.log("Error while parsing response data: {}".format(e))
         else:
-            self._log_deployments_list(deployments)
+            self._log_deployments_list(models)
 
     @staticmethod
-    def _get_request_json(kwargs):
-        state = kwargs.get("state")
-        if not state:
+    def _get_request_json(filters):
+        if not filters:
             return None
 
-        params = {"filter": {"where": {"and": [{"state": state}]}}}
-        return params
+        json_ = {"filter": {"where": {"and": [filters]}}}
+        return json_
 
     @staticmethod
     def _get_deployments_list(response):

paperspace/commands/models.py

@@ -18,7 +18,7 @@ def execute(self, filters):
             if not response.ok:
                 self.logger.log_error_response(data)
                 return
-            models = data["modelList"]
+            models = self._get_objects_list(response)
         except (ValueError, KeyError) as e:
             self.logger.log("Error while parsing response data: {}".format(e))
         else:
@@ -32,12 +32,9 @@ def _get_request_json(filters):
         json_ = {"filter": {"where": {"and": [filters]}}}
         return json_
 
-    def _get_models_list(self, response):
-        if not response.ok:
-            raise ValueError("Unknown error")
-
+    @staticmethod
+    def _get_objects_list(response):
         data = response.json()["modelList"]
-        self.logger.debug(data)
         return data
 
     def _log_models_list(self, models):

tests/functional/test_deployments.py

@@ -187,6 +187,20 @@ def test_should_send_get_request_and_print_list_of_deployments_filtered_with_sta
                                             params=None)
         assert result.output == "No deployments found\n"
 
+    @mock.patch("paperspace.cli.cli.deployments_commands.client.requests.get")
+    def test_should_print_proper_message_when_wrong_api_key_was_used(self, get_patched):
+        get_patched.return_value = MockResponse({"status": 400, "message": "Invalid API token"},
+                                                400)
+
+        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 == "Invalid API token\n"
+
 
 class TestDeploymentsUpdate(object):
     URL = "https://api.paperspace.io/deployments/updateDeployment/"
@@ -264,7 +278,7 @@ class TestStartDeployment(object):
 
     @mock.patch("paperspace.cli.cli.deployments_commands.client.requests.post")
     def test_should_send_proper_data_and_print_message_when_deployments_start_was_used(self, post_patched):
-        post_patched.return_value = MockResponse(None, 204, "fake content")
+        post_patched.return_value = MockResponse(status_code=204)
 
         runner = CliRunner()
         result = runner.invoke(cli.cli, self.COMMAND)
@@ -297,7 +311,7 @@ class TestDeleteDeployment(object):
 
     @mock.patch("paperspace.cli.cli.deployments_commands.client.requests.post")
     def test_should_send_proper_data_and_print_message_when_deployments_delete_was_used(self, post_patched):
-        post_patched.return_value = MockResponse(None, 204, "fake content")
+        post_patched.return_value = MockResponse(status_code=204)
 
         runner = CliRunner()
         result = runner.invoke(cli.cli, self.COMMAND)
@@ -311,7 +325,7 @@ def test_should_send_proper_data_and_print_message_when_deployments_delete_was_u
 
     @mock.patch("paperspace.cli.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")
+        post_patched.return_value = MockResponse(status_code=204)
 
         runner = CliRunner()
         result = runner.invoke(cli.cli, self.COMMAND_WITH_API_KEY)