Merge pull request #31 from Chisanan232/develop

Chisanan232 · web-flow · commit 992ae3892bb0 · 2022-11-29T09:48:20.000+08:00
🔧⚙️🔩 [Breaking Change] (config) Modify the processing about test coverage report processing.
diff --git a/.coveragerc b/.coveragerc
@@ -2,9 +2,7 @@
 branch = True
 parallel = True
 source=./test_gh_workflow
+relative_files = True
 
 omit =
     */__init__.py
-
-[path]
-source=./test_gh_workflow
diff --git a/.github/workflows/organize_and_generate_test_cov_reports.yaml b/.github/workflows/organize_and_generate_test_cov_reports.yaml
@@ -22,8 +22,8 @@ on:
     inputs:
       test_type:
         description: "The testing type. In generally, it only has 2 options: 'unit-test' and 'integration-test'."
-        required: true
         type: string
+        required: true
 
 
 jobs:
@@ -49,33 +49,22 @@ jobs:
           python3 -m pip install --upgrade pip
           pip3 install -U pip
           pip3 install coverage
-          pip3 install codecov
-          pip3 install coveralls
-
-      - name: Combine all testing code coverage result files with one specific test type
-        if: ${{ inputs.test_type == 'unit-test' || inputs.test_type == 'integration-test' }}
-        run: coverage combine --data-file=.coverage.${{ inputs.test_type }} .coverage.${{ inputs.test_type }}.*
 
-      - name: Combine all testing code coverage result files with all test types
-        if: ${{ inputs.test_type == 'all-test' }}
-        run: coverage combine --data-file=.coverage.${{ inputs.test_type }} .coverage.*
-
-      - name: Report testing coverage of project code
-        run: coverage report -m --data-file=.coverage.${{ inputs.test_type }}
-
-      - name: General testing coverage report as XML format with ${{ inputs.test_type }}
-        run: coverage xml --data-file=.coverage.${{ inputs.test_type }} -o coverage_${{ inputs.test_type }}.xml
+      - name: Combine all testing coverage data files with test type and runtime OS, and convert to XML format file finally
+        run: |
+          curl https://raw.githubusercontent.com/Chisanan232/GitHub-Action_Workflow-Template-Python/develop/scripts/ci/combine_coverage_reports.sh --output ./scripts/ci/combine_coverage_reports.sh
+          bash ./scripts/ci/combine_coverage_reports.sh ${{ inputs.test_type }}
 
       - name: Upload testing coverage report (.coverage)
         uses: actions/upload-artifact@v3
         with:
-          name: test_coverage_report
-          path: .coverage.${{ inputs.test_type }}
+          name: test_coverage_data_file
+          path: .coverage
           if-no-files-found: error
 
       - name: Upload testing coverage report (.xml)
         uses: actions/upload-artifact@v3
         with:
           name: test_coverage_xml_report
-          path: coverage_${{ inputs.test_type }}.xml
+          path: coverage**xml
           if-no-files-found: error
diff --git a/.github/workflows/test_python_project_ci_multi-tests.yaml b/.github/workflows/test_python_project_ci_multi-tests.yaml
@@ -69,26 +69,18 @@ jobs:
       debug_mode: true
 
 
-  unit-test_codecov:
+  all-test_codecov:
 #    name: Organize and generate the testing report and upload it to Codecov
-    needs: run_unit-test
+    needs: [run_unit-test, run_integration-test]
     uses: ./.github/workflows/organize_and_generate_test_cov_reports.yaml
     with:
-      test_type: unit-test
-
-
-  integration-test_codecov:
-#    name: Organize and generate the testing report and upload it to Codecov
-    needs: run_integration-test
-    uses: ./.github/workflows/organize_and_generate_test_cov_reports.yaml
-    with:
-      test_type: integration-test
+      test_type: all-test
 
 
   codecov_finish:
 #    name: Organize and generate the testing report and upload it to Codecov
 #    if: github.ref_name == 'release' || github.ref_name == 'master'
-    needs: [unit-test_codecov, integration-test_codecov]
+    needs: [all-test_codecov]
     uses: ./.github/workflows/upload_test_cov_report.yaml
     secrets:
       codecov_token: ${{ secrets.CODECOV_TOKEN }}
