From 8d0e7f1a2812e1adb3140a2a700a6746b2dfb548 Mon Sep 17 00:00:00 2001
From: Matt Swartwout <mwswartwout@google.com>
Date: Thu, 25 Apr 2024 03:23:22 +0000
Subject: [PATCH] Add equality operator to StatusIB
---
src/app/MessageDef/StatusIB.h | 10 +++++++++
src/app/tests/TestStatusIB.cpp | 39 ++++++++++++++++++++++++++++++++++
2 files changed, 49 insertions(+)
diff --git a/src/app/MessageDef/StatusIB.h b/src/app/MessageDef/StatusIB.h
index 0dadccc58ee527..f5ade6cc71c628 100644
--- a/src/app/MessageDef/StatusIB.h
+++ b/src/app/MessageDef/StatusIB.h
@@ -117,5 +117,15 @@ struct StatusIB
}; // struct StatusIB
+constexpr bool operator==(const StatusIB & one, const StatusIB & two)
+{
+ return one.mStatus == two.mStatus && one.mClusterStatus == two.mClusterStatus;
+}
+
+constexpr bool operator!=(const StatusIB & one, const StatusIB & two)
+{
+ return !(one == two);
+}
+
}; // namespace app
}; // namespace chip
diff --git a/src/app/tests/TestStatusIB.cpp b/src/app/tests/TestStatusIB.cpp
index 3eb47f438f67df..2e5f78f7da64f7 100644
--- a/src/app/tests/TestStatusIB.cpp
+++ b/src/app/tests/TestStatusIB.cpp
@@ -113,6 +113,44 @@ void TestStatusIBErrorToString(nlTestSuite * aSuite, void * aContext)
}
#endif // !CHIP_CONFIG_SHORT_ERROR_STR
+void TestStatusIBEqualityOperator(nlTestSuite * aSuite, void * /*aContext*/)
+{
+ // Equality against self is true.
+ StatusIB one;
+ NL_TEST_ASSERT(aSuite, one == one);
+
+ // Default constructors are equal.
+ NL_TEST_ASSERT(aSuite, one == StatusIB());
+
+ // Different imStatus is not equal.
+ StatusIB with_imstatus(Status::Failure);
+ NL_TEST_ASSERT(aSuite, one != with_imstatus);
+
+ // Same imStatus are equal.
+ NL_TEST_ASSERT(aSuite, with_imstatus == StatusIB(Status::Failure));
+
+ // Same imStatus but different clusterStatus are not equal.
+ StatusIB with_cluster_status(Status::Failure, /*clusterStatus=*/2);
+ NL_TEST_ASSERT(aSuite, with_imstatus != with_cluster_status);
+
+ // Different imStatus but same clusterStatus are not equal.
+ NL_TEST_ASSERT(aSuite, with_cluster_status != StatusIB(Status::Success, /*clusterStatus=*/2));
+
+ // Same imStatus and clusterStatus are equal.
+ NL_TEST_ASSERT(aSuite, with_cluster_status == StatusIB(Status::Failure, /*clusterStatus=*/2));
+
+ // From same CHIP_ERROR are equal.
+ StatusIB invalid_argument(CHIP_ERROR_INVALID_ARGUMENT);
+ NL_TEST_ASSERT(aSuite, invalid_argument == StatusIB(CHIP_ERROR_INVALID_ARGUMENT));
+
+ // Different CHIP_ERROR are equal if they are not from kIMClusterStatus or
+ // kIMGlobalStatus.
+ NL_TEST_ASSERT(aSuite, invalid_argument == StatusIB(CHIP_ERROR_INCORRECT_STATE));
+
+ // Error never equals NO_ERROR
+ NL_TEST_ASSERT(aSuite, invalid_argument != StatusIB(CHIP_NO_ERROR));
+}
+
// clang-format off
const nlTest sTests[] =
{
@@ -120,6 +158,7 @@ const nlTest sTests[] =
#if !CHIP_CONFIG_SHORT_ERROR_STR
NL_TEST_DEF("StatusIBErrorToString", TestStatusIBErrorToString),
#endif // !CHIP_CONFIG_SHORT_ERROR_STR
+ NL_TEST_DEF("StatusIBEqualityOperator", TestStatusIBEqualityOperator),
NL_TEST_SENTINEL()
};
// clang-format on