Merge remote-tracking branch 'origin/master' into pr/swan-amazon/37015

Author: swan-amazon

.github/PULL_REQUEST_TEMPLATE.md

@@ -1,12 +1,18 @@
-> !!!!!!!!!! Please delete the instructions below and replace with PR description
+> !!!!!!!!!! Please delete the instructions below and replace with PR
+> description
 >
-> If you have an issue number, please use a syntax of
-> `Fixes #12345` and a brief change description
+> If you have an issue number, please use a syntax of `Fixes #12345` and a brief
+> change description
 >
-> If you do not have an issue number, please have a good description of
-> the problem and the fix. Help the reviewer understand what to expect.
+> If you do not have an issue number, please have a good description of the
+> problem and the fix. Help the reviewer understand what to expect.
+>
+> Complete/append to the `### Testing` section below, to describe how testing
+> was done. See
+> <https://github.com/project-chip/connectedhomeip/blob/master/CONTRIBUTING.md#pull-requests>
 >
 > Make sure you delete these instructions (to prove you have read them).
 >
 > !!!!!!!!!! Instructions end
 
+#### Testing

.github/workflows/cancel_workflows_for_pr.yaml

@@ -35,15 +35,16 @@ jobs:
                 python-version: '3.12'
             - name: Setup pip modules we use
               run: |
-                  pip install         \
+                  python3 -m venv venv
+                  venv/bin/pip3 install \
                       click           \
                       coloredlogs     \
                       python-dateutil \
                       pygithub        \
-                      && echo "DONE installint python prerequisites"
+                      && echo "DONE installing python prerequisites"
             - name: Cancel runs
               run: |
-                  scripts/tools/cancel_workflows_for_pr.py       \
+                  venv/bin/python3 scripts/tools/cancel_workflows_for_pr.py \
                     --gh-api-token "${{ secrets.GITHUB_TOKEN }}" \
                     --require "Restyled"       \
                     --require "Lint Code Base" \

.github/workflows/docbuild.yaml

@@ -29,17 +29,18 @@ jobs:
       - name: Install Python
         uses: actions/setup-python@v5
         with:
-          python-version: 3.8
+          python-version: 3.12
           cache-dependency-path: matter/docs/requirements.txt
           cache: pip
       - name: Install base dependencies
         working-directory: matter
         run: |
-          sudo pip3 install -U pip
-          pip3 install -r docs/requirements.txt
+          python3 -m venv venv
+          venv/bin/pip3 install -r docs/requirements.txt
       - name: Build documentation
         working-directory: matter/docs
         run: |
+          source ../venv/bin/activate
           mkdir -p _build/src
           make html
           touch _build/html/.nojekyll

.github/workflows/examples-bouffalolab.yaml

@@ -116,8 +116,26 @@ jobs:
       - name: Clean out build output
         run: rm -rf ./out
 
+      - name: Build example BL702L Contact Sensor
+        timeout-minutes: 30
+        run: |
+          ./scripts/run_in_build_env.sh \
+            "./scripts/build/build_examples.py \
+              --target bouffalolab-bl704ldk-contact-sensor-thread-mtd-littlefs-mfd \
+              build \
+              --copy-artifacts-to out/artifacts \
+            "
+      - name: Prepare some bloat report from the previous builds
+        run: |
+          .environment/pigweed-venv/bin/python3 scripts/tools/memory/gh_sizes.py \
+              bl702l bl702l+mfd+littlefs contact-sensor-app \
+              out/artifacts/bouffalolab-bl704ldk-contact-sensor-thread-mtd-littlefs-mfd/chip-bl702l-contact-sensor-example.out \
+              /tmp/bloat_reports/
+      - name: Clean out build output
+        run: rm -rf ./out
+
       - name: Uploading Size Reports
         uses: ./.github/actions/upload-size-reports
         if: ${{ !env.ACT }}
         with:
-          platform-name: BouffaloLab
+          platform-name: BouffaloLab

.github/workflows/pr-validation.yaml

