dev.galasa.docker.internal.DockerImageBuilderImpl Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of dev.galasa.docker.manager Show documentation
A Galasa project
The newest version!
/*
 * Copyright contributors to the Galasa project
 *
 * SPDX-License-Identifier: EPL-2.0
 */
package dev.galasa.docker.internal;

import java.io.BufferedOutputStream;
import java.io.IOException;
import java.io.InputStream;
import java.io.OutputStream;
import java.nio.file.Files;
import java.nio.file.Path;
import java.nio.file.Paths;
import java.util.Map;

import org.apache.commons.compress.archivers.tar.TarArchiveEntry;
import org.apache.commons.compress.archivers.tar.TarArchiveOutputStream;
import org.apache.commons.compress.compressors.gzip.GzipCompressorOutputStream;
import org.apache.commons.io.IOUtils;

import dev.galasa.docker.DockerManagerException;

public class DockerImageBuilderImpl implements IDockerImageBuilder {
    private DockerEngineImpl engine;

    /**
     * Pass the docker engine that the image will be required upon.
     * @param engine
     */
    public DockerImageBuilderImpl(DockerEngineImpl engine) {
        this.engine = engine;
    }
    
    /**
     * Build a new image on the docker engine. A dockerfile MUST be passed.
     * @param imageName
     * @param dockerfile
     * @throws DockerMangerException
     */
    @Override
    public void buildImage(String imageName, InputStream dockerfile)throws DockerManagerException {
    	buildImage(imageName, dockerfile, null);
    }
    

    /**
     * Build a new image on the docker engine. A dockerfile MUST be passed. Any resources required to build the 
     * dockerfile need to be passed with there corresponding filename.
     * 
     * @param imageName
     * @param dockerfile
     * @param resources
     * @throws DockerMangerException
     */
    @Override
    public void buildImage(String imageName, InputStream dockerfile, Map resources)
            throws DockerManagerException {
        try {
        	Path dockerPath = createDockerTagGz(dockerfile, resources);
            engine.buildImage(imageName, dockerPath);
        } catch (IOException e) {
            throw new DockerManagerException("Failed to build image", e);
        }

    }

    /**
     * Creates a tar.gz in a temp build directory and pass back a path to the file.
     * 
     * @param dockerfile
     * @param buildResources
     * @return
     * @throws DockerManagerException
     * @throws IOException 
     */
    private Path createDockerTagGz(InputStream dockerfile, Map buildResources) throws DockerManagerException, IOException {
    	Path tmp = Paths.get("/tmp");
    	Path tmpDir = Files.createTempDirectory(tmp, "galasa-build-dir");
        Path outputTar = Paths.get(tmpDir + "/Dockerfile.tar.gz");

        try {
            OutputStream fOut = Files.newOutputStream(outputTar);
            BufferedOutputStream buffOut = new BufferedOutputStream(fOut);
            GzipCompressorOutputStream gzOut = new GzipCompressorOutputStream(buffOut);
            TarArchiveOutputStream tOut = new TarArchiveOutputStream(gzOut);

            // Create the dockerfile
            TarArchiveEntry dockerEntry = new TarArchiveEntry("Dockerfile");
            dockerEntry.setSize(dockerfile.available());
            tOut.putArchiveEntry(dockerEntry);
            IOUtils.copy(dockerfile, tOut);
            tOut.closeArchiveEntry();

            if (buildResources != null) {
            	// Put the rest of the resources in a flat dir
                for (String fileName : buildResources.keySet()) {
                    TarArchiveEntry entry = new TarArchiveEntry(fileName);
                    entry.setSize(buildResources.get(fileName).available());
                    tOut.putArchiveEntry(entry);
                    IOUtils.copy(buildResources.get(fileName), tOut);
                    tOut.closeArchiveEntry();
                }
            }
            
            tOut.flush();
            tOut.close();

        } catch(IOException e) {
            throw new DockerManagerException("Failed to create Dockerfile.tar.gz", e);
        }
        return outputTar;
    }
}