test: use request_mock for all clients tests (#537)

Similar to #536 but focused on the resources clients.

Pass request_mock directly to the test functions to configure the mocked
HTTP requests. We do not want to update/modify protected properties (the
mock object) within the client class.

Allows us to move the location of the client request function (that is
mocked) in the future, without breaking the tests.

This also starts adding typing information to the tests, which should
open the door for linting our test code as well.

A lot of the diff is from search and replaces and breaking the test
arguments onto multiple lines.

This is the second patch of a larger set.

Based on top of #536

Author: jooola

tests/unit/actions/test_client.py

@@ -77,15 +77,18 @@ def test_wait_until_finished_max_retries(
 
 class TestResourceActionsClient:
     @pytest.fixture()
-    def actions_client(self):
-        return ResourceActionsClient(client=mock.MagicMock(), resource="/resource")
+    def actions_client(self, client: Client):
+        return ResourceActionsClient(client, resource="/resource")
 
-    def test_get_by_id(self, actions_client, generic_action):
-        actions_client._client.request.return_value = generic_action
+    def test_get_by_id(
+        self,
+        request_mock: mock.MagicMock,
+        actions_client: ActionsClient,
+        generic_action,
+    ):
+        request_mock.return_value = generic_action
         action = actions_client.get_by_id(1)
-        actions_client._client.request.assert_called_with(
-            url="/resource/actions/1", method="GET"
-        )
+        request_mock.assert_called_with(url="/resource/actions/1", method="GET")
         assert action._client == actions_client._client.actions
         assert action.id == 1
         assert action.command == "stop_server"
@@ -94,10 +97,16 @@ def test_get_by_id(self, actions_client, generic_action):
         "params",
         [{}, {"status": ["active"], "sort": ["status"], "page": 2, "per_page": 10}],
     )
-    def test_get_list(self, actions_client, generic_action_list, params):
-        actions_client._client.request.return_value = generic_action_list
+    def test_get_list(
+        self,
+        request_mock: mock.MagicMock,
+        actions_client: ActionsClient,
+        generic_action_list,
+        params,
+    ):
+        request_mock.return_value = generic_action_list
         result = actions_client.get_list(**params)
-        actions_client._client.request.assert_called_with(
+        request_mock.assert_called_with(
             url="/resource/actions", method="GET", params=params
         )
 
@@ -118,13 +127,19 @@ def test_get_list(self, actions_client, generic_action_list, params):
         assert action2.command == "stop_server"
 
     @pytest.mark.parametrize("params", [{}, {"status": ["active"], "sort": ["status"]}])
-    def test_get_all(self, actions_client, generic_action_list, params):
-        actions_client._client.request.return_value = generic_action_list
+    def test_get_all(
+        self,
+        request_mock: mock.MagicMock,
+        actions_client: ActionsClient,
+        generic_action_list,
+        params,
+    ):
+        request_mock.return_value = generic_action_list
         actions = actions_client.get_all(**params)
 
         params.update({"page": 1, "per_page": 50})
 
-        actions_client._client.request.assert_called_with(
+        request_mock.assert_called_with(
             url="/resource/actions", method="GET", params=params
         )
 
@@ -144,15 +159,18 @@ def test_get_all(self, actions_client, generic_action_list, params):
 
 class TestActionsClient:
     @pytest.fixture()
-    def actions_client(self):
-        return ActionsClient(client=mock.MagicMock())
+    def actions_client(self, client: Client):
+        return ActionsClient(client)
 
-    def test_get_by_id(self, actions_client, generic_action):
-        actions_client._client.request.return_value = generic_action
+    def test_get_by_id(
+        self,
+        request_mock: mock.MagicMock,
+        actions_client: ActionsClient,
+        generic_action,
+    ):
+        request_mock.return_value = generic_action
         action = actions_client.get_by_id(1)
-        actions_client._client.request.assert_called_with(
-            url="/actions/1", method="GET"
-        )
+        request_mock.assert_called_with(url="/actions/1", method="GET")
         assert action._client == actions_client._client.actions
         assert action.id == 1
         assert action.command == "stop_server"
@@ -161,13 +179,17 @@ def test_get_by_id(self, actions_client, generic_action):
         "params",
         [{}, {"status": ["active"], "sort": ["status"], "page": 2, "per_page": 10}],
     )
-    def test_get_list(self, actions_client, generic_action_list, params):
-        actions_client._client.request.return_value = generic_action_list
+    def test_get_list(
+        self,
+        request_mock: mock.MagicMock,
+        actions_client: ActionsClient,
+        generic_action_list,
+        params,
+    ):
+        request_mock.return_value = generic_action_list
         with pytest.deprecated_call():
             result = actions_client.get_list(**params)
-        actions_client._client.request.assert_called_with(
-            url="/actions", method="GET", params=params
-        )
+        request_mock.assert_called_with(url="/actions", method="GET", params=params)
 
         assert result.meta is not None
 
@@ -186,16 +208,20 @@ def test_get_list(self, actions_client, generic_action_list, params):
         assert action2.command == "stop_server"
 
     @pytest.mark.parametrize("params", [{}, {"status": ["active"], "sort": ["status"]}])
-    def test_get_all(self, actions_client, generic_action_list, params):
-        actions_client._client.request.return_value = generic_action_list
+    def test_get_all(
+        self,
+        request_mock: mock.MagicMock,
+        actions_client: ActionsClient,
+        generic_action_list,
+        params,
+    ):
+        request_mock.return_value = generic_action_list
         with pytest.deprecated_call():
             actions = actions_client.get_all(**params)
 
         params.update({"page": 1, "per_page": 50})
 
-        actions_client._client.request.assert_called_with(
-            url="/actions", method="GET", params=params
-        )
+        request_mock.assert_called_with(url="/actions", method="GET", params=params)
 
         assert len(actions) == 2