Skip to content

Commit

Permalink
feat: implement with_init_sql for Postgres, Mysql and Mariadb (…
Browse files Browse the repository at this point in the history 
…#182)

Resolves #164

~The implementation is a bit hacky, am open to better approaches or
other feedback ^^~

The implementation is pretty straigtforeward and similar to
#217
  • Loading branch information
@CommanderStorm
CommanderStorm authored Sep 26, 2024
1 parent 149062c commit 674a926
Show file tree
Hide file tree
Showing 3 changed files with 186 additions and 13 deletions.
65 changes: 60 additions & 5 deletions src/mariadb/mod.rs
View file
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
use std::borrow::Cow;

use testcontainers::{core::WaitFor, Image};
use testcontainers::{core::WaitFor, CopyDataSource, CopyToContainer, Image};

const NAME: &str = "mariadb";
const TAG: &str = "11.3";
Expand All @@ -27,10 +27,38 @@ const TAG: &str = "11.3";
/// [`MariaDB docker image`]: https://hub.docker.com/_/mariadb
#[derive(Debug, Default, Clone)]
pub struct Mariadb {
/// (remove if there is another variable)
/// Field is included to prevent this struct to be a unit struct.
/// This allows extending functionality (and thus further variables) without breaking changes
_priv: (),
copy_to_sources: Vec<CopyToContainer>,
}

impl Mariadb {
/// Registers sql to be executed automatically when the container starts.
/// Can be called multiple times to add (not override) scripts.
///
/// # Example
///
/// ```
/// # use testcontainers_modules::mariadb::Mariadb;
/// let mariadb_image = Mariadb::default().with_init_sql(
/// "CREATE TABLE foo (bar varchar(255));"
/// .to_string()
/// .into_bytes(),
/// );
/// ```
///
/// ```rust,ignore
/// # use testcontainers_modules::mariadb::Mariadb;
/// let mariadb_image = Mariadb::default()
/// .with_init_sql(include_str!("path_to_init.sql").to_string().into_bytes());
/// ```
pub fn with_init_sql(mut self, init_sql: impl Into<CopyDataSource>) -> Self {
let target = format!(
"/docker-entrypoint-initdb.d/init_{i}.sql",
i = self.copy_to_sources.len()
);
self.copy_to_sources
.push(CopyToContainer::new(init_sql.into(), target));
self
}
}

impl Image for Mariadb {
Expand All @@ -57,6 +85,9 @@ impl Image for Mariadb {
("MARIADB_ALLOW_EMPTY_ROOT_PASSWORD", "1"),
]
}
fn copy_to_sources(&self) -> impl IntoIterator<Item = &CopyToContainer> {
&self.copy_to_sources
}
}

#[cfg(test)]
Expand All @@ -69,6 +100,30 @@ mod tests {
testcontainers::{runners::SyncRunner, ImageExt},
};

#[test]
fn mariadb_with_init_sql() -> Result<(), Box<dyn std::error::Error + 'static>> {
let node = MariadbImage::default()
.with_init_sql(
"CREATE TABLE foo (bar varchar(255));"
.to_string()
.into_bytes(),
)
.start()?;

let connection_string = &format!(
"mysql://root@{}:{}/test",
node.get_host()?,
node.get_host_port_ipv4(3306.tcp())?
);
let mut conn = mysql::Conn::new(mysql::Opts::from_url(connection_string).unwrap()).unwrap();

let rows: Vec<String> = conn.query("INSERT INTO foo(bar) VALUES ('blub')").unwrap();
assert_eq!(rows.len(), 0);

let rows: Vec<String> = conn.query("SELECT bar FROM foo").unwrap();
assert_eq!(rows.len(), 1);
Ok(())
}
#[test]
fn mariadb_one_plus_one() -> Result<(), Box<dyn std::error::Error + 'static>> {
let mariadb_image = MariadbImage::default();
Expand Down
66 changes: 61 additions & 5 deletions src/mysql/mod.rs
View file
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
use std::borrow::Cow;

use testcontainers::{core::WaitFor, Image};
use testcontainers::{core::WaitFor, CopyDataSource, CopyToContainer, Image};

const NAME: &str = "mysql";
const TAG: &str = "8.1";
Expand All @@ -27,10 +27,37 @@ const TAG: &str = "8.1";
/// [`MySQL docker image`]: https://hub.docker.com/_/mysql
#[derive(Debug, Default, Clone)]
pub struct Mysql {
/// (remove if there is another variable)
/// Field is included to prevent this struct to be a unit struct.
/// This allows extending functionality (and thus further variables) without breaking changes
_priv: (),
copy_to_sources: Vec<CopyToContainer>,
}
impl Mysql {
/// Registers sql to be executed automatically when the container starts.
/// Can be called multiple times to add (not override) scripts.
///
/// # Example
///
/// ```
/// # use testcontainers_modules::mysql::Mysql;
/// let mysql_image = Mysql::default().with_init_sql(
/// "CREATE TABLE foo (bar varchar(255));"
/// .to_string()
/// .into_bytes(),
/// );
/// ```
///
/// ```rust,ignore
/// # use testcontainers_modules::mysql::Mysql;
/// let mysql_image = Mysql::default()
/// .with_init_sql(include_str!("path_to_init.sql").to_string().into_bytes());
/// ```
pub fn with_init_sql(mut self, init_sql: impl Into<CopyDataSource>) -> Self {
let target = format!(
"/docker-entrypoint-initdb.d/init_{i}.sql",
i = self.copy_to_sources.len()
);
self.copy_to_sources
.push(CopyToContainer::new(init_sql.into(), target));
self
}
}

