WIP new charm

Author: Hyask

.github/workflows/build-and-test-charms.yaml

@@ -1,4 +1,4 @@
-name: Build and test charms
+name: Build and test charm
 
 on:
   push:
@@ -12,34 +12,11 @@ env:
   DEBIAN_FRONTEND: noninteractive
 
 jobs:
-  define-charm-list:
-    name: Define charm list to build
-    runs-on: ubuntu-24.04
-    outputs:
-      charms: ${{ steps.charms.outputs.charms }}
-    steps:
-      - name: Checkout
-        uses: actions/checkout@08eba0b27e820071cde6df949e0beb9ba4906955 # v4.3.0
-        with:
-          persist-credentials: false
-
-      - name: Generate list
-        id: charms
-        run: |
-          list="$(find . -mindepth 1 -maxdepth 1 -type d -printf '"%P", ')"
-          echo "charms=[$list]"
-          echo "charms=[$list]" >> $GITHUB_OUTPUT
-        working-directory: charms
-
   lint:
-    name: Lint - (${{ matrix.charm }})
+    name: Lint
     runs-on: ubuntu-24.04
-    needs:
-      - define-charm-list
     strategy:
       fail-fast: false
-      matrix:
-        charm: ${{ fromJSON(needs.define-charm-list.outputs.charms) }}
     steps:
       - name: Checkout
         uses: actions/checkout@08eba0b27e820071cde6df949e0beb9ba4906955 # v4.3.0
@@ -49,16 +26,11 @@ jobs:
         run: sudo snap install ruff --classic
       - name: Run linters
         run: ruff check --preview .
-        working-directory: charms/${{ matrix.charm }}
+        working-directory: charm
 
   lib-check:
-    name: Check libraries - (${{ matrix.charm }})
+    name: Check libraries
     runs-on: ubuntu-24.04
-    needs:
-      - define-charm-list
-    strategy:
-      matrix:
-        charm: ${{ fromJSON(needs.define-charm-list.outputs.charms) }}
     permissions:
       contents: write
       pull-requests: write
@@ -72,16 +44,11 @@ jobs:
         uses: canonical/charming-actions/check-libraries@1753e0803f70445132e92acd45c905aba6473225 # 2.7.0
         with:
           github-token: "${{ secrets.GITHUB_TOKEN }}"
-          charm-path: charms/${{ matrix.charm }}
+          charm-path: .
 
   pack-charm:
-    name: Build charm - (${{ matrix.charm }})
+    name: Build charm
     runs-on: ubuntu-24.04
-    needs:
-      - define-charm-list
-    strategy:
-      matrix:
-        charm: ${{ fromJSON(needs.define-charm-list.outputs.charms) }}
     steps:
       - name: Checkout
         uses: actions/checkout@08eba0b27e820071cde6df949e0beb9ba4906955 # v4.3.0
@@ -102,24 +69,22 @@ jobs:
 
       - name: Pack charm
         run: charmcraft pack -v
-        working-directory: charms/${{ matrix.charm }}
 
       - name: Test charm
-        run: uv run --all-extras pytest tests/ -vv --log-level=INFO
-        working-directory: charms/${{ matrix.charm }}
+        run: uv run --all-extras pytest -vv --log-level=INFO .
+        working-directory: charm/tests
 
       - name: Upload charm artifact
         uses: actions/upload-artifact@ea165f8d65b6e75b540449e92b4886f43607fa02 # v4.6.2
         with:
-          name: ${{ matrix.charm }}.charm
-          path: charms/${{ matrix.charm }}/*.charm
+          name: error-tracker.charm
+          path: "*.charm"
 
       - name: Upload charm to charmhub
         uses: canonical/charming-actions/upload-charm@1753e0803f70445132e92acd45c905aba6473225 # 2.7.0
         with:
           credentials: '${{ secrets.CHARMHUB_TOKEN }}'
           github-token: '${{ secrets.GITHUB_TOKEN }}'
-          charm-path: charms/${{ matrix.charm }}
           tag-prefix: ${{ matrix.charm }}
-          built-charm-path: error-tracker-${{ matrix.charm }}_ubuntu@24.04-amd64.charm
+          built-charm-path: error-tracker_ubuntu@24.04-amd64.charm
         if: github.ref == 'refs/heads/main'

.github/workflows/ci.yaml

@@ -43,7 +43,7 @@ jobs:
         run: sudo snap install charmcraft --classic
       - name: Run Error Tracker tests
         run: |
-          charmcraft.spread -v
+          charmcraft.spread -v tests/errortracker/
       # spread artifacts need to work to re-enable this
       # - name: Upload coverage
       #   uses: actions/upload-artifact@v4

.gitignore

@@ -1,5 +1,9 @@
+# Charm
+*.charm
+
 # Spread
 .spread*
+
 # Byte-compiled / optimized / DLL files
 __pycache__/
 *.py[cod]

charm/charm.py

@@ -0,0 +1,72 @@
+#!/usr/bin/env python3
+# Copyright 2025 Skia
+# See LICENSE file for licensing details.
+
+"""Charm the Error Tracker."""
+
+import logging
+
+import ops
+
+from errortracker import ErrorTracker
+
+logger = logging.getLogger(__name__)
+
+
+class ErrorTrackerCharm(ops.CharmBase):
+    """Charm the application."""
+
+    def __init__(self, *args):
+        super().__init__(*args)
+        self._error_tracker = ErrorTracker()
+
+        self.framework.observe(self.on.start, self._on_start)
+        self.framework.observe(self.on.install, self._on_install)
+        self.framework.observe(self.on.config_changed, self._on_config_changed)
+
+    def _on_start(self, event: ops.StartEvent):
+        """Handle start event."""
+        self.unit.status = ops.ActiveStatus()
+
+    def _on_install(self, event: ops.InstallEvent):
+        """Handle install event."""
+        self.unit.status = ops.MaintenanceStatus("Installing the error tracker")
+        try:
+            self._error_tracker.install()
+        except Exception as e:
+            logger.error("Failed to install the Error Tracker: %s", str(e))
+            self.unit.status = ops.BlockedStatus("Failed installing the Error Tracker")
+            return
+
+        self.unit.status = ops.ActiveStatus("Ready")
+
+    def _on_config_changed(self, event: ops.ConfigChangedEvent):
+        enable_daisy = self.config.get("enable_daisy")
+        enable_retracer = self.config.get("enable_retracer")
+        enable_timers = self.config.get("enable_timers")
+        enable_web = self.config.get("enable_web")
+
+        config = self.config.get("configuration")
+
+        self._error_tracker.configure(config)
+
+        # TODO: the charms know how to enable components, but not disable them.
+        # This is a bit annoying, but also doesn't have a very big impact in
+        # practice. This charm has no configuration where it's supposed to store
+        # data, so it's always very easy to remove a unit and recreate.
+        if enable_daisy:
+            self._error_tracker.configure_daisy()
+            self.unit.set_ports(self._error_tracker.daisy_port)
+        if enable_retracer:
+            self._error_tracker.configure_retracer(self.config.get("retracer_failed_queue"))
+        if enable_timers:
+            self._error_tracker.configure_timers()
+        if enable_web:
+            self._error_tracker.configure_web()
+
+        self.unit.set_workload_version(self._error_tracker.get_version())
+        self.unit.status = ops.ActiveStatus("Ready")
+
+
+if __name__ == "__main__":  # pragma: nocover
+    ops.main(ErrorTrackerCharm)  # type: ignore