Skip to content

Latest commit

 

History

History
52 lines (34 loc) · 3.47 KB

index.md

File metadata and controls

52 lines (34 loc) · 3.47 KB
Raw

TestContainers

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.

Build Status View on Github

Testcontainers logo

Use Cases

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.

Who is using TestContainers?

  • ZeroTurnaround - Testing of the Java Agents, micro-services, Selenium browser automation
  • Zipkin - MySQL and Cassandra testing
  • Apache Gora - CouchDB testing
  • Apache James - LDAP and Cassandra integration testing
  • StreamSets - LDAP, MySQL Vault, MongoDB, Redis integration testing

License

See LICENSE.

Attributions

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 was initially inspired by a gist by Mosche Eschel.

Contributing

  • Star the project on Github and help spread the word :)
  • Join our Slack: http://slack.testcontainers.org
  • 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

Copyright (c) 2015, 2016 Richard North and other authors.

See AUTHORS for contributors.