more refactoring

Signed-off-by: Chris Snow <[email protected]>

Author: snowch

tests/base_test.py

@@ -37,14 +37,14 @@
     from io import StringIO
 
 
-def session_mock_response():
-    return MockResponse(
-        json_data={},
-        status_code=200,
-        headers={
-            "location": "/api/v1/session/df1bfacb-xxxx-xxxx-xxxx-c8f57d8f3c71"
-        },
-    )
+# def session_mock_response():
+#     return MockResponse(
+#         json_data={},
+#         status_code=200,
+#         headers={
+#             "location": "/api/v1/session/df1bfacb-xxxx-xxxx-xxxx-c8f57d8f3c71"
+#         },
+#     )
 
 
 class MockResponse:
@@ -90,26 +90,12 @@ def get_client():
     return client
 
 
-# # pylint: disable=no-method-argument
-# def mocked_login_post(*args, **kwargs):
-#     if args[0] == "https://127.0.0.1:8080/api/v1/login":
-#         return MockResponse(
-#             json_data={},
-#             status_code=200,
-#             headers={
-#                 "location": (
-#                     "/api/v1/session/df1bfacb-xxxx-xxxx-xxxx-c8f57d8f3c71"
-#                 )
-#             },
-#         )
-#     raise RuntimeError("Unhandle POST request: " + args[0])
-
-
 @six.add_metaclass(abc.ABCMeta)
 class BaseTestCase(unittest.TestCase):
 
     _http_get_handlers = {}
     _http_post_handlers = {}
+    _http_put_handlers = {}
     _http_delete_handlers = {}
 
     @classmethod
@@ -128,6 +114,22 @@ def httpPostHandlers(cls, *args, **kwargs):
         else:
             return handler
 
+    @classmethod
+    def httpPutHandlers(cls, *args, **kwargs):
+        try:
+            handler = BaseTestCase._http_put_handlers[args[0]]
+        except KeyError:
+            raise Exception(
+                "Handler not found for PUT '{}'.\nDid you register a handler with BaseTestCase.registerHttpPutHandler?".format(
+                    args[0]
+                )
+            )
+
+        if isinstance(handler, Exception):
+            raise handler
+        else:
+            return handler
+
     @classmethod
     def httpGetHandlers(cls, *args, **kwargs):
         try:
@@ -164,6 +166,10 @@ def httpDeleteHandlers(cls, *args, **kwargs):
     def registerHttpPostHandler(cls, url, response):
         BaseTestCase._http_post_handlers[url] = response
 
+    @classmethod
+    def registerHttpPutHandler(cls, url, response):
+        BaseTestCase._http_put_handlers[url] = response
+
     @classmethod
     def registerHttpGetHandler(cls, url, response):
         BaseTestCase._http_get_handlers[url] = response
@@ -177,6 +183,7 @@ def setUpClass(cls):
 
         _http_get_handlers = {}
         _http_post_handlers = {}
+        _http_put_handlers = {}
         _http_delete_handlers = {}
 
         # Register the login handler

tests/cli_mock_api_responses.py

@@ -0,0 +1,56 @@
+# (C) Copyright [2020] Hewlett Packard Enterprise Development LP
+#
+# Permission is hereby granted, free of charge, to any person obtaining a
+# copy of this software and associated documentation files (the "Software"),
+# to deal in the Software without restriction, including without limitation
+# the rights to use, copy, modify, merge, publish, distribute, sublicense,
+# and/or sell copies of the Software, and to permit persons to whom the
+# Software is furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included
+# in all copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL
+# THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR
+# OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
+# ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
+# OTHER DEALINGS IN THE SOFTWARE.
+
+
+from hpecp.exceptions import APIItemNotFoundException
+
+from .base_test import BaseTestCase, MockResponse
+
+
+def mockApiSetup():
+    BaseTestCase.registerHttpGetHandler(
+        url="https://127.0.0.1:8080/some/url",
+        response=MockResponse(
+            json_data={"foo": "bar"},
+            text_data='{"foo":"bar"}',
+            status_code=200,
+            headers=dict(),
+        ),
+    )
+
+    BaseTestCase.registerHttpPostHandler(
+        url="https://127.0.0.1:8080/some/url",
+        response=MockResponse(
+            text_data={"mock_data": True},
+            json_data={},
+            status_code=200,
+            headers={},
+        ),
+    )
+
+    BaseTestCase.registerHttpPutHandler(
+        url="https://127.0.0.1:8080/some/url",
+        response=MockResponse(
+            text_data={"mock_data": True},
+            json_data={},
+            status_code=200,
+            headers={},
+        ),
+    )

