Merge pull request #2 from nationalarchives/feature/docker-test

Make a Docker image for tests

.github/workflows/ci.yml

@@ -8,15 +8,13 @@ jobs:
     steps:
       - name: Checkout
         uses: actions/checkout@v4
-      - name: Set up Python
-        uses: actions/setup-python@v5
-        with:
-          python-version: '3.x'
-      - name: Install Python requirements
-        run: pip install -r test/requirements.txt
-      - name: Run server
-        run: flask --app test run --debug --port 5000 &
       - name: Install Node dependencies
         run: npm install
+      - name: Start test server
+        run: docker compose up -d
+      - name: Wait for response
+        uses: nev7n/wait_for_response@v1
+        with:
+          url: http://localhost:5001/ready/
       - name: Run the tests
         run: node test-fixtures.mjs || exit 1

.github/workflows/python-publish.yml

@@ -4,22 +4,23 @@ on:
   release:
     types: [published]
 
+concurrency:
+  group: deploy-${{ github.ref }}
+
 jobs:
   test:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout
         uses: actions/checkout@v4
-      - name: Set up Python
-        uses: actions/setup-python@v5
-        with:
-          python-version: '3.x'
-      - name: Install Python requirements
-        run: pip install -r test/requirements.txt
-      - name: Run server
-        run: flask --app test run --debug --port 5000 &
       - name: Install Node dependencies
         run: npm install
+      - name: Start test server
+        run: docker compose up -d
+      - name: Wait for response
+        uses: nev7n/wait_for_response@v1
+        with:
+          url: http://localhost:5001/ready/
       - name: Run the tests
         run: node test-fixtures.mjs || exit 1
 

README.md

