Merge pull request #108 from NHSDigital/DTOSS-9251-audit-functionality-1

DTOSS-9251 preparatory refactoring

Author: MatMoore

.azuredevops/pipelines/deploy.yml

@@ -2,48 +2,48 @@ trigger: none
 pr: none
 
 parameters:
-- name: commitSHA
-  displayName: Commit SHA
-  type: string
-- name: environments
-  type: object
-  default:
-  - dev
+  - name: commitSHA
+    displayName: Commit SHA
+    type: string
+  - name: environments
+    type: object
+    default:
+      - dev
 
 stages:
-- ${{ each env in parameters.environments }}:
-  - stage: ${{ env }}
-    displayName: Deploy to ${{ env }} environment
-    pool:
-      name: private-pool-dev-uks
-    lockBehavior: sequential
-    isSkippable: false
+  - ${{ each env in parameters.environments }}:
+      - stage: ${{ env }}
+        displayName: Deploy to ${{ env }} environment
+        pool:
+          name: private-pool-dev-uks
+        lockBehavior: sequential
+        isSkippable: false
 
-    jobs:
-    - deployment: DeployApp
-      displayName: Deploy application
-      environment: ${{ env }}
-      strategy:
-        runOnce:
-          deploy:
-            steps:
-            - checkout: self
+        jobs:
+          - deployment: DeployApp
+            displayName: Deploy application
+            environment: ${{ env }}
+            strategy:
+              runOnce:
+                deploy:
+                  steps:
+                    - checkout: self
 
-            - task: TerraformInstaller@1
-              displayName: Install Terraform
-              inputs:
-                terraformVersion: 1.7.0
+                    - task: TerraformInstaller@1
+                      displayName: Install Terraform
+                      inputs:
+                        terraformVersion: 1.7.0
 
-            - task: AzureCLI@2
-              name: RunTerraform
-              inputs:
-                azureSubscription: manbrs-${{ env }}
-                scriptType: bash
-                scriptLocation: inlineScript
-                addSpnToEnvironment: true
-                inlineScript: |
-                  export ARM_TENANT_ID="$tenantId"
-                  export ARM_CLIENT_ID="$servicePrincipalId"
-                  export ARM_OIDC_TOKEN="$idToken"
-                  export ARM_USE_OIDC=true
-                  make ci ${{ env }} terraform-apply DOCKER_IMAGE_TAG=git-sha-${{ parameters.commitSHA }}
+                    - task: AzureCLI@2
+                      name: RunTerraform
+                      inputs:
+                        azureSubscription: manbrs-${{ env }}
+                        scriptType: bash
+                        scriptLocation: inlineScript
+                        addSpnToEnvironment: true
+                        inlineScript: |
+                          export ARM_TENANT_ID="$tenantId"
+                          export ARM_CLIENT_ID="$servicePrincipalId"
+                          export ARM_OIDC_TOKEN="$idToken"
+                          export ARM_USE_OIDC=true
+                          make ci ${{ env }} terraform-apply DOCKER_IMAGE_TAG=git-sha-${{ parameters.commitSHA }}

.github/pull_request_template.md

@@ -1,12 +1,11 @@
 <!-- Prefix the PR title with the Jira issue number in square brackets (eg - [DTOSS-XXXX]), if applicable -->
 
 ## Description
-<!-- Add screenshots if there are any UI updates. -->
 
+<!-- Add screenshots if there are any UI updates. -->
 
 ## Jira link
 
-
 ## Review notes
-<!-- Add notable context, discussion items, and anything else that would be helpful for a reviewer to know. -->
 
+<!-- Add notable context, discussion items, and anything else that would be helpful for a reviewer to know. -->

.github/workflows/stage-4-deploy.yaml

@@ -15,16 +15,16 @@ jobs:
     environment: azure
 
     steps:
-    - name: Checkout code
-      uses: actions/checkout@v4
+      - name: Checkout code
+        uses: actions/checkout@v4
 
-    - uses: azure/login@v2
-      with:
-        client-id: ${{ secrets.AZURE_CLIENT_ID }}
-        tenant-id: ${{ secrets.AZURE_TENANT_ID }}
-        subscription-id: ${{ secrets.AZURE_SUBSCRIPTION_ID }}
+      - uses: azure/login@v2
+        with:
+          client-id: ${{ secrets.AZURE_CLIENT_ID }}
+          tenant-id: ${{ secrets.AZURE_TENANT_ID }}
+          subscription-id: ${{ secrets.AZURE_SUBSCRIPTION_ID }}
 
-    - name: Call deployment pipeline
-      run: |
-        az pipelines run --commit-id ${{inputs.commit_sha}} --name "Deploy to Azure" --org https://dev.azure.com/nhse-dtos --project dtos-manage-breast-screening \
-          --parameters commitSHA=${{inputs.commit_sha}}
+      - name: Call deployment pipeline
+        run: |
+          az pipelines run --commit-id ${{inputs.commit_sha}} --name "Deploy to Azure" --org https://dev.azure.com/nhse-dtos --project dtos-manage-breast-screening \
+            --parameters commitSHA=${{inputs.commit_sha}}

.prettierignore

@@ -18,3 +18,6 @@ manage_breast_screening/assets/compiled
 manage_breast_screening/staticfiles
 manage_breast_screening/static
 
+# Files that aren't checked in
+.pytest_cache
+.terraform

Dockerfile

@@ -10,7 +10,7 @@ WORKDIR /app
 RUN apk add --no-cache bash
 
 # Compile static assets
-COPY .browserslistrc babel.config.js package.json package-lock.json rollup.config.js  ./
+COPY .browserslistrc babel.config.cjs package.json package-lock.json rollup.config.js  ./
 COPY manage_breast_screening ./manage_breast_screening
 RUN npm ci
 RUN npm run compile

README.md

@@ -131,6 +131,7 @@ For each environment, e.g. 'dev':
 1. The web app URL will be displayed as output. Copy it into a browser on the AVD to access the app.
 
 ## Continuous deployment
+
 When a PR is merged, Github actions securely triggers the deployment pipeline on the Azure devops pool running on the internal network. It currently deploys the dev environment automatically.
 
 Access [Azure devops](https://dev.azure.com/nhse-dtos/dtos-manage-breast-screening/_build?definitionId=86) to see the pipeline.

babel.config.js babel.config.cjsbabel.config.js renamed to babel.config.cjs

@@ -1,7 +1,7 @@
 /**
  * @type {TransformOptions}
  */
-export default {
+module.exports = {
   browserslistEnv: 'javascripts',
   presets: [
     [

manage_breast_screening/clinics/models.py

@@ -1,17 +1,9 @@
-import uuid
 from datetime import date
 from enum import StrEnum
 
 from django.db import models
 
-
-class BaseModel(models.Model):
-    class Meta:
-        abstract = True
-
-    id = models.UUIDField(default=uuid.uuid4, editable=False, primary_key=True)
-    created_at = models.DateTimeField(auto_now_add=True)
-    updated_at = models.DateTimeField(auto_now=True)
+from ..core.models import BaseModel
 
 
 class Provider(BaseModel):

manage_breast_screening/clinics/presenters.py

@@ -1,5 +1,5 @@
-from ..utils.date_formatting import format_date, format_time_range
-from ..utils.string_formatting import sentence_case
+from ..core.utils.date_formatting import format_date, format_time_range
+from ..core.utils.string_formatting import sentence_case
 from .models import Clinic
 
 

manage_breast_screening/config/settings.py

@@ -57,6 +57,7 @@ def boolean_env(key, default=None):
     "django.contrib.sessions",
     "django.contrib.messages",
     "django.contrib.staticfiles",
+    "manage_breast_screening.core",
     "manage_breast_screening.clinics",
     "manage_breast_screening.participants",
     "manage_breast_screening.mammograms",
@@ -73,7 +74,7 @@ def boolean_env(key, default=None):
     "django.middleware.clickjacking.XFrameOptionsMiddleware",
 ]
 
-ROOT_URLCONF = "manage_breast_screening.config.urls"
+ROOT_URLCONF = "manage_breast_screening.core.urls"
 
 TEMPLATES = [
     {