Add a script capable to check for backwards compatibility differences between .matter files #29349
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
pullapprove
bot
requested review from
younghak-hwang,
yufengwangca and
yunhanw-google
scripts/py_matter_idl/matter_idl/backwards_compatibility/__init__.py
Outdated
Show resolved
Hide resolved
|
PR #29349: Size comparison from 0f620c0 to 7b95640 Full report (32 builds for bl602, bl702, bl702l, cc13x4_26x4, cc32xx, cyw30739, k32w, linux, mbed, nrfconnect, psoc6, qpg)
|
|
PR #29349: Size comparison from 0f620c0 to 0792053 Full report (1 build for cc32xx)
|
|
PR #29349: Size comparison from 0f620c0 to 5c80164 Full report (49 builds for bl602, bl702, bl702l, cc13x4_26x4, cc32xx, cyw30739, efr32, esp32, k32w, linux, mbed, nrfconnect, psoc6, qpg)
|
|
PR #29349: Size comparison from 0f620c0 to cfb1bb3 Increases (1 build for telink)
Full report (66 builds for bl602, bl702, bl702l, cc13x4_26x4, cc32xx, cyw30739, efr32, esp32, k32w, linux, mbed, nrfconnect, psoc6, qpg, telink)
|
bzbarsky-apple
approved these changes
Sep 20, 2023
|
PR #29349: Size comparison from 0f620c0 to 8d5a208 Increases (1 build for telink)
Full report (66 builds for bl602, bl702, bl702l, cc13x4_26x4, cc32xx, cyw30739, efr32, esp32, k32w, linux, mbed, nrfconnect, psoc6, qpg, telink)
|
|
PR #29349: Size comparison from 94853cf to 41c92a1 Decreases (1 build for esp32)
Full report (66 builds for bl602, bl702, bl702l, cc13x4_26x4, cc32xx, cyw30739, efr32, esp32, k32w, linux, mbed, nrfconnect, psoc6, qpg, telink)
|
tcarmelveilleux
approved these changes
Sep 21, 2023
HunsupJung
pushed a commit
to HunsupJung/connectedhomeip
that referenced
this pull request
Oct 23, 2023
… between .matter files (project-chip#29349) * Start defining a compatibility checker with unit tests * Enumeration validation passes * Restyle * Mark unimplemented items with TODO * Add some cluster validation tests * Add validation for bitmap statuses and unit tests for that * Mild restyle and clearer code * Take into consideration cluster sides * Update naming a bit * More detailed messages for code entry changes * Use sub-tests to mark clearly what failures occur where * Fix typing and common logic * Add implementation and tests for event backward compatibility * Restyle * Add command backwards compatibility checks and tests, better error reporting * Less noisy output for unit tests * Restyle * Fixed types * Split tests so we have better split and execution report - 23 tests instead of just 5 * Add minor unit test * Added struct handling and unit tests * Restyle * Attribute validation * Restyle * Fix typo * Add some extra logic to not detect renames in fields * Additional tests for renames of fields * Add struct tests for reorder and renames * Add cluster names for error reports * Restyle * Fix test comments * Move defs outside init into separate file, update build scripts * Move to single file for use as an import instead of a module directory * Remove unused import * Rename some global methods to pep8 * Move more methods to pep8 * Remove unused import * Make sure unit test is run as part of standard tests * Update comment * Ensure click argument for choice is list of str instead of a dictionary view (makes mypy happy) --------- Co-authored-by: Andrei Litvin <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Intent is to use this in CI to detect changes in controller-clusters.matter (which is intended to contain all SDK clusters) that require human review for backwards compatibiltiy.
As an example this would detect changes in 4752dcc where type of a struct member was changed from unsigned to signed (which is not backwards compatible):
Changes