Skip to content

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
life-exe:masterfrom
MichaelBCG:feature/inform-excluded-tests
Open

Add feature: Inform users about CppCoverage exclude path when creating tests files, and fix typo in Exlude#20
MichaelBCG wants to merge 2 commits into
life-exe:masterfrom
MichaelBCG:feature/inform-excluded-tests

Conversation

@MichaelBCG

@MichaelBCG MichaelBCG commented Apr 17, 2024

Copy link
Copy Markdown

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 as Tests, 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 match Tests* 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:
image

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 ExludedPathForTestReport variable name (corrected name is ExcludedPathForTestReport) in their copies of \devops_data\config.bat files. 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).

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

Copy link
Copy Markdown
Author

FYI: The changes in this pull request are included to #22

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant