Merge pull request #44 from Chisanan232/develop

Chisanan232 · web-flow · commit 0be94422e8d5 · 2023-10-19T09:42:03.000+08:00
🔬🧪🧬 [Refactor] Automating getting test module paths.
diff --git a/.github/workflows/prepare_test_items.yaml b/.github/workflows/prepare_test_items.yaml
@@ -6,6 +6,7 @@
 # Workflow input parameters:
 #     * shell_path: The file path of shell script which gets all the test items.
 #     * shell_arg: The arguments of the shell script which gets all the test items.
+#     * use_customized_shell: Don't use the shell script template project prepares, run customized shell script.
 #
 # Workflow running output:
 #     Yes, it has running result output. The output is the paths of all test items.
@@ -19,12 +20,18 @@ on:
     inputs:
       shell_path:
         description: "The file path of shell script which gets all the test items."
-        required: true
+        required: false
         type: string
+        default: './scripts/ci/get-all-tests.sh'
       shell_arg:
         description: "The arguments of the shell script which gets all the test items."
         required: true
         type: string
+      use_customized_shell:
+        description: "If it's true, it wouldn't download the shell script and use the value of argument *shell_path* directly as shell script path to run."
+        type: boolean
+        required: false
+        default: false
     outputs:
       all_test_items:
         description: "The output string about all test items it needs to run."
@@ -40,6 +47,11 @@ jobs:
       matrix: ${{ steps.set-matrix.outputs.all_test_items }}
     steps:
       - uses: actions/checkout@v3
+
+      - name: Download shell script for getting path of all test modules
+        if: ${{ inputs.use_customized_shell != true }}
+        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
         run: |
           sudo apt-get install jq
diff --git a/.github/workflows/test_pyproject_ci_multi-tests_by_poetry.yaml b/.github/workflows/test_pyproject_ci_multi-tests_by_poetry.yaml
@@ -32,8 +32,7 @@ jobs:
 #    name: Prepare all unit test items
     uses: ./.github/workflows/prepare_test_items.yaml
     with:
-      shell_path: scripts/ci/test/get-unit-test-paths.sh
-      shell_arg: unix
+      shell_arg: test/unit_test/
 
 
   prep-testbed_integration-test:
@@ -42,6 +41,7 @@ jobs:
     with:
       shell_path: scripts/ci/test/get-integration-test-paths.sh
       shell_arg: unix
+      use_customized_shell: true
 
 
   run_unit-test:
diff --git a/.github/workflows/test_python_project_ci_multi-tests.yaml b/.github/workflows/test_python_project_ci_multi-tests.yaml
@@ -34,8 +34,7 @@ jobs:
 #    name: Prepare all unit test items
     uses: ./.github/workflows/prepare_test_items.yaml
     with:
-      shell_path: scripts/ci/test/get-unit-test-paths.sh
-      shell_arg: unix
+      shell_arg: test/unit_test/
 
 
   prep-testbed_integration-test:
@@ -44,6 +43,7 @@ jobs:
     with:
       shell_path: scripts/ci/test/get-integration-test-paths.sh
       shell_arg: unix
+      use_customized_shell: true
 
 
   run_unit-test:
diff --git a/.github/workflows/test_python_project_ci_one-test.yaml b/.github/workflows/test_python_project_ci_one-test.yaml
@@ -33,8 +33,7 @@ jobs:
 #    name: Prepare all unit test items
     uses: ./.github/workflows/prepare_test_items.yaml
     with:
-      shell_path: scripts/ci/test/get-unit-test-paths.sh
-      shell_arg: unix
+      shell_arg: test/unit_test/
 
 
   run_unit-test:
