Fix #5486 & part of #5343: Introducing new wiki page for code coverage usage and limitations

.github/workflows/build_tests.yml

@@ -11,7 +11,7 @@ on:
       - develop
 
 concurrency:
-  group: ${{ github.workflow }}-${{ github.ref }}
+  group: ${{ github.workflow }}-${{ github.event.pull_request.number || github.run_id }}
   cancel-in-progress: true
 
 jobs:

.github/workflows/code_coverage.yml

@@ -12,7 +12,7 @@ on:
       - develop
 
 concurrency:
-  group: ${{ github.workflow }}-${{ github.ref }}
+  group: ${{ github.workflow }}-${{ github.event.pull_request.number || github.run_id }}
   cancel-in-progress: true
 
 jobs:
@@ -255,10 +255,13 @@ jobs:
           name: coverage-report-${{ env.SHARD_NAME }} # Saving with unique names to avoid conflict
           path: coverage_reports
 
-  evaluate-code-coverage-reports:
+  evaluate_code_coverage_reports:
     name: Evaluate Code Coverage Reports
     runs-on: ubuntu-20.04
     needs: code_coverage_run
+    # The expression if: ${{ !cancelled() }} runs a job or step regardless of its success or failure while responding to cancellations,
+    # serving as a cancellation-compliant alternative to if: ${{ always() }} in concurrent workflows.
+    if: ${{ !cancelled() }}
     env:
       CACHE_DIRECTORY: ~/.bazel_cache
     steps:
@@ -305,32 +308,10 @@ jobs:
           name: final-coverage-report
           path: coverage_reports/CoverageReport.md
 
-  publish_coverage_report:
-    name: Publish Code Coverage Report
-    needs: evaluate-code-coverage-reports
-    permissions:
-      pull-requests: write
-
-    # The expression if: ${{ !cancelled() }} runs a job or step regardless of its success or failure while responding to cancellations,
-    # serving as a cancellation-compliant alternative to if: ${{ always() }} in concurrent workflows.
-    if: ${{ !cancelled() }}
-    runs-on: ubuntu-latest
-    steps:
-      - name: Download Generated Markdown Report
-        uses: actions/download-artifact@v4
-        with:
-          name: final-coverage-report
-
-      - name: Upload Coverage Report as PR Comment
-        uses: peter-evans/create-or-update-comment@v4
-        with:
-          issue-number: ${{ github.event.pull_request.number }}
-          body-path: 'CoverageReport.md'
-
   # Reference: https://github.community/t/127354/7.
   check_coverage_results:
     name: Check Code Coverage Results
-    needs: [ compute_changed_files, code_coverage_run, evaluate-code-coverage-reports ]
+    needs: [ compute_changed_files, code_coverage_run, evaluate_code_coverage_reports ]
     # The expression if: ${{ !cancelled() }} runs a job or step regardless of its success or failure while responding to cancellations,
     # serving as a cancellation-compliant alternative to if: ${{ always() }} in concurrent workflows.
     if: ${{ !cancelled() }}
@@ -341,5 +322,5 @@ jobs:
         run: exit 1
 
       - name: Check that coverage status is passed
-        if: ${{ needs.evaluate-code-coverage-reports.result != 'success' }}
+        if: ${{ needs.compute_changed_files.outputs.can_skip_files != 'true' && needs.evaluate_code_coverage_reports.result != 'success' }}
         run: exit 1

.github/workflows/comment_coverage_report.yml

