From 836eeb9cd763c3f0fb639b83170423f897e7f8c4 Mon Sep 17 00:00:00 2001
From: Sabrina Yan <9669990+violetbrina@users.noreply.github.com>
Date: Wed, 18 Sep 2024 09:42:17 +1000
Subject: [PATCH] Add sonarqube scan to test workflow (#161)

* Add sonarqube scan to test workflow

* Add sonarqube scan to test workflow

* Hide sonar scanner folder
---
 .github/workflows/test.yaml | 34 ++++++++++++++++++++++++++++++++++
 .gitignore                  |  1 +
 sonar-project.properties    |  4 ++++
 3 files changed, 39 insertions(+)
 create mode 100644 .github/workflows/test.yaml
 create mode 100644 sonar-project.properties

diff --git a/.github/workflows/test.yaml b/.github/workflows/test.yaml
new file mode 100644
index 0000000..a59b844
--- /dev/null
+++ b/.github/workflows/test.yaml
@@ -0,0 +1,34 @@
+name: Test
+on: [push]
+
+jobs:
+  sonarqube:
+    name: SonarQube scan
+    runs-on: ubuntu-latest
+    needs: test
+    environment: production
+    if: github.ref == 'refs/heads/main' || github.ref == 'refs/heads/dev'
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0 # Shallow clones should be disabled for a better relevancy of analysis
+
+      # # Download the coverage report artifact - there are no test report to download
+      # - name: 'Download coverage and execution report'
+      #   uses: actions/download-artifact@v4
+      #   with:
+      #     pattern: '*-report'
+
+      # Perform the SonarQube scan
+      - uses: sonarsource/sonarqube-scan-action@master
+        env:
+          SONAR_TOKEN: ${{ secrets.SONAR_TOKEN }}
+          SONAR_HOST_URL: ${{ secrets.SONAR_HOST_URL }}
+
+      # Optional: Fail the job if Quality Gate is red
+      # If you wish to fail your job when the Quality Gate is red, uncomment the
+      # following lines. This would typically be used to fail a deployment.
+      # - uses: sonarsource/sonarqube-quality-gate-action@master
+      #   timeout-minutes: 5
+      #   env:
+      #     SONAR_TOKEN: ${{ secrets.SONAR_TOKEN }}
diff --git a/.gitignore b/.gitignore
index 4befed3..a5b8f14 100644
--- a/.gitignore
+++ b/.gitignore
@@ -1,2 +1,3 @@
 .DS_Store
 .idea
+.scannerwork
diff --git a/sonar-project.properties b/sonar-project.properties
new file mode 100644
index 0000000..74bb10a
--- /dev/null
+++ b/sonar-project.properties
@@ -0,0 +1,4 @@
+sonar.projectKey=populationgenomics_images
+sonar.python.version=3.11
+sonar.python.coverage.reportPaths=coverage.xml
+sonar.python.xunit.reportPath=test-execution.xml