@@ -102,7 +94,7 @@ jobs:
   coveralls_finish:
 #    name: Organize and generate the testing report and upload it to Coveralls
 #    if: github.ref_name == 'release' || github.ref_name == 'master'
-    needs: [unit-test_codecov, integration-test_codecov]
+    needs: [all-test_codecov]
     uses: ./.github/workflows/upload_test_cov_report.yaml
     secrets:
       coveralls_token: ${{ secrets.COVERALLS_TOKEN }}
@@ -113,7 +105,7 @@ jobs:
 
   codacy_finish:
 #    name: Upload test report to Codacy to analyse and record code quality
-    needs: [unit-test_codecov, integration-test_codecov]
+    needs: [all-test_codecov]
     uses: ./.github/workflows/upload_test_cov_report.yaml
     secrets:
       codacy_token: ${{ secrets.CODACY_PROJECT_TOKEN }}
@@ -136,7 +128,7 @@ jobs:
 
   build_git-tag_and_create_github-release:
 #    name: Build git tag and GitHub release if it needs
-    needs: [coveralls_finish, codacy_finish]
+    needs: [codecov_finish, coveralls_finish, codacy_finish]
     uses: ./.github/workflows/build_git-tag_and_create_github-release.yaml
     with:
       project_type: python-package
diff --git a/.github/workflows/test_python_project_ci_one-test.yaml b/.github/workflows/test_python_project_ci_one-test.yaml
@@ -53,18 +53,18 @@ jobs:
       test_type: unit-test
 
 
-#  codecov_finish:
-##    name: Organize and generate the testing report and upload it to Codecov
-##    if: github.ref_name == 'release' || github.ref_name == 'master'
-#    needs: [unit-test_codecov]
-#    uses: ./.github/workflows/upload_test_cov_report.yaml
-#    secrets:
-#      codecov_token: ${{ secrets.CODECOV_TOKEN }}
-#    with:
-#      test_type: unit-test
-#      upload-to-codecov: true
-#      codecov_flags: unit  # Required if 'upload-to-codecov' is true
-#      codecov_name: gh_workflow_template  # Required if 'upload-to-codecov' is true
+  codecov_finish:
+#    name: Organize and generate the testing report and upload it to Codecov
+#    if: github.ref_name == 'release' || github.ref_name == 'master'
+    needs: [unit-test_codecov]
+    uses: ./.github/workflows/upload_test_cov_report.yaml
+    secrets:
+      codecov_token: ${{ secrets.CODECOV_TOKEN }}
+    with:
+      test_type: unit-test
+      upload-to-codecov: true
+      codecov_flags: unit  # Required if 'upload-to-codecov' is true
+      codecov_name: gh_workflow_template  # Required if 'upload-to-codecov' is true
 
 
   coveralls_finish:
@@ -105,7 +105,7 @@ jobs:
 
   build_git-tag_and_create_github-release:
 #    name: Build git tag and GitHub release if it needs
-    needs: [coveralls_finish, codacy_finish]
+    needs: [coveralls_finish, codecov_finish, codacy_finish]
     uses: ./.github/workflows/build_git-tag_and_create_github-release.yaml
     with:
       project_type: python-package
diff --git a/.github/workflows/upload_test_cov_report.yaml b/.github/workflows/upload_test_cov_report.yaml
@@ -96,14 +96,12 @@ jobs:
           echo "Check the parameters of uploading report to Codacy ..."
           bash ./scripts/ci/check-input-params.sh ${{ inputs.upload-to-codacy }} ${{ secrets.codacy_token }}
 
-      # TODO: It's possible be better that open input parameter 'file_path' or 'download name' outside.
       - name: Download code coverage result files which has be handled by different test type process
         uses: actions/download-artifact@v3
         with:
-          name: test_coverage_report
+          name: test_coverage_data_file
           path: ${{ inputs.download_path }}
 
-      # TODO: It's possible be better that open input parameter 'file_path' or 'download name' outside.
       - name: Download code coverage result files which has be handled by different test type process
         uses: actions/download-artifact@v3
         with:
