Add Dockerflow to the backend application (#1277)

* Add Dockerflow to the backend application

* Update version.json before taskboot build

* Fix CI

* Apply Bastien's suggestions + Add tests

Co-authored-by: EvaBardou <ebardou@teklia.com>

Author: EvaBardou

.taskcluster.yml

@@ -291,21 +291,11 @@ tasks:
                   privileged: true
                 maxRunTime: 3600
                 image: "${taskboot_image}"
-                env:
-                  GIT_REPOSITORY: ${repository}
-                  GIT_REVISION: ${head_rev}
                 command:
-                  - taskboot
-                  - build
-                  - --image
-                  - mozilla/code-review
-                  - --tag
-                  - "${channel}"
-                  - --tag
-                  - "${head_rev}"
-                  - --write
-                  - /backend.tar
-                  - backend/Dockerfile
+                  - /bin/sh
+                  - -lxce
+                  - "git clone --quiet ${repository} /code-review && cd /code-review && git checkout ${head_rev} -b build
+                    && backend/build.sh ${head_rev} ${head_branch} ${repository} ${channel}"
                 artifacts:
                   public/code-review-backend.tar:
                     expires: {$fromNow: '2 weeks'}

backend/build.sh

@@ -0,0 +1,17 @@
+#!/bin/sh
+COMMIT_SHA=$1
+VERSION=$2
+SOURCE=$3
+CHANNEL=$4
+
+# Create a version.json per https://github.com/mozilla-services/Dockerflow/blob/master/docs/version_object.md
+printf '{"commit": "%s", "version": "%s", "source": "%s", "build": "%s"}\n' \
+"$COMMIT_SHA" \
+"$VERSION" \
+"$SOURCE" \
+"${TASKCLUSTER_ROOT_URL}/tasks/${TASK_ID}" > backend/code_review_backend/version.json
+
+# Run 'taskboot build' with our local copy of the Git repository where we updated the version.json with correct values.
+# To do so, we use '--target /path/to/existing/clone' instead of passing environment variables (GIT_REPOSITORY, GIT_REVISION)
+# to taskboot that would activate an automated clone.
+taskboot --target /code-review build --image mozilla/code-review --tag "$CHANNEL" --tag "$COMMIT_SHA" --write /backend.tar backend/Dockerfile

backend/code_review_backend/app/settings.py

@@ -58,6 +58,7 @@
     "django.contrib.staticfiles",
     "corsheaders",
     "rest_framework",
+    "dockerflow.django",
     "code_review_backend.issues",
     "drf_yasg",
 ]
@@ -71,6 +72,7 @@
     "django.contrib.auth.middleware.AuthenticationMiddleware",
     "django.contrib.messages.middleware.MessageMiddleware",
     "django.middleware.clickjacking.XFrameOptionsMiddleware",
+    "dockerflow.django.middleware.DockerflowMiddleware",
 ]
 
 ROOT_URLCONF = "code_review_backend.app.urls"
@@ -181,10 +183,27 @@
 LOGGING = {
     "version": 1,
     "disable_existing_loggers": False,
-    "handlers": {"console": {"class": "logging.StreamHandler"}},
+    "formatters": {
+        "json": {
+            "()": "dockerflow.logging.JsonLogFormatter",
+            "logger_name": "code_review_backend",
+        },
+    },
+    "handlers": {
+        "console": {"class": "logging.StreamHandler"},
+        "json": {
+            "class": "logging.StreamHandler",
+            "formatter": "json",
+            "level": "DEBUG",
+        },
+    },
     "loggers": {
         "django": {"handlers": ["console"], "level": "INFO"},
         "code_review_backend": {"handlers": ["console"], "level": "INFO"},
+        "request.summary": {
+            "handlers": ["json"],
+            "level": "DEBUG",
+        },
     },
 }
 

backend/code_review_backend/issues/tests/test_dockerflow.py

@@ -0,0 +1,51 @@
+# -*- coding: utf-8 -*-
+# This Source Code Form is subject to the terms of the Mozilla Public
+# License, v. 2.0. If a copy of the MPL was not distributed with this
+# file, You can obtain one at http://mozilla.org/MPL/2.0/.
+
+import json
+
+from django.conf import settings
+from django.test import TestCase
+
+
+class DockerflowEndpointsTestCase(TestCase):
+    def setUp(self):
+        self.old_setting = settings.DEBUG
+
+    def tearDown(self):
+        settings.DEBUG = self.old_setting
+
+    def test_get_version(self):
+        response = self.client.get("/__version__")
+        self.assertEqual(response.status_code, 200)
+
+        with open(f"{settings.BASE_DIR}/version.json", "r") as version_file:
+            self.assertEqual(response.json(), json.loads(version_file.read()))
+
+    def test_get_heartbeat_debug(self):
+        settings.DEBUG = True
+
+        response = self.client.get("/__heartbeat__")
+        self.assertEqual(response.status_code, 200)
+
+        # In DEBUG mode, we can retrieve checks details
+        heartbeat = response.json()
+        self.assertEqual(heartbeat["status"], "ok")
+        self.assertTrue("checks" in heartbeat)
+        self.assertTrue("details" in heartbeat)
+
+    def test_get_heartbeat(self):
+        settings.DEBUG = False
+
+        response = self.client.get("/__heartbeat__")
+        self.assertEqual(response.status_code, 200)
+
+        # When DEBUG is False, we can't retrieve checks details and the status is certainly
+        # equal to "warning" because of the deployment checks that are added:
+        # https://github.com/mozilla-services/python-dockerflow/blob/e316f0c5f0aa6d176a6d08d1f568f83658b51339/src/dockerflow/django/views.py#L45
+        self.assertEqual(response.json(), {"status": "warning"})
+
+    def test_get_lbheartbeat(self):
+        response = self.client.get("/__lbheartbeat__")
+        self.assertEqual(response.status_code, 200)

backend/code_review_backend/version.json

@@ -0,0 +1,6 @@
+{
+  "commit": "stub",
+  "version": "stub",
+  "source": "https://github.com/mozilla/code-review",
+  "build": "https://tools.taskcluster.net/task-inspector/#XXXXXXXXXXXXXXXXXX"
+}

backend/requirements.txt

@@ -3,6 +3,7 @@ dj-database-url==1.0.0
 Django==4.1
 django-cors-headers==3.13.0
 djangorestframework==3.13.1
+dockerflow==2022.7.0
 drf-yasg==1.21.3
 gunicorn==20.1.0
 psycopg2-binary==2.9.3