Implement build_number_generator with django

README.md

@@ -1,3 +1,38 @@
 # backend-services
 
 Scripts used to power the Mumble public infrastructure backend (e.g. public server list)
+
+
+## Development
+
+Enter the Django project folder ``mumble_backend``. Call ``source setup``
+to create a new venv which automatically installs Django and activates it.
+
+Create the database tables with:
+```
+python manage.py migrate
+```
+
+Start the development server with:
+```
+python manage.py runserver
+```
+
+Run tests with:
+```
+python manage.py test
+```
+
+Create an admin account for the admin interface with:
+```
+python manage.py createsuperuser
+```
+
+Auto format code with:
+```
+black .
+```
+
+## Production
+
+TBD

mumble_backend/build_number_generator/admin.py

@@ -0,0 +1,6 @@
+from django.contrib import admin
+
+from .models import Series, Build
+
+admin.site.register(Series)
+admin.site.register(Build)

mumble_backend/build_number_generator/apps.py

@@ -0,0 +1,6 @@
+from django.apps import AppConfig
+
+
+class BuildNumberGeneratorConfig(AppConfig):
+    default_auto_field = "django.db.models.BigAutoField"
+    name = "build_number_generator"

mumble_backend/build_number_generator/migrations/0001_initial.py

@@ -0,0 +1,62 @@
+# Generated by Django 4.1.7 on 2023-04-02 10:26
+
+from django.db import migrations, models
+import django.db.models.deletion
+
+
+class Migration(migrations.Migration):
+    initial = True
+
+    dependencies = []
+
+    operations = [
+        migrations.CreateModel(
+            name="Series",
+            fields=[
+                (
+                    "id",
+                    models.BigAutoField(
+                        auto_created=True,
+                        primary_key=True,
+                        serialize=False,
+                        verbose_name="ID",
+                    ),
+                ),
+                ("name", models.CharField(max_length=20, unique=True)),
+                ("created_on", models.DateTimeField(auto_now_add=True)),
+            ],
+            options={
+                "verbose_name_plural": "series",
+            },
+        ),
+        migrations.CreateModel(
+            name="Build",
+            fields=[
+                (
+                    "id",
+                    models.BigAutoField(
+                        auto_created=True,
+                        primary_key=True,
+                        serialize=False,
+                        verbose_name="ID",
+                    ),
+                ),
+                ("commit_hash", models.CharField(max_length=128)),
+                ("build_number", models.PositiveIntegerField()),
+                ("created_on", models.DateTimeField(auto_now_add=True)),
+                (
+                    "series",
+                    models.ForeignKey(
+                        on_delete=django.db.models.deletion.PROTECT,
+                        to="build_number_generator.series",
+                    ),
+                ),
+            ],
+        ),
+        migrations.AddConstraint(
+            model_name="build",
+            constraint=models.UniqueConstraint(
+                fields=("series", "commit_hash"), name="commit_unique_in_series"
+            ),
+        ),
+    ]

mumble_backend/build_number_generator/models.py

@@ -0,0 +1,29 @@
+from django.db import models
+
+
+class Series(models.Model):
+    name = models.CharField(max_length=20, unique=True)
+    created_on = models.DateTimeField(auto_now_add=True)
+
+    def __str__(self):
+        return "%s.x" % (self.name)  # e.g. 1.4.x
+
+    class Meta:
+        verbose_name_plural = "series"
+
+
+class Build(models.Model):
+    series = models.ForeignKey(Series, on_delete=models.PROTECT)
+    commit_hash = models.CharField(max_length=128)
+    build_number = models.PositiveIntegerField()
+    created_on = models.DateTimeField(auto_now_add=True)
+
+    def __str__(self):
+        return "%s.%i" % (self.series.name, self.build_number)  # e.g. 1.4.142
+
+    class Meta:
+        constraints = [
+            models.UniqueConstraint(
+                fields=["series", "commit_hash"], name="commit_unique_in_series"
+            )
+        ]

mumble_backend/build_number_generator/tests.py

