Feat/grafana dashboards with charm

.github/workflows/pull-request.yaml

@@ -0,0 +1,35 @@
+name: Pull Requests
+
+on:
+  workflow_dispatch: {}
+  pull_request:
+    branches:
+      - main
+
+jobs:
+  main:
+    runs-on: ubuntu-latest
+    steps:
+    - name: Checkout repository
+      uses: actions/checkout@v3
+
+    - name: Determine any rockcraft.yaml changed in the PR
+      id: changed-files
+      uses: tj-actions/changed-files@v35
+      with:
+        files: "./rockcraft.yaml"
+
+    - name: Setup LXD
+      if: steps.changed-files.outputs.any_changed
+      uses: canonical/[email protected]
+      with:
+        channel: latest/stable
+
+    - name: Install dependencies
+      if: steps.changed-files.outputs.any_changed
+      run: |
+        sudo snap install --classic rockcraft
+    - name: Build ROCK
+      if: steps.changed-files.outputs.any_changed
+      run: |
+        rockcraft pack --verbose

.github/workflows/rock-release-dev.yaml

@@ -0,0 +1,58 @@
+# The workflow canonical/observability/.github/workflows/rock-release-dev.yaml@main
+# https://github.com/canonical/observability/blob/34b7edb56094e8e3f01200ce49e01bf9dd6688ac/.github/workflows/rock-release-dev.yaml
+# does not allow setting a GHCR repo where to publish at the moment.
+# We thus copy it below and adapt it.
+
+name: Build ROCK and release dev tag to GHCR
+
+on:
+  workflow_dispatch:
+  push:
+    branches:
+      - main
+
+jobs:
+  main:
+    runs-on: ubuntu-latest
+    steps:
+
+    - name: Checkout repository
+      uses: actions/checkout@v3
+
+    - name: Find the *latest* rockcraft.yaml
+      id: find-latest
+      run: |
+        latest_rockcraft_file=$(find $GITHUB_WORKSPACE -name "rockcraft.yaml" | sort -V | tail -n1)
+        rockcraft_dir=$(dirname ${latest_rockcraft_file#\./})
+        echo "latest-dir=$rockcraft_dir" >> $GITHUB_OUTPUT
+    - name: Build ROCK
+      uses: canonical/craft-actions/rockcraft-pack@main
+      with:
+        path: "${{ steps.find-latest.outputs.latest-dir }}"
+        verbosity: verbose
+      id: rockcraft
+
+    - name: Upload locally built ROCK artifact
+      uses: actions/upload-artifact@v3
+      with:
+        name: cos-registration-agent-rock
+        path: ${{ steps.rockcraft.outputs.rock }}
+
+    - name: Upload ROCK to ghcr.io
+      run: |
+        sudo skopeo --insecure-policy copy oci-archive:$(realpath ${{ steps.rockcraft.outputs.rock }}) docker://ghcr.io/ubuntu-robotics/cos-registration-server:dev --dest-creds "${{ github.actor }}:${{ secrets.GITHUB_TOKEN }}"
+    - name: Generate digest
+      run: |
+        digest=$(skopeo inspect oci-archive:$(realpath ${{ steps.rockcraft.outputs.rock }}) --format '{{.Digest}}')
+        echo "digest=${digest#*:}" >> "$GITHUB_OUTPUT"
+    - name: Install Syft
+      run: |
+        curl -sSfL https://raw.githubusercontent.com/anchore/syft/main/install.sh | sh -s -- -b /usr/local/bin
+    - name: Create SBOM
+      run: syft $(realpath ${{ steps.rockcraft.outputs.rock }}) -o spdx-json=cos-registration-server.sbom.json
+
+    - name: Upload SBOM
+      uses: actions/upload-artifact@v3
+      with:
+        name: cos-registration-server-sbom
+        path: "cos-registration-server.sbom.json"

.github/workflows/rock-release-pr.yaml

@@ -0,0 +1,58 @@
+# The workflow canonical/observability/.github/workflows/rock-release-dev.yaml@main
+# https://github.com/canonical/observability/blob/34b7edb56094e8e3f01200ce49e01bf9dd6688ac/.github/workflows/rock-release-dev.yaml
+# does not allow setting a GHCR repo where to publish at the moment.
+# We thus copy it below and adapt it.
+
+name: Build ROCK and release pr tag to GHCR
+
+on:
+  workflow_dispatch:
+  pull_request:
+    branches:
+      - main
+
+jobs:
+  main:
+    runs-on: ubuntu-latest
+    steps:
+
+    - name: Checkout repository
+      uses: actions/checkout@v3
+
+    - name: Find the *latest* rockcraft.yaml
+      id: find-latest
+      run: |
+        latest_rockcraft_file=$(find $GITHUB_WORKSPACE -name "rockcraft.yaml" | sort -V | tail -n1)
+        rockcraft_dir=$(dirname ${latest_rockcraft_file#\./})
+        echo "latest-dir=$rockcraft_dir" >> $GITHUB_OUTPUT
+    - name: Build ROCK
+      uses: canonical/craft-actions/rockcraft-pack@main
+      with:
+        path: "${{ steps.find-latest.outputs.latest-dir }}"
+        verbosity: verbose
+      id: rockcraft
+
+    - name: Upload locally built ROCK artifact
+      uses: actions/upload-artifact@v3
+      with:
+        name: cos-registration-agent-rock
+        path: ${{ steps.rockcraft.outputs.rock }}
+
+    - name: Upload ROCK to ghcr.io
+      run: |
+        sudo skopeo --insecure-policy copy oci-archive:$(realpath ${{ steps.rockcraft.outputs.rock }}) docker://ghcr.io/ubuntu-robotics/cos-registration-server:pr --dest-creds "${{ github.actor }}:${{ secrets.GITHUB_TOKEN }}"
+    - name: Generate digest
+      run: |
+        digest=$(skopeo inspect oci-archive:$(realpath ${{ steps.rockcraft.outputs.rock }}) --format '{{.Digest}}')
+        echo "digest=${digest#*:}" >> "$GITHUB_OUTPUT"
+    - name: Install Syft
+      run: |
+        curl -sSfL https://raw.githubusercontent.com/anchore/syft/main/install.sh | sh -s -- -b /usr/local/bin
+    - name: Create SBOM
+      run: syft $(realpath ${{ steps.rockcraft.outputs.rock }}) -o spdx-json=cos-registration-server.sbom.json
+
+    - name: Upload SBOM
+      uses: actions/upload-artifact@v3
+      with:
+        name: cos-registration-server-sbom
+        path: "cos-registration-server.sbom.json"

.github/workflows/main.yml → .github/workflows/tests.yml

@@ -1,6 +1,6 @@
 # This is a basic workflow to help you get started with Actions
 
-name: CI
+name: tests
 
 # Controls when the workflow will run
 on:
@@ -18,7 +18,7 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        python-version: [3.9]
+        python-version: ["3.10"]
         os: [ubuntu-latest]
     runs-on: ${{ matrix.os }}
     steps:
@@ -28,6 +28,8 @@ jobs:
           python-version: ${{ matrix.python-version }}
       - name: Install project
         run: make install
+      - name: Generate django secret key
+        run: export SECRET_KEY_DJANGO=$(make secretkey)
       - name: Run linter
         run: make lint
 
@@ -36,7 +38,7 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        python-version: [3.9]
+        python-version: ["3.10"]
         os: [ubuntu-latest]
     runs-on: ${{ matrix.os }}
     steps:
@@ -50,43 +52,3 @@ jobs:
         run: make test
       - name: "Upload coverage to Codecov"
         uses: codecov/codecov-action@v3
-        # with:
-        #   fail_ci_if_error: true
-
-  tests_mac:
-    needs: linter
-    strategy:
-      fail-fast: false
-      matrix:
-        python-version: [3.9]
-        os: [macos-latest]
-    runs-on: ${{ matrix.os }}
-    steps:
-      - uses: actions/checkout@v4
-      - uses: actions/setup-python@v5
-        with:
-          python-version: ${{ matrix.python-version }}
-      - name: Install project
-        run: make install
-      - name: Run tests
-        run: make test
-
-  tests_win:
-    needs: linter
-    strategy:
-      fail-fast: false
-      matrix:
-        python-version: [3.9]
-        os: [windows-latest]
-    runs-on: ${{ matrix.os }}
-    steps:
-      - uses: actions/checkout@v4
-      - uses: actions/setup-python@v5
-        with:
-          python-version: ${{ matrix.python-version }}
-      - name: Install Pip
-        run: pip install --user --upgrade pip
-      - name: Install project
-        run: pip install -e .[test]
-      - name: run tests
-        run: pytest -s -vvvv -l --tb=long tests

.gitignore

@@ -130,3 +130,10 @@ dmypy.json
 
 # templates
 .github/templates/*
+
+# snap
+*.snap
+# rock
+*.rock
+# static files
+cos_registration_server/static/

CONTRIBUTING.md

@@ -21,6 +21,10 @@ then activate it with `source .venv/bin/activate`.
 
 Run `make install` to install the project in develop mode.
 
+## Start the developer server
+
+Run `make runserver` to start the django developer server.
+
 ## Run the tests to ensure everything is working
 
 Run `make test` to run the tests.

MANIFEST.in

@@ -1,5 +1,4 @@
 include LICENSE
 include HISTORY.md
-include Containerfile
-graft tests
 graft cos_registration_server
+recursive-include cos_registration_server/devices/templates *

Makefile

@@ -23,29 +23,32 @@ install:          ## Install the project in dev mode.
 	@echo "Don't forget to run 'make virtualenv' if you got errors."
 	$(ENV_PREFIX)pip install -e .[test]
 
+.PHONY: runserver
+runserver:          ## Django run server.
+	$(ENV_PREFIX)python3 cos_registration_server/manage.py runserver
+
+.PHONY: secretkey
+secretkey:          ## Generate the django secret key.
+	$(ENV_PREFIX)python3 -c 'from django.core.management.utils import get_random_secret_key; print(get_random_secret_key())'
+
+
 .PHONY: fmt
 fmt:              ## Format code using black & isort.
 	$(ENV_PREFIX)isort cos_registration_server/
 	$(ENV_PREFIX)black -l 79 cos_registration_server/
-	$(ENV_PREFIX)black -l 79 tests/
 
 .PHONY: lint
 lint:             ## Run pep8, black, mypy linters.
 	$(ENV_PREFIX)flake8 cos_registration_server/
 	$(ENV_PREFIX)black -l 79 --check cos_registration_server/
-	$(ENV_PREFIX)black -l 79 --check tests/
 	$(ENV_PREFIX)mypy --ignore-missing-imports cos_registration_server/
 
 .PHONY: test
 test: lint        ## Run tests and generate coverage report.
-	$(ENV_PREFIX)pytest -v --cov-config .coveragerc --cov=cos_registration_server -l --tb=short --maxfail=1 tests/
+	$(ENV_PREFIX)coverage run --source='.' cos_registration_server/manage.py test api devices
 	$(ENV_PREFIX)coverage xml
 	$(ENV_PREFIX)coverage html
 
-.PHONY: watch
-watch:            ## Run tests on every change.
-	ls **/**.py | entr $(ENV_PREFIX)pytest -s -vvv -l --tb=long --maxfail=1 tests/
-
 .PHONY: clean
 clean:            ## Clean unused files.
 	@find ./ -name '*.pyc' -exec rm -f {} \;
@@ -77,9 +80,9 @@ virtualenv:       ## Create a virtual environment.
 release:          ## Create a new tag for release.
 	@echo "WARNING: This operation will create s version tag and push to github"
 	@read -p "Version? (provide the next x.y.z semver) : " TAG
-	@echo "$${TAG}" > cos_registration_server/VERSION
+	@echo "$${TAG}" > cos_registration_server/cos_registration_server/VERSION
 	@$(ENV_PREFIX)gitchangelog > HISTORY.md
-	@git add cos_registration_server/VERSION HISTORY.md
+	@git add cos_registration_server/cos_registration_server/VERSION HISTORY.md
 	@git commit -m "release: version $${TAG} 🚀"
 	@echo "creating git tag : $${TAG}"
 	@git tag $${TAG}