Make butane/tests a separate crate (#416)

Author: jayvdb

.github/workflows/ci.yml

@@ -126,7 +126,7 @@ jobs:
     - name: Test CLI
       run: cd butane_cli && cargo +stable test --all-features
     - name: Test
-      run: cd butane && cargo +stable test --all-features
+      run: cargo +stable test -p butane_tests --all-features
     - name: Check example migrations have been updated
       run: |
         set -ex

.gitignore

@@ -6,6 +6,7 @@ butanevsc.code-workspace
 butane.code_workspace.code-workspace
 .vscode/tasks.json
 butane_codegen/.butane
+butane/tests/.butane
 db.sqlite
 tmp_pg
 *.db

Cargo.lock

@@ -2,6 +2,7 @@
 resolver = "2"
 members = [
   "butane",
+  "butane/tests",
   "butane_cli",
   "butane_codegen",
   "butane_core",

Cargo.toml

@@ -10,8 +10,10 @@ categories = ["database"]
 license.workspace = true
 repository.workspace = true
 documentation = "https://docs.rs/butane/"
-build = "build.rs"
 rust-version.workspace = true
+exclude = ["tests"]
+autobenches = false
+autotests = false
 
 [features]
 async = ["butane_core/async", "butane_codegen/async"]
@@ -30,9 +32,6 @@ r2d2 = ["dep:r2d2"]
 turso = ["butane_core/turso"]
 tls = ["butane_core/tls"]
 uuid = ["butane_codegen/uuid", "butane_core/uuid"]
-# This feature is for testing only. It will delete the .butane directory inside the butane crate, which only
-# exists when running tests.  It has no effect when running butane as a dependency.
-_auto_delete_dot_butane = []
 
 [dependencies]
 butane_codegen = { workspace = true }
@@ -41,69 +40,6 @@ r2d2 = { optional = true, workspace = true }
 deadpool = { optional = true, workspace = true }
 
 [dev-dependencies]
-butane = { features = ["_auto_delete_dot_butane"], path = "." }
-butane_test_helper = { workspace = true, default-features = false, features = ["pg", "sqlite", "turso"] }
-butane_test_macros = { workspace = true }
-cfg-if = { workspace = true }
-paste = { workspace = true }
-chrono = { workspace = true, features = ["now"] }
-env_logger = { workspace = true }
-fake = { workspace = true, features = ["chrono", "derive", "uuid"] }
-geo-types = "0.7"
-log.workspace = true
-nonempty.workspace = true
-quote = { workspace = true }
-maybe-async-cfg.workspace = true
-proc-macro2 = { workspace = true }
-tokio = { workspace = true, features = ["macros"] }
-tokio-postgres = { features = ["with-geo-types-0_7"], workspace = true }
-tokio-test = { workspace = true }
-rand = { workspace = true }
-rusqlite = { workspace = true }
-serde = { workspace = true }
-serde_json = { workspace = true }
-sqlparser = { workspace = true }
-uuid_for_test = { package = "uuid", version = "1.2", features = ["v4"] }
 
 [package.metadata.docs.rs]
 all-features = true
-
-[[test]]
-name = "basic"
-required-features = ["async"]
-
-[[test]]
-name = "custom_enum_derived"
-required-features = ["async"]
-
-[[test]]
-name = "custom_type"
-required-features = ["async"]
-
-[[test]]
-name = "fake"
-required-features = ["fake"]
-
-[[test]]
-name = "json"
-required-features = ["async", "json"]
-
-[[test]]
-name = "many"
-required-features = ["async"]
-
-[[test]]
-name = "nullable"
-required-features = ["async"]
-
-[[test]]
-name = "pool"
-required-features = ["r2d2", "deadpool"]
-
-[[test]]
-name = "query"
-required-features = ["async"]
-
-[[test]]
-name = "uuid"
-required-features = ["async", "uuid"]

butane/Cargo.toml

@@ -0,0 +1,115 @@
+[package]
+name = "butane_tests"
+version.workspace = true
+authors = ["James Oakley <[email protected]>"]
+edition.workspace = true
+description = "Integration tests for butane ORM"
+license.workspace = true
+repository.workspace = true
+publish = false
+rust-version.workspace = true
+build = "build.rs"
+
+[features]
+async = ["butane/async"]
+datetime = ["butane/datetime"]
+json = ["butane/json"]
+sqlite = ["butane/sqlite"]
+sqlite-bundled = ["butane/sqlite-bundled"]
+pg = ["butane/pg"]
+fake = ["butane/fake"]
+uuid = ["butane/uuid"]
+r2d2 = ["butane/r2d2"]
+deadpool = ["butane/deadpool"]
+turso = ["butane/turso"]
+
+[lib]
+path = "common/mod.rs"
+
+[dependencies]
+butane = { workspace = true }
+butane_core = { workspace = true }
+butane_test_helper = { workspace = true, default-features = false, features = ["pg", "sqlite", "turso"] }
+butane_test_macros = { workspace = true }
+cfg-if = { workspace = true }
+paste = { workspace = true }
+chrono = { workspace = true, features = ["now"] }
+deadpool = { workspace = true }
+env_logger = { workspace = true }
+fake = { workspace = true, features = ["chrono", "derive", "uuid"] }
+geo-types = "0.7"
+log.workspace = true
+nonempty.workspace = true
+quote = { workspace = true }
+maybe-async-cfg.workspace = true
+proc-macro2 = { workspace = true }
+r2d2 = { workspace = true }
+rand = { workspace = true }
+rusqlite = { workspace = true }
+serde = { workspace = true }
+serde_json = { workspace = true }
+sqlparser = { workspace = true }
+tokio = { workspace = true, features = ["macros"] }
+tokio-postgres = { features = ["with-geo-types-0_7"], workspace = true }
+tokio-test = { workspace = true }
+uuid_for_test = { package = "uuid", version = "1.2", features = ["v4"] }
+
+[[test]]
+name = "basic"
+path = "basic.rs"
+required-features = ["async"]
+
+[[test]]
+name = "custom_enum_derived"
+path = "custom_enum_derived.rs"
+required-features = ["async"]
+
+[[test]]
+name = "custom_type"
+path = "custom_type.rs"
+required-features = ["async"]
+
+[[test]]
+name = "derive_model"
+path = "derive_model.rs"
+required-features = ["async"]
+
+[[test]]
+name = "fake"
+path = "fake.rs"
+required-features = ["fake"]
+
+[[test]]
+name = "json"
+path = "json.rs"
+required-features = ["async", "json"]
+
+[[test]]
+name = "many"
+path = "many.rs"
+required-features = ["async"]
+
+[[test]]
+name = "nullable"
+path = "nullable.rs"
+required-features = ["async"]
+
+[[test]]
+name = "pool"
+path = "pool.rs"
+required-features = ["r2d2", "deadpool"]
+
+[[test]]
+name = "query"
+path = "query.rs"
+required-features = ["async"]
+
+[[test]]
+name = "unmigrate"
+path = "unmigrate.rs"
+required-features = ["async"]
+
+[[test]]
+name = "uuid"
+path = "uuid.rs"
+required-features = ["async", "uuid"]

butane/tests/Cargo.toml

@@ -1,22 +1,12 @@
-fn main() {
-    println!("cargo:rerun-if-changed=tests/");
-
-    // Note that #[cfg(test)] and CARGO_CFG_TEST do not work in build.rs
-    // See https://github.com/rust-lang/cargo/issues/4789
-    #[cfg(feature = "_auto_delete_dot_butane")]
-    {
-        clean_dot_butane();
-    }
-}
-
 /// This cleans the .butane/ directory which is generated when compiling the tests so that
 /// the tests do not encounter side effects from previous test runs.
 /// Currently the only way to remove stale items from the generated .butane/ directory is to
 /// delete it before the code is compiled.
 /// This means we can not rely on `butane clean` or the code behind it, because it hasnt
 /// been compiled yet.
-#[cfg(feature = "_auto_delete_dot_butane")]
-fn clean_dot_butane() {
+fn main() {
+    println!("cargo:rerun-if-changed=./");
+
     let dir = ".butane/";
     if std::path::Path::new(&dir).is_dir() {
         println!("cargo:warning=Deleting .butane directory");

butane/build.rs renamed to butane/tests/build.rs

@@ -1,4 +1,4 @@
-//! Test that #[derive(DataObject)] works the same as #[model]
+//! Test that `#[derive(DataObject)]` works the same as #[model].
 
 use butane::db::ConnectionAsync;
 use butane::{query, AutoPk, DataObject};

butane/tests/derive_model.rs

@@ -2,7 +2,6 @@
 use butane::db::ConnectionManager;
 use butane_test_helper::*;
 #[cfg(any(feature = "pg", feature = "sqlite"))]
-#[cfg(any(feature = "pg", feature = "sqlite"))]
 use r2d2;
 use std::ops::DerefMut;