@@ -0,0 +1,232 @@
+from django.test import TestCase
+from django.db.utils import IntegrityError
+from .models import Series, Build
+
+import json
+
+AUTH_PASSWORD = "testpassword"
+
+
+class HttpTest(TestCase):
+    # Expect to reach all URLs without a 404 error
+    def test_url_routing(self):
+        urls = [
+            "/build-number",
+            "/build-number/",
+            "/build-number/series",
+            "/build-number/series/",
+            "/build-number/series/hash",
+            "/build-number/series/hash/",
+        ]
+        for url in urls:
+            response = self.client.post(url, {"token": AUTH_PASSWORD})
+            self.assertNotEqual(response.status_code, 404)
+
+    # Expect to only be able to use the POST method
+    def test_http_method(self):
+        response = self.client.get("/build-number")
+        self.assertEqual(response.status_code, 405)
+
+        response = self.client.post("/build-number")
+        self.assertEqual(response.status_code, 401)
+
+    # Expect authorization requirements
+    def test_authorized(self):
+        response = self.client.post("/build-number")
+        self.assertEqual(response.status_code, 401)
+
+        response = self.client.post("/build-number", {"token": AUTH_PASSWORD})
+        self.assertEqual(response.status_code, 400)
+
+    # Expect argument parsing to only accept valid arguments
+    def test_argument_parsing(self):
+        response = self.client.post(
+            "/build-number/11/931ad6480dce38486a221119bccd0a35e5cdbb81",
+            {"token": AUTH_PASSWORD},
+        )
+        self.assertEqual(response.status_code, 400)
+
+        response = self.client.post(
+            "/build-number/1.a/931ad6480dce38486a221119bccd0a35e5cdbb81",
+            {"token": AUTH_PASSWORD},
+        )
+        self.assertEqual(response.status_code, 400)
+
+        response = self.client.post("/build-number/1.1/SHORT", {"token": AUTH_PASSWORD})
+        self.assertEqual(response.status_code, 400)
+
+        response = self.client.post(
+            "/build-number/1.1/931ad6480dce38486a221119bccd0a35e5cdbb81",
+            {"token": AUTH_PASSWORD},
+        )
+        self.assertEqual(response.status_code, 201)
+
+
+class ModelTest(TestCase):
+    # Expect constraints to be enforced
+    def test_constraint(self):
+        series = Series.objects.create(name="1.1")
+        Build.objects.create(
+            series=series,
+            commit_hash="931ad6480dce38486a221119bccd0a35e5cdbb81",
+            build_number=1,
+        )
+
+        with self.assertRaises(IntegrityError):
+            Build.objects.create(
+                series=series,
+                commit_hash="931ad6480dce38486a221119bccd0a35e5cdbb81",
+                build_number=1,
+            )
+
+
+class DatabaseTestInsert(TestCase):
+    # Unknown series, unknown commit
+    def test_db_insert(self):
+        self.assertEqual(len(Series.objects.all()), 0)
+        self.assertEqual(len(Build.objects.all()), 0)
+
+        response = self.client.post(
+            "/build-number/1.1/931ad6480dce38486a221119bccd0a35e5cdbb81",
+            {"token": AUTH_PASSWORD},
+        )
+        self.assertEqual(response.status_code, 201)
+
+        self.assertEqual(len(Series.objects.all()), 1)
+        self.assertEqual(len(Build.objects.all()), 1)
+
+    # Known series, unknown commit
+    def test_db_insert_multiple_hashes(self):
+        self.assertEqual(len(Series.objects.all()), 0)
+        self.assertEqual(len(Build.objects.all()), 0)
+
+        response = self.client.post(
+            "/build-number/1.1/931ad6480dce38486a221119bccd0a35e5cdbb81",
+            {"token": AUTH_PASSWORD},
+        )
+        self.assertEqual(response.status_code, 201)
+
+        response = self.client.post(
+            "/build-number/1.1/784ec286c3b0292b2aece78a2300c55143932360",
+            {"token": AUTH_PASSWORD},
+        )
+        self.assertEqual(response.status_code, 201)
+
+        self.assertEqual(len(Series.objects.all()), 1)
+        self.assertEqual(len(Build.objects.all()), 2)
+
+    # Expect no database interaction on the second call
+    def test_db_insert_reuse_hash(self):
+        self.assertEqual(len(Series.objects.all()), 0)
+        self.assertEqual(len(Build.objects.all()), 0)
+
+        response = self.client.post(
+            "/build-number/1.1/931ad6480dce38486a221119bccd0a35e5cdbb81",
+            {"token": AUTH_PASSWORD},
+        )
+        self.assertEqual(response.status_code, 201)
+
+        response = self.client.post(
+            "/build-number/1.1/931ad6480dce38486a221119bccd0a35e5cdbb81",
+            {"token": AUTH_PASSWORD},
+        )
+        self.assertEqual(response.status_code, 200)
+
+        self.assertEqual(len(Series.objects.all()), 1)
+        self.assertEqual(len(Build.objects.all()), 1)
+
+    # Unknown series, known commit
+    def test_db_insert_multiple_series(self):
+        self.assertEqual(len(Series.objects.all()), 0)
+        self.assertEqual(len(Build.objects.all()), 0)
+
+        response = self.client.post(
+            "/build-number/1.1/931ad6480dce38486a221119bccd0a35e5cdbb81",
+            {"token": AUTH_PASSWORD},
+        )
+        self.assertEqual(response.status_code, 201)
+
+        response = self.client.post(
+            "/build-number/1.2/931ad6480dce38486a221119bccd0a35e5cdbb81",
+            {"token": AUTH_PASSWORD},
+        )
+        self.assertEqual(response.status_code, 201)
+
+        self.assertEqual(len(Series.objects.all()), 2)
+        self.assertEqual(len(Build.objects.all()), 2)
+
+
+class DatabaseTestContent(TestCase):
+    # Expect correct database values after insertions
+    def test_db_content(self):
+        self.client.post(
+            "/build-number/1.1/931ad6480dce38486a221119bccd0a35e5cdbb81",
+            {"token": AUTH_PASSWORD},
+        )
+
+        series = Series.objects.all()[0]
+        build = Build.objects.all()[0]
+
+        self.assertEqual(series.name, "1.1")
+        self.assertEqual(build.series, series)
+        self.assertEqual(build.commit_hash, "931ad6480dce38486a221119bccd0a35e5cdbb81")
+        self.assertEqual(build.build_number, 1)
+
+    # Expect correct database values after insertions
+    def test_db_content_multiple(self):
+        self.client.post(
+            "/build-number/1.1/931ad6480dce38486a221119bccd0a35e5cdbb81",
+            {"token": AUTH_PASSWORD},
+        )
+        self.client.post(
+            "/build-number/1.1/784ec286c3b0292b2aece78a2300c55143932360",
+            {"token": AUTH_PASSWORD},
+        )
+
+        series = Series.objects.all()[0]
+        build = Build.objects.all()[1]
+
+        self.assertEqual(series.name, "1.1")
+        self.assertEqual(build.series, series)
+        self.assertEqual(build.commit_hash, "784ec286c3b0292b2aece78a2300c55143932360")
+        self.assertEqual(build.build_number, 2)
+
+    # Expect to fail if the new build number exceeds two bytes
+    def test_db_fail_mumble_limit(self):
+        self.client.post(
+            "/build-number/1.1/931ad6480dce38486a221119bccd0a35e5cdbb81",
+            {"token": AUTH_PASSWORD},
+        )
+        series = Series.objects.all()[0]
+
+        Build.objects.create(
+            series=series,
+            commit_hash="784ec286c3b0292b2aece78a2300c55143932360",
+            build_number=0xFFFF,
+        )
+
+        response = self.client.post(
+            "/build-number/1.1/3e273e617a0adba491e9879f6aabf7915db0f432",
+            {"token": AUTH_PASSWORD},
+        )
+        self.assertEqual(response.status_code, 422)
+
+        self.assertEqual(len(Build.objects.all()), 2)
+
+
+class JSONResponseTest(TestCase):
+    # Expect the JSON response to match the arguments
+    def test_json(self):
+        response = self.client.post(
+            "/build-number/1.1/931ad6480dce38486a221119bccd0a35e5cdbb81",
+            {"token": AUTH_PASSWORD},
+        )
+        response = json.loads(response.content)
+
+        self.assertEqual(response["series"], "1.1")
+        self.assertEqual(response["series_id"], 1)
+        self.assertEqual(
+            response["commit_hash"], "931ad6480dce38486a221119bccd0a35e5cdbb81"
+        )
+        self.assertEqual(response["build_number"], 1)
+        self.assertEqual(response["status"], 201)

mumble_backend/build_number_generator/urls.py

@@ -0,0 +1,12 @@
+from django.urls import path
+
+from . import views
+
+urlpatterns = [
+    path("", views.process, name="build-number"),
+    path("/", views.process, name="build-number"),
+    path("/<str:series>", views.process, name="build-number"),
+    path("/<str:series>/", views.process, name="build-number"),
+    path("/<str:series>/<str:commit>", views.process, name="build-number"),
+    path("/<str:series>/<str:commit>/", views.process, name="build-number"),
+]