TestContainers is a Java library that supports JUnit tests, providing lightweight, throwaway instances of common databases, Selenium web browsers, or anything else that can run in a Docker container.

• Use Cases
• Usage summary
• Usage
  • Prerequisites
  • Usage modes
• Maven dependencies
• License
• Attributions
• Contributing
• Copyright

TestContainers makes it easy to launch useful Docker containers for the duration of JUnit tests.

• Data access layer integration tests: use a containerized instance of a MySQL, PostgreSQL or Oracle database to test your data access layer code for complete compatibility, but without requiring complex setup on developers' machines and safe in the knowledge that your tests will always start with a known DB state. Any other database type that can be containerized can also be used.
• Application integration tests: for running your application in a short-lived test mode with dependencies, such as databases, message queues or web servers.
• UI/Acceptance tests: use containerized web browsers, compatible with Selenium, for conducting automated UI tests. Each test can get a fresh instance of the browser, with no browser state, plugin variations or automated browser upgrades to worry about. And you get a video recording of each test session, or just each session where tests failed.

Docker or boot2docker (for OS X) must be installed on the machine you are running tests on. TestContainers currently requires JDK 1.7 and is compatible with JUnit and Selenium2/WebDriver.

• Temporary database containers - specialized MySQL, PostgreSQL and Oracle XE container support
• Webdriver containers - run a Dockerized Chrome or Firefox browser ready for Selenium/Webdriver operations - complete with automatic video recording
• Generic containers - run any Docker container as a test dependency
• Docker compose - reuse services defined in a Docker Compose YAML file

TestContainers is distributed in a handful of Maven modules:

• testcontainers for just core functionality and generic containers support
• mysql, postgresql or oracle-xe for database container support
• selenium for selenium/webdriver support
• docker-compose for Docker Compose support
• nginx for nginx container support

In the dependency description below, replace --artifact name-- as appropriate:

<dependency>
    <groupId>org.testcontainers</groupId>
    <artifactId>--artifact name--</artifactId>
    <version>0.9.8</version>
</dependency>

See LICENSE.

This project includes a modified class (ScriptUtils) taken from the Spring JDBC project, adapted under the terms of the Apache license. Copyright for that class remains with the original authors.

This project is built on top of the awesome Spotify docker client library for Java and was initially inspired by a gist by Mosche Eschel.

• Star the project on Github and help spread the word :)
• See ROADMAP to understand the approach behind the project and what may/may not be in store for the future.
• Post an issue if you find any bugs
• Contribute improvements or fixes using a Pull Request. If you're going to contribute, thank you! Please just be sure to:
  • discuss with the authors on an issue ticket prior to doing anything big
  • follow the style, naming and structure conventions of the rest of the project
  • make commits atomic and easy to merge
  • verify all tests are passing. Build the project with mvn clean install -Pproprietary-deps to do this.

Copyright (c) 2015 Richard North and other authors.

See AUTHORS for contributors.