Skip to content

Commit

Permalink
Updates comments for the excluded python test scripts based on their …
Browse files Browse the repository at this point in the history 
…current status in the CI pipeline (project-chip#35660)

* Script updated with comments on why the scripts have been included from the glob run

* Restyled by autopep8

* Removed exclusion test script explanation

* Fixed comments on the test scripts

* Fix excluded scripts for adding support scripts still in the directory

---------

Co-authored-by: Restyled.io <[email protected]>
  • Loading branch information
@vatsalghelani-csa @restyled-commits
vatsalghelani-csa and restyled-commits authored Sep 19, 2024
1 parent 00d755c commit 12f04dc
Showing 1 changed file with 47 additions and 57 deletions.
104 changes: 47 additions & 57 deletions src/python_testing/execute_python_tests.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -55,66 +55,56 @@ def main(search_directory, env_file):

# 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",
"MinimalRepresentation.py", # Code/Test not being used or not shared code for any other tests
"TC_CNET_4_4.py", # It has no CI execution block, is not executed in CI
"TC_CCTRL_2_1.py", # They rely on example applications that inter-communicate and there is no example app that works right now
"TC_CCTRL_2_2.py", # They rely on example applications that inter-communicate and there is no example app that works right now
"TC_CCTRL_2_3.py", # They rely on example applications that inter-communicate and there is no example app that works right now
"TC_DGGEN_3_2.py", # src/python_testing/test_testing/test_TC_DGGEN_3_2.py is the Unit test of this test
"TC_EEVSE_Utils.py", # Shared code for TC_EEVSE, not a standalone test
"TC_ECOINFO_2_1.py", # They rely on example applications that inter-communicate and there is no example app that works right now
"TC_ECOINFO_2_2.py", # They rely on example applications that inter-communicate and there is no example app that works right now
"TC_EWATERHTRBase.py", # Shared code for TC_EWATERHTR, not a standalone test
"TC_EnergyReporting_Utils.py", # Shared code for TC_EEM and TC_EPM, not a standalone test
"TC_OpstateCommon.py", # Shared code for TC_OPSTATE, not a standalone test
"TC_pics_checker.py", # Currently isn't enabled because we don't have any examples with conformant PICS
"TC_TMP_2_1.py", # src/python_testing/test_testing/test_TC_TMP_2_1.py is the Unit test of this test
"TC_MCORE_FS_1_1.py", # This test requires a TH_SERVER application, hence not ready run with CI
"TC_MCORE_FS_1_2.py", # This test requires a TH_SERVER application, hence not ready run with CI
"TC_MCORE_FS_1_3.py", # This test requires a TH_SERVER application, hence not ready run with CI
"TC_MCORE_FS_1_4.py", # This test requires a TH_SERVER application, hence not ready run with CI
"TC_MCORE_FS_1_5.py", # This test requires a TH_SERVER application, hence not ready run with CI
"TC_OCC_3_1.py", # There are CI issues for the test cases that implements manually controlling sensor device for the occupancy state ON/OFF change
"TC_OCC_3_2.py", # There are CI issues for the test cases that implements manually controlling sensor device for the occupancy state ON/OFF change
"TC_BRBINFO_4_1.py", # This test requires a TH_ICD_SERVER application, hence not ready run with CI
"TestCommissioningTimeSync.py", # Code/Test not being used or not shared code for any other tests
"TestConformanceSupport.py", # Unit test - does not run against an app
"TestChoiceConformanceSupport.py", # Unit test - does not run against an app
"TC_DEMTestBase.py", # Shared code for TC_DEM, not a standalone test
"TestConformanceTest.py", # Unit test of the conformance test (TC_DeviceConformance) - does not run against an app
"TestIdChecks.py", # Unit test - does not run against an app
"TestSpecParsingDeviceType.py", # Unit test - does not run against an app
"TestConformanceTest.py", # Unit test - does not run against an app
"TestMatterTestingSupport.py", # Unit test - does not run against an app
"TestSpecParsingSupport.py", # Unit test - does not run against an app
"TestTimeSyncTrustedTimeSource.py", # Unit test and shared code for scripts/tests/TestTimeSyncTrustedTimeSourceRunner.py
"drlk_2_x_common.py", # Shared code for TC_DRLK, not a standalone test
# Python code that runs all the python tests from src/python_testing (This code itself run via tests.yaml)
"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"
"hello_external_runner.py", # Code/Test not being used or not shared code for any other tests
"hello_test.py", # Is a template for tests
"test_plan_support.py", # Shared code for TC_*, not a standalone test
"test_plan_table_generator.py", # Code/Test not being used or not shared code for any other tests
"basic_composition_support.py", # Test support/shared code script, not a standalone test
"choice_conformance_support.py", # Test support/shared code script, not a standalone test
"conformance_support.py", # Test support/shared code script, not a standalone test
"global_attribute_ids.py", # Test support/shared code script, not a standalone test
"matter_testing_support.py", # Test support/shared code script, not a standalone test
"pics_support.py", # Test support/shared code script, not a standalone test
"spec_parsing_support.py", # Test support/shared code script, not a standalone test
"taglist_and_topology_test_support.py" # Test support/shared code script, not a standalone test
}

"""
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"))

Expand Down

0 comments on commit 12f04dc

Please sign in to comment.