pw_unit_test migration: apps

src/BUILD.gn

@@ -96,6 +96,7 @@ if (chip_build_tests) {
     if (chip_device_platform != "efr32") {
       tests += [
         "${chip_root}/src/app/tests",
+        "${chip_root}/src/app/tests:tests_nltest",
         "${chip_root}/src/credentials/tests",
         "${chip_root}/src/lib/format/tests",
         "${chip_root}/src/lib/support/tests",

src/app/CommandHandler.h

@@ -55,6 +55,9 @@
 #include <app/MessageDef/InvokeResponseMessage.h>
 
 namespace chip {
+namespace Test {
+class CommandHandlerTestAccess;
+}
 namespace app {
 
 /// Defines an abstract class of something that can be encoded
@@ -506,6 +509,7 @@ class CommandHandler
 private:
     friend class TestCommandInteraction;
     friend class CommandHandler::Handle;
+    friend class chip::Test::CommandHandlerTestAccess;
 
     enum class State : uint8_t
     {

src/app/CommandSender.h

@@ -51,6 +51,10 @@
 #define COMMON_STATUS_SUCCESS 0
 
 namespace chip {
+namespace Test {
+class CommandSenderTestAccess;
+
+}
 namespace app {
 
 class CommandSender final : public Messaging::ExchangeDelegate
@@ -491,6 +495,7 @@ class CommandSender final : public Messaging::ExchangeDelegate
 
 private:
     friend class TestCommandInteraction;
+    friend class chip::Test::CommandSenderTestAccess;
 
     enum class State : uint8_t
     {

src/app/ReadHandler.h

@@ -56,6 +56,12 @@
 inline constexpr uint16_t kSubscriptionMaxIntervalPublisherLimit = 3600; // seconds (60 minutes)
 
 namespace chip {
+
+// Forward declaration of ReadHandlerTestAccess class to allow it to be friend with the ReadHandler.
+// This is not for general API use. It is only to be used for (Unit) Tests to expose private Methods/Members.
+namespace Test {
+class ReadHandlerTestAccess;
+}
 namespace app {
 
 //
@@ -426,6 +432,7 @@ class ReadHandler : public Messaging::ExchangeDelegate
     friend class TestReadInteraction;
     friend class chip::app::reporting::TestReportingEngine;
     friend class chip::app::reporting::TestReportScheduler;
+    friend class chip::Test::ReadHandlerTestAccess;
 
     //
     // The engine needs to be able to Abort/Close a ReadHandler instance upon completion of work for a given read/subscribe

src/app/WriteClient.h

@@ -42,6 +42,10 @@
 #include <system/TLVPacketBufferBackingStore.h>
 
 namespace chip {
+namespace Test {
+class WriteClientTestAccess;
+
+}
 namespace app {
 
 class InteractionModelEngine;
@@ -237,6 +241,7 @@ class WriteClient : public Messaging::ExchangeDelegate
 private:
     friend class TestWriteInteraction;
     friend class InteractionModelEngine;
+    friend class chip::Test::WriteClientTestAccess;
 
     enum class State
     {

src/app/WriteHandler.h

@@ -35,6 +35,9 @@
 #include <system/TLVPacketBufferBackingStore.h>
 
 namespace chip {
+namespace Test {
+class WriteHandlerTestAccess;
+}
 namespace app {
 
 class WriteHandler;
@@ -132,6 +135,8 @@ class WriteHandler : public Messaging::ExchangeDelegate
 
 private:
     friend class TestWriteInteraction;
+    friend class chip::Test::WriteHandlerTestAccess;
+
     enum class State
     {
         Uninitialized = 0, // The handler has not been initialized

src/app/reporting/Engine.h

@@ -38,6 +38,10 @@
 #include <system/TLVPacketBufferBackingStore.h>
 
 namespace chip {
+namespace Test {
+class EngineTestAccess;
+
+}
 namespace app {
 
 class InteractionModelEngine;
@@ -148,6 +152,7 @@ class Engine
 
     friend class TestReportingEngine;
     friend class ::chip::app::TestReadInteraction;
+    friend class ::chip::Test::EngineTestAccess;
 
     bool IsRunScheduled() const { return mRunScheduled; }
 

src/app/tests/AppTestContext.cpp

@@ -49,6 +49,12 @@ void AppContext::SetUpTestSuite()
 
 void AppContext::TearDownTestSuite()
 {
+    // Adding a DrainAndServiceIO call fixes the teardown for some tests (TestAclAttribute and TestReportScheduler); these were
+    // triggering failures in tests that follow them when running on nRF CI (Zephyr native_posix where all Unit Tests are compiled
+    // into a single file)
+    // TODO: understand this more and solve underlying issue
+    LoopbackMessagingContext::DrainAndServiceIO();
+
     chip::DeviceLayer::PlatformMgr().Shutdown();
     LoopbackMessagingContext::TearDownTestSuite();
 }

src/app/tests/BUILD.gn

@@ -15,6 +15,7 @@
 import("//build_overrides/build.gni")
 import("//build_overrides/chip.gni")
 import("//build_overrides/nlunit_test.gni")
+import("//build_overrides/pigweed.gni")
 
 import("${chip_root}/build/chip/chip_test_suite.gni")
 import("${chip_root}/src/app/icd/icd.gni")
@@ -37,9 +38,10 @@ static_library("helpers") {
     "${chip_root}/src/access",
     "${chip_root}/src/app",
     "${chip_root}/src/lib/support",
-    "${chip_root}/src/messaging/tests:helpers",
     "${chip_root}/src/transport/raw/tests:helpers",
   ]
+
+  public_deps = [ "${chip_root}/src/messaging/tests:helpers" ]
 }
 
 source_set("binding-test-srcs") {
@@ -119,21 +121,80 @@ source_set("operational-state-test-srcs") {
   ]
 }
 
-chip_test_suite_using_nltest("tests") {
+source_set("ember-apptest-compatibility") {
+  sources = [
+    "ember-test-compatibility.cpp",
+    "ember-test-compatibility.h",
+  ]
+  public_configs = [ "${chip_root}/src/lib/support/pw_log_chip:config" ]
+
+  public_deps = [
+    "${chip_root}/src/app/util/mock:mock_ember",
+    "${chip_root}/src/lib/core",
+    "${chip_root}/src/lib/support",
+  ]
+}
+
+chip_test_suite("tests") {
   output_name = "libAppTests"
 
+  sources = [
+    "CommandHandlerTestAccess.h",
+    "CommandSenderTestAccess.h",
+    "EngineTestAccess.h",
+    "ReadHandlerTestAccess.h",
+    "WriteClientTestAccess.h",
+    "WriteHandlerTestAccess.h",
+  ]
   test_sources = [
+    "TestAclAttribute.cpp",
     "TestAclEvent.cpp",
+    "TestBindingTable.cpp",
+    "TestBuilderParser.cpp",
+    "TestCommandInteraction.cpp",
+    "TestMessageDef.cpp",
+    "TestNullable.cpp",
+    "TestReportingEngine.cpp",
+    "TestStatusIB.cpp",
+    "TestStatusResponseMessage.cpp",
+    "TestTimedHandler.cpp",
+    "TestWriteInteraction.cpp",
+  ]
+
+  if (!chip_fake_platform) {
+    test_sources += [ "TestFailSafeContext.cpp" ]
+  }
+
+  cflags = [ "-Wconversion" ]
+
+  public_deps = [
+    ":binding-test-srcs",
+    ":ember-apptest-compatibility",
+    ":operational-state-test-srcs",
+    ":ota-requestor-test-srcs",
+    ":time-sync-data-provider-test-srcs",
+    "${chip_root}/src/app",
+    "${chip_root}/src/app/common:cluster-objects",
+    "${chip_root}/src/app/icd/client:manager",
+    "${chip_root}/src/app/tests:helpers",
+    "${chip_root}/src/app/util/mock:mock_ember",
+    "${chip_root}/src/lib/core",
+    "${chip_root}/src/lib/support:test_utils",
+    "${chip_root}/src/lib/support:testing",
+  ]
+}
+
+chip_test_suite_using_nltest("tests_nltest") {
+  output_name = "libAppTestsNL"
+
+  test_sources = [
     "TestAttributeAccessInterfaceCache.cpp",
     "TestAttributePathExpandIterator.cpp",
     "TestAttributePersistenceProvider.cpp",
     "TestAttributeValueDecoder.cpp",
     "TestAttributeValueEncoder.cpp",
     "TestBasicCommandPathRegistry.cpp",
-    "TestBindingTable.cpp",
-    "TestBuilderParser.cpp",
     "TestClusterInfo.cpp",
-    "TestCommandInteraction.cpp",
     "TestCommandPathParams.cpp",
     "TestConcreteAttributePath.cpp",
     "TestDataModelSerialization.cpp",
@@ -143,29 +204,17 @@ chip_test_suite_using_nltest("tests") {
     "TestEventPathParams.cpp",
     "TestFabricScopedEventLogging.cpp",
     "TestInteractionModelEngine.cpp",
-    "TestMessageDef.cpp",
-    "TestNullable.cpp",
     "TestNumericAttributeTraits.cpp",
     "TestOperationalStateClusterObjects.cpp",
     "TestPendingNotificationMap.cpp",
     "TestPendingResponseTrackerImpl.cpp",
     "TestPowerSourceCluster.cpp",
     "TestReadInteraction.cpp",
-    "TestReportingEngine.cpp",
-    "TestStatusIB.cpp",
-    "TestStatusResponseMessage.cpp",
+    "TestReportScheduler.cpp",
     "TestTestEventTriggerDelegate.cpp",
     "TestTimeSyncDataProvider.cpp",
-    "TestTimedHandler.cpp",
-    "TestWriteInteraction.cpp",
   ]
 
-  if (!chip_fake_platform) {
-    test_sources += [ "TestFailSafeContext.cpp" ]
-  }
-
-  test_sources += [ "TestAclAttribute.cpp" ]
-
   # DefaultICDClientStorage assumes that raw AES key is used by the application
   if (chip_crypto != "psa") {
     test_sources += [ "TestDefaultICDClientStorage.cpp" ]
@@ -191,18 +240,20 @@ chip_test_suite_using_nltest("tests") {
 
   # The platform manager is not properly clearing queues in test teardown, which results in
   # DrainIO calls not being able to run in expected time (5seconds) if unprocessed reported engine
-  # runs are remaining, causing tests to crash in Open IoT SDK and Zephyr tests since they are
+  # runs are remaining, causing tests to crash in Open IoT SDK since they are
   # running all tests in one file. We need to figure out how to properly clean the event queues
   # before enabling this test for these platforms.
-  if (chip_device_platform != "nrfconnect" &&
-      chip_device_platform != "openiotsdk") {
-    test_sources += [ "TestReportScheduler.cpp" ]
+  # Update: This was fixed for Nordic Zephyr Tests by calling DrainAndServiceIO in AppContext::TearDownTestSuite()
+  # TODO: check if above solution works for openiotsdk as well
+  if (chip_device_platform != "openiotsdk") {
+    test_sources += []
   }
 
   cflags = [ "-Wconversion" ]
 
   public_deps = [
     ":binding-test-srcs",
+    ":ember-apptest-compatibility",
     ":operational-state-test-srcs",
     ":ota-requestor-test-srcs",
     ":time-sync-data-provider-test-srcs",

src/app/tests/CommandHandlerTestAccess.h

@@ -0,0 +1,57 @@
+/*
+ *
+ *    Copyright (c) 2024 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 <app/CommandHandler.h>
+
+namespace chip {
+namespace Test {
+
+/**
+ * @brief Class acts as an accessor to private methods of the CommandHandler class without needing to give friend access to
+ *        each individual test.
+ *        This is not a Global API and should only be used for (Unit) Testing.
+ */
+class CommandHandlerTestAccess
+{
+
+public:
+    CommandHandlerTestAccess(app::CommandHandler * aCommandHandler) : pCommandHandler(aCommandHandler) {}
+
+    bool TestOnlyIsInIdleState() { return pCommandHandler->TestOnlyIsInIdleState(); }
+
+    Protocols::InteractionModel::Status ProcessInvokeRequest(System::PacketBufferHandle && payload, bool isTimedInvoke)
+    {
+        return pCommandHandler->ProcessInvokeRequest(std::move(payload), isTimedInvoke);
+    }
+
+    void SetReserveSpaceForMoreChunkMessages(bool aReserveSpaceForMoreChunkMessages)
+    {
+        pCommandHandler->mReserveSpaceForMoreChunkMessages = aReserveSpaceForMoreChunkMessages;
+    }
+
+    app::InvokeResponseMessage::Builder & GetInvokeResponseBuilder() { return pCommandHandler->mInvokeResponseBuilder; }
+
+    app::CommandHandlerExchangeInterface * GetmpResponder() { return pCommandHandler->mpResponder; }
+
+private:
+    app::CommandHandler * pCommandHandler = nullptr;
+};
+
+} // namespace Test
+} // namespace chip