Creating ACL 2 4 python3 test module (#38314)

* Modifying how ACL Attribute is written: making it use a non-empty initial ReplaceAll list

* removing Test modifications on ACL Extensions

* adding reference to issue in TODO comment

* integrating comments

* integrating comments

* Revert "removing Test modifications on ACL Extensions"

This reverts commit 055af80d6c71e40ddeef081b6046263bc06ef141.

* Testing removing one of the template functions

* WriteClient: Encoding as many items as possible into a single list as part of ReplaceAll item operation

* fixing failures

* Fix to Error Handling in User-Label Cluster: return RESOURCE_EXHAUSTED when the number of items in list exceeds kMaxUserLabelListLength

* chip-repl: support for preencoded attributes

* Fixing ACL 2.3 and 2.5

* Validating ACLs Upfront: This is done to make sure we reject the whole list if any of the entries within it are non conforming

* more yaml test changes

* Restyled by prettier-yaml

* Fix Unit Testing Cluster (Test Cluster Server) to process ReplaceAll operations

* fix PutPreencodedAttribute

* Cleaning code

* More Code Clean Up

* Unit Test Cleanup

* more cleanup

* Adding testcases to TestAccessControlCluster

* Fixing comments

* Making IsValid method in AccessControl Static

* Adding comments

* Make IsValid a member function of AccessControl::Entry

* Adding WriteClient class member mIsWriteRequestChunked

* making TestWriteChunkig more Robust

* Adding ACL_2_4 python3 test module:
- Adding python3 ACL_2_4 test module
- This uses base branch of Amine's PR #38263 to create this test module: This is a follow-up PR to that PR from Amine, once Amine's PR is merged this one can come out of WIP state.

* Restyled by autopep8

* Updating TC_ACL_2_4 python3 test module:
- Changing expect clause for test step 29

* Updating TC_ACL_2_4:
- Resolving linting errors

* Apply commit suggestions from code review from Amine

Updating to include commit suggestions to test steps and comments from @Alami-Amine. These suggestions made the code cleaner and more readable, thank you!

Co-authored-by: Amine Alami <43780877+Alami-Amine@users.noreply.github.com>

* Updating TC_ACL_2_4 python3 test module to resolve commits from Amine, making the code cleaner and better:
- Updating to change type of ID from "fabric-scoped node ID" with correct type "invalid Group Node ID"
- Updating test step 4 description to be more detailed.

* Restyled by autopep8

* Update src/python_testing/TC_ACL_2_4.py

Changing hex values for CAT1-CAT4 in test step 21 as suggested by Amine who gathered these from the test spec

Co-authored-by: Amine Alami <43780877+Alami-Amine@users.noreply.github.com>

* Updating TC_ACL_2_4 python3 test module:
- Replacing duplicate CAT4 value in test step 21 and replaced it with value from Amine that did not replicate CAT3's value

* Updating TC_ACL_2_4 test module:
- Updating to match test steps in test plan PR: https://github.com/CHIP-Specifications/chip-test-plans/pull/5052

* Pulling in files from upstream master to make sure that everything is in sync

* Updating TC_ACL_2_4 python3 test module:
- Removing try except blocks
- Replacing self.print_step() with logging.info()

* Restyled by autopep8

* Updated TC_ACL_2_4 python3 test module:
- Added new test step method to step 29
- Updated test steps after test step 29 include the test step ordering
- Updated test 29 and 30 to include the correct verbiage for the definitions and expected results

* Updated TC_ACL_2_4 test module:
- Actually updated TC_ACL_2_4 python3 test module to correct expected results verbiage for test steps 32-44

* Restyled by autopep8

* Update src/python_testing/TC_ACL_2_4.py

Co-authored-by: Amine Alami <43780877+Alami-Amine@users.noreply.github.com>

* Removing Test_TC_ACL_2_4.yaml script

* Updating TC_ACL_2_4 python3 test module:
- Replaced enumerate blocks with asserts.assert_in() checks to verify that structs are read correctly throughout the test
- Removed some unneeded comments in the test module

* Restyled by autopep8

* Updating TC_ACL_2_4 python3 test module:
- Added in validation of admin entry only to end of test steps 32-44
- Removed duplicate validation of admin entry only in test step 31

---------

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