impl Image for Mysql {
Expand All @@ -57,17 +84,46 @@ impl Image for Mysql {
("MYSQL_ALLOW_EMPTY_PASSWORD", "yes"),
]
}
fn copy_to_sources(&self) -> impl IntoIterator<Item = &CopyToContainer> {
&self.copy_to_sources
}
}

#[cfg(test)]
mod tests {
use mysql::prelude::Queryable;
use testcontainers::core::IntoContainerPort;

use crate::{
mysql::Mysql as MysqlImage,
testcontainers::{runners::SyncRunner, ImageExt},
};

#[test]
fn mysql_with_init_sql() -> Result<(), Box<dyn std::error::Error + 'static>> {
let node = crate::mysql::Mysql::default()
.with_init_sql(
"CREATE TABLE foo (bar varchar(255));"
.to_string()
.into_bytes(),
)
.start()?;

let connection_string = &format!(
"mysql://root@{}:{}/test",
node.get_host()?,
node.get_host_port_ipv4(3306.tcp())?
);
let mut conn = mysql::Conn::new(mysql::Opts::from_url(connection_string).unwrap()).unwrap();

let rows: Vec<String> = conn.query("INSERT INTO foo(bar) VALUES ('blub')").unwrap();
assert_eq!(rows.len(), 0);

let rows: Vec<String> = conn.query("SELECT bar FROM foo").unwrap();
assert_eq!(rows.len(), 1);
Ok(())
}

#[test]
fn mysql_one_plus_one() -> Result<(), Box<dyn std::error::Error + 'static>> {
let mysql_image = MysqlImage::default();
Expand Down
68 changes: 65 additions & 3 deletions src/postgres/mod.rs
View file
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
use std::{borrow::Cow, collections::HashMap};

use testcontainers::{core::WaitFor, Image};
use testcontainers::{core::WaitFor, CopyDataSource, CopyToContainer, Image};

const NAME: &str = "postgres";
const TAG: &str = "11-alpine";
Expand Down Expand Up @@ -30,6 +30,7 @@ const TAG: &str = "11-alpine";
#[derive(Debug, Clone)]
pub struct Postgres {
env_vars: HashMap<String, String>,
copy_to_sources: Vec<CopyToContainer>,
}

impl Postgres {
Expand Down Expand Up @@ -61,16 +62,47 @@ impl Postgres {
.insert("POSTGRES_PASSWORD".to_owned(), password.to_owned());
self
}
}

/// Registers sql to be executed automatically when the container starts.
/// Can be called multiple times to add (not override) scripts.
///
/// # Example
///
/// ```
/// # use testcontainers_modules::postgres::Postgres;
/// let postgres_image = Postgres::default().with_init_sql(
/// "CREATE EXTENSION IF NOT EXISTS hstore;"
/// .to_string()
/// .into_bytes(),
/// );
/// ```
///
/// ```rust,ignore
/// # use testcontainers_modules::postgres::Postgres;
/// let postgres_image = Postgres::default()
/// .with_init_sql(include_str!("path_to_init.sql").to_string().into_bytes());
/// ```
pub fn with_init_sql(mut self, init_sql: impl Into<CopyDataSource>) -> Self {
let target = format!(
"/docker-entrypoint-initdb.d/init_{i}.sql",
i = self.copy_to_sources.len()
);
self.copy_to_sources
.push(CopyToContainer::new(init_sql.into(), target));
self
}
}
impl Default for Postgres {
fn default() -> Self {
let mut env_vars = HashMap::new();
env_vars.insert("POSTGRES_DB".to_owned(), "postgres".to_owned());
env_vars.insert("POSTGRES_USER".to_owned(), "postgres".to_owned());
env_vars.insert("POSTGRES_PASSWORD".to_owned(), "postgres".to_owned());

Self { env_vars }
Self {
env_vars,
copy_to_sources: Vec::new(),
}
}
}

Expand All @@ -95,6 +127,9 @@ impl Image for Postgres {
) -> impl IntoIterator<Item = (impl Into<Cow<'_, str>>, impl Into<Cow<'_, str>>)> {
&self.env_vars
}
fn copy_to_sources(&self) -> impl IntoIterator<Item = &CopyToContainer> {
&self.copy_to_sources
}
}

#[cfg(test)]
Expand Down Expand Up @@ -144,4 +179,31 @@ mod tests {
assert!(first_column.contains("13"));
Ok(())
}

#[test]
fn postgres_with_init_sql() -> Result<(), Box<dyn std::error::Error + 'static>> {
let node = Postgres::default()
.with_init_sql(
"CREATE TABLE foo (bar varchar(255));"
.to_string()
.into_bytes(),
)
.start()?;

let connection_string = &format!(
"postgres://postgres:postgres@{}:{}/postgres",
node.get_host()?,
node.get_host_port_ipv4(5432)?
);
let mut conn = postgres::Client::connect(connection_string, postgres::NoTls).unwrap();

let rows = conn
.query("INSERT INTO foo(bar) VALUES ($1)", &[&"blub"])
.unwrap();
assert_eq!(rows.len(), 0);

let rows = conn.query("SELECT bar FROM foo", &[]).unwrap();
assert_eq!(rows.len(), 1);
Ok(())
}
}

0 comments on commit 674a926

Please sign in to comment.