Merge pull request #249 from testcontainers/release/0.12.0

Author: thomaseizinger

CHANGELOG.md

@@ -7,6 +7,19 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [0.12.0] - 2021-01-27
+
+### Added
+
+-   Allow custom version for postgres image
+-   Remove `derivative` dependency
+-   `OrientDB` image
+-   `Zookeeper` image
+
+### Changed
+
+-   Move port mapping logic to `RunArgs` instead of each Image.
+
 ## [0.11.0] - 2020-09-30
 
 ### Added
@@ -59,7 +72,9 @@ Previously, this was done in a fire-and-forget way and hence led to containers n
 -   Provide a default password for the postgres image.
 There seems to be an unfortunate breaking change in the postgres image that we need to cater for.
 
-[Unreleased]: https://github.com/testcontainers/testcontainers-rs/compare/0.11.0...HEAD
+[Unreleased]: https://github.com/testcontainers/testcontainers-rs/compare/0.12.0...HEAD
+
+[0.12.0]: https://github.com/testcontainers/testcontainers-rs/compare/0.11.0...0.12.0
 
 [0.11.0]: https://github.com/testcontainers/testcontainers-rs/compare/0.10.0...0.11.0
 

Cargo.toml

@@ -7,23 +7,22 @@ keywords = ["docker", "testcontainers"]
 license = "MIT OR Apache-2.0"
 name = "testcontainers"
 repository = "https://github.com/testcontainers/testcontainers-rs"
-version = "0.11.0"
+version = "0.12.0"
 
 [dependencies]
-derivative = "2"
 hex = "0.4"
-hmac = "0.8"
+hmac = "0.10"
 log = "0.4"
-rand = "0.7"
+rand = "0.8"
 serde = { version = "1", features = ["derive"] }
 serde_json = "1"
 sha2 = "0.9"
 
 [dev-dependencies]
-bitcoincore-rpc = "0.11"
-postgres = "0.17"
+bitcoincore-rpc = "0.12"
+postgres = "0.18"
 pretty_env_logger = "0.4"
-redis = "0.16"
+redis = "0.19"
 mongodb = "1.0.0"
 rusoto_core = "0.45"
 rusoto_credential = "0.45"
@@ -33,3 +32,6 @@ spectral = "0.6"
 reqwest = { version = "0.10", features = ["blocking"] }
 json = "0.12"
 tokio = { version = "0.2", features = ["macros"] }
+env_logger = "0.8"
+zookeeper = "0.5"
+orientdb-client = "0.5.1"

src/clients/cli.rs

@@ -98,7 +98,7 @@ impl Cli {
             command.arg("--entrypoint").arg(entrypoint);
         }
 
