ci(MM-63199): code coverage tracking

.github/actions/test-coverage/action.yml

@@ -0,0 +1,124 @@
+# This action is used to test the coverage of the mobile repo
+# It will download the coverage result from the main branch and compare it with the current branch
+# If the coverage is lower than the main branch (1% or more), it will post a warning along with
+# the coverage report to the PR.
+# If this action is run on the main branch, it will upload the coverage result to the main branch
+# It will also generate a run id and cache it, so that the next time the action is run in the PR, 
+# it will use the cached run id to download the coverage result from the main branch
+
+name: test-coverage
+description: Test coverage tracking for mobile repo
+
+inputs:
+  github_token:
+    description: The token to use to download the coverage result
+    required: true
+  run_id:
+    description: The run id to use to download the coverage result
+    required: true
+
+runs:
+  using: composite
+  steps:
+    - name: ci/prepare-node-deps
+      uses: ./.github/actions/prepare-node-deps
+
+    - name: ci/get-last-run-id
+      if: github.event_name == 'pull_request'
+      id: get-last-run-id
+      uses: actions/cache/restore@0c907a75c2c80ebcb7f088228285e798b750cf8f
+      continue-on-error: true
+      with:
+        path: run-id.txt
+        key: last-run-id-${{ inputs.run_id }}
+        restore-keys: |
+          last-run-id-
+
+    - name: ci/set-pr-condition
+      if: github.event_name == 'pull_request'
+      shell: bash
+      run: |
+        echo "::group::set-pr-condition"
+        if [ -f "run-id.txt" ]; then
+          echo "IS_PR_WITH_CACHE=true" >> $GITHUB_ENV
+          echo "LAST_RUN_ID=$(cat run-id.txt)" >> $GITHUB_ENV
+        fi
+        echo "::endgroup::"
+
+    - name: ci/download-main-coverage
+      if: env.IS_PR_WITH_CACHE == 'true'
+      uses: actions/download-artifact@v4
+      with:
+        name: test-coverage-result-${{ env.LAST_RUN_ID }}
+        path: main-coverage/
+        github-token: ${{ inputs.github_token }}
+        run-id: ${{ env.LAST_RUN_ID }}
+
+    - name: ci/read-coverage
+      if: env.IS_PR_WITH_CACHE == 'true'
+      shell: bash
+      run: |
+        echo "::group::read-coverage"
+        ./scripts/read-coverage.sh ./main-coverage/coverage-summary.json
+        echo "::endgroup::"
+
+    - name: ci/run-tests-with-coverage
+      shell: bash
+      run: |
+        echo "::group::run-tests"
+        npm run test:coverage
+        echo "::endgroup::"
+
+    - name: ci/compare-coverage
+      if: env.IS_PR_WITH_CACHE == 'true'
+      id: compare-coverage
+      shell: bash
+      run: |
+        echo "::group::compare-coverage"
+        output=$(./scripts/compare-coverage.sh \
+          ./main-coverage \
+          ./coverage \
+          ${{ github.event.pull_request.number }} \
+          ${{ inputs.github_token }})
+        echo "report<<EOF" >> $GITHUB_ENV
+        echo "$output" >> $GITHUB_ENV
+        echo "EOF" >> $GITHUB_ENV
+        echo "::endgroup::"
+
+    - name: Post coverage report
+      if: env.IS_PR_WITH_CACHE == 'true'
+      uses: thollander/actions-comment-pull-request@v3
+      with:
+        message: ${{ env.report }}
+        comment-tag: coverage-report
+        # github-token: ${{ inputs.github_token }}
+        create-if-not-exists: true
+
+    - name: ci/upload-coverage
+      if: github.ref_name == 'main'
+      id: upload-coverage
+      uses: actions/upload-artifact@v4
+      with:
+        name: test-coverage-result-${{ inputs.run_id }}
+        path: coverage/coverage-summary.json
+        overwrite: true
+
+    - name: Set upload success
+      if: github.ref_name == 'main' && steps.upload-coverage.outcome == 'success'
+      shell: bash
+      run: echo "UPLOAD_SUCCESS=true" >> $GITHUB_ENV
+
+    - name: ci/generate-run-id-file
+      if: env.UPLOAD_SUCCESS == 'true'
+      shell: bash
+      run: |
+        echo "::group::generate-last-run-id"
+        echo "${{ inputs.run_id }}" > run-id.txt
+        echo "::endgroup::"
+
+    - name: ci/cache-run-id-file
+      if: env.UPLOAD_SUCCESS == 'true'
+      uses: actions/cache/save@0c907a75c2c80ebcb7f088228285e798b750cf8f
+      with:
+        path: run-id.txt
+        key: last-run-id-${{ inputs.run_id }}

.github/actions/test/action.yaml

@@ -13,12 +13,16 @@ runs:
         echo "::group::check-styles"
         npm run check
         echo "::endgroup::"
+
     - name: ci/run-tests
+      # main and PR will run test:coverage
+      if: startsWith(github.ref_name, 'release-')
       shell: bash
       run: |
         echo "::group::run-tests"
         npm test
         echo "::endgroup::"
+
     - name: ci/check-i18n
       shell: bash
       run: |

.github/workflows/ci.yml

@@ -19,3 +19,9 @@ jobs:
         uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
       - name: ci/test
         uses: ./.github/actions/test
+      - name: ci/test-coverage
+        if: github.event_name == 'pull_request' || github.ref_name == 'main'
+        uses: ./.github/actions/test-coverage
+        with:
+          github_token: ${{ secrets.MM_MOBILE_GITHUB_TOKEN }}
+          run_id: ${{ github.run_id }}

