ci: add integration test coverage job

Author: racitores

.github/actions/ci-status-gate/action.yml

@@ -96,6 +96,7 @@ runs:
         prepare_ci_js_deps_result="$(jq -nr 'env.NEEDS_JSON | fromjson | .["prepare-ci-js-deps"].result // ""')"
         unit_tests_result="$(jq -nr 'env.NEEDS_JSON | fromjson | .["unit-tests"].result // ""')"
         component_view_tests_result="$(jq -nr 'env.NEEDS_JSON | fromjson | .["component-view-tests"].result // ""')"
+        integration_tests_result="$(jq -nr 'env.NEEDS_JSON | fromjson | .["integration-tests"].result // ""')"
 
         if [[ "$block_merge_for_e2e_readiness" == "true" ]]; then
           echo "::error::The 'pr-not-ready-for-e2e' label is still applied. Remove it to trigger E2E tests before merging."
@@ -142,7 +143,8 @@ runs:
               elif [[ "$job_name" == "sonar-cloud-quality-gate-status" &&
                       ( "$prepare_ci_js_deps_result" =~ ^(failure|cancelled)$ ||
                         "$unit_tests_result" =~ ^(failure|cancelled)$ ||
-                        "$component_view_tests_result" =~ ^(failure|cancelled)$ ) ]]; then
+                        "$component_view_tests_result" =~ ^(failure|cancelled)$ ||
+                        "$integration_tests_result" =~ ^(failure|cancelled)$ ) ]]; then
                 add_summary_row "$job_name" "$result" "pass" "downstream coverage/Sonar skip is allowed after upstream dependency/test failure or cancellation"
               else
                 mark_failure "$job_name was skipped unexpectedly"

.github/scripts/collect-qa-stats.mjs

