Added docs and reverted all testing data

yet to fix the ambiguity error with main calls
oppia · Aug 11, 2024 · 1d15ea4 · 1d15ea4
1 parent 90d2a7e
commit 1d15ea4
Show file tree

Hide file tree

Showing 4 changed files with 23 additions and 19 deletions.
diff --git a/.github/workflows/code_coverage.yml b/.github/workflows/code_coverage.yml
@@ -8,27 +8,27 @@ on:
   pull_request:
   push:
     branches:
-      # Push events on develop branch
+       Push events on develop branch
       - develop
 
 concurrency:
   group: ${{ github.workflow }}-${{ github.ref }}
   cancel-in-progress: true
 
 jobs:
-#  check_unit_tests_completed:
-#    name: Check unit test completed
-#    runs-on: ubuntu-latest
-#    steps:
-#      - name: Wait for unit tests to checks
-#        uses: ArcticLampyrid/[email protected]
-#        with:
-#          workflow: unit_tests.yml
-#          sha: auto
+  check_unit_tests_completed:
+    name: Check unit test completed
+    runs-on: ubuntu-latest
+    steps:
+      - name: Wait for unit tests to checks
+        uses: ArcticLampyrid/[email protected]
+        with:
+          workflow: unit_tests.yml
+          sha: auto
 
   compute_changed_files:
     name: Compute changed files
-#    needs: check_unit_tests_completed
+    needs: check_unit_tests_completed
     runs-on: ubuntu-20.04
     outputs:
       matrix: ${{ steps.compute-file-matrix.outputs.matrix }}
@@ -247,12 +247,12 @@ jobs:
           CHANGED_FILES: ${{ env.CHANGED_FILES }}
         run: |
           echo "CHANGED FILES: $CHANGED_FILES"
-          bazel run //scripts:run_coverage -- $(pwd) $CHANGED_FILES --format=proto --processTimeout=15
+          bazel run //scripts:run_coverage -- $(pwd) $CHANGED_FILES --format=PROTO --processTimeout=15
 
       - name: Upload Coverage Report Artifact
         uses: actions/upload-artifact@v4
         with:
-          name: coverage-report-${{ env.SHARD_NAME }}
+          name: coverage-report-${{ env.SHARD_NAME }} # Saving with unique names to avoid conflict
           path: coverage_reports
 
   evaluate-code-coverage-reports:
@@ -341,6 +341,6 @@ jobs:
         if: ${{ needs.compute_changed_files.outputs.can_skip_files != 'true' && needs.code_coverage_run.result != 'success' }}
         run: exit 1
 
-      - name: Coverage Status pased
+      - name: Coverage status passed
         if: ${{ needs.evaluate-code-coverage-reports.result != 'success' }}
         run: exit 1
diff --git a/scripts/assets/test_file_exemptions.textproto b/scripts/assets/test_file_exemptions.textproto
@@ -1,7 +1,3 @@
-test_file_exemption {
-  exempted_file_path: "scripts/src/java/org/oppia/android/scripts/coverage/RunCoverage.kt"
-  test_file_not_required: true
-}
 test_file_exemption {
   exempted_file_path: "app/src/main/java/org/oppia/android/app/activity/ActivityComponent.kt"
   test_file_not_required: true

diff --git a/scripts/src/java/org/oppia/android/scripts/coverage/CoverageReporter.kt b/scripts/src/java/org/oppia/android/scripts/coverage/CoverageReporter.kt
@@ -25,6 +25,14 @@ const val BOLD = "\u001B[1m"
  * Usage:
  *    bazel run //scripts:coverage_runner -- <path_to_root> <list_of_relative_path_to_proto_files>
  *
+ * Arguments:
+ * - path_to_root: directory path to the root of the Oppia Android repository.
+ * - list_of_relative_path_to_proto_files: the list of relative path to the proto files
+ *     with coverage report data to analyse coverage.
+ *
+ * Example:
+ *     bazel run //scripts:coverage_reporter -- $(pwd) coverage_reports/utility/src/main/java \\
+ *     /org/oppia/android/util/parser/math/MathModel/coverage_report.pb
  */
 fun main(vararg args: String) {
   val repoRoot = args[0]

diff --git a/scripts/src/java/org/oppia/android/scripts/coverage/RunCoverage.kt b/scripts/src/java/org/oppia/android/scripts/coverage/RunCoverage.kt
@@ -19,7 +19,7 @@ import java.util.concurrent.TimeUnit
  * Entry point function for running coverage analysis for a source file.
  *
  * Usage:
- *    bazel run //scripts:run_coverage_for_test_target -- <path_to_root> <list_of_relative_path_to_files>
+ *    bazel run //scripts:run_coverage -- <path_to_root> <list_of_relative_path_to_files>
  *
  * Arguments:
  * - path_to_root: directory path to the root of the Oppia Android repository.