Add boilerplate unit test code to currently untested modules #14993
Conversation
This file contains 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
ciarmcom
added
the
release-type: patch
|
@hazzlim, thank you for your changes. |
rwalton-arm
reviewed
Aug 11, 2021
hazzlim
force-pushed
the
unit_test_support
branch
from
55469f1
to
0a0acb1
Compare
Patater
previously requested changes
Aug 11, 2021
hazzlim
force-pushed
the
unit_test_support
branch
from
0a0acb1
to
5d2ea38
Compare
hazzlim
commented
Aug 11, 2021
Patater
previously approved these changes
Aug 12, 2021
Patater
changed the title
0xc0170
reviewed
Aug 12, 2021
Unit tests for drivers are currently not checked for style compliance. We should be checking coding style in unit tests, so we remove them from the .codecheckignore file.
Currently there are no stub implementations of the analogin_api.c functions. As the AnalogIn class makes use of these functions, these stub definitions are required in order to build AnalogIn.cpp and generate .gcno files to be used to generate code coverage metrics.
In pursuit of increasing unit test coverage of Mbed OS, we add the boilerplate code for unit testing of AnalogIn.cpp and an empty test source file. This serves two purposes - it allows us to report on currently untested sources in code coverage data, and it makes it a little easier for developers to write unit tests for these sources. The 'empty' test file contains a main function that simply returns. This is required to allow CMake's add_executable() to be used to pull in the source file for the SUT, which ensures that this source file is built and therefore instrumented to generate coverage data. The alternative that was explored was to instead use Google Test's TEST() macro and prefix the test name with 'DISABLED_' to skip it, but that resulted in the test being reported as skipped, which was deemed undesireable for these 'empty' tests.
hazzlim
force-pushed
the
unit_test_support
branch
from
5d2ea38
to
c6312a3
Compare
0xc0170
approved these changes
Aug 16, 2021
|
CI started |
Patater
approved these changes
Aug 16, 2021
| @@ -35,4 +35,3 @@ | |||
| ^UNITTESTS | |||
| ^storage/blockdevice/tests/UNITTESTS | |||
| ^storage/kvstore/tests/UNITTESTS | |||
| ^drivers/tests/UNITTESTS | |||
There was a problem hiding this comment.
Just an observation: There seem to be no style changes needed in this commit. The style checking CI is passing. If there were files out of style in drivers/tests/UNITTESTS, this commit would have needed fixes to get those files back in style.
There was a problem hiding this comment.
Thanks Jaeden, noted. I did run astyle on them but they turned out to all be fine, luckily.
Patater
moved this from In progress (8)
to Reviewer approved & awaiting CI & merge (3)
in Mbed Core
Jenkins CI Test : ✔️ SUCCESSBuild Number: 1 | 🔒 Jenkins CI Job | 🌐 Logs & ArtifactsCLICK for Detailed Summary
|
Mbed Core
automation
moved this from Reviewer approved & awaiting CI & merge (3)
to Done
Aug 17, 2021
mbedmain
added
release-version: 6.14.0
Release-pending
and removed
release-type: patch
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 of changes
In pursuit of increasing unit test coverage of MbedOS, we add the
boilerplate code for unit testing of AnalogIn.cpp and an empty test
source file. This serves two purposes - it allows us to report on
currently untested sources in code coverage data, and it makes it a
little easier for developers to write unit tests for these sources.
The 'empty' test file contains a main function that simply returns. This
is required to allow CMake's add_executable() to be used to pull in the
source file for the SUT, which ensures that this source file is built
and therefore instrumented to generate coverage data. The alternative
that was explored was to instead use Google Test's TEST() macro and
prefix the test name with 'DISABLED_' to skip it, but that resulted in
the test being reported as skipped, which was deemed undesireable for
these 'empty' tests.
Additionally, stubs for analogin_api.c functions are added to the Mbed-stubs-hal library, to allow AnalogIn.cpp to build & to be used by the future unit tests.
Impact of changes
Migration actions required
None.
Documentation
None.
Pull request type
Test results
Reviewers
@Patater @rwalton-arm @ARMmbed/mbed-os-core