feat: adds code coverage with coveralls

.config/dictionaries/project.dic

@@ -6,9 +6,9 @@ afinet
 androidx
 anypolicy
 appspot
-Arissara
 Arbritrary
 ARGB
+Arissara
 asmjs
 asyncio
 asyncpg
@@ -25,11 +25,12 @@ bluefireteam
 BROTLI
 canvaskit
 cardano
+carryforward
 Catalyst
 CBOR
 cborg
-CEST
 cdylib
+CEST
 cfbundle
 Chotivichit
 chromedriver
@@ -40,6 +41,7 @@ COCOAPODS
 codegen
 codepoints
 coti
+coverallsapp
 cryptoxide
 Cunego
 Cupertino
@@ -239,4 +241,4 @@ xcodeproj
 xctest
 xctestrun
 xcworkspace
-yoroi
+yoroi

.github/workflows/generate-allure-report.yml

@@ -20,7 +20,9 @@ env:
     EARTHLY_TARGET: docker
     ECR_REGISTRY: 332405224602.dkr.ecr.eu-central-1.amazonaws.com
     ALLURE_REPORT_PATH: allure-report
+    COVERAGE_REPORT_PATH: coverage-report
     REPORT_EXT: .junit-report.xml
+    COVERAGE_EXT: .info
 
 jobs:
   generate-test-reports:
@@ -71,8 +73,8 @@ jobs:
             target_flags:
             runner_address: ${{ secrets.EARTHLY_SATELLITE_ADDRESS }}
             artifact: "false"
-      
-      - name: Get backend python test report
+
+      - name: Get python api test report
         uses: input-output-hk/catalyst-ci/actions/run@master
         if: always()
         continue-on-error: true
@@ -88,10 +90,20 @@ jobs:
         uses: actions/upload-artifact@v4
         if: always()
         with:
+            name: test-reports
             path: '**/*${{ env.REPORT_EXT }}'
             if-no-files-found: error
             retention-days: 1
 
+      - name: Collect and upload test coverage
+        uses: actions/upload-artifact@v4
+        if: always()
+        with:
+            name: coverage-reports
+            path: '**/*${{ env.COVERAGE_EXT }}'
+            if-no-files-found: error
+            retention-days: 1
+
   generate-allure-report:
     name: Generate allure report
     runs-on: ubuntu-latest
@@ -100,6 +112,8 @@ jobs:
       - uses: actions/checkout@v4
 
       - uses: actions/download-artifact@v4
+        with:
+          name: test-reports
 
       - name: Setup Allure report
         run: |
@@ -136,4 +150,64 @@ jobs:
           message: |
             ${{ steps.allure.outputs.test_result_icon }} [Test Report](${{ steps.allure.outputs.report_url }}) | ${\color{lightgreen}Pass: ${{ steps.allure.outputs.test_result_passed }}/${{ steps.allure.outputs.test_result_total }}}$ | ${\color{red}Fail: ${{ steps.allure.outputs.test_result_failed }}/${{ steps.allure.outputs.test_result_total }}}$ |
           comment_tag: allure_report
-          mode: upsert
+          mode: upsert
+
+  generate-coverage-report:
+    name: Generate coverage report
+    runs-on: ubuntu-latest
+    needs: [generate-test-reports]
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: actions/download-artifact@v4
+        with:
+          name: coverage-reports
+
+      - name: Collect coverage report
+        run: |
+            mkdir -p ${{ env.COVERAGE_REPORT_PATH }}
+            shopt -s globstar
+            cp **/*${{ env.COVERAGE_EXT }} ${{ env.COVERAGE_REPORT_PATH }}
+            ls ${{ env.COVERAGE_REPORT_PATH }}
+
+      - name: Normalize coverage report paths
+        run: |
+            sed -i -e 's/SF:\/root/SF:catalyst-gateway/g' ${{ env.COVERAGE_REPORT_PATH }}/cat-gateway.coverage.info
+            sed -i -e 's/SF:lib/SF:catalyst_voices\/lib/g' ${{ env.COVERAGE_REPORT_PATH }}/lcov.info
+            cat ${{ env.COVERAGE_REPORT_PATH }}/cat-gateway.coverage.info
+
+      - name: Coveralls
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        uses: coverallsapp/github-action@v2
+        with:
+          path-to-lcov: "${{ env.COVERAGE_REPORT_PATH }}/cat-gateway.coverage.info"
+          allow-empty: true
+          debug: true
+          flag-name: rust-unit-test
+          base-path: "/home/runner/work/catalyst-voices/catalyst-voices/"
+          parallel: true
+
+      - name: Coveralls
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        uses: coverallsapp/github-action@v2
+        with:
+          path-to-lcov: "${{ env.COVERAGE_REPORT_PATH }}/lcov.info"
+          allow-empty: true
+          debug: true
+          flag-name: flutter-test
+          base-path: "/home/runner/work/catalyst-voices/catalyst-voices/"
+          parallel: true
+
+  upload-coverage-report:
+    name: Upload coverage report
+    needs: [generate-coverage-report]
+    if: ${{ always() }}
+    runs-on: ubuntu-latest
+    steps:
+    - name: Coveralls Finished
+      uses: coverallsapp/github-action@v2
+      with:
+        parallel-finished: true
+        carryforward: "rust-unit-test,flutter-test"

catalyst-gateway/.gitignore

@@ -11,6 +11,6 @@ target/
 *.pdb
 
 # Build artifacts
-cat-gateway.coverage-report.info
+cat-gateway.coverage.info
 cat-gateway.junit-report.xml
 cat-gateway-api.*

catalyst-gateway/Earthfile

@@ -40,7 +40,7 @@ build:
         --args2="--cov_report=$HOME/coverage-report.info" \
         --output="release/cat-gateway" \
         --junit="cat-gateway.junit-report.xml" \
-        --coverage="cat-gateway.coverage-report.info" \
+        --coverage="cat-gateway.coverage.info" \
         --docs="true"
 
     # Generate the OpenAPI doc from the cat-gateway executable itself.

catalyst-gateway/tests/api_tests/Earthfile

@@ -13,17 +13,20 @@ builder:
 # Disabled in CI, to enable rename it to `test`.
 api-test:
     FROM +builder
+    RUN apk update && apk add iptables-legacy # workaround for https://github.com/earthly/earthly/issues/3784
 
     COPY ./docker-compose.yml .
 
     WITH DOCKER \
         --compose docker-compose.yml \
         --load event-db:latest=(../../event-db+build) \
-        --load cat-gateway:latest=(../../+package-cat-gateway-with-preprod) \
+        --load cat-gateway:latest=(../../+package-cat-gateway-with-preprod-snapshot) \
         --service cat-gateway \
         --allow-privileged
-        RUN poetry run pytest -s --junitxml=junit-report.xml
+        RUN poetry run pytest -s --junitxml=junit-report.xml --cov=api_tests --cov-report lcov
     END
     WAIT
-        SAVE ARTIFACT junit-report.xml AS LOCAL backendpython.junit-report.xml
+        SAVE ARTIFACT junit-report.xml AS LOCAL api-tests.junit-report.xml
+        SAVE ARTIFACT coverage.lcov AS LOCAL api-tests.coverage.info
+
     END