🎉🎊🍾 [New Feature] (config) Add sample code and configurations for testing workflows to ensure its functions.

.coveragerc

@@ -0,0 +1,11 @@
+# # This test directory for testing to simulate a Python library project structure.
+
+[run]
+parallel = True
+relative_files = True
+source=./test_gh_workflow
+
+omit =
+    */__init__.py
+
+#ignore_errors = True

.github/workflows/organize_all_testing_coverage_reports_with_different_os_and_py_version.yaml

@@ -24,12 +24,13 @@ on:
         type: string
       generate_xml_report_finally:
         description: "Something, it only has 1 test type currently. So it could let this option to be 'true' than it would generate XML report finally to let uploading process to use it directly."
-        required: true
         type: boolean
+        required: false
+        default: false
 
 
 jobs:
-  organize_and_generate_test_report:
+  organize_test_reports:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout
@@ -39,7 +40,7 @@ jobs:
         uses: actions/download-artifact@v3
         with:
           name: coverage
-          path: .coverage.${{ inputs.test_type }}*
+          path: ./
 
       - name: Setup Python 3.10 in Ubuntu OS
         uses: actions/setup-python@v2
@@ -58,26 +59,53 @@ jobs:
       - name: Report testing coverage of project code
         run: coverage report -m
 
+      - name: Upload testing coverage report
+        uses: actions/upload-artifact@v3
+        with:
+          name: project_testing_coverage_report_${{ inputs.test_type }}
+          path: .coverage
+          if-no-files-found: error
+
+  generate_final_test_report:
+    if: ${{ inputs.generate_xml_report_finally == true }}
+#    if: inputs.generate_xml_report_finally == 'true'
+    needs: organize_test_reports
+    runs-on: ubuntu-latest
+    steps:
+      - name: Download code coverage result file
+        uses: actions/download-artifact@v3
+        with:
+          name: project_testing_coverage_report_${{ inputs.test_type }}
+          path: ./
+
       - name: General testing coverage report as XML format
-        if: ${{ inputs.generate_xml_report_finally }} == 'true'
         run: coverage xml
 
-      - name: Rename the testing coverage report with test type
-        if: ${{ inputs.generate_xml_report_finally }} == 'false'
-        run: mv .coverage .coverage-${{ inputs.test_type }}
-
       - name: Upload testing coverage report
-        if: ${{ inputs.generate_xml_report_finally }} == 'true'
         uses: actions/upload-artifact@v3
         with:
           name: final_project_testing_coverage_report
           path: coverage.xml
           if-no-files-found: error
 
+  generate_test_type_report:
+    if: ${{ inputs.generate_xml_report_finally == false }}
+#    if: inputs.generate_xml_report_finally == 'false'
+    needs: organize_test_reports
+    runs-on: ubuntu-latest
+    steps:
+      - name: Download code coverage result file
+        uses: actions/download-artifact@v3
+        with:
+          name: project_testing_coverage_report_${{ inputs.test_type }}
+          path: ./
+
+      - name: Rename the testing coverage report with test type
+        run: mv .coverage .coverage-${{ inputs.test_type }}
+
       - name: Upload testing coverage report
-        if: ${{ inputs.generate_xml_report_finally }} == 'false'
         uses: actions/upload-artifact@v3
         with:
-          name: project_testing_coverage_report
+          name: new_project_testing_coverage_report_${{ inputs.test_type }}
           path: .coverage-${{ inputs.test_type }}
           if-no-files-found: error

.github/workflows/organize_all_testing_reports_with_different_test_type.yaml

@@ -27,8 +27,14 @@ jobs:
       - name: Download code coverage result file
         uses: actions/download-artifact@v3
         with:
-          name: project_testing_coverage_report
-          path: .coverage-*
+          name: new_project_testing_coverage_report_unit-test
+          path: ./
+
+      - name: Download code coverage result file
+        uses: actions/download-artifact@v3
+        with:
+          name: new_project_testing_coverage_report_integration-test
+          path: ./
 
       - name: Setup Python 3.10 in Ubuntu OS
         uses: actions/setup-python@v2

.github/workflows/test-reusable-workflows.yaml