@@ -0,0 +1,69 @@
+name: PR validity
+
+on:
+  pull_request:
+    types: [opened, synchronize, reopened, edited]
+
+jobs:
+  check_testing_header:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Check for `### Testing` section in PR
+        id: check-testing
+        continue-on-error: true
+        run: |
+          cat >/tmp/pr-summary.txt << "EndMarkerForPrSummary"
+          ${{ github.event.pull_request.body }}
+          EndMarkerForPrSummary
+
+          python -c 'import sys; pr_summary = open("/tmp/pr-summary.txt", "rt").read(); sys.exit(0 if "### Testing" in pr_summary else 1)'
+
+      - name: Check for PR starting instructions
+        id: check-instructions
+        continue-on-error: true
+        run: |
+          cat >/tmp/pr-summary.txt << "EndMarkerForPrSummary"
+          ${{ github.event.pull_request.body }}
+          EndMarkerForPrSummary
+
+          python -c 'import sys; pr_summary = open("/tmp/pr-summary.txt", "rt").read(); sys.exit(1 if "Make sure you delete these instructions" in pr_summary else 0)'
+
+      # NOTE: comments disabled for now as separate permissions are required
+      #       failing CI step may be sufficient to start (although it contains less information about why it failed)
+
+      # - name: Add comment (missing instructions)
+      #   if: steps.check-instructions.outcome == 'failure'
+      #   uses: actions/github-script@v6
+      #   with:
+      #     github-token: ${{ secrets.GITHUB_TOKEN }}
+      #     script: |
+      #       github.rest.issues.createComment({
+      #         issue_number: context.issue.number,
+      #         owner: context.repo.owner,
+      #         repo: context.repo.repo,
+      #         body: 'Please make sure to delete starter instructions from your PR summary and replace them with a descriptive summary.'
+      #       })
+
+      - name: Fail if PR instructions were not deleted
+        if: steps.check-instructions.outcome == 'failure'
+        run: |
+          python -c 'import sys; print("PR instructions were not replaced"); sys.exit(1)'
+
+      # - name: Add comment (missing testing)
+      #   if: steps.check-testing.outcome == 'failure'
+      #   uses: actions/github-script@v6
+      #   with:
+      #     github-token: ${{ secrets.GITHUB_TOKEN }}
+      #     script: |
+      #       github.rest.issues.createComment({
+      #         issue_number: context.issue.number,
+      #         owner: context.repo.owner,
+      #         repo: context.repo.repo,
+      #         body: 'Please add a `### Testing` section to your PR summary describing the testing performed. See https://github.com/project-chip/connectedhomeip/blob/master/CONTRIBUTING.md#pull-requests'
+      #       })
+
+      - name: Fail if `### Testing` section not in PR
+        if: steps.check-testing.outcome == 'failure'
+        run: |
+          python -c 'import sys; print("Testing section missing (test failed)"); sys.exit(1)'
+

.github/workflows/protocol_compatibility.yaml

@@ -30,11 +30,11 @@ jobs:
        - name: Setup python
          uses: actions/setup-python@v5
          with:
-           python-version: 3.11
+           python-version: 3.12
        - name: Install dependencies
          run: |
-           python -m pip install --upgrade pip
-           pip install click coloredlogs lark
+           python3 -m venv venv
+           venv/bin/pip3 install click coloredlogs lark
        - name: Create old/new copies
          run: |
            mkdir -p out
@@ -45,5 +45,4 @@ jobs:
            patch -p1 <out/patch.diff
        - name: Check backwards compatibility
          run: |
-           scripts/backwards_compatibility_checker.py out/old_version.matter out/new_version.matter
-
+           venv/bin/python3 scripts/backwards_compatibility_checker.py out/old_version.matter out/new_version.matter

.github/workflows/tests.yaml

@@ -111,6 +111,7 @@ jobs:
                       src/app/zap-templates/zcl/data-model/chip/boolean-state-cluster.xml \
                       src/app/zap-templates/zcl/data-model/chip/actions-cluster.xml \
                       src/app/zap-templates/zcl/data-model/chip/bridged-device-basic-information.xml \
+                      src/app/zap-templates/zcl/data-model/chip/camera-av-settings-user-level-management-cluster.xml \
                       src/app/zap-templates/zcl/data-model/chip/camera-av-stream-management-cluster.xml \
                       src/app/zap-templates/zcl/data-model/chip/chip-ota.xml \
                       src/app/zap-templates/zcl/data-model/chip/chip-types.xml \

CONTRIBUTING.md

@@ -160,6 +160,99 @@ This will trigger the continuous-integration checks. You can view the results in
 the respective services. Note that the integration checks will report failures
 on occasion.
 
