Refactoring of support test scripts to enhance matter testing infrastructure (#34785)

* Refactoring of the matter testing infrastructure

* Restyled by shfmt

* Manually fix restyle

* Manually fix restyle

* Manually restyle

* Manually fix restyle

* Manually fix restyle

* Renamed testing_support to matter_testing _support

* Fixed the support scripts from matter_testing_support

* Fixed TC_OVENOPSTATE_2_6.py for import command

* replace all os.path.join and such (using _file_) with their own method

* Fixed paths.py for import

* Fixed imports for TC_DeviceConformace.py

* Fixed the broken import for matter_testing

* Make sure modules match master

* Debug the data model files for spec_parsing

* Try to guess data model root

* Restyle

* Moving Test* from python_testing to matter_testing_support

* Removed the tests moved from glob python scripts

* Restyled by isort

* Added taglist_and_topology_test.py to the support tests list

* Restyled by isort

* Fixed the structure for accessing example_pics_xml_basic_info.xml

* Fixing the TC_RVCCLEANM_2_2.py script according to master changes

* Changes according to master

* Fixing structuring of TestMatterTestingSupport.py and TestSpecParsingSupport.py

* Restyled by isort

* Fixed typo on src/python_testing/matter_testing_infrastructure/BUILD.gn tests section

* Fixed import for TC_ICDM_3_2.py

* Fix Import for TC_RVCCLEANM_2_2.py

* Restyled by autopep8

* Update line formatting in TestSpecParsingSupport.py

* Fixed comment on execute_python_tests.py

* tests.yaml test

* Test to fix src/python_testing/test_testing directory imports

* Restyled by isort

* Fixed code lints

* Fix imports for test_testing directory

* Fixed imports on test_TC_ICDM_2_1.py

* Restyled by autopep8

* Restyled by isort

* Updated imported fixes on test_TC_ICDM_2_1.py

* Restyled by autopep8

* Restyled by isort

* Import fixes for parent directory test imports

* Fixing try-except imports for test_testing directory scripts

* Remove unwanted import os from 2 scripts

* Restyled by isort

* Restyled by isort

* Restyled by autopep8

* Restyled by isort

* Updated paths and spec_xml scripts

* Fixed unused imports

* Restyled by isort

* Try to guess data model root

* Fixed wrong string via GUI that was set in vscode

* Fix matter_testing imports

* Comment

* Remove comment

* Fixed import and improved logging via flush of stdout

* Fixed matter support import for test scripts

* Restyled by isort

* Fixed "os.environ is not callable, it is a dictionary"

Co-authored-by: Andrei Litvin <andy314@gmail.com>

* Import fixed for TC_CCTRL_2_3.py

* Update logic to match master

* Fixed multiple executions of the same tests

* Fixed test_testing scripts with master

* Restyled by isort

* Fixing code lints

* Restyled by autopep8

* Fix formate changes happened with autosave on TestSpecParsingSupport.py

* Fixed module import in MockTestRunner script

* Restructured the tasks.py scripts in matter_testing_support

* Fixed formatting

* Restyled by shfmt

* Restyled by isort

* Fixed code lints

* Fixed imports for the new scripts added

* Fixed k1_4 for the test script

* Restyled by autopep8

* Fixed import for new scripts added

* Added support for v1_4

* Update TestSpecParsingSupport.py

* Added the missed part of the code after hard reset from commit d0e36909af460b490565b1798bc7b4f0042a8545

* Print statements to test

* Update TestSpecParsingSupport.py

* Added in_progress for DEFAULT_OUTPUT_DIR_IN_PROGRESS

* Added support for conformance_support in atomic attributes

* Removing test prints statements

* Restyled by isort

* Checking in Thermostat's Revision

* Check and Verified Cluster Thermostats's Revision

* Restyled by isort

* Fixed improts with news supports apps.py

* Restyled by isort

* Fixed imports for ECOINFO scripts

* Restyled by isort

* Renamed matter_testing_support to chip.testing

* Update TestSpecParsingSupport.py

* Restyled by shfmt

* Restyled by isort

* Update build_python.sh

* Fix imports for TC_SWITCH.py script

* Restyled by isort

---------

Co-authored-by: Restyled.io <commits@restyled.io>
Co-authored-by: Andrei Litvin <andy314@gmail.com>
203 files changed
tree: da2b3a25ad085ff7d19e75b92dc2902d26d46348
  1. .devcontainer/
  2. .githooks/
  3. .github/
  4. .vscode/
  5. build/
  6. build_overrides/
  7. config/
  8. credentials/
  9. data_model/
  10. docs/
  11. examples/
  12. integrations/
  13. scripts/
  14. src/
  15. third_party/
  16. zzz_generated/
  17. .actrc
  18. .clang-format
  19. .clang-tidy
  20. .default-version.min
  21. .dir-locals.el
  22. .editorconfig
  23. .gitattributes
  24. .gitignore
  25. .gitmodules
  26. .gn
  27. .isort.cfg
  28. .mergify.yml
  29. .prettierrc.json
  30. .pullapprove.yml
  31. .restyled.yaml
  32. .shellcheck_tree
  33. .spellcheck.yml
  34. BUILD.gn
  35. CODE_OF_CONDUCT.md
  36. CODEOWNERS
  37. CONTRIBUTING.md
  38. gn_build.sh
  39. iwyu.imp
  40. kotlin-detect-config.yaml
  41. lgtm.yml
  42. LICENSE
  43. NOTICE
  44. README.md
  45. REVIEWERS.md
  46. ruff.toml
  47. SPECIFICATION_VERSION
README.md

Matter

Builds

Builds

Android Ameba ASR BouffaloLab Darwin TI CC26X2X7 TI CC32XX EFR32 ESP32 Infineon i.MX Linux K32W with SE051 Linux ARM Linux Standalone Linux Standalone Mbed OS MW320 nRF Connect SDK Open IoT SDK QPG STM32 Telink Tizen

Tests

Unit / Integration Tests Cirque QEMU

Tools

ZAP Templates

Documentation

Documentation Build

About

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.

What is Matter?

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.

Project Overview

Development Goals

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.

Architecture Overview

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: Matter Architecture Overview

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:

Matter Stack Architecture

  1. Application: High-order business logic of a device. For example, an application that is focused on lighting might contain logic to handle turning on/off the bulb as well as its color characteristics.
  1. Data Model: The data layer corresponds to the data and verb elements that help support the functionality of the application. The Application operates on these data structures when there is an intent to interact with the device.
  1. Interaction Model: The Interaction Model layer defines a set of interactions that can be performed between a client and server device. For example, reading or writing attributes on a server device would correspond to application behavior on the device. These interactions operate on the elements defined at the data model layer.
  1. Action Framing: Once an action is constructed using the Interaction Model, it is serialized into a prescribed packed binary format to encode for network transmission.
  1. 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.

  2. 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.

  1. IP Framing & Transport Management: After the final payload has been constructed, it is sent to the underlying transport protocol for IP management of the data.

Current Status of Matter

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.

How to Contribute

We welcome your contributions to Matter. Read our contribution guidelines here.

Building and Developing in Matter

Instructions about how to build Matter can be found here .

Directory Structure

The Matter repository is structured as follows:

File/FolderContent
buildBuild system support content and built output directories
build_overridesBuild system parameter customization for different platforms
configProject configurations
credentialsDevelopment and test credentials
docsDocumentation, including guides. Visit the Matter SDK documentation page to read it.
examplesExample firmware applications that demonstrate use of Matter
integrations3rd party integrations
scriptsScripts needed to work with the Matter repository
srcImplementation of Matter
third_party3rd party code used by Matter
zzz_generatedZAP generated template code - Revolving around cluster information
BUILD.gnBuild file for the GN build system
CODE_OF_CONDUCT.mdCode of conduct for Matter and contribution to it
CONTRIBUTING.mdGuidelines for contributing to Matter
LICENSEMatter license file
REVIEWERS.mdPR reviewers
gn_build.shBuild script for specific projects such as Android, EFR32, etc.
README.mdThis file

License

Matter is released under the Apache 2.0 license.