Allow the "retries" parameter to apply to pull as well as push.

Signed-off-by: Ben Kelley <[email protected]>

Author: bkelley17

src/main/asciidoc/inc/build/_configuration.adoc

@@ -120,6 +120,9 @@ a| Scan the archive specified in `dockerArchive` and find the actual repository
 | *shell*
 | Shell to be used for the *runCmds*. It contains *arg* elements which are defining the executable and its params.
 
+| *retries*
+| If pulling an image is required, how often should a pull be retried before giving up. This useful for flaky registries which tend to return 500 error codes from time to time. The default is 0 which means no retry at all.
+
 | *runCmds*
 | Commands to be run during the build process. It contains *run* elements which are passed to the shell. Whitespace is trimmed from each element and empty elements are ignored. The run commands are inserted right after the assembly and after *workdir* into the Dockerfile. This tag is not to be confused with the `<run>` section for this image which specifies the runtime behaviour when starting containers.
 

src/main/asciidoc/inc/start/_configuration.adoc

@@ -9,6 +9,10 @@ In addition to the <<global-configuration>>, this goal supports the following gl
 | Default pattern for naming all containers when they are created. See <<container-name, Container Names>> for details.
 | `docker.containerNamePattern`
 
+| *retries*
+| If pulling an image is required, how often should a pull be retried before giving up. This useful for flaky registries which tend to return 500 error codes from time to time. The default is 0 which means no retry at all.
+| `docker.pull.retries`
+
 | *showLogs*
 | In order to switch on globally the logs *showLogs* can be used as global configuration (i.e. outside of `<images>`). If set it will print out all standard
  output and standard error messages for all containers started. As value the images for which logs should be shown can be given as a comma separated list.
@@ -18,7 +22,6 @@ In addition to the <<global-configuration>>, this goal supports the following gl
 | *startParallel*
 | Starts docker images in parallel while dependencies expressed as <<start-links,Link>> or <<start-depends-on,dependsOn>> are respected. This option can significantly reduce the startup time because independent containers do not need to wait for each other.
 | `docker.startParallel`
-
 |===
 
 The `<run>` configuration element knows the following sub elements:

src/main/asciidoc/inc/watch/_configuration.adoc

@@ -49,6 +49,22 @@ below how this can be specified.
 | *watchPostGoal*
 | A maven goal which should be called if a rebuild or a restart has been performed. This goal must have the format `<pluginGroupId>:<pluginArtifactId>:<goal>` and the plugin must be configured in the `pom.xml`. For example a post-goal `io.fabric8:fabric8:delete-pods` will trigger the deletion of PODs in Kubernetes which in turn triggers are new start of a POD within the Kubernetes cluster. The value specified here is the the default post goal which can be overridden by `<postGoal>` in a `<watch>` configuration.
 |
+
+| *keepRunning*
+| If set to `true` all container will be kept running after `{plugin}:watch` has been stopped. By default this is set to `false`.
+| `docker.keepRunning`
+
+| *keepContainer*
+| As for `{plugin}:stop`, if this is set to `true` (and `keepRunning` is disabled) then all container will be removed after they have been stopped. The default is `true`.
+| `docker.keepContainer`
+
+| *removeVolumes*
+| if set to `true` will remove any volumes associated to the container as well. This option will be ignored if either `keepContainer` or `keepRunning` are `true`.
+| `docker.removeVolumes`
+
+| *retries*
+| If pulling an image is required, how often should a pull be retried before giving up. This useful for flaky registries which tend to return 500 error codes from time to time. The default is 0 which means no retry at all.
+| `docker.pull.retries`
 |===
 
 Image specific watch configuration goes into an extra image-level `<watch>` section (i.e. `+<image><watch>...</watch></image>+`). The following parameters are recognized:

src/main/java/io/fabric8/maven/docker/AbstractDockerMojo.java