-        if let Some(ports) = image.ports() {
+        if let Some(ports) = run_args.ports() {
             for port in &ports {
                 command
                     .arg("-p")
@@ -327,7 +327,6 @@ impl Ports {
 
 #[cfg(test)]
 mod tests {
-    use crate::core::Port;
     use crate::images::generic::GenericImage;
     use crate::{Container, Docker, Image};
 
@@ -414,10 +413,6 @@ mod tests {
             self.env_vars.clone()
         }
 
-        fn ports(&self) -> Option<Vec<Port>> {
-            None
-        }
-
         fn with_args(self, _arguments: <Self as Image>::Args) -> Self {
             self
         }
@@ -466,12 +461,11 @@ mod tests {
 
     #[test]
     fn cli_run_command_should_expose_only_requested_ports() {
-        let image = GenericImage::new("hello")
+        let image = GenericImage::new("hello");
+        let mut docker = Command::new("docker");
+        let run_args = RunArgs::default()
             .with_mapped_port((123, 456))
             .with_mapped_port((555, 888));
-
-        let mut docker = Command::new("docker");
-        let run_args = RunArgs::default();
         let command = Cli::build_run_command(&image, &mut docker, &run_args);
 
         println!("Executing command: {:?}", command);

src/core/docker.rs

@@ -1,5 +1,6 @@
+use crate::core::Port;
 use crate::{Container, Image};
-use std::{collections::HashMap, io::Read};
+use std::{collections::HashMap, fmt, io::Read};
 
 /// Defines the minimum API required for interacting with the Docker daemon.
 pub trait Docker
@@ -18,10 +19,12 @@ where
 /// Container run command arguments.
 /// `name` - run image instance with the given name (should be explicitly set to be seen by other containers created in the same docker network).
 /// `network` - run image instance on the given network.
+/// `ports` - run image instance with the given ports mapping (if explicit mappings is not defined, all image ports will be automatically exposed and mapped on random host ports).
 #[derive(Debug, Clone, Default)]
 pub struct RunArgs {
     name: Option<String>,
     network: Option<String>,
+    ports: Option<Vec<Port>>,
 }
 
 impl RunArgs {
@@ -39,13 +42,24 @@ impl RunArgs {
         }
     }
 
+    pub fn with_mapped_port<P: Into<Port>>(mut self, port: P) -> Self {
+        let mut ports = self.ports.unwrap_or_default();
+        ports.push(port.into());
+        self.ports = Some(ports);
+        self
+    }
+
     pub(crate) fn network(&self) -> Option<String> {
         self.network.clone()
     }
 
     pub(crate) fn name(&self) -> Option<String> {
         self.name.clone()
     }
+
+    pub(crate) fn ports(&self) -> Option<Vec<Port>> {
+        self.ports.clone()
+    }
 }
 
 /// The exposed ports of a running container.
@@ -71,11 +85,13 @@ impl Ports {
 }
 
 /// Log streams of running container (stdout & stderr).
-#[derive(derivative::Derivative)]
-#[derivative(Debug)]
 pub struct Logs {
-    #[derivative(Debug = "ignore")]
     pub stdout: Box<dyn Read>,
-    #[derivative(Debug = "ignore")]
     pub stderr: Box<dyn Read>,
 }
+
+impl fmt::Debug for Logs {
+    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
+        f.debug_struct("Logs").finish()
+    }
+}

src/core/image.rs

@@ -85,11 +85,6 @@ where
     /// Returns the volumes this instance was created with.
     fn volumes(&self) -> Self::Volumes;
 
-    /// Returs the ports mapping requested for the image.
-    /// If not explicit port mappings is defined, all image ports will be automatically
-    /// exposed and mapped on random host ports.
-    fn ports(&self) -> Option<Vec<Port>>;
-
     /// Re-configures the current instance of this image with the given arguments.
     fn with_args(self, arguments: Self::Args) -> Self;
 

src/images.rs

@@ -3,7 +3,9 @@ pub mod dynamodb_local;
 pub mod elasticmq;
 pub mod generic;
 pub mod mongo;
+pub mod orientdb;
 pub mod parity_parity;
 pub mod postgres;
 pub mod redis;
 pub mod trufflesuite_ganachecli;
+pub mod zookeeper;

src/images/coblox_bitcoincore.rs

@@ -1,4 +1,3 @@
-use crate::core::Port;
 use crate::core::{Container, Docker, Image, WaitForMessage};
 use hex::encode;
 use hmac::{Hmac, Mac, NewMac};
@@ -11,7 +10,6 @@ use std::{collections::HashMap, env::var, thread::sleep, time::Duration};
 pub struct BitcoinCore {
     tag: String,
     arguments: BitcoinCoreImageArgs,
-    ports: Option<Vec<Port>>,
 }
 
 impl BitcoinCore {
@@ -235,10 +233,6 @@ impl Image for BitcoinCore {
         HashMap::new()
     }
 
-    fn ports(&self) -> Option<Vec<Port>> {
-        self.ports.clone()
-    }
-
     fn with_args(self, arguments: <Self as Image>::Args) -> Self {
         BitcoinCore { arguments, ..self }
     }
@@ -249,7 +243,6 @@ impl Default for BitcoinCore {
         BitcoinCore {
             tag: "0.20.0".into(),
             arguments: BitcoinCoreImageArgs::default(),
-            ports: None,
         }
     }
 }
@@ -261,13 +254,6 @@ impl BitcoinCore {
             ..self
         }
     }
-
-    pub fn with_mapped_port<P: Into<Port>>(mut self, port: P) -> Self {
-        let mut ports = self.ports.unwrap_or_default();
-        ports.push(port.into());
-        self.ports = Some(ports);
-        self
-    }
 }
 
 #[cfg(test)]

src/images/dynamodb_local.rs

@@ -1,4 +1,3 @@
-use crate::core::Port;
 use crate::{Container, Docker, Image, WaitForMessage};
 use std::{collections::HashMap, env::var, thread::sleep, time::Duration};
 
@@ -23,15 +22,13 @@ impl IntoIterator for DynamoDbArgs {
 pub struct DynamoDb {
     tag: String,
     arguments: DynamoDbArgs,
-    ports: Option<Vec<Port>>,
 }
 
 impl Default for DynamoDb {
     fn default() -> Self {
         DynamoDb {
             tag: DEFAULT_TAG.to_string(),
             arguments: DynamoDbArgs {},
-            ports: None,
         }
     }
 }
@@ -80,10 +77,6 @@ impl Image for DynamoDb {
         HashMap::new()
     }
 
-    fn ports(&self) -> Option<Vec<Port>> {
-        self.ports.clone()
-    }
-
     fn with_args(self, arguments: <Self as Image>::Args) -> Self {
         DynamoDb { arguments, ..self }
     }
@@ -96,11 +89,4 @@ impl DynamoDb {
             ..self
         }
     }
-
-    pub fn with_mapped_port<P: Into<Port>>(mut self, port: P) -> Self {
-        let mut ports = self.ports.unwrap_or_default();
-        ports.push(port.into());
-        self.ports = Some(ports);
-        self
-    }
 }

src/images/elasticmq.rs

@@ -1,4 +1,3 @@
-use crate::core::Port;
 use crate::{Container, Docker, Image, WaitForMessage};
 use std::collections::HashMap;
 
@@ -21,15 +20,13 @@ impl IntoIterator for ElasticMQArgs {
 pub struct ElasticMQ {
     tag: String,
     arguments: ElasticMQArgs,
-    ports: Option<Vec<Port>>,
 }
 
 impl Default for ElasticMQ {
     fn default() -> Self {
         ElasticMQ {
             tag: DEFAULT_TAG.to_string(),
             arguments: ElasticMQArgs {},
-            ports: None,
         }
     }
 }
@@ -64,10 +61,6 @@ impl Image for ElasticMQ {
         HashMap::new()
     }
 
-    fn ports(&self) -> Option<Vec<Port>> {
-        self.ports.clone()
-    }
-
     fn with_args(self, arguments: <Self as Image>::Args) -> Self {
         ElasticMQ { arguments, ..self }
     }
@@ -80,11 +73,4 @@ impl ElasticMQ {
             ..self
         }
     }
-
-    pub fn with_mapped_port<P: Into<Port>>(mut self, port: P) -> Self {
-        let mut ports = self.ports.unwrap_or_default();
-        ports.push(port.into());
-        self.ports = Some(ports);
-        self
-    }
 }