tests/cli_test.py

@@ -32,7 +32,11 @@
 from hpecp.gateway import Gateway
 
 from .base_test import BaseTestCase, MockResponse
-from .base_test import session_mock_response as base_login_post_response
+from .cli_mock_api_responses import mockApiSetup
+
+# setup the mock data
+mockApiSetup()
+
 
 if six.PY2:
     # from io import BytesIO as StringIO  # noqa: F811
@@ -204,7 +208,7 @@ def test_configure_cli_reads_hpecp_conf_user_provided_profile(self):
 
 
 class TestBaseProxy(BaseTestCase):
-    @patch("requests.post", side_effect=base_login_post_response)
+    @patch("requests.post", side_effect=BaseTestCase.httpPostHandlers)
     def test_list_with_invalid_column(self, mock_post):
 
         with self.assertRaises(SystemExit) as cm:
@@ -223,7 +227,7 @@ def test_list_with_invalid_column(self, mock_post):
 
         self.assertEqual(cm.exception.code, 1)
 
-    @patch("requests.post", side_effect=base_login_post_response)
+    @patch("requests.post", side_effect=BaseTestCase.httpPostHandlers)
     def test_list_with_invalid_columns_list(self, mock_post):
 
         with self.assertRaises(SystemExit) as cm:
@@ -242,7 +246,7 @@ def test_list_with_invalid_columns_list(self, mock_post):
 
         self.assertEqual(cm.exception.code, 1)
 
-    @patch("requests.post", side_effect=base_login_post_response)
+    @patch("requests.post", side_effect=BaseTestCase.httpPostHandlers)
     def test_list_with_invalid_output_param(self, mock_post):
 
         with self.assertRaises(SystemExit) as cm:
@@ -289,21 +293,6 @@ def test_hpe_config_file_var(self):
 
 
 class TestCLIHttpClient(BaseTestCase):
-    def mocked_requests_post(*args, **kwargs):
-        if args[0] == "https://127.0.0.1:8080/api/v1/login":
-            return base_login_post_response()
-        raise RuntimeError("Unhandle POST request: " + args[0])
-
-    def mocked_requests_get(*args, **kwargs):
-        if args[0] == "https://127.0.0.1:8080/some/url":
-            return MockResponse(
-                json_data={"foo": "bar"},
-                text_data='{"foo":"bar"}',
-                status_code=200,
-                headers=dict(),
-            )
-        raise RuntimeError("Unhandle GET request: " + args[0])
-
     def mocked_requests_failed_login(*args, **kwargs):
         if args[0] == "https://127.0.0.1:8080/api/v1/login":
             return MockResponse(
@@ -315,7 +304,7 @@ def mocked_requests_failed_login(*args, **kwargs):
             )
         raise RuntimeError("Unhandle POST request: " + args[0])
 
-    @patch("requests.get", side_effect=mocked_requests_get)
+    @patch("requests.get", side_effect=BaseTestCase.httpGetHandlers)
     @patch("requests.post", side_effect=mocked_requests_failed_login)
     def test_get_failed_login(self, mock_get, mock_post):
 
@@ -338,8 +327,8 @@ def test_get_failed_login(self, mock_get, mock_post):
             "Expected: `{}` Actual: `{}`".format(expected_err, actual_err),
         )
 