@@ -97,8 +97,7 @@ We test each component against its published [component fixtures](https://github
 ## Test the templates
 
 ```sh
-python -m venv venv
-python install -r test/requirements.txt
-flask --app test run --debug --port 5000
+npm install
+docker compose up -d
 node test-fixtures.mjs
 ```

docker-compose.yml

@@ -0,0 +1,14 @@
+services:
+  app:
+    build:
+      # context: test
+      dockerfile: test/Dockerfile
+    environment:
+      - ENVIRONMENT=develop
+      - CONFIG=config.Develop
+      - SECRET_KEY=abc123
+    ports:
+      - 5001:8080
+    volumes:
+      - ./test:/app
+      - ./tna_frontend_jinja:/home/app/tna_frontend_jinja

package.json

@@ -1,15 +1,13 @@
 {
   "scripts": {
-    "prettier": "prettier --write '*.{mjs,json}'",
-    "run": "flask --app test run --debug --port 5000",
+    "prettier": "npx --yes prettier --write '*.{mjs,json}'",
     "test": "node test-fixtures.mjs"
   },
   "dependencies": {
     "@nationalarchives/frontend": "^0.2.8",
     "diff": "^5.1.0",
     "glob": "^10.2.7",
     "js-beautify": "^1.14.8",
-    "node-fetch": "^3.3.1",
-    "prettier": "^3.2.5"
+    "node-fetch": "^3.3.1"
   }
 }

test-fixtures.mjs

@@ -13,7 +13,7 @@ const fail = (message) => {
 };
 
 console.log("Running tests...");
-const testEndpoint = "http://127.0.0.1:5000/";
+const testEndpoint = "http://127.0.0.1:5001/";
 const standardiseHtml = (html) =>
   html_beautify(
     html
@@ -93,7 +93,8 @@ for (let i = 0; i < components.length; i++) {
       const diff = diffChars(bodyPretty, fixturePretty)
         .map(
           (part) =>
-            `${part.added ? "\x1b[32m" : part.removed ? "\x1b[31m" : "\x1b[0m"
+            `${
+              part.added ? "\x1b[32m" : part.removed ? "\x1b[31m" : "\x1b[0m"
             }${part.value === " " ? "█" : part.value}`,
         )
         .join("");
@@ -171,7 +172,8 @@ for (let i = 0; i < utilities.length; i++) {
       const diff = diffChars(bodyPretty, fixturePretty)
         .map(
           (part) =>
-            `${part.added ? "\x1b[32m" : part.removed ? "\x1b[31m" : "\x1b[0m"
+            `${
+              part.added ? "\x1b[32m" : part.removed ? "\x1b[31m" : "\x1b[0m"
             }${part.value === " " ? "█" : part.value}`,
         )
         .join("");
@@ -189,12 +191,10 @@ for (let i = 0; i < utilities.length; i++) {
 
 const templatesDirectory = `${tnaFrontendDirectory}/nationalarchives/templates/`;
 const { fixtures } = JSON.parse(
-  fs.readFileSync(`${templatesDirectory}fixtures.json`,
-    "utf8",
-  ),
+  fs.readFileSync(`${templatesDirectory}fixtures.json`, "utf8"),
 );
-const genericFixture = fixtures.find(fixture => fixture.name === "generic")
-const testUrl = `${testEndpoint}templates/base`
+const genericFixture = fixtures.find((fixture) => fixture.name === "generic");
+const testUrl = `${testEndpoint}templates/base`;
 console.log("\nTemplates");
 const response = await fetch(testUrl)
   .then((response) => {
@@ -218,7 +218,8 @@ if (mismatch) {
   const diff = diffChars(bodyPretty, fixturePretty)
     .map(
       (part) =>
-        `${part.added ? "\x1b[32m" : part.removed ? "\x1b[31m" : "\x1b[0m"
+        `${
+          part.added ? "\x1b[32m" : part.removed ? "\x1b[31m" : "\x1b[0m"
         }${part.value === " " ? "█" : part.value}`,
     )
     .join("");
@@ -230,4 +231,4 @@ if (mismatch) {
   throw new Error("Fixtures tests failed");
 } else {
   pass(genericFixture.name);
-}
+}

test/Dockerfile

@@ -0,0 +1,8 @@
+FROM ghcr.io/nationalarchives/tna-python:latest
+
+COPY --chown=app test .
+COPY --chown=app ../tna_frontend_jinja /home/app/tna_frontend_jinja
+
+RUN tna-build
+
+CMD ["tna-run", "app:app"]

test/app/__init__.py

@@ -1,15 +1,16 @@
 from flask import Flask
+from .components import bp as components_bp
+from .utilities import bp as utilities_bp
+from .templates import bp as templates_bp
 
+app = Flask(__name__, template_folder="/home/app/tna_frontend_jinja/templates")
 
-def create_app():
-    app = Flask(__name__, template_folder="../../tna_frontend_jinja/templates")
 
-    from .components import bp as components_bp
-    from .utilities import bp as utilities_bp
-    from .templates import bp as templates_bp
+@app.route("/ready/")
+def ready():
+    return "ok"
 
-    app.register_blueprint(components_bp, url_prefix="/components")
-    app.register_blueprint(utilities_bp, url_prefix="/utilities")
-    app.register_blueprint(templates_bp, url_prefix="/templates")
 
-    return app
+app.register_blueprint(components_bp, url_prefix="/components")
+app.register_blueprint(utilities_bp, url_prefix="/utilities")
+app.register_blueprint(templates_bp, url_prefix="/templates")

test/app/components/__init__.py

@@ -2,4 +2,4 @@
 
 bp = Blueprint("components", __name__, template_folder="test-templates")
 
-from test.app.components import routes  # noqa: E402,F401
+from app.components import routes  # noqa: E402,F401

test/app/components/routes.py

@@ -1,5 +1,5 @@
 import json
-from test.app.components import bp
+from app.components import bp
 
 from flask import render_template, request
 

test/app/templates/__init__.py

@@ -2,4 +2,4 @@
 
 bp = Blueprint("templates", __name__, template_folder="../templates")
 
-from test.app.templates import routes  # noqa: E402,F401
+from app.templates import routes  # noqa: E402,F401

test/app/templates/routes.py

@@ -1,5 +1,5 @@
 import json
-from test.app.templates import bp
+from app.templates import bp
 
 from flask import render_template, request
 

test/app/utilities/__init__.py

@@ -2,4 +2,4 @@
 
 bp = Blueprint("utilities", __name__, template_folder="test-templates")
 
-from test.app.utilities import routes  # noqa: E402,F401
+from app.utilities import routes  # noqa: E402,F401

test/app/utilities/routes.py

@@ -1,5 +1,5 @@
 import json
-from test.app.utilities import bp
+from app.utilities import bp
 
 from flask import render_template, request