@@ -0,0 +1,120 @@
+name: github-action reusable workflows test
+on:
+  push:
+    branches:
+      - "develop"
+      - "release"
+      - "release-**"
+      - "release/**"
+      - "master"
+    paths-ignore:
+      - ".gitcommitrules"
+      - ".gitignore"
+      - "LICENSE"
+      - "README.md"
+  pull_request:
+    branches:
+      - "develop"
+      - "release"
+      - "release-**"
+      - "release/**"
+    paths-ignore:
+      - ".gitcommitrules"
+      - ".gitignore"
+      - "LICENSE"
+      - "README.md"
+
+jobs:
+
+  prep-testbed_unit-test:
+#    name: Prepare all unit test items
+    uses: ./.github/workflows/prepare_test_items.yaml
+    with:
+      shell_path: scripts/ci/get-unit-test-paths.sh
+      shell_arg: unix
+
+
+  prep-testbed_integration-test:
+#    name: Prepare all integration test items
+    uses: ./.github/workflows/prepare_test_items.yaml
+    with:
+      shell_path: scripts/ci/get-integration-test-paths.sh
+      shell_arg: unix
+
+
+  run_unit-test:
+#    name: Run all unit test items
+    needs: prep-testbed_unit-test
+    uses: ./.github/workflows/run_test_items_via_pytest.yaml
+    with:
+      test_type: unit-test
+      all_test_items_paths: ${{needs.prep-testbed_unit-test.outputs.all_test_items}}
+
+
+  run_integration-test:
+#    name: Run all integration test items. This testing would test the code with other resource or system to ensure the features work finely.
+    needs: prep-testbed_integration-test
+    uses: ./.github/workflows/run_test_items_via_pytest.yaml
+    with:
+      test_type: integration-test
+      all_test_items_paths: ${{needs.prep-testbed_integration-test.outputs.all_test_items}}
+
+
+  unit-test_codecov:
+#    name: Organize and generate the testing report and upload it to Codecov
+    needs: run_unit-test
+    uses: ./.github/workflows/organize_all_testing_coverage_reports_with_different_os_and_py_version.yaml
+    with:
+      test_type: unit-test
+      generate_xml_report_finally: false
+
+
+  integration-test_codecov:
+#    name: Organize and generate the testing report and upload it to Codecov
+    needs: run_integration-test
+    uses: ./.github/workflows/organize_all_testing_coverage_reports_with_different_os_and_py_version.yaml
+    with:
+      test_type: integration-test
+      generate_xml_report_finally: false
+
+
+  organize_all-test_codecov_and_generate_report:
+#    name: Organize and generate the testing report and upload it to Codecov
+    needs: [unit-test_codecov, integration-test_codecov]
+    uses: ./.github/workflows/organize_all_testing_reports_with_different_test_type.yaml
+
+
+  codecov_finish:
+#    name: Organize and generate the testing report and upload it to Codecov
+    if: github.ref_name == 'release' || github.ref_name == 'master'
+    needs: organize_all-test_codecov_and_generate_report
+    uses: ./.github/workflows/upload_test_report_to_codecov.yaml
+    secrets:
+      codecov_token: ${{ secrets.CODECOV_TOKEN }}
+    with:
+      download_path: ./
+      codecov_flags: unit-test, integration-test
+      codecov_name: smoothcrawler-appintegration_github-actions_test # optional
+
+
+  codacy_finish:
+#    name: Upload test report to Codacy to analyse and record code quality
+    needs: [codecov_finish]
+    uses: ./.github/workflows/upload_code_report_to_codacy.yaml
+    secrets:
+      codacy_token: ${{ secrets.CODACY_PROJECT_TOKEN }}
+    with:
+      download_path: ./
+
+
+#  pre-building_check:
+##    name: Check about it could work finely by installing the Python package with setup.py file
+#    needs: [codecov_finish, codacy_finish]
+#    uses: Chisanan232/GitHub-Action-Template-Python/.github/workflows/upload_code_report_to_codacy.yaml
+#    with:
+#      python_package_name: smoothcrawler
+#      test_import_package_code_1: import smoothcrawler as mr
+#      test_import_package_code_2: from smoothcrawler.crawler import SimpleCrawler
+#      test_import_package_code_3: from smoothcrawler.components.data import BaseHTTPResponseParser, BaseDataHandler
+#      test_python_script: ./scripts/test_crawler.py
+

