Ensure memory shutdown is done in tests (#15590)

* Ensure MemoryInit is paired with MemoryShutdown in tests

* Fix broken logic bits for init/shutdown operations

* Could not fully fix TestCommissioningManager - added a comment for it

* Removed more cleanup logic. It seems pool frees do not work properly in testcommissionermanager

* Remove a redundant Server::Shutdown

examples/platform/nrfconnect/util/test/TestInetCommon.cpp

@@ -76,6 +76,11 @@ void InitTestInetCommon()
     chip::Platform::MemoryInit();
 }
 
+void ShutdownTestInetCommon()
+{
+    chip::Platform::MemoryShutdown();
+}
+
 void InitSystemLayer()
 {
     gSystemLayer.Init();

src/app/CASESessionManager.h

@@ -63,6 +63,7 @@ class CASESessionManager : public Dnssd::OperationalResolveDelegate
     virtual ~CASESessionManager() { mDNSResolver.Shutdown(); }
 
     CHIP_ERROR Init();
+    void Shutdown() { mDNSResolver.Shutdown(); }
 
     /**
      * Find an existing session for the given node ID, or trigger a new session request.

src/app/server/Server.cpp

@@ -344,6 +344,7 @@ void Server::Shutdown()
     mSessions.Shutdown();
     mTransports.Close();
     mCommissioningWindowManager.Shutdown();
+    mCASESessionManager.Shutdown();
     chip::Platform::MemoryShutdown();
 }
 

src/app/tests/TestCommissionManager.cpp

@@ -17,6 +17,7 @@
 
 #include <app/server/CommissioningWindowManager.h>
 #include <app/server/Server.h>
+#include <lib/dnssd/Advertiser.h>
 #include <lib/support/Span.h>
 #include <lib/support/UnitTestRegistration.h>
 #include <messaging/tests/echo/common.h>
@@ -52,6 +53,27 @@ void InitializeChip(nlTestSuite * suite)
     chip::DeviceLayer::PlatformMgr().StartEventLoopTask();
 }
 
+void ShutdownChipTest()
+{
+    chip::DeviceLayer::PlatformMgr().StopEventLoopTask();
+    chip::DeviceLayer::PlatformMgr().Shutdown();
+
+    auto & mdnsAdvertiser = chip::Dnssd::ServiceAdvertiser::Instance();
+    mdnsAdvertiser.RemoveServices();
+    mdnsAdvertiser.Shutdown();
+
+    // Server shudown will be called in TearDownTask
+
+    // TODO: At this point UDP endpoits still seem leaked and the sanitizer
+    // builds will attempt a memory free. As a result, we keep Memory initialized
+    // so that the global UDPManager can still be destructed without a coredump.
+    //
+    // This is likely either a missing shutdown or an actual UDP endpoint leak
+    // which I have not been able to track down yet.
+    //
+    // chip::Platform::MemoryShutdown();
+}
+
 void CheckCommissioningWindowManagerBasicWindowOpenCloseTask(intptr_t context)
 {
     nlTestSuite * suite                        = reinterpret_cast<nlTestSuite *>(context);
@@ -182,8 +204,7 @@ int TestCommissioningWindowManager()
     // TODO: The platform memory was intentionally left not deinitialized so that minimal mdns can destruct
     chip::DeviceLayer::PlatformMgr().ScheduleWork(TearDownTask, 0);
     sleep(kTestTaskWaitSeconds);
-    chip::DeviceLayer::PlatformMgr().StopEventLoopTask();
-    chip::DeviceLayer::PlatformMgr().Shutdown();
+    ShutdownChipTest();
 
     return (nlTestRunnerStats(&theSuite));
 }

src/inet/tests/TestInetCommon.h

@@ -62,6 +62,7 @@ extern bool gDone;
 void InitTestInetCommon();
 void InitSystemLayer();
 void ShutdownSystemLayer();
+void ShutdownTestInetCommon();
 void InetFailError(CHIP_ERROR err, const char * msg);
 
 void InitNetwork();

src/inet/tests/TestInetCommonPosix.cpp

@@ -154,6 +154,11 @@ void InitTestInetCommon()
     UseStdoutLineBuffering();
 }
 
+void ShutdownTestInetCommon()
+{
+    chip::Platform::MemoryShutdown();
+}
+
 void InitSystemLayer()
 {
 #if CHIP_SYSTEM_CONFIG_USE_LWIP

src/inet/tests/TestInetLayer.cpp

@@ -320,6 +320,8 @@ int main(int argc, char * argv[])
 
     lSuccessful = Common::WasSuccessful(sTestState.mStatus);
 
+    ShutdownTestInetCommon();
+
 exit:
     return (lSuccessful ? EXIT_SUCCESS : EXIT_FAILURE);
 }

src/lib/dnssd/minimal_mdns/tests/TestAdvertiser.cpp

@@ -559,6 +559,10 @@ int TestAdvertiser(void)
     nlTestRunner(&theSuite, &server);
     server.Shutdown();
     context.Shutdown();
+    mdnsAdvertiser.RemoveServices();
+    mdnsAdvertiser.Shutdown();
+    chip::Platform::MemoryShutdown();
+
     return nlTestRunnerStats(&theSuite);
 }
 

src/lib/dnssd/minimal_mdns/tests/TestMinimalMdnsAllocator.cpp

@@ -306,12 +306,22 @@ const nlTest sTests[] = {
     NL_TEST_SENTINEL() //
 };
 
+int TestSetup(void * inContext)
+{
+    return chip::Platform::MemoryInit() == CHIP_NO_ERROR ? SUCCESS : FAILURE;
+}
+
+int TestTeardown(void * inContext)
+{
+    chip::Platform::MemoryShutdown();
+    return SUCCESS;
+}
+
 } // namespace
 
 int TestMinimalMdnsAllocator(void)
 {
-    chip::Platform::MemoryInit();
-    nlTestSuite theSuite = { "MinimalMdnsAllocator", &sTests[0], nullptr, nullptr };
+    nlTestSuite theSuite = { "MinimalMdnsAllocator", &sTests[0], &TestSetup, &TestTeardown };
     nlTestRunner(&theSuite, nullptr);
     return nlTestRunnerStats(&theSuite);
 }

src/lib/dnssd/minimal_mdns/tests/TestResponseSender.cpp

@@ -354,12 +354,22 @@ const nlTest sTests[] = {
     NL_TEST_SENTINEL() //
 };
 
+int TestSetup(void * inContext)
+{
+    return chip::Platform::MemoryInit() == CHIP_NO_ERROR ? SUCCESS : FAILURE;
+}
+
+int TestTeardown(void * inContext)
+{
+    chip::Platform::MemoryShutdown();
+    return SUCCESS;
+}
+
 } // namespace
 
 int TestResponseSender(void)
 {
-    chip::Platform::MemoryInit();
-    nlTestSuite theSuite = { "RecordData", sTests, nullptr, nullptr };
+    nlTestSuite theSuite = { "RecordData", sTests, &TestSetup, &TestTeardown };
     nlTestRunner(&theSuite, nullptr);
     return nlTestRunnerStats(&theSuite);
 }

src/lib/dnssd/platform/tests/TestPlatform.cpp

@@ -221,7 +221,12 @@ void TestCommissionableNode(nlTestSuite * inSuite, void * inContext)
 
 int TestSetup(void * inContext)
 {
-    chip::Platform::MemoryInit();
+    return chip::Platform::MemoryInit() == CHIP_NO_ERROR ? SUCCESS : FAILURE;
+}
+
+int TestTeardown(void * inContext)
+{
+    chip::Platform::MemoryShutdown();
     return SUCCESS;
 }
 
@@ -236,7 +241,7 @@ const nlTest sTests[] = {
 
 int TestDnssdPlatform(void)
 {
-    nlTestSuite theSuite = { "DnssdPlatform", &sTests[0], &TestSetup, nullptr };
+    nlTestSuite theSuite = { "DnssdPlatform", &sTests[0], &TestSetup, &TestTeardown };
     nlTestRunner(&theSuite, nullptr);
     return nlTestRunnerStats(&theSuite);
 }

src/lib/support/tests/TestCHIPArgParser.cpp

@@ -788,6 +788,8 @@ int TestCHIPArgParser(void)
 
     printf("All tests succeeded\n");
 
+    chip::Platform::MemoryShutdown();
+
     return (EXIT_SUCCESS);
 }
 #else  // CHIP_CONFIG_ENABLE_ARG_PARSER

src/platform/tests/TestCHIPoBLEStackMgr.cpp

@@ -52,8 +52,8 @@ int TestCHIPoBLEStackManager()
     ChipLogProgress(DeviceLayer, "Start Chip Over Ble stack Done");
 
     chip::DeviceLayer::PlatformMgrImpl().RunEventLoop();
-    ChipLogProgress(DeviceLayer, "Start EventLoop");
-
+    ChipLogProgress(DeviceLayer, "RunEventLoop completed");
+    chip::Platform::MemoryShutdown();
     return 0;
 }
 

src/platform/tests/TestThreadStackMgr.cpp

@@ -46,6 +46,7 @@ void EventHandler(const chip::DeviceLayer::ChipDeviceEvent * event, intptr_t arg
     {
         if (event->ThreadConnectivityChange.Result == chip::DeviceLayer::ConnectivityChange::kConnectivity_Established)
         {
+            chip::Platform::MemoryShutdown();
             exit(0);
         }
     }
@@ -76,6 +77,7 @@ int TestThreadStackManager()
     printf("Start Thread task done\n");
 
     chip::DeviceLayer::PlatformMgrImpl().RunEventLoop();
+    chip::Platform::MemoryShutdown();
 
     return -1;
 }

src/protocols/secure_channel/tests/TestMessageCounterManager.cpp

@@ -170,6 +170,7 @@ int Finalize(void * aContext)
 {
     CHIP_ERROR err = reinterpret_cast<TestContext *>(aContext)->Shutdown();
     gIOContext.Shutdown();
+    chip::Platform::MemoryShutdown();
     return (err == CHIP_NO_ERROR) ? SUCCESS : FAILURE;
 }
 

src/system/tests/TestSystemPacketBuffer.cpp

@@ -235,6 +235,8 @@ int PacketBufferTest::TestTeardown(void * inContext)
     if (err != CHIP_NO_ERROR && err != CHIP_ERROR_NOT_IMPLEMENTED)
         return FAILURE;
 
+    chip::Platform::MemoryShutdown();
+
     return SUCCESS;
 }