-    @patch("requests.get", side_effect=mocked_requests_get)
-    @patch("requests.post", side_effect=mocked_requests_post)
+    @patch("requests.get", side_effect=BaseTestCase.httpGetHandlers)
+    @patch("requests.post", side_effect=BaseTestCase.httpPostHandlers)
     def test_get(self, mock_get, mock_post):
 
         hpecp = self.cli.CLI()
@@ -358,7 +347,7 @@ def mocked_requests_delete(*args, **kwargs):
         raise RuntimeError("Unhandle DELETE request: " + args[0])
 
     @patch("requests.delete", side_effect=mocked_requests_delete)
-    @patch("requests.post", side_effect=mocked_requests_post)
+    @patch("requests.post", side_effect=BaseTestCase.httpPostHandlers)
     def test_delete(self, mock_delete, mock_post):
 
         hpecp = self.cli.CLI()
@@ -367,20 +356,9 @@ def test_delete(self, mock_delete, mock_post):
         self.assertEqual(self.out.getvalue(), "")
 
     def test_post(self):
-        def mocked_requests_post(*args, **kwargs):
-            if args[0] == "https://127.0.0.1:8080/api/v1/login":
-                return base_login_post_response()
-            if args[0] == "https://127.0.0.1:8080/some/url":
-                return MockResponse(
-                    text_data={"mock_data": True},
-                    json_data={},
-                    status_code=200,
-                    headers={},
-                )
-            raise RuntimeError("Unhandle POST request: " + args[0])
 
         with patch("requests.post") as mock_requests:
-            mock_requests.side_effect = mocked_requests_post
+            mock_requests.side_effect = BaseTestCase.httpPostHandlers
 
             with tempfile.NamedTemporaryFile() as json_file:
                 json_file.write(json.dumps({"abc": "def"}).encode("utf-8"))
@@ -415,20 +393,11 @@ def mocked_requests_post(*args, **kwargs):
         if six.PY2:
             self.assertEqual(stderr, expected_stderr)
 
-    @patch("requests.post", side_effect=mocked_requests_post)
+    @patch("requests.post", side_effect=BaseTestCase.httpPostHandlers)
     def test_put(self, mock_post):
-        def mocked_requests_put(*args, **kwargs):
-            if args[0] == "https://127.0.0.1:8080/some/url":
-                return MockResponse(
-                    text_data={"mock_data": True},
-                    json_data={},
-                    status_code=200,
-                    headers={},
-                )
-            raise RuntimeError("Unhandle PUT request: " + args[0])
 
         with patch("requests.put") as mock_requests:
-            mock_requests.side_effect = mocked_requests_put
+            mock_requests.side_effect = BaseTestCase.httpPutHandlers
 
             with tempfile.NamedTemporaryFile() as json_file:
                 json_file.write(json.dumps({"abc": "def"}).encode("utf-8"))

tests/k8s_worker_test.py

@@ -7,12 +7,7 @@
 from hpecp.exceptions import APIItemConflictException, APIItemNotFoundException
 from hpecp.k8s_worker import K8sWorkerController, WorkerK8s, WorkerK8sStatus
 
-from .base_test import (
-    BaseTestCase,
-    MockResponse,
-    get_client,
-    session_mock_response,
-)
+from .base_test import BaseTestCase, MockResponse, get_client
 from .k8s_worker_mock_api_responses import mockApiSetup
 
 # setup the mock data
@@ -208,11 +203,6 @@ def test_key_and_keycontent_provided(self,):
             ),
         )
 
-    def mocked_requests_post(*args, **kwargs):
-        if args[0] == "https://127.0.0.1:8080/api/v1/login":
-            return session_mock_response()
-        raise RuntimeError("Unhandle POST request: " + args[0])
-
     @patch("requests.post", side_effect=BaseTestCase.httpPostHandlers)
     @patch("hpecp.k8s_worker")
     def test_with_only_ssh_key_content_provided(