feat: add patch controls to web, review web, enrich info tab (#115)

* add ability to specify one-time patch on package addition

* support vars in interface

tests/ahriman/web/schemas/test_package_patch_schema.py

@@ -0,0 +1 @@
+# schema testing goes in view class tests

tests/ahriman/web/schemas/test_patch_name_schema.py

@@ -0,0 +1 @@
+# schema testing goes in view class tests

tests/ahriman/web/schemas/test_patch_schema.py

@@ -0,0 +1 @@
+# schema testing goes in view class tests

tests/ahriman/web/schemas/test_versioned_log_schema.py

@@ -0,0 +1 @@
+# schema testing goes in view class tests

tests/ahriman/web/views/v1/service/test_view_v1_service_add.py

@@ -4,6 +4,7 @@ from aiohttp.test_utils import TestClient
 from pytest_mock import MockerFixture
 from unittest.mock import AsyncMock
 
+from ahriman.models.pkgbuild_patch import PkgbuildPatch
 from ahriman.models.repository_id import RepositoryId
 from ahriman.models.user_access import UserAccess
 from ahriman.web.views.v1.service.add import AddView
@@ -40,13 +41,42 @@ async def test_post(client: TestClient, repository_id: RepositoryId, mocker: Moc
     assert not request_schema.validate(payload)
     response = await client.post("/api/v1/service/add", json=payload)
     assert response.ok
-    add_mock.assert_called_once_with(repository_id, ["ahriman"], "username", now=True)
+    add_mock.assert_called_once_with(repository_id, ["ahriman"], "username", patches=[], now=True)
 
     json = await response.json()
     assert json["process_id"] == "abc"
     assert not response_schema.validate(json)
 
 
+async def test_post_patches(client: TestClient, repository_id: RepositoryId, mocker: MockerFixture) -> None:
+    """
+    must call post request with patches correctly
+    """
+    add_mock = mocker.patch("ahriman.core.spawn.Spawn.packages_add", return_value="abc")
+    user_mock = AsyncMock()
+    user_mock.return_value = "username"
+    mocker.patch("ahriman.web.views.base.BaseView.username", side_effect=user_mock)
+    request_schema = pytest.helpers.schema_request(AddView.post)
+
+    payload = {
+        "packages": ["ahriman"],
+        "patches": [
+            {
+                "key": "k",
+                "value": "v",
+            },
+            {
+                "key": "k2",
+            },
+        ]
+    }
+    assert not request_schema.validate(payload)
+    response = await client.post("/api/v1/service/add", json=payload)
+    assert response.ok
+    add_mock.assert_called_once_with(repository_id, ["ahriman"], "username",
+                                     patches=[PkgbuildPatch("k", "v"), PkgbuildPatch("k2", "")], now=True)
+
+
 async def test_post_empty(client: TestClient, mocker: MockerFixture) -> None:
     """
     must call raise 400 on empty request

tests/ahriman/web/views/v1/service/test_view_v1_service_request.py

@@ -4,6 +4,7 @@ from aiohttp.test_utils import TestClient
 from pytest_mock import MockerFixture
 from unittest.mock import AsyncMock
 
+from ahriman.models.pkgbuild_patch import PkgbuildPatch
 from ahriman.models.repository_id import RepositoryId
 from ahriman.models.user_access import UserAccess
 from ahriman.web.views.v1.service.request import RequestView
@@ -40,13 +41,42 @@ async def test_post(client: TestClient, repository_id: RepositoryId, mocker: Moc
     assert not request_schema.validate(payload)
     response = await client.post("/api/v1/service/request", json=payload)
     assert response.ok
-    add_mock.assert_called_once_with(repository_id, ["ahriman"], "username", now=False)
+    add_mock.assert_called_once_with(repository_id, ["ahriman"], "username", patches=[], now=False)
 
     json = await response.json()
     assert json["process_id"] == "abc"
     assert not response_schema.validate(json)
 
 
+async def test_post_patches(client: TestClient, repository_id: RepositoryId, mocker: MockerFixture) -> None:
+    """
+    must call post request with patches correctly
+    """
+    add_mock = mocker.patch("ahriman.core.spawn.Spawn.packages_add", return_value="abc")
+    user_mock = AsyncMock()
+    user_mock.return_value = "username"
+    mocker.patch("ahriman.web.views.base.BaseView.username", side_effect=user_mock)
+    request_schema = pytest.helpers.schema_request(RequestView.post)
+
+    payload = {
+        "packages": ["ahriman"],
+        "patches": [
+            {
+                "key": "k",
+                "value": "v",
+            },
+            {
+                "key": "k2",
+            },
+        ]
+    }
+    assert not request_schema.validate(payload)
+    response = await client.post("/api/v1/service/request", json=payload)
+    assert response.ok
+    add_mock.assert_called_once_with(repository_id, ["ahriman"], "username",
+                                     patches=[PkgbuildPatch("k", "v"), PkgbuildPatch("k2", "")], now=False)
+
+
 async def test_post_exception(client: TestClient, mocker: MockerFixture) -> None:
     """
     must raise exception on missing packages payload

tests/ahriman/web/views/v1/status/test_view_v1_status_patch.py

@@ -0,0 +1,81 @@
+import pytest
+
+from aiohttp.test_utils import TestClient
+
+from ahriman.models.build_status import BuildStatusEnum
+from ahriman.models.package import Package
+from ahriman.models.pkgbuild_patch import PkgbuildPatch
+from ahriman.models.user_access import UserAccess
+from ahriman.web.views.v1.status.patch import PatchView
+
+
+async def test_get_permission() -> None:
+    """
+    must return correct permission for the request
+    """
+    for method in ("GET",):
+        request = pytest.helpers.request("", "", method)
+        assert await PatchView.get_permission(request) == UserAccess.Reporter
+    for method in ("DELETE",):
+        request = pytest.helpers.request("", "", method)
+        assert await PatchView.get_permission(request) == UserAccess.Full
+
+
+def test_routes() -> None:
+    """
+    must return correct routes
+    """
+    assert PatchView.ROUTES == ["/api/v1/packages/{package}/patches/{patch}"]
+
+
+async def test_delete(client: TestClient, package_ahriman: Package, package_python_schedule: Package) -> None:
+    """
+    must delete patch for package
+    """
+    await client.post(f"/api/v1/packages/{package_ahriman.base}",
+                      json={"status": BuildStatusEnum.Success.value, "package": package_ahriman.view()})
+    await client.post(f"/api/v1/packages/{package_python_schedule.base}",
+                      json={"status": BuildStatusEnum.Success.value, "package": package_python_schedule.view()})
+
+    patch_key = "k"
+    await client.post(f"/api/v1/packages/{package_ahriman.base}/patches", json={"key": patch_key, "value": "v"})
+    await client.post(f"/api/v1/packages/{package_python_schedule.base}/patches",
+                      json={"key": patch_key, "value": "v2"})
+
+    response = await client.delete(f"/api/v1/packages/{package_ahriman.base}/patches/{patch_key}")
+    assert response.status == 204
+
+    response = await client.get(f"/api/v1/packages/{package_ahriman.base}/patches")
+    assert not await response.json()
+
+    response = await client.get(f"/api/v1/packages/{package_python_schedule.base}/patches")
+    assert await response.json()
+
+
+async def test_get(client: TestClient, package_ahriman: Package) -> None:
+    """
+    must get patch for package
+    """
+    patch = PkgbuildPatch("k", "v")
+    await client.post(f"/api/v1/packages/{package_ahriman.base}",
+                      json={"status": BuildStatusEnum.Success.value, "package": package_ahriman.view()})
+    await client.post(f"/api/v1/packages/{package_ahriman.base}/patches", json=patch.view())
+    response_schema = pytest.helpers.schema_response(PatchView.get)
+
+    response = await client.get(f"/api/v1/packages/{package_ahriman.base}/patches/{patch.key}")
+    assert response.status == 200
+
+    patches = await response.json()
+    assert not response_schema.validate(patches)
+    assert patches == patch.view()
+
+
+async def test_get_not_found(client: TestClient, package_ahriman: Package) -> None:
+    """
+    must return not found for missing package
+    """
+    response_schema = pytest.helpers.schema_response(PatchView.get, code=404)
+
+    response = await client.get(f"/api/v1/packages/{package_ahriman.base}/patches/random")
+    assert response.status == 404
+    assert not response_schema.validate(await response.json())

tests/ahriman/web/views/v1/status/test_view_v1_status_patches.py

@@ -0,0 +1,75 @@
+import pytest
+
+from aiohttp.test_utils import TestClient
+
+from ahriman.models.build_status import BuildStatusEnum
+from ahriman.models.package import Package
+from ahriman.models.pkgbuild_patch import PkgbuildPatch
+from ahriman.models.user_access import UserAccess
+from ahriman.web.views.v1.status.patches import PatchesView
+
+
+async def test_get_permission() -> None:
+    """
+    must return correct permission for the request
+    """
+    for method in ("GET",):
+        request = pytest.helpers.request("", "", method)
+        assert await PatchesView.get_permission(request) == UserAccess.Reporter
+    for method in ("POST",):
+        request = pytest.helpers.request("", "", method)
+        assert await PatchesView.get_permission(request) == UserAccess.Full
+
+
+def test_routes() -> None:
+    """
+    must return correct routes
+    """
+    assert PatchesView.ROUTES == ["/api/v1/packages/{package}/patches"]
+
+
+async def test_get(client: TestClient, package_ahriman: Package) -> None:
+    """
+    must get patch for package
+    """
+    patch = PkgbuildPatch("k", "v")
+    await client.post(f"/api/v1/packages/{package_ahriman.base}",
+                      json={"status": BuildStatusEnum.Success.value, "package": package_ahriman.view()})
+    await client.post(f"/api/v1/packages/{package_ahriman.base}/patches", json=patch.view())
+    response_schema = pytest.helpers.schema_response(PatchesView.get)
+
+    response = await client.get(f"/api/v1/packages/{package_ahriman.base}/patches")
+    assert response.status == 200
+
+    patches = await response.json()
+    assert not response_schema.validate(patches)
+    assert patches == [patch.view()]
+
+
+async def test_post(client: TestClient, package_ahriman: Package) -> None:
+    """
+    must create patch
+    """
+    await client.post(f"/api/v1/packages/{package_ahriman.base}",
+                      json={"status": BuildStatusEnum.Success.value, "package": package_ahriman.view()})
+    request_schema = pytest.helpers.schema_request(PatchesView.post)
+
+    payload = {"key": "k", "value": "v"}
+    assert not request_schema.validate(payload)
+    response = await client.post(f"/api/v1/packages/{package_ahriman.base}/patches", json=payload)
+    assert response.status == 204
+
+    response = await client.get(f"/api/v1/packages/{package_ahriman.base}/patches")
+    patches = await response.json()
+    assert patches == [payload]
+
+
+async def test_post_exception(client: TestClient, package_ahriman: Package) -> None:
+    """
+    must raise exception on invalid payload
+    """
+    response_schema = pytest.helpers.schema_response(PatchesView.post, code=400)
+
+    response = await client.post(f"/api/v1/packages/{package_ahriman.base}/patches", json={})
+    assert response.status == 400
+    assert not response_schema.validate(await response.json())

tests/ahriman/web/views/v2/status/test_view_v2_status_logs.py

@@ -44,7 +44,16 @@ async def test_get(client: TestClient, package_ahriman: Package) -> None:
 
     logs = await response.json()
     assert not response_schema.validate(logs)
-    assert logs["logs"] == [[42.0, "message 1"], [43.0, "message 2"]]
+    assert logs == [
+        {
+            "created": 42.0,
+            "message": "message 1",
+        },
+        {
+            "created": 43.0,
+            "message": "message 2",
+        },
+    ]
 
 
 async def test_get_with_pagination(client: TestClient, package_ahriman: Package) -> None:
@@ -67,18 +76,7 @@ async def test_get_with_pagination(client: TestClient, package_ahriman: Package)
 
     logs = await response.json()
     assert not response_schema.validate(logs)
-    assert logs["logs"] == [[43.0, "message 2"]]
-
-
-async def test_get_not_found(client: TestClient, package_ahriman: Package) -> None:
-    """
-    must return not found for missing package
-    """
-    response_schema = pytest.helpers.schema_response(LogsView.get, code=404)
-
-    response = await client.get(f"/api/v2/packages/{package_ahriman.base}/logs")
-    assert response.status == 404
-    assert not response_schema.validate(await response.json())
+    assert logs == [{"created": 43.0, "message": "message 2"}]
 
 
 async def test_get_bad_request(client: TestClient, package_ahriman: Package) -> None: