GitHub workflow for validating terraform deploy + upgrading charms

.github/workflows/frontend_charm_analysis.yml

@@ -2,7 +2,9 @@ name: Run charm tests
 on:
   pull_request:
     branches:
-      - main
+      - '**'
+    paths:
+      - 'frontend/charm/**'
   push:
     branches: ["main"]
     tags: ["v*.*.*"]
@@ -35,7 +37,7 @@ jobs:
         working-directory: ./frontend/charm
 
   unit-tests-with-coverage:
-    name: Unit tests
+    name: Frontend charm unit tests
     runs-on: [self-hosted, linux]
     steps:
       - uses: actions/checkout@v3

.github/workflows/publish_api.yml

@@ -2,6 +2,7 @@ on:
   push:
     branches: ["main"]
     tags: ["v*.*.*"]
+  workflow_dispatch:
 
 env:
   REGISTRY: ghcr.io

.github/workflows/publish_frontend.yml

@@ -2,6 +2,7 @@ on:
   push:
     branches: ["main"]
     tags: ["v*.*.*"]
+  workflow_dispatch:
 
 env:
   REGISTRY: ghcr.io

.github/workflows/terraform_test_deploy.yml

@@ -0,0 +1,107 @@
+name: Terraform deploy to a fresh microk8s model
+on:
+  pull_request:
+    branches:
+      - '**'
+    paths:
+      - 'frontend/charm/**'
+      - 'backend/charm/**'
+      - 'terraform/**'
+  pull_request_review:
+    on:
+      pull_request_review:
+        types:
+          - submitted
+      paths:
+        - 'frontend/charm/**'
+        - 'backend/charm/**'
+        - 'terraform/**'
+  push:
+    branches: ["main"]
+    tags: ["v*.*.*"]
+  workflow_dispatch:
+
+jobs:
+  deploy:
+    name: terraform deploy + upgrade charms
+    # if: github.event.review.state == 'APPROVED'
+    runs-on: [self-hosted, jammy, xlarge]
+
+    defaults:
+      run:
+        working-directory: ./terraform
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v2
+
+      - name: Set up Terraform dependencies
+        run: |
+          sudo apt-get update
+          sudo apt-get install unzip
+
+      - name: Set up terraform
+        uses: hashicorp/setup-terraform@v1
+
+      - name: Terraform init
+        run: terraform init
+
+      - name: Set up microk8s
+        uses: canonical/certification-github-workflows/.github/actions/microk8s-setup@main
+
+      # TODO: Separate this build step to its own action once custom VM images are available
+      # (when there is a charmcraft + LXD capable image available)
+      - name: Build API charm
+        run: charmcraft pack
+        working-directory: ./backend/charm
+
+      # TODO: Separate this build step to its own action once custom VM images are available
+      # (when there is a charmcraft + LXD capable image available)
+      - name: Build frontend charm
+        run: charmcraft pack
+        working-directory: ./frontend/charm
+
+      - name: Terraform apply
+        run: |
+          TF_VAR_environment=development \
+          TF_VAR_nginx_ingress_integrator_charm_whitelist_source_range="" \
+          terraform apply -auto-approve
+
+      - name: Switch model to test-observer-development
+        run: |
+          juju switch test-observer-development
+          sleep 10 # hack hack, the below wait-for condition is not actually correct, so let's wait a bit
+
+      - name: Replace the API charm with the locally built one
+        run: |
+          juju wait-for application api --timeout=10m --query='life=="alive"'
+          juju refresh api --path ../backend/charm/*.charm
+
+      - name: Replace the frontend charm with the locally built one
+        run: |
+          juju wait-for application frontend --timeout=10m --query='life=="alive"'
+          juju refresh frontend --path ../frontend/charm/*.charm
+
+      - name: Wait for deployment to complete
+        run: |
+          juju wait-for model test-observer-development \
+          --timeout=10m \
+          --query='life=="alive" && status=="available" && forEach(applications, app => app.status == "active")'
+
+      - name: Echo juju status on failure
+        if: failure()
+        run: |
+          juju status --color
+
+      - name: Run juju crashdump on failure
+        if: failure()
+        run: |
+          sudo juju crashdump -o ./ -m test-observer-development --as-root -a juju-show-unit -a juju-show-status-log -a juju-show-machine -a config
+          sudo chown $USER ./**/juju-crashdump-*.tar.xz
+
+      - name: Archive juju crashdump on failure
+        if: failure()
+        uses: actions/upload-artifact@v3
+        with:
+          name: juju-crashdump
+          path: ./**/juju-crashdump-*.tar.xz

.github/workflows/test_backend.yml

@@ -1,9 +1,14 @@
 name: Test Backend
-on: [push]
-# Cancel inprogress runs if new commit pushed
+on:
+  push:
+    paths:
+      - 'backend/**'
+    tags:
+      - "v*.*.*"
 concurrency:
   group: ${{ github.workflow }}-${{ github.ref }}
   cancel-in-progress: true
+
 jobs:
   test:
     runs-on: [self-hosted, linux, large]

.github/workflows/test_frontend.yml

@@ -1,9 +1,14 @@
 name: Test Frontend
-on: [push]
-# Cancel inprogress runs if new commit pushed
+on:
+  push:
+    paths:
+      - 'frontend/**'
+    tags:
+      - "v*.*.*"
 concurrency:
   group: ${{ github.workflow }}-${{ github.ref }}
   cancel-in-progress: true
+
 jobs:
   test:
     runs-on: [self-hosted, linux, large]

.gitignore

@@ -1,2 +0,0 @@
-# Visual Studio Code configurations
-.vscode

.vscode/settings.json

@@ -0,0 +1,6 @@
+{
+    "python.analysis.extraPaths": [
+        "./backend/charm/lib"
+    ],
+    "cmake.sourceDirectory": "/home/mz2/Developer/test_observer/frontend/linux"
+}

README.md

@@ -158,17 +158,9 @@ Charms are released through GitHub actions on push to main. If however you need
 
 ## VS Code & charm libraries
 
-VS Code fails to find (for autocompletions and code navigation purposes) the charm libraries under `lib` in each of `backend/charm` and `frontend/charm`. There is a .vscode-settings-default.json found under each of these directories which you can copy to the `.gitignore`d path `.vscode/settings.json` to make them fly. Taking the backend charm as an example:
+VS Code fails to find (for autocompletions and code navigation purposes) the charm libraries under `lib` in each of `backend/charm` and `frontend/charm`. There is therafore a .vscode/settings..json found under each of the directories that will plausibly used as a VS Code workspace.
 
-```bash
-mkdir -p backend/charm/.vscode
-cp backend/charm/.vscode-settings-default.json backend/charm/.vscode/settings.json
-
-mkdir -p frontend/charm/.vscode
-cp frontend/charm/.vscode-settings-default.json frontend/charm/.vscode/settings.json
-```
-
-Now if you use as your project the directory `backend/charm` and `frontend/charm` respectively (which you'll want to do also for them to keep their own virtual environments), VS Code should be happy.
+If you use as your project the directory `backend/charm` and `frontend/charm` respectively (which you'll want to do also for them to keep their own virtual environments), VS Code should be happy.
 
 ## Handy documentation pointers about charming
 

backend/charm/.gitignore

@@ -1,2 +1,5 @@
 *.charm
 venv
+prime
+stage
+parts

frontend/charm/.vscode-settings-default.json → backend/charm/.vscode-settings.json

@@ -1,11 +1,13 @@
 {
-  "python.autoComplete.extraPaths": ["./lib"],
+  "python.autoComplete.extraPaths": [
+    "./lib"
+  ],
   "python.analysis.extraPaths": [
     "./lib"
   ],
   "yaml.schemas": {
     "https://json.schemastore.org/yamllint.json": [
-      "./metadata.yaml",
+      "./metadata.yaml"
     ]
   },
   "ansible.python.interpreterPath": "./venv/bin/python3"

backend/charm/.vscode/settings.json

@@ -0,0 +1,6 @@
+{
+    "python.analysis.extraPaths": [
+        "./lib/charms",
+        "./lib"
+    ]
+}

backend/charm/charmcraft.yaml

@@ -1,8 +1,34 @@
+name: test-observer-api
 type: charm
+summary: |
+  API to observe the status of artifact (snaps, debs, etc) testing
+description: |
+  API and dashboard to observe the status of artifact (snaps, debs, etc) test status
 bases:
   - build-on:
       - name: ubuntu
         channel: "22.04"
     run-on:
       - name: ubuntu
         channel: "22.04"
+assumes:
+  - juju >= 2.9
+  - k8s-api
+containers:
+  api:
+    resource: api-image
+requires:
+  database:
+    interface: postgresql_client
+    limit: 1
+  nginx-route:
+    interface: nginx-route
+provides:
+  test-observer-rest-api:
+    interface: http
+    scope: global
+resources:
+  api-image:
+    type: oci-image
+    description: OCI image from GitHub Container Repository
+    upstream-source: ghcr.io/canonical/test_observer/api:main