Use a consistent approach for organising test fixture files (#681)

Previously test fixtures were located under a mixture of:
* `<crate>/fixtures/`
* `<crate>/test-fixtures/`

Now  for consistency they are all located under:
`<crate>/tests/fixtures/`

This matches the pattern already used by the Python CNB, Procfile CNB etc.

GUS-W-14161083.

.gitignore

@@ -1,8 +1,10 @@
-/target/
-/packaged/
+target/
 .DS_Store
 .idea
+
+# Since libcnb.rs is a library, we don't commit the lockfile so that CI tests the latest
+# in-range dependencies, which is what users will use when installing from scratch.
 Cargo.lock
-**/fixtures/*/target/
-**/fixtures/*/packaged/
-**/test-fixtures/buildpacks/*/target/
+
+# The default output directory of `cargo libcnb package`.
+packaged/

examples/execd/tests/integration_test.rs

@@ -13,7 +13,7 @@ use libcnb_test::{assert_contains, assert_empty, BuildConfig, TestRunner};
 #[ignore = "integration test"]
 fn basic() {
     TestRunner::default().build(
-        BuildConfig::new("heroku/builder:22", "test-fixtures/empty-app"),
+        BuildConfig::new("heroku/builder:22", "tests/fixtures/empty-app"),
         |context| {
             let command_output = context.run_shell_command("env");
             assert_empty!(command_output.stderr);

examples/ruby-sample/tests/integration_test.rs

@@ -19,7 +19,7 @@ use std::{fs, io};
 #[test]
 #[ignore = "integration test"]
 fn basic() {
-    let config = BuildConfig::new("heroku/buildpacks:20", "test-fixtures/simple-ruby-app");
+    let config = BuildConfig::new("heroku/buildpacks:20", "tests/fixtures/simple-ruby-app");
 
     TestRunner::default().build(&config, |context| {
         assert_contains!(context.pack_stdout, "---> Ruby Buildpack");
@@ -60,7 +60,7 @@ fn basic() {
 #[ignore = "integration test"]
 fn missing_gemfile_lock() {
     TestRunner::default().build(
-        BuildConfig::new("heroku/buildpacks:20", "test-fixtures/simple-ruby-app")
+        BuildConfig::new("heroku/buildpacks:20", "tests/fixtures/simple-ruby-app")
             .app_dir_preprocessor(|path| fs::remove_file(path.join("Gemfile.lock")).unwrap())
             .expected_pack_result(PackResult::Failure),
         |context| {

libcnb-cargo/tests/integration_test.rs

@@ -307,7 +307,7 @@ fn validate_packaged_meta_buildpack(
 
 fn copy_fixture_to_temp_dir(name: &str) -> Result<TempDir, std::io::Error> {
     let fixture_dir = PathBuf::from(env!("CARGO_MANIFEST_DIR"))
-        .join("fixtures")
+        .join("tests/fixtures")
         .join(name);
 
     // Instead of using `tempfile::tempdir` directly, we get the temporary directory ourselves and

libcnb-test/README.md

@@ -37,7 +37,7 @@ use libcnb_test::{assert_contains, assert_empty, BuildConfig, TestRunner};
 // #[test]
 fn basic() {
     TestRunner::default().build(
-        BuildConfig::new("heroku/builder:22", "test-fixtures/app"),
+        BuildConfig::new("heroku/builder:22", "tests/fixtures/app"),
         |context| {
             assert_empty!(context.pack_stderr);
             assert_contains!(context.pack_stdout, "Expected build output");
@@ -54,7 +54,7 @@ use libcnb_test::{assert_contains, BuildConfig, TestRunner};
 // #[test]
 fn rebuild() {
     TestRunner::default().build(
-        BuildConfig::new("heroku/builder:22", "test-fixtures/app"),
+        BuildConfig::new("heroku/builder:22", "tests/fixtures/app"),
         |context| {
             assert_contains!(context.pack_stdout, "Installing dependencies");
 
@@ -75,7 +75,7 @@ use libcnb_test::{assert_contains, BuildConfig, PackResult, TestRunner};
 // #[test]
 fn expected_pack_failure() {
     TestRunner::default().build(
-        BuildConfig::new("heroku/builder:22", "test-fixtures/invalid-app")
+        BuildConfig::new("heroku/builder:22", "tests/fixtures/invalid-app")
             .expected_pack_result(PackResult::Failure),
         |context| {
             assert_contains!(context.pack_stderr, "ERROR: Invalid Procfile!");
@@ -92,7 +92,7 @@ use libcnb_test::{assert_empty, BuildConfig, TestRunner};
 // #[test]
 fn run_shell_command() {
     TestRunner::default().build(
-        BuildConfig::new("heroku/builder:22", "test-fixtures/app"),
+        BuildConfig::new("heroku/builder:22", "tests/fixtures/app"),
         |context| {
             // ...
             let command_output = context.run_shell_command("python --version");
@@ -115,7 +115,7 @@ const TEST_PORT: u16 = 12345;
 // #[test]
 fn starting_web_server_container() {
     TestRunner::default().build(
-        BuildConfig::new("heroku/builder:22", "test-fixtures/app"),
+        BuildConfig::new("heroku/builder:22", "tests/fixtures/app"),
         |context| {
             // ...
             context.start_container(
@@ -154,7 +154,7 @@ use libcnb_test::{assert_contains, BuildConfig, ContainerConfig, TestRunner};
 // #[test]
 fn shell_exec() {
     TestRunner::default().build(
-        BuildConfig::new("heroku/builder:22", "test-fixtures/app"),
+        BuildConfig::new("heroku/builder:22", "tests/fixtures/app"),
         |context| {
             // ...
             context.start_container(ContainerConfig::new(), |container| {
@@ -176,7 +176,7 @@ use std::fs;
 // #[test]
 fn dynamic_fixture() {
     TestRunner::default().build(
-        BuildConfig::new("heroku/builder:22", "test-fixtures/app").app_dir_preprocessor(
+        BuildConfig::new("heroku/builder:22", "tests/fixtures/app").app_dir_preprocessor(
             |app_dir| {
                 fs::write(app_dir.join("runtime.txt"), "python-3.10").unwrap();
             },
@@ -197,7 +197,7 @@ use libcnb_test::{BuildConfig, BuildpackReference, TestRunner};
 // #[test]
 fn additional_buildpacks() {
     TestRunner::default().build(
-        BuildConfig::new("heroku/builder:22", "test-fixtures/app").buildpacks([
+        BuildConfig::new("heroku/builder:22", "tests/fixtures/app").buildpacks([
             BuildpackReference::CurrentCrate,
             BuildpackReference::WorkspaceBuildpack(buildpack_id!("my-project/buildpack")),
             BuildpackReference::Other(String::from("heroku/another-buildpack")),

libcnb-test/src/build_config.rs

@@ -30,7 +30,7 @@ impl BuildConfig {
     /// use libcnb_test::{BuildConfig, TestRunner};
     ///
     /// TestRunner::default().build(
-    ///     BuildConfig::new("heroku/builder:22", "test-fixtures/app"),
+    ///     BuildConfig::new("heroku/builder:22", "tests/fixtures/app"),
     ///     |context| {
     ///         // ...
     ///     },
@@ -59,7 +59,7 @@ impl BuildConfig {
     /// use libcnb_test::{BuildConfig, BuildpackReference, TestRunner};
     ///
     /// TestRunner::default().build(
-    ///     BuildConfig::new("heroku/builder:22", "test-fixtures/app").buildpacks([
+    ///     BuildConfig::new("heroku/builder:22", "tests/fixtures/app").buildpacks([
     ///         BuildpackReference::CurrentCrate,
     ///         BuildpackReference::WorkspaceBuildpack(buildpack_id!("my-project/buildpack")),
     ///         BuildpackReference::Other(String::from("heroku/another-buildpack")),
@@ -83,7 +83,7 @@ impl BuildConfig {
     /// use libcnb_test::{BuildConfig, CargoProfile, TestRunner};
     ///
     /// TestRunner::default().build(
-    ///     BuildConfig::new("heroku/builder:22", "test-fixtures/app")
+    ///     BuildConfig::new("heroku/builder:22", "tests/fixtures/app")
     ///         .cargo_profile(CargoProfile::Release),
     ///     |context| {
     ///         // ...
@@ -104,7 +104,7 @@ impl BuildConfig {
     /// use libcnb_test::{BuildConfig, TestRunner};
     ///
     /// TestRunner::default().build(
-    ///     BuildConfig::new("heroku/builder:22", "test-fixtures/app")
+    ///     BuildConfig::new("heroku/builder:22", "tests/fixtures/app")
     ///         .target_triple("x86_64-unknown-linux-musl"),
     ///     |context| {
     ///         // ...
@@ -126,7 +126,7 @@ impl BuildConfig {
     /// use libcnb_test::{BuildConfig, TestRunner};
     ///
     /// TestRunner::default().build(
-    ///     BuildConfig::new("heroku/builder:22", "test-fixtures/app")
+    ///     BuildConfig::new("heroku/builder:22", "tests/fixtures/app")
     ///         .env("ENV_VAR_ONE", "VALUE ONE")
     ///         .env("ENV_VAR_TWO", "SOME OTHER VALUE"),
     ///     |context| {
@@ -149,7 +149,7 @@ impl BuildConfig {
     /// use libcnb_test::{BuildConfig, TestRunner};
     ///
     /// TestRunner::default().build(
-    ///     BuildConfig::new("heroku/builder:22", "test-fixtures/app").envs([
+    ///     BuildConfig::new("heroku/builder:22", "tests/fixtures/app").envs([
     ///         ("ENV_VAR_ONE", "VALUE ONE"),
     ///         ("ENV_VAR_TWO", "SOME OTHER VALUE"),
     ///     ]),
@@ -182,7 +182,7 @@ impl BuildConfig {
     /// use libcnb_test::{BuildConfig, TestRunner};
     ///
     /// TestRunner::default().build(
-    ///     BuildConfig::new("heroku/builder:22", "test-fixtures/app").app_dir_preprocessor(
+    ///     BuildConfig::new("heroku/builder:22", "tests/fixtures/app").app_dir_preprocessor(
     ///         |app_dir| {
     ///             std::fs::remove_file(app_dir.join("Procfile")).unwrap();
     ///         },
@@ -208,11 +208,11 @@ impl BuildConfig {
     /// use libcnb_test::{BuildConfig, TestRunner};
     ///
     /// fn default_config() -> BuildConfig {
-    ///     BuildConfig::new("heroku/builder:22", "test-fixtures/app")
+    ///     BuildConfig::new("heroku/builder:22", "tests/fixtures/app")
     /// }
     ///
     /// TestRunner::default().build(
-    ///     default_config().app_dir("test-fixtures/a-different-app"),
+    ///     default_config().app_dir("tests/fixtures/a-different-app"),
     ///     |context| {
     ///         // ...
     ///     },
@@ -236,7 +236,7 @@ impl BuildConfig {
     /// use libcnb_test::{assert_contains, BuildConfig, PackResult, TestRunner};
     ///
     /// TestRunner::default().build(
-    ///     BuildConfig::new("heroku/builder:22", "test-fixtures/app")
+    ///     BuildConfig::new("heroku/builder:22", "tests/fixtures/app")
     ///         .expected_pack_result(PackResult::Failure),
     ///     |context| {
     ///         assert_contains!(context.pack_stderr, "ERROR: Invalid Procfile!");

libcnb-test/src/container_config.rs

@@ -11,7 +11,7 @@ use std::collections::{HashMap, HashSet};
 /// use libcnb_test::{BuildConfig, ContainerConfig, TestRunner};
 ///
 /// TestRunner::default().build(
-///     BuildConfig::new("heroku/builder:22", "test-fixtures/app"),
+///     BuildConfig::new("heroku/builder:22", "tests/fixtures/app"),
 ///     |context| {
 ///         // ...
 ///         context.start_container(
@@ -45,7 +45,7 @@ impl ContainerConfig {
     /// use libcnb_test::{BuildConfig, ContainerConfig, TestRunner};
     ///
     /// TestRunner::default().build(
-    ///     BuildConfig::new("heroku/builder:22", "test-fixtures/app"),
+    ///     BuildConfig::new("heroku/builder:22", "tests/fixtures/app"),
     ///     |context| {
     ///         // ...
     ///         context.start_container(
@@ -73,7 +73,7 @@ impl ContainerConfig {
     /// use libcnb_test::{BuildConfig, ContainerConfig, TestRunner};
     ///
     /// TestRunner::default().build(
-    ///     BuildConfig::new("heroku/builder:22", "test-fixtures/app"),
+    ///     BuildConfig::new("heroku/builder:22", "tests/fixtures/app"),
     ///     |context| {
     ///         // ...
     ///         context.start_container(ContainerConfig::new().entrypoint("worker"), |container| {
@@ -96,7 +96,7 @@ impl ContainerConfig {
     /// use libcnb_test::{BuildConfig, ContainerConfig, TestRunner};
     ///
     /// TestRunner::default().build(
-    ///     BuildConfig::new("heroku/builder:22", "test-fixtures/app"),
+    ///     BuildConfig::new("heroku/builder:22", "tests/fixtures/app"),
     ///     |context| {
     ///         // ...
     ///         context.start_container(
@@ -123,7 +123,7 @@ impl ContainerConfig {
     /// use libcnb_test::{BuildConfig, ContainerConfig, TestRunner};
     ///
     /// TestRunner::default().build(
-    ///     BuildConfig::new("heroku/builder:22", "test-fixtures/app"),
+    ///     BuildConfig::new("heroku/builder:22", "tests/fixtures/app"),
     ///     |context| {
     ///         // ...
     ///         context.start_container(
@@ -150,7 +150,7 @@ impl ContainerConfig {
     /// use libcnb_test::{BuildConfig, ContainerConfig, TestRunner};
     ///
     /// TestRunner::default().build(
-    ///     BuildConfig::new("heroku/builder:22", "test-fixtures/app"),
+    ///     BuildConfig::new("heroku/builder:22", "tests/fixtures/app"),
     ///     |context| {
     ///         // ...
     ///         context.start_container(
@@ -176,7 +176,7 @@ impl ContainerConfig {
     /// use libcnb_test::{BuildConfig, ContainerConfig, TestRunner};
     ///
     /// TestRunner::default().build(
-    ///     BuildConfig::new("heroku/builder:22", "test-fixtures/app"),
+    ///     BuildConfig::new("heroku/builder:22", "tests/fixtures/app"),
     ///     |context| {
     ///         // ...
     ///         context.start_container(

libcnb-test/src/container_context.rs

@@ -27,7 +27,7 @@ impl ContainerContext {
     /// use libcnb_test::{assert_contains, assert_empty, BuildConfig, ContainerConfig, TestRunner};
     ///
     /// TestRunner::default().build(
-    ///     BuildConfig::new("heroku/builder:22", "test-fixtures/app"),
+    ///     BuildConfig::new("heroku/builder:22", "tests/fixtures/app"),
     ///     |context| {
     ///         // ...
     ///         context.start_container(ContainerConfig::new(), |container| {
@@ -61,7 +61,7 @@ impl ContainerContext {
     /// use libcnb_test::{assert_contains, assert_empty, BuildConfig, ContainerConfig, TestRunner};
     ///
     /// TestRunner::default().build(
-    ///     BuildConfig::new("heroku/builder:22", "test-fixtures/app"),
+    ///     BuildConfig::new("heroku/builder:22", "tests/fixtures/app"),
     ///     |context| {
     ///         // ...
     ///         context.start_container(ContainerConfig::new(), |container| {
@@ -91,7 +91,7 @@ impl ContainerContext {
     /// use libcnb_test::{BuildConfig, ContainerConfig, TestRunner};
     ///
     /// TestRunner::default().build(
-    ///     BuildConfig::new("heroku/builder:22", "test-fixtures/app"),
+    ///     BuildConfig::new("heroku/builder:22", "tests/fixtures/app"),
     ///     |context| {
     ///         // ...
     ///         context.start_container(
@@ -146,7 +146,7 @@ impl ContainerContext {
     /// use libcnb_test::{assert_contains, BuildConfig, ContainerConfig, TestRunner};
     ///
     /// TestRunner::default().build(
-    ///     BuildConfig::new("heroku/builder:22", "test-fixtures/app"),
+    ///     BuildConfig::new("heroku/builder:22", "tests/fixtures/app"),
     ///     |context| {
     ///         // ...
     ///         context.start_container(ContainerConfig::new(), |container| {

libcnb-test/src/test_context.rs

@@ -32,7 +32,7 @@ impl<'a> TestContext<'a> {
     /// use libcnb_test::{BuildConfig, ContainerConfig, TestRunner};
     ///
     /// TestRunner::default().build(
-    ///     BuildConfig::new("heroku/builder:22", "test-fixtures/app"),
+    ///     BuildConfig::new("heroku/builder:22", "tests/fixtures/app"),
     ///     |context| {
     ///         // Start the container using the default process-type:
     ///         // https://buildpacks.io/docs/app-developer-guide/run-an-app/#default-process-type
@@ -126,7 +126,7 @@ impl<'a> TestContext<'a> {
     /// use libcnb_test::{BuildConfig, ContainerConfig, TestRunner};
     ///
     /// TestRunner::default().build(
-    ///     BuildConfig::new("heroku/builder:22", "test-fixtures/app"),
+    ///     BuildConfig::new("heroku/builder:22", "tests/fixtures/app"),
     ///     |context| {
     ///         // ...
     ///         let command_output =
@@ -141,7 +141,7 @@ impl<'a> TestContext<'a> {
     /// use libcnb_test::{BuildConfig, ContainerConfig, TestRunner};
     ///
     /// TestRunner::default().build(
-    ///     BuildConfig::new("heroku/builder:22", "test-fixtures/app"),
+    ///     BuildConfig::new("heroku/builder:22", "tests/fixtures/app"),
     ///     |context| {
     ///         // ...
     ///         context.start_container(
@@ -203,7 +203,7 @@ impl<'a> TestContext<'a> {
     /// use libcnb_test::{BuildConfig, ContainerConfig, SbomType, TestRunner};
     ///
     /// TestRunner::default().build(
-    ///     BuildConfig::new("heroku/builder:22", "test-fixtures/app"),
+    ///     BuildConfig::new("heroku/builder:22", "tests/fixtures/app"),
     ///     |context| {
     ///         context.download_sbom_files(|sbom_files| {
     ///             assert!(sbom_files
@@ -254,7 +254,7 @@ impl<'a> TestContext<'a> {
     /// use libcnb_test::{assert_contains, BuildConfig, TestRunner};
     ///
     /// TestRunner::default().build(
-    ///     BuildConfig::new("heroku/builder:22", "test-fixtures/app"),
+    ///     BuildConfig::new("heroku/builder:22", "tests/fixtures/app"),
     ///     |context| {
     ///         assert_contains!(context.pack_stdout, "---> Installing dependencies");
     ///

libcnb-test/src/test_runner.rs

@@ -14,7 +14,7 @@ use tempfile::tempdir;
 /// use libcnb_test::{assert_contains, assert_empty, BuildConfig, TestRunner};
 ///
 /// TestRunner::default().build(
-///     BuildConfig::new("heroku/builder:22", "test-fixtures/app"),
+///     BuildConfig::new("heroku/builder:22", "tests/fixtures/app"),
 ///     |context| {
 ///         assert_empty!(context.pack_stderr);
 ///         assert_contains!(context.pack_stdout, "Expected build output");
@@ -40,7 +40,7 @@ impl TestRunner {
     /// use libcnb_test::{assert_contains, assert_empty, BuildConfig, TestRunner};
     ///
     /// TestRunner::default().build(
-    ///     BuildConfig::new("heroku/builder:22", "test-fixtures/app"),
+    ///     BuildConfig::new("heroku/builder:22", "tests/fixtures/app"),
     ///     |context| {
     ///         assert_empty!(context.pack_stderr);
     ///         assert_contains!(context.pack_stdout, "Expected build output");