Merge pull request #86 from Chisanan232/develop

[CU-86et1kvnd] Add end-to-end test for the working directory feature

Author: Chisanan232

.github/workflows/rw_get_tests.yaml

@@ -56,6 +56,7 @@ jobs:
 
       - name: Download shell script for getting path of all test modules
         if: ${{ inputs.use_customized_shell != true }}
+        working-directory: ${{ inputs.test_working_directory }}
         run: curl https://raw.githubusercontent.com/Chisanan232/GitHub-Action_Reusable_Workflows-Python/develop/scripts/ci/get-all-tests.sh --output ${{ inputs.shell_path }}
 
       - id: set-matrix

.github/workflows/rw_organize_test_cov_reports.yaml

@@ -5,6 +5,7 @@
 #
 # Workflow input parameters:
 #     * test_type: The testing type. In generally, it only has 2 options: 'unit-test' and 'integration-test'.
+#     * test_working_directory: The working directory for test running.
 #
 # Workflow running output:
 #     No, but it would save the testing coverage reports (coverage.xml) to provide after-process to organize and record.
@@ -24,6 +25,11 @@ on:
         description: "The testing type. In generally, it only has 2 options: 'unit-test' and 'integration-test'."
         type: string
         required: true
+      test_working_directory:
+        description: "The working directory for test running."
+        required: false
+        type: string
+        default: './'
 
 
 jobs:
@@ -37,7 +43,7 @@ jobs:
         uses: actions/download-artifact@v4
         with:
           pattern: coverage*
-          path: ./
+          path: ${{ inputs.test_working_directory }}
           merge-multiple: true
 
       - name: Setup Python 3.10 in Ubuntu OS
@@ -46,6 +52,7 @@ jobs:
           python-version: '3.10'
 
       - name: Install Python tool 'coverage'
+        working-directory: ${{ inputs.test_working_directory }}
         run: |
           python3 -m pip install --upgrade pip
           pip3 install -U pip
@@ -54,6 +61,7 @@ jobs:
           ls -la
 
       - name: Combine all testing coverage data files with test type and runtime OS, and convert to XML format file finally
+        working-directory: ${{ inputs.test_working_directory }}
         run: |
           curl https://raw.githubusercontent.com/Chisanan232/GitHub-Action_Reusable_Workflows-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 }} .coverage.
@@ -62,14 +70,14 @@ jobs:
         uses: actions/upload-artifact@v4
         with:
           name: ${{ inputs.test_type }}_coverage_data_file
-          path: .coverage
+          path: ${{ inputs.test_working_directory }}.coverage
           if-no-files-found: error
           include-hidden-files: true
 
       - name: Upload testing coverage report (.xml)
         uses: actions/upload-artifact@v4
         with:
           name: ${{ inputs.test_type }}_coverage_xml_report
-          path: coverage**xml
+          path: ${{ inputs.test_working_directory }}coverage**xml
           if-no-files-found: error
           include-hidden-files: true

.github/workflows/rw_poetry_run_test.yaml

@@ -149,6 +149,7 @@ jobs:
 
       - name: Setup and run HTTP server for testing
         if: ${{ inputs.setup_http_server == true }}
+        working-directory: ${{ inputs.test_working_directory }}
         run: gunicorn --bind ${{ inputs.http_server_host }}:${{ inputs.http_server_port }} '${{ inputs.http_server_app_module }}:${{ inputs.http_server_enter_point }}' --daemon
 
       - name: Test to send HTTP request to sample HTTP server
@@ -169,6 +170,6 @@ jobs:
         uses: actions/upload-artifact@v4
         with:
           name: coverage_${{ inputs.test_type }}_${{ inputs.runtime_os }}_${{ inputs.python_version }}
-          path: .coverage.${{ inputs.test_type }}.${{ inputs.runtime_os }}-${{ inputs.python_version }}
+          path: ${{ inputs.test_working_directory }}.coverage.${{ inputs.test_type }}.${{ inputs.runtime_os }}-${{ inputs.python_version }}
           if-no-files-found: error
           include-hidden-files: true

.github/workflows/rw_poetry_run_test_with_multi_py_versions.yaml

@@ -6,6 +6,7 @@
 #
 # Workflow input parameters:
 #     * test_type: The testing type. In generally, it only has 2 options: 'unit-test' and 'integration-test'.
