Add more tests for clusters list

Author: MudlaffP

tests/config_files/clusters_list.yaml

@@ -0,0 +1,2 @@
+apiKey: some_key
+limit: 2

tests/conftest.py

@@ -382,3 +382,10 @@ def entity_tags_remove_config_path():
     p = Path(__file__)
     fixture_dir = p.parent / "config_files" / "entity_tags_remove.yaml"
     return str(fixture_dir.resolve())
+
+
+@pytest.fixture
+def clusters_list_config_path():
+    p = Path(__file__)
+    fixture_dir = p.parent / "config_files" / "clusters_list.yaml"
+    return str(fixture_dir.resolve())

tests/example_responses.py

@@ -6141,6 +6141,7 @@
     "tagFilter": []
 }
 
+
 EXAMPLE_CLUSTERS_LIST_RESPONSE = [
     {
         "id": "cluster_id_1",
@@ -6188,3 +6189,37 @@
         "modelId": 1170
     }
 ]
+
+
+LIMITED_EXAMPLE_CLUSTERS_LIST_RESPONSE = [
+    {
+        "id": "cluster_id_1",
+        "name": "cluster name 1",
+        "type": "Job Cluster",
+        "region": "Private",
+        "cloud": "private",
+        "teamId": "team_id",
+        "isDefault": True,
+        "dtCreated": "2019-07-05T23:28:17.416Z",
+        "dtModified": "2019-07-05T23:28:17.416Z",
+        "clusterId": 91,
+        "isPrivate": True,
+        "modelName": "team",
+        "modelId": 1170
+    },
+    {
+        "id": "cluster_id_2",
+        "name": "cluster name 2",
+        "type": "Kubernetes Processing Site",
+        "region": "Private",
+        "cloud": "aws",
+        "teamId": "team_id",
+        "isDefault": False,
+        "dtCreated": "2019-07-22T14:50:10.170Z",
+        "dtModified": "2019-11-21T18:12:27.723Z",
+        "clusterId": 92,
+        "isPrivate": True,
+        "modelName": "team",
+        "modelId": 1170
+    }
+]

tests/functional/test_clusters.py

@@ -10,13 +10,18 @@ class TestClustersList(object):
     URL = "https://api.paperspace.io/clusters/getClusters"
 
     COMMAND = ["clusters", "list"]
+    COMMAND_WITH_LIMIT = COMMAND[:] + ["-l", "2"]
     COMMAND_WITH_OPTIONS_FILE = ["clusters", "list", "--optionsFile", ]  # path added in test
 
     LIST_CLUSTERS = example_responses.EXAMPLE_CLUSTERS_LIST_RESPONSE
+    LIMITED_LIST_CLUSTERS = example_responses.LIMITED_EXAMPLE_CLUSTERS_LIST_RESPONSE
 
     DEFAULT_PARAMS = {
         "filter": '{"limit": 20, "offset": 0, "where": {"isPrivate": true}}'
     }
+    LIMITED_PARAMS = {
+        "filter": '{"limit": 2, "offset": 0, "where": {"isPrivate": true}}'
+    }
 
     COMMAND_WITH_API_KEY = ["clusters", "list", "--apiKey", "some_key"]
     EXPECTED_HEADERS = http_client.default_headers.copy()
@@ -30,6 +35,16 @@ class TestClustersList(object):
 | cluster_id_2 | cluster name 2 | Kubernetes Processing Site |
 | cluster_id_3 | cluster name 3 | Job Cluster                |
 +--------------+----------------+----------------------------+
+"""
+    PAGINATED_LIST_STDOUT = """+--------------+----------------+----------------------------+
+| ID           | Name           | Type                       |
++--------------+----------------+----------------------------+
+| cluster_id_1 | cluster name 1 | Job Cluster                |
+| cluster_id_2 | cluster name 2 | Kubernetes Processing Site |
++--------------+----------------+----------------------------+
+
+Do you want to continue? [y/N]: 
+Aborted!
 """
 
     @mock.patch("gradient.api_sdk.clients.http_client.requests.get")
@@ -44,3 +59,32 @@ def test_should_send_get_request_and_print_list_of_clusters(self, get_patched):
                                             headers=self.EXPECTED_HEADERS,
                                             json=None,
                                             params=self.DEFAULT_PARAMS)
+
+    @mock.patch("gradient.api_sdk.clients.http_client.requests.get")
+    def test_should_send_get_request_and_paginate_list_of_clusters(self, get_patched):
+        get_patched.return_value = MockResponse(self.LIMITED_LIST_CLUSTERS, 200, "fake content")
+
+        runner = CliRunner()
+        result = runner.invoke(cli.cli, self.COMMAND_WITH_LIMIT)
+
+        assert self.PAGINATED_LIST_STDOUT in str(result.output)
+        get_patched.assert_called_once_with(self.URL,
+                                            headers=self.EXPECTED_HEADERS,
+                                            json=None,
+                                            params=self.LIMITED_PARAMS)
+
+    @mock.patch("gradient.api_sdk.clients.http_client.requests.get")
+    def test_should_read_options_defined_in_a_config_file(self, get_patched, clusters_list_config_path):
+        get_patched.return_value = MockResponse(json_data=self.LIMITED_LIST_CLUSTERS,
+                                                status_code=200)
+        command = self.COMMAND_WITH_OPTIONS_FILE[:] + [clusters_list_config_path]
+
+        runner = CliRunner()
+        result = runner.invoke(cli.cli, command)
+
+        assert self.PAGINATED_LIST_STDOUT in str(result.output)
+        get_patched.assert_called_once_with(self.URL,
+                                            headers=self.EXPECTED_HEADERS_WITH_CHANGED_API_KEY,
+                                            json=None,
+                                            params=self.LIMITED_PARAMS,
+                                            )