Add TestEventTrigger to the ICDManager

Author: mkardous-silabs

.github/workflows/tests.yaml

@@ -506,6 +506,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"'

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

@@ -42,7 +42,8 @@ static_assert(UINT8_MAX >= CHIP_CONFIG_MAX_EXCHANGE_CONTEXTS,
               "ICDManager::mOpenExchangeContextCount cannot hold count for the max exchange count");
 
 void ICDManager::Init(PersistentStorageDelegate * storage, FabricTable * fabricTable, Crypto::SymmetricKeystore * symmetricKeystore,
-                      Messaging::ExchangeManager * exchangeManager, SubscriptionsInfoProvider * subInfoProvider)
+                      Messaging::ExchangeManager * exchangeManager, SubscriptionsInfoProvider * subInfoProvider,
+                      TestEventTriggerDelegate * testEventTriggerDelegate)
 {
 #if CHIP_CONFIG_ENABLE_ICD_CIP
     VerifyOrDie(storage != nullptr);
@@ -52,6 +53,9 @@ void ICDManager::Init(PersistentStorageDelegate * storage, FabricTable * fabricT
     VerifyOrDie(subInfoProvider != nullptr);
 #endif // CHIP_CONFIG_ENABLE_ICD_CIP
 
+    VerifyOrDie(testEventTriggerDelegate);
+    testEventTriggerDelegate->AddHandler(this);
+
 #if CHIP_CONFIG_ENABLE_ICD_LIT
     // LIT ICD Verification Checks
     if (SupportsFeature(Feature::kLongIdleTimeSupport))
@@ -87,8 +91,11 @@ void ICDManager::Init(PersistentStorageDelegate * storage, FabricTable * fabricT
     UpdateOperationState(OperationalState::IdleMode);
 }
 
-void ICDManager::Shutdown()
+void ICDManager::Shutdown(TestEventTriggerDelegate * testEventTriggerDelegate)
 {
+    VerifyOrDie(testEventTriggerDelegate);
+    testEventTriggerDelegate->RemoveHandler(this);
+
     ICDNotifier::GetInstance().Unsubscribe(this);
 
     // cancel any running timer of the icd
@@ -643,6 +650,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
@@ -93,8 +93,9 @@ class ICDManager : public ICDListener
 
     ICDManager() {}
     void Init(PersistentStorageDelegate * storage, FabricTable * fabricTable, Crypto::SymmetricKeystore * symmetricKeyStore,
-              Messaging::ExchangeManager * exchangeManager, SubscriptionsInfoProvider * manager);
-    void Shutdown();
+              Messaging::ExchangeManager * exchangeManager, SubscriptionsInfoProvider * manager,
+              TestEventTriggerDelegate * testEventTriggerDelegate);
+    void Shutdown(TestEventTriggerDelegate * testEventTriggerDelegate);
     void UpdateICDMode();
     void UpdateOperationState(OperationalState state);
     void SetKeepActiveModeRequirements(KeepActiveFlags flag, bool state);
@@ -129,6 +130,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 +175,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);
 
@@ -191,6 +201,12 @@ class ICDManager : public ICDListener
     uint8_t mOpenExchangeContextCount = 0;
 
 private:
+    enum class ICDTestEventTriggerEvent : uint64_t
+    {
+        kAddActiveModeReq    = 0x0046'0000'00000001,
+        kRemoveActiveModeReq = 0x0046'0000'00000002,
+    };
+
 #if CHIP_CONFIG_ENABLE_ICD_CIP
     bool ShouldCheckInMsgsBeSentAtActiveModeFunction(FabricIndex aFabricIndex, NodeId subjectID);
 

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/Server.cpp

@@ -347,7 +347,7 @@ CHIP_ERROR Server::Init(const ServerInitParams & initParams)
     mICDManager.RegisterObserver(&app::DnssdServer::Instance());
 
     mICDManager.Init(mDeviceStorage, &GetFabricTable(), mSessionKeystore, &mExchangeMgr,
-                     chip::app::InteractionModelEngine::GetInstance());
+                     chip::app::InteractionModelEngine::GetInstance(), mTestEventTriggerDelegate);
 #endif // CHIP_CONFIG_ENABLE_ICD_SERVER
 
     // This code is necessary to restart listening to existing groups after a reboot
@@ -592,7 +592,7 @@ void Server::Shutdown()
     Access::ResetAccessControlToDefault();
     Credentials::SetGroupDataProvider(nullptr);
 #if CHIP_CONFIG_ENABLE_ICD_SERVER
-    mICDManager.Shutdown();
+    mICDManager.Shutdown(mTestEventTriggerDelegate);
 #endif // CHIP_CONFIG_ENABLE_ICD_SERVER
     mAttributePersister.Shutdown();
     // TODO(16969): Remove chip::Platform::MemoryInit() call from Server class, it belongs to outer code

src/app/tests/TestICDManager.cpp

@@ -17,6 +17,7 @@
  */
 #include <app/EventManagement.h>
 #include <app/SubscriptionsInfoProvider.h>
+#include <app/TestEventTriggerDelegate.h>
 #include <app/icd/server/ICDConfigurationData.h>
 #include <app/icd/server/ICDManager.h>
 #include <app/icd/server/ICDNotifier.h>
@@ -53,6 +54,8 @@ constexpr NodeId kClientNodeId12        = 0x100002;
 constexpr NodeId kClientNodeId21        = 0x200001;
 constexpr NodeId kClientNodeId22        = 0x200002;
 
+const uint8_t kTestKey[16] = { 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15 };
+
 constexpr uint8_t kKeyBuffer1a[] = {
     0x10, 0x11, 0x12, 0x13, 0x14, 0x15, 0x16, 0x17, 0x18, 0x19, 0x1a, 0x1b, 0x1c, 0x1d, 0x1e, 0x1f
 };
