Add feature: Inform users about CppCoverage exclude path when creating tests files, and fix typo in Exlude - #20
Open
MichaelBCG wants to merge 2 commits into
Conversation
MichaelBCG
referenced
this pull request
in MichaelBCG/devops_ue
Apr 17, 2024
Add feature: Inform users about CppCoverage exclude path when creating tests files, and fix typo in Exlude
MichaelBCG
force-pushed
the
feature/inform-excluded-tests
branch
from
April 19, 2024 02:29
36c5e02 to
f5fac6d
Compare
Author
|
FYI: The changes in this pull request are included to #22 |
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
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.
This pull request improves usability of creating test files. Also it fixes typos in variable names containing Exluded
Previous behavior:
The directory with test files which are to be excluded from OpenCppCoverage report is hard-coded in config.bat as
\Tests(which means that the directories starting with "Tests" are excluded from code coverage report, e.g. directories such asTests,Tests123,Tests\123\etc are excluded).Problem:
However, using scripts create_spec_file.bat and create_test_file.bat a user can create test files in any directory (e.g.
MyTests). If this new directory does not matchTests*pattern, it will not be excluded from the code coverage report, and the problem is that the user may be not aware of it or it could slip user's mind at the moment.New behavior:
Functionality added with this pull request informs the user about what path will be excluded from OpenCppCoverage report when the user creates tests files. This information will remind the user that test files should be created in the specified path.
Example of updated output in create_spec_file.bat:

Typos fix:
This pull request also fixes the typos in the variable names because these variables are used in the added functionality:
"c" is missing in variable names starting with "Exluded..." (should be "Excluded...")
Besides,
Users who already utilize this repo will need to fix the typo in
ExludedPathForTestReportvariable name (corrected name isExcludedPathForTestReport) in their copies of\devops_data\config.batfiles. Otherwise UE tests as well as OpenCPPCoverage will not run from within \tests\run_tests.bat (previous versions of the http UE tests report and the code coverage report will be shown in this case).