.gitignore

@@ -0,0 +1,11 @@
+# # This test directory for testing to simulate a Python library project structure.
+
+.DS_Store
+__pycache__
+.coverage
+.coverage.*
+.pypirc
+.pytest_cache/
+.python-version
+code_source/
+coverage.xml

codecov.yml

@@ -0,0 +1,4 @@
+# # This test directory for testing to simulate a Python library project structure.
+
+codecov:
+  token: $CODECOV_TOKEN

pytest.ini

@@ -0,0 +1,14 @@
+# # This test directory for testing to simulate a Python library project structure.
+
+# pytest.ini
+[pytest]
+minversion = 0.1.0
+
+addopts =
+    --cov=./test_gh_workflow
+    --cov-config=./.coveragerc
+    -r a
+    -v
+    --reruns 3
+
+testpaths =

requirements/requirements-test.txt

@@ -0,0 +1,11 @@
+###### SmoothCrawler-AppIntegration Development (or Testing) Dependencies Requirements ######
+## For running pytest ##
+pytest >= 7.0.0
+pytest-cov >= 3.0.0
+pytest-html >= 3.1.1
+pytest-rerunfailures >= 10.2
+
+## For calculating code coverage ##
+coverage >= 6.2    # In Python 3.6, its latest version supported is 6.2. But it supports 6.4 version in Python 3.10.
+codecov >= 2.1.12
+coveralls >= 3.3.1

requirements/requirements.txt

@@ -0,0 +1,2 @@
+###### SmoothCrawler-AppIntegration Dependencies Requirements ######
+## Code - Basic ##

scripts/ci/get-integration-test-paths.sh

@@ -0,0 +1,34 @@
+#!/usr/bin/env bash
+
+set -ex
+runtime_os=$1
+
+declare -a base_tests
+
+getalltests() {
+    declare -a testpatharray=( $(ls -F "$1" | grep -v '/$' | grep -v '__init__.py' | grep -v 'test_config.py' | grep -v -E '^_[a-z_]{1,64}.py' | grep -v '__pycache__'))
+
+    declare -a alltestpaths
+    for (( i = 0; i < ${#testpatharray[@]}; i++ )) ; do
+        alltestpaths[$i]=$1${testpatharray[$i]}
+    done
+
+    base_tests=("${alltestpaths[@]}")
+}
+
+base_path=test/integration_test/
+
+getalltests $base_path
+
+dest=( "${base_tests[@]}" )
+
+
+if echo "$runtime_os" | grep -q "windows";
+then
+    printf '%s\n' "${dest[@]}" | jq -R .
+elif echo "$runtime_os" | grep -q "unix";
+then
+    printf '%s\n' "${dest[@]}" | jq -R . | jq -cs .
+else
+    printf 'error' | jq -R .
+fi

scripts/ci/get-unit-test-paths.sh

@@ -0,0 +1,34 @@
+#!/usr/bin/env bash
+
+set -ex
+runtime_os=$1
+
+declare -a init_tests
+
+getalltests() {
+    declare -a testpatharray=( $(ls -F "$1" | grep -v '/$' | grep -v '__init__.py' | grep -v 'test_config.py' | grep -v -E '^_[a-z_]{1,64}.py' | grep -v '__pycache__'))
+
+    declare -a alltestpaths
+    for (( i = 0; i < ${#testpatharray[@]}; i++ )) ; do
+        alltestpaths[$i]=$1${testpatharray[$i]}
+    done
+
+    init_tests=("${alltestpaths[@]}")
+}
+
+init_path=test/unit_test/
+
+getalltests $init_path
+
+dest=( "${init_tests[@]}" )
+
+
+if echo "$runtime_os" | grep -q "windows";
+then
+    printf "${dest[@]}" | jq -R .
+elif echo "$runtime_os" | grep -q "unix";
+then
+    printf '%s\n' "${dest[@]}" | jq -R . | jq -cs .
+else
+    printf 'error' | jq -R .
+fi