From 335b3514ade67db6e96df59d12e2a226325a42e2 Mon Sep 17 00:00:00 2001 From: Ed Morley <501702+edmorley@users.noreply.github.com> Date: Fri, 17 Nov 2023 12:13:41 +0000 Subject: [PATCH] Clean up rustdocs about how to run the integration tests (#745) 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. --- examples/execd/tests/integration_test.rs | 6 ++---- examples/ruby-sample/tests/integration_test.rs | 6 ++---- libcnb-cargo/tests/integration_test.rs | 3 +++ libcnb-test/tests/integration_test.rs | 6 ++---- .../readonly-layer-files/tests/integration_test.rs | 6 ++---- test-buildpacks/sbom/tests/integration_test.rs | 6 ++---- test-buildpacks/store/tests/integration_test.rs | 6 ++---- 7 files changed, 15 insertions(+), 24 deletions(-) diff --git a/examples/execd/tests/integration_test.rs b/examples/execd/tests/integration_test.rs index 7d0e80ef..380b915b 100644 --- a/examples/execd/tests/integration_test.rs +++ b/examples/execd/tests/integration_test.rs @@ -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 diff --git a/examples/ruby-sample/tests/integration_test.rs b/examples/ruby-sample/tests/integration_test.rs index 1ae7be44..3b3abae0 100644 --- a/examples/ruby-sample/tests/integration_test.rs +++ b/examples/ruby-sample/tests/integration_test.rs @@ -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 diff --git a/libcnb-cargo/tests/integration_test.rs b/libcnb-cargo/tests/integration_test.rs index a1c27383..f42df7aa 100644 --- a/libcnb-cargo/tests/integration_test.rs +++ b/libcnb-cargo/tests/integration_test.rs @@ -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)] diff --git a/libcnb-test/tests/integration_test.rs b/libcnb-test/tests/integration_test.rs index 3149824a..39ffc9c2 100644 --- a/libcnb-test/tests/integration_test.rs +++ b/libcnb-test/tests/integration_test.rs @@ -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` diff --git a/test-buildpacks/readonly-layer-files/tests/integration_test.rs b/test-buildpacks/readonly-layer-files/tests/integration_test.rs index b82569a4..8b43f30c 100644 --- a/test-buildpacks/readonly-layer-files/tests/integration_test.rs +++ b/test-buildpacks/readonly-layer-files/tests/integration_test.rs @@ -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 diff --git a/test-buildpacks/sbom/tests/integration_test.rs b/test-buildpacks/sbom/tests/integration_test.rs index faf5a809..519a451b 100644 --- a/test-buildpacks/sbom/tests/integration_test.rs +++ b/test-buildpacks/sbom/tests/integration_test.rs @@ -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 diff --git a/test-buildpacks/store/tests/integration_test.rs b/test-buildpacks/store/tests/integration_test.rs index 3dec8028..4ea30f4d 100644 --- a/test-buildpacks/store/tests/integration_test.rs +++ b/test-buildpacks/store/tests/integration_test.rs @@ -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