Make timeouts in ResetCommisionnee log the node ID involved. (#37087)

In some of our tests we have dozens of commissionees, so when one of them times out on RemoveFabric it's really hard to tell which one.
project-chip · Jan 16, 2025 · 184127e · 184127e
1 parent f9c7a8d
commit 184127e
Show file tree

Hide file tree

Showing 4 changed files with 20 additions and 6 deletions.
diff --git a/src/darwin/Framework/CHIPTests/MTRPerControllerStorageTests.m b/src/darwin/Framework/CHIPTests/MTRPerControllerStorageTests.m
@@ -2873,7 +2873,7 @@ - (void)doTestSubscriptionPoolWithSize:(NSInteger)subscriptionPoolSize deviceOnb
     // Reset our commissionees.
     for (NSNumber * deviceID in orderedDeviceIDs) {
         __auto_type * baseDevice = [MTRBaseDevice deviceWithNodeID:deviceID controller:controller];
-        ResetCommissionee(baseDevice, queue, self, kTimeoutInSeconds);
+        ResetCommissioneeWithNodeID(baseDevice, queue, self, kTimeoutInSeconds, deviceID);
     }
 
     [controller shutdown];

diff --git a/src/darwin/Framework/CHIPTests/MTRSwiftDeviceTests.swift b/src/darwin/Framework/CHIPTests/MTRSwiftDeviceTests.swift
@@ -163,8 +163,8 @@ class MTRSwiftDeviceTests : XCTestCase {
     }
 
     static override func tearDown() {
-        ResetCommissionee(sConnectedDevice, DispatchQueue.main, nil, UInt16(DeviceConstants.timeoutInSeconds))
-
+        XCTAssertNotNil(sConnectedDevice)
+        ResetCommissionee(sConnectedDevice!, DispatchQueue.main, nil, UInt16(DeviceConstants.timeoutInSeconds))
         let controller = sController
         XCTAssertNotNil(controller)
         controller!.shutdown()

diff --git a/src/darwin/Framework/CHIPTests/TestHelpers/MTRTestResetCommissioneeHelper.h b/src/darwin/Framework/CHIPTests/TestHelpers/MTRTestResetCommissioneeHelper.h
@@ -20,4 +20,12 @@
 
 #pragma once
 
-void ResetCommissionee(MTRBaseDevice * device, dispatch_queue_t queue, XCTestCase * testcase, uint16_t commandTimeout);
+NS_ASSUME_NONNULL_BEGIN
+
+void ResetCommissionee(MTRBaseDevice * device, dispatch_queue_t queue, XCTestCase * _Nullable testcase, uint16_t commandTimeout);
+
+// MTRBaseDevice does not expose its node ID, so for now just allow callers to
+// pass that in out-of-band.
+void ResetCommissioneeWithNodeID(MTRBaseDevice * device, dispatch_queue_t queue, XCTestCase * _Nullable testcase, uint16_t commandTimeout, NSNumber * _Nullable nodeID);
+
+NS_ASSUME_NONNULL_END
diff --git a/src/darwin/Framework/CHIPTests/TestHelpers/MTRTestResetCommissioneeHelper.m b/src/darwin/Framework/CHIPTests/TestHelpers/MTRTestResetCommissioneeHelper.m
@@ -16,7 +16,7 @@
 
 #import "MTRTestResetCommissioneeHelper.h"
 
-void ResetCommissionee(MTRBaseDevice * device, dispatch_queue_t queue, XCTestCase * testcaseUnused, uint16_t commandTimeout)
+void ResetCommissioneeWithNodeID(MTRBaseDevice * device, dispatch_queue_t queue, XCTestCase * testcaseUnused, uint16_t commandTimeout, NSNumber * _Nullable nodeID)
 {
     // Put the device back in the state we found it: open commissioning window, no fabrics commissioned.
     // Get our current fabric index, for later deletion.
@@ -65,5 +65,11 @@ void ResetCommissionee(MTRBaseDevice * device, dispatch_queue_t queue, XCTestCas
                              [removeFabricExpectation fulfill];
                          }];
 
-    XCTAssertEqual([XCTWaiter waitForExpectations:@[ removeFabricExpectation ] timeout:commandTimeout], XCTWaiterResultCompleted);
+    XCTAssertEqual([XCTWaiter waitForExpectations:@[ removeFabricExpectation ] timeout:commandTimeout], XCTWaiterResultCompleted,
+        "Resetting commissionnee 0x%llx", nodeID.unsignedLongLongValue);
+}
+
+void ResetCommissionee(MTRBaseDevice * device, dispatch_queue_t queue, XCTestCase * testcaseUnused, uint16_t commandTimeout)
+{
+    return ResetCommissioneeWithNodeID(device, queue, testcaseUnused, commandTimeout, nil);
 }