Skip to content

Commit

Permalink
Clean up rustdocs about how to run the integration tests (#745)
Browse files Browse the repository at this point in the history
The rustdocs is now based on the wording used for the Python CNB,
which has slightly less boilerplate. The docs have also been added
to one place where they were missing.
  • Loading branch information
edmorley committed Nov 17, 2023
1 parent ee6542f commit 335b351
Show file tree
Hide file tree
Showing 7 changed files with 15 additions and 24 deletions.
6 changes: 2 additions & 4 deletions examples/execd/tests/integration_test.rs
Original file line number Diff line number Diff line change
@@ -1,7 +1,5 @@
//! Integration tests using libcnb-test.
//!
//! All integration tests are skipped by default (using the `ignore` attribute),
//! since performing builds is slow. To run the tests use: `cargo test -- --ignored`
//! All integration tests are skipped by default (using the `ignore` attribute)
//! since performing builds is slow. To run them use: `cargo test -- --ignored`.

// Enable Clippy lints that are disabled by default.
// https://rust-lang.github.io/rust-clippy/stable/index.html
Expand Down
6 changes: 2 additions & 4 deletions examples/ruby-sample/tests/integration_test.rs
Original file line number Diff line number Diff line change
@@ -1,7 +1,5 @@
//! Integration tests using libcnb-test.
//!
//! All integration tests are skipped by default (using the `ignore` attribute),
//! since performing builds is slow. To run the tests use: `cargo test -- --ignored`
//! All integration tests are skipped by default (using the `ignore` attribute)
//! since performing builds is slow. To run them use: `cargo test -- --ignored`.

// Enable Clippy lints that are disabled by default.
// https://rust-lang.github.io/rust-clippy/stable/index.html
Expand Down
3 changes: 3 additions & 0 deletions libcnb-cargo/tests/integration_test.rs
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
//! All integration tests are skipped by default (using the `ignore` attribute)
//! since performing builds is slow. To run them use: `cargo test -- --ignored`.

// Enable Clippy lints that are disabled by default.
// https://rust-lang.github.io/rust-clippy/stable/index.html
#![warn(clippy::pedantic)]
Expand Down
6 changes: 2 additions & 4 deletions libcnb-test/tests/integration_test.rs
Original file line number Diff line number Diff line change
@@ -1,7 +1,5 @@
//! Integration tests using libcnb-test.
//!
//! All integration tests are skipped by default (using the `ignore` attribute),
//! since performing builds is slow. To run the tests use: `cargo test -- --ignored`
//! All integration tests are skipped by default (using the `ignore` attribute)
//! since performing builds is slow. To run them use: `cargo test -- --ignored`.
//!
//! When testing panics, prefer using `#[should_panic(expected = "...")]`, unless you need
//! to test dynamic values, in which case the only option is to use `panic::catch_unwind`
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,5 @@
//! Integration tests using libcnb-test.
//!
//! All integration tests are skipped by default (using the `ignore` attribute),
//! since performing builds is slow. To run the tests use: `cargo test -- --ignored`
//! All integration tests are skipped by default (using the `ignore` attribute)
//! since performing builds is slow. To run them use: `cargo test -- --ignored`.

// Enable Clippy lints that are disabled by default.
// https://rust-lang.github.io/rust-clippy/stable/index.html
Expand Down
6 changes: 2 additions & 4 deletions test-buildpacks/sbom/tests/integration_test.rs
Original file line number Diff line number Diff line change
@@ -1,7 +1,5 @@
//! Integration tests using libcnb-test.
//!
//! All integration tests are skipped by default (using the `ignore` attribute),
//! since performing builds is slow. To run the tests use: `cargo test -- --ignored`
//! All integration tests are skipped by default (using the `ignore` attribute)
//! since performing builds is slow. To run them use: `cargo test -- --ignored`.

// Enable Clippy lints that are disabled by default.
// https://rust-lang.github.io/rust-clippy/stable/index.html
Expand Down
6 changes: 2 additions & 4 deletions test-buildpacks/store/tests/integration_test.rs
Original file line number Diff line number Diff line change
@@ -1,7 +1,5 @@
//! Integration tests using libcnb-test.
//!
//! All integration tests are skipped by default (using the `ignore` attribute),
//! since performing builds is slow. To run the tests use: `cargo test -- --ignored`
//! All integration tests are skipped by default (using the `ignore` attribute)
//! since performing builds is slow. To run them use: `cargo test -- --ignored`.

// Enable Clippy lints that are disabled by default.
// https://rust-lang.github.io/rust-clippy/stable/index.html
Expand Down

0 comments on commit 335b351

Please sign in to comment.