@@ -29,6 +29,7 @@
  *   {
  *     "unit":          { "total_tests_run": 41957, "total_tests_skipped": 17, "bridge_tests_run": 5000, "other_tests_run": 1000 },
  *     "component_view":{ "total_tests_run": 94,    "total_tests_skipped": 0 },
+ *     "integration":   { "total_tests_run": 11,    "total_tests_skipped": 0 },
  *     "e2e":           { "total_tests_run": 420,   "total_tests_skipped": 27,
  *                        "main_tests_run": 276, "main_android_tests_run": 276, "main_ios_tests_run": 276,
  *                        "flask_tests_run": 144, "confirmations_tests_run": 62 },
@@ -70,6 +71,7 @@ const PATH_ONBOARDING_EVENTS = 'tests/helpers/analytics/helpers.ts';
 const SCAN_PERFORMANCE_DIR = 'tests/performance';
 
 const PATTERN_CV_TEST_FILE   = /\.view(?:\..+)?\.test\.[jt]sx?$/;
+const PATTERN_INTEGRATION_TEST_FILE = /\.integration\.test\.[jt]sx?$/;
 const PATTERN_UNIT_TEST_FILE = /\.test\.[jt]sx?$/;
 const PATTERN_E2E_SPEC_FILE  = /\.spec\.[jt]sx?$/;
 const PATTERN_PERF_SPEC_FILE = /\.spec\.js$/;
@@ -834,16 +836,64 @@ async function collectComponentViewTestCount() {
   return result;
 }
 
+async function collectIntegrationTestCount() {
+  console.log(
+    '[integration] collecting per-suite counts from shard artifacts...',
+  );
+  const result = await collectShardCounts(
+    /^coverage-integration-\d+$/,
+    'integration',
+  );
+  if (Object.keys(result).length === 0) return result;
+
+  const isIntegrationTestFile = (name) =>
+    PATTERN_INTEGRATION_TEST_FILE.test(name);
+  const files = await walkFiles(SCAN_APP_DIR, isIntegrationTestFile);
+  let defined = 0, skips = 0;
+  for (const f of files) {
+    const source = await readFile(f, 'utf8');
+    defined += countDefinedTests(source);
+    skips += countSkips(source);
+  }
+  result.total_tests_defined = defined;
+  result.total_tests_skipped = skips;
+
+  // Coverage from the pre-computed nyc json-summary report produced by
+  // the merge-unit-and-component-view-tests job in ci.yml.
+  try {
+    const destDir = await downloadArtifact('integration-test-coverage-summary');
+    const summary = JSON.parse(
+      await readFile(join(destDir, 'coverage-summary.json'), 'utf8'),
+    );
+    const { lines, statements, branches, functions } = summary.total;
+    result.coverage_line = Math.round(lines.pct * 10) / 10;
+    result.coverage_statement = Math.round(statements.pct * 10) / 10;
+    result.coverage_branch = Math.round(branches.pct * 10) / 10;
+    result.coverage_function = Math.round(functions.pct * 10) / 10;
+    console.log(
+      `[integration] coverage — line: ${result.coverage_line}%, stmt: ${result.coverage_statement}%, branch: ${result.coverage_branch}%, fn: ${result.coverage_function}%`,
+    );
+  } catch (err) {
+    console.warn(
+      `[integration] coverage summary not available, skipping: ${err.message}`,
+    );
+  }
+
+  return result;
+}
+
 async function collectUnitTestCount() {
   console.log('[unit] collecting per-suite counts from shard artifacts...');
   // minFolderCount=200: buckets individual component-level folders into `other`,
   // keeping only meaningful team-level categories (bridge, perps, confirmations, etc.)
   const result = await collectShardCounts(/^coverage-unit-\d+$/, 'unit', 200);
   if (Object.keys(result).length === 0) return result;
 
-  // Unit test files: *.test.{ts,tsx,js} excluding *.view[.*].test.*
+  // Unit test files: *.test.{ts,tsx,js} excluding view and integration suites.
   const isUnitTestFile = (name) =>
-    PATTERN_UNIT_TEST_FILE.test(name) && !PATTERN_CV_TEST_FILE.test(name);
+    PATTERN_UNIT_TEST_FILE.test(name) &&
+    !PATTERN_CV_TEST_FILE.test(name) &&
+    !PATTERN_INTEGRATION_TEST_FILE.test(name);
   const files = await walkFiles(SCAN_APP_DIR, isUnitTestFile);
   let defined = 0, skips = 0;
   for (const f of files) {
@@ -1220,6 +1270,7 @@ async function main() {
   const collectors = [
     { namespace: 'unit', collect: collectUnitTestCount },
     { namespace: 'component_view', collect: collectComponentViewTestCount },
+    { namespace: 'integration', collect: collectIntegrationTestCount },
     { namespace: 'e2e', collect: collectE2ECounts },
     { namespace: 'e2e_test_times', collect: collectE2ETestTimes },
     { namespace: 'metametrics', collect: collectMetametricsQaStats },

.github/workflows/ci.yml

@@ -746,11 +746,15 @@ jobs:
             echo "No changes detected"
           fi
 
-  # We need to merge both unit and component view tests into a single coverage report so the PR coverage
-  # threshold calculation is accurate.
+  # We need to merge unit, component view, and integration tests into a
+  # single coverage report so the PR coverage threshold calculation is accurate.
   merge-unit-and-component-view-tests:
     runs-on: ${{ inputs.runner_provider == 'namespace' && 'namespace-profile-metamask-ci-linux' || 'ubuntu-latest' }}
-    needs: [prepare-ci-js-deps, unit-tests, component-view-tests]
+    needs:
+      - prepare-ci-js-deps
+      - unit-tests
+      - component-view-tests
+      - integration-tests
     # BITRISE/NAMESPACE-SHADOW: skip for iOS-only shadow benchmark (INFRA-3679) — revert to enable full pipeline
     if: ${{ github.event_name != 'merge_group' && inputs.runner_provider != 'bitrise' && inputs.runner_provider != 'namespace' }}
     steps:
@@ -807,11 +811,25 @@ jobs:
           echo "{\"component_view_test_number\": $cv_total}" > cv-test-stats.json
           echo "CV test count: $cv_total"
 
+          integration_total=0
+          for file in ./tests/coverage/coverage-integration-*/count.json; do
+            [ -f "$file" ] || continue
+            count=$(jq '.count // 0' "$file")
+            integration_total=$((integration_total + count))
+          done
+          echo "{\"integration_test_number\": $integration_total}" > integration-test-stats.json
+          echo "Integration test count: $integration_total"
+
           mkdir -p tests/coverage-cv-merged
           for file in ./tests/coverage/coverage-cv-*/coverage-cv-*.json; do
             [ -f "$file" ] && cp "$file" ./tests/coverage-cv-merged/
           done
 
+          mkdir -p tests/coverage-integration-merged
+          for file in ./tests/coverage/coverage-integration-*/coverage-integration-*.json; do
+            [ -f "$file" ] && cp "$file" ./tests/coverage-integration-merged/
+          done
+
           mkdir -p tests/coverage-unit-merged
           for file in ./tests/coverage/coverage-unit-*/coverage-unit-*.json; do
             [ -f "$file" ] && cp "$file" ./tests/coverage-unit-merged/
@@ -852,6 +870,22 @@ jobs:
           path: ./cv-test-stats.json
           if-no-files-found: error
           retention-days: 7
+      - name: Upload integration-test-stats (Namespace)
+        if: ${{ inputs.runner_provider == 'namespace' }}
+        uses: namespace-actions/upload-artifact@f6ccaacc655aec41b93af180d1d7eef21af862d2 # v1.0.3
+        with:
+          name: integration-test-stats
+          path: ./integration-test-stats.json
+          if-no-files-found: error
+          retention-days: 7
+      - name: Upload integration-test-stats (current)
+        if: ${{ inputs.runner_provider != 'namespace' }}
+        uses: actions/upload-artifact@v4
+        with:
+          name: integration-test-stats
+          path: ./integration-test-stats.json
+          if-no-files-found: error
+          retention-days: 7
       - name: Upload unit-test-stats (Namespace)
         if: ${{ inputs.runner_provider == 'namespace' }}
         uses: namespace-actions/upload-artifact@f6ccaacc655aec41b93af180d1d7eef21af862d2 # v1.0.3
@@ -902,6 +936,40 @@ jobs:
           path: ./tests/coverage-cv-lcov/coverage-summary.json
           if-no-files-found: error
           retention-days: 7
+      - name: Generate integration test coverage report
+        run: yarn nyc report --temp-dir ./tests/coverage-integration-merged --report-dir ./tests/coverage-integration-lcov --reporter html --reporter json-summary
+      - name: Upload integration-test-coverage-html (Namespace)
+        if: ${{ inputs.runner_provider == 'namespace' }}
+        uses: namespace-actions/upload-artifact@f6ccaacc655aec41b93af180d1d7eef21af862d2 # v1.0.3
+        with:
+          name: integration-test-coverage-html
+          path: ./tests/coverage-integration-lcov/
+          if-no-files-found: error
+          retention-days: 7
+      - name: Upload integration-test-coverage-html (current)
+        if: ${{ inputs.runner_provider != 'namespace' }}
+        uses: actions/upload-artifact@v4
+        with:
+          name: integration-test-coverage-html
+          path: ./tests/coverage-integration-lcov/
+          if-no-files-found: error
+          retention-days: 7
+      - name: Upload integration-test-coverage-summary (Namespace)
+        if: ${{ inputs.runner_provider == 'namespace' }}
+        uses: namespace-actions/upload-artifact@f6ccaacc655aec41b93af180d1d7eef21af862d2 # v1.0.3
+        with:
+          name: integration-test-coverage-summary
+          path: ./tests/coverage-integration-lcov/coverage-summary.json
+          if-no-files-found: error
+          retention-days: 7
+      - name: Upload integration-test-coverage-summary (current)
+        if: ${{ inputs.runner_provider != 'namespace' }}
+        uses: actions/upload-artifact@v4
+        with:
+          name: integration-test-coverage-summary
+          path: ./tests/coverage-integration-lcov/coverage-summary.json
+          if-no-files-found: error
+          retention-days: 7
       - name: Generate unit test coverage summary
         run: yarn nyc report --temp-dir ./tests/coverage-unit-merged --report-dir ./tests/coverage-unit-lcov --reporter json-summary
       - name: Upload unit-test-coverage-summary (Namespace)
@@ -995,6 +1063,70 @@ jobs:
           if-no-files-found: error
           retention-days: 7
 
+  integration-tests:
+    name: Integration tests
+    runs-on: ${{ inputs.runner_provider == 'namespace' && 'namespace-profile-metamask-ci-linux' || 'ubuntu-latest' }}
+    if: ${{ !cancelled() && needs.get_requirements.result == 'success' && needs.get_requirements.outputs.skip_everything != 'true' }}
+    needs:
+      - get_requirements
+      - prepare-ci-js-deps
+    strategy:
+      matrix:
+        shard: [1, 2]
+    steps:
+      - uses: namespacelabs/nscloud-checkout-action@938f5d2d403d6224d9a0c0dc559b1dae09c2ede4 # v8.1.1
+        if: ${{ inputs.runner_provider == 'namespace' }}
+      - uses: actions/checkout@v6
+        if: ${{ inputs.runner_provider != 'namespace' }}
+      # TEMP: artifact fallback for non-Namespace runners.
+      # Remove these two steps once Namespace passes the trial and becomes the default.
+      - name: Download CI JS deps artifact
+        id: download-ci-js-deps
+        if: ${{ inputs.runner_provider != 'namespace' && needs.prepare-ci-js-deps.result == 'success' }}
+        continue-on-error: true
+        uses: actions/download-artifact@v4
+        with:
+          name: ci-js-deps
+          path: .
+      - name: Extract CI JS deps
+        if: ${{ inputs.runner_provider != 'namespace' && needs.prepare-ci-js-deps.result == 'success' && steps.download-ci-js-deps.outcome == 'success' }}
+        run: tar -xzf ci-js-deps.tar.gz && rm ci-js-deps.tar.gz
+      - uses: ./.github/actions/setup-ci-js-deps
+        with:
+          runner_provider: ${{ inputs.runner_provider }}
+      - name: Prepare results directory
+        run: mkdir -p tests/results
+      - run: |
+          yarn test:integration:ci \
+            --shard=${{ matrix.shard }}/2 \
+            --json \
+            --outputFile=tests/results/integration-test-results-${{ matrix.shard }}.json
+        env:
+          NODE_OPTIONS: ${{ inputs.runner_provider == 'namespace' && '--max-old-space-size=12288' || '--max-old-space-size=20480' }}
+      - name: Rename coverage report and extract test count for this shard
+        shell: bash
+        run: |
+          mv ./tests/coverage/coverage-final.json ./tests/coverage/coverage-integration-${{ matrix.shard }}.json
+          cp tests/results/integration-test-results-${{ matrix.shard }}.json ./tests/coverage/jest-results.json
+          count=$(jq '(.numPassedTests // 0) + (.numFailedTests // 0)' tests/results/integration-test-results-${{ matrix.shard }}.json)
+          echo "{\"count\": $count}" > ./tests/coverage/count.json
+      - name: Upload coverage integration shard (Namespace)
+        if: ${{ inputs.runner_provider == 'namespace' }}
+        uses: namespace-actions/upload-artifact@f6ccaacc655aec41b93af180d1d7eef21af862d2 # v1.0.3
+        with:
+          name: coverage-integration-${{ matrix.shard }}
+          path: ./tests/coverage/
+          if-no-files-found: error
+          retention-days: 7
+      - name: Upload coverage integration shard (current)
+        if: ${{ inputs.runner_provider != 'namespace' }}
+        uses: actions/upload-artifact@v4
+        with:
+          name: coverage-integration-${{ matrix.shard }}
+          path: ./tests/coverage/
+          if-no-files-found: error
+          retention-days: 7
+
   smart-e2e-selection:
     name: 'Smart E2E Selection'
     runs-on: ${{ inputs.runner_provider == 'namespace' && 'namespace-profile-metamask-ci-linux' || 'ubuntu-latest' }}
@@ -1515,6 +1647,7 @@ jobs:
     needs:
       - unit-tests
       - component-view-tests
+      - integration-tests
       - merge-unit-and-component-view-tests
     permissions:
       actions: write
@@ -1554,6 +1687,8 @@ jobs:
       - scripts
       - unit-tests
       - component-view-tests
+      - integration-tests
+      - merge-unit-and-component-view-tests
       - check-workflows
       - prepare-ci-js-deps
       - js-bundle-size-check

package.json

@@ -90,13 +90,19 @@
     "build:ios:pre-flask": "export METAMASK_BUILD_TYPE='flask' && ./scripts/build.sh ios flask --pre",
     "build:attribution": "./scripts/generate-attributions.sh",
     "test": "yarn test:unit",
-    "test:unit": "jest ./app/ ./locales/ ./tests/**/*.test.ts .github/**/*.test.ts ./scripts/**/*.test.ts --testPathIgnorePatterns='.*/tests/(smoke|regression)/.*\\.spec\\.(ts|tsx|js)$|.*/e2e/.*\\.spec\\.(ts|tsx|js)$|.*\\.view(\\..*)?\\.test\\.(ts|tsx|js|jsx)$'",
+    "test:unit": "jest ./app/ ./locales/ ./tests/**/*.test.ts .github/**/*.test.ts ./scripts/**/*.test.ts --testPathIgnorePatterns='.*/tests/(smoke|regression)/.*\\.spec\\.(ts|tsx|js)$|.*/e2e/.*\\.spec\\.(ts|tsx|js)$|.*\\.integration\\.test\\.(ts|tsx|js|jsx)$|.*\\.view(\\..*)?\\.test\\.(ts|tsx|js|jsx)$'",
     "test:view:base": "jest -c jest.config.view.js --no-watchman --silent",
     "test:view": "yarn test:view:base --coverage=false --testPathPattern='.*\\.view(\\..*)?\\.test\\.(ts|tsx|js|jsx)$'",
     "test:view:one": "yarn test:view:base --verbose --coverage=false --testTimeout=30000",
     "test:view:coverage": "yarn test:view:base --coverage --testPathPattern='.*\\.view(\\..*)?\\.test\\.(ts|tsx|js|jsx)$'",
     "test:view:coverage:folder": "sh -c 'yarn test:view:base --coverage --testPathPattern=\"$1.*\\\\.view\\\\.test\\\\.(ts|tsx|js|jsx)$\" --collectCoverageFrom=\"$1/**/*.{ts,tsx,js,jsx}\" --coverageReporters=text-summary --coverageReporters=lcov' --",
     "test:view:ci": "TEST_OS=ios yarn test:view:coverage --forceExit --silent --coverageReporters=json",
+    "test:integration:base": "jest -c jest.config.integration.js --no-watchman --silent",
+    "test:integration": "yarn test:integration:base --coverage=false --testPathPattern='.*\\.integration\\.test\\.(ts|tsx|js|jsx)$'",
+    "test:integration:one": "yarn test:integration:base --verbose --coverage=false --testTimeout=30000",
+    "test:integration:coverage": "yarn test:integration:base --coverage --testPathPattern='.*\\.integration\\.test\\.(ts|tsx|js|jsx)$'",
+    "test:integration:coverage:folder": "sh -c 'yarn test:integration:base --coverage --testPathPattern=\"$1.*\\\\.integration\\\\.test\\\\.(ts|tsx|js|jsx)$\" --collectCoverageFrom=\"$1/**/*.{ts,tsx,js,jsx}\" --coverageReporters=text-summary --coverageReporters=lcov' --",
+    "test:integration:ci": "TEST_OS=ios yarn test:integration:coverage --forceExit --silent --coverageReporters=json",
     "test:unit:update": "time jest -u ./app/",
     "test:api-specs": "detox reset-lock-file && detox test -c ios.sim.apiSpecs",
     "test:e2e:android:main:ci": "HAS_TEST_OVERRIDES='true' NODE_OPTIONS='--experimental-vm-modules' detox test -c android.emu.main.ci --headless",