https://github.com/bazhenov/docker-testng-integration
Simple way of running integration tests with TestNG and Docker
https://github.com/bazhenov/docker-testng-integration
docker docker-testng java testng
Last synced: 6 months ago
JSON representation
Simple way of running integration tests with TestNG and Docker
- Host: GitHub
- URL: https://github.com/bazhenov/docker-testng-integration
- Owner: bazhenov
- License: other
- Created: 2016-09-01T12:23:01.000Z (almost 10 years ago)
- Default Branch: master
- Last Pushed: 2023-04-17T11:04:53.000Z (over 3 years ago)
- Last Synced: 2025-07-26T21:22:15.071Z (12 months ago)
- Topics: docker, docker-testng, java, testng
- Language: Java
- Size: 98.6 KB
- Stars: 4
- Watchers: 3
- Forks: 9
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Docker TestNG Integration
## Introduction
This library allows you to run Docker containers before your test suite.
## Usage
Include dependency in your `pom.xml`
```xml
me.bazhenov
docker-testng-integration
1.6
test
```
Then in your test use class-level annotation `@Container` (you can provide several annotations), as well as method-level
annotation `@AfterContainerStart`. You also need to register `me.bazhenov.docker.DockerTestNgListener`
```java
@Container(name = "my-container", image = "mysql", publish = @Port(3306), environment =
{"MYSQL_ROOT_PASSWORD=secret"})
@Listeners(DockerTestNgListener.class)
public class MySqlIT {
private int mysqlPort;
@AfterContainerStart
public void setUp(@ContainerPort(name = "my-container", port = 3306) int port) {
mysqlPort = port;
}
@Test
public void myTest() {
String jdbcUrl = "jdbc:mysql://localhost:" + mysqlPort + "/db";
// Using this URL to connect to MySQL
}
}
```
If you don't want to register listener on a test-case class you can add the listener to your test suite. If you are
using Maven, just add following config to your `pom.xml`:
```xml
org.apache.maven.plugins
maven-surefire-plugin
listener
me.bazhenov.docker.DockerTestNgListener
```
You should remember that registering listener both in XML and test classes (using annotations) will result in container being
started twice.
By default all containers are local to the test case. So if you define two test cases with container named `mysql`, 2 mysql
instances will be started. One for each test case. But you can share containers between test cases, if you need to.
```java
@Container(image = "mysql:5.6", name = "mysql", publish = @Port(3306))
class SharedContainers {}
@ContainersFrom(SharedContainers.class)
@Listeners(DockerTestNgListener.class)
class MyTestCase {
@AfterContainerStart
public void dockerSetup(@ContainerPort(name = "mysql", port = 3306) int mysqlPort) {
// ...
}
}
```
In this case container `mysql` will be started just once and shared between all test cases importing it using `@ContainersFrom`.
## Networking
You can create network between several containers:
```java
@Container(name = "mysql", image = "mysql", network = "my-test-network", networkAlias = "mysql-host")
@Container(name = "node1", image = "node-needs-mysql", network = "my-test-network", environment =
{"NODE_JDBC_URL=jdbc:mysql://mysql-host:3306/db"})
@Container(name = "node2", image = "node-needs-mysql", network = "my-test-network", environment =
{"NODE_JDBC_URL=jdbc:mysql://mysql-host:3306/db"})
@Listeners(DockerTestNgListener.class)
public class MyAppIT {
// ...
}
```
Containers `mysql`, `node1` and `node2` will be started with the same network `my-test-network`.
Container `mysql` will be accessible in this network by network alias `mysql-host` with all its ports.
Port publishing is not necessary.
## Features
* library using `docker` command line utility;
* provides an easy way of getting dynamically allocated ports in tests;
* mark all containers with `testng` label, so they could be easily found with `docker ps -af label=testng` command;
* can map host directories as volumes inside a container;
* waits for given ports to be open in a container, so containerized service is up at the moment of test starts;
* library can share containers before several test cases using `@ContainersFrom` annotation. This allows to speed up test
execution if you can reuse single container instead of starting a new container each time.
## Limitations
* only TCP ports are exposed at the moment