use python script to replace part of shell script

Author: BHznJNs

.github/workflows/test.yml

@@ -0,0 +1,23 @@
+name: Run Tests
+
+on:
+  push:
+    branches: [ main, master ]
+  pull_request:
+    branches: [ main, master ]
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v4
+
+    - name: Set up Python
+      uses: actions/setup-python@v5
+      with:
+        python-version: "3.13"
+
+    - name: Run tests
+      run: |
+        python -m unittest tests.test_copy_files

.gitignore

@@ -0,0 +1,2 @@
+.vscode/
+__pycache__/

action.yml

@@ -102,42 +102,10 @@ runs:
         rm -rf pystand
 
     - name: Copy Sources and Assets to Build directory
-      shell: bash
-      run: |
-        set -e
-        build_path="${{ steps.init-build-directory.outputs.build-directory }}"
-
-        # resolves multi-line input of GitHub Actions
-        process_input() {
-          local input="$1"
-          # remove return symbol, split by line, trim spaces
-          echo "$input" | tr -d '\r' | sed -e 's/^[[:space:]]*//' -e 's/[[:space:]]*$//' | grep -v '^$'
-        }
-
-        ITEMS=()
-        while IFS= read -r line; do
-          [[ -n "$line" ]] && ITEMS+=("$line")
-        done < <(process_input "${{ inputs.included-files }}")
-
-        echo "=== Processed Items ==="
-        printf 'Item: "%s"\n' "${ITEMS[@]}"
-        echo "=== End Processed Items ==="
-
-        for item in "${ITEMS[@]}"; do
-          echo "Processing: $item"
-          
-          if [ ! -e "$item" ]; then
-            echo "::warning file=$item::Item does not exist, skipped."
-            continue
-          fi
-          
-          if [ -d "$item" ]; then
-            cp -rv "$item" "$build_path/"
-          elif [ -f "$item" ]; then
-            cp -v -- "$item" "$build_path/"
-          else
-            echo "::warning file=$item::Item is not a regular file or directory, skipped."
-          fi
-        done
-
-        cp "${{ inputs.pystand-entry-file }}" "$build_path/${{ inputs.application-name }}.py"
+      id: copy-sources
+      run: python scripts/copy_files.py
+      env:
+        BUILD_PATH: ${{ steps.init-build-directory.outputs.build-directory }}
+        INCLUDED_FILES: ${{ inputs.included-files }}
+        PYSTAND_ENTRY_FILE: ${{ inputs.pystand-entry-file }}
+        APPLICATION_NAME: ${{ inputs.application-name }}

scripts/copy_files.py

@@ -0,0 +1,61 @@
+import os
+import sys
+import shutil
+
+def process_input(input_str: str) -> list[str]:
+    """
+    Resolves the multi-line inputs from GitHub Actions
+    """
+    if not input_str:
+        return []
+    # filters empty lines, strips the spaces for every lines
+    return [line.strip() for line in input_str.splitlines() if line.strip()]
+
+def main():
+    try:
+        build_path = os.environ['BUILD_PATH']
+        included_files_str = os.environ.get('INCLUDED_FILES', '')
+        entry_file = os.environ['PYSTAND_ENTRY_FILE']
+        app_name = os.environ['APPLICATION_NAME']
+    except KeyError as e:
+        print("Environment variable missing: ", e)
+        sys.exit(1)
+
+    items_to_copy = process_input(included_files_str)
+
+    print("=== Processed Items ===")
+    for item in items_to_copy:
+        print(f'Item: "{item}"')
+    print("=== End Processed Items ===")
+
+    try:
+        for item in items_to_copy:
+            print(f"Processing: {item}")
+            if not os.path.exists(item):
+                print(f"::warning file={item}::Item does not exist, skipped.")
+                continue
+
+            if os.path.isdir(item):
+                # Copies the source directory 'item' to the directory under the build dir with the name name.
+                # For example, copies 'src/assets' to 'build_path/assets/'
+                target_dir_path = os.path.join(build_path, os.path.basename(item))
+                print(f"Copying directory '{item}' to '{target_dir_path}'")
+                shutil.copytree(item, target_dir_path, dirs_exist_ok=True)
+            elif os.path.isfile(item):
+                print(f"Copying file '{item}' to '{build_path}'")
+                shutil.copy2(item, build_path)
+            else:
+                print(f"::warning file={item}::Item is not a regular file or directory, skipped.")
+
+        # copy and rename PyStand entry file
+        entry_dest = os.path.join(build_path, f"{app_name}.py")
+        print(f"Copying entry file '{entry_file}' to '{entry_dest}'")
+        shutil.copy2(entry_file, entry_dest)
+
+        print("=== All items processed successfully! ===")
+    except Exception as e:
+        print(f"::error::An unexpected error occurred: {e}")
+        sys.exit(1)
+
+if __name__ == "__main__":
+    main()