@@ -0,0 +1,81 @@
+# Contains jobs corresponding to publishing coverage reports generated by code_coverage.yml.
+
+name: Comment Coverage Report
+
+# Controls when the action will run. Triggers the workflow  on pull request events
+# (assigned, opened, synchronize, reopened)
+
+on:
+  pull_request_target:
+    types: [assigned, opened, synchronize, reopened]
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.event.pull_request.number || github.run_id }}
+  cancel-in-progress: true
+
+jobs:
+  check_code_coverage_completed:
+    name: Check code coverage completed
+    runs-on: ubuntu-latest
+    steps:
+      - name: Wait for code coverage to complete
+        id: wait-for-coverage
+        uses: ArcticLampyrid/[email protected]
+        with:
+          workflow: code_coverage.yml
+          sha: auto
+          allowed-conclusions: |
+            success
+            failure
+
+  comment_coverage_report:
+    name: Comment Code Coverage Report
+    needs: check_code_coverage_completed
+    permissions:
+      pull-requests: write
+
+    # The expression if: ${{ !cancelled() }} runs a job or step regardless of its success or failure while responding to cancellations,
+    # serving as a cancellation-compliant alternative to if: ${{ always() }} in concurrent workflows.
+    if: ${{ !cancelled() }}
+    runs-on: ubuntu-latest
+    steps:
+      - name: Find CI workflow run for PR
+        id: find-workflow-run
+        uses: actions/github-script@v7
+        continue-on-error: true
+        with:
+          script: |
+            // Find the last successful workflow run for the current PR's head
+            const { owner, repo } = context.repo;
+            const runsResponse = await github.rest.actions.listWorkflowRuns({
+              owner,
+              repo,
+              workflow_id: 'code_coverage.yml',
+              event: 'pull_request',
+              head_sha: '${{ github.event.pull_request.head.sha }}',
+            });
+
+            const runs = runsResponse.data.workflow_runs;
+            runs.sort((a, b) => new Date(b.created_at).getTime() - new Date(a.created_at).getTime());
+
+            const run = runs[0];
+            if(!run) {
+              core.setFailed('Could not find a succesful workflow run for the PR');
+              return;
+            }
+
+            core.setOutput('run-id', run.id);
+
+      - name: Download Generated Markdown Report
+        uses: actions/download-artifact@v4
+        if: ${{ !cancelled() }} # IMPORTANT: Upload reports regardless of success or failure status
+        with:
+          name: final-coverage-report
+          github-token: ${{ secrets.GITHUB_TOKEN }}
+          run-id: ${{ steps.find-workflow-run.outputs.run-id }}
+
+      - name: Upload Coverage Report as PR Comment
+        uses: peter-evans/create-or-update-comment@v4
+        with:
+          issue-number: ${{ github.event.pull_request.number }}
+          body-path: 'CoverageReport.md'

.github/workflows/main.yml

@@ -13,7 +13,7 @@ on:
       - develop
 
 concurrency:
-  group: ${{ github.workflow }}-${{ github.ref }}
+  group: ${{ github.workflow }}-${{ github.event.pull_request.number || github.run_id }}
   cancel-in-progress: true
 
 # This workflow has the following jobs:

.github/workflows/static_checks.yml

@@ -10,7 +10,7 @@ on:
       - develop
 
 concurrency:
-  group: ${{ github.workflow }}-${{ github.ref }}
+  group: ${{ github.workflow }}-${{ github.event.pull_request.number || github.run_id }}
   cancel-in-progress: true
 
 jobs:

.github/workflows/unit_tests.yml

@@ -13,7 +13,7 @@ on:
       - develop
 
 concurrency:
-  group: ${{ github.workflow }}-${{ github.ref }}
+  group: ${{ github.workflow }}-${{ github.event.pull_request.number || github.run_id }}
   cancel-in-progress: true
 
 jobs:

scripts/src/java/org/oppia/android/scripts/coverage/reporter/CoverageReporter.kt

@@ -496,16 +496,37 @@ class CoverageReporter(
       }
     }
 
