feat: Bake enterprise version info into private cloud image (#2420)

* Bake enterprise version info into private cloud image

* formatting

.github/workflows/platform-docker-publish-all-features-image.yml

@@ -62,6 +62,7 @@ jobs:
           cd api
           echo ${{ github.sha }} > CI_COMMIT_SHA
           echo '${{ steps.meta.outputs.tags }}' > IMAGE_TAG
+          echo '' > ENTERPRISE_VERSION
 
       - name: Docker metadata
         id: meta

api/app/urls.py

@@ -15,7 +15,7 @@
     url(r"^api/v1/", include("api.urls.v1", namespace="api-v1")),
     url(r"^admin/", admin.site.urls),
     url(r"^health", include("health_check.urls", namespace="health")),
-    url(r"^version", views.version_info),
+    url(r"^version", views.version_info, name="version-info"),
     url(
         r"^sales-dashboard/",
         include("sales_dashboard.urls", namespace="sales_dashboard"),

api/app/utils.py

@@ -8,19 +8,21 @@ def create_hash():
     return shortuuid.uuid()
 
 
-def get_version_info():
+def get_version_info() -> dict:
     """Reads the version info baked into src folder of the docker container"""
     version_json = {
-        "ci_commit_sha": get_file("./CI_COMMIT_SHA"),
-        "image_tag": get_file("./IMAGE_TAG"),
+        "ci_commit_sha": _get_file_contents("./CI_COMMIT_SHA"),
+        "image_tag": _get_file_contents("./IMAGE_TAG"),
+        "is_enterprise": pathlib.Path("./ENTERPRISE_VERSION").exists(),
     }
 
     return version_json
 
 
-def get_file(file_path):
+def _get_file_contents(file_path: str) -> str:
     """Attempts to read a file from the filesystem and return the contents"""
-    if pathlib.Path(file_path).is_file():
-        return open(file_path).read().replace("\n", "")
-
-    return "unknown"
+    try:
+        with open(file_path) as f:
+            return f.read().replace("\n", "")
+    except FileNotFoundError:
+        return "unknown"

api/app/views.py

@@ -5,13 +5,14 @@
 from django.http import HttpResponse, JsonResponse
 from django.template import loader
 from django.views.decorators.csrf import csrf_exempt
+from rest_framework.request import Request
 
 from . import utils
 
 logger = logging.getLogger(__name__)
 
 
-def version_info(request):
+def version_info(request: Request) -> JsonResponse:
     return JsonResponse(utils.get_version_info())
 
 

api/tests/unit/app/test_unit_app_utils.py

@@ -0,0 +1,33 @@
+import pathlib
+
+from pytest_mock import MockerFixture
+
+from app.utils import get_version_info
+
+
+def test_get_version_info(mocker: MockerFixture) -> None:
+    # Given
+    mocked_pathlib = mocker.patch("app.utils.pathlib")
+
+    def path_side_effect(file_path: str) -> mocker.MagicMock:
+        mocked_path_object = mocker.MagicMock(spec=pathlib.Path)
+
+        if file_path == "./ENTERPRISE_VERSION":
+            mocked_path_object.exists.return_value = True
+
+        return mocked_path_object
+
+    mocked_pathlib.Path.side_effect = path_side_effect
+
+    mock_get_file_contents = mocker.patch("app.utils._get_file_contents")
+    mock_get_file_contents.side_effect = ("some_sha", "v1.0.0")
+
+    # When
+    result = get_version_info()
+
+    # Then
+    assert result == {
+        "ci_commit_sha": "some_sha",
+        "image_tag": "v1.0.0",
+        "is_enterprise": True,
+    }

api/tests/unit/app/test_unit_app_views.py

@@ -0,0 +1,19 @@
+from django.urls import reverse
+from rest_framework import status
+from rest_framework.test import APIClient
+
+
+def test_get_version_info(api_client: APIClient) -> None:
+    # Given
+    url = reverse("version-info")
+
+    # When
+    response = api_client.get(url)
+
+    # Then
+    assert response.status_code == status.HTTP_200_OK
+    assert response.json() == {
+        "ci_commit_sha": "unknown",
+        "image_tag": "unknown",
+        "is_enterprise": False,
+    }