tests/test_copy_files.py

@@ -0,0 +1,101 @@
+import unittest
+import os
+import shutil
+import tempfile
+import sys
+from unittest.mock import patch, ANY
+
+sys.path.insert(0, os.path.abspath(os.path.join(os.path.dirname(__file__), '..', 'scripts')))
+from copy_files import process_input, main
+
+class TestCopyFiles(unittest.TestCase):
+
+    def setUp(self):
+        # 创建一个临时目录作为测试环境
+        self.test_dir = tempfile.mkdtemp()
+        self.build_dir = os.path.join(self.test_dir, 'build')
+        os.makedirs(self.build_dir)
+        self.source_dir = os.path.join(self.test_dir, 'source')
+        os.makedirs(self.source_dir)
+
+        # 创建一些测试文件和目录
+        self.test_file1 = os.path.join(self.source_dir, 'file1.txt')
+        self.test_file2 = os.path.join(self.source_dir, 'file2.py')
+        self.test_subdir = os.path.join(self.source_dir, 'subdir')
+        os.makedirs(self.test_subdir)
+        self.test_subfile = os.path.join(self.test_subdir, 'subfile.txt')
+
+        with open(self.test_file1, 'w') as f:
+            f.write('This is file1.')
+        with open(self.test_file2, 'w') as f:
+            f.write('print("This is file2.")')
+        with open(self.test_subfile, 'w') as f:
+            f.write('This is a subfile.')
+
+    def tearDown(self):
+        # 清理临时目录
+        shutil.rmtree(self.test_dir)
+
+    def test_process_input_empty(self):
+        self.assertEqual(process_input(''), [])
+
+    def test_process_input_single_line(self):
+        self.assertEqual(process_input('file.txt'), ['file.txt'])
+
+    def test_process_input_multiple_lines(self):
+        input_str = 'file1.txt\nfile2.py\n  spaced_file.txt  \n\n'
+        expected = ['file1.txt', 'file2.py', 'spaced_file.txt']
+        self.assertEqual(process_input(input_str), expected)
+
+    @patch('sys.exit')
+    @patch('builtins.print')
+    def test_main_missing_env_var(self, mock_print, mock_exit):
+        with patch.dict(os.environ, {}, clear=True):
+            main()
+            mock_exit.assert_called_once_with(1)
+            mock_print.assert_any_call(ANY) # Check for any error message
+
+    @patch('builtins.print')
+    def test_main_copy_operations(self, mock_print):
+        with patch.dict(os.environ, {
+            'BUILD_PATH': self.build_dir,
+            'INCLUDED_FILES': f'{self.test_file1}\n{self.test_subdir}\nnon_existent_file.txt',
+            'PYSTAND_ENTRY_FILE': self.test_file2,
+            'APPLICATION_NAME': 'my_app'
+        }):
+            # 确保在测试前 build_dir 是空的
+            for item in os.listdir(self.build_dir):
+                shutil.rmtree(os.path.join(self.build_dir, item)) if os.path.isdir(os.path.join(self.build_dir, item)) else os.remove(os.path.join(self.build_dir, item))
+
+            main()
+
+            # 检查文件和目录是否被复制
+            self.assertTrue(os.path.exists(os.path.join(self.build_dir, 'file1.txt')))
+            self.assertTrue(os.path.isdir(os.path.join(self.build_dir, 'subdir')))
+            self.assertTrue(os.path.exists(os.path.join(self.build_dir, 'subdir', 'subfile.txt')))
+            self.assertTrue(os.path.exists(os.path.join(self.build_dir, 'my_app.py')))
+
+            # 检查警告信息
+            print_args_list = [call_args[0][0] for call_args in mock_print.call_args_list]
+            self.assertTrue(any("Item does not exist, skipped." in args for args in print_args_list))
+            self.assertTrue(any("non_existent_file.txt" in args for args in print_args_list))
+
+    @patch('builtins.print')
+    def test_main_only_entry_file(self, mock_print):
+        with patch.dict(os.environ, {
+            'BUILD_PATH': self.build_dir,
+            'INCLUDED_FILES': '',
+            'PYSTAND_ENTRY_FILE': self.test_file1,
+            'APPLICATION_NAME': 'app_with_no_includes'
+        }):
+            # 确保在测试前 build_dir 是空的
+            for item in os.listdir(self.build_dir):
+                shutil.rmtree(os.path.join(self.build_dir, item)) if os.path.isdir(os.path.join(self.build_dir, item)) else os.remove(os.path.join(self.build_dir, item))
+
+            main()
+            self.assertTrue(os.path.exists(os.path.join(self.build_dir, 'app_with_no_includes.py')))
+            self.assertFalse(os.path.exists(os.path.join(self.build_dir, 'file1.txt')))
+
+
+if __name__ == '__main__':
+    unittest.main()