@@ -121,6 +121,9 @@ public abstract class AbstractDockerMojo extends AbstractMojo implements Context
     @Parameter(property = "docker.removeVolumes", defaultValue = "false")
     protected boolean removeVolumes;
 
+    @Parameter(property = "docker.pull.retries", defaultValue = "0")
+    protected int retries;
+
     @Parameter(property = "docker.apiVersion")
     private String apiVersion;
 
@@ -577,7 +580,7 @@ protected void pullImage(RegistryService registryService, ImageConfiguration ima
         RunImageConfiguration runConfiguration = imageConfig.getRunConfiguration();
         ImagePullManager pullManager = getImagePullManager(determinePullPolicy(runConfiguration), autoPull);
         RegistryConfig registryConfig = getRegistryConfig(pullRegistry);
-        registryService.pullImageWithPolicy(imageName, pullManager, registryConfig, imageConfig.getBuildConfiguration());
+        registryService.pullImageWithPolicy(imageName, pullManager, registryConfig, imageConfig.getBuildConfiguration(), retries);
     }
 
     protected boolean shouldSkipPom() {
@@ -601,7 +604,7 @@ private boolean containerMatchesPattern(Container container, Matcher imageNameMa
         }
     }
 
-    private String determinePullPolicy(RunImageConfiguration runConfig) {
+    protected String determinePullPolicy(RunImageConfiguration runConfig) {
         return runConfig.getImagePullPolicy() != null ? runConfig.getImagePullPolicy() : imagePullPolicy;
     }
 

src/main/java/io/fabric8/maven/docker/BuildMojo.java

@@ -64,6 +64,8 @@ public class BuildMojo extends AbstractBuildSupportMojo {
      */
     @Parameter(property = "docker.skip.tag", defaultValue = "false")
     protected boolean skipTag;
+    @Parameter(property = "docker.pull.retries", defaultValue = "0")
+    private int retries;
 
     @Override
     protected void executeInternal(ServiceHub hub) throws IOException, MojoExecutionException {
@@ -111,7 +113,7 @@ private void proceedWithDockerBuild(ServiceHub hub, BuildService.BuildContext bu
             if (imageConfig.isBuildX()) {
                 hub.getBuildXService().build(createProjectPaths(), imageConfig, null, getAuthConfig(imageConfig), buildArchiveFile);
             } else {
-                buildService.buildImage(imageConfig, pullManager, buildContext, buildArchiveFile);
+                buildService.buildImage(imageConfig, pullManager, buildContext, buildArchiveFile, retries);
                 if (!skipTag) {
                     buildService.tagImage(imageConfig);
                 }

src/main/java/io/fabric8/maven/docker/StartMojo.java

@@ -34,6 +34,7 @@
 import io.fabric8.maven.docker.config.RunVolumeConfiguration;
 import io.fabric8.maven.docker.config.VolumeConfiguration;
 import io.fabric8.maven.docker.log.LogDispatcher;
+import io.fabric8.maven.docker.service.ImagePullManager;
 import io.fabric8.maven.docker.service.QueryService;
 import io.fabric8.maven.docker.service.RegistryService;
 import io.fabric8.maven.docker.service.RunService;
@@ -336,6 +337,7 @@ private Queue<ImageConfiguration> prepareStart(ServiceHub hub, QueryService quer
             pullImage(registryService, imageConfig, pullRegistry);
 
             RunImageConfiguration runConfig = imageConfig.getRunConfiguration();
+
             NetworkConfig config = runConfig.getNetworkingConfig();
             List<String> bindMounts = extractBindMounts(runConfig.getVolumeConfiguration());
             List<VolumeConfiguration> volumes = getVolumes();

src/main/java/io/fabric8/maven/docker/WatchMojo.java

@@ -73,14 +73,17 @@ public class WatchMojo extends AbstractBuildSupportMojo {
     @Parameter(property = "docker.autoCreateCustomNetworks", defaultValue = "false")
     protected boolean autoCreateCustomNetworks;
 
+    @Parameter(property = "docker.pull.retries", defaultValue = "0")
+    private int retries;
+
     @Override
     protected synchronized void executeInternal(ServiceHub hub) throws IOException,
                                                                        MojoExecutionException {
 
         BuildService.BuildContext buildContext = getBuildContext();
         WatchService.WatchContext watchContext = getWatchContext(hub);
 
-        hub.getWatchService().watch(watchContext, buildContext, getResolvedImages());
+        hub.getWatchService().watch(watchContext, buildContext, getResolvedImages(), retries);
     }
 
     protected WatchService.WatchContext getWatchContext(ServiceHub hub) throws IOException {

src/main/java/io/fabric8/maven/docker/access/DockerAccess.java

@@ -241,7 +241,7 @@ void copyArchiveFromContainer(String containerId, String containerPath, File arc
      * @param options additional query arguments to add when creating the image. Can be null.
      * @throws DockerAccessException if the image couldn't be pulled.
      */
-    void pullImage(String image, AuthConfig authConfig, String registry, CreateImageOptions options) throws DockerAccessException;
+    void pullImage(String image, AuthConfig authConfig, String registry, CreateImageOptions options, int retries) throws DockerAccessException;
 
     /**
      * Push an image to a registry. A registry can be specified which is used as target

src/main/java/io/fabric8/maven/docker/access/hc/DockerAccessWithHcClient.java

@@ -535,13 +535,12 @@ public void loadImage(String image, File tarArchive) throws DockerAccessExceptio
     }
 
     @Override
-    public void pullImage(String image, AuthConfig authConfig, String registry, CreateImageOptions options)
+    public void pullImage(String image, AuthConfig authConfig, String registry, CreateImageOptions options, int retries)
             throws DockerAccessException {
         String pullUrl = urlBuilder.pullImage(options);
         log.verbose(Logger.LogVerboseCategory.API, API_LOG_FORMAT_POST, pullUrl);
         try {
-            delegate.post(pullUrl, null, createAuthHeader(authConfig),
-                    createPullOrPushResponseHandler(), HTTP_OK);
+            doPushPullImage(pullUrl, createAuthHeader(authConfig), createBuildResponseHandler(), HTTP_OK, retries);
         } catch (IOException e) {
             throw new DockerAccessException(e, "Unable to pull '%s'%s", image, (registry != null) ? " from registry '" + registry + "'" : "");
         }
@@ -556,7 +555,7 @@ public void pushImage(String image, AuthConfig authConfig, String registry, int
         TemporaryImageHandler temporaryImageHandler = tagTemporaryImage(name, registry);
         DockerAccessException dae = null;
         try {
-            doPushImage(pushUrl, createAuthHeader(authConfig), createPullOrPushResponseHandler(), HTTP_OK, retries);
+            doPushPullImage(pushUrl, createAuthHeader(authConfig), createPullOrPushResponseHandler(), HTTP_OK, retries);
         } catch (IOException e) {
             dae = new DockerAccessException(e, "Unable to push '%s'%s", image, (registry != null) ? " to registry '" + registry + "'" : "");
             throw dae;
@@ -764,16 +763,16 @@ private boolean isRetryableErrorCode(int errorCode) {
         return errorCode == HTTP_INTERNAL_ERROR;
     }
 
-    private void doPushImage(String url, Map<String, String> header, HcChunkedResponseHandlerWrapper handler, int status,
+    private void doPushPullImage(String url, Map<String, String> header, HcChunkedResponseHandlerWrapper handler, int status,
                              int retries) throws IOException {
         // 0: The original attempt, 1..retry: possible retries.
         for (int i = 0; i <= retries; i++) {
             try {
-                delegate.post(url, null, header, handler, HTTP_OK);
+                delegate.post(url, null, header, handler, status);
                 return;
             } catch (HttpResponseException e) {
                 if (isRetryableErrorCode(e.getStatusCode()) && i != retries) {
-                    log.warn("failed to push image to [{}], retrying...", url);
+                    log.warn("failed to push/pull image to/from [%s], retrying...", url);
                 } else {
                     throw e;
                 }

src/main/java/io/fabric8/maven/docker/service/BuildService.java

@@ -57,15 +57,16 @@ public class BuildService {
      *
      * @param imageConfig  the image configuration
      * @param buildContext the build context
+     * @param pullRetries the number of times to retry if pulling an image fails
      * @throws DockerAccessException
      * @throws MojoExecutionException
      */
-    public void buildImage(ImageConfiguration imageConfig, ImagePullManager imagePullManager, BuildContext buildContext, File buildArchiveFile)
+    public void buildImage(ImageConfiguration imageConfig, ImagePullManager imagePullManager, BuildContext buildContext, File buildArchiveFile, int pullRetries)
             throws DockerAccessException, MojoExecutionException {
 
         if (imagePullManager != null) {
-            autoPullBaseImage(imageConfig, imagePullManager, buildContext);
-            autoPullCacheFromImage(imageConfig, imagePullManager, buildContext);
+            autoPullBaseImage(imageConfig, imagePullManager, buildContext, pullRetries);
+            autoPullCacheFromImage(imageConfig, imagePullManager, buildContext, pullRetries);
         }
 
         buildImage(imageConfig, buildContext.getMojoParameters(), checkForNocache(imageConfig), checkForSquash(imageConfig), addBuildArgs(buildContext), buildArchiveFile);
@@ -356,7 +357,7 @@ private Map<String, String> addBuildArgsFromDockerConfig() {
         return buildArgs;
     }
 
-    private void autoPullBaseImage(ImageConfiguration imageConfig, ImagePullManager imagePullManager, BuildContext buildContext)
+    private void autoPullBaseImage(ImageConfiguration imageConfig, ImagePullManager imagePullManager, BuildContext buildContext, int pullRetries)
             throws DockerAccessException, MojoExecutionException {
         BuildImageConfiguration buildConfig = imageConfig.getBuildConfiguration();
         CleanupMode cleanupMode = buildConfig.cleanupMode();
@@ -383,7 +384,7 @@ private void autoPullBaseImage(ImageConfiguration imageConfig, ImagePullManager
                     oldImageId = queryService.getImageId(fromImage);
                 }
 
-                registryService.pullImageWithPolicy(fromImage, imagePullManager, buildContext.getRegistryConfig(), buildConfig);
+                registryService.pullImageWithPolicy(fromImage, imagePullManager, buildContext.getRegistryConfig(), buildConfig, pullRetries);
 
                 String newImageId = queryService.getImageId(fromImage);
 
@@ -392,7 +393,7 @@ private void autoPullBaseImage(ImageConfiguration imageConfig, ImagePullManager
         }
     }
 
-    private void autoPullCacheFromImage(ImageConfiguration imageConfig, ImagePullManager imagePullManager, BuildContext buildContext) throws DockerAccessException, MojoExecutionException {
+    private void autoPullCacheFromImage(ImageConfiguration imageConfig, ImagePullManager imagePullManager, BuildContext buildContext, int pullRetries) throws DockerAccessException, MojoExecutionException {
         if (imageConfig.getBuildConfiguration().getCacheFrom() == null) {
             return;
         }
@@ -407,7 +408,7 @@ private void autoPullCacheFromImage(ImageConfiguration imageConfig, ImagePullMan
             }
 
             try {
-                registryService.pullImageWithPolicy(cacheFromImage, imagePullManager, buildContext.getRegistryConfig(), buildConfig);
+                registryService.pullImageWithPolicy(cacheFromImage, imagePullManager, buildContext.getRegistryConfig(), buildConfig, pullRetries);
             } catch (DockerAccessException e) {
                 log.warn("Could not pull cacheFrom image: '%s'. Reason: %s", cacheFromImage, e.getMessage());
             }