[Create Test] Create TC_ACL_2_10 persistence test with reboot DUT functionality (#39945)
* [Create Test] Create TC_ACL_2_10 persistence test with reboot DUT functionality:
- Add TC_ACL_2_10 Python test module for ACL persistence testing
- Remove legacy ACL_2_10 YAML script (replaced by Python implementation)
- Add reboot functionality to run_python_test python3 test runner
- Implement flag file mechanism for app restart signaling (/tmp/chip_test_restart_app)
- Add environment variable support for app restart configuration
- Add proper process management and cleanup for restarted apps
- Ensure backward compatibility with existing tests
The reboot functionality allows testing data persistence across device reboots,
which is essential for validating AccessControl cluster behavior.
* autopep8 and isort stylized
* Apply suggestions from code review by Gemini AI bot
Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
* Fix concurrent test conflicts with unique flag file paths
- Generate unique test run ID using UUID to avoid conflicts in concurrent test runs
- Replace hardcoded /tmp paths with unique paths: /tmp/chip_test_restart_app_{test_run_id}
- Add environment variables CHIP_TEST_RESTART_FLAG_FILE and CHIP_TEST_STOP_FLAG_FILE
- Update monitor function to accept flag file paths as parameters
- Maintain backward compatibility with existing tests
This prevents race conditions when multiple test instances run concurrently
on the same machine, eliminating test flakiness caused by file path conflicts.
* Restyled by autopep8
* Resolving linting errors
* Update scripts/tests/run_python_test.py
Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
* Updating TC_ACL_2_10 test module and run_python_test test runner modules:
- Updated test code in test steps 12-16 to resolve some redundancy when there is only one entry
- Added in a finally block so that we make sure that any flag file is removed at the end of tests that call for reboots
- Added some try-catch logic around the cleanup operations
- Moved import uuid to top of test runner script
- Enforced that flag files are set in test environment when running TC_ACL_2_10 test step 9
* Restyled by autopep8
* Updating reboot logic and thread processing for TC_ACL_2_10 test module:
- Remove unnecessary hasattr check that was previously added as a precaution
- Introduce AppProcessManager class to centralize app process lifecycle management (start, stop, restart) including stdin pipe forwarding support
- Remove environment variable dependencies (CHIP_TEST_APP_RESTART_AVAILABLE) as AppProcessManager now handles all app control
- Replace environment variable for restart flag filename with direct passing via script-args to matter testing support module which then allows test modules to access it
- Add thread-safe access to shared app_manager_ref using threading.Lock between main thread and monitor thread
- Simplify restart monitoring: remove separate stop flag file as monitor thread automatically exits after handling restart
- Remove unnecessary sleep in exception handler
* Removed no longer needed restart_app_process()
* Applying isort and autopep8
* Resolving linting errors
* Updating run_python_test test runner module:
- Changed to using sys.stderr.buffer for error buffer output in terminal
- Changed to using stream_output var for exit at end of test in CI
* Add --reboot-dut command line flag to control DUT reboot logic
* Restyled by autopep8
* Fixing app manager cleanup logic
* Restyled by autopep8
* Adding optional restart-flag-file CLI arg to runner.py for rebooting DUT during tests
* Adding reboot-dut to CI runner args in ACL_2_10
* Restyled by autopep8
* Removing Test_TC_ACL_2_10 reference from yaml runner docs
* Updating chip -> matter for imports
* Restyled by isort
* Removing reboot-dut CLI flag
* Restyled by autopep8
* Removing formatting previously done by isort to matter_testing support module
* Removing formatting previously done by isort to matter_testing support module redo: missed a couple lines the first time
* Making it so that --restart-flag-file is not an added arg in mobile-device-test test
* added restart_monitor_thread var and set to None in order to resolve current CI failure when thread monitor not restarted, and cleaning up CI failure output
* Updating TC_ACL_2_10 test, metadata support, and run_python_test test runner modules:
- Updating to add type hints to init function of AppProcessManager class
- Removed "reboot_dut" unneeded var from metadata module
- Changed from using self.is_ci() to now checking if restart flag file is passed into the test self.get_restart_flag_file()
- Changed to using app_ready_pattern in TC_ACL_2_10 instead of using hard coded sleep timers, still needs 1 sec sleep timer after app-ready-pattern is detected
- Created test step 17 to restore default ACL entry for default controller to continue with next test.
* Restyled by autopep8
* Removed reboot_dut from CI args in TC_ACL_2_10 python3 test module
* Removed reboot_dut from var set in metadata python3 support modules parse_script function
* Updating TC_ACL_2_10 python3 test module test step 17 definition
* Update src/python_testing/TC_ACL_2_10.py
Co-authored-by: C Freeman <cecille@google.com>
* Adding TODO for current workaround of not running --restart-flag-file arg through mobile-device-test
* Adding link to cirque and CI test pipeline task
* Restyled by autopep8
* Updating TC_ACL_2_10 python3 test module:
- Changed to using the f2 var for removing TH2 fabric instead of gathering the fabric ID again
- Removed unneeded function that had been used to gather TH2 fabric ID as no longer needed
- Updated to gathering the admin only ACL entry at the start of test 5 before any write ops then using it in test step 17 instead of creating a new admin only ACL entry.
* Updating matter_testing support module to help resolve mypy restart_flag_file type issue
---------
Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
Co-authored-by: Restyled.io <commits@restyled.io>
Co-authored-by: C Freeman <cecille@google.com>Builds
Tests
Tools
Documentation
Matter (formerly Project CHIP) creates more connections between more objects, simplifying development for manufacturers and increasing compatibility for consumers, guided by the Connectivity Standards Alliance.
Matter is a unified, open-source application-layer connectivity standard built to enable developers and device manufacturers to connect and build reliable, and secure ecosystems and increase compatibility among connected home devices. It is built with market-proven technologies using Internet Protocol (IP) and is compatible with Thread and Wi-Fi network transports. Matter was developed by a Working Group within the Connectivity Standards Alliance (Alliance). This Working Group develops and promotes the adoption of the Matter standard, a royalty-free connectivity standard to increase compatibility among smart home products, with security as a fundamental design tenet. The vision that led major industry players to come together to build Matter is that smart connectivity should be simple, reliable, and interoperable.
Matter simplifies development for manufacturers and increases compatibility for consumers.
The standard was built around a shared belief that smart home devices should be secure, reliable, and seamless to use. By building upon Internet Protocol (IP), Matter enables communication across smart home devices, mobile apps, and cloud services and defines a specific set of IP-based networking technologies for device certification.
The Matter specification details everything necessary to implement a Matter application and transport layer stack. It is intended to be used by implementers as a complete specification.
The Alliance officially opened the Matter Working Group on January 17, 2020, and the specification is available for adoption now.
Visit buildwithmatter.com to learn more and read the latest news and updates about the project.
Matter is developed with the following goals and principles in mind:
Unifying: Matter is built with and on top of market-tested, existing technologies.
Interoperable: The specification permits communication between any Matter-certified device, subject to users’ permission.
Secure: The specification leverages modern security practices and protocols.
User Control: The end user controls authorization for interaction with devices.
Federated: No single entity serves as a throttle or a single point of failure for root of trust.
Robust: The set of protocols specifies a complete lifecycle of a device — starting with the seamless out-of-box experience, through operational protocols, to device and system management specifications required for proper function in the presence of change.
Low Overhead: The protocols are practically implementable on low compute-resource devices, such as MCUs.
Pervasive: The protocols are broadly deployable and accessible, by leveraging IP and being implementable on low-capability devices.
Ecosystem-Flexible: The protocol is flexible enough to accommodate deployment in ecosystems with differing policies.
Easy to Use: The protocol provides smooth, cohesive, integrated provisioning and out-of-box experience.
Open: The Project’s design and technical processes are open and transparent to the general public, including non-members wherever possible.
Matter aims to build a universal IPv6-based communication protocol for smart home devices. The protocol defines the application layer that will be deployed on devices and the different link layers to help maintain interoperability. The following diagram illustrates the normal operational mode of the stack:
The architecture is divided into layers to help separate the different responsibilities and introduce a good level of encapsulation among the various pieces of the protocol stack. The vast majority of interactions flow through the stack captured in the following Figure:
Security: An encoded action frame is then sent down to the Security Layer to encrypt and sign the payload to ensure that data is secured and authenticated by both sender and receiver of a packet.
Message Framing & Routing: With an interaction encrypted and signed, the Message Layer constructs the payload format with required and optional header fields; which specify the message's properties and some routing information.
Matter’s design and technical processes are intended to be open and transparent to the general public, including to Working Group non-members wherever possible. The availability of this GitHub repository and its source code under an Apache v2 license is an important and demonstrable step to achieving this commitment. Matter endeavors to bring together the best aspects of market-tested technologies and redeploy them as a unified and cohesive whole-system solution. The overall goal of this approach is to bring the benefits of Matter to consumers and manufacturers as quickly as possible. As a result, what you observe in this repository is an implementation-first approach to the technical specification, vetting integrations in practice. The Matter repository is growing and evolving to implement the overall architecture. The repository currently contains the security foundations, message framing and dispatch, and an implementation of the interaction model and data model. The code examples show simple interactions, and are supported on multiple transports -- Wi-Fi and Thread -- starting with resource-constrained (i.e., memory, processing) silicon platforms to help ensure Matter’s scalability.
We welcome your contributions to Matter. Read our contribution guidelines here.
Instructions about how to build Matter can be found here .
The Matter repository is structured as follows:
| File/Folder | Content |
|---|---|
| build | Build system support content and built output directories |
| build_overrides | Build system parameter customization for different platforms |
| config | Project configurations |
| credentials | Development and test credentials |
| docs | Documentation, including guides. Visit the Matter SDK documentation page to read it. |
| examples | Example firmware applications that demonstrate use of Matter |
| integrations | 3rd party integrations |
| scripts | Scripts needed to work with the Matter repository |
| src | Implementation of Matter |
| third_party | 3rd party code used by Matter |
| zzz_generated | ZAP generated template code - Revolving around cluster information |
| BUILD.gn | Build file for the GN build system |
| CODE_OF_CONDUCT.md | Code of conduct for Matter and contribution to it |
| CONTRIBUTING.md | Guidelines for contributing to Matter |
| LICENSE | Matter license file |
| REVIEWERS.md | PR reviewers |
| gn_build.sh | Build script for specific projects such as Android, EFR32, etc. |
| README.md | This file |
Matter is released under the Apache 2.0 license.