Add tests for API methods

Prove pagination works as expected and test everything else for good
measure.

Signed-off-by: Stephen Finucane <[email protected]>

Author: stephenfin

pyproject.toml

@@ -61,3 +61,6 @@ ignore = [
     # we make extensive use of printf style formatting and rewriting is a chore
     "UP031",
 ]
+
+[tool.ruff.lint.per-file-ignores]
+"tests/*" = ["S"]

tests/test_api.py

@@ -1,3 +1,5 @@
+from unittest import mock
+
 import pytest
 
 from pwclient import api
@@ -14,7 +16,7 @@ def test_xmlrpc_init__missing_username():
 def test_xmlrpc_init__invalid_auth():
     """The XML-RPC API doesn't support tokens."""
     with pytest.raises(exceptions.ConfigError) as exc:
-        api.XMLRPC('https://example.com/xmlrpc', token='foo')  # noqa: S106
+        api.XMLRPC('https://example.com/xmlrpc', token='foo')
 
     assert 'The XML-RPC API does not support API tokens' in str(exc.value)
 
@@ -35,3 +37,116 @@ def test_rest_init__transform_legacy_url(capsys):
     assert (
         'Automatically converted XML-RPC URL to REST API URL.' in captured.err
     )
+
+
+def test_rest_client__create():
+    """Validate the _create helper."""
+    client = api.REST(
+        'https://patchwork.kernel.org/api',
+        username='user',
+        password='pass',
+    )
+
+    fake_response = mock.MagicMock()
+    fake_response.read.return_value = (
+        b'{"id": 1, "state": "success", "context": "foo"}'
+    )
+    fake_response.getheaders.return_value = []
+
+    with mock.patch('urllib.request.urlopen') as mock_open:
+        fake_response.__enter__.return_value = fake_response
+        mock_open.return_value = fake_response
+
+        expected = {'id': 1, 'state': 'success', 'context': 'foo'}
+        actual = client._create(
+            'patches',
+            resource_id=1,
+            subresource_type='checks',
+            data={'context': 'foo', 'state': 'success'},
+        )
+
+        assert expected == actual
+
+
+def test_rest_client__update():
+    """Validate the _update helper."""
+    client = api.REST(
+        'https://patchwork.kernel.org/api',
+        username='user',
+        password='pass',
+    )
+
+    fake_response = mock.MagicMock()
+    fake_response.read.return_value = b'{"id": 1, "archived": true}'
+    fake_response.getheaders.return_value = []
+
+    with mock.patch('urllib.request.urlopen') as mock_open:
+        fake_response.__enter__.return_value = fake_response
+        mock_open.return_value = fake_response
+
+        expected = {'id': 1, 'archived': True}
+        actual = client._update(
+            'patches',
+            1,
+            {'archived': True},
+        )
+
+        assert expected == actual
+
+
+def test_rest_client__detail():
+    """Validate the _detail helper."""
+    client = api.REST(
+        'https://patchwork.kernel.org/api',
+        username='user',
+        password='pass',
+    )
+
+    fake_response = mock.MagicMock()
+    fake_response.read.return_value = b'{"id": 1, "name": "foo"}'
+    fake_response.getheaders.return_value = []
+
+    with mock.patch('urllib.request.urlopen') as mock_open:
+        fake_response.__enter__.return_value = fake_response
+        mock_open.return_value = fake_response
+
+        expected = {'id': 1, 'name': 'foo'}
+        actual = client._detail(
+            'patches',
+            1,
+        )
+
+        assert expected == actual
+
+
+def test_rest_client__list():
+    """Validate the _list helper."""
+    client = api.REST(
+        'https://patchwork.kernel.org/api',
+        username='user',
+        password='pass',
+    )
+
+    fake_response = mock.MagicMock()
+    fake_response.read.side_effect = [
+        b'[{"id": 1}]',
+        b'[{"id": 2}]',
+    ]
+    fake_response.getheaders.side_effect = [
+        [
+            (
+                'Link',
+                '<https://patchwork.kernel.org/api/patches/?page=2&project=patchwork>; rel="next"',
+            )
+        ],
+        [],
+    ]
+
+    with mock.patch('urllib.request.urlopen') as mock_open:
+        fake_response.__enter__.return_value = fake_response
+        mock_open.return_value = fake_response
+
+        expected = [{'id': 1}, {'id': 2}]
+        actual = list(client._list('patches'))
+
+        assert expected == actual

tests/test_patches.py

@@ -137,7 +137,7 @@ def test_action_list__submitter_filter(mock_list_patches, capsys):
     assert (
         'Patches submitted by Joe Bloggs <[email protected]>:'
         in captured.out
-    )  # noqa: E501
+    )
 
     api.patch_list.assert_called_once_with(
         project='defaultproject',