use barrel::backend::Pg as Sql;
#[cfg(feature = "postgres")]
mod postgres {
use assert_cmd::prelude::*;
use predicates::str::contains;
use refinery::config::ConfigDbType;
use refinery::{
config::Config, embed_migrations, error::Kind, Migrate, Migration, Runner, Target,
};
use refinery_core::postgres::{Client, NoTls};
use std::process::Command;
use std::str::FromStr;
use time::OffsetDateTime;
const DEFAULT_TABLE_NAME: &str = "refinery_schema_history";
mod embedded {
use refinery::embed_migrations;
embed_migrations!("./tests/migrations");
}
mod broken {
use refinery::embed_migrations;
embed_migrations!("./tests/migrations_broken");
}
mod missing {
use refinery::embed_migrations;
embed_migrations!("./tests/migrations_missing");
}
#[cfg(feature = "int8-versions")]
mod int8 {
use refinery::embed_migrations;
embed_migrations!("./tests/migrations_int8");
}
fn db_uri() -> String {
std::env::var("DB_URI").unwrap_or("postgres://postgres@localhost:5432/postgres".to_string())
}
fn get_migrations() -> Vec<Migration> {
embed_migrations!("./tests/migrations");
let migration1 =
Migration::unapplied("V1__initial.rs", &migrations::V1__initial::migration()).unwrap();
let migration2 = Migration::unapplied(
"V2__add_cars_and_motos_table.sql",
include_str!("./migrations/V1-2/V2__add_cars_and_motos_table.sql"),
)
.unwrap();
let migration3 = Migration::unapplied(
"V3__add_brand_to_cars_table",
include_str!("./migrations/V3/V3__add_brand_to_cars_table.sql"),
)
.unwrap();
let migration4 = Migration::unapplied(
"V4__add_year_to_motos_table.rs",
&migrations::V4__add_year_to_motos_table::migration(),
)
.unwrap();
let migration5 = Migration::unapplied(
"V5__add_year_field_to_cars",
"ALTER TABLE cars ADD year INTEGER;",
)
.unwrap();
vec![migration1, migration2, migration3, migration4, migration5]
}
fn prep_database() {
let mut client = Client::connect(&db_uri(), NoTls).unwrap();
client
.execute("DROP SCHEMA IF EXISTS public CASCADE", &[])
.unwrap();
client
.execute("CREATE SCHEMA IF NOT EXISTS public", &[])
.unwrap();
}
fn run_test<T>(test: T)
where
T: FnOnce(),
{
prep_database();
test();
}
#[test]
fn report_contains_applied_migrations() {
run_test(|| {
let mut client = Client::connect(&db_uri(), NoTls).unwrap();
let report = embedded::migrations::runner().run(&mut client).unwrap();
let migrations = get_migrations();
let applied_migrations = report.applied_migrations();
assert_eq!(4, applied_migrations.len());
assert_eq!(migrations[0].version(), applied_migrations[0].version());
assert_eq!(migrations[1].version(), applied_migrations[1].version());
assert_eq!(migrations[2].version(), applied_migrations[2].version());
assert_eq!(migrations[3].version(), applied_migrations[3].version());
assert_eq!(migrations[0].name(), migrations[0].name());
assert_eq!(migrations[1].name(), applied_migrations[1].name());
assert_eq!(migrations[2].name(), applied_migrations[2].name());
assert_eq!(migrations[3].name(), applied_migrations[3].name());
assert_eq!(migrations[0].checksum(), applied_migrations[0].checksum());
assert_eq!(migrations[1].checksum(), applied_migrations[1].checksum());
assert_eq!(migrations[2].checksum(), applied_migrations[2].checksum());
assert_eq!(migrations[3].checksum(), applied_migrations[3].checksum());
});
}
#[test]
fn creates_migration_table() {
run_test(|| {
let mut client = Client::connect(&db_uri(), NoTls).unwrap();
embedded::migrations::runner().run(&mut client).unwrap();
for row in &client
.query(
&format!(
"SELECT table_name FROM information_schema.tables WHERE table_name='{DEFAULT_TABLE_NAME}'",
),
&[],
)
.unwrap()
{
let table_name: String = row.get(0);
assert_eq!(DEFAULT_TABLE_NAME, table_name);
}
});
}
#[test]
fn creates_migration_table_grouped_transaction() {
run_test(|| {
let mut client = Client::connect(&db_uri(), NoTls).unwrap();
embedded::migrations::runner()
.set_grouped(true)
.run(&mut client)
.unwrap();
for row in &client
.query(
&format!(
"SELECT table_name FROM information_schema.tables WHERE table_name='{DEFAULT_TABLE_NAME}'",
),
&[],
)
.unwrap()
{
let table_name: String = row.get(0);
assert_eq!(DEFAULT_TABLE_NAME, table_name);
}
});
}
#[test]
fn applies_migration() {
run_test(|| {
let mut client = Client::connect(&db_uri(), NoTls).unwrap();
embedded::migrations::runner().run(&mut client).unwrap();
client
.execute(
"INSERT INTO persons (name, city) VALUES ($1, $2)",
&[&"John Legend", &"New York"],
)
.unwrap();
for row in &client.query("SELECT name, city FROM persons", &[]).unwrap() {
let name: String = row.get(0);
let city: String = row.get(1);
assert_eq!("John Legend", name);
assert_eq!("New York", city);
}
});
}
#[test]
#[cfg(feature = "int8-versions")]
fn applies_migration_int8() {
run_test(|| {
let mut client = Client::connect(&db_uri(), NoTls).unwrap();
let report = int8::migrations::runner().run(&mut client).unwrap();
let applied_migrations = report.applied_migrations();
assert_eq!(4, applied_migrations.len());
assert_eq!(20240504090241, applied_migrations[0].version());
assert_eq!(20240504090301, applied_migrations[1].version());
assert_eq!(20240504090322, applied_migrations[2].version());
assert_eq!(20240504090343, applied_migrations[3].version());
client
.execute(
"INSERT INTO persons (name, city) VALUES ($1, $2)",
&[&"John Legend", &"New York"],
)
.unwrap();
for row in &client.query("SELECT name, city FROM persons", &[]).unwrap() {
let name: String = row.get(0);
let city: String = row.get(1);
assert_eq!("John Legend", name);
assert_eq!("New York", city);
}
});
}
#[test]
fn applies_migration_grouped_transaction() {
run_test(|| {
let mut client = Client::connect(&db_uri(), NoTls).unwrap();
embedded::migrations::runner()
.set_grouped(false)
.run(&mut client)
.unwrap();
client
.execute(
"INSERT INTO persons (name, city) VALUES ($1, $2)",
&[&"John Legend", &"New York"],
)
.unwrap();
for row in &client.query("SELECT name, city FROM persons", &[]).unwrap() {
let name: String = row.get(0);
let city: String = row.get(1);
assert_eq!("John Legend", name);
assert_eq!("New York", city);
}
});
}
#[test]
fn updates_schema_history() {
run_test(|| {
let mut client = Client::connect(&db_uri(), NoTls).unwrap();
embedded::migrations::runner().run(&mut client).unwrap();
let current = client
.get_last_applied_migration(DEFAULT_TABLE_NAME)
.unwrap()
.unwrap();
assert_eq!(4, current.version());
assert_eq!(
OffsetDateTime::now_utc().date(),
current.applied_on().unwrap().date()
);
});
}
#[test]
fn updates_schema_history_grouped_transaction() {
run_test(|| {
let mut client = Client::connect(&db_uri(), NoTls).unwrap();
embedded::migrations::runner()
.set_grouped(false)
.run(&mut client)
.unwrap();
let current = client
.get_last_applied_migration(DEFAULT_TABLE_NAME)
.unwrap()
.unwrap();
assert_eq!(4, current.version());
assert_eq!(
OffsetDateTime::now_utc().date(),
current.applied_on().unwrap().date()
);
});
}
#[test]
fn updates_to_last_working_if_not_grouped() {
run_test(|| {
let mut client = Client::connect(&db_uri(), NoTls).unwrap();
let result = broken::migrations::runner().run(&mut client);
assert!(result.is_err());
println!("CURRENT: {result:?}");
let current = client
.get_last_applied_migration(DEFAULT_TABLE_NAME)
.unwrap()
.unwrap();
let err = result.unwrap_err();
let migrations = get_migrations();
let applied_migrations = err.report().unwrap().applied_migrations();
assert_eq!(
OffsetDateTime::now_utc().date(),
current.applied_on().unwrap().date()
);
assert_eq!(2, current.version());
assert_eq!(2, applied_migrations.len());
assert_eq!(1, applied_migrations[0].version());
assert_eq!(2, applied_migrations[1].version());
assert_eq!("initial", migrations[0].name());
assert_eq!("add_cars_table", applied_migrations[1].name());
#[cfg(not(feature = "int8-versions"))]
assert_eq!(2959965718684201605, applied_migrations[0].checksum());
#[cfg(feature = "int8-versions")]
assert_eq!(13938959368620441626, applied_migrations[0].checksum());
#[cfg(not(feature = "int8-versions"))]
assert_eq!(8238603820526370208, applied_migrations[1].checksum());
#[cfg(feature = "int8-versions")]
assert_eq!(5394706226941044339, applied_migrations[1].checksum());
});
}
#[test]
fn doesnt_update_to_last_working_if_grouped() {
run_test(|| {
let mut client = Client::connect(&db_uri(), NoTls).unwrap();
let result = broken::migrations::runner()
.set_grouped(true)
.run(&mut client);
assert!(result.is_err());
println!("CURRENT: {result:?}");
let query = &client
.query("SELECT version FROM refinery_schema_history", &[])
.unwrap();
assert!(query.is_empty());
});
}
#[test]
fn gets_applied_migrations() {
run_test(|| {
let mut client = Client::connect(&db_uri(), NoTls).unwrap();
embedded::migrations::runner().run(&mut client).unwrap();
let migrations = get_migrations();
let applied_migrations = client.get_applied_migrations(DEFAULT_TABLE_NAME).unwrap();
assert_eq!(4, applied_migrations.len());
assert_eq!(migrations[0].version(), applied_migrations[0].version());
assert_eq!(migrations[1].version(), applied_migrations[1].version());
assert_eq!(migrations[2].version(), applied_migrations[2].version());
assert_eq!(migrations[3].version(), applied_migrations[3].version());
assert_eq!(migrations[0].name(), migrations[0].name());
assert_eq!(migrations[1].name(), applied_migrations[1].name());
assert_eq!(migrations[2].name(), applied_migrations[2].name());
assert_eq!(migrations[3].name(), applied_migrations[3].name());
assert_eq!(migrations[0].checksum(), applied_migrations[0].checksum());
assert_eq!(migrations[1].checksum(), applied_migrations[1].checksum());
assert_eq!(migrations[2].checksum(), applied_migrations[2].checksum());
assert_eq!(migrations[3].checksum(), applied_migrations[3].checksum());
});
}
#[test]
fn applies_new_migration() {
run_test(|| {
let mut client = Client::connect(&db_uri(), NoTls).unwrap();
embedded::migrations::runner().run(&mut client).unwrap();
let migrations = get_migrations();
let mchecksum = migrations[4].checksum();
client
.migrate(
&migrations,
true,
true,
false,
Target::Latest,
DEFAULT_TABLE_NAME,
)
.unwrap();
let current = client
.get_last_applied_migration(DEFAULT_TABLE_NAME)
.unwrap()
.unwrap();
assert_eq!(5, current.version());
assert_eq!(mchecksum, current.checksum());
});
}
#[test]
fn migrates_to_target_migration() {
run_test(|| {
let mut client = Client::connect(&db_uri(), NoTls).unwrap();
let report = embedded::migrations::runner()
.set_target(Target::Version(3))
.run(&mut client)
.unwrap();
let current = client
.get_last_applied_migration(DEFAULT_TABLE_NAME)
.unwrap()
.unwrap();
assert_eq!(3, current.version());
let migrations = get_migrations();
let applied_migrations = report.applied_migrations();
assert_eq!(3, applied_migrations.len());
assert_eq!(migrations[0].version(), applied_migrations[0].version());
assert_eq!(migrations[1].version(), applied_migrations[1].version());
assert_eq!(migrations[2].version(), applied_migrations[2].version());
assert_eq!(migrations[0].name(), migrations[0].name());
assert_eq!(migrations[1].name(), applied_migrations[1].name());
assert_eq!(migrations[2].name(), applied_migrations[2].name());
assert_eq!(migrations[0].checksum(), applied_migrations[0].checksum());
assert_eq!(migrations[1].checksum(), applied_migrations[1].checksum());
assert_eq!(migrations[2].checksum(), applied_migrations[2].checksum());
});
}
#[test]
fn migrates_to_target_migration_grouped() {
run_test(|| {
let mut client = Client::connect(&db_uri(), NoTls).unwrap();
let report = embedded::migrations::runner()
.set_target(Target::Version(3))
.set_grouped(true)
.run(&mut client)
.unwrap();
let current = client
.get_last_applied_migration(DEFAULT_TABLE_NAME)
.unwrap()
.unwrap();
assert_eq!(3, current.version());
let migrations = get_migrations();
let applied_migrations = report.applied_migrations();
assert_eq!(3, applied_migrations.len());
assert_eq!(migrations[0].version(), applied_migrations[0].version());
assert_eq!(migrations[1].version(), applied_migrations[1].version());
assert_eq!(migrations[2].version(), applied_migrations[2].version());
assert_eq!(migrations[0].name(), migrations[0].name());
assert_eq!(migrations[1].name(), applied_migrations[1].name());
assert_eq!(migrations[2].name(), applied_migrations[2].name());
assert_eq!(migrations[0].checksum(), applied_migrations[0].checksum());
assert_eq!(migrations[1].checksum(), applied_migrations[1].checksum());
assert_eq!(migrations[2].checksum(), applied_migrations[2].checksum());
});
}
#[test]
fn aborts_on_missing_migration_on_filesystem() {
run_test(|| {
let mut client = Client::connect(&db_uri(), NoTls).unwrap();
embedded::migrations::runner().run(&mut client).unwrap();
let migration = Migration::unapplied(
"V4__add_year_field_to_cars",
"ALTER TABLE cars ADD year INTEGER;",
)
.unwrap();
let err = client
.migrate(
&[migration],
true,
true,
false,
Target::Latest,
DEFAULT_TABLE_NAME,
)
.unwrap_err();
match err.kind() {
Kind::MissingVersion(missing) => {
assert_eq!(1, missing.version());
assert_eq!("initial", missing.name());
}
_ => panic!("failed test"),
}
});
}
#[test]
fn aborts_on_divergent_migration() {
run_test(|| {
let mut client = Client::connect(&db_uri(), NoTls).unwrap();
embedded::migrations::runner().run(&mut client).unwrap();
let migration = Migration::unapplied(
"V2__add_year_field_to_cars",
"ALTER TABLE cars ADD year INTEGER;",
)
.unwrap();
let err = client
.migrate(
&[migration.clone()],
true,
false,
false,
Target::Latest,
DEFAULT_TABLE_NAME,
)
.unwrap_err();
match err.kind() {
Kind::DivergentVersion(applied, divergent) => {
assert_eq!(&migration, divergent);
assert_eq!(2, applied.version());
assert_eq!("add_cars_and_motos_table", applied.name());
}
_ => panic!("failed test"),
}
});
}
#[test]
fn aborts_on_missing_migration_on_database() {
run_test(|| {
let mut client = Client::connect(&db_uri(), NoTls).unwrap();
missing::migrations::runner().run(&mut client).unwrap();
let migration1 = Migration::unapplied(
"V1__initial",
concat!(
"CREATE TABLE persons (",
"id int,",
"name varchar(255),",
"city varchar(255)",
");"
),
)
.unwrap();
let migration2 = Migration::unapplied(
"V2__add_cars_table",
include_str!("./migrations_missing/V2__add_cars_table.sql"),
)
.unwrap();
let err = client
.migrate(
&[migration1, migration2],
true,
true,
false,
Target::Latest,
DEFAULT_TABLE_NAME,
)
.unwrap_err();
match err.kind() {
Kind::MissingVersion(missing) => {
assert_eq!(1, missing.version());
assert_eq!("initial", missing.name());
}
_ => panic!("failed test"),
}
});
}
#[test]
fn migrates_from_config() {
run_test(|| {
let mut config = Config::from_str(&db_uri()).unwrap();
let migrations = get_migrations();
let runner = Runner::new(&migrations)
.set_grouped(false)
.set_abort_divergent(true)
.set_abort_missing(true);
runner.run(&mut config).unwrap();
let applied_migrations = runner.get_applied_migrations(&mut config).unwrap();
assert_eq!(5, applied_migrations.len());
assert_eq!(migrations[0].version(), applied_migrations[0].version());
assert_eq!(migrations[1].version(), applied_migrations[1].version());
assert_eq!(migrations[2].version(), applied_migrations[2].version());
assert_eq!(migrations[3].version(), applied_migrations[3].version());
assert_eq!(migrations[4].version(), applied_migrations[4].version());
assert_eq!(migrations[0].name(), migrations[0].name());
assert_eq!(migrations[1].name(), applied_migrations[1].name());
assert_eq!(migrations[2].name(), applied_migrations[2].name());
assert_eq!(migrations[3].name(), applied_migrations[3].name());
assert_eq!(migrations[4].name(), applied_migrations[4].name());
assert_eq!(migrations[0].checksum(), applied_migrations[0].checksum());
assert_eq!(migrations[1].checksum(), applied_migrations[1].checksum());
assert_eq!(migrations[2].checksum(), applied_migrations[2].checksum());
assert_eq!(migrations[3].checksum(), applied_migrations[3].checksum());
assert_eq!(migrations[4].checksum(), applied_migrations[4].checksum());
})
}
#[test]
fn migrate_from_config_report_contains_migrations() {
run_test(|| {
let mut config = Config::from_str(&db_uri()).unwrap();
let migrations = get_migrations();
let runner = Runner::new(&migrations)
.set_grouped(false)
.set_abort_divergent(true)
.set_abort_missing(true);
let report = runner.run(&mut config).unwrap();
let applied_migrations = report.applied_migrations();
assert_eq!(5, applied_migrations.len());
assert_eq!(migrations[0].version(), applied_migrations[0].version());
assert_eq!(migrations[1].version(), applied_migrations[1].version());
assert_eq!(migrations[2].version(), applied_migrations[2].version());
assert_eq!(migrations[3].version(), applied_migrations[3].version());
assert_eq!(migrations[4].version(), applied_migrations[4].version());
assert_eq!(migrations[0].name(), migrations[0].name());
assert_eq!(migrations[1].name(), applied_migrations[1].name());
assert_eq!(migrations[2].name(), applied_migrations[2].name());
assert_eq!(migrations[3].name(), applied_migrations[3].name());
assert_eq!(migrations[4].name(), applied_migrations[4].name());
assert_eq!(migrations[0].checksum(), applied_migrations[0].checksum());
assert_eq!(migrations[1].checksum(), applied_migrations[1].checksum());
assert_eq!(migrations[2].checksum(), applied_migrations[2].checksum());
assert_eq!(migrations[3].checksum(), applied_migrations[3].checksum());
assert_eq!(migrations[4].checksum(), applied_migrations[4].checksum());
})
}
#[test]
fn migrate_from_config_report_returns_last_applied_migration() {
run_test(|| {
let mut config = Config::from_str(&db_uri()).unwrap();
let migrations = get_migrations();
let runner = Runner::new(&migrations)
.set_grouped(false)
.set_abort_divergent(true)
.set_abort_missing(true);
runner.run(&mut config).unwrap();
let applied_migration = runner
.get_last_applied_migration(&mut config)
.unwrap()
.unwrap();
assert_eq!(5, applied_migration.version());
assert_eq!(migrations[4].version(), applied_migration.version());
assert_eq!(migrations[4].name(), applied_migration.name());
assert_eq!(migrations[4].checksum(), applied_migration.checksum());
})
}
#[test]
fn doesnt_run_migrations_if_fake() {
run_test(|| {
let mut client = Client::connect(&db_uri(), NoTls).unwrap();
let report = embedded::migrations::runner()
.set_target(Target::Fake)
.run(&mut client)
.unwrap();
let applied_migrations = report.applied_migrations();
assert!(applied_migrations.is_empty());
let current = client
.get_last_applied_migration(DEFAULT_TABLE_NAME)
.unwrap()
.unwrap();
let migrations = get_migrations();
let mchecksum = migrations[3].checksum();
assert_eq!(4, current.version());
assert_eq!(mchecksum, current.checksum());
let row = &client
.query(
"SELECT table_name FROM information_schema.tables WHERE table_name='persons'",
&[],
)
.unwrap();
assert!(row.is_empty());
});
}
#[test]
fn doesnt_run_migrations_if_fake_version() {
run_test(|| {
let mut client = Client::connect(&db_uri(), NoTls).unwrap();
let report = embedded::migrations::runner()
.set_target(Target::FakeVersion(2))
.run(&mut client)
.unwrap();
let applied_migrations = report.applied_migrations();
assert!(applied_migrations.is_empty());
let current = client
.get_last_applied_migration(DEFAULT_TABLE_NAME)
.unwrap()
.unwrap();
let migrations = get_migrations();
let mchecksum = migrations[1].checksum();
assert_eq!(2, current.version());
assert_eq!(mchecksum, current.checksum());
let row = &client
.query(
"SELECT table_name FROM information_schema.tables WHERE table_name='persons'",
&[],
)
.unwrap();
assert!(row.is_empty());
});
}
#[test]
fn migrates_from_cli() {
run_test(|| {
Command::new("refinery")
.args([
"migrate",
"-c",
"tests/postgres_refinery.toml",
"-p",
"tests/migrations",
])
.unwrap()
.assert()
.stdout(contains("applying migration: V2__add_cars_and_motos_table"))
.stdout(contains("applying migration: V3__add_brand_to_cars_table"));
})
}
#[test]
fn migrates_with_tls_enabled() {
run_test(|| {
let mut config = Config::new(ConfigDbType::Postgres)
.set_db_name("postgres")
.set_db_user("postgres")
.set_db_host("localhost")
.set_db_port("5432")
.set_use_tls(true);
let migrations = get_migrations();
let runner = Runner::new(&migrations)
.set_grouped(false)
.set_abort_divergent(true)
.set_abort_missing(true);
let report = runner.run(&mut config).unwrap();
let applied_migrations = report.applied_migrations();
assert_eq!(5, applied_migrations.len());
let last_migration = runner
.get_last_applied_migration(&mut config)
.unwrap()
.unwrap();
assert_eq!(5, last_migration.version());
assert_eq!(migrations[4].name(), last_migration.name());
assert_eq!(migrations[4].checksum(), last_migration.checksum());
assert!(config.use_tls());
});
}
}