Merge pull request #743 from maykinmedia/feature/728-version-number

[#728] Add endpoint with version number

Author: SilviaAmAm

backend/requirements/base.in

@@ -39,4 +39,5 @@ celery
 zgw-consumers[setup-configuration]
 furl
 python-slugify
-XlsxWriter
+XlsxWriter
+GitPython

backend/requirements/base.txt

@@ -161,6 +161,10 @@ furl==2.1.3
     # via
     #   -r requirements/base.in
     #   ape-pie
+gitdb==4.0.12
+    # via gitpython
+gitpython==3.1.44
+    # via -r requirements/base.in
 glom==23.5.0
     # via mozilla-django-oidc-db
 idna==3.7
@@ -256,6 +260,8 @@ six==1.16.0
     #   furl
     #   orderedmultidict
     #   python-dateutil
+smmap==5.0.2
+    # via gitdb
 sqlparse==0.5.0
     # via django
 text-unidecode==1.3

backend/requirements/ci.txt

@@ -313,6 +313,15 @@ furl==2.1.3
     #   -c requirements/base.txt
     #   -r requirements/base.txt
     #   ape-pie
+gitdb==4.0.12
+    # via
+    #   -c requirements/base.txt
+    #   -r requirements/base.txt
+    #   gitpython
+gitpython==3.1.44
+    # via
+    #   -c requirements/base.txt
+    #   -r requirements/base.txt
 glom==23.5.0
     # via
     #   -c requirements/base.txt
@@ -573,6 +582,11 @@ six==1.16.0
     #   furl
     #   orderedmultidict
     #   python-dateutil
+smmap==5.0.2
+    # via
+    #   -c requirements/base.txt
+    #   -r requirements/base.txt
+    #   gitdb
 snowballstemmer==2.2.0
     # via sphinx
 soupsieve==2.5

backend/requirements/dev.txt

@@ -367,10 +367,16 @@ furl==2.1.3
     #   -c requirements/ci.txt
     #   -r requirements/ci.txt
     #   ape-pie
-gitdb==4.0.11
-    # via gitpython
-gitpython==3.1.43
-    # via -r requirements/dev.in
+gitdb==4.0.12
+    # via
+    #   -c requirements/ci.txt
+    #   -r requirements/ci.txt
+    #   gitpython
+gitpython==3.1.44
+    # via
+    #   -c requirements/ci.txt
+    #   -r requirements/ci.txt
+    #   -r requirements/dev.in
 glom==23.5.0
     # via
     #   -c requirements/ci.txt
@@ -711,8 +717,11 @@ six==1.16.0
     #   furl
     #   orderedmultidict
     #   python-dateutil
-smmap==5.0.1
-    # via gitdb
+smmap==5.0.2
+    # via
+    #   -c requirements/ci.txt
+    #   -r requirements/ci.txt
+    #   gitdb
 snowballstemmer==2.2.0
     # via
     #   -c requirements/ci.txt

backend/src/openarchiefbeheer/api/urls.py

@@ -9,6 +9,7 @@
 
 from openarchiefbeheer.accounts.api.views import UsersView, WhoAmIView
 from openarchiefbeheer.config.api.views import (
+    ApplicationInfoView,
     ArchiveConfigView,
     HealthCheckView,
     OIDCInfoView,
@@ -123,6 +124,7 @@
                     name="users",
                 ),
                 path("whoami/", WhoAmIView.as_view(), name="whoami"),
+                path("app-info/", ApplicationInfoView.as_view(), name="app-info"),
                 path(
                     "destruction-list-statuses/",
                     ListStatusesListView.as_view(),

backend/src/openarchiefbeheer/conf/base.py

@@ -8,7 +8,7 @@
 from celery.schedules import crontab
 from corsheaders.defaults import default_headers
 
-from .utils import config, get_sentry_integrations
+from .utils import config, get_git_sha, get_release, get_sentry_integrations
 
 # Build paths inside the project, so further paths can be defined relative to
 # the code root.
@@ -378,26 +378,17 @@
 # multiple login urls defined.
 LOGIN_URLS = [reverse_lazy("admin:login")]
 
+
 if "GIT_SHA" in os.environ:
     GIT_SHA = config("GIT_SHA", "")
-# in docker (build) context, there is no .git directory
-elif (BASE_DIR / ".git").exists():
-    try:
-        import git
-    except ImportError:
-        GIT_SHA = None
-    else:
-        repo = git.Repo(search_parent_directories=True)
-        try:
-            GIT_SHA = repo.head.object.hexsha
-        except (
-            ValueError
-        ):  # on startproject initial runs before any git commits have been made
-            GIT_SHA = repo.active_branch.name
 else:
-    GIT_SHA = None
+    GIT_SHA = get_git_sha()
+
+if "RELEASE" in os.environ:
+    RELEASE = config("RELEASE", "")
+else:
+    RELEASE = get_release() or GIT_SHA
 
-RELEASE = config("RELEASE", GIT_SHA)
 
 REQUESTS_READ_TIMEOUT = config("REQUESTS_READ_TIMEOUT", 30)
 # Default (connection timeout, read timeout) for the requests library (in seconds)

backend/src/openarchiefbeheer/conf/utils.py

@@ -48,3 +48,38 @@ def get_sentry_integrations() -> list:
         extra.append(celery.CeleryIntegration())
 
     return [*default, *extra]
+
+
+def get_git_sha() -> str:
+    from git import InvalidGitRepositoryError, Repo
+
+    try:
+        # in docker (build) context, there is no .git directory
+        repo = Repo(search_parent_directories=True)
+    except InvalidGitRepositoryError:
+        return ""
+
+    try:
+        return repo.head.object.hexsha
+    except (
+        ValueError
+    ):  # on startproject initial runs before any git commits have been made
+        return repo.active_branch.name
+
+
+def get_release() -> str:
+    from git import InvalidGitRepositoryError, Repo
+
+    try:
+        # in docker (build) context, there is no .git directory
+        repo = Repo(search_parent_directories=True)
+    except InvalidGitRepositoryError:
+        return ""
+
+    if not len(repo.tags):
+        return ""
+
+    current_tag = next(
+        (tag for tag in repo.tags if tag.commit == repo.head.commit), None
+    )
+    return current_tag.name if current_tag else ""

backend/src/openarchiefbeheer/config/api/serializers.py

@@ -1,3 +1,4 @@
+from django.conf import settings
 from django.utils.translation import gettext_lazy as _
 
 from drf_spectacular.utils import extend_schema_field
@@ -52,3 +53,26 @@ def get_login_url(self, config: OpenIDConnectConfig) -> str:
 
         request = self.context.get("request")
         return reverse("oidc_authentication_init", request=request)
+
+
+class ApplicationInfoSerializer(serializers.Serializer):
+    release = serializers.SerializerMethodField(
+        label=_("Application version"),
+        help_text=_(
+            "This uses the git tag if one is present, otherwise it defaults to the git commit hash. "
+            "If the commit hash cannot be resolved, it will be empty."
+        ),
+    )
+    git_sha = serializers.SerializerMethodField(
+        label=_("Application git commit hash"),
+        help_text=_(
+            "This returns the git commit hash if it can be resolved. "
+            "Otherwise, it will be empty."
+        ),
+    )
+
+    def get_release(self, data) -> str:
+        return settings.RELEASE
+
+    def get_git_sha(self, data) -> str:
+        return settings.GIT_SHA

backend/src/openarchiefbeheer/config/api/views.py

@@ -11,7 +11,11 @@
 
 from ..health_checks import is_configuration_complete
 from ..models import ArchiveConfig
-from .serializers import ArchiveConfigSerializer, OIDCInfoSerializer
+from .serializers import (
+    ApplicationInfoSerializer,
+    ArchiveConfigSerializer,
+    OIDCInfoSerializer,
+)
 
 
 class ArchiveConfigView(APIView):
@@ -128,3 +132,19 @@ class HealthCheckView(APIView):
     def get(self, request: Request, *args, **kwargs):
         results = is_configuration_complete()
         return Response(results)
+
+
+@extend_schema(
+    tags=["Configuration"],
+    summary=_("App info"),
+    description=_("Returns information about the application."),
+    responses={
+        200: ApplicationInfoSerializer(),
+    },
+)
+class ApplicationInfoView(APIView):
+    def get(self, request: Request, *args, **kwargs):
+        serializer = ApplicationInfoSerializer(data={})
+        serializer.is_valid()
+
+        return Response(serializer.data)

backend/src/openarchiefbeheer/config/tests/test_views.py

@@ -190,3 +190,24 @@ def test_health_check(self):
 
         self.assertEqual(response.status_code, status.HTTP_200_OK)
         self.assertFalse(response.json()["success"])
+
+
+@override_settings(RELEASE="1.0.0", GIT_SHA="123")
+class ApplicationInfoTests(APITestCase):
+    def test_not_logged_in(self):
+        response = self.client.get(reverse("api:app-info"))
+
+        self.assertEqual(response.status_code, status.HTTP_403_FORBIDDEN)
+
+    def test_get_app_info(self):
+        user = UserFactory.create()
+        self.client.force_login(user)
+
+        response = self.client.get(reverse("api:app-info"))
+
+        self.assertEqual(response.status_code, status.HTTP_200_OK)
+
+        data = response.json()
+
+        self.assertEqual(data["release"], "1.0.0")
+        self.assertEqual(data["gitSha"], "123")