feat: add settings/system/ API endpoint (#1064)

Co-authored-by: Alex <[email protected]>

Author: bzwei

src/aap_eda/api/serializers/setting.py

@@ -0,0 +1,45 @@
+#  Copyright 2024 Red Hat, Inc.
+#
+#  Licensed under the Apache License, Version 2.0 (the "License");
+#  you may not use this file except in compliance with the License.
+#  You may obtain a copy of the License at
+#
+#      http://www.apache.org/licenses/LICENSE-2.0
+#
+#  Unless required by applicable law or agreed to in writing, software
+#  distributed under the License is distributed on an "AS IS" BASIS,
+#  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+#  See the License for the specific language governing permissions and
+#  limitations under the License.
+
+from rest_framework import serializers
+
+from aap_eda.conf import settings_registry
+
+
+class SettingSerializer(serializers.Serializer):
+    def __init__(self, *args, **kwargs):
+        super(SettingSerializer, self).__init__(*args, **kwargs)
+
+        for key in settings_registry.get_registered_settings():
+            v_type = settings_registry.get_setting_type(key)
+            read_only = settings_registry.is_setting_read_only(key)
+            if v_type == str:
+                field = serializers.CharField(
+                    required=False, allow_blank=True, read_only=read_only
+                )
+            elif v_type == int:
+                field = serializers.IntegerField(
+                    required=False, read_only=read_only
+                )
+            elif v_type == bool:
+                field = serializers.BooleanField(
+                    required=False, read_only=read_only
+                )
+            elif v_type == dict:
+                field = serializers.JSONField(
+                    required=False, read_only=read_only
+                )
+            else:
+                raise TypeError(f"unsupported type {v_type}")
+            self.fields[key] = field

src/aap_eda/api/urls.py

@@ -85,6 +85,9 @@
 
 eda_v1_urls = [
     path("config/", views.ConfigView.as_view(), name="config"),
+    path(
+        "settings/system/", views.SettingView.as_view(), name="setting-system"
+    ),
     path("status/", core_views.StatusView.as_view(), name="status"),
     path("", include(openapi_urls)),
     path(

src/aap_eda/api/views/__init__.py

@@ -24,6 +24,7 @@
 from .project import ProjectViewSet
 from .root import ApiRootView, ApiV1RootView
 from .rulebook import AuditRuleViewSet, RulebookViewSet
+from .setting import SettingView
 from .team import TeamViewSet
 from .user import CurrentUserAwxTokenViewSet, CurrentUserView, UserViewSet
 
@@ -61,4 +62,5 @@
     "EventStreamViewSet",
     # External event stream
     "ExternalEventStreamViewSet",
+    "SettingView",
 )

src/aap_eda/api/views/setting.py

@@ -0,0 +1,60 @@
+#  Copyright 2024 Red Hat, Inc.
+#
+#  Licensed under the Apache License, Version 2.0 (the "License");
+#  you may not use this file except in compliance with the License.
+#  You may obtain a copy of the License at
+#
+#      http://www.apache.org/licenses/LICENSE-2.0
+#
+#  Unless required by applicable law or agreed to in writing, software
+#  distributed under the License is distributed on an "AS IS" BASIS,
+#  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+#  See the License for the specific language governing permissions and
+#  limitations under the License.
+
+from drf_spectacular.utils import OpenApiResponse, extend_schema
+from rest_framework import status
+from rest_framework.permissions import IsAdminUser
+from rest_framework.request import Request
+from rest_framework.response import Response
+from rest_framework.views import APIView
+
+from aap_eda.api.serializers.setting import SettingSerializer
+from aap_eda.conf import settings_registry
+
+
+class SettingView(APIView):
+    permission_classes = [IsAdminUser]
+
+    def get_serializer(self, *args, **kwargs):
+        return SettingSerializer(*args, **kwargs)
+
+    @extend_schema(
+        description="Get application system settings",
+        responses={
+            status.HTTP_200_OK: OpenApiResponse(
+                SettingSerializer,
+                description=("Return application system settings"),
+            )
+        },
+    )
+    def get(self, request):
+        data = settings_registry.db_get_settings_for_display()
+        return Response(SettingSerializer(data).data)
+
+    @extend_schema(
+        description="Partially update application system settings",
+        request=SettingSerializer,
+        responses={
+            status.HTTP_200_OK: OpenApiResponse(
+                SettingSerializer,
+                description="Return updated system settings.",
+            ),
+        },
+    )
+    def patch(self, request: Request):
+        serializer = SettingSerializer(data=request.data)
+        serializer.is_valid(raise_exception=True)
+        settings_registry.db_update_settings(serializer.validated_data)
+
+        return self.get(None)

tests/integration/api/test_application_setting.py

@@ -0,0 +1,70 @@
+#  Copyright 2024 Red Hat, Inc.
+#
+#  Licensed under the Apache License, Version 2.0 (the "License");
+#  you may not use this file except in compliance with the License.
+#  You may obtain a copy of the License at
+#
+#      http://www.apache.org/licenses/LICENSE-2.0
+#
+#  Unless required by applicable law or agreed to in writing, software
+#  distributed under the License is distributed on an "AS IS" BASIS,
+#  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+#  See the License for the specific language governing permissions and
+#  limitations under the License.
+
+import pytest
+from rest_framework import status
+from rest_framework.test import APIClient
+
+from aap_eda.conf import settings_registry
+from tests.integration.constants import api_url_v1
+
+
+@pytest.fixture(autouse=True)
+def register() -> None:
+    settings_registry.persist_registry_data()
+
+
+@pytest.mark.django_db
+def test_list_system_settings(superuser_client: APIClient):
+    response = superuser_client.get(f"{api_url_v1}/settings/system/")
+    assert response.status_code == status.HTTP_200_OK
+    data = response.data
+    assert len(data) == 10
+    assert data["INSIGHTS_TRACKING_STATE"] is False
+    assert data["AUTOMATION_ANALYTICS_GATHER_INTERVAL"] == 14400
+
+
+@pytest.mark.django_db
+def test_partial_update_system_settings(superuser_client: APIClient):
+    pword = "secret"
+    body = {"REDHAT_USERNAME": "auser", "REDHAT_PASSWORD": pword}
+    response = superuser_client.patch(
+        f"{api_url_v1}/settings/system/", data=body
+    )
+    assert response.status_code == status.HTTP_200_OK
+    data = response.data
+    assert len(data) == 10
+    assert data["REDHAT_USERNAME"] == "auser"
+    assert data["REDHAT_PASSWORD"] == "$encrypted$"
+
+
+@pytest.mark.django_db
+def test_list_settings_forbidden(user_client: APIClient):
+    response = user_client.get(f"{api_url_v1}/settings/system/")
+    assert response.status_code == status.HTTP_403_FORBIDDEN
+
+
+@pytest.mark.django_db
+def test_update_settings_forbidden(user_client: APIClient):
+    response = user_client.patch(f"{api_url_v1}/settings/system/", data={})
+    assert response.status_code == status.HTTP_403_FORBIDDEN
+
+
+@pytest.mark.django_db
+def test_update_settings_wrong_type(superuser_client: APIClient):
+    data = {"AUTOMATION_ANALYTICS_GATHER_INTERVAL": "not number"}
+    response = superuser_client.patch(
+        f"{api_url_v1}/settings/system/", data=data
+    )
+    assert response.status_code == status.HTTP_400_BAD_REQUEST

tests/integration/api/test_root.py

@@ -45,6 +45,7 @@
                 "/organizations/",
                 "/teams/",
                 "/event-streams/",
+                "/settings/system/",
             ],
             True,
             id="with_shared_resource",
@@ -83,6 +84,7 @@
                 "/organizations/",
                 "/teams/",
                 "/event-streams/",
+                "/settings/system/",
             ],
             False,
             id="no_shared_resource",

tests/integration/conftest.py

@@ -74,6 +74,7 @@ def super_user():
         password="superuser123",
         email="superuser@localhost",
         is_superuser=True,
+        is_staff=True,
     )