As a user installing an application I want to call `make check` so I can see if the application was properly built before calling `make install`.
Nobody has claimed this yet.
Assessment
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Newbie friendliness
- 35/100
- Issue type
- Feature
- Clarity
- Mostly clear
- Activity status
- Stale
- Tech stack
- cmake
- Domain
- build-system, cli, testing-qa
Research direction
Start by inspecting the project's CMake configuration and the existing make cli_tests target and CLI test registration. Define how make check should handle missing build artifacts, selected tests, failures, and diagnostics, then verify the acceptance criteria with the existing test suite.
Written by the indexing model from the issue text.
Description
@rrahn commented on Mon Mar 30 2020
Description
In many systems to install an application multiple steps are involved:
configure / cmake
make
make check
make install
First the application is configured (in our case using cmake), then the binary is built using make and then the extra target check is called to check if the built binary is correct.
In our case it should run CLI tests or a subset of them defined by the application developer.
Acceptance Criteria
- calling
make checkaftermakeand makecli_testsruns the cli tests of the application - if the binary hasn't been built before
make checkis called a diagnostic message is issued to inform that the binary has to be built before. - if the cli tests haven't been built before a diagnostic message is issued to inform that the cli tests have to be built before.
- if the binary and cli tests are present the target
checkexecutes the cli tests. - the target fails if some cli tests don't pass and outputs a corresonding diagnostic message
- if only a subset of cli tests is registered for the target only those get executed
Tasks
- add a
checktarget which runs the cli tests - allow to register only a subset of cli tests to the
checktarget
Definition of Done
- Implementation and design approved
- Unit tests pass
- Test coverage = 100%
- Microbenchmarks added and/or affected microbenchmarks < 5% performance drop
- API documentation added
- Tutorial/teaching material added
- Test suite compiles in less than 30 seconds (on travis)
- Changelog entry added
@marehr commented on Thu May 07 2020
Core-Meeting:
This would only execute a subset of tests to test basic functionality. For a complete unit test; build all tests.
- Dominant language
- CMake
- Stars
- 6
- Forks
- 9
- Avg merge
- 23h 34m
- Merged PRs (30d)
- 3
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from seqan/app-template
-
Add CMake Presets Open
seqan/app-template#139 · 1 assignee ·
-
Difficulty 3/5 1-2 days Newbie friendliness 45/100
seqan/app-template#65 ·
-
Make a release. Open
Difficulty 5/5 Over a week Newbie friendliness 20/100
seqan/app-template#62 ·
-
Difficulty 4/5 3-5 days Newbie friendliness 35/100
seqan/app-template#61 ·
-
Difficulty 3/5 1-2 days Newbie friendliness 38/100
seqan/app-template#60 ·
All issues in seqan/app-template
Similar issues
-
Needs Design Priority: Wishlist
Difficulty 2/5 1-3 hours Newbie friendliness 84/100
elementary/flatpak-platform#253 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
objectionary/hone-maven-plugin#1060 ·
-
0.kind: build failure
Difficulty 2/5 1-3 hours Newbie friendliness 74/100
-
Update Vish to 1.1.5 Openpackage-update
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
oSoWoSo/vOid_Community_repOsitory#144 · 1 comment ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 86/100