@@ -91,6 +94,22 @@ class TestSubscriptionsInfoProvider : public SubscriptionsInfoProvider
     bool mHasPersistedSubscription = false;
 };
 
+class TestEventDelegate : public TestEventTriggerDelegate
+{
+public:
+    TestEventDelegate() { mEnableKey = ByteSpan{ kTestKey }; };
+
+    explicit TestEventDelegate(const ByteSpan & enableKey) : mEnableKey(enableKey) {}
+
+    bool DoesEnableKeyMatch(const ByteSpan & enableKey) const override
+    {
+        return !mEnableKey.empty() && mEnableKey.data_equal(enableKey);
+    }
+
+private:
+    ByteSpan mEnableKey;
+};
+
 class TestContext : public chip::Test::AppContext
 {
 public:
@@ -115,16 +134,18 @@ class TestContext : public chip::Test::AppContext
     // Performs setup for each individual test in the test suite
     CHIP_ERROR SetUp() override
     {
+
         ReturnErrorOnFailure(chip::Test::AppContext::SetUp());
-        mICDManager.Init(&testStorage, &GetFabricTable(), &mKeystore, &GetExchangeManager(), &mSubInfoProvider);
+        mICDManager.Init(&testStorage, &GetFabricTable(), &mKeystore, &GetExchangeManager(), &mSubInfoProvider,
+                         &mTestEventDelagate);
         mICDManager.RegisterObserver(&mICDStateObserver);
         return CHIP_NO_ERROR;
     }
 
     // Performs teardown for each individual test in the test suite
     void TearDown() override
     {
-        mICDManager.Shutdown();
+        mICDManager.Shutdown(&mTestEventDelagate);
         chip::Test::AppContext::TearDown();
     }
 
@@ -134,6 +155,7 @@ class TestContext : public chip::Test::AppContext
     TestSubscriptionsInfoProvider mSubInfoProvider;
     TestPersistentStorageDelegate testStorage;
     TestICDStateObserver mICDStateObserver;
+    TestEventDelegate mTestEventDelagate;
 
 private:
     System::Clock::ClockBase * mRealClock;
@@ -514,9 +536,9 @@ class TestICDManager
         uint32_t counter  = ICDConfigurationData::GetInstance().GetICDCounter().GetValue();
 
         // Shut down and reinit ICDManager to increment counter
-        ctx->mICDManager.Shutdown();
+        ctx->mICDManager.Shutdown(&(ctx->mTestEventDelagate));
         ctx->mICDManager.Init(&(ctx->testStorage), &(ctx->GetFabricTable()), &(ctx->mKeystore), &(ctx->GetExchangeManager()),
-                              &(ctx->mSubInfoProvider));
+                              &(ctx->mSubInfoProvider), &(ctx->mTestEventDelagate));
         ctx->mICDManager.RegisterObserver(&(ctx->mICDStateObserver));
 
         NL_TEST_ASSERT_EQUALS(aSuite, counter + ICDConfigurationData::kICDCounterPersistenceIncrement,
@@ -692,6 +714,26 @@ class TestICDManager
         NL_TEST_ASSERT(aSuite, ctx->mICDManager.ShouldCheckInMsgsBeSentAtActiveModeFunction(kTestFabricIndex1, kClientNodeId11));
     }
 #endif // CHIP_CONFIG_PERSIST_SUBSCRIPTIONS
+
+    static void TestHandleTestEventTriggerActiveModeReq(nlTestSuite * aSuite, void * aContext)
+    {
+        TestContext * ctx = static_cast<TestContext *>(aContext);
+
+        // Verify That ICDManager starts in Idle
+        NL_TEST_ASSERT(aSuite, ctx->mICDManager.mOperationalState == ICDManager::OperationalState::IdleMode);
+
+        // Add ActiveMode req for the Test event trigger event
+        ctx->mICDManager.HandleEventTrigger(static_cast<uint64_t>(ICDManager::ICDTestEventTriggerEvent::kAddActiveModeReq));
+        NL_TEST_ASSERT(aSuite, ctx->mICDManager.mOperationalState == ICDManager::OperationalState::ActiveMode);
+
+        // Advance clock by the ActiveModeDuration and check that the device is still in ActiveMode
+        AdvanceClockAndRunEventLoop(ctx, ICDConfigurationData::GetInstance().GetActiveModeDuration() + 1_ms32);
+        NL_TEST_ASSERT(aSuite, ctx->mICDManager.mOperationalState == ICDManager::OperationalState::ActiveMode);
+
+        // Remove req and device should go to IdleMode
+        ctx->mICDManager.HandleEventTrigger(static_cast<uint64_t>(ICDManager::ICDTestEventTriggerEvent::kRemoveActiveModeReq));
+        NL_TEST_ASSERT(aSuite, ctx->mICDManager.mOperationalState == ICDManager::OperationalState::IdleMode);
+    }
 };
 
 } // namespace app
@@ -710,6 +752,7 @@ static const nlTest sTests[] = {
     NL_TEST_DEF("TestICDCounter", TestICDManager::TestICDCounter),
     NL_TEST_DEF("TestICDStayActive", TestICDManager::TestICDMStayActive),
     NL_TEST_DEF("TestShouldCheckInMsgsBeSentAtActiveModeFunction", TestICDManager::TestShouldCheckInMsgsBeSentAtActiveModeFunction),
+    NL_TEST_DEF("TestHandleTestEventTriggerActiveModeReq", TestICDManager::TestHandleTestEventTriggerActiveModeReq),
     NL_TEST_SENTINEL(),
 };