-    val finalReportText = "## Coverage Report\n\n" +
-      "### Results\n" +
-      "Number of files assessed: ${coverageReportContainer.coverageReportList.size}\n" +
-      "Overall Coverage: **${"%.2f".format(calculateOverallCoveragePercentage())}%**\n" +
-      "Coverage Analysis: $status\n" +
-      "##" +
-      failureMarkdownTable +
-      failureMarkdownEntries +
-      successMarkdownEntries +
-      testFileExemptedSection
+    val wikiPageLinkNote = buildString {
+      val wikiPageReferenceNote = ">To learn more, visit the [Oppia Android Code Coverage]" +
+        "(https://github.com/oppia/oppia-android/wiki/Oppia-Android-Code-Coverage) wiki page"
+      append("\n\n")
+      append("#")
+      append("\n")
+      append(wikiPageReferenceNote)
+    }
+
+    val skipCoverageReportText = buildString {
+      append("## Coverage Report\n")
+      append("### Results\n")
+      append("Coverage Analysis: **SKIP** :next_track_button:\n\n")
+      append("_This PR did not introduce any changes to Kotlin source or test files._")
+      append(wikiPageLinkNote)
+    }
+
+    val finalReportText = coverageReportContainer.coverageReportList.takeIf { it.isNotEmpty() }
+      ?.let {
+        "## Coverage Report\n\n" +
+          "### Results\n" +
+          "Number of files assessed: ${coverageReportContainer.coverageReportList.size}\n" +
+          "Overall Coverage: **${"%.2f".format(calculateOverallCoveragePercentage())}%**\n" +
+          "Coverage Analysis: $status\n" +
+          "##" +
+          failureMarkdownTable +
+          failureMarkdownEntries +
+          successMarkdownEntries +
+          testFileExemptedSection +
+          wikiPageLinkNote
+      } ?: skipCoverageReportText
 
     val finalReportOutputPath = mdReportOutputPath
       ?.let { it }

scripts/src/javatests/org/oppia/android/scripts/coverage/RunCoverageTest.kt

@@ -90,6 +90,7 @@ class RunCoverageTest {
       append("| File | Failure Reason | Status |\n")
       append("|------|----------------|--------|\n")
       append("| ${getFilenameAsDetailsSummary(sampleFile)} | $failureMessage | :x: |")
+      append(oppiaCoverageWikiPageLinkNote)
     }
 
     assertThat(readFinalMdReport()).isEqualTo(expectedMarkdown)
@@ -229,6 +230,7 @@ class RunCoverageTest {
       append("\n\n")
       append(exemptionsReferenceNote)
       append("</details>")
+      append(oppiaCoverageWikiPageLinkNote)
     }
 
     assertThat(readFinalMdReport()).isEqualTo(expectedResult)
@@ -278,6 +280,7 @@ class RunCoverageTest {
       append("\n\n")
       append(exemptionsReferenceNote)
       append("</details>")
+      append(oppiaCoverageWikiPageLinkNote)
     }
 
     assertThat(readFinalMdReport()).isEqualTo(expectedResult)
@@ -385,6 +388,7 @@ class RunCoverageTest {
       append("| File | Failure Reason | Status |\n")
       append("|------|----------------|--------|\n")
       append("| //coverage/example:AddNumsTest | $failureMessage | :x: |")
+      append(oppiaCoverageWikiPageLinkNote)
     }
 
     assertThat(readFinalMdReport()).isEqualTo(expectedMarkdown)
@@ -469,6 +473,7 @@ class RunCoverageTest {
       append("| File | Failure Reason | Status |\n")
       append("|------|----------------|--------|\n")
       append("| //coverage/test/java/com/example:SubNumsTest | $failureMessage | :x: |")
+      append(oppiaCoverageWikiPageLinkNote)
     }
 
     assertThat(readFinalMdReport()).isEqualTo(expectedMarkdown)
@@ -655,6 +660,7 @@ class RunCoverageTest {
           ":white_check_mark: | $MIN_THRESHOLD% |\n\n"
       )
       append("</details>")
+      append(oppiaCoverageWikiPageLinkNote)
     }
 
     assertThat(readFinalMdReport()).isEqualTo(expectedResult)
@@ -843,6 +849,7 @@ class RunCoverageTest {
         "| ${getFilenameAsDetailsSummary(filePathList.get(0))} | 0.00% | 0 / 4 | " +
           ":x: | $MIN_THRESHOLD% |\n"
       )
+      append(oppiaCoverageWikiPageLinkNote)
     }
 
     assertThat(readFinalMdReport()).isEqualTo(expectedResult)
@@ -934,6 +941,7 @@ class RunCoverageTest {
           ":x: | 101% _*_ |"
       )
       append("\n\n>**_*_** represents tests with custom overridden pass/fail coverage thresholds")
