Define the test build target more often
#91
Merged
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
bretbrownjr
requested review from
camio,
dietmarkuehl,
neatudarius,
steve-downey and
wusatosi
as code owners
bretbrownjr
force-pushed
the
better-test-target
branch
from
49fc815 to
3624042
Compare
Problem ------- Given a setting of `BEMAN_EXEMPLAR_BUILD_TESTS` equal to `OFF`, when a user runs a basic CMake test command such as: ``` cmake --build binary-dir/ --target test ``` Then the user gets an error that indicates there is no CMake test target defined. ``` $ cmake --build build2/ --target test ninja: error: unknown target 'test', did you mean 'help'? ``` Solution -------- It is not required to actually build any tests to define the CMake test target. This commit defines the CMake `test` target unconditionally. This is good practice for a few reasons: * A user or tool doesn't have to know project-specific details to perform basic actions on this project. * A user or tool doesn't have to know how to interpret the "unknown target 'test'" error. * When no tests are built, the user sees a successful run of zero tests instead of a more ambiguous situation where test aren't run for unclear reasons.
bretbrownjr
force-pushed
the
better-test-target
branch
from
3624042 to
a885d77
Compare
Draft
neatudarius
reviewed
Jan 2, 2025
There was a problem hiding this comment.
I'm OK with this change, but we should be consistent with the update.
I would create an issue in https://github.com/bemanproject/beman to update the Beman Standard first. Then I would update all other repos.
camio
approved these changes
Jan 6, 2025
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.
Problem
Given a setting of
BEMAN_EXEMPLAR_BUILD_TESTSequal toOFF, when a user runs a basic CMake test command such as:Then the user gets an error that indicates there is no CMake test target defined.
Solution
It is not required to actually build any tests to define the CMake test target. This commit defines the CMake
testtarget unconditionally.This is good practice for a few reasons:
A user or tool doesn't have to know project-specific details to perform basic actions on this project.
A user or tool doesn't have to know how to interpret the "unknown target 'test'" error.
When no tests are built, the user sees a successful run of zero tests instead of a more ambiguous situation where test aren't run for unclear reasons.