[Groupcast] Align GroupDataProvider limits with membership count (project-chip#43167)

jmartinez-silabs · restyled-commits · web-flow · commit bf354ec0f2c4 · 2026-02-17T09:49:29.000-05:00
* Update GroupDataProvider Constructor, the Max group per fabric and Max keys per fabric configurations inline with groupcast definitions. Add a unit test for LeaveGroup 0 (ALL) command

* Add explicit constructor in the MockGroupDataProvider

* Update all-cluster-app config to set CHIP_CONFIG_MAX_GROUPCAST_MEMBERSHIP_COUNT at 24 for backward compatibility of test TestGroupKeyManagementCluster that still usese Groups cluster. Add one additinal key creation in the test inline with groupdataprovider changes.

* Restyled by whitespace

* Update KeySetWrite command in yaml inline with changes on master

---------

Co-authored-by: Restyled.io &lt;commits@restyled.io&gt;
diff --git a/examples/all-clusters-app/infineon/psoc6/include/CHIPProjectConfig.h b/examples/all-clusters-app/infineon/psoc6/include/CHIPProjectConfig.h
@@ -109,6 +109,11 @@
 // CHIP_CONFIG_MAX_GROUPS_PER_FABRIC is properly configured.
 #define CHIP_CONFIG_MAX_GROUP_ENDPOINTS_PER_FABRIC 3
 
+// Temporary set MaxMembershipCount to 24 for all-cluster-app due to hardcoded TestGroupKeyManagementCluster.yaml
+// Where 12 group are created on a single fabric with the group clusters.
+// TODO cleanup this config #43166
+#define CHIP_CONFIG_MAX_GROUPCAST_MEMBERSHIP_COUNT 24
+
 // Enable `Extension` attribute of ACL Cluster
 #ifndef CHIP_CONFIG_ENABLE_ACL_EXTENSIONS
 #define CHIP_CONFIG_ENABLE_ACL_EXTENSIONS 1
diff --git a/examples/all-clusters-app/linux/include/CHIPProjectAppConfig.h b/examples/all-clusters-app/linux/include/CHIPProjectAppConfig.h
@@ -39,6 +39,11 @@
 // CHIP_CONFIG_MAX_GROUPS_PER_FABRIC is properly configured.
 #define CHIP_CONFIG_MAX_GROUP_ENDPOINTS_PER_FABRIC 3
 
+// Temporary set MaxMembershipCount to 24 for all-cluster-app due to hardcoded TestGroupKeyManagementCluster.yaml
+// Where 12 group are created on a single fabric with the group clusters.
+// TODO cleanup this config #43166
+#define CHIP_CONFIG_MAX_GROUPCAST_MEMBERSHIP_COUNT 24
+
 // Allows app options (ports) to be configured on launch of app
 #define CHIP_DEVICE_ENABLE_PORT_PARAMS 1
 
diff --git a/examples/all-clusters-app/nrfconnect/main/include/CHIPProjectConfig.h b/examples/all-clusters-app/nrfconnect/main/include/CHIPProjectConfig.h
@@ -30,4 +30,9 @@
 // CHIP_CONFIG_MAX_GROUPS_PER_FABRIC is properly configured.
 #define CHIP_CONFIG_MAX_GROUP_ENDPOINTS_PER_FABRIC 3
 
+// Temporary set MaxMembershipCount to 24 for all-cluster-app due to hardcoded TestGroupKeyManagementCluster.yaml
+// Where 12 group are created on a single fabric with the group clusters.
+// TODO cleanup this config #43166
+#define CHIP_CONFIG_MAX_GROUPCAST_MEMBERSHIP_COUNT 24
+
 #define CHIP_CONFIG_ENABLE_ACL_EXTENSIONS 1
diff --git a/examples/all-clusters-app/nxp/zephyr/main/include/CHIPProjectConfig.h b/examples/all-clusters-app/nxp/zephyr/main/include/CHIPProjectConfig.h
@@ -30,4 +30,9 @@
 // CHIP_CONFIG_MAX_GROUPS_PER_FABRIC is properly configured.
 #define CHIP_CONFIG_MAX_GROUP_ENDPOINTS_PER_FABRIC 3
 
+// Temporary set MaxMembershipCount to 24 for all-cluster-app due to hardcoded TestGroupKeyManagementCluster.yaml
+// Where 12 group are created on a single fabric with the group clusters.
+// TODO cleanup this config #43166
+#define CHIP_CONFIG_MAX_GROUPCAST_MEMBERSHIP_COUNT 24
+
 #define CHIP_CONFIG_ENABLE_ACL_EXTENSIONS 1
diff --git a/examples/all-clusters-app/telink/include/CHIPProjectConfig.h b/examples/all-clusters-app/telink/include/CHIPProjectConfig.h
@@ -35,4 +35,9 @@
 // CHIP_CONFIG_MAX_GROUPS_PER_FABRIC is properly configured.
 #define CHIP_CONFIG_MAX_GROUP_ENDPOINTS_PER_FABRIC 3
 
+// Temporary set MaxMembershipCount to 24 for all-cluster-app due to hardcoded TestGroupKeyManagementCluster.yaml
+// Where 12 group are created on a single fabric with the group clusters.
+// TODO cleanup this config #43166
+#define CHIP_CONFIG_MAX_GROUPCAST_MEMBERSHIP_COUNT 24
+
 #define CHIP_CONFIG_ENABLE_ACL_EXTENSIONS 1
diff --git a/examples/all-clusters-app/tizen/include/CHIPProjectAppConfig.h b/examples/all-clusters-app/tizen/include/CHIPProjectAppConfig.h
@@ -34,6 +34,11 @@
 // CHIP_CONFIG_MAX_GROUPS_PER_FABRIC is properly configured.
 #define CHIP_CONFIG_MAX_GROUP_ENDPOINTS_PER_FABRIC 3
 
+// Temporary set MaxMembershipCount to 24 for all-cluster-app due to hardcoded TestGroupKeyManagementCluster.yaml
+// Where 12 group are created on a single fabric with the group clusters.
+// TODO cleanup this config #43166
+#define CHIP_CONFIG_MAX_GROUPCAST_MEMBERSHIP_COUNT 24
+
 // Claim a device type while advertising that matches the device type on our
 // endpoint 1.  0x0101 is the "Dimmable Light" device type.
 #define CHIP_DEVICE_CONFIG_DEVICE_TYPE 0x0101
diff --git a/src/app/clusters/groupcast/tests/TestGroupcastCluster.cpp b/src/app/clusters/groupcast/tests/TestGroupcastCluster.cpp
@@ -369,7 +369,7 @@ TEST_F(TestGroupcastCluster, TestLeaveGroup)
     chip::Testing::ClusterTester tester(mListener);
     tester.SetFabricIndex(kTestFabricIndex);
 
-    // Join grojups
+    // Join groups
     {
         // Group 1
         Commands::JoinGroup::Type data;
@@ -494,11 +494,10 @@ TEST_F(TestGroupcastCluster, TestLeaveGroup)
         }
     }
 
-    // LeaveGroup (all)
+    // LeaveGroup a List of endpoints from all groups
     {
         Commands::LeaveGroup::Type data;
 
-        // Update existing key (invalid)
         data.groupID = 0;
         data.endpoints =
             MakeOptional(chip::app::DataModel::List<const EndpointId>(kLeaveEndpoints2, MATTER_ARRAY_SIZE(kLeaveEndpoints2)));
@@ -547,6 +546,26 @@ TEST_F(TestGroupcastCluster, TestLeaveGroup)
             group_id++;
         }
     }
+
+    // LeaveGroup all groups completely.
+    {
+        Commands::LeaveGroup::Type data;
+        data.groupID = 0;
+        auto result  = tester.Invoke(Commands::LeaveGroup::Id, data);
+        ASSERT_TRUE(result.status.has_value());
+        EXPECT_EQ(result.status.value().GetStatusCode().GetStatus(), // NOLINT(bugprone-unchecked-optional-access)
+                  Protocols::InteractionModel::Status::Success);
+    }
+
+    // Read Membership
+    {
+        app::Clusters::Groupcast::Attributes::Membership::TypeInfo::DecodableType memberships;
+        ASSERT_EQ(tester.ReadAttribute(Attributes::Membership::Id, memberships), CHIP_NO_ERROR);
+
+        size_t memershipCount = 0;
+        ASSERT_EQ(CountListElements(memberships, memershipCount), CHIP_NO_ERROR);
+        ASSERT_EQ(memershipCount, 0u);
+    }
 }
 
 TEST_F(TestGroupcastCluster, TestUpdateGroupKey)
