docker container fetch limit is now configurable

Signed-off-by: Gregory Gulrajani <gregory.gulrajani@nucleusfinancial.com>

doc/manual/external-configuration.md

@@ -36,8 +36,8 @@ Example:
 </image>
 ```
 
-Given this example configuration a single image configuration is build
-up from the following properties, which correspond to corresponding
+Given this example configuration a single image configuration is built
+up from the following properties, which correspond to the corresponding
 values in the `<build>` and `<run>` sections.
 
 * **docker.alias** Alias name
@@ -83,6 +83,7 @@ used to create the image. The dockerfile must be name `Dockerfile`
   used as environment variables. The environment variables takes precedence over any other environment
   variables specified.
 * **docker.extraHosts.idx** List of `host:ip` to add to `/etc/hosts`
+* **docker.fetchLimit** Number of running and stopped containers to return. A value of 0 returns all running and stopped containers. Default is 100.
 * **docker.from** Base image for building an image
 * **docker.hostname** Container hostname
 * **docker.labels.LABEL** Sets a label which works similarly like setting environment variables. 

doc/manual/global-configuration.md

@@ -47,6 +47,8 @@ parentheses.
 * **skip** (`docker.skip`)
   With this parameter the execution of this plugin can be skipped
   completely. 
+* **fetchLimit** (`docker.fetchLimit`)
+  Number of running and stopped containers to return. A value of 0 returns all running and stopped containers. Default is 100.
 * **skipTags** (`docker.skipTags`)
   If set to `true` the plugin won't add any tags to images that have been built.
 * **registry** (`docker.registry`)

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

@@ -120,6 +120,10 @@ public abstract class AbstractDockerMojo extends AbstractMojo implements Context
     @Parameter(property = "docker.skip", defaultValue = "false")
     private boolean skip;
 
+    // Max number of containers to fetch when stopping/removing
+    @Parameter(property = "docker.fetchLimit", defaultValue = "100")
+    protected int fetchLimit;
+
     /**
      * Whether to restrict operation to a single image. This can be either
      * the image or an alias name. It can also be comma separated list.
@@ -139,7 +143,7 @@ public abstract class AbstractDockerMojo extends AbstractMojo implements Context
     // property file to write out with port mappings
     @Parameter
     protected String portPropertyFile;
-    
+
     // Authentication information
     @Parameter
     Map authConfig;
@@ -178,7 +182,9 @@ public void execute() throws MojoExecutionException, MojoFailureException {
             DockerAccess access = null;
             try {
                 access = createDockerAccess(minimalApiVersion);
-                ServiceHub serviceHub = serviceHubFactory.createServiceHub(project, session, access, log, logSpecFactory);
+                fetchLimit = resolvedImages.get(0).getRunConfiguration().getFetchLimit() != null
+                        ? resolvedImages.get(0).getRunConfiguration().getFetchLimit() : fetchLimit;
+                ServiceHub serviceHub = serviceHubFactory.createServiceHub(project, session, access, log, logSpecFactory, fetchLimit);
                 executeInternal(serviceHub);
             } catch (DockerAccessException exp) {
                 log.error("%s", exp.getMessage());
@@ -225,6 +231,7 @@ public List<ImageConfiguration> resolve(ImageConfiguration image) {
 
     // Customization hook for subclasses to influence the final configuration. This method is called
     // before initialization and validation of the configuration.
+    @Override
     public List<ImageConfiguration> customizeConfig(List<ImageConfiguration> imageConfigs) {
         return imageConfigs;
     }

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

@@ -53,7 +53,7 @@ public String containerLogs(String containerId, boolean follow) {
                 .p("follow", follow)
                 .build();
     }
-    
+
     public String createContainer(String name) {
         return u("containers/create")
                 .p("name", name)
@@ -70,13 +70,19 @@ public String inspectContainer(String containerId) {
         return u("containers/%s/json", containerId)
                 .build();
     }
-    
+
     public String listContainers(int limit) {
         return u("containers/json")
                 .p("limit", limit)
                 .build();
     }
 
+    public String listAllContainers() {
+        return u("containers/json")
+                .p("all", 0)
+                .build();
+    }
+
     public String pullImage(ImageName name, String registry) {
         return u("images/create")
                 .p("fromImage", name.getNameWithoutTag(registry))

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

@@ -188,7 +188,7 @@ public void stopContainer(String containerId, int killWait) throws DockerAccessE
 
     @Override
     public void buildImage(String image, File dockerArchive, String dockerfileName, boolean forceRemove, boolean noCache,
-                           Map<String, String> buildArgs) throws DockerAccessException {
+            Map<String, String> buildArgs) throws DockerAccessException {
         try {
             String url = urlBuilder.buildImage(image, dockerfileName, forceRemove, noCache, buildArgs);
             delegate.post(url, dockerArchive, createBuildResponseHandler(), HTTP_OK);
@@ -198,7 +198,7 @@ public void buildImage(String image, File dockerArchive, String dockerfileName,
     }
 
     @Override
-    public void copyArchive(String containerId,File archive, String targetPath)
+    public void copyArchive(String containerId, File archive, String targetPath)
             throws DockerAccessException {
         try {
             String url = urlBuilder.copyArchive(containerId, targetPath);
@@ -235,7 +235,7 @@ public Container inspectContainer(String containerId) throws DockerAccessExcepti
 
     @Override
     public List<Container> listContainers(int limit) throws DockerAccessException {
-        String url = urlBuilder.listContainers(limit);
+        String url = limit == 0 ? urlBuilder.listAllContainers() : urlBuilder.listContainers(limit);
 
         try {
             String response = delegate.get(url, HTTP_OK);
@@ -300,7 +300,7 @@ public void pullImage(String image, AuthConfig authConfig, String registry)
 
         try {
             delegate.post(pullUrl, null, createAuthHeader(authConfig),
-                          createPullOrPushResponseHandler(), HTTP_OK);
+                    createPullOrPushResponseHandler(), HTTP_OK);
         } catch (IOException e) {
             throw new DockerAccessException(e, "Unable to pull '%s'%s", image, (registry != null) ? " from registry '" + registry + "'" : "");
         }
@@ -314,7 +314,7 @@ public void pushImage(String image, AuthConfig authConfig, String registry)
         String temporaryImage = tagTemporaryImage(name, registry);
         try {
             delegate.post(pushUrl, null, createAuthHeader(authConfig),
-                          createPullOrPushResponseHandler(), HTTP_OK);
+                    createPullOrPushResponseHandler(), HTTP_OK);
         } catch (IOException e) {
             throw new DockerAccessException(e, "Unable to push '%s'%s", image, (registry != null) ? " from registry '" + registry + "'" : "");
         } finally {
@@ -334,7 +334,7 @@ public void tag(String sourceImage, String targetImage, boolean force)
             delegate.post(url, HTTP_CREATED);
         } catch (IOException e) {
             throw new DockerAccessException(e, "Unable to add tag [%s] to image [%s]", targetImage,
-                                            sourceImage, e);
+                    sourceImage, e);
         }
     }
 

src/main/java/io/fabric8/maven/docker/config/RunImageConfiguration.java

@@ -109,15 +109,18 @@ public class RunImageConfiguration {
     @Parameter
     private WaitConfiguration wait;
 
+    @Parameter
+    private Integer fetchLimit;
+
     @Parameter
     private LogConfiguration log;
-    
+
     @Parameter
     private RestartPolicy restartPolicy;
 
     @Parameter
     private boolean skip = false;
-    
+
     public RunImageConfiguration() { }
 
     public String initAndValidate() {
@@ -197,6 +200,10 @@ public WaitConfiguration getWaitConfiguration() {
         return wait;
     }
 
+    public Integer getFetchLimit() {
+        return fetchLimit;
+    }
+
     public LogConfiguration getLogConfiguration() {
         return log;
     }
@@ -224,7 +231,7 @@ public List<String> getDnsSearch() {
     public List<String> getExtraHosts() {
         return extraHosts;
     }
-    
+
     public VolumeConfiguration getVolumeConfiguration() {
         return volumes;
     }
@@ -248,7 +255,7 @@ public enum NamingStrategy {
     public NamingStrategy getNamingStrategy() {
         return namingStrategy == null ? NamingStrategy.none : namingStrategy;
     }
-    
+
     public Boolean getPrivileged() {
         return privileged;
     }
@@ -260,7 +267,7 @@ public RestartPolicy getRestartPolicy() {
     public boolean skip() {
         return skip;
     }
-    
+
     // ======================================================================================
 
     public static class Builder {
@@ -387,12 +394,16 @@ public Builder wait(WaitConfiguration wait) {
             return this;
         }
 
+        public Builder fetchLimit(Integer fetchLimit) {
+            config.fetchLimit = fetchLimit;
+            return this;
+        }
+
         public Builder log(LogConfiguration log) {
             config.log = log;
             return this;
         }
 
-
         public Builder namingStrategy(String namingStrategy) {
             config.namingStrategy = namingStrategy == null ?
                     NamingStrategy.none :

src/main/java/io/fabric8/maven/docker/config/handler/property/ConfigKey.java

@@ -1,5 +1,5 @@
 package io.fabric8.maven.docker.config.handler.property;/*
- * 
+ *
  * Copyright 2014 Roland Huss
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
@@ -15,8 +15,6 @@
  * limitations under the License.
  */
 
-import static io.fabric8.maven.docker.assembly.DockerFileKeyword.WORKDIR;
-
 /**
  * Enum holding possible configuration keys
  *
@@ -51,6 +49,7 @@ public enum ConfigKey {
     ENV,
     ENV_PROPERTY_FILE,
     EXTRA_HOSTS,
+    FETCH_LIMIT,
     FROM,
     HOSTNAME,
     LABELS,

src/main/java/io/fabric8/maven/docker/config/handler/property/PropertyConfigHandler.java

@@ -1,5 +1,5 @@
 package io.fabric8.maven.docker.config.handler.property;/*
- * 
+ *
  * Copyright 2014 Roland Huss
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
@@ -40,14 +40,14 @@ public String getType() {
     @Override
     public List<ImageConfiguration> resolve(ImageConfiguration config, Properties properties) throws IllegalArgumentException {
         String prefix = getPrefix(config);
-        
+
         RunImageConfiguration run = extractRunConfiguration(prefix,properties);
         BuildImageConfiguration build = extractBuildConfiguration(prefix,properties);
         WatchImageConfiguration watch = extractWatchConfig(prefix, properties);
 
         String name = extractName(prefix, properties);
         String alias = withPrefix(prefix, ALIAS, properties);
-        
+
         return Collections.singletonList(
                 new ImageConfiguration.Builder()
                         .name(name)
@@ -85,7 +85,7 @@ private BuildImageConfiguration extractBuildConfiguration(String prefix, Propert
     }
 
     private RunImageConfiguration extractRunConfiguration(String prefix, Properties properties) {
-
+        
         return new RunImageConfiguration.Builder()
                 .capAdd(listWithPrefix(prefix, CAP_ADD, properties))
                 .capDrop(listWithPrefix(prefix, CAP_DROP, properties))
@@ -113,14 +113,15 @@ private RunImageConfiguration extractRunConfiguration(String prefix, Properties
                 .workingDir(withPrefix(prefix, WORKING_DIR, properties))
                 .log(extractLogConfig(prefix,properties))
                 .wait(extractWaitConfig(prefix, properties))
+                .fetchLimit(intWithPrefix(prefix, FETCH_LIMIT, properties))
                 .volumes(extractVolumeConfig(prefix, properties))
                 .skip(withPrefix(prefix, SKIP_RUN, properties))
                 .build();
     }
 
     private AssemblyConfiguration extractAssembly(String prefix, Properties properties) {
         return new AssemblyConfiguration.Builder()
-                .basedir(withPrefix(prefix, ASSEMBLY_BASEDIR, properties))        
+                .basedir(withPrefix(prefix, ASSEMBLY_BASEDIR, properties))
                 .descriptor(withPrefix(prefix, ASSEMBLY_DESCRIPTOR, properties))
                 .descriptorRef(withPrefix(prefix, ASSEMBLY_DESCRIPTOR_REF, properties))
                 .dockerFileDir(withPrefix(prefix, ASSEMBLY_DOCKER_FILE_DIR, properties))
@@ -130,15 +131,15 @@ private AssemblyConfiguration extractAssembly(String prefix, Properties properti
                 .mode(withPrefix(prefix, ASSEMBLY_MODE, properties))
                 .build();
     }
-    
+
     private String extractName(String prefix, Properties properties) throws IllegalArgumentException {
         String name = withPrefix(prefix, NAME, properties);
         if (name == null) {
             throw new IllegalArgumentException(String.format("Mandatory property [%s] is not defined", NAME));
         }
         return name;
     }
-    
+
     // Extract only the values of the port mapping
     private List<String> extractPortValues(String prefix, Properties properties) {
         List<String> ret = new ArrayList<>();
@@ -204,7 +205,7 @@ private WaitConfiguration extractWaitConfig(String prefix, Properties properties
                 .tcpPorts(asIntList(listWithPrefix(prefix, WAIT_TCP_PORT, properties)))
                 .build();
     }
-    
+
     private WatchImageConfiguration extractWatchConfig(String prefix, Properties properties) {
         return new WatchImageConfiguration.Builder()
                 .interval(asInt(withPrefix(prefix, WATCH_INTERVAL, properties)))
@@ -219,7 +220,7 @@ private VolumeConfiguration extractVolumeConfig(String prefix, Properties proper
                 .from(listWithPrefix(prefix, VOLUMES_FROM, properties))
                 .build();
     }
-  
+
     private int asInt(String s) {
         return s != null ? Integer.parseInt(s) : 0;
     }
@@ -241,11 +242,11 @@ private List<Integer> asIntList(List<String> strings) {
     private List<String> listWithPrefix(String prefix, ConfigKey key, Properties properties) {
         return extractFromPropertiesAsList(key.asPropertyKey(prefix), properties);
     }
-   
+
     private Map<String, String> mapWithPrefix(String prefix, ConfigKey key, Properties properties) {
         return extractFromPropertiesAsMap(key.asPropertyKey(prefix), properties);
     }
-        
+
     private String withPrefix(String prefix, ConfigKey key, Properties properties) {
         return properties.getProperty(key.asPropertyKey(prefix));
     }
@@ -255,6 +256,11 @@ private Long longWithPrefix(String prefix, ConfigKey key, Properties properties)
         return prop == null ? null : Long.valueOf(prop);
     }
 
+    private Integer intWithPrefix(String prefix, ConfigKey key, Properties properties) {
+        String prop = withPrefix(prefix, key, properties);
+        return prop == null ? null : Integer.valueOf(prop);
+    }
+
     private Boolean booleanWithPrefix(String prefix, ConfigKey key, Properties properties) {
         String prop = withPrefix(prefix,key,properties);
         return prop == null ? null : Boolean.valueOf(prop);