Consul for test-containers

This repository provides consul support for test-containers, based on the official hashicorp image from dockerhub.

Features

• support for ACLs
• consul configuration as an object
• support for both new (>= 1.4.0) and legacy (< 1.4.0) ACL config
• TLS support
• cluster support

Examples

Simply running container:

ConsulContainer cc = new ConsulContainer();
cc.start();

Adding custom configuration:

// set master token
ConsulConfiguration.Tokens tokens = new ConsulConfiguration.Tokens();
tokens.setMaster(UUID.randomUUID().toString());

// enable ACLs
ConsulConfiguration.ACL acl = new ConsulConfiguration.ACL();
acl.setEnabled(true);
acl.setDefaultPolicy("deny");
acl.setDownPolicy("deny");
acl.setTokens(tokens);

// build config
ConsulConfiguration ccf = new ConsulConfiguration();
ccf.setDatacenter("dc");
ccf.setPrimaryDatacenter("dc");
ccf.setAcl(acl);

ConsulContainer cc = new ConsulContainer(ccf); // apply config
cc.start();

TLS support:

// resources are taken from classpath
ConsulConfiguration.TLSConfig tlsConfig = new ConsulConfiguration.TLSConfig();
tlsConfig.setCaFile("tls/ca.cert");
tlsConfig.setKeyFile("tls/consul.key");
tlsConfig.setCertFile("tls/consul.cert");

ConsulConfiguration config = new ConsulConfiguration();
config.setDatacenter(DEFAULT_DC);
config.setTlsConfig(tlsConfig);
config.setVerifyIncoming(true);
config.setVerifyOutgoing(true);

Ports ports = new Ports();
ports.setHttpsPort(8501);
config.setPorts(ports);

ConsulContainer cc = new ConsulContainer(ccf);
cc.start();

To avoid boilerplate one can use ConsulContainerBuilder:

ConsulContainer container = new ConsulContainerBuilder()
                .withDatacenter("default")
                .withACLEnabled(true)
                .withACLDefaultPolicy("deny")
                .withMasterToken(UUID.randomUUID().toString())
                .withContainerVersion("1.3.0")
//              one can also specify ConsulConfiguration object, 
//              which is a composite of all above
//              .withConfig(config)
                .build();

To run consul cluster one can reuse ConsulContainerBuilder:

ConsulCluster cluster = new ConsulContainerBuilder()
                .withDatacenter("default")
                .withACLEnabled()
                .withACLDefaultPolicy("deny")
                .withMasterToken(UUID.randomUUID().toString())
                .withContainerVersion("1.4.0")
                .cluster(3); // cluster of 3 nodes

cluster.start();
// do smth
cluster.stop();

Credits

Many thanks to the creators and maintainers of Testcontainers. You do an awesome job!

This repository has been forked from https://github.com/denverx/testcontainers-consul.

Many thanks to @denverx for the contribution and inspiration for this project.

License

MIT License

Copyright (c) 2022 Houghton Mifflin Harcourt.

See LICENSE file for details.