Rename CONFIG_IM_BUILD_FOR_UNIT_TEST to CONFIG_BUILD_FOR_HOST_UNIT_TE…

…ST (#19689)

CONFIG_IM_BUILD_FOR_UNIT_TEST started getting used in other unit tests other
than IM. A more appropriate name is CONFIG_BUILD_FOR_HOST_UNIT_TEST.

config/standalone/CHIPProjectConfig.h

@@ -85,6 +85,7 @@
 //
 #define CHIP_CONFIG_MAX_EXCHANGE_CONTEXTS 150
 
-#define CONFIG_IM_BUILD_FOR_UNIT_TEST 1
+// Safe to enable this flag since standalone is associated with host and not a device.
+#define CONFIG_BUILD_FOR_HOST_UNIT_TEST 1
 
 #endif /* CHIPPROJECTCONFIG_H */

examples/chip-tool/include/CHIPProjectAppConfig.h

@@ -63,6 +63,6 @@
 #define CHIP_DEVICE_CONFIG_ENABLE_COMMISSIONER_DISCOVERY 1
 
 // Enable some test-only interaction model APIs.
-#define CONFIG_IM_BUILD_FOR_UNIT_TEST 1
+#define CONFIG_BUILD_FOR_HOST_UNIT_TEST 1
 
 #endif /* CHIPPROJECTCONFIG_H */

src/app/CommandSender.h

@@ -173,7 +173,7 @@ class CommandSender final : public Messaging::ExchangeDelegate
 
  CHIP_ERROR FinishCommand(const Optional<uint16_t> & aTimedInvokeTimeoutMs);
 
-#if CONFIG_IM_BUILD_FOR_UNIT_TEST
+#if CONFIG_BUILD_FOR_HOST_UNIT_TEST
  /**
  * Version of AddRequestData that allows sending a message that is
  * guaranteed to fail due to requiring a timed invoke but not providing a
@@ -186,7 +186,7 @@ class CommandSender final : public Messaging::ExchangeDelegate
  mSuppressResponse = aSuppressResponse;
  return AddRequestDataInternal(aCommandPath, aData, aTimedInvokeTimeoutMs);
  }
-#endif // CONFIG_IM_BUILD_FOR_UNIT_TEST
+#endif // CONFIG_BUILD_FOR_HOST_UNIT_TEST
 
 private:
  template <typename CommandDataT>

src/app/InteractionModelEngine.cpp

@@ -675,12 +675,12 @@ bool InteractionModelEngine::EnsureResourceForSubscription(FabricIndex aFabricIn
  size_t aRequestedEventPathCount)
 {
 #if CHIP_SYSTEM_CONFIG_POOL_USE_HEAP && !CHIP_CONFIG_IM_FORCE_FABRIC_QUOTA_CHECK
-#if CONFIG_IM_BUILD_FOR_UNIT_TEST
+#if CONFIG_BUILD_FOR_HOST_UNIT_TEST
  const bool allowUnlimited = !mForceHandlerQuota;
-#else // CONFIG_IM_BUILD_FOR_UNIT_TEST
+#else // CONFIG_BUILD_FOR_HOST_UNIT_TEST
  // If the resources are allocated on the heap, we should be able to handle as many Read / Subscribe requests as possible.
  const bool allowUnlimited = true;
-#endif // CONFIG_IM_BUILD_FOR_UNIT_TEST
+#endif // CONFIG_BUILD_FOR_HOST_UNIT_TEST
 #else // CHIP_SYSTEM_CONFIG_POOL_USE_HEAP && !CHIP_CONFIG_IM_FORCE_FABRIC_QUOTA_CHECK
  const bool allowUnlimited = false;
 #endif // CHIP_SYSTEM_CONFIG_POOL_USE_HEAP && !CHIP_CONFIG_IM_FORCE_FABRIC_QUOTA_CHECK
@@ -859,12 +859,12 @@ Protocols::InteractionModel::Status InteractionModelEngine::EnsureResourceForRea
  size_t aRequestedEventPathCount)
 {
 #if CHIP_SYSTEM_CONFIG_POOL_USE_HEAP && !CHIP_CONFIG_IM_FORCE_FABRIC_QUOTA_CHECK
-#if CONFIG_IM_BUILD_FOR_UNIT_TEST
+#if CONFIG_BUILD_FOR_HOST_UNIT_TEST
  const bool allowUnlimited = !mForceHandlerQuota;
-#else // CONFIG_IM_BUILD_FOR_UNIT_TEST
+#else // CONFIG_BUILD_FOR_HOST_UNIT_TEST
  // If the resources are allocated on the heap, we should be able to handle as many Read / Subscribe requests as possible.
  const bool allowUnlimited = true;
-#endif // CONFIG_IM_BUILD_FOR_UNIT_TEST
+#endif // CONFIG_BUILD_FOR_HOST_UNIT_TEST
 #else // CHIP_SYSTEM_CONFIG_POOL_USE_HEAP && !CHIP_CONFIG_IM_FORCE_FABRIC_QUOTA_CHECK
  const bool allowUnlimited = false;
 #endif // CHIP_SYSTEM_CONFIG_POOL_USE_HEAP && !CHIP_CONFIG_IM_FORCE_FABRIC_QUOTA_CHECK

src/app/InteractionModelEngine.h

@@ -265,7 +265,7 @@ class InteractionModelEngine : public Messaging::UnsolicitedMessageHandler,
 
  uint16_t GetMinSubscriptionsPerFabric() const;
 
-#if CONFIG_IM_BUILD_FOR_UNIT_TEST
+#if CONFIG_BUILD_FOR_HOST_UNIT_TEST
  //
  // Get direct access to the underlying read handler pool
  //
@@ -397,7 +397,7 @@ class InteractionModelEngine : public Messaging::UnsolicitedMessageHandler,
 
  inline size_t GetPathPoolCapacityForReads() const
  {
-#if CONFIG_IM_BUILD_FOR_UNIT_TEST
+#if CONFIG_BUILD_FOR_HOST_UNIT_TEST
  return (mPathPoolCapacityForReadsOverride == -1) ? CHIP_IM_SERVER_MAX_NUM_PATH_GROUPS_FOR_READS
  : static_cast<size_t>(mPathPoolCapacityForReadsOverride);
 #else
@@ -407,7 +407,7 @@ class InteractionModelEngine : public Messaging::UnsolicitedMessageHandler,
 
  inline size_t GetReadHandlerPoolCapacityForReads() const
  {
-#if CONFIG_IM_BUILD_FOR_UNIT_TEST
+#if CONFIG_BUILD_FOR_HOST_UNIT_TEST
  return (mReadHandlerCapacityForReadsOverride == -1) ? CHIP_IM_MAX_NUM_READS
  : static_cast<size_t>(mReadHandlerCapacityForReadsOverride);
 #else
@@ -417,7 +417,7 @@ class InteractionModelEngine : public Messaging::UnsolicitedMessageHandler,
 
  inline size_t GetPathPoolCapacityForSubscriptions() const
  {
-#if CONFIG_IM_BUILD_FOR_UNIT_TEST
+#if CONFIG_BUILD_FOR_HOST_UNIT_TEST
  return (mPathPoolCapacityForSubscriptionsOverride == -1) ? CHIP_IM_SERVER_MAX_NUM_PATH_GROUPS_FOR_SUBSCRIPTIONS
  : static_cast<size_t>(mPathPoolCapacityForSubscriptionsOverride);
 #else
@@ -427,7 +427,7 @@ class InteractionModelEngine : public Messaging::UnsolicitedMessageHandler,
 
  inline size_t GetReadHandlerPoolCapacityForSubscriptions() const
  {
-#if CONFIG_IM_BUILD_FOR_UNIT_TEST
+#if CONFIG_BUILD_FOR_HOST_UNIT_TEST
  return (mReadHandlerCapacityForSubscriptionsOverride == -1)
  ? CHIP_IM_MAX_NUM_SUBSCRIPTIONS
  : static_cast<size_t>(mReadHandlerCapacityForSubscriptionsOverride);
@@ -438,7 +438,7 @@ class InteractionModelEngine : public Messaging::UnsolicitedMessageHandler,
 
  inline uint8_t GetConfigMaxFabrics() const
  {
-#if CONFIG_IM_BUILD_FOR_UNIT_TEST
+#if CONFIG_BUILD_FOR_HOST_UNIT_TEST
  return (mMaxNumFabricsOverride == -1) ? CHIP_CONFIG_MAX_FABRICS : static_cast<uint8_t>(mMaxNumFabricsOverride);
 #else
  return CHIP_CONFIG_MAX_FABRICS;
@@ -534,7 +534,7 @@ class InteractionModelEngine : public Messaging::UnsolicitedMessageHandler,
 
  ReadHandler::ApplicationCallback * mpReadHandlerApplicationCallback = nullptr;
 
-#if CONFIG_IM_BUILD_FOR_UNIT_TEST
+#if CONFIG_BUILD_FOR_HOST_UNIT_TEST
  int mReadHandlerCapacityForSubscriptionsOverride = -1;
  int mPathPoolCapacityForSubscriptionsOverride = -1;
 

src/app/ReadClient.h

@@ -318,12 +318,12 @@ class ReadClient : public Messaging::ExchangeDelegate
  // Like SendSubscribeRequest, but allows sending certain forms of invalid
  // subscribe requests that servers are expected to reject, for testing
  // purposes. Should only be called from tests.
-#if CONFIG_IM_BUILD_FOR_UNIT_TEST
+#if CONFIG_BUILD_FOR_HOST_UNIT_TEST
  CHIP_ERROR SendSubscribeRequestWithoutValidation(const ReadPrepareParams & aReadPrepareParams)
  {
  return SendSubscribeRequestImpl(aReadPrepareParams);
  }
-#endif // CONFIG_IM_BUILD_FOR_UNIT_TEST
+#endif // CONFIG_BUILD_FOR_HOST_UNIT_TEST
 
 private:
  friend class TestReadInteraction;

src/app/WriteClient.cpp

@@ -227,7 +227,7 @@ CHIP_ERROR WriteClient::StartNewMessage()
  // end of container).
  reservedSize = static_cast<uint16_t>(reservedSize + kReservedSizeForTLVEncodingOverhead);
 
-#if CONFIG_IM_BUILD_FOR_UNIT_TEST
+#if CONFIG_BUILD_FOR_HOST_UNIT_TEST
  // ... and for unit tests.
  reservedSize = static_cast<uint16_t>(reservedSize + mReservedSize);
 #endif

src/app/WriteClient.h

@@ -128,7 +128,7 @@ class WriteClient : public Messaging::ExchangeDelegate
  mpCallback(apCallback), mTimedWriteTimeoutMs(aTimedWriteTimeoutMs), mSuppressResponse(aSuppressResponse)
  {}
 
-#if CONFIG_IM_BUILD_FOR_UNIT_TEST
+#if CONFIG_BUILD_FOR_HOST_UNIT_TEST
  WriteClient(Messaging::ExchangeManager * apExchangeMgr, Callback * apCallback, const Optional<uint16_t> & aTimedWriteTimeoutMs,
  uint16_t aReservedSize) :
  mpExchangeMgr(apExchangeMgr),
@@ -398,7 +398,7 @@ class WriteClient : public Messaging::ExchangeDelegate
  // TODO: This file might be compiled with different build flags on Darwin platform (when building WriteClient.cpp and
  // CHIPClustersObjc.mm), which will cause undefined behavior when building write requests. Uncomment the #if and #endif after
  // resolving it.
- // #if CONFIG_IM_BUILD_FOR_UNIT_TEST
+ // #if CONFIG_BUILD_FOR_HOST_UNIT_TEST
  uint16_t mReservedSize = 0;
  // #endif
 

src/app/data-model/Encode.h

@@ -160,14 +160,14 @@ CHIP_ERROR Encode(TLV::TLVWriter & writer, TLV::Tag tag, const Nullable<X> & x)
  }
 
  // Allow sending invalid values for nullables when
- // CONFIG_IM_BUILD_FOR_UNIT_TEST is true, so we can test how the other side
+ // CONFIG_BUILD_FOR_HOST_UNIT_TEST is true, so we can test how the other side
  // responds.
-#if !CONFIG_IM_BUILD_FOR_UNIT_TEST
+#if !CONFIG_BUILD_FOR_HOST_UNIT_TEST
  if (!x.HasValidValue())
  {
  return CHIP_IM_GLOBAL_STATUS(ConstraintError);
  }
-#endif // !CONFIG_IM_BUILD_FOR_UNIT_TEST
+#endif // !CONFIG_BUILD_FOR_HOST_UNIT_TEST
 
  // The -Wmaybe-uninitialized warning gets confused about the fact
  // that x.mValue is always initialized if x.IsNull() is not

src/app/reporting/Engine.cpp

@@ -121,7 +121,7 @@ CHIP_ERROR Engine::BuildSingleReportDataAttributeReportIBs(ReportDataMessage::Bu
  apReadHandler->ResetPathIterator();
  }
 
-#if CONFIG_IM_BUILD_FOR_UNIT_TEST
+#if CONFIG_BUILD_FOR_HOST_UNIT_TEST
  uint32_t attributesRead = 0;
 #endif
 
@@ -161,7 +161,7 @@ CHIP_ERROR Engine::BuildSingleReportDataAttributeReportIBs(ReportDataMessage::Bu
  }
  }
 
-#if CONFIG_IM_BUILD_FOR_UNIT_TEST
+#if CONFIG_BUILD_FOR_HOST_UNIT_TEST
  attributesRead++;
  if (attributesRead > mMaxAttributesPerChunk)
  {
@@ -431,7 +431,7 @@ CHIP_ERROR Engine::BuildAndSendSingleReportData(ReadHandler * apReadHandler)
 
  reportDataWriter.Init(std::move(bufHandle));
 
-#if CONFIG_IM_BUILD_FOR_UNIT_TEST
+#if CONFIG_BUILD_FOR_HOST_UNIT_TEST
  reportDataWriter.ReserveBuffer(mReservedSize);
 #endif
 

src/app/reporting/Engine.h

@@ -63,7 +63,7 @@ class Engine
 
  void Shutdown();
 
-#if CONFIG_IM_BUILD_FOR_UNIT_TEST
+#if CONFIG_BUILD_FOR_HOST_UNIT_TEST
  void SetWriterReserved(uint32_t aReservedSize) { mReservedSize = aReservedSize; }
 
  void SetMaxAttributesPerChunk(uint32_t aMaxAttributesPerChunk) { mMaxAttributesPerChunk = aMaxAttributesPerChunk; }
@@ -126,7 +126,7 @@ class Engine
 
  void ScheduleUrgentEventDeliverySync();
 
-#if CONFIG_IM_BUILD_FOR_UNIT_TEST
+#if CONFIG_BUILD_FOR_HOST_UNIT_TEST
  size_t GetGlobalDirtySetSize() { return mGlobalDirtySet.Allocated(); }
 #endif
 
@@ -247,7 +247,7 @@ class Engine
  * mGlobalDirtySet is used to track the set of attribute/event paths marked dirty for reporting purposes.
  *
  */
-#if CONFIG_IM_BUILD_FOR_UNIT_TEST
+#if CONFIG_BUILD_FOR_HOST_UNIT_TEST
  // For unit tests, always use inline allocation for code coverage.
  ObjectPool<AttributePathParamsWithGeneration, CHIP_IM_SERVER_MAX_NUM_DIRTY_SET, ObjectPoolMem::kInline> mGlobalDirtySet;
 #else
@@ -268,7 +268,7 @@ class Engine
  */
  uint64_t mDirtyGeneration = 1;
 
-#if CONFIG_IM_BUILD_FOR_UNIT_TEST
+#if CONFIG_BUILD_FOR_HOST_UNIT_TEST
  uint32_t mReservedSize = 0;
  uint32_t mMaxAttributesPerChunk = UINT32_MAX;
 #endif

src/credentials/FabricTable.h

@@ -409,11 +409,11 @@ class DLL_EXPORT FabricTable
  */
  CHIP_ERROR UpdateFabric(FabricIndex fabricIndex, FabricInfo & fabricInfo);
 
- // TODO this #if CONFIG_IM_BUILD_FOR_UNIT_TEST is temporary. There is a change incoming soon
+ // TODO this #if CONFIG_BUILD_FOR_HOST_UNIT_TEST is temporary. There is a change incoming soon
  // that will allow triggering NOC update directly.
-#if CONFIG_IM_BUILD_FOR_UNIT_TEST
+#if CONFIG_BUILD_FOR_HOST_UNIT_TEST
  void SendUpdateFabricNotificationForTest(FabricIndex fabricIndex) { NotifyNOCUpdatedOnFabric(fabricIndex); }
-#endif // CONFIG_IM_BUILD_FOR_UNIT_TEST
+#endif // CONFIG_BUILD_FOR_HOST_UNIT_TEST
 
  FabricInfo * FindFabric(const Crypto::P256PublicKey & rootPubKey, FabricId fabricId);
  FabricInfo * FindFabricWithIndex(FabricIndex fabricIndex);

src/lib/core/CHIPConfig.h

@@ -878,13 +878,15 @@ extern const char CHIP_NON_PRODUCTION_MARKER[];
 #endif
 
 /**
- * @def CONFIG_IM_BUILD_FOR_UNIT_TEST
+ * @def CONFIG_BUILD_FOR_HOST_UNIT_TEST
  *
- * @brief Defines whether we're currently building the IM for unit testing, which enables a set of features
- * that are only utilized in those tests.
+ * @brief Defines whether we're currently building for unit testing, which enables a set of features
+ * that are only utilized in those tests. This flag should not be enabled on devices. If you have a test
+ * that uses this flag, either appropriately conditionalize the entire test on this flag, or to exclude
+ * the compliation of that test source file entirely.
  */
-#ifndef CONFIG_IM_BUILD_FOR_UNIT_TEST
-#define CONFIG_IM_BUILD_FOR_UNIT_TEST 0
+#ifndef CONFIG_BUILD_FOR_HOST_UNIT_TEST
+#define CONFIG_BUILD_FOR_HOST_UNIT_TEST 0
 #endif
 
 /**

src/protocols/secure_channel/CASESession.cpp

@@ -1727,7 +1727,7 @@ CHIP_ERROR CASESession::OnMessageReceived(ExchangeContext * ec, const PayloadHea
  Protocols::SecureChannel::MsgType msgType = static_cast<Protocols::SecureChannel::MsgType>(payloadHeader.GetMessageType());
  SuccessOrExit(err);
 
-#if CONFIG_IM_BUILD_FOR_UNIT_TEST
+#if CONFIG_BUILD_FOR_HOST_UNIT_TEST
  if (mStopHandshakeAtState.HasValue() && mState == mStopHandshakeAtState.Value())
  {
  mStopHandshakeAtState = Optional<State>::Missing();
@@ -1741,7 +1741,7 @@ CHIP_ERROR CASESession::OnMessageReceived(ExchangeContext * ec, const PayloadHea
  mExchangeCtxt->WillSendMessage();
  return CHIP_NO_ERROR;
  }
-#endif // CONFIG_IM_BUILD_FOR_UNIT_TEST
+#endif // CONFIG_BUILD_FOR_HOST_UNIT_TEST
 
 #if CHIP_CONFIG_SLOW_CRYPTO
  if (msgType == Protocols::SecureChannel::MsgType::CASE_Sigma1 || msgType == Protocols::SecureChannel::MsgType::CASE_Sigma2 ||

src/protocols/secure_channel/CASESession.h

@@ -272,9 +272,9 @@ class DLL_EXPORT CASESession : public Messaging::UnsolicitedMessageHandler,
 
  void InvalidateIfPendingEstablishmentOnFabric(FabricIndex fabricIndex);
 
-#if CONFIG_IM_BUILD_FOR_UNIT_TEST
+#if CONFIG_BUILD_FOR_HOST_UNIT_TEST
  void SetStopSigmaHandshakeAt(Optional<State> state) { mStopHandshakeAtState = state; }
-#endif // CONFIG_IM_BUILD_FOR_UNIT_TEST
+#endif // CONFIG_BUILD_FOR_HOST_UNIT_TEST
 
  Crypto::Hash_SHA256_stream mCommissioningHash;
  Crypto::P256PublicKey mRemotePubKey;
@@ -305,9 +305,9 @@ class DLL_EXPORT CASESession : public Messaging::UnsolicitedMessageHandler,
 
  State mState;
 
-#if CONFIG_IM_BUILD_FOR_UNIT_TEST
+#if CONFIG_BUILD_FOR_HOST_UNIT_TEST
  Optional<State> mStopHandshakeAtState = Optional<State>::Missing();
-#endif // CONFIG_IM_BUILD_FOR_UNIT_TEST
+#endif // CONFIG_BUILD_FOR_HOST_UNIT_TEST
 };
 
 } // namespace chip

src/protocols/secure_channel/tests/TestCASESession.cpp

@@ -355,7 +355,7 @@ void CASE_SecurePairingHandshakeTestCommon(nlTestSuite * inSuite, void * inConte
  NL_TEST_ASSERT(inSuite, pairingCommissioner.GetRemoteMRPConfig().mIdleRetransTimeout == System::Clock::Milliseconds32(360000));
  NL_TEST_ASSERT(inSuite,
  pairingCommissioner.GetRemoteMRPConfig().mActiveRetransTimeout == System::Clock::Milliseconds32(100000));
-#if CONFIG_IM_BUILD_FOR_UNIT_TEST
+#if CONFIG_BUILD_FOR_HOST_UNIT_TEST
  // Confirming that FabricTable sending a notification that fabric was updated doesn't affect
  // already established connections.
  //
@@ -367,7 +367,7 @@ void CASE_SecurePairingHandshakeTestCommon(nlTestSuite * inSuite, void * inConte
  NL_TEST_ASSERT(inSuite, delegateCommissioner.mNumPairingComplete == 1);
  NL_TEST_ASSERT(inSuite, delegateAccessory.mNumPairingErrors == 0);
  NL_TEST_ASSERT(inSuite, delegateCommissioner.mNumPairingErrors == 0);
-#endif // CONFIG_IM_BUILD_FOR_UNIT_TEST
+#endif // CONFIG_BUILD_FOR_HOST_UNIT_TEST
 }
 
 void CASE_SecurePairingHandshakeTest(nlTestSuite * inSuite, void * inContext)
@@ -844,7 +844,7 @@ static void CASE_SessionResumptionStorage(nlTestSuite * inSuite, void * inContex
 }
 
 // TODO, move all tests above into this class
-#if CONFIG_IM_BUILD_FOR_UNIT_TEST
+#if CONFIG_BUILD_FOR_HOST_UNIT_TEST
 namespace chip {
 // TODO rename CASESessionForTest to TestCASESession. Not doing that immediately since that requires
 // removing a lot of the `using namesapce` above which is a larger cleanup.
@@ -920,7 +920,7 @@ void CASESessionForTest::CASE_SimulateUpdateNOCInvalidatePendingEstablishment(nl
  NL_TEST_ASSERT(inSuite, delegateCommissioner.mNumPairingComplete == 0);
 }
 } // namespace chip
-#endif // CONFIG_IM_BUILD_FOR_UNIT_TEST
+#endif // CONFIG_BUILD_FOR_HOST_UNIT_TEST
 
 // Test Suite
 
@@ -937,11 +937,11 @@ static const nlTest sTests[] =
  NL_TEST_DEF("Sigma1Parsing", CASE_Sigma1ParsingTest),
  NL_TEST_DEF("DestinationId", CASE_DestinationIdTest),
  NL_TEST_DEF("SessionResumptionStorage", CASE_SessionResumptionStorage),
-#if CONFIG_IM_BUILD_FOR_UNIT_TEST
+#if CONFIG_BUILD_FOR_HOST_UNIT_TEST
  // This is compiled for host tests which is enough test coverage to ensure updating NOC invalidates
  // CASESession that are in the process of establishing.
  NL_TEST_DEF("InvalidatePendingSessionEstablishment", chip::CASESessionForTest::CASE_SimulateUpdateNOCInvalidatePendingEstablishment),
-#endif // CONFIG_IM_BUILD_FOR_UNIT_TEST
+#endif // CONFIG_BUILD_FOR_HOST_UNIT_TEST
 
  NL_TEST_SENTINEL()
 };