From 1064908ddd46b0e334c67b914b0ff9c6c4d32c6e Mon Sep 17 00:00:00 2001 From: jrhees-cae <61466710+jrhees-cae@users.noreply.github.com> Date: Mon, 13 Mar 2023 17:32:53 -0400 Subject: [PATCH] Generate WrongCodeEntryLimit DoorLockAlarm event when lockout is engaged (#25436) * Generate WrongCodeEntryLimit DoorLockAlarm event when lockout is engaged (#25420) Update DL_LockUnlock YAML test to test for event. * Fix restyle issue * trigger GitHub actions * Generate WrongCodeEntryLimit DoorLockAlarm event when lockout is engaged (#25420) Update DL_LockUnlock YAML test to test for event. * Fix restyle issue --- .../door-lock-server/door-lock-server.cpp | 2 + src/app/tests/suites/DL_LockUnlock.yaml | 8 ++ .../chip-tool/zap-generated/test/Commands.h | 105 +++++++++++------- 3 files changed, 74 insertions(+), 41 deletions(-) diff --git a/src/app/clusters/door-lock-server/door-lock-server.cpp b/src/app/clusters/door-lock-server/door-lock-server.cpp index d294803ab60e89..78ed3f63ac06b2 100644 --- a/src/app/clusters/door-lock-server/door-lock-server.cpp +++ b/src/app/clusters/door-lock-server/door-lock-server.cpp @@ -255,6 +255,8 @@ bool DoorLockServer::engageLockout(chip::EndpointId endpointId) emberAfDoorLockClusterPrintln("Lockout engaged [endpointId=%d,lockoutTimeout=%d]", endpointId, lockoutTimeout); + SendLockAlarmEvent(endpointId, AlarmCodeEnum::kWrongCodeEntryLimit); + emberAfPluginDoorLockLockoutStarted(endpointId, endpointContext->lockoutEndTimestamp); return true; diff --git a/src/app/tests/suites/DL_LockUnlock.yaml b/src/app/tests/suites/DL_LockUnlock.yaml index 7eab03dbc63e44..a07c8c515c1d53 100644 --- a/src/app/tests/suites/DL_LockUnlock.yaml +++ b/src/app/tests/suites/DL_LockUnlock.yaml @@ -394,6 +394,14 @@ tests: response: error: FAILURE + - label: + "Read the DoorLockAlarm event list; verify WrongEntryCodeLimit alarm + has been generated" + command: "readEvent" + event: "DoorLockAlarm" + response: + value: { "AlarmCode": 4 } + - label: "Wait for the lockout to end" cluster: "DelayCommands" command: "WaitForMs" diff --git a/zzz_generated/chip-tool/zap-generated/test/Commands.h b/zzz_generated/chip-tool/zap-generated/test/Commands.h index 8e396b0c1ca79b..ea8348cb0a492e 100644 --- a/zzz_generated/chip-tool/zap-generated/test/Commands.h +++ b/zzz_generated/chip-tool/zap-generated/test/Commands.h @@ -78376,7 +78376,7 @@ class DL_UsersAndCredentialsSuite : public TestCommand class DL_LockUnlockSuite : public TestCommand { public: - DL_LockUnlockSuite(CredentialIssuerCommands * credsIssuerConfig) : TestCommand("DL_LockUnlock", 53, credsIssuerConfig) + DL_LockUnlockSuite(CredentialIssuerCommands * credsIssuerConfig) : TestCommand("DL_LockUnlock", 54, credsIssuerConfig) { AddArgument("nodeId", 0, UINT64_MAX, &mNodeId); AddArgument("cluster", &mCluster); @@ -78687,13 +78687,30 @@ class DL_LockUnlockSuite : public TestCommand VerifyOrReturn(CheckValue("status", chip::to_underlying(status.mStatus), EMBER_ZCL_STATUS_FAILURE)); break; case 39: - VerifyOrReturn(CheckValue("status", chip::to_underlying(status.mStatus), 0)); - shouldContinue = true; + switch (mTestSubStepIndex) + { + case 0: + VerifyOrReturn(CheckValue("status", chip::to_underlying(status.mStatus), 0)); + { + chip::app::Clusters::DoorLock::Events::DoorLockAlarm::DecodableType value; + VerifyOrReturn(CheckDecodeValue(chip::app::DataModel::Decode(*data, value))); + VerifyOrReturn(CheckValue("doorLockAlarm.alarmCode", value.alarmCode, 4U)); + } + mTestSubStepIndex++; + break; + default: + LogErrorOnFailure(ContinueOnChipMainThread(CHIP_ERROR_INVALID_ARGUMENT)); + break; + } break; case 40: VerifyOrReturn(CheckValue("status", chip::to_underlying(status.mStatus), 0)); + shouldContinue = true; break; case 41: + VerifyOrReturn(CheckValue("status", chip::to_underlying(status.mStatus), 0)); + break; + case 42: VerifyOrReturn(CheckValue("status", chip::to_underlying(status.mStatus), 0)); { chip::app::DataModel::Nullable value; @@ -78702,10 +78719,10 @@ class DL_LockUnlockSuite : public TestCommand VerifyOrReturn(CheckValue("lockState.Value()", value.Value(), 2U)); } break; - case 42: + case 43: VerifyOrReturn(CheckValue("status", chip::to_underlying(status.mStatus), 0)); break; - case 43: + case 44: VerifyOrReturn(CheckValue("status", chip::to_underlying(status.mStatus), 0)); { chip::app::Clusters::DoorLock::Commands::SetCredentialResponse::DecodableType value; @@ -78717,10 +78734,10 @@ class DL_LockUnlockSuite : public TestCommand VerifyOrReturn(CheckValue("nextCredentialIndex.Value()", value.nextCredentialIndex.Value(), 4U)); } break; - case 44: + case 45: VerifyOrReturn(CheckValue("status", chip::to_underlying(status.mStatus), EMBER_ZCL_STATUS_FAILURE)); break; - case 45: + case 46: VerifyOrReturn(CheckValue("status", chip::to_underlying(status.mStatus), 0)); { chip::app::DataModel::Nullable value; @@ -78729,10 +78746,10 @@ class DL_LockUnlockSuite : public TestCommand VerifyOrReturn(CheckValue("lockState.Value()", value.Value(), 1U)); } break; - case 46: + case 47: VerifyOrReturn(CheckValue("status", chip::to_underlying(status.mStatus), 0)); break; - case 47: + case 48: VerifyOrReturn(CheckValue("status", chip::to_underlying(status.mStatus), 0)); { chip::app::DataModel::Nullable value; @@ -78741,10 +78758,10 @@ class DL_LockUnlockSuite : public TestCommand VerifyOrReturn(CheckValue("lockState.Value()", value.Value(), 2U)); } break; - case 48: + case 49: VerifyOrReturn(CheckValue("status", chip::to_underlying(status.mStatus), EMBER_ZCL_STATUS_FAILURE)); break; - case 49: + case 50: VerifyOrReturn(CheckValue("status", chip::to_underlying(status.mStatus), 0)); { chip::app::DataModel::Nullable value; @@ -78753,10 +78770,10 @@ class DL_LockUnlockSuite : public TestCommand VerifyOrReturn(CheckValue("lockState.Value()", value.Value(), 2U)); } break; - case 50: + case 51: VerifyOrReturn(CheckValue("status", chip::to_underlying(status.mStatus), 0)); break; - case 51: + case 52: VerifyOrReturn(CheckValue("status", chip::to_underlying(status.mStatus), 0)); { chip::app::DataModel::Nullable value; @@ -78765,7 +78782,7 @@ class DL_LockUnlockSuite : public TestCommand VerifyOrReturn(CheckValue("lockState.Value()", value.Value(), 1U)); } break; - case 52: + case 53: VerifyOrReturn(CheckValue("status", chip::to_underlying(status.mStatus), 0)); break; default: @@ -79133,14 +79150,20 @@ class DL_LockUnlockSuite : public TestCommand ); } case 39: { - LogStep(39, "Wait for the lockout to end"); + LogStep(39, "Read the DoorLockAlarm event list; verify WrongEntryCodeLimit alarm has been generated"); + mTestSubStepCount = 1; + return ReadEvent(kIdentityAlpha, GetEndpoint(1), DoorLock::Id, DoorLock::Events::DoorLockAlarm::Id, false, + chip::NullOptional); + } + case 40: { + LogStep(40, "Wait for the lockout to end"); ListFreer listFreer; chip::app::Clusters::DelayCommands::Commands::WaitForMs::Type value; value.ms = 10000UL; return WaitForMs(kIdentityAlpha, value); } - case 40: { - LogStep(40, "Try to unlock the door with valid PIN and make sure it succeeds"); + case 41: { + LogStep(41, "Try to unlock the door with valid PIN and make sure it succeeds"); ListFreer listFreer; chip::app::Clusters::DoorLock::Commands::UnlockDoor::Type value; value.PINCode.Emplace(); @@ -79150,13 +79173,13 @@ class DL_LockUnlockSuite : public TestCommand ); } - case 41: { - LogStep(41, "Verify that lock state attribute value is set to Unlocked"); + case 42: { + LogStep(42, "Verify that lock state attribute value is set to Unlocked"); return ReadAttribute(kIdentityAlpha, GetEndpoint(1), DoorLock::Id, DoorLock::Attributes::LockState::Id, true, chip::NullOptional); } - case 42: { - LogStep(42, "Lock the door back prior to next tests"); + case 43: { + LogStep(43, "Lock the door back prior to next tests"); ListFreer listFreer; chip::app::Clusters::DoorLock::Commands::LockDoor::Type value; value.PINCode.Emplace(); @@ -79166,8 +79189,8 @@ class DL_LockUnlockSuite : public TestCommand ); } - case 43: { - LogStep(43, "Create a disabled user and credential"); + case 44: { + LogStep(44, "Create a disabled user and credential"); ListFreer listFreer; chip::app::Clusters::DoorLock::Commands::SetCredential::Type value; value.operationType = static_cast(0); @@ -79185,8 +79208,8 @@ class DL_LockUnlockSuite : public TestCommand ); } - case 44: { - LogStep(44, "Try to unlock the door with disabled user PIN"); + case 45: { + LogStep(45, "Try to unlock the door with disabled user PIN"); ListFreer listFreer; chip::app::Clusters::DoorLock::Commands::UnlockDoor::Type value; value.PINCode.Emplace(); @@ -79196,13 +79219,13 @@ class DL_LockUnlockSuite : public TestCommand ); } - case 45: { - LogStep(45, "Verify that lock state attribute value is set to Locked"); + case 46: { + LogStep(46, "Verify that lock state attribute value is set to Locked"); return ReadAttribute(kIdentityAlpha, GetEndpoint(1), DoorLock::Id, DoorLock::Attributes::LockState::Id, true, chip::NullOptional); } - case 46: { - LogStep(46, "Unlock the door with enabled user PIN"); + case 47: { + LogStep(47, "Unlock the door with enabled user PIN"); ListFreer listFreer; chip::app::Clusters::DoorLock::Commands::UnlockDoor::Type value; value.PINCode.Emplace(); @@ -79212,13 +79235,13 @@ class DL_LockUnlockSuite : public TestCommand ); } - case 47: { - LogStep(47, "Verify that lock state attribute value is set to Unlocked"); + case 48: { + LogStep(48, "Verify that lock state attribute value is set to Unlocked"); return ReadAttribute(kIdentityAlpha, GetEndpoint(1), DoorLock::Id, DoorLock::Attributes::LockState::Id, true, chip::NullOptional); } - case 48: { - LogStep(48, "Try to lock the door with disabled user PIN"); + case 49: { + LogStep(49, "Try to lock the door with disabled user PIN"); ListFreer listFreer; chip::app::Clusters::DoorLock::Commands::LockDoor::Type value; value.PINCode.Emplace(); @@ -79228,13 +79251,13 @@ class DL_LockUnlockSuite : public TestCommand ); } - case 49: { - LogStep(49, "Verify that lock state attribute value stays Unlocked"); + case 50: { + LogStep(50, "Verify that lock state attribute value stays Unlocked"); return ReadAttribute(kIdentityAlpha, GetEndpoint(1), DoorLock::Id, DoorLock::Attributes::LockState::Id, true, chip::NullOptional); } - case 50: { - LogStep(50, "Lock the door with enabled user PIN"); + case 51: { + LogStep(51, "Lock the door with enabled user PIN"); ListFreer listFreer; chip::app::Clusters::DoorLock::Commands::LockDoor::Type value; value.PINCode.Emplace(); @@ -79244,13 +79267,13 @@ class DL_LockUnlockSuite : public TestCommand ); } - case 51: { - LogStep(51, "Verify that lock state attribute value is set to Locked"); + case 52: { + LogStep(52, "Verify that lock state attribute value is set to Locked"); return ReadAttribute(kIdentityAlpha, GetEndpoint(1), DoorLock::Id, DoorLock::Attributes::LockState::Id, true, chip::NullOptional); } - case 52: { - LogStep(52, "Clean all the users and credentials"); + case 53: { + LogStep(53, "Clean all the users and credentials"); ListFreer listFreer; chip::app::Clusters::DoorLock::Commands::ClearUser::Type value; value.userIndex = 65534U;