org.testcontainers.containers.CephContainer Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of testcontainers-ceph Show documentation
Testcontainers Ceph
The newest version!
package org.testcontainers.containers;

import com.github.dockerjava.api.model.Ulimit;
import org.testcontainers.containers.wait.strategy.Wait;
import org.testcontainers.utility.DockerImageName;

import java.net.URI;
import java.net.URISyntaxException;
import java.time.Duration;

import static java.util.Objects.requireNonNull;

/**
 * Testcontainers implementation for Ceph.
 * 

 * Supported image: {@code quay.io/ceph/demo}
 * 

 * Defaults to {@code quay.io/ceph/demo:latest-quincy} aka v17 of Ceph
 * 

 * Exposed ports:
 * 
 *     Ceph: 8080
 *     Monitor: 3300
 * 
 */
public class CephContainer extends GenericContainer {
    private static final DockerImageName DEFAULT_IMAGE_NAME = DockerImageName.parse("quay.io/ceph/demo");

    private static final String DEFAULT_IMAGE_TAG = "latest-quincy";

    private static final String CEPH_RGW_DEFAULT_ACCESS_KEY = "demo";

    private static final String CEPH_RGW_DEFAULT_SECRET_KEY = "b36361c4-1589-42f7-a369-d9dafb926d55";

    private static final Integer CEPH_MON_DEFAULT_PORT = 3300;

    private static final Integer CEPH_RGW_DEFAULT_PORT = 8080;

    private static final String CEPH_DEMO_UID = "demo";

    private static final String CEPH_DEMO_BUCKET = "demo";

    private static final String CEPH_END_START_REGEX_FORMAT = ".*Bucket 's3://%s/' created\n.*";

    private static final Ulimit[] DEFAULT_ULIMITS = new Ulimit[]{new Ulimit("nofile", 65536L, 65536L)};

    private String cephAccessKey;

    private String cephSecretKey;

    private String cephBucket;

    public CephContainer() {
        this(DEFAULT_IMAGE_NAME.withTag(DEFAULT_IMAGE_TAG));
    }

    public CephContainer(final String dockerImageName) {
        this(DockerImageName.parse(dockerImageName));
    }

    public CephContainer(final DockerImageName dockerImageName) {
        super(dockerImageName);
        dockerImageName.assertCompatibleWith(DEFAULT_IMAGE_NAME);
        withCreateContainerCmdModifier(createContainerCmd ->
                requireNonNull(createContainerCmd
                        .getHostConfig())
                        .withUlimits(DEFAULT_ULIMITS));
    }

    @Override
    public void configure() {
        addExposedPorts(CEPH_MON_DEFAULT_PORT, CEPH_RGW_DEFAULT_PORT);

        addEnv("CEPH_DEMO_UID", CEPH_DEMO_UID);
        addEnv(
                "CEPH_DEMO_BUCKET",
                this.cephBucket != null
                        ? this.cephBucket
                        : (this.cephBucket = CEPH_DEMO_BUCKET)
        );
        addEnv(
                "CEPH_DEMO_ACCESS_KEY",
                this.cephAccessKey != null
                        ? this.cephAccessKey
                        : (this.cephAccessKey = CEPH_RGW_DEFAULT_ACCESS_KEY)
        );
        addEnv(
                "CEPH_DEMO_SECRET_KEY",
                this.cephSecretKey != null
                        ? this.cephSecretKey
                        : (this.cephSecretKey = CEPH_RGW_DEFAULT_SECRET_KEY)
        );
        addEnv("CEPH_PUBLIC_NETWORK", "0.0.0.0/0");
        // This needs to be 127.0.0.1, if not the demo image will not start properly
        addEnv("MON_IP", "127.0.0.1");
        // This is important because without it, we cant access ceph from http://localhost:
        addEnv("RGW_NAME", "localhost");
        if (this.waitStrategy == DEFAULT_WAIT_STRATEGY) {
            setWaitStrategy(Wait.forLogMessage(String.format(CEPH_END_START_REGEX_FORMAT, this.cephBucket), 1)
                    .withStartupTimeout(Duration.ofMinutes(5)));
        }
    }

    public CephContainer withSslDisabled() {
        return super.withCreateContainerCmdModifier((cmd) -> {
            cmd.withEntrypoint(
                    "bash",
                    "-c",
                    "sed -i '/^rgw frontends = .*/a rgw verify ssl = false\\\n" +
                            "rgw crypt require ssl = false' /opt/ceph-container/bin/demo;\n" +
                            "/opt/ceph-container/bin/demo;"
            );
        });
    }

    public CephContainer withCephAccessKey(String cephAccessKey) {
        this.cephAccessKey = cephAccessKey;
        return this;
    }

    public CephContainer withCephSecretKey(String cephSecretKey) {
        this.cephSecretKey = cephSecretKey;
        return this;
    }

    public CephContainer withCephBucket(String cephBucket) {
        this.cephBucket = cephBucket;
        return this;
    }

    public int getCephPort() {
        return getMappedPort(CEPH_RGW_DEFAULT_PORT);
    }

    public URI getCephUrl() throws URISyntaxException {
        return new URI(String.format("http://%s:%s", this.getHost(), getCephPort()));
    }

    public String getCephAccessKey() {
        return cephAccessKey;
    }

    public String getCephSecretKey() {
        return cephSecretKey;
    }

    public String getCephBucket() {
        return cephBucket;
    }
}