+#### Pull requests
+
+Aim to make pull requests easy to read both when viewed in a list (title only)
+as well as clear in content within the description.
+
+##### Title formatting
+
+Describe the change as a one-line in some descriptive manner. Add sufficient
+context for a reader to understand what is improved. If platform-specific
+consider adding the platform as a prefix, like `[Android]` or any other tags may
+be useful for quick filtering like `[TC-ABC-1.2]` to tag test changes.
+
+Examples of descriptive titles:
+
+-   `[Silabs] Fix compile of SiWx917 if LED and BUTTON are disabled`
+-   `[Telink] Update build Dockerfile with new Zeprhy SHA: c05c4.....`
+-   `General Commissioning Cluster: use AttributeAccessInterface/CommandHandlerInterface for processing`
+-   `Scenes Management/CopyScene: set access as manage instead of default to match the spec`
+-   `Fix build errors due to ChipDeviceEvent default constructor not being available`
+-   `Fix crash during DNSSD processing due to malformed packet`
+-   `[NRF] Fix crash due to stack overflow during logging for PW-RPC builds`
+-   `[TC-ABC-2.3] added new python test case based on test plan`
+-   `[TC-ABC] migrate tests from yaml to python`
+
+Examples of titles that are vague (not clear what the change is, one would need
+to open the pull request for details or open additional issue in GitHub)
+
+-   `Work on issue 1234`
+-   `Fix android JniTypeWrappers`
+-   `Fix segfault in BLE`
+-   `Fix TC-ABC-1.2`
+-   `Update Readme`
+
+##### Summary contents
+
+Ensure that there is sufficient detail in issue summaries to make the content of
+the PR clear:
+
+-   a `TLDR` of the change content. This is a judgment call on details,
+    generally you should include a what was changed and why. The change is
+    trivial/short, this can be very short (i.e. "fixed typos" is perfectly
+    acceptable, however if changing 100-1000s of line, the areas of changes
+    should be explained)
+-   If a crash/error is fixed, explain the root cause and if the fix is not
+    obvious (again, judgment call), explain why the given approach was taken.
+-   Help the reviewer out with any notable information (specific platform
+    issues, extra thoughts or requests for feedback or gotchas on tricky code,
+    followup work or PR dependencies)
+-   TIP: use the syntax of `Fixes #....` to mark issues completed on PR merge or
+    use `#...` to reference issues that are addressed.
+-   TIP: prefer adding some brief description (especially about the content of
+    the changes) instead of just referencing an issue (helps reviewers get
+    context faster without extra clicks).
+
+##### Testing section
+
+All Pull Requests **MUST** contain a `#### Testing` section that describes how
+the pull request was tested. Ideally every test should have automated testing,
+however for platform specific changes or hardware-specific issues we may not be
+able to have such tests (e.g. we may not BLE or NFC capability in CI). As such,
+manual testing is acceptable, however the description has to be detailed
+intentionally to avoid a bias towards marking pull requests as "manually tested"
+out of convenience.
+
+-   Automated testing
+
+    **AWESOME**. You can say "unit tests added/updated" or "Integration tests
+    updated to cover functionality" or "existing tests already cover this" (make
+    sure they do. Integration tests often only cover happy paths).
+
+    Add any notes on not covered things. It is a judgment call on how much can
+    be covered as 100% sounds great however not always possible.
+
+-   Manual testing
+
+    Describe why automated testing is impossible in the current CI environment
+    or difficult to add. If adding later, reference the issue to add automation
+    and a timeline for adding such automation.
+
+    Describe in **DETAIL** how manual testing was done: what environment, what
+    builds were used (`build-example` names are ok such as
+    `flashed qpg-qpg6105-light` and `used linux-x64-chip-tool-clang`). Describe
+    commands ran (often chip-tool) and physical interaction and what was
+    observed.
+
+-   Trivial/obvious change
+
+    In rare cases the change is trivial (e.g. fixing a typo in a `Readme.md`).
+    Scripts still require a `#### Testing` section however you can be brief like
+    `N/A` or `checked new URL opens`. Note that these cases are rare - e.g.
+    fixing a typo in an ID still requires some description on how you checked
+    that the new ID takes effect.
+
 ### Review Requirements
 
 #### Documentation Best Practices

docs/ids_and_codes/zap_clusters.md

@@ -131,6 +131,7 @@ Generally regenerate using one of:
 |       1296 |      0x510 | ContentAppObserver                                      |
 |       1360 |      0x550 | ZoneManagement                                          |
 |       1361 |      0x551 | CameraAvStreamManagement                                |
+|       1362 |      0x552 | CameraAvSettingsUserLevelManagement                     |
 |       1363 |      0x553 | WebRTCTransportProvider                                 |
 |       1364 |      0x554 | WebRTCTransportRequestor                                |
 |       1366 |      0x556 | Chime                                                   |

docs/issue_triage.md

@@ -137,6 +137,7 @@ types or functionality) as well as individual examples.
 | `examples/rvc-app`                             |                              | UNMAINTAINED |
 | `examples/smoke-co-alarm-app`                  |                              | UNMAINTAINED |
 | `examples/temperature-measurement-app`         |                              | UNMAINTAINED |
