Merge pull request #14 from Azure-Samples/cruft/update

manual cruft update

Author: kjaymiller

.cruft.json

@@ -1,10 +1,11 @@
 {
   "template": "https://github.com/kjaymiller/cookiecutter-relecloud",
-  "commit": "6a54aabb6ec52cd3ad8588728e747a300f043b03",
+  "commit": "5361c11e1ead790f7eb0b7a15cd6e803c44c4d7e",
   "checkout": null,
   "context": {
     "cookiecutter": {
       "project_name": "azure",
+      "python_version": "3.12",
       "project_backend": "flask",
       "db_resource": "postgres-flexible",
       "project_host": "aca",

.devcontainer/Dockerfile_dev

@@ -1,7 +1,11 @@
-FROM mcr.microsoft.com/devcontainers/python:3.11-bullseye
+FROM mcr.microsoft.com/devcontainers/python:3.12-bullseye
 
 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 -m flask --app src/flaskapp db upgrade --directory src/flaskapp/migrations && python3 -m flask --app src/flaskapp seed --filename src/seed_data.json"
+    "postCreateCommand": "playwright install chromium --with-deps && pip install -e src && python3 -m flask --app src/flaskapp db upgrade --directory src/flaskapp/migrations && python3 -m flask --app src/flaskapp seed --filename src/seed_data.json"
 }
 

.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

@@ -5,20 +5,22 @@ on:
     push:
       branches:
         - main
-        - cruft/update
+        - cruft/update*
 
 # 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

@@ -28,10 +28,10 @@ jobs:
 
       - uses: actions/setup-python@v4
         with:
-          python-version: "3.10"
+          python-version: "3.12"
 
       - 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

@@ -18,13 +18,13 @@ jobs:
         - uses: actions/checkout@v3
         - uses: actions/setup-python@v4
           with:
-                python-version: 3.11
+                python-version: 3.12
                 cache: 'pip'
         - 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,14 +36,14 @@ 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 -m flask --app src.flaskapp db upgrade --directory src/flaskapp/migrations
             python3 -m flask --app src.flaskapp seed --filename src/seed_data.json
-            python3 -m pytest 
+            python3 -m pytest
           env:
             POSTGRES_HOST: localhost
             POSTGRES_USERNAME: postgres

.markdownlint.json

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