diff --git a/scripts/ci/get-all-tests.sh b/scripts/ci/get-all-tests.sh
@@ -0,0 +1,94 @@
+#!/usr/bin/env bash
+
+set -ex
+
+base_directory=$1
+if [ "$base_directory" == "" ];
+then
+    base_directory="test/"
+fi
+
+runtime_os=$2
+if [ "$runtime_os" == "" ];
+then
+    runtime_os="unix"
+fi
+
+declare -a all_test_subpkgs=( "$base_directory" )
+
+get_all_test_subpackage() {
+    # Get all test directories (python subpackage)
+    # Note: use dept-first search algorithm
+    declare index=0
+    if [ "$1" ];
+    then
+        index=$1
+    fi
+
+    declare test_subpkg="${all_test_subpkgs[$index]}"
+    if [ "$test_subpkg" != "" ];
+    then
+        # Still has test subpackage won't scan
+        declare test_path="$test_subpkg*/"
+        declare -a test_subpkg_array=( $(ls -d "$test_path" | grep -v '__pycache__') )
+
+        if [ ${#test_subpkg_array[@]} != 0 ];
+        then
+            # No any directory under this path, try to get the test modules
+            all_test_subpkgs+=( "${test_subpkg_array[@]}" )
+            # shellcheck disable=SC2004
+            get_all_test_subpackage $(( $index + 1 ))
+        else
+            # Has some directories under this path, keep searching
+            if [ ${#all_test_subpkgs[@]} != "$index" ];
+            then
+                # shellcheck disable=SC2004
+                get_all_test_subpackage $(( $index + 1 ))
+            fi
+        fi
+    fi
+}
+
+declare all_tests
+
+get_all_test_modules_under_subpkg() {
+    # Get all test modules with one specific subpackage (directory has __init__.py file)
+    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 test_module_path in "${testpatharray[@]}";
+    do
+        alltestpaths+=("$1$test_module_path")
+    done
+
+    # shellcheck disable=SC2124
+    # shellcheck disable=SC2178
+    all_tests+="${alltestpaths[@]} "
+}
+
+get_all_test_modules() {
+    # Get all test modules under these test subpackages
+    for test_subpkg in "${all_test_subpkgs[@]}";
+    do
+        get_all_test_modules_under_subpkg "$test_subpkg"
+    done
+}
+
+# Get all test module paths
+get_all_test_subpackage
+get_all_test_modules
+
+# Process data as list type value
+dest=( "${all_tests[@]}" )
+
+
+# Output the final result about all test modules
+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
diff --git a/scripts/ci/test/get-unit-test-paths.sh b/scripts/ci/test/get-unit-test-paths.sh
diff --git a/test/unit_test/subpkg_1/__init__.py b/test/unit_test/subpkg_1/__init__.py
diff --git a/test/unit_test/subpkg_1/sample_one_layer.py b/test/unit_test/subpkg_1/sample_one_layer.py
@@ -0,0 +1,15 @@
+import test_gh_workflow.sample
+import logging
+import pytest
+
+
+@pytest.fixture(scope="function")
+def get_hello_python() -> str:
+    return test_gh_workflow.sample.hello_python()
+
+
+def test_sample(get_hello_python: str) -> None:
+    logging.info("Start Unit test.")
+    assert get_hello_python == "Hello Python", "The return value should be 'Hello Python'."
+    logging.info("This is Unit test done.")
+
diff --git a/test/unit_test/subpkg_1/sample_one_layer_2.py b/test/unit_test/subpkg_1/sample_one_layer_2.py
@@ -0,0 +1,15 @@
+import test_gh_workflow.sample
+import logging
+import pytest
+
+
+@pytest.fixture(scope="function")
+def get_hello_python() -> str:
+    return test_gh_workflow.sample.hello_python()
+
+
+def test_sample(get_hello_python: str) -> None:
+    logging.info("Start Unit test.")
+    assert get_hello_python == "Hello Python", "The return value should be 'Hello Python'."
+    logging.info("This is Unit test done.")
+
diff --git a/test/unit_test/subpkg_2/__init__.py b/test/unit_test/subpkg_2/__init__.py
diff --git a/test/unit_test/subpkg_2/sample_2_layer.py b/test/unit_test/subpkg_2/sample_2_layer.py
@@ -0,0 +1,15 @@
+import test_gh_workflow.sample
+import logging
+import pytest
+
+
+@pytest.fixture(scope="function")
+def get_hello_python() -> str:
+    return test_gh_workflow.sample.hello_python()
+
+
+def test_sample(get_hello_python: str) -> None:
+    logging.info("Start Unit test.")
+    assert get_hello_python == "Hello Python", "The return value should be 'Hello Python'."
+    logging.info("This is Unit test done.")
+
diff --git a/test/unit_test/subpkg_2/sample_2_layer_2.py b/test/unit_test/subpkg_2/sample_2_layer_2.py
@@ -0,0 +1,15 @@
+import test_gh_workflow.sample
+import logging
+import pytest
+
+
+@pytest.fixture(scope="function")
+def get_hello_python() -> str:
+    return test_gh_workflow.sample.hello_python()
+
+
+def test_sample(get_hello_python: str) -> None:
+    logging.info("Start Unit test.")
+    assert get_hello_python == "Hello Python", "The return value should be 'Hello Python'."
+    logging.info("This is Unit test done.")
+
diff --git a/test/unit_test/subpkg_2/sample_2_layer_3.py b/test/unit_test/subpkg_2/sample_2_layer_3.py
@@ -0,0 +1,15 @@
+import test_gh_workflow.sample
+import logging
+import pytest
+
+
+@pytest.fixture(scope="function")
+def get_hello_python() -> str:
+    return test_gh_workflow.sample.hello_python()
+
+
+def test_sample(get_hello_python: str) -> None:
+    logging.info("Start Unit test.")
+    assert get_hello_python == "Hello Python", "The return value should be 'Hello Python'."
+    logging.info("This is Unit test done.")
+
diff --git a/test/unit_test/subpkg_2/subpkg_2-1/__init__.py b/test/unit_test/subpkg_2/subpkg_2-1/__init__.py
diff --git a/test/unit_test/subpkg_2/subpkg_2-1/sample_2-1_layer.py b/test/unit_test/subpkg_2/subpkg_2-1/sample_2-1_layer.py
@@ -0,0 +1,15 @@
+import test_gh_workflow.sample
+import logging
+import pytest
+
+
+@pytest.fixture(scope="function")
+def get_hello_python() -> str:
+    return test_gh_workflow.sample.hello_python()
+
+
+def test_sample(get_hello_python: str) -> None:
+    logging.info("Start Unit test.")
+    assert get_hello_python == "Hello Python", "The return value should be 'Hello Python'."
+    logging.info("This is Unit test done.")
+
diff --git a/test/unit_test/subpkg_2/subpkg_2-1/subpkg_2-1-1/__init__.py b/test/unit_test/subpkg_2/subpkg_2-1/subpkg_2-1-1/__init__.py
diff --git a/test/unit_test/subpkg_2/subpkg_2-1/subpkg_2-1-1/sample_2-1-1_layer.py b/test/unit_test/subpkg_2/subpkg_2-1/subpkg_2-1-1/sample_2-1-1_layer.py
@@ -0,0 +1,15 @@
+import test_gh_workflow.sample
+import logging
+import pytest
+
+
+@pytest.fixture(scope="function")
+def get_hello_python() -> str:
+    return test_gh_workflow.sample.hello_python()
+
+
+def test_sample(get_hello_python: str) -> None:
+    logging.info("Start Unit test.")
+    assert get_hello_python == "Hello Python", "The return value should be 'Hello Python'."
+    logging.info("This is Unit test done.")
+
diff --git a/test/unit_test/subpkg_2/subpkg_2-1/subpkg_2-1-1/sample_2-1-1_layer_2.py b/test/unit_test/subpkg_2/subpkg_2-1/subpkg_2-1-1/sample_2-1-1_layer_2.py
@@ -0,0 +1,15 @@
+import test_gh_workflow.sample
+import logging
+import pytest
+
+
+@pytest.fixture(scope="function")
+def get_hello_python() -> str:
+    return test_gh_workflow.sample.hello_python()
+
+
+def test_sample(get_hello_python: str) -> None:
+    logging.info("Start Unit test.")
+    assert get_hello_python == "Hello Python", "The return value should be 'Hello Python'."
+    logging.info("This is Unit test done.")
+