+| `examples/terms-and-conditions-app`            | James Swan                   |              |
 | `examples/thermostat`                          |                              | UNMAINTAINED |
 | `examples/thread-br-app`                       |                              | UNMAINTAINED |
 | `examples/tv-app`                              | Chris DeCenzo, Lazar Kovacic |              |

examples/all-clusters-app/all-clusters-common/src/software-diagnostics-stub.cpp

@@ -0,0 +1,68 @@
+/*
+ *
+ *    Copyright (c) 2024 Project CHIP Authors
+ *
+ *    Licensed under the Apache License, Version 2.0 (the "License");
+ *    you may not use this file except in compliance with the License.
+ *    You may obtain a copy of the License at
+ *
+ *        http://www.apache.org/licenses/LICENSE-2.0
+ *
+ *    Unless required by applicable law or agreed to in writing, software
+ *    distributed under the License is distributed on an "AS IS" BASIS,
+ *    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ *    See the License for the specific language governing permissions and
+ *    limitations under the License.
+ */
+
+#include <app/clusters/software-diagnostics-server/SoftwareDiagnosticsTestEventTriggerHandler.h>
+#include <app/clusters/software-diagnostics-server/software-diagnostics-server.h>
+#include <platform/CHIPDeviceLayer.h>
+#include <platform/DiagnosticDataProvider.h>
+
+using namespace chip;
+using namespace chip::app;
+using namespace chip::DeviceLayer;
+
+namespace {
+
+void SetTestEventTrigger_SoftwareFaultOccurred()
+{
+    Clusters::SoftwareDiagnostics::Events::SoftwareFault::Type softwareFault;
+    char threadName[kMaxThreadNameLength + 1];
+
+    softwareFault.id = static_cast<uint64_t>(getpid());
+    Platform::CopyString(threadName, std::to_string(softwareFault.id).c_str());
+
+    softwareFault.name.SetValue(CharSpan::fromCharString(threadName));
+
+    std::time_t result = std::time(nullptr);
+    // Using size of 50 as it is double the expected 25 characters "Www Mmm dd hh:mm:ss yyyy\n".
+    char timeChar[50];
+    if (std::strftime(timeChar, sizeof(timeChar), "%c", std::localtime(&result)))
+    {
+        softwareFault.faultRecording.SetValue(ByteSpan(Uint8::from_const_char(timeChar), strlen(timeChar)));
+    }
+
+    Clusters::SoftwareDiagnosticsServer::Instance().OnSoftwareFaultDetect(softwareFault);
+}
+
+} // namespace
+
+bool HandleSoftwareDiagnosticsTestEventTrigger(uint64_t eventTrigger)
+{
+    SoftwareDiagnosticsTrigger trigger = static_cast<SoftwareDiagnosticsTrigger>(eventTrigger);
+
+    switch (trigger)
+    {
+    case SoftwareDiagnosticsTrigger::kSoftwareFault:
+        ChipLogProgress(Support, "[Software-Diagnostics-Test-Event] => Software Fault occurred");
+        SetTestEventTrigger_SoftwareFaultOccurred();
+        break;
+    default:
+
+        return false;
+    }
+
+    return true;
+}

examples/all-clusters-app/esp32/main/main.cpp

@@ -210,9 +210,10 @@ extern "C" void app_main()
     {
         ESP_LOGE(TAG, "GetAppTask().StartAppTask() failed : %" CHIP_ERROR_FORMAT, error.Format());
     }
-    ESPOpenThreadInit();
 
     chip::DeviceLayer::PlatformMgr().ScheduleWork(InitServer, reinterpret_cast<intptr_t>(nullptr));
+
+    ESPOpenThreadInit();
 }
 
 bool lowPowerClusterSleep()

examples/all-clusters-app/linux/BUILD.gn

@@ -56,6 +56,7 @@ source_set("chip-all-clusters-common") {
     "${chip_root}/examples/all-clusters-app/all-clusters-common/src/rvc-modes.cpp",
     "${chip_root}/examples/all-clusters-app/all-clusters-common/src/rvc-operational-state-delegate-impl.cpp",
     "${chip_root}/examples/all-clusters-app/all-clusters-common/src/smco-stub.cpp",
+    "${chip_root}/examples/all-clusters-app/all-clusters-common/src/software-diagnostics-stub.cpp",
     "${chip_root}/examples/all-clusters-app/all-clusters-common/src/static-supported-modes-manager.cpp",
     "${chip_root}/examples/all-clusters-app/all-clusters-common/src/static-supported-temperature-levels.cpp",
     "${chip_root}/examples/all-clusters-app/all-clusters-common/src/tcc-mode.cpp",