+#     * test_working_directory: The working directory for test running.
 #     * install_dependency_with_group: Install the dependency by Poetry configuration with dependency group setting. This parameter receive the dependency group naming.
 #     * all_test_items_paths: The target paths of test items under test.
 #     * setup_http_server: If it's true, it would set up and run HTTP server for testing.
@@ -34,6 +35,11 @@ on:
         description: "The testing type. In generally, it only has 2 options: 'unit-test' and 'integration-test'."
         required: true
         type: string
+      test_working_directory:
+        description: "The working directory for test running."
+        required: false
+        type: string
+        default: './'
       install_dependency_with_group:
         description: "Install the dependency by Poetry configuration with dependency group setting. This parameter receive the dependency group naming."
         type: string
@@ -86,6 +92,7 @@ jobs:
       runtime_os: ${{ matrix.os }}
       python_version: ${{ matrix.python-version }}
       test_type: ${{ inputs.test_type }}
+      test_working_directory: ${{ inputs.test_working_directory }}
       install_dependency_with_group: ${{ inputs.install_dependency_with_group }}
       all_test_items_paths: ${{ inputs.all_test_items_paths }}
       setup_http_server: ${{ inputs.setup_http_server }}

.github/workflows/rw_upload_test_cov_report.yaml

@@ -7,6 +7,7 @@
 #     * General arguments:
 #         * download_path: The path to download testing coverage reports via 'actions/download-artifact@v3'.
 #         * test_type: The testing type. In generally, it only has 2 options: 'unit-test' and 'integration-test'.
+#         * test_working_directory: The working directory for test running.
 #         * upload-to-codecov: If it's true, it would upload testing coverage report for Codecov (https://codecov.io).
 #         * codecov_flags: The flags of the testing coverage report for Codecov. This option would be required if 'upload-to-codecov' is true.
 #         * codecov_name: The name of the testing coverage report for Codecov. This option would be required if 'upload-to-codecov' is true.
@@ -37,6 +38,11 @@ on:
         description: "The testing type. In generally, it only has 2 options: 'unit-test' and 'integration-test'."
         required: true
         type: string
+      test_working_directory:
+        description: "The working directory for test running."
+        required: false
+        type: string
+        default: './'
       upload-to-codecov:
         description: "If it's true, it would upload testing coverage report for Codecov (https://codecov.io)."
         type: boolean
@@ -156,6 +162,7 @@ jobs:
 
       - name: Upload coverage report to Coveralls https://coveralls.io
         if: ${{ inputs.upload-to-coveralls == true }}
+        working-directory: ${{ inputs.test_working_directory }}
         env:
           GITHUB_TOKEN: ${{ secrets.coveralls_token }}
         run: coveralls --verbose

.github/workflows/test_nested_pyproject_ci_multi-tests_by_poetry.yaml

@@ -0,0 +1,136 @@
+name: Nested Python project with Poetry CI Test (multi-tests)
+
+on:
+  pull_request:
+    branches:
+      - "develop**"
+      - "master"
+    paths:
+#     The workflow self.
+      - ".github/workflows/test_nested_pyproject_ci_multi-tests_by_poetry.yaml"
+#     The shell script only be used by this workflow.
+      - "nested_poetry_project/scripts/ci/check_getting_output.sh"
+#     The sample Python code.
+      - "nested_poetry_project/.coveragerc"
+      - "nested_poetry_project/pyproject.toml"
+      - "nested_poetry_project/poetry.lock"
+      - "nested_poetry_project/pytest.ini"
+      - "nested_poetry_project/nested_python_src/**"
+      - "nested_poetry_project/test/**"
+#     The shell scripts or actions this workflow would use.
+      - ".github/workflows/rw_get_tests.yaml"
+      - ".github/workflows/rw_poetry_run_test.yaml"
+      - ".github/workflows/rw_poetry_run_test_with_multi_py_versions.yaml"
+      - ".github/workflows/rw_organize_test_cov_reports.yaml"
+      - "nested_poetry_project/scripts/ci/combine_coverage_reports.sh"
+      - ".github/workflows/rw_upload_test_cov_report.yaml"
+      - "nested_poetry_project/scripts/ci/check-input-params.sh"
+      - ".github/workflows/rw_sonarqube_scan.yaml"
+      - ".github/workflows/rw_pre-building_test.yaml"
+      - ".github/workflows/rw_build_git-tag_and_create_github-release.yaml"
+      - "nested_poetry_project/scripts/ci/build_git-tag_or_create_github-release.sh"
+      - "nested_poetry_project/scripts/ci/deployment_new_version_workflow.sh"
+
+jobs:
+  prep-testbed_unit-test:
+#    name: Prepare all unit test items
+    uses: ./.github/workflows/rw_get_tests.yaml
+    with:
+      test_working_directory: './nested_poetry_project/'
+      shell_arg: test/unit_test/
+
+
+  prep-testbed_integration-test:
+#    name: Prepare all integration test items
+    uses: ./.github/workflows/rw_get_tests.yaml
+    with:
+      shell_path: ./scripts/ci/test/get-integration-test-paths.sh
+      shell_arg: unix
+      test_working_directory: './nested_poetry_project/'
+      use_customized_shell: true
+
+
+  run_unit-test:
+#    name: Run all unit test items
+    needs: prep-testbed_unit-test
+    uses: ./.github/workflows/rw_poetry_run_test.yaml
+    with:
+      test_type: unit-test
+      test_working_directory: './nested_poetry_project/'
+      install_dependency_with_group: github-action
+      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/rw_poetry_run_test_with_multi_py_versions.yaml
+    with:
+      test_type: integration-test
+      test_working_directory: './nested_poetry_project/'
+      install_dependency_with_group: github-action
+      all_test_items_paths: ${{needs.prep-testbed_integration-test.outputs.all_test_items}}
+      setup_http_server: true
+      http_server_host: 0.0.0.0
+      http_server_port: 30303
+      http_server_app_module: test._http_server.app
+      http_server_enter_point: app
+
+
+  all-test_codecov:
+#    name: Organize and generate the testing report and upload it to Codecov
+    if: ${{ !contains(github.event.pull_request.labels.*.name, 'dependencies') }}
+    needs: [run_unit-test, run_integration-test]
+    uses: ./.github/workflows/rw_organize_test_cov_reports.yaml
+    with:
+      test_type: all-test
+      test_working_directory: './nested_poetry_project/'
+
+
+  codecov_finish:
+#    name: Organize and generate the testing report and upload it to Codecov
+#    if: github.ref_name == 'release' || github.ref_name == 'master'
+    needs: [all-test_codecov]
+    uses: ./.github/workflows/rw_upload_test_cov_report.yaml
+    secrets:
+      codecov_token: ${{ secrets.CODECOV_TOKEN }}
+    with:
+      test_type: all-test
+      upload-to-codecov: true
+      codecov_flags: unit,integration  # Required if 'upload-to-codecov' is true
+      codecov_name: gh_workflow_template  # Required if 'upload-to-codecov' is true
+
+
+  coveralls_finish:
+#    name: Organize and generate the testing report and upload it to Coveralls
+#    if: github.ref_name == 'release' || github.ref_name == 'master'
+    needs: [all-test_codecov]
+    uses: ./.github/workflows/rw_upload_test_cov_report.yaml
+    secrets:
+      coveralls_token: ${{ secrets.COVERALLS_TOKEN }}
+    with:
+      test_type: all-test
+      test_working_directory: './nested_poetry_project/'
+      upload-to-coveralls: true
+
+
+  codacy_finish:
+#    name: Upload test report to Codacy to analyse and record code quality
+    needs: [all-test_codecov]
+    uses: ./.github/workflows/rw_upload_test_cov_report.yaml
+    secrets:
+      codacy_token: ${{ secrets.CODACY_PROJECT_TOKEN }}
+    with:
+      test_type: all-test
+      upload-to-codacy: true
+
+
+  sonarqube_finish:
+#    name: Trigger SoarQube service to scan and analyse project
+    needs: [all-test_codecov]
+    uses: ./.github/workflows/rw_sonarqube_scan.yaml
+    secrets:
+      sonar_token: ${{ secrets.SONAR_TOKEN }}
+    with:
+      test_type: all-test
+#      download_path: ${{ inputs.download_path }}

nested_poetry_project/.coveragerc

@@ -0,0 +1,7 @@
+[run]
+parallel = True
+relative_files = True
+include=./test_gh_workflow
+
+omit =
+    */__init__.py

nested_poetry_project/nested_python_src/__init__.py

@@ -0,0 +1 @@
+__version__ = "0.2.0-alpha1.post1"

nested_poetry_project/nested_python_src/__pkg_info__.py

@@ -0,0 +1,3 @@
+
+def hello_python() -> str:
+    return "Hello Python"