support coverage report (#3)

* support coverage report

* temporary comment out run conditions

* update on

* add sonar properties

* updated CI

Author: Goldziher

.github/workflows/ci.yaml

@@ -6,6 +6,7 @@ on:
       - main
 jobs:
   validate:
+    name: "Validate"
     runs-on: ubuntu-latest
     steps:
       - name: Checkout repository
@@ -25,6 +26,7 @@ jobs:
       - name: Execute Pre-Commit
         run: pre-commit run --show-diff-on-failure --color=always --all-files
   pyton_tests:
+    name: "Python Tests"
     runs-on: ubuntu-latest
     strategy:
       fail-fast: true
@@ -58,17 +60,50 @@ jobs:
       - name: Test
         run: poetry run pytest
   rust_tests:
+    name: "Rust Tests"
     runs-on: ubuntu-latest
     steps:
       - name: Checkout Repository
         uses: actions/checkout@v3
       - name: Install Rust
         uses: actions-rs/toolchain@v1
         with:
-          profile: minimal
           toolchain: stable
           override: true
-      - name: Install Rust Dependencies
-        uses: actions-rs/cargo@v1
+          target: x86_64-unknown-linux-musl
+          components: llvm-tools-preview
+      - name: Download grcov
+        run: |
+          mkdir -p "${HOME}/.local/bin"
+          curl -sL https://github.com/mozilla/grcov/releases/download/v0.8.10/grcov-x86_64-unknown-linux-gnu.tar.bz2 | tar jxf - -C "${HOME}/.local/bin"
+          echo "$HOME/.local/bin" >> $GITHUB_PATH
+      - name: Test with Coverage
+        run: CARGO_INCREMENTAL=0 RUSTFLAGS='-Cinstrument-coverage' LLVM_PROFILE_FILE='cargo-test-%p-%m.profraw' cargo test
+      - name: Generate Coverage Report
+        run: mkdir coverage && grcov . --binary-path ./target/debug/deps/ -s . -t lcov --branch --ignore-not-existing --ignore '../*' --ignore "/*" -o coverage.lcov
+      - uses: actions/upload-artifact@v3
         with:
-          command: test
+          name: coverage-lcov
+          path: coverage.lcov
+  sonar:
+    name: "Sonar"
+    needs:
+      - pyton_tests
+      - rust_tests
+      - validate
+    if: github.event.pull_request.head.repo.fork == false
+    runs-on: ubuntu-latest
+    steps:
+      - name: Check out repository
+        uses: actions/checkout@v3
+      - name: Download Artifacts
+        uses: actions/download-artifact@v3
+        with:
+          name: coverage-lcov
+      - name: Fix coverage file for sonarcloud
+        run: sed -i "s/home\/runner\/work\/http_utils\/src/github\/workspace/g" coverage.lcov
+      - name: SonarCloud Scan
+        uses: sonarsource/sonarcloud-github-action@master
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          SONAR_TOKEN: ${{ secrets.SONAR_TOKEN }}

.gitignore

@@ -3,3 +3,5 @@ __pycache__/
 .pytest_cache/
 *.iml
 .idea
+*.profraw
+coverage*

sonar-project.properties

@@ -0,0 +1,5 @@
+sonar.projectKey=starlite-api_http-utils
+sonar.organization=starlite-api
+sonar.javascript.lcov.reportPaths==coverage.lcov
+sonar.sourceEncoding=UTF-8
+sonar.sources=src