Testing, examples, docs, CI #63

killercup · 2018-02-17T15:49:32Z

While we have compile-tests for the guides and examples, we currently don't really have a good testing story. We have doc tests for the functions we provide, but nothing in regard of integration tests. We should change that.

My idea is this to add full crates to examples/ instead of in-crate binaries.

Each example:

has a Cargo.toml, src/main.rs
depends on the current quicli version as well as other necessary crates
has a tests/integration.rs that uses a crate like assert_cli to actually test that the correct things happen

I propose we do it like this:

Convert existing example(s) to this structure (Examples and tests #64)
Write integration tests for these examples (Add integration test for verbosity example #65)
Create a Cargo workspace and add examples to prevent compiling libs over and over again (Examples and tests #64)
Convert waltz call in doc/_test.sh to write to examples/<guide-name> (Examples and tests #64)
Link to full code in guides
Add link checker to CI (e.g. using this)
Fail CI when running waltz creates a diff (Examples and tests #64)
Write integration tests for code in the guides

The text was updated successfully, but these errors were encountered:

First step towards #63. Instead of `.cargo/config` and recompiling stuff over and over again, we'll be adding sub-crates to `examples/`.

#63 is going according to plan.

This changes the call to waltz to render the code from the guides into the `examples/` directory instead of a some temporary directory and assert that they are checked in. cf. #63

The idea is this: Since the code from the guides is now checked in as crates in `examples/`, we can call `cargo test --all` in the one CI build and only use the waltz build step to assert that they are up to date. While we're at it, let's also turn in caching. cf .#63

This changes the call to waltz to render the code from the guides into the `examples/` directory instead of a some temporary directory and assert that they are checked in. cf. #63

The idea is this: Since the code from the guides is now checked in as crates in `examples/`, we can call `cargo test --all` in the one CI build and only use the waltz build step to assert that they are up to date. While we're at it, let's also turn in caching. cf .#63

This changes the call to waltz to render the code from the guides into the `examples/` directory instead of a some temporary directory and assert that they are checked in. cf. #63

The idea is this: Since the code from the guides is now checked in as crates in `examples/`, we can call `cargo test --all` in the one CI build and only use the waltz build step to assert that they are up to date. While we're at it, let's also turn in caching. cf .#63

First step towards #63. Instead of `.cargo/config` and recompiling stuff over and over again, we'll be adding sub-crates to `examples/`.

#63 is going according to plan.

This changes the call to waltz to render the code from the guides into the `examples/` directory instead of a some temporary directory and assert that they are checked in. cf. #63

The idea is this: Since the code from the guides is now checked in as crates in `examples/`, we can call `cargo test --all` in the one CI build and only use the waltz build step to assert that they are up to date. While we're at it, let's also turn in caching. cf .#63

The idea is this: Since the code from the guides is now checked in as crates in `examples/`, we can call `cargo test --all` in the one CI build and only use the waltz build step to assert that they are up to date. While we're at it, let's also turn on caching. cf .#63

64: Examples and tests r=killercup a=killercup cf. #63

cc #63

65: Add integration test for verbosity example r=killercup a=killercup cc #63

killercup added planned looking for feedback labels Feb 17, 2018

killercup added a commit that referenced this issue Feb 17, 2018

Use Cargo workspace and patch section

c12806a

First step towards #63. Instead of `.cargo/config` and recompiling stuff over and over again, we'll be adding sub-crates to `examples/`.

killercup added a commit that referenced this issue Feb 17, 2018

Make verbosity examples a sub crate

00d4992

#63 is going according to plan.

killercup mentioned this issue Feb 17, 2018

Examples and tests #64

Merged

killercup added a commit that referenced this issue Feb 17, 2018

Use Cargo workspace and patch section

f332acc

First step towards #63. Instead of `.cargo/config` and recompiling stuff over and over again, we'll be adding sub-crates to `examples/`.

killercup added a commit that referenced this issue Feb 17, 2018

Make verbosity examples a sub crate

dda83b0

#63 is going according to plan.

bors bot added a commit that referenced this issue Feb 17, 2018

Merge #64

9257709

64: Examples and tests r=killercup a=killercup cf. #63

killercup added help wanted Extra attention is needed and removed looking for feedback labels Feb 17, 2018

killercup added a commit that referenced this issue Feb 18, 2018

Add integration test for verbosity example

b06e5f9

cc #63

killercup mentioned this issue Feb 18, 2018

Add integration test for verbosity example #65

Merged

bors bot added a commit that referenced this issue Feb 18, 2018

Merge #65

5ec1b64

65: Add integration test for verbosity example r=killercup a=killercup cc #63

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Testing, examples, docs, CI #63

Testing, examples, docs, CI #63

killercup commented Feb 17, 2018 •

edited

Loading

Testing, examples, docs, CI #63

Testing, examples, docs, CI #63

Comments

killercup commented Feb 17, 2018 • edited Loading

killercup commented Feb 17, 2018 •

edited

Loading