src/python_testing/execute_python_tests.py

#
#    Copyright (c) 2024 Project CHIP Authors
#    All rights reserved.
#
#    Licensed under the Apache License, Version 2.0 (the "License");
#    you may not use this file except in compliance with the License.
#    You may obtain a copy of the License at
#
#        http://www.apache.org/licenses/LICENSE-2.0
#
#    Unless required by applicable law or agreed to in writing, software
#    distributed under the License is distributed on an "AS IS" BASIS,
#    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
#    See the License for the specific language governing permissions and
#    limitations under the License.
#

import argparse
import glob
import os
import subprocess

# Function to load --app argument environment variables from a file


def load_env_from_yaml(file_path):
    """
    Load environment variables from the specified YAML file.

    The YAML file contains key-value pairs that define --app environment variables
    required for the test scripts to run. These variables configurations needed during the test execution.

    This function reads the YAML file and sets the environment variables
    in the current process's environment using os.environ.

    Args:
        file_path (str): The path to the YAML file containing the environment variables.
    """
    with open(file_path, 'r') as file:
        for line in file:
            if line.strip():  # Skip empty lines
                key, value = line.strip().split(': ', 1)
                os.environ[key] = value


def main(search_directory, env_file):
    # Determine the root directory of the CHIP project
    chip_root = os.path.abspath(os.path.join(os.path.dirname(__file__), '..', '..'))

    # Load environment variables from the specified file
    load_env_from_yaml(env_file)

    # Define the base command to run tests
    base_command = os.path.join(chip_root, "scripts/tests/run_python_test.py")

    # Define the files and patterns to exclude
    excluded_patterns = {
        "MinimalRepresentation.py",
        "TC_CNET_4_4.py",
        "TC_CCTRL_2_1.py",
        "TC_CCTRL_2_2.py",
        "TC_CCTRL_2_3.py",
        "TC_DGGEN_3_2.py",
        "TC_EEVSE_Utils.py",
        "TC_ECOINFO_2_1.py",
        "TC_ECOINFO_2_2.py",
        "TC_EWATERHTRBase.py",
        "TC_EWATERHTR_2_1.py",
        "TC_EWATERHTR_2_2.py",
        "TC_EWATERHTR_2_3.py",
        "TC_EnergyReporting_Utils.py",
        "TC_OpstateCommon.py",
        "TC_pics_checker.py",
        "TC_TMP_2_1.py",
        "TC_MCORE_FS_1_1.py",
        "TC_MCORE_FS_1_2.py",
        "TC_MCORE_FS_1_3.py",
        "TC_MCORE_FS_1_4.py",
        "TC_MCORE_FS_1_5.py",
        "TC_OCC_3_1.py",
        "TC_OCC_3_2.py",
        "TC_BRBINFO_4_1.py",
        "TestCommissioningTimeSync.py",
        "TestConformanceSupport.py",
        "TestChoiceConformanceSupport.py",
        "TC_DEMTestBase.py",
        "choice_conformance_support.py",
        "TestConformanceTest.py",  # Unit test of the conformance test (TC_DeviceConformance) - does not run against an app.
        "TestIdChecks.py",
        "TestSpecParsingDeviceType.py",
        "TestConformanceTest.py",
        "TestMatterTestingSupport.py",
        "TestSpecParsingSupport.py",
        "TestTimeSyncTrustedTimeSource.py",
        "basic_composition_support.py",
        "conformance_support.py",
        "drlk_2_x_common.py",
        "execute_python_tests.py",
        "global_attribute_ids.py",
        "hello_external_runner.py",
        "hello_test.py",
        "matter_testing_support.py",
        "pics_support.py",
        "spec_parsing_support.py",
        "taglist_and_topology_test_support.py",
        "test_plan_support.py",
        "test_plan_table_generator.py"
    }

    """
    Explanation for excluded files:
    The above list of files are excluded from the tests as they are either not app-specific tests
    or are run through a different block of tests mentioned in tests.yaml.
    This is to ensure that only relevant test scripts are executed, avoiding redundancy and ensuring
    the correctness of the test suite.
    """

    # Get all .py files in the directory
    all_python_files = glob.glob(os.path.join(search_directory, "*.py"))

    # Filter out the files matching the excluded patterns
    python_files = [file for file in all_python_files if os.path.basename(file) not in excluded_patterns]

    # Run each script with the base command
    for script in python_files:
        full_command = f"{base_command} --load-from-env {env_file} --script {script}"
        print(f"Running command: {full_command}")
        subprocess.run(full_command, shell=True, check=True)


if __name__ == "__main__":
    parser = argparse.ArgumentParser(description="Run Python test scripts.")
    parser.add_argument("--search-directory", type=str, default="src/python_testing",
                        help="Directory to search for Python scripts.")
    parser.add_argument("--env-file", type=str, default="/tmp/test_env.yaml", help="Path to the environment variables file.")

    args = parser.parse_args()
    main(args.search_directory, args.env_file)