diff --git a/src/app/clusters/scenes-server/tests/TestScenesManagementCluster.cpp b/src/app/clusters/scenes-server/tests/TestScenesManagementCluster.cpp
@@ -165,6 +165,7 @@ class MockSceneHandler : public scenes::SceneHandler
 class MockGroupDataProvider : public GroupDataProvider
 {
 public:
+    MockGroupDataProvider() : GroupDataProvider(0, 0) {}
     CHIP_ERROR Init() override { return CHIP_NO_ERROR; }
     void Finish() override {}
     CHIP_ERROR SetGroupInfo(FabricIndex, const GroupInfo &) override { return CHIP_NO_ERROR; }
diff --git a/src/app/tests/suites/TestGroupKeyManagementCluster.yaml b/src/app/tests/suites/TestGroupKeyManagementCluster.yaml
@@ -608,7 +608,10 @@ tests:
                     # Note: There's always an IPK keyset with index 0
                     contains: [0x01a1, 0x01a2, 0]
 
-    - label: "Write one keyset too many when already full"
+    # TODO: This is really hardcoded based on the default value of CHIP_CONFIG_MAX_GROUP_KEYS_PER_FABRIC.
+    # Logic should be added to handle configurations variability.
+    # To do so, this whole test should be moved to python tests for better flexibility.
+    - label: "Write additional KeySets to reach fabric 1 capacity"
       command: "KeySetWrite"
       arguments:
           values:
@@ -625,6 +628,24 @@ tests:
                         EpochStartTime2: 3110002,
                         GroupKeyMulticastPolicy: 0,
                     }
+
+    - label: "Write one keyset too many when already full"
+      command: "KeySetWrite"
+      arguments:
+          values:
+              - name: "GroupKeySet"
+                value:
+                    {
+                        GroupKeySetID: 0x0333,
+                        GroupKeySecurityPolicy: 0,
+                        EpochKey0: "\xd1\xd1\xd2\xd3\xd4\xd5\xd6\xd7\xd8\xd9\xda\xdb\xdc\xdd\xde\xdf",
+                        EpochStartTime0: 3110000,
+                        EpochKey1: "\xe1\xe1\xe2\xe3\xe4\xe5\xe6\xe7\xe8\xe9\xea\xeb\xec\xed\xee\xef",
+                        EpochStartTime1: 3110001,
+                        EpochKey2: "\xf1\xf1\xf2\xf3\xf4\xf5\xf6\xf7\xf8\xf9\xfa\xfb\xfc\xfd\xfe\xff",
+                        EpochStartTime2: 3110002,
+                        GroupKeyMulticastPolicy: 0,
+                    }
       response:
           error: RESOURCE_EXHAUSTED
 
diff --git a/src/controller/python/BUILD.gn b/src/controller/python/BUILD.gn
@@ -105,8 +105,8 @@ shared_library("ChipDeviceCtrl") {
       ]
     }
     defines += [ "CHIP_CONFIG_MAX_ACTIVE_TCP_CONNECTIONS=20" ]
-    defines += [ "CHIP_CONFIG_MAX_GROUPS_PER_FABRIC=50" ]
     defines += [ "CHIP_CONFIG_MAX_GROUP_KEYS_PER_FABRIC=50" ]
+    defines += [ "CHIP_CONFIG_MAX_GROUPCAST_MEMBERSHIP_COUNT=100" ]
 
     if (chip_python_supports_stack_locking) {
       sources += [ "matter/native/ChipMainLoopWork_StackLock.cpp" ]
diff --git a/src/credentials/GroupDataProvider.h b/src/credentials/GroupDataProvider.h
@@ -224,10 +224,8 @@ class GroupDataProvider
     using KeySetIterator       = CommonIterator<KeySet>;
     using GroupSessionIterator = CommonIterator<GroupSession>;
 
-    GroupDataProvider(uint16_t maxGroupsPerFabric    = CHIP_CONFIG_MAX_GROUPS_PER_FABRIC,
-                      uint16_t maxGroupKeysPerFabric = CHIP_CONFIG_MAX_GROUP_KEYS_PER_FABRIC) :
-        mMaxGroupsPerFabric(maxGroupsPerFabric),
-        mMaxGroupKeysPerFabric(maxGroupKeysPerFabric)
+    GroupDataProvider(uint16_t maxGroupsPerFabric, uint16_t maxGroupKeysPerFabric) :
+        mMaxGroupsPerFabric(maxGroupsPerFabric), mMaxGroupKeysPerFabric(maxGroupKeysPerFabric)
     {}
 
     virtual ~GroupDataProvider() = default;
diff --git a/src/credentials/GroupDataProviderImpl.h b/src/credentials/GroupDataProviderImpl.h
@@ -28,10 +28,15 @@ class GroupDataProviderImpl : public GroupDataProvider
 {
 public:
     static constexpr size_t kIteratorsMax         = CHIP_CONFIG_MAX_GROUP_CONCURRENT_ITERATORS;
-    static constexpr uint16_t kMaxMembershipCount = 10;
-    static constexpr uint16_t kMaxMcastAddrCount  = 4;
+    static constexpr uint16_t kMaxMembershipCount = CHIP_CONFIG_MAX_GROUPCAST_MEMBERSHIP_COUNT;
+    // Per spec, a single fabric cannot use more than half of the total memberships
+    static constexpr uint16_t kMaxMembershipPerFabric = kMaxMembershipCount / 2;
+    static constexpr uint16_t kMaxGroupKeysPerFabric  = CHIP_CONFIG_MAX_GROUP_KEYS_PER_FABRIC;
 
-    GroupDataProviderImpl() = default;
+    // TODO Make this configurable. Note: if PGA feature is enabled it SHALL be >= 4. else it SHALL = 1.
+    static constexpr uint16_t kMaxMcastAddrCount = 4;
+
+    GroupDataProviderImpl() : GroupDataProvider(kMaxMembershipPerFabric, kMaxGroupKeysPerFabric) {}
     GroupDataProviderImpl(uint16_t maxGroupsPerFabric, uint16_t maxGroupKeysPerFabric) :
         GroupDataProvider(maxGroupsPerFabric, maxGroupKeysPerFabric)
     {}
@@ -103,7 +108,7 @@ class GroupDataProviderImpl : public GroupDataProvider
     Crypto::SymmetricKeyContext * GetKeyContext(FabricIndex fabric_index, GroupId group_id) override;
     GroupSessionIterator * IterateGroupSessions(uint16_t session_id) override;
 
-    // Groupcast
+    // Groupcast configurations
     uint16_t getMaxMembershipCount() override { return kMaxMembershipCount; }
     uint16_t getMaxMcastAddrCount() override { return kMaxMcastAddrCount; }
 
diff --git a/src/lib/core/CHIPConfig.h b/src/lib/core/CHIPConfig.h
@@ -1107,6 +1107,7 @@ extern const char CHIP_NON_PRODUCTION_MARKER[];
  * @brief Defines the number of "endpoint->controlling group" mappings per fabric.
  *
  * Binds to number of GroupMapping entries per fabric
+ * TODO cleanup this config #43166
  */
 #ifndef CHIP_CONFIG_MAX_GROUP_ENDPOINTS_PER_FABRIC
 #define CHIP_CONFIG_MAX_GROUP_ENDPOINTS_PER_FABRIC 1
@@ -1121,12 +1122,22 @@ extern const char CHIP_NON_PRODUCTION_MARKER[];
 #define CHIP_CONFIG_MAX_BINDING_ENTRIES_PER_FABRIC 4
 #endif
 
+/**
+ * @def CHIP_CONFIG_MAX_GROUPCAST_MEMBERSHIP_COUNT
+ *
+ * @brief Defines the maximum number of group memberships
+ */
+#ifndef CHIP_CONFIG_MAX_GROUPCAST_MEMBERSHIP_COUNT
+#define CHIP_CONFIG_MAX_GROUPCAST_MEMBERSHIP_COUNT 10
+#endif // CHIP_CONFIG_MAX_GROUPCAST_MEMBERSHIP_COUNT
+
 /**
  * @def CHIP_CONFIG_MAX_GROUPS_PER_FABRIC
  *
  * @brief Defines the number of groups supported per fabric, see Group Key Management Cluster in specification.
  *
  * Binds to number of GroupState entries to support per fabric
+ * TODO cleanup this config #43166
  */
 #ifndef CHIP_CONFIG_MAX_GROUPS_PER_FABRIC
 #define CHIP_CONFIG_MAX_GROUPS_PER_FABRIC (4 * CHIP_CONFIG_MAX_GROUP_ENDPOINTS_PER_FABRIC)
@@ -1144,7 +1155,7 @@ extern const char CHIP_NON_PRODUCTION_MARKER[];
  * Binds to number of KeySet entries to support per fabric (Need at least 1 for Identity Protection Key)
  */
 #ifndef CHIP_CONFIG_MAX_GROUP_KEYS_PER_FABRIC
-#define CHIP_CONFIG_MAX_GROUP_KEYS_PER_FABRIC 3
+#define CHIP_CONFIG_MAX_GROUP_KEYS_PER_FABRIC (3 + 1) // support 3 KeySets + IPK per fabric
 #endif
 
 #if CHIP_CONFIG_MAX_GROUP_KEYS_PER_FABRIC < 1

Original file line number	Diff line number	Diff line change
`@@ -165,6 +165,7 @@ class MockSceneHandler : public scenes::SceneHandler`
`165`	`165`	`class MockGroupDataProvider : public GroupDataProvider`
`166`	`166`	`{`
`167`	`167`	`public:`
	`168`	`+ MockGroupDataProvider() : GroupDataProvider(0, 0) {}`
`168`	`169`	`CHIP_ERROR Init() override { return CHIP_NO_ERROR; }`
`169`	`170`	`void Finish() override {}`
`170`	`171`	`CHIP_ERROR SetGroupInfo(FabricIndex, const GroupInfo &) override { return CHIP_NO_ERROR; }`
Original file line number	Diff line number	Diff line change
`@@ -105,8 +105,8 @@ shared_library("ChipDeviceCtrl") {`
`105`	`105`	`]`
`106`	`106`	`}`
`107`	`107`	`defines += [ "CHIP_CONFIG_MAX_ACTIVE_TCP_CONNECTIONS=20" ]`
`108`		`- defines += [ "CHIP_CONFIG_MAX_GROUPS_PER_FABRIC=50" ]`
`109`	`108`	`defines += [ "CHIP_CONFIG_MAX_GROUP_KEYS_PER_FABRIC=50" ]`
	`109`	`+ defines += [ "CHIP_CONFIG_MAX_GROUPCAST_MEMBERSHIP_COUNT=100" ]`
`110`	`110`
`111`	`111`	`if (chip_python_supports_stack_locking) {`
`112`	`112`	`sources += [ "matter/native/ChipMainLoopWork_StackLock.cpp" ]`