Increase unit test code coverage of ble/ by 1.9%
#39890
Open
+207
−4
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
|
Th 8000 ere was a problem hiding this comment.
Code Review
This pull request aims to increase unit test coverage for the ble/ directory by adding tests for BleLayer::NewConnectionByDiscriminators. The changes introduce a test accessor for BleLayer and several new test cases. While the new tests cover various scenarios like initialization failures and delegate issues, the core success and error path tests have logical flaws in how they simulate and verify callbacks. I've also pointed out a few minor issues in comments and build files. Addressing the issues in the test logic is important to ensure the BleLayer's callback mechanism is correctly validated.
c41cbcd to
efdcd51
Compare
src/ble/BleLayer.h
Outdated
| @@ -224,7 +231,7 @@ class DLL_EXPORT BleLayer | |||
| kState_NotInitialized = 0, | |||
| kState_Initialized = 1, | |||
| kState_Disconnecting = 2 | |||
| } mState; ///< [READ-ONLY] external access is deprecated, use IsInitialized() / IsBleClosing() | |||
| } mState; ///< [READ-ONLY] external access is deprecated, use () / IsBleClosing() | |||
There was a problem hiding this comment.
Why was the bot's (correct) comment resolved without actually resolving the issue?
src/ble/BleLayer.h
Outdated
| @@ -354,6 +361,7 @@ class DLL_EXPORT BleLayer | |||
|
|
|||
| static void OnConnectionComplete(void * appState, BLE_CONNECTION_OBJECT connObj); | |||
| static void OnConnectionError(void * appState, CHIP_ERROR err); | |||
|
|
|||
src/ble/tests/TestBleLayer.cpp
Outdated
|
|
||
| // Create a list of discriminators | ||
| SetupDiscriminator discriminators[] = { SetupDiscriminator(), SetupDiscriminator() }; | ||
| Span<const SetupDiscriminator> discriminatorsSpan(discriminators, 2); |
There was a problem hiding this comment.
Suggested change
| Span<const SetupDiscriminator> discriminatorsSpan(discriminators, 2); | |
| Span<const SetupDiscriminator> discriminatorsSpan(discriminators); |
| // Checks that the connection could not be established due to an error | ||
| TEST_F(TestBleLayer, NewConnectionByDiscriminatorsError) | ||
| { | ||
| chip::Test::BleLayerTestAccess access(this); |
There was a problem hiding this comment.
Why the chip:: prefix here and elsewhere in this PR? Is this not all inside namespace chip?
There was a problem hiding this comment.
The chip:: prefix here is needed, because otherwise compiler identifies Test as pw::unit_test::internal::Test.
src/ble/tests/TestBleLayer.cpp
Outdated
| access.SetConnectionDelegate(nullptr); | ||
|
|
||
| SetupDiscriminator discriminators[] = { SetupDiscriminator(), SetupDiscriminator() }; | ||
| Span<const SetupDiscriminator> discriminatorsSpan(discriminators, 2); |
There was a problem hiding this comment.
Please drop the extra , 2 various places. I'll stop commenting on this.
There was a problem hiding this comment.
Thank you for the review. This PR is still a draft, I'll make the changes based on your feedback.
aafb339 to
7b4f187
Compare
d19f134 to
bc25c93
Compare
|
PR #39890: Size comparison from 1446be8 to bc25c93 Full report (72 builds for bl602, bl702, bl702l, cc13x4_26x4, cc32xx, cyw30739, efr32, esp32, linux, nrfconnect, nxp, psoc6, qpg, stm32, telink, tizen)
|
… completes succesfully
Adds a test to callback to the BLE layer to notify when a connection is complete. This change also adds a test case to verify the callback is working. - The old BleLayerAccess.h is removed - -`CallOnConnectionComplete` function is added to `BleLayerTestAccess.h` as a wrapper to `OnConnectionComplete` function of `BleLayer` to test the new callback functionality.
It tries to ensure that the connection delegate is properly set before attempting to establish a connection, preventing potential incorrect state errors.
in the test BLE layer. This allows for better verification of connection establishment success and failure scenarios.
Refactors the Ble connection success test by simplifying the OnSuccess callback invocation and adding assertions to verify the connection and error counts, ensuring more robust test coverage.
Introduces validation to handle empty discriminator Span in BLE connection logic, returning an error for invalid arguments. Adds unit tests to cover scenarios such as uninitialized states, missing connection delegates, and empty discriminator spans.
Introduces a new test to validate error handling during BLE connection establishment using discriminators.
Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
Co-authored-by: Boris Zbarsky <bzbarsky@apple.com>
bc25c93 to
7893a87
Compare
|
PR #39890: Size comparison from bde480e to 7893a87 Full report (45 builds for bl602, bl702, bl702l, cc13x4_26x4, cc32xx, cyw30739, nrfconnect, psoc6, qpg, stm32, telink, tizen)
|
|
PR #39890: Size comparison from f804504 to a241cd3 Full report (72 builds for bl602, bl702, bl702l, cc13x4_26x4, cc32xx, cyw30739, efr32, esp32, linux, nrfconnect, nxp, psoc6, qpg, stm32, telink, tizen)
|
heinsaar
approved these changes
Jul 11, 2025
juandediosg
reviewed
Jul 11, 2025
| @@ -383,5 +408,127 @@ TEST_F(TestBleLayer, ExceedBleConnectionEndPointLimit) | |||
| EXPECT_FALSE(HandleWriteReceivedCapabilitiesRequest(connObj)); | |||
| } | |||
|
|
|||
| TEST_F(TestBleLayer, NewBleConnectionByDiscriminatorsNotInitialized) | |||
There was a problem hiding this comment.
Maybe consider adding a comment.
| EXPECT_EQ(NewBleConnectionByDiscriminators(discriminatorsSpan, this, OnSuccess, OnError), CHIP_ERROR_INCORRECT_STATE); | ||
| } | ||
|
|
||
| TEST_F(TestBleLayer, NewBleConnectionByDiscriminatorsNoConnectionDelegate) |
There was a problem hiding this comment.
Maybe consider adding a comment.
| EXPECT_EQ(NewBleConnectionByDiscriminators(discriminatorsSpan, this, OnSuccess, OnError), CHIP_ERROR_INCORRECT_STATE); | ||
| } | ||
|
|
||
| TEST_F(TestBleLayer, NewBleConnectionByDiscriminatorsNoBleTransportLayer) |
There was a problem hiding this comment.
Maybe consider adding a comment.
| EXPECT_EQ(NewBleConnectionByDiscriminators(discriminatorsSpan, this, OnSuccess, OnError), CHIP_ERROR_INCORRECT_STATE); | ||
| } | ||
|
|
||
| TEST_F(TestBleLayer, NewConnectionByDiscriminatorsSuccess) |
There was a problem hiding this comment.
Maybe consider adding a comment.
| EXPECT_EQ(mOnConnectionErrorCount, 1); | ||
| } | ||
|
|
||
| TEST_F(TestBleLayer, NewConnectionByDiscriminatorsEmptySpan) |
There was a problem hiding this comment.
Maybe consider adding a comment.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
This PR adds comprehensive unit tests for the
BleLayer::NewConnectionByDiscriminatorsmethod inTestBleLayer.cpp, increasing test coverage ofble/folder from 67.2% to 69.1%. The tests cover the following scenarios:BleLayerBleConnectionDelegateOnSuccesscallback)OnErrorcallback)Implementation Notes
BLE_LAYER_NUM_BLE_ENDPOINTSmacro being set to 1, restrictingBleLayerto one connection at a time. MultipleOnSuccesscallback calls when multiple discriminators match cannot be tested at the moment beacuse of this endpoint limitation.BleLayerTestAccessaccessor class inBleLayerTestAccess.hto access private membermConnectionDelegateandOnConnectionCompletemethod ofBleLayerfor testing purposes, following the testing guidelines defined in the Connected Home IP unit testing documentationOnSuccessandOnErrorcallback validation is achieved through custom lambda functions implemented specifically for testing purposes to simulate connection success/failure scenarios.Related issues
Main Issue #37732
Testing
This PR only adds new unit tests. No changes made to production code.