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`.

Open
#31 0 comments 0 reactions 0 assignees View on GitHub

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

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 check after make and make cli_tests runs the cli tests of the application
  • if the binary hasn't been built before make check is 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 check executes 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 check target which runs the cli tests
  • allow to register only a subset of cli tests to the check target
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

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from seqan/app-template

All issues in seqan/app-template

Similar issues

More Build System issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.