com.arakelian.docker.junit.model.DockerConfig Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of docker-junit-rule Show documentation
null
There is a newer version: 4.1.0
/*
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You under the Apache License, Version 2.0
 * (the "License"); you may not use this file except in compliance with
 * the License.  You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package com.arakelian.docker.junit.model;

import java.util.List;

import org.immutables.value.Value;

import com.google.common.collect.ImmutableList;

/**
 * Docker configuration.
 *
 * We use Immutables to generate immutable Java beans, via Java
 * Annotation Processing.
 *
 * @author Greg Arakelian
 */
@Value.Immutable(copy = false)
public interface DockerConfig {
    @Value.Default
    @Value.Auxiliary
    public default List getContainerConfigurer() {
        return ImmutableList.of();
    }

    @Value.Default
    @Value.Auxiliary
    public default List getHostConfigurer() {
        return ImmutableList.of();
    }

    /**
     * Returns the name of the docker image.
     *
     * @return name of the docker image
     */
    @Value.Auxiliary
    public String getImage();

    /**
     * Returns the container name (as would be displayed in "NAMES" column of "docker ps" command).
     *
     * @return the container name.
     */
    public String getName();

    /**
     * Returns the list of ports that this container will make public.
     *
     * @return list of ports that this container will make public.
     */
    @Value.Auxiliary
    public String[] getPorts();

    /**
     * Returns a list of listeners which are called when the container is started.
     * 
     * @return list of listeners which are called when the container is started
     */
    @Value.Default
    @Value.Auxiliary
    public default List getStartedListener() {
        return ImmutableList.of();
    }

    /**
     * Returns true if container is allowed to continue running between separate JUnit tests.
     * 
     * Note that all containers are automatically stopped when the JVM is exited (e.g. when Gradle
     * tests complete, or when JUnit tests complete inside Eclipse). This is a performance
     * enhancement that allows individual unit tests to complete much faster.
     * 
     * @return true if container is allowed to continue running between separate JUnit tests
     */
    @Value.Default
    @Value.Auxiliary
    public default boolean isAllowRunningBetweenUnitTests() {
        return true;
    }

    /**
     * Returns true if we should always pull the latest image, even if we already have a copy
     * locally.
     *
     * @return true if we should always pull the latest image
     */
    @Value.Default
    @Value.Auxiliary
    public default boolean isAlwaysPullLatestImage() {
        return false;
    }

    /**
     * Returns true if container should always be removed between executions.
     * 
     * @return true if container should always be removed between executions.
     */
    @Value.Default
    @Value.Auxiliary
    public default boolean isAlwaysRemoveContainer() {
        return false;
    }
}