au.net.causal.maven.plugins.boxdb.db.DockerPuller Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of boxdb-maven-plugin Show documentation
Maven plugin to start databases using Docker and VMs
There is a newer version: 3.3
package au.net.causal.maven.plugins.boxdb.db;

import io.fabric8.maven.docker.access.DockerAccessException;
import io.fabric8.maven.docker.service.ImagePullManager;
import io.fabric8.maven.docker.service.QueryService;
import io.fabric8.maven.docker.service.RegistryService;
import org.apache.maven.plugin.MojoExecutionException;

/**
 * Utility class for pulling Docker images using a pull policy configured on the Maven project.
 */
public final class DockerPuller
{
    /**
     * Private constructor to prevent instantiation.
     */
    private DockerPuller()
    {
    }

    /**
     * Pull an image using Docker if needed.  This uses the pull image policy configured in Maven, which controls whether
     * images are checked and updated if needed.
     *
     * @param imageName the name of the Docker image to pull.
     * @param boxConfiguration database box configuration.
     * @param projectConfiguration project configuration.
     * @param context context.
     *
     * @throws BoxDatabaseException if an error occurs.
     * @throws DockerAccessException if a Docker error occurs.
     * @throws MojoExecutionException if there is a problem with configuration in Maven.
     */
    public static void pullImage(String imageName, BoxConfiguration boxConfiguration,
                                 ProjectConfiguration projectConfiguration, BoxContext context)
    throws BoxDatabaseException, DockerAccessException, MojoExecutionException
    {
        QueryService queryService = context.getDockerServiceHub().getQueryService();
        RegistryService.RegistryConfig registryConfig = getRegistryConfig(projectConfiguration, context, null); //TODO should we allow specific registry to pull from to be configured?
        ImagePullManager pullManager = context.imagePullManager(boxConfiguration);
        context.getDockerServiceHub().getRegistryService().pullImageWithPolicy(imageName, pullManager, registryConfig,
                                                      queryService.hasImage(imageName));
    }

    /**
     * Builds Docker registry configuration from Maven configuration.
     *
     * @param projectConfiguration Maven project configuration for the current project.
     * @param context box context.
     * @param specificRegistry the Docker registry specifically configured, or null to use the default registry.
     *
     * @return registry configuration.
     */
    private static RegistryService.RegistryConfig getRegistryConfig(ProjectConfiguration projectConfiguration, BoxContext context, String specificRegistry)
    {

        return new RegistryService.RegistryConfig.Builder()
                    .settings(projectConfiguration.getSettings())
                    .authConfig(context.getDockerAuthConfiguration() != null ? context.getDockerAuthConfiguration().toMap() : null)
                    .authConfigFactory(context.getAuthConfigFactory())
                    .skipExtendedAuth(context.isDockerSkipExtendedAuth())
                    .registry(specificRegistry)
                    .build();
    }


}