@@ -126,57 +124,32 @@ jobs:
         if: ${{ inputs.upload-to-codecov == true }}
         run: pip3 install codecov
 
-      - name: Upload coverage report to Codecov https://codecov.io (For Unit-Test or Integration-Test)
-        if: ${{ inputs.upload-to-codecov == true && (inputs.test_type == 'unit-test' || inputs.test_type == 'integration-test') }}
+      - name: Upload coverage report to Codecov https://codecov.io
+        if: ${{ inputs.upload-to-codecov == true }}
         run: |
           codecov \
             -t ${{ secrets.codecov_token }} \
             --file coverage_${{ inputs.test_type }}.xml \
             --flags ${{ inputs.codecov_flags }} \
             --env OS,PYTHON \
             --name ${{ inputs.codecov_name }} \
-            --verbose
-
-      - name: Upload coverage report to Codecov https://codecov.io (For all test types)
-        if: ${{ inputs.upload-to-codecov == true && inputs.test_type == 'all-test' }}
-        run: |
-          codecov \
-            -t ${{ secrets.codecov_token }} \
-            --file coverage_unit-test.xml \
-            --file coverage_integration-test.xml \
-            --flags ${{ inputs.codecov_flags }} \
-            --env OS,PYTHON \
-            --name ${{ inputs.codecov_name }} \
+            --required \
             --verbose
 
       - name: Install Python dependencies about tool of Coveralls
         if: ${{ inputs.upload-to-coveralls == true }}
-        run: |
-          pip3 install coveralls
-          pip3 install coverage
-
-      - name: Combine all testing code coverage result files with all test types
-        if: ${{ inputs.upload-to-coveralls == true }}
-        run: coverage combine .coverage.*
+        run: pip3 install coveralls
 
       - name: Upload coverage report to Coveralls https://coveralls.io
         if: ${{ inputs.upload-to-coveralls == true }}
         env:
           GITHUB_TOKEN: ${{ secrets.coveralls_token }}
         run: coveralls --verbose
 
-      - name: Upload testing report to Codacy https://app.codacy.com/ (For Unit-Test or Integration-Test)
-        if: ${{ inputs.upload-to-codacy == true && (inputs.test_type == 'unit-test' || inputs.test_type == 'integration-test') }}
+      - name: Upload testing report to Codacy https://app.codacy.com/
+        if: ${{ inputs.upload-to-codacy == true }}
         uses: codacy/codacy-coverage-reporter-action@v1
         with:
           project-token: ${{ secrets.codacy_token }}
           coverage-reports: coverage_${{ inputs.test_type }}.xml
 #          coverage-reports: cobertura.xml
-
-      - name: Upload testing report to Codacy https://app.codacy.com/ (For all test types)
-        if: ${{ inputs.upload-to-codacy == true && inputs.test_type == 'all-test' }}
-        uses: codacy/codacy-coverage-reporter-action@v1
-        with:
-          project-token: ${{ secrets.codacy_token }}
-          coverage-reports: coverage_unit-test.xml,coverage_integration-test.xml
-#          coverage-reports: cobertura.xml
diff --git a/scripts/ci/combine_coverage_reports.sh b/scripts/ci/combine_coverage_reports.sh
@@ -0,0 +1,22 @@
+#!/usr/bin/env bash
+
+set -ex
+
+test_type=$1
+
+coveragedatafile=".coverage.$test_type"
+
+if [ "$test_type" == "unit-test" ] || [ "$test_type" == "integration-test" ];
+then
+  coverage combine --data-file="$coveragedatafile" .coverage."$test_type".*
+elif [ "$test_type" == "all-test" ];
+then
+  coverage combine --data-file="$coveragedatafile" .coverage.*
+else
+  echo "❌ It doesn't support $test_type currently. Please change to use options 'unit-test', 'integration-test' or 'all-test'." && exit 1
+fi
+
+coverage report -m --data-file="$coveragedatafile"
+coverage xml --data-file="$coveragedatafile" -o coverage_"$test_type".xml
+cp "$coveragedatafile" .coverage
+echo "✅ All processing done." && exit 0