+      append(oppiaCoverageWikiPageLinkNote)
     }
 
     assertThat(readFinalMdReport()).isEqualTo(expectedResult)
@@ -1021,6 +1029,7 @@ class RunCoverageTest {
       )
       append("\n\n>**_*_** represents tests with custom overridden pass/fail coverage thresholds\n")
       append("</details>")
+      append(oppiaCoverageWikiPageLinkNote)
     }
 
     assertThat(readFinalMdReport()).isEqualTo(expectedResult)
@@ -1090,6 +1099,7 @@ class RunCoverageTest {
           ":white_check_mark: | $MIN_THRESHOLD% |\n\n"
       )
       append("</details>")
+      append(oppiaCoverageWikiPageLinkNote)
     }
 
     assertThat(readFinalMdReport()).isEqualTo(expectedResult)
@@ -1162,6 +1172,7 @@ class RunCoverageTest {
       append("\n\n")
       append(exemptionsReferenceNote)
       append("</details>")
+      append(oppiaCoverageWikiPageLinkNote)
     }
 
     assertThat(readFinalMdReport()).isEqualTo(expectedResult)
@@ -1238,6 +1249,7 @@ class RunCoverageTest {
       append("\n\n")
       append(exemptionsReferenceNote)
       append("</details>")
+      append(oppiaCoverageWikiPageLinkNote)
     }
 
     assertThat(readFinalMdReport()).isEqualTo(expectedResult)
@@ -1333,6 +1345,7 @@ class RunCoverageTest {
       append("\n\n")
       append(exemptionsReferenceNote)
       append("</details>")
+      append(oppiaCoverageWikiPageLinkNote)
     }
 
     assertThat(readFinalMdReport()).isEqualTo(expectedResult)
@@ -1438,6 +1451,7 @@ class RunCoverageTest {
       append("\n\n")
       append(exemptionsReferenceNote)
       append("</details>")
+      append(oppiaCoverageWikiPageLinkNote)
     }
 
     assertThat(readFinalMdReport()).isEqualTo(expectedResult)
@@ -1642,6 +1656,7 @@ class RunCoverageTest {
           ":white_check_mark: | $MIN_THRESHOLD% |\n\n"
       )
       append("</details>")
+      append(oppiaCoverageWikiPageLinkNote)
     }
 
     assertThat(readFinalMdReport()).isEqualTo(expectedResult)
@@ -1722,6 +1737,7 @@ class RunCoverageTest {
           ":white_check_mark: | $MIN_THRESHOLD% |\n\n"
       )
       append("</details>")
+      append(oppiaCoverageWikiPageLinkNote)
     }
 
     assertThat(readFinalMdReport()).isEqualTo(expectedResult)
@@ -2282,6 +2298,7 @@ class RunCoverageTest {
           "3 / 4 | :white_check_mark: | $MIN_THRESHOLD% |\n\n"
       )
       append("</details>")
+      append(oppiaCoverageWikiPageLinkNote)
     }
 
     return markdownText
@@ -2575,13 +2592,20 @@ class RunCoverageTest {
   }
 
   private fun getFilenameAsDetailsSummary(
-    filePath: String,
-    additionalData: String? = null
+    filePath: String
   ): String {
     val fileName = filePath.substringAfterLast("/")
-    val additionalDataPart = additionalData?.let { " - $it" } ?: ""
 
-    return "<details><summary><b>$fileName</b>$additionalDataPart</summary>$filePath</details>"
+    return "<details><summary><b>$fileName</b></summary>$filePath</details>"
+  }
+
+  private val oppiaCoverageWikiPageLinkNote = buildString {
+    val wikiPageReferenceNote = ">To learn more, visit the [Oppia Android Code Coverage]" +
+      "(https://github.com/oppia/oppia-android/wiki/Oppia-Android-Code-Coverage) wiki page"
+    append("\n\n")
+    append("#")
+    append("\n")
+    append(wikiPageReferenceNote)
   }
 
   private fun loadCoverageReportProto(