Add alert_historian to SonarQube

Author: antonrasmussen

.github/workflows/sonar.yml

@@ -7,6 +7,7 @@ on:
       - "server/**"
       - "frontend/**"
       - "screenshot/**"
+      - "alert_historian/**"
   workflow_dispatch: # add ability to run workflow.
   pull_request:
     types: [opened, synchronize, reopened]
@@ -121,3 +122,33 @@ jobs:
         run: |
           cd screenshot/
           ./gradlew build sonar
+
+  sonarQubeAlertHistorian:
+    name: SonarQube Alert Historian
+    runs-on: ubuntu-latest
+    needs: sonarCheck
+    if: ${{ needs.sonarCheck.outputs.enabled == 'true' }}
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+      - name: Set up Python 3.11
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.11"
+      - name: Install dependencies
+        run: |
+          cd alert_historian
+          python -m pip install --upgrade pip
+          pip install -e ".[dev]"
+      - name: Run coverage
+        run: |
+          cd alert_historian
+          pytest --cov=src/alert_historian --cov-report=xml:coverage.xml
+      - name: Scan alert_historian
+        uses: SonarSource/sonarqube-scan-action@v6.0.0
+        env:
+          SONAR_TOKEN: ${{ secrets.SONAR_TOKEN }}
+          SONAR_HOST_URL: ${{ secrets.SONAR_HOST }}
+        with:
+          projectBaseDir: alert_historian/

alert_historian/README.md

@@ -30,6 +30,14 @@ python -m alert_historian report
 python -m alert_historian run-once
 ```
 
+## SonarQube local prep
+
+Generate the coverage report used by SonarQube:
+
+```bash
+pytest --cov=src/alert_historian --cov-report=xml:coverage.xml
+```
+
 ## Configuration
 
 Copy `.env.example` to `.env` and set:

alert_historian/pyproject.toml

@@ -17,6 +17,7 @@ dependencies = [
 [project.optional-dependencies]
 dev = [
   "pytest>=8.2.0",
+  "pytest-cov>=5.0.0",
 ]
 
 [tool.setuptools]

alert_historian/sonar-project.properties

@@ -0,0 +1,8 @@
+sonar.projectKey=antonrasmussen_findfirst_alert_historian
+sonar.organization=antonrasmussen
+sonar.projectName=alert_historian
+sonar.sources=src
+sonar.tests=tests
+sonar.python.version=3.11
+sonar.python.coverage.reportPaths=coverage.xml
+sonar.exclusions=.venv/**,.pytest_cache/**,artifacts/**,reports/**,state/**