com.palantir.docker.compose.execution.DockerComposeExecutable Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of docker-compose-rule-core Show documentation
Palantir open source project
There is a newer version: 2.3.0
Show newest version
/*
 * (c) Copyright 2016 Palantir Technologies Inc. All rights reserved.
 *
 * Licensed 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.palantir.docker.compose.execution;

import com.github.zafarkhaja.semver.Version;
import com.google.common.collect.ImmutableList;
import com.palantir.docker.compose.configuration.DockerComposeFiles;
import com.palantir.docker.compose.configuration.ProjectName;
import java.io.IOException;
import java.util.List;
import org.immutables.value.Value;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

@Value.Immutable
public abstract class DockerComposeExecutable implements Executable {
    private static final Logger log = LoggerFactory.getLogger(DockerComposeExecutable.class);

    private static final DockerCommandLocations DOCKER_COMPOSE_LOCATIONS = new DockerCommandLocations(
            System.getenv("DOCKER_COMPOSE_LOCATION"),
            "/usr/local/bin/docker-compose",
            "/usr/bin/docker-compose"
    );

    private static String defaultDockerComposePath() {
        String pathToUse = DOCKER_COMPOSE_LOCATIONS.preferredLocation()
                .orElseThrow(() -> new IllegalStateException(
                        "Could not find docker-compose, looked in: " + DOCKER_COMPOSE_LOCATIONS));

        log.debug("Using docker-compose found at " + pathToUse);

        return pathToUse;
    }

    static Version version() throws IOException, InterruptedException {
        Command dockerCompose = new Command(new Executable() {
            @Override
            public String commandName() {
                return "docker-compose";
            }

            @Override
            public Process execute(String... commands) throws IOException {
                List args = ImmutableList.builder()
                        .add(defaultDockerComposePath())
                        .add(commands)
                        .build();
                return new ProcessBuilder(args).redirectErrorStream(true).start();
            }
        }, log::trace);

        String versionOutput = dockerCompose.execute(Command.throwingOnError(), "-v");
        return DockerComposeVersion.parseFromDockerComposeVersion(versionOutput);
    }

    @Value.Parameter protected abstract DockerComposeFiles dockerComposeFiles();
    @Value.Parameter protected abstract DockerConfiguration dockerConfiguration();

    @Value.Default public ProjectName projectName() {
        return ProjectName.random();
    }

    @Override
    public final String commandName() {
        return "docker-compose";
    }

    @Value.Derived
    protected String dockerComposePath() {
        return defaultDockerComposePath();
    }

    @Override
    public Process execute(String... commands) throws IOException {
        DockerForMacHostsIssue.issueWarning();

        List args = ImmutableList.builder()
                .add(dockerComposePath())
                .addAll(projectName().constructComposeFileCommand())
                .addAll(dockerComposeFiles().constructComposeFileCommand())
                .add(commands)
                .build();

        return dockerConfiguration().configuredDockerComposeProcess()
                .command(args)
                .redirectErrorStream(true)
                .start();
    }

    public static ImmutableDockerComposeExecutable.Builder builder() {
        return ImmutableDockerComposeExecutable.builder();
    }
}