jest.config.js

@@ -13,7 +13,7 @@ module.exports = {
     clearMocks: true,
     setupFilesAfterEnv: ['<rootDir>/test/setup.ts'],
     collectCoverageFrom: ['app/**/*.{js,jsx,ts,tsx}'],
-    coverageReporters: ['lcov', 'text-summary'],
+    coverageReporters: ['lcov', 'text-summary', 'json-summary'],
     testPathIgnorePatterns: ['/node_modules/'],
     coveragePathIgnorePatterns: ['/node_modules/', '/components/', '/screens/'],
     transformIgnorePatterns: [

scripts/compare-coverage.sh

@@ -0,0 +1,71 @@
+#!/bin/bash
+
+COVERAGE_THRESHOLD=0.5
+MAIN_COVERAGE_FILE="$1/coverage-summary.json"
+RECENT_COVERAGE_FILE="$2/coverage-summary.json"
+PR_NUMBER="$3"
+GITHUB_TOKEN="$4"
+
+if [ ! -f "$MAIN_COVERAGE_FILE" ] || [ ! -f "$RECENT_COVERAGE_FILE" ]; then
+    echo "One or both coverage files not found"
+    exit 0
+fi
+
+COMMENT_BODY="### Coverage Comparison Report
+
+\`\`\`
++-----------------+------------+------------+-----------+
+| Metric          | Main       | This PR    | Diff      |
++-----------------+------------+------------+-----------+"
+
+HAS_DECREASE=0
+
+# Initialize variables for calculating average total coverage
+# since the coverage summary doesn't provide an overall total
+main_total=0
+pr_total=0
+metric_count=0
+
+for metric in lines statements branches functions; do
+    main=$(jq ".total.${metric}.pct" "$MAIN_COVERAGE_FILE")
+    pr=$(jq ".total.${metric}.pct" "$RECENT_COVERAGE_FILE")
+    diff=$(echo "$pr - $main" | bc)
+
+    # Add to totals for average calculation
+    main_total=$(echo "$main_total + $main" | bc)
+    pr_total=$(echo "$pr_total + $pr" | bc)
+    metric_count=$((metric_count + 1))
+
+    row=$(printf "| %-15s | %9.2f%% | %9.2f%% | %8.2f%% |" "${metric^}" "$main" "$pr" "$diff")
+    COMMENT_BODY+=$'\n'"$row"
+
+    if (( $(echo "$diff > -$COVERAGE_THRESHOLD" | bc -l) )); then
+        # Write error messages to stderr instead of stdout
+        echo "::error::${metric^} coverage has decreased by more than ${COVERAGE_THRESHOLD}% ($diff%)" >&2
+        HAS_DECREASE=1
+    fi
+done
+
+# Add separator line
+COMMENT_BODY+=$'\n'"+-----------------+------------+------------+-----------+"
+
+# Calculate the average coverage across all metrics
+main_avg=$(echo "scale=2; $main_total / $metric_count" | bc)
+pr_avg=$(echo "scale=2; $pr_total / $metric_count" | bc)
+total_diff=$(echo "$pr_avg - $main_avg" | bc)
+
+row=$(printf "| %-15s | %9.2f%% | %9.2f%% | %8.2f%% |" "Total" "$main_avg" "$pr_avg" "$total_diff")
+COMMENT_BODY+=$'\n'"$row"
+
+COMMENT_BODY+=$'\n'"+-----------------+------------+------------+-----------+
+\`\`\`"
+
+if [ "$HAS_DECREASE" -eq 1 ]; then
+    COMMENT_BODY+=$'\n\n'"⚠️ **Warning:** One or more coverage metrics have decreased by more than ${COVERAGE_THRESHOLD}%"
+fi
+
+# Only output the comment body to stdout
+echo "$COMMENT_BODY"
+
+# Not failing the build for now
+# exit $HAS_DECREASE 

scripts/read-coverage.sh

@@ -0,0 +1,37 @@
+#!/bin/bash
+
+set -e  # Exit on any error
+
+# Check if an argument is provided
+if [ -z "$1" ]; then
+  echo "❌ Error: No coverage file provided."
+  echo "Usage: $0 <coverage-summary.json>"
+  exit 1
+fi
+
+COVERAGE_FILE="$1"
+
+# Check if the coverage file exists
+if [ ! -f "$COVERAGE_FILE" ]; then
+  echo "❌ Error: Coverage summary file not found: $COVERAGE_FILE"
+  exit 1
+fi
+
+# Extract coverage values from JSON
+BRANCHES=$(jq '.total.branches.pct' $COVERAGE_FILE)
+FUNCTIONS=$(jq '.total.functions.pct' $COVERAGE_FILE)
+LINES=$(jq '.total.lines.pct' $COVERAGE_FILE)
+STATEMENTS=$(jq '.total.statements.pct' $COVERAGE_FILE)
+
+# Print extracted values
+echo "📊 Extracted Coverage Values:"
+echo " - Branches:   $BRANCHES%"
+echo " - Functions:  $FUNCTIONS%"
+echo " - Lines:      $LINES%"
+echo " - Statements: $STATEMENTS%"
+
+# Export values for GitHub Actions (if needed)
+echo "BRANCHES=$BRANCHES" >> $GITHUB_ENV
+echo "FUNCTIONS=$FUNCTIONS" >> $GITHUB_ENV
+echo "LINES=$LINES" >> $GITHUB_ENV
+echo "STATEMENTS=$STATEMENTS" >> $GITHUB_ENV