Add sonar to project for quality checks

Author: ArBridgeman

.github/workflows/ci.yml

@@ -22,5 +22,6 @@ jobs:
   Metrics:
     needs: [ CI ]
     uses: ./.github/workflows/report.yml
+    secrets: inherit
     permissions:
       contents: read

.github/workflows/report.yml

@@ -29,7 +29,7 @@ jobs:
       - name: Copy Artifacts into Root Folder
         working-directory: ./artifacts
         run: |
-          poetry run -- coverage combine --keep coverage-python3.9*/.coverage
+          poetry run -- coverage combine --keep coverage-python*/.coverage
           # Errors during copying are ignored because they are checked in the next step
           cp .coverage ../ || true
           cp lint-python3.9/.lint.txt ../ || true
@@ -42,6 +42,18 @@ jobs:
       - name: Generate Report
         run: poetry run -- nox -s project:report -- --format json | tee metrics.json
 
+      - name: Prepare files for sonar
+        run: |
+          poetry run -- coverage xml -o ci-coverage.xml --include="exasol/toolbox/*"
+
+      - name: Upload to sonar
+        run: |
+          poetry run -- pysonar --sonar-token ${{ secrets.SONAR_TOKEN }} \
+          --sonar-branch-name ${{ github.ref_name }} \
+          --sonar-python-coverage-report-paths ci-coverage.xml \
+          --sonar-python-pylint-report-path .lint.json \
+          --sonar-python-mypy-report-paths .security.json
+
       - name: Upload Artifacts
         uses: actions/[email protected]
         with:

.gitignore

@@ -7,6 +7,7 @@ odbcconfig/odbcinst.ini
 .html-documentation
 
 .coverage
+.sonar
 
 _build/
 

doc/changes/unreleased.md

@@ -17,6 +17,7 @@ pyupgrade_args = ("--py310-plus",)
 ## ✨ Features
 
 * [#441](https://github.com/exasol/python-toolbox/issues/441): Switched nox task for `version:check` to use the config value of `version_file` to specify the location of the `version.py`
+* [#451](https://github.com/exasol/python-toolbox/issues/451): Added Sonar to project for quality checks
 
 ## ⚒️ Refactorings
 

poetry.lock

@@ -4,8 +4,8 @@ version = "1.2.0"
 requires-python = ">=3.9,<4.0"
 description = "Your one-stop solution for managing all standard tasks and core workflows of your Python project."
 authors = [
-    {name = "Nicola Coretti", email = "[email protected]"},
-    {name = "Ariel Schulz", email = "[email protected]"},
+    { name = "Nicola Coretti", email = "[email protected]" },
+    { name = "Ariel Schulz", email = "[email protected]" },
 ]
 readme = "README.md"
 license = "MIT"
@@ -50,7 +50,7 @@ myst-parser = ">=2.0.0,<4"
 nox = ">=2022.8.7"
 pluggy = "^1.5.0"
 pre-commit = ">=4"
-prysk = {extras = ["pytest-plugin"], version = ">0.17.0,<1"}
+prysk = { extras = ["pytest-plugin"], version = ">0.17.0,<1" }
 pylint = ">=2.15.4"
 pytest = ">=7.2.2,<9"
 pyupgrade = ">=2.38.2,<4.0.0"
@@ -59,15 +59,17 @@ sphinx = ">=5.3,<8"
 sphinx-copybutton = "^0.5.0"
 sphinx-inline-tabs = "^2023.4.21"
 sphinx-design = ">=0.5.0,<1"
-typer = {extras = ["all"], version = ">=0.7.0"}
-bandit = {extras = ["toml"], version = "^1.7.9"}
+typer = { extras = ["all"], version = ">=0.7.0" }
+bandit = { extras = ["toml"], version = "^1.7.9" }
 jinja2 = "^3.1.6"
 pip-licenses = "^5.0.0"
 pip-audit = "^2.7.3"
 pydantic = "^2.11.5"
+lxml = "^5.4.0"
 
 [tool.poetry.group.dev.dependencies]
 autoimport = "^1.4.0"
+pysonar = "^1.0.1.1548"
 
 [build-system]
 requires = ["poetry-core>=2.0.0"]
@@ -104,6 +106,7 @@ max-module-lines = 800
 
 [tool.mypy]
 plugins = ['pydantic.mypy']
+xml_report = 'mypy.xml'
 
 [[tool.mypy.overrides]]
 module = [

pyproject.toml

@@ -0,0 +1,10 @@
+sonar.projectKey=com.exasol:python-toolbox
+sonar.projectName=python-toolbox
+sonar.organization=exasol
+sonar.language=py
+sonar.host.url=https://sonarcloud.io 
+
+sonar.sources=exasol/toolbox
+sonar.tests=test
+sonar.python.version=3.9,3.10,3.11,3.12,3.13
+sonar.branch.target=main