[ICD] Add TestEventTrigger support to the ICDManager (#32898)

* Add TestEventTrigger to the ICDManager

* Update copyright year

* Update init / shutdown to not modify them

* Remove unnecessary import

* Fix nxp build

* remove unnused import

* add test event trigger to the app layer

* Remove TestEventTrigger from known problems linter

* fix typo

* fix merge conflicts

* update TestICDManager inits

* Fix TestCommissionManager

* move enum to the impl anonymous namespace

Author: mkardous-silabs

.github/workflows/lint.yml

@@ -23,7 +23,10 @@ on:
     workflow_dispatch:
 
 concurrency:
-    group: ${{ github.ref }}-${{ github.workflow }}-${{ (github.event_name == 'pull_request' && github.event.number) || (github.event_name == 'workflow_dispatch' && github.run_number) || github.sha }}
+    group:
+        ${{ github.ref }}-${{ github.workflow }}-${{ (github.event_name ==
+        'pull_request' && github.event.number) || (github.event_name ==
+        'workflow_dispatch' && github.run_number) || github.sha }}
     cancel-in-progress: true
 
 jobs:
@@ -43,7 +46,7 @@ jobs:
             - name: Checkout submodules & Bootstrap
               uses: ./.github/actions/checkout-submodules-and-bootstrap
               with:
-                platform: linux
+                  platform: linux
 
             - name: Check for orphaned gn files
               if: always()
@@ -103,7 +106,6 @@ jobs:
                      --known-failure app/reporting/reporting.cpp \
                      --known-failure app/reporting/tests/MockReportScheduler.cpp \
                      --known-failure app/reporting/tests/MockReportScheduler.h \
-                     --known-failure app/TestEventTriggerDelegate.h \
                      --known-failure app/util/attribute-storage.cpp \
                      --known-failure app/util/attribute-storage.h \
                      --known-failure app/util/attribute-storage-detail.h \
@@ -174,23 +176,28 @@ jobs:
             # git grep exits with 0 if it finds a match, but we want
             # to fail (exit nonzero) on match.  And we want to exclude this file,
             # to avoid our grep regexp matching itself.
-            - name: Check for use of PRI*8, which are not supported on some libcs.
+            - name:
+                  Check for use of PRI*8, which are not supported on some libcs.
               if: always()
               run: |
                   git grep -I -n "PRI.8" -- './*' ':(exclude).github/workflows/lint.yml' ':(exclude)third_party/lwip/repo/lwip/src/include/lwip/arch.h' && exit 1 || exit 0
 
             # git grep exits with 0 if it finds a match, but we want
             # to fail (exit nonzero) on match.  And we want to exclude this file,
             # to avoid our grep regexp matching itself.
-            - name: Check for use of PRI*16, which are not supported on some libcs.
+            - name:
+                  Check for use of PRI*16, which are not supported on some
+                  libcs.
               if: always()
               run: |
                   git grep -I -n "PRI.16" -- './*' ':(exclude).github/workflows/lint.yml' ':(exclude)third_party/lwip/repo/lwip/src/include/lwip/arch.h' && exit 1 || exit 0
 
             # git grep exits with 0 if it finds a match, but we want
             # to fail (exit nonzero) on match.  And we want to exclude this file,
             # to avoid our grep regexp matching itself.
-            - name: Check for use of PRI*64, which are not supported on some libcs.
+            - name:
+                  Check for use of PRI*64, which are not supported on some
+                  libcs.
               if: always()
               run: |
                   # TODO: MessageDefHelper should ideally not be excluded here.
@@ -230,22 +237,28 @@ jobs:
             # git grep exits with 0 if it finds a match, but we want
             # to fail (exit nonzero) on match.  And we want to exclude this file,
             # to avoid our grep regexp matching itself.
-            - name: Check for use of 0x%u and the like, which lead to misleading output.
+            - name:
+                  Check for use of 0x%u and the like, which lead to misleading
+                  output.
               if: always()
               run: |
                   git grep -I -n '0x%[0-9l.-]*[^0-9lxX".-]' -- './*' ':(exclude).github/workflows/lint.yml' && exit 1 || exit 0
 
             # git grep exits with 0 if it finds a match, but we want
             # to fail (exit nonzero) on match.  And we want to exclude this file,
             # to avoid our grep regexp matching itself.
-            - name: Check for use of '"0x" PRIu*' and the like, which lead to misleading output.
+            - name:
+                  Check for use of '"0x" PRIu*' and the like, which lead to
+                  misleading output.
               if: always()
               run: |
                   git grep -I -n '0x%[0-9-]*" *PRI[^xX]' -- './*' ':(exclude).github/workflows/lint.yml' && exit 1 || exit 0
 
             # git grep exits with 0 if it finds a match, but we want
             # to fail (exit nonzero) on match.
-            - name: Check for use of NSLog instead of Matter logging in Matter framework
+            - name:
+                  Check for use of NSLog instead of Matter logging in Matter
+                  framework
               if: always()
               run: |
                   git grep -n 'NSLog(' -- src/darwin/Framework/CHIP && exit 1 || exit 0
@@ -254,7 +267,9 @@ jobs:
             # to fail (exit nonzero) on match.  And we want to exclude this file,
             # to avoid our grep regexp matching itself, as well as excluding the files
             # that implement the type-safe accessors
-            - name: Check for use of 'emberAfReadAttribute' instead of the type-safe getters
+            - name:
+                  Check for use of 'emberAfReadAttribute' instead of the
+                  type-safe getters
               if: always()
               run: |
                   git grep -I -n 'emberAfReadAttribute' -- './*' ':(exclude).github/workflows/lint.yml' ':(exclude)src/app/util/attribute-table.h' ':(exclude)zzz_generated/app-common/app-common/zap-generated/attributes/Accessors.cpp' ':(exclude)src/app/zap-templates/templates/app/attributes/Accessors-src.zapt' ':(exclude)src/app/util/attribute-table.cpp'  && exit 1 || exit 0
@@ -264,7 +279,9 @@ jobs:
             # to avoid our grep regexp matching itself, as well as excluding the files
             # that implement the type-safe accessors, attribute writing from the wire, and some
             # Pigweed RPC code that seems hard to update.
-            - name: Check for use of 'emberAfWriteAttribute' instead of the type-safe setters
+            - name:
+                  Check for use of 'emberAfWriteAttribute' instead of the
+                  type-safe setters
               if: always()
               run: |
                   git grep -I -n 'emberAfWriteAttribute' -- './*' ':(exclude).github/workflows/lint.yml' ':(exclude)zzz_generated/app-common/app-common/zap-generated/attributes/Accessors.cpp' ':(exclude)src/app/zap-templates/templates/app/attributes/Accessors-src.zapt' ':(exclude)src/app/util/attribute-table.cpp' ':(exclude)examples/common/pigweed/rpc_services/Attributes.h' ':(exclude)src/app/util/attribute-table.h' ':(exclude)src/app/util/ember-compatibility-functions.cpp' && exit 1 || exit 0
@@ -278,22 +295,29 @@ jobs:
             # git grep exits with 0 if it finds a match, but we want
             # to fail (exit nonzero) on match.  And we want to exclude this file,
             # to avoid our grep regexp matching itself.
-            - name: Check for use of "SuccessOrExit(CHIP_ERROR_*)", which should probably be "SuccessOrExit(err = CHIP_ERROR_*)"
+            - name:
+                  Check for use of "SuccessOrExit(CHIP_ERROR_*)", which should
+                  probably be "SuccessOrExit(err = CHIP_ERROR_*)"
               if: always()
               run: |
                   git grep -I -n 'SuccessOrExit(CHIP_ERROR' -- './*' ':(exclude).github/workflows/lint.yml' && exit 1 || exit 0
 
             # git grep exits with 0 if it finds a match, but we want
             # to fail (exit nonzero) on match.  And we want to exclude this file,
             # to avoid our grep regexp matching itself.
-            - name: Check for use of "SuccessOrExit(something-without-assignment(", which should probably be "SuccessOrExit(err = something("
+            - name:
+                  Check for use of
+                  "SuccessOrExit(something-without-assignment(", which should
+                  probably be "SuccessOrExit(err = something("
               if: always()
               run: |
                   git grep -I -n 'SuccessOrExit([^=)]*(' -- './*' ':(exclude).github/workflows/lint.yml' && exit 1 || exit 0
 
             # git grep exits with 0 if it finds a match, but we want
             # to fail (exit nonzero) on match.
-            - name: Check for use of "using namespace" outside of a class/function in headers.
+            - name:
+                  Check for use of "using namespace" outside of a class/function
+                  in headers.
               if: always()
               run: |
                   # Various platforms have `using namespace chip::Ble` in their BLEManager* headers; just exclude those for now.

.github/workflows/tests.yaml

@@ -508,6 +508,7 @@ jobs:
                   scripts/run_in_python_env.sh out/venv './scripts/tests/run_python_test.py --app out/linux-x64-all-clusters-ipv6only-no-ble-no-wifi-tsan-clang-test/chip-all-clusters-app  --factoryreset --app-args "--discriminator 1234 --KVS kvs1 --trace-to json:out/trace_data/app-{SCRIPT_BASE_NAME}.json" --script "src/python_testing/TC_FAN_3_4.py" --script-args "--storage-path admin_storage.json --commissioning-method on-network --discriminator 1234 --passcode 20202021 --trace-to json:out/trace_data/test-{SCRIPT_BASE_NAME}.json --trace-to perfetto:out/trace_data/test-{SCRIPT_BASE_NAME}.perfetto"'
                   scripts/run_in_python_env.sh out/venv './scripts/tests/run_python_test.py --app out/linux-x64-all-clusters-ipv6only-no-ble-no-wifi-tsan-clang-test/chip-all-clusters-app  --factoryreset --app-args "--discriminator 1234 --KVS kvs1 --trace-to json:out/trace_data/app-{SCRIPT_BASE_NAME}.json" --script "src/python_testing/TC_FAN_3_5.py" --script-args "--storage-path admin_storage.json --commissioning-method on-network --discriminator 1234 --passcode 20202021 --trace-to json:out/trace_data/test-{SCRIPT_BASE_NAME}.json --trace-to perfetto:out/trace_data/test-{SCRIPT_BASE_NAME}.perfetto"'
                   scripts/run_in_python_env.sh out/venv './scripts/tests/run_python_test.py --app out/linux-x64-lit-icd-ipv6only-no-ble-no-wifi-tsan-clang-test/lit-icd-app  --factoryreset --app-args "--discriminator 1234 --KVS kvs1 --trace-to json:out/trace_data/app-{SCRIPT_BASE_NAME}.json" --script "src/python_testing/TC_ICDM_2_1.py" --script-args "--storage-path admin_storage.json --commissioning-method on-network --discriminator 1234 --passcode 20202021 --PICS src/app/tests/suites/certification/ci-pics-values --trace-to json:out/trace_data/test-{SCRIPT_BASE_NAME}.json --trace-to perfetto:out/trace_data/test-{SCRIPT_BASE_NAME}.perfetto"'
+                  scripts/run_in_python_env.sh out/venv './scripts/tests/run_python_test.py --app out/linux-x64-lit-icd-ipv6only-no-ble-no-wifi-tsan-clang-test/lit-icd-app  --factoryreset --app-args "--discriminator 1234 --KVS kvs1 --trace-to json:out/trace_data/app-{SCRIPT_BASE_NAME}.json --enable-key 000102030405060708090a0b0c0d0e0f" --script "src/python_testing/TC_ICDManagementCluster.py" --script-args "--storage-path admin_storage.json --commissioning-method on-network --discriminator 1234 --passcode 20202021 --hex-arg enableKey:000102030405060708090a0b0c0d0e0f --trace-to json:out/trace_data/test-{SCRIPT_BASE_NAME}.json --trace-to perfetto:out/trace_data/test-{SCRIPT_BASE_NAME}.perfetto"'
                   scripts/run_in_python_env.sh out/venv './scripts/tests/run_python_test.py --app out/linux-x64-all-clusters-ipv6only-no-ble-no-wifi-tsan-clang-test/chip-all-clusters-app  --factoryreset --app-args "--discriminator 1234 --KVS kvs1 --trace-to json:out/trace_data/app-{SCRIPT_BASE_NAME}.json" --script "src/python_testing/TC_IDM_1_2.py" --script-args "--storage-path admin_storage.json --commissioning-method on-network --discriminator 1234 --passcode 20202021 --trace-to json:out/trace_data/test-{SCRIPT_BASE_NAME}.json --trace-to perfetto:out/trace_data/test-{SCRIPT_BASE_NAME}.perfetto"'
                   scripts/run_in_python_env.sh out/venv './scripts/tests/run_python_test.py --app out/linux-x64-all-clusters-ipv6only-no-ble-no-wifi-tsan-clang-test/chip-all-clusters-app --factoryreset --app-args "--discriminator 1234 --KVS kvs1 --trace-to json:out/trace_data/app-{SCRIPT_BASE_NAME}.json --enable-key 000102030405060708090a0b0c0d0e0f" --script "src/python_testing/TC_IDM_1_4.py" --script-args "--hex-arg PIXIT.DGGEN.TEST_EVENT_TRIGGER_KEY:000102030405060708090a0b0c0d0e0f --storage-path admin_storage.json --commissioning-method on-network --discriminator 1234 --passcode 20202021 --trace-to json:out/trace_data/test-{SCRIPT_BASE_NAME}.json --trace-to perfetto:out/trace_data/test-{SCRIPT_BASE_NAME}.perfetto"'
                   scripts/run_in_python_env.sh out/venv './scripts/tests/run_python_test.py --app out/linux-x64-all-clusters-ipv6only-no-ble-no-wifi-tsan-clang-test/chip-all-clusters-app  --factoryreset --app-args "--discriminator 1234 --KVS kvs1 --trace-to json:out/trace_data/app-{SCRIPT_BASE_NAME}.json" --script "src/python_testing/TC_PWRTL_2_1.py" --script-args "--storage-path admin_storage.json --commissioning-method on-network --discriminator 1234 --passcode 20202021 --trace-to json:out/trace_data/test-{SCRIPT_BASE_NAME}.json --trace-to perfetto:out/trace_data/test-{SCRIPT_BASE_NAME}.perfetto"'

examples/lighting-app/nxp/k32w/k32w0/BUILD.gn

@@ -112,6 +112,7 @@ k32w0_executable("light_app") {
     "${chip_root}/examples/common/QRCode",
     "${chip_root}/examples/lighting-app/nxp/zap/",
     "${chip_root}/examples/providers:device_info_provider",
+    "${chip_root}/src/app:test-event-trigger",
     "${chip_root}/src/lib",
     "${chip_root}/src/platform:syscalls_stub",
     "${chip_root}/third_party/mbedtls:mbedtls",

src/app/BUILD.gn

@@ -146,6 +146,10 @@ source_set("constants") {
   ]
 }
 
+source_set("test-event-trigger") {
+  sources = [ "TestEventTriggerDelegate.h" ]
+}
+
 # interaction-model is a static-library because it currently requires global functions (app/util/...) that are stubbed in different test files that depend on the app static_library
 # which in tern depens on the interaction-model.
 # Using source_set prevents the unit test to build correctly.

src/app/icd/server/BUILD.gn

@@ -81,6 +81,7 @@ source_set("manager") {
     ":notifier",
     ":observer",
     "${chip_root}/src/app:subscription-info-provider",
+    "${chip_root}/src/app:test-event-trigger",
     "${chip_root}/src/credentials:credentials",
     "${chip_root}/src/messaging",
   ]

src/app/icd/server/ICDManager.cpp

@@ -28,6 +28,14 @@
 #include <platform/internal/CHIPDeviceLayerInternal.h>
 #include <stdlib.h>
 
+namespace {
+enum class ICDTestEventTriggerEvent : uint64_t
+{
+    kAddActiveModeReq    = 0x0046'0000'00000001,
+    kRemoveActiveModeReq = 0x0046'0000'00000002,
+};
+} // namespace
+
 namespace chip {
 namespace app {
 
@@ -643,6 +651,27 @@ void ICDManager::ExtendActiveMode(Milliseconds16 extendDuration)
     }
 }
 
+CHIP_ERROR ICDManager::HandleEventTrigger(uint64_t eventTrigger)
+{
+    ICDTestEventTriggerEvent trigger = static_cast<ICDTestEventTriggerEvent>(eventTrigger);
+    CHIP_ERROR err                   = CHIP_NO_ERROR;
+
+    switch (trigger)
+    {
+    case ICDTestEventTriggerEvent::kAddActiveModeReq:
+        SetKeepActiveModeRequirements(KeepActiveFlag::kTestEventTriggerActiveMode, true);
+        break;
+    case ICDTestEventTriggerEvent::kRemoveActiveModeReq:
+        SetKeepActiveModeRequirements(KeepActiveFlag::kTestEventTriggerActiveMode, false);
+        break;
+    default:
+        err = CHIP_ERROR_INVALID_ARGUMENT;
+        break;
+    }
+
+    return err;
+}
+
 ICDManager::ObserverPointer * ICDManager::RegisterObserver(ICDStateObserver * observer)
 {
     return mStateObserverPool.CreateObject(observer);

src/app/icd/server/ICDManager.h

@@ -16,16 +16,11 @@
  */
 #pragma once
 
-#include <app-common/zap-generated/cluster-enums.h>
-
 #include <app/icd/server/ICDServerConfig.h>
 
-#if CHIP_CONFIG_ENABLE_ICD_CIP
-#include <app/icd/server/ICDCheckInSender.h>   // nogncheck
-#include <app/icd/server/ICDMonitoringTable.h> // nogncheck
-#endif                                         // CHIP_CONFIG_ENABLE_ICD_CIP
-
+#include <app-common/zap-generated/cluster-enums.h>
 #include <app/SubscriptionsInfoProvider.h>
+#include <app/TestEventTriggerDelegate.h>
 #include <app/icd/server/ICDConfigurationData.h>
 #include <app/icd/server/ICDNotifier.h>
 #include <app/icd/server/ICDStateObserver.h>
@@ -38,6 +33,11 @@
 #include <platform/internal/CHIPDeviceLayerInternal.h>
 #include <system/SystemClock.h>
 
+#if CHIP_CONFIG_ENABLE_ICD_CIP
+#include <app/icd/server/ICDCheckInSender.h>   // nogncheck
+#include <app/icd/server/ICDMonitoringTable.h> // nogncheck
+#endif                                         // CHIP_CONFIG_ENABLE_ICD_CIP
+
 namespace chip {
 namespace Crypto {
 using SymmetricKeystore = SessionKeystore;
@@ -54,7 +54,7 @@ class TestICDManager;
 /**
  * @brief ICD Manager is responsible of processing the events and triggering the correct action for an ICD
  */
-class ICDManager : public ICDListener
+class ICDManager : public ICDListener, public TestEventTriggerHandler
 {
 public:
     // This structure is used for the creation an ObjectPool of ICDStateObserver pointers
@@ -129,6 +129,15 @@ class ICDManager : public ICDListener
      */
     uint32_t StayActiveRequest(uint32_t stayActiveDuration);
 
+    /**
+     * @brief TestEventTriggerHandler for the ICD feature set
+     *
+     * @param eventTrigger Event trigger to handle.
+     * @return CHIP_ERROR CHIP_NO_ERROR - No erros during the processing
+     *                    CHIP_ERROR_INVALID_ARGUMENT - eventTrigger isn't a valid value
+     */
+    CHIP_ERROR HandleEventTrigger(uint64_t eventTrigger) override;
+
 #if CHIP_CONFIG_ENABLE_ICD_CIP
     void SendCheckInMsgs();
 
@@ -165,14 +174,14 @@ class ICDManager : public ICDListener
     void OnSubscriptionReport() override;
 
 protected:
+    friend class TestICDManager;
+
     /**
      * @brief Hepler function that extends the Active Mode duration as well as the Active Mode Jitter timer for the transition to
      * iddle mode.
      */
     void ExtendActiveMode(System::Clock::Milliseconds16 extendDuration);
 
-    friend class TestICDManager;
-
     static void OnIdleModeDone(System::Layer * aLayer, void * appState);
     static void OnActiveModeDone(System::Layer * aLayer, void * appState);
 

src/app/icd/server/ICDNotifier.h

@@ -39,11 +39,12 @@ class ICDListener
 public:
     enum class KeepActiveFlagsValues : uint8_t
     {
-        kCommissioningWindowOpen = 0x01,
-        kFailSafeArmed           = 0x02,
-        kExchangeContextOpen     = 0x04,
-        kCheckInInProgress       = 0x08,
-        kInvalidFlag             = 0x10, // Move up when adding more flags
+        kCommissioningWindowOpen    = 0x01,
+        kFailSafeArmed              = 0x02,
+        kExchangeContextOpen        = 0x04,
+        kCheckInInProgress          = 0x08,
+        kTestEventTriggerActiveMode = 0x10,
+        kInvalidFlag                = 0x20, // Move up when adding more flags
     };
 
     enum class ICDManagementEvents : uint8_t

src/app/server/BUILD.gn

@@ -52,6 +52,7 @@ static_library("server") {
 
   public_deps = [
     "${chip_root}/src/app",
+    "${chip_root}/src/app:test-event-trigger",
     "${chip_root}/src/app/icd/server:icd-server-config",
     "${chip_root}/src/app/icd/server:observer",
     "${chip_root}/src/lib/address_resolve",

src/app/server/Server.cpp

@@ -348,6 +348,10 @@ CHIP_ERROR Server::Init(const ServerInitParams & initParams)
 
     mICDManager.Init(mDeviceStorage, &GetFabricTable(), mSessionKeystore, &mExchangeMgr,
                      chip::app::InteractionModelEngine::GetInstance());
+
+    // Register Test Event Trigger Handler
+    mTestEventTriggerDelegate->AddHandler(&mICDManager);
+
 #endif // CHIP_CONFIG_ENABLE_ICD_SERVER
 
     // This code is necessary to restart listening to existing groups after a reboot
@@ -592,6 +596,8 @@ void Server::Shutdown()
     Access::ResetAccessControlToDefault();
     Credentials::SetGroupDataProvider(nullptr);
 #if CHIP_CONFIG_ENABLE_ICD_SERVER
+    // Remove Test Event Trigger Handler
+    mTestEventTriggerDelegate->RemoveHandler(&mICDManager);
     mICDManager.Shutdown();
 #endif // CHIP_CONFIG_ENABLE_ICD_SERVER
     mAttributePersister.Shutdown();