Cruft update

.cruft.json

@@ -1,6 +1,6 @@
 {
   "template": "https://github.com/kjaymiller/cookiecutter-relecloud/",
-  "commit": "a3794bddf382c4c6fa4add5bf935ca14bca40a71",
+  "commit": "04ac8410200b9d270bf7f07d1ae0d96837f5b5d9",
   "checkout": null,
   "context": {
     "cookiecutter": {

.devcontainer/Dockerfile_dev

@@ -4,4 +4,8 @@ RUN apt-get update && export DEBIAN_FRONTEND=noninteractive \
     && apt-get -y install --no-install-recommends postgresql-client \
     && apt-get clean -y && rm -rf /var/lib/apt/lists/*
 
+
+COPY requirements-dev.txt requirements-dev.txt
+COPY src/requirements.txt src/requirements.txt
 RUN python -m pip install --upgrade pip
+RUN python -m pip install -r requirements-dev.txt

.devcontainer/devcontainer.json

@@ -22,40 +22,34 @@
                 "ms-azuretools.vscode-bicep",
                 "charliermarsh.ruff",
                 "ms-python.python",
-                "ms-python.black-formatter",
                 "ms-azuretools.vscode-docker",
-                "mtxr.sqltools",
-                "mtxr.sqltools-driver-pg",
                 "bierner.github-markdown-preview"
             ],
             "settings": {
-                "sqltools.connections": [
-                    {
-                        "name": "Local database",
-                        "driver": "PostgreSQL",
-                        "server": "db",
-                        "port": 5432,
-                        "database": "relecloud",
-                        "username": "postgres",
-                        "password": "postgres"
-                    }
-                ],
                 "python.defaultInterpreterPath": "/usr/local/bin/python",
                 "python.testing.pytestEnabled": true,
                 "python.testing.unittestEnabled": false,
                 "files.exclude": {
                     ".coverage": true,
                     ".pytest_cache": true,
                     "__pycache__": true
+                },
+                "[python]": {
+                    "editor.formatOnSave": true,
+                    "editor.defaultFormatter": "charliermarsh.ruff",
+                    "editor.codeActionsOnSave": {
+                        "source.organizeImports": true,
+                        "source.fixAll": true
+                    }
                 }
             }
         }
     },
     "features": {
-        "ghcr.io/azure/azure-dev/azd:latest": {},
         // Required for azd to package the app to ACA
-        "ghcr.io/devcontainers/features/docker-in-docker:2": {}
+        "ghcr.io/devcontainers/features/docker-in-docker:2": {},
+        "ghcr.io/azure/azure-dev/azd:latest": {}
     },
-    "postCreateCommand": "pip install -r requirements-dev.in && pip install -e src && python3 src/fastapi_app/seed_data.py"
+    "postCreateCommand": "playwright install chromium --with-deps && pip install -e src &&  python3 src/fastapi_app/seed_data.py"
 }
 

.devcontainer/docker-compose_dev.yml

@@ -21,8 +21,8 @@ services:
 
   app:
     build:
-      context: .
-      dockerfile: Dockerfile_dev
+      context: ..
+      dockerfile: ./.devcontainer/Dockerfile_dev
     depends_on:
       db:
         condition: service_healthy

.github/workflows/azure-dev.yml

@@ -9,16 +9,18 @@ on:
 
 # GitHub Actions workflow to deploy to Azure using azd
 # To configure required secrets for connecting to Azure, simply run `azd pipeline config`
-  
+
 # Set up permissions for deploying with secretless Azure federated credentials
 # https://learn.microsoft.com/en-us/azure/developer/github/connect-from-azure?tabs=azure-portal%2Clinux#set-up-azure-login-with-openid-connect-authentication
 permissions:
     id-token: write
     contents: read
-  
+
 jobs:
     build:
       runs-on: ubuntu-latest
+      outputs:
+        uri: ${{ steps.output.outputs.uri }}
       env:
         AZURE_CLIENT_ID: ${{ vars.AZURE_CLIENT_ID }}
         AZURE_TENANT_ID: ${{ vars.AZURE_TENANT_ID }}
@@ -27,10 +29,10 @@ jobs:
       steps:
         - name: Checkout
           uses: actions/checkout@v3
-  
+
         - name: Install azd
           uses: Azure/[email protected]
-  
+
         - name: Log in with Azure (Federated Credentials)
           if: ${{ env.AZURE_CLIENT_ID != '' }}
           run: |
@@ -39,31 +41,67 @@ jobs:
               --federated-credential-provider "github" `
               --tenant-id "$Env:AZURE_TENANT_ID"
           shell: pwsh
-  
+
         - name: Log in with Azure (Client Credentials)
           if: ${{ env.AZURE_CREDENTIALS != '' }}
           run: |
             $info = $Env:AZURE_CREDENTIALS | ConvertFrom-Json -AsHashtable;
             Write-Host "::add-mask::$($info.clientSecret)"
-  
+
             azd auth login `
               --client-id "$($info.clientId)" `
               --client-secret "$($info.clientSecret)" `
               --tenant-id "$($info.tenantId)"
           shell: pwsh
           env:
             AZURE_CREDENTIALS: ${{ secrets.AZURE_CREDENTIALS }}
-  
+
         - name: Provision Infrastructure
           run: azd provision --no-prompt
           env:
             AZURE_ENV_NAME: ${{ vars.AZURE_ENV_NAME }}
             AZURE_LOCATION: ${{ vars.AZURE_LOCATION }}
             AZURE_SUBSCRIPTION_ID: ${{ vars.AZURE_SUBSCRIPTION_ID }}
-  
+
         - name: Deploy Application
           run: azd deploy --no-prompt
           env:
             AZURE_ENV_NAME: ${{ vars.AZURE_ENV_NAME }}
             AZURE_LOCATION: ${{ vars.AZURE_LOCATION }}
             AZURE_SUBSCRIPTION_ID: ${{ vars.AZURE_SUBSCRIPTION_ID }}
+
+        - name: Output Deployment URI
+          id: output
+          run: |
+            azd env get-values > .env
+            source .env
+            echo "uri=$BACKEND_URI" >> "$GITHUB_OUTPUT"
+
+    smoketests:
+      runs-on: ubuntu-latest
+      needs: build
+      steps:
+
+        - name: Basic smoke test (curl)
+          env:
+            URI: ${{needs.build.outputs.uri}}
+          run: |
+            echo "Sleeping 1 minute due to https://github.com/Azure/azure-dev/issues/2669"
+            sleep 60
+            curl -sSf $URI
+        - name: Checkout
+          uses: actions/checkout@v3
+
+        - name: Setup python
+          uses: actions/setup-python@v4
+          with:
+            python-version: 3.12
+
+        - name: End-to-end smoke tests (playwright)
+          env:
+            URI: ${{needs.build.outputs.uri}}
+          run: |
+            python3 -m pip install --upgrade pip
+            python3 -m pip install -r requirements-dev.txt
+            python3 -m playwright install --with-deps
+            python3 -m pytest --exitfirst src/tests/smoke/smoketests.py --live-server-url $URI

.github/workflows/cruft.yml

@@ -31,7 +31,7 @@ jobs:
           python-version: "3.10"
 
       - name: Install Cruft
-        run: pip3 install -r requirements-dev.in
+        run: pip3 install -r requirements-dev.txt
 
       - name: Check if update is available
         continue-on-error: false

.github/workflows/format.yml

@@ -23,8 +23,8 @@ jobs:
         - name: Install dependencies
           run: |
             python -m pip install --upgrade pip
-            pip install -r requirements-dev.in
+            pip install -r requirements-dev.txt
         - name: Lint with ruff
-          run: ruff .
-        - name: Check formatting with black
-          run: black . --check --verbose
+          run: |
+            ruff check .
+            ruff format .

.github/workflows/tests.yml

@@ -15,7 +15,7 @@ jobs:
       fail-fast: false
       matrix:
         os: ["ubuntu-20.04"]
-        python_version: ["3.8", "3.9", "3.10", "3.11"]
+        python_version: ["3.8", "3.9", "3.10", "3.11", "3.12"]
     services:
       db:
         image: postgres:14
@@ -36,13 +36,13 @@ jobs:
         - name: Install dependencies
           run: |
             python3 -m pip install --upgrade pip
-            python3 -m pip install -r requirements-dev.in
+            python3 -m pip install -r requirements-dev.txt
             playwright install --with-deps
             python3 -m pip install -e src
         - name: Seed data and run Pytest tests
           run: |
             python3 src/fastapi_app/seed_data.py
-            python3 -m pytest 
+            python3 -m pytest
           env:
             POSTGRES_HOST: localhost
             POSTGRES_USERNAME: postgres

.markdownlint.json

@@ -0,0 +1,3 @@
+{
+  "MD013": false
+}

README.md

@@ -54,8 +54,8 @@ python3 -m uvicorn fastapi_app:app --reload --port=8000
 2. Install the development requirements:
 
     ```sh
-    python3 -m pip install -r requirements-dev.in
-    playwright install --with-deps
+    python3 -m pip install -r requirements-dev.txt
+    python3 -m playwright install --with-deps
     ```
 
 3. Run the tests:

infra/core/host/appservice.bicep

@@ -1,3 +1,4 @@
+metadata description = 'Creates an Azure App Service in an existing Azure App Service plan.'
 param name string
 param location string = resourceGroup().location
 param tags object = {}
@@ -23,6 +24,7 @@ param kind string = 'app,linux'
 param allowedOrigins array = []
 param alwaysOn bool = true
 param appCommandLine string = ''
+@secure()
 param appSettings object = {}
 param clientAffinityEnabled bool = false
 param enableOryxBuild bool = contains(kind, 'linux')
@@ -63,6 +65,18 @@ resource appService 'Microsoft.Web/sites@2022-03-01' = {
 
   identity: { type: managedIdentity ? 'SystemAssigned' : 'None' }
 
+  resource configAppSettings 'config' = {
+    name: 'appsettings'
+    properties: union(appSettings,
+      {
+        SCM_DO_BUILD_DURING_DEPLOYMENT: string(scmDoBuildDuringDeployment)
+        ENABLE_ORYX_BUILD: string(enableOryxBuild)
+      },
+      runtimeName == 'python' ? { PYTHON_ENABLE_GUNICORN_MULTIWORKERS: 'true'} : {},
+      !empty(applicationInsightsName) ? { APPLICATIONINSIGHTS_CONNECTION_STRING: applicationInsights.properties.ConnectionString } : {},
+      !empty(keyVaultName) ? { AZURE_KEY_VAULT_ENDPOINT: keyVault.properties.vaultUri } : {})
+  }
+
   resource configLogs 'config' = {
     name: 'logs'
     properties: {
@@ -71,39 +85,26 @@ resource appService 'Microsoft.Web/sites@2022-03-01' = {
       failedRequestsTracing: { enabled: true }
       httpLogs: { fileSystem: { enabled: true, retentionInDays: 1, retentionInMb: 35 } }
     }
+    dependsOn: [
+      configAppSettings
+    ]
   }
 
   resource basicPublishingCredentialsPoliciesFtp 'basicPublishingCredentialsPolicies' = {
     name: 'ftp'
-    location: location
     properties: {
       allow: false
     }
   }
 
   resource basicPublishingCredentialsPoliciesScm 'basicPublishingCredentialsPolicies' = {
     name: 'scm'
-    location: location
     properties: {
       allow: false
     }
   }
 }
 
-module config 'appservice-appsettings.bicep' = if (!empty(appSettings)) {
-  name: '${name}-appSettings'
-  params: {
-    name: appService.name
-    appSettings: union(appSettings,
-      {
-        SCM_DO_BUILD_DURING_DEPLOYMENT: string(scmDoBuildDuringDeployment)
-        ENABLE_ORYX_BUILD: string(enableOryxBuild)
-      },
-      !empty(applicationInsightsName) ? { APPLICATIONINSIGHTS_CONNECTION_STRING: applicationInsights.properties.ConnectionString } : {},
-      !empty(keyVaultName) ? { AZURE_KEY_VAULT_ENDPOINT: keyVault.properties.vaultUri } : {})
-  }
-}
-
 resource keyVault 'Microsoft.KeyVault/vaults@2022-07-01' existing = if (!(empty(keyVaultName))) {
   name: keyVaultName
 }

infra/main.bicep

@@ -128,4 +128,6 @@ output SERVICE_WEB_URI string = web.outputs.SERVICE_WEB_URI
 output SERVICE_WEB_IMAGE_NAME string = web.outputs.SERVICE_WEB_IMAGE_NAME
 output AZURE_KEY_VAULT_ENDPOINT string = keyVault.outputs.endpoint
 output AZURE_KEY_VAULT_NAME string = keyVault.outputs.name
-output APPLICATIONINSIGHTS_NAME string = monitoring.outputs.applicationInsightsName
+output APPLICATIONINSIGHTS_NAME string = monitoring.outputs.applicationInsightsName
+
+output BACKEND_URI string = web.outputs.uri

infra/web.bicep

@@ -61,6 +61,10 @@ module app 'core/host/container-app-upsert.bicep' = {
         name: 'POSTGRES_PASSWORD'
         secretRef: 'dbserver-password'
       }
+      {
+        name: 'POSTGRES_SSL'
+        value: 'require'
+      }
       {
         name: 'RUNNING_IN_PRODUCTION'
         value: 'true'
@@ -88,3 +92,5 @@ output SERVICE_WEB_IDENTITY_PRINCIPAL_ID string = webIdentity.properties.princip
 output SERVICE_WEB_NAME string = app.outputs.name
 output SERVICE_WEB_URI string = app.outputs.uri
 output SERVICE_WEB_IMAGE_NAME string = app.outputs.imageName
+
+output uri string = app.outputs.uri

pyproject.toml

@@ -2,15 +2,10 @@
 line-length = 120
 select = ["E", "F", "I", "UP"]
 ignore = ["D203"]
+extend-exclude = ["src/flaskapp/migrations/"]
 
 [tool.ruff.isort]
 known-first-party = ["fastapi_app"]
 
-[tool.black]
-line-length = 120
-
 [tool.pytest.ini_options]
-addopts = "-ra --cov -vv"
-
-[tool.coverage.report]
-show_missing = true
+addopts = "-ra -vv"

requirements-dev.in → requirements-dev.txt

@@ -5,11 +5,9 @@ cruft
 pip-tools
 
 # Testing Tools
-coverage
 pytest
-pytest-cov
+ephemeral-port-reserve
 pytest-playwright
 
 # Linters
 ruff
-black