add sonar cloud

.github/workflows/sonarcloud.yml

@@ -0,0 +1,40 @@
+name: sonarcloud
+
+on:
+  push:
+    branches:
+    - main
+  pull_request:
+    types: [opened, synchronize, reopened]
+    branches:
+    - main
+
+jobs:
+
+  sonarcloud:
+    name: SonarCloud
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+        with:
+          fetch-depth: 0  # Shallow clones should be disabled for a better relevancy of analysis
+      - name: Set up Python
+        uses: actions/setup-python@v3
+        with:
+          python-version: 3.10
+      - name: Python info
+        shell: bash -l {0}
+        run: |
+          which python3
+          python3 --version
+      - name: Install dependencies
+        run: python3 -m pip install hatch --upgrade
+      - name: Run unit tests with coverage
+        run: hatch run coverage
+      - name: Correct coverage paths
+        run: sed -i "s+$PWD/++g" coverage.xml
+      - name: SonarCloud Scan
+        uses: SonarSource/sonarcloud-github-action@master
+        env:
+          GITHUB_TOKEN: ${{secrets.GITHUB_TOKEN }}  # Needed to get PR information, if any
+          SONAR_TOKEN: ${{secrets.SONAR_TOKEN }}

sonar-project.properties

@@ -0,0 +1,13 @@
+sonar.organization=ecoextreml
+sonar.projectKey=EcoExtreML_zampy
+sonar.host.url=https://sonarcloud.io
+sonar.sources=zampy/
+sonar.tests=tests/
+sonar.links.homepage=https://github.com/EcoExtreML/zampy
+sonar.links.scm=https://github.com/EcoExtreML/zampy
+sonar.links.issue=https://github.com/EcoExtreML/zampy/issues
+sonar.links.ci=https://github.com/EcoExtreML/zampy/actions
+sonar.python.coverage.reportPaths=coverage.xml
+sonar.python.xunit.reportPath=xunit-result.xml
+sonar.python.pylint.reportPaths=pylint-report.txt
+sonar.python.version=3.8, 3.9, 3.10

tests/test_dataset_protocol.py

@@ -55,7 +55,7 @@ def test_read_properties():
             variable_names,
         ) = dataset_protocol.read_properties_file(dataset_folder)
 
-            # Verify the returned values
+        # Verify the returned values
         assert spatial_bounds.north == 54
         assert spatial_bounds.east == 6
         assert spatial_bounds.south == 51