Small fixes to cluster unit testing infrastructure (project-chip#41882)

* Add error logging to `Is*ListEqualTo` functions

* Add `GetNextGeneratedEvent` to class `Cluster` and make `Invoke` fully deduce template parameters

This was removed from PR project-chip#41603 by mistake

* Restyled by clang-format

* Update `ClusterTester::Invoke` usage in `TestGroupcastCluster.cpp`

* Update comment for `ClusterTester::Invoke`

* Add license notice and `#pragma once` in some files.

* Use initializer list for `IsGeneratedCommandsListEqualTo`

---------

Co-authored-by: Restyled.io <[email protected]>

Author: Hayk10002

src/app/clusters/groupcast/tests/TestGroupcastCluster.cpp

@@ -117,8 +117,7 @@ TEST_F(TestGroupcastCluster, TestJoinGroupCommand)
 
     chip::app::Testing::MockCommandHandler cmdHandler;
     chip::Test::ClusterTester tester(cluster);
-    auto result =
-        tester.Invoke<Commands::JoinGroup::Type::ResponseType, Commands::JoinGroup::Type>(Commands::JoinGroup::Id, cmdData);
+    auto result = tester.Invoke(Commands::JoinGroup::Id, cmdData);
     ASSERT_TRUE(result.status.has_value());
     EXPECT_EQ(result.status.value().GetStatusCode().GetStatus(), // NOLINT(bugprone-unchecked-optional-access)
               Protocols::InteractionModel::Status::Failure);     // Currently expect Failure as JoinGroup command returns

src/app/clusters/testing/AttributeTesting.h

@@ -14,6 +14,7 @@
  *    limitations under the License.
  */
 
+#pragma once
 #include <app/data-model-provider/MetadataTypes.h>
 #include <lib/support/Span.h>
 

src/app/clusters/testing/ClusterTester.h

@@ -14,6 +14,7 @@
  *    limitations under the License.
  */
 
+#pragma once
 #include <app/AttributeValueDecoder.h>
 #include <app/AttributeValueEncoder.h>
 #include <app/CommandHandler.h>
@@ -144,12 +145,11 @@ class ClusterTester
     };
 
     // Invoke a command and return the decoded result.
-    // The `RequestType`, `ResponseType` type-parameters must be of the correct type for the command being invoked.
-    // Use `app::Clusters::<ClusterName>::Commands::<CommandName>::Type` for the `RequestType` type-parameter to be spec compliant
-    // Use `app::Clusters::<ClusterName>::Commands::<CommandName>::Type::ResponseType` for the `ResponseType` type-parameter to be
-    // spec compliant Will construct the command path using the first path returned by `GetPaths()` on the cluster.
+    // The `request` parameter must be of the correct type for the command being invoked.
+    // Use `app::Clusters::<ClusterName>::Commands::<CommandName>::Type` for the `request` parameter to be spec compliant
+    // Will construct the command path using the first path returned by `GetPaths()` on the cluster.
     // @returns `CHIP_ERROR_INCORRECT_STATE` if `GetPaths()` doesn't return a list with one path.
-    template <typename ResponseType, typename RequestType>
+    template <typename RequestType, typename ResponseType = typename RequestType::ResponseType>
     [[nodiscard]] InvokeResult<ResponseType> Invoke(chip::CommandId commandId, const RequestType & request)
     {
         InvokeResult<ResponseType> result;
@@ -198,6 +198,12 @@ class ClusterTester
         return result;
     }
 
+    // Returns the next generated event from the event generator in the test server cluster context
+    std::optional<LogOnlyEvents::EventInformation> GetNextGeneratedEvent()
+    {
+        return mTestServerClusterContext.EventsGenerator().GetNextEvent();
+    }
+
 private:
     bool VerifyClusterPathsValid()
     {

src/app/clusters/testing/ValidateGlobalAttributes.cpp

@@ -23,8 +23,9 @@ bool IsAttributesListEqualTo(app::ServerClusterInterface & cluster,
     VerifyOrDie(cluster.GetPaths().size() == 1);
     auto path = cluster.GetPaths()[0];
     ReadOnlyBufferBuilder<app::DataModel::AttributeEntry> attributesBuilder;
-    if (cluster.Attributes(path, attributesBuilder) != CHIP_NO_ERROR)
+    if (CHIP_ERROR err = cluster.Attributes(path, attributesBuilder); err != CHIP_NO_ERROR)
     {
+        ChipLogError(Test, "Failed to get attributes list from cluster. Error: %" CHIP_ERROR_FORMAT, err.Format());
         return false;
     }
 
@@ -47,8 +48,9 @@ bool IsAcceptedCommandsListEqualTo(app::ServerClusterInterface & cluster,
     VerifyOrDie(cluster.GetPaths().size() == 1);
     auto path = cluster.GetPaths()[0];
     ReadOnlyBufferBuilder<app::DataModel::AcceptedCommandEntry> commandsBuilder;
-    if (cluster.AcceptedCommands(path, commandsBuilder) != CHIP_NO_ERROR)
+    if (CHIP_ERROR err = cluster.AcceptedCommands(path, commandsBuilder); err != CHIP_NO_ERROR)
     {
+        ChipLogError(Test, "Failed to get accepted commands list from cluster. Error: %" CHIP_ERROR_FORMAT, err.Format());
         return false;
     }
 
@@ -63,16 +65,26 @@ bool IsAcceptedCommandsListEqualTo(app::ServerClusterInterface & cluster,
     return EqualAcceptedCommandSets(commandsBuilder.TakeBuffer(), expectedBuilder.TakeBuffer());
 }
 
-bool IsGeneratedCommandsListEqualTo(app::ServerClusterInterface & cluster, Span<CommandId> expected)
+bool IsGeneratedCommandsListEqualTo(app::ServerClusterInterface & cluster, std::initializer_list<const CommandId> expected)
 {
     VerifyOrDie(cluster.GetPaths().size() == 1);
     auto path = cluster.GetPaths()[0];
     ReadOnlyBufferBuilder<CommandId> commandsBuilder;
-    if (cluster.GeneratedCommands(path, commandsBuilder) != CHIP_NO_ERROR)
+    if (CHIP_ERROR err = cluster.GeneratedCommands(path, commandsBuilder); err != CHIP_NO_ERROR)
     {
+        ChipLogError(Test, "Failed to get generated commands list from cluster. Error: %" CHIP_ERROR_FORMAT, err.Format());
         return false;
     }
-    return EqualGeneratedCommandSets(commandsBuilder.TakeBuffer(), expected);
+
+    ReadOnlyBufferBuilder<CommandId> expectedBuilder;
+
+    SuccessOrDie(expectedBuilder.EnsureAppendCapacity(expected.size()));
+    for (const auto & entry : expected)
+    {
+        SuccessOrDie(expectedBuilder.Append(entry));
+    }
+
+    return EqualGeneratedCommandSets(commandsBuilder.TakeBuffer(), expectedBuilder.TakeBuffer());
 }
 
 } // namespace chip::Testing

src/app/clusters/testing/ValidateGlobalAttributes.h

@@ -1,5 +1,20 @@
-#pragma once
+/*
+ *    Copyright (c) 2025 Project CHIP Authors
+ *
+ *    Licensed under the Apache License, Version 2.0 (the "License");
+ *    you may not use this file except in compliance with the License.
+ *    You may obtain a copy of the License at
+ *
+ *        http://www.apache.org/licenses/LICENSE-2.0
+ *
+ *    Unless required by applicable law or agreed to in writing, software
+ *    distributed under the License is distributed on an "AS IS" BASIS,
+ *    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ *    See the License for the specific language governing permissions and
+ *    limitations under the License.
+ */
 
+#pragma once
 #include "AttributeTesting.h"
 
 #include <app/server-cluster/DefaultServerCluster.h>
@@ -66,7 +81,7 @@ bool IsAcceptedCommandsListEqualTo(app::ServerClusterInterface & cluster,
 /// ClusterImpl cluster(kTestEndpointId, ...);
 /// ASSERT_TRUE(IsGeneratedCommandsListEqualTo(cluster, { Commands::SomeCommandResponse::kMetadataEntry }));
 /// ```
-bool IsGeneratedCommandsListEqualTo(app::ServerClusterInterface & cluster, Span<CommandId> expected);
+bool IsGeneratedCommandsListEqualTo(app::ServerClusterInterface & cluster, std::initializer_list<const CommandId> expected);
 
 } // namespace Testing
 } // namespace chip