Use special DockerCmdExecFactory in tests to realize automatic

Marcus Linke · Marcus Linke · commit 0815e2fc7bf8 · 2014-09-13T21:23:51.000+02:00
image/container cleanup.
diff --git a/src/main/java/com/github/dockerjava/jaxrs/DockerCmdExecFactoryImpl.java b/src/main/java/com/github/dockerjava/jaxrs/DockerCmdExecFactoryImpl.java
@@ -87,7 +87,7 @@ public void init(DockerClientConfig dockerClientConfig) {
 		
 	}
 	
-	private WebTarget getBaseResource() {
+	protected WebTarget getBaseResource() {
 		Preconditions.checkNotNull(baseResource, "Factory not initialized. You probably forgot to call init()!");
 		return baseResource;
 	}
diff --git a/src/test/java/com/github/dockerjava/client/AbstractDockerClientTest.java b/src/test/java/com/github/dockerjava/client/AbstractDockerClientTest.java
@@ -4,6 +4,7 @@
 import com.github.dockerjava.api.DockerException;
 import com.github.dockerjava.core.DockerClientImpl;
 import com.github.dockerjava.jaxrs.DockerClientBuilder;
+import com.github.dockerjava.jaxrs.TestDockerCmdExecFactory;
 
 import org.apache.commons.io.IOUtils;
 import org.apache.commons.io.LineIterator;
@@ -28,14 +29,17 @@ public abstract class AbstractDockerClientTest extends Assert {
 	
 	protected DockerClient dockerClient;
 
-	protected List<String> tmpImgs;
-	protected List<String> tmpContainers;
+//	protected List<String> tmpImgs;
+//	protected List<String> tmpContainers;
 
+	private TestDockerCmdExecFactory dockerCmdExecFactory = new TestDockerCmdExecFactory();
 
 	public void beforeTest()  {
 		LOG.info("======================= BEFORETEST =======================");
 		LOG.info("Connecting to Docker server");
-		dockerClient = DockerClientBuilder.getInstance().build();
+		dockerClient = DockerClientBuilder.getInstance()
+				.withDockerCmdExecFactory(dockerCmdExecFactory)
+				.build();
 
 		LOG.info("Pulling image 'busybox'");
 		// need to block until image is pulled completely
@@ -53,16 +57,16 @@ public void afterTest() {
 
 
 	public void beforeMethod(Method method) {
-	        tmpContainers = new ArrayList<String>();
-	        tmpImgs = new ArrayList<String>();
+//	        tmpContainers = new ArrayList<String>();
+//	        tmpImgs = new ArrayList<String>();
 		LOG.info(String
 				.format("################################## STARTING %s ##################################",
 						method.getName()));
 	}
 
 	public void afterMethod(ITestResult result) {
 
-		for (String container : tmpContainers) {
+		for (String container : dockerCmdExecFactory.getContainerIds()) {
 			LOG.info("Cleaning up temporary container {}", container);
 			try {
 				dockerClient.stopContainerCmd(container).exec();
@@ -78,7 +82,7 @@ public void afterMethod(ITestResult result) {
 			}
 		}
 
-		for (String image : tmpImgs) {
+		for (String image : dockerCmdExecFactory.getImagesIds()) {
 			LOG.info("Cleaning up temporary image {}", image);
 			try {
 				dockerClient.removeImageCmd(image).exec();
diff --git a/src/test/java/com/github/dockerjava/client/DockerClientTest.java b/src/test/java/com/github/dockerjava/client/DockerClientTest.java
@@ -62,7 +62,7 @@ public void testRunShlex() throws DockerException {
 			CreateContainerResponse container = dockerClient
 					.createContainerCmd("busybox").withCmd(commands).exec();
 			dockerClient.startContainerCmd(container.getId());
-			tmpContainers.add(container.getId());
+			
 			int exitcode = dockerClient.waitContainerCmd(container.getId()).exec();
 			assertThat(exitcode, equalTo(0));
 		}
diff --git a/src/test/java/com/github/dockerjava/core/command/BuildImageCmdImplTest.java b/src/test/java/com/github/dockerjava/core/command/BuildImageCmdImplTest.java
@@ -69,7 +69,7 @@ public void testNginxDockerfileBuilder() {
 				.inspectImageCmd(imageId).exec();
 		assertThat(inspectImageResponse, not(nullValue()));
 		LOG.info("Image Inspect: {}", inspectImageResponse.toString());
-		tmpImgs.add(inspectImageResponse.getId());
+		//tmpImgs.add(inspectImageResponse.getId());
 
 		assertThat(inspectImageResponse.getAuthor(),
 				equalTo("Guillaume J. Charmes \"guillaume@dotcloud.com\""));
@@ -120,7 +120,7 @@ private String dockerfileBuild(File baseDir, String expectedText) {
 		dockerClient.startContainerCmd(container.getId()).exec();
 		dockerClient.waitContainerCmd(container.getId()).exec();
 
-		tmpContainers.add(container.getId());
+		//tmpContainers.add(container.getId());
 
 		// Log container
 		InputStream logResponse = logContainer(container
@@ -155,13 +155,13 @@ public void testNetCatDockerfileBuilder() throws InterruptedException {
 		assertThat(inspectImageResponse, not(nullValue()));
 		assertThat(inspectImageResponse.getId(), not(nullValue()));
 		LOG.info("Image Inspect: {}", inspectImageResponse.toString());
-		tmpImgs.add(inspectImageResponse.getId());
+		//tmpImgs.add(inspectImageResponse.getId());
 
 		CreateContainerResponse container = dockerClient.createContainerCmd(
 				inspectImageResponse.getId()).exec();
 		assertThat(container.getId(), not(isEmptyString()));
 		dockerClient.startContainerCmd(container.getId()).exec();
-		tmpContainers.add(container.getId());
+		//tmpContainers.add(container.getId());
 
 		InspectContainerResponse inspectContainerResponse = dockerClient
 				.inspectContainerCmd(container.getId()).exec();
diff --git a/src/test/java/com/github/dockerjava/core/command/CommitCmdImplTest.java b/src/test/java/com/github/dockerjava/core/command/CommitCmdImplTest.java
@@ -52,12 +52,10 @@ public void commit() throws DockerException {
 		LOG.info("Created container: {}", container.toString());
 		assertThat(container.getId(), not(isEmptyString()));
 		dockerClient.startContainerCmd(container.getId()).exec();
-		tmpContainers.add(container.getId());
 
 		LOG.info("Commiting container: {}", container.toString());
 		String imageId = dockerClient
 				.commitCmd(container.getId()).exec();
-		tmpImgs.add(imageId);
 
 		InspectImageResponse inspectImageResponse = dockerClient
 				.inspectImageCmd(imageId).exec();
diff --git a/src/test/java/com/github/dockerjava/core/command/ContainerDiffCmdImplTest.java b/src/test/java/com/github/dockerjava/core/command/ContainerDiffCmdImplTest.java
@@ -51,7 +51,7 @@ public void testDiff() throws DockerException {
 		LOG.info("Created container: {}", container.toString());
 		assertThat(container.getId(), not(isEmptyString()));
 		dockerClient.startContainerCmd(container.getId()).exec();
-		tmpContainers.add(container.getId());
+		
 		int exitCode = dockerClient.waitContainerCmd(container.getId()).exec();
 		assertThat(exitCode, equalTo(0));
 
diff --git a/src/test/java/com/github/dockerjava/core/command/CopyFileFromContainerCmdImplTest.java b/src/test/java/com/github/dockerjava/core/command/CopyFileFromContainerCmdImplTest.java
@@ -46,7 +46,6 @@ public void copyFromContainer() throws Exception {
         assertThat(container.getId(), not(isEmptyOrNullString()));
 
         dockerClient.startContainerCmd(container.getId()).exec();
-        tmpContainers.add(container.getId());
 
         InputStream response = dockerClient.copyFileFromContainerCmd(container.getId(), "/test").exec();
         assertTrue(response.available() > 0, "The file was not copied from the container.");
diff --git a/src/test/java/com/github/dockerjava/core/command/CreateContainerCmdImplTest.java b/src/test/java/com/github/dockerjava/core/command/CreateContainerCmdImplTest.java
@@ -48,8 +48,6 @@ public void createContainerWithVolume() throws DockerException {
 		CreateContainerResponse container = dockerClient
 				.createContainerCmd("busybox").withVolumes(new Volume("/var/log")).withCmd("true").exec();
 
-		tmpContainers.add(container.getId());
-
 		LOG.info("Created container {}", container.toString());
 
 		assertThat(container.getId(), not(isEmptyString()));
@@ -59,8 +57,6 @@ public void createContainerWithVolume() throws DockerException {
 		LOG.info("Inspect container {}", inspectContainerResponse.getConfig().getVolumes());
 
 		assertThat(inspectContainerResponse.getConfig().getVolumes().keySet(), contains("/var/log"));
-
-
 	}
 
 	@Test
@@ -69,8 +65,6 @@ public void createContainerWithEnv() throws DockerException {
 		CreateContainerResponse container = dockerClient
 				.createContainerCmd("busybox").withEnv("VARIABLE=success").withCmd("env").exec();
 
-		tmpContainers.add(container.getId());
-
 		LOG.info("Created container {}", container.toString());
 
 		assertThat(container.getId(), not(isEmptyString()));
@@ -90,8 +84,6 @@ public void createContainerWithHostname() throws DockerException {
 		CreateContainerResponse container = dockerClient
 				.createContainerCmd("busybox").withHostName("docker-java").withCmd("env").exec();
 
-		tmpContainers.add(container.getId());
-
 		LOG.info("Created container {}", container.toString());
 
 		assertThat(container.getId(), not(isEmptyString()));
@@ -111,8 +103,6 @@ public void createContainerWithName() throws DockerException {
 		CreateContainerResponse container = dockerClient
 				.createContainerCmd("busybox").withName("container").withCmd("env").exec();
 
-		tmpContainers.add(container.getId());
-
 		LOG.info("Created container {}", container.toString());
 
 		assertThat(container.getId(), not(isEmptyString()));
diff --git a/src/test/java/com/github/dockerjava/core/command/InfoCmdImplTest.java b/src/test/java/com/github/dockerjava/core/command/InfoCmdImplTest.java
@@ -53,7 +53,6 @@ public void info() throws DockerException {
         assertThat(container.getId(), not(isEmptyOrNullString()));
 
         dockerClient.startContainerCmd(container.getId()).exec();
-        tmpContainers.add(container.getId());
 
         Info dockerInfo = dockerClient.infoCmd().exec();
 		LOG.info(dockerInfo.toString());
diff --git a/src/test/java/com/github/dockerjava/core/command/KillContainerCmdImplTest.java b/src/test/java/com/github/dockerjava/core/command/KillContainerCmdImplTest.java
@@ -55,7 +55,6 @@ public void testKillContainer() throws DockerException {
 		LOG.info("Created container: {}", container.toString());
 		assertThat(container.getId(), not(isEmptyString()));
 		dockerClient.startContainerCmd(container.getId()).exec();
-		tmpContainers.add(container.getId());
 
 		LOG.info("Killing container: {}", container.getId());
 		dockerClient.killContainerCmd(container.getId()).exec();
diff --git a/src/test/java/com/github/dockerjava/core/command/ListContainersCmdImplTest.java b/src/test/java/com/github/dockerjava/core/command/ListContainersCmdImplTest.java
@@ -73,9 +73,7 @@ public void testListContainers() throws DockerException {
 
 		assertThat(inspectContainerResponse.getConfig().getImage(), is(equalTo(testImage)));
 
-
 		dockerClient.startContainerCmd(container1.getId()).exec();
-		tmpContainers.add(container1.getId());
 
 		LOG.info("container id: " + container1.getId());
 
diff --git a/src/test/java/com/github/dockerjava/core/command/LogContainerCmdImplTest.java b/src/test/java/com/github/dockerjava/core/command/LogContainerCmdImplTest.java
@@ -56,8 +56,6 @@ public void logContainer() throws Exception {
 
 		dockerClient.startContainerCmd(container.getId()).exec();
 		
-		tmpContainers.add(container.getId());
-
 		int exitCode = dockerClient.waitContainerCmd(container.getId()).exec();
 
 		assertThat(exitCode, equalTo(0));
diff --git a/src/test/java/com/github/dockerjava/core/command/PullImageCmdImplTest.java b/src/test/java/com/github/dockerjava/core/command/PullImageCmdImplTest.java
@@ -70,10 +70,8 @@ public void testPullImage() throws DockerException, IOException {
 
 		LOG.info("Pulling image: {}", testImage);
 
-		tmpImgs.add(testImage);
 		InputStream response = dockerClient.pullImageCmd(testImage).exec();
 
-
 		assertThat(asString(response),
 				containsString("Download complete"));
 
diff --git a/src/test/java/com/github/dockerjava/core/command/PushImageCmdImplTest.java b/src/test/java/com/github/dockerjava/core/command/PushImageCmdImplTest.java
@@ -57,8 +57,6 @@ public void testPushLatest() throws Exception {
 
 		assertThat(container.getId(), not(isEmptyString()));
 
-		tmpContainers.add(container.getId());
-
 		LOG.info("Commiting container: {}", container.toString());
 		String imageId = dockerClient.commitCmd(container.getId()).withRepository(username + "/busybox").exec();
 
@@ -70,8 +68,6 @@ public void testPushLatest() throws Exception {
 		String response = asString(dockerClient.pullImageCmd(username + "/busybox").exec());
 
 		assertThat(response, not(containsString("HTTP code: 404")));
-
-		tmpImgs.add(username + "/busybox");
 	}
 
 	@Test
diff --git a/src/test/java/com/github/dockerjava/core/command/RemoveImageCmdImplTest.java b/src/test/java/com/github/dockerjava/core/command/RemoveImageCmdImplTest.java
@@ -57,18 +57,15 @@ public void testRemoveImage() throws DockerException, InterruptedException {
 		LOG.info("Created container: {}", container.toString());
 		assertThat(container.getId(), not(isEmptyString()));
 		dockerClient.startContainerCmd(container.getId()).exec();
-		tmpContainers.add(container.getId());
-
+		
 		LOG.info("Commiting container {}", container.toString());
 		String imageId = dockerClient
 				.commitCmd(container.getId()).exec();
-		tmpImgs.add(imageId);
-
+	
 		dockerClient.stopContainerCmd(container.getId()).exec();
 		dockerClient.killContainerCmd(container.getId()).exec();
 		dockerClient.removeContainerCmd(container.getId()).exec();
 
-		tmpContainers.remove(container.getId());
 		LOG.info("Removing image: {}", imageId);
 		dockerClient.removeImageCmd(imageId).exec();
 
diff --git a/src/test/java/com/github/dockerjava/core/command/RestartContainerCmdImplTest.java b/src/test/java/com/github/dockerjava/core/command/RestartContainerCmdImplTest.java
@@ -50,8 +50,7 @@ public void restartContainer() throws DockerException {
 		LOG.info("Created container: {}", container.toString());
 		assertThat(container.getId(), not(isEmptyString()));
 		dockerClient.startContainerCmd(container.getId()).exec();
-		tmpContainers.add(container.getId());
-
+		
 		InspectContainerResponse inspectContainerResponse = dockerClient
 				.inspectContainerCmd(container.getId()).exec();
 		LOG.info("Container Inspect: {}", inspectContainerResponse.toString());
diff --git a/src/test/java/com/github/dockerjava/core/command/StartContainerCmdImplTest.java b/src/test/java/com/github/dockerjava/core/command/StartContainerCmdImplTest.java
@@ -88,7 +88,6 @@ public void startContainerWithVolumes() throws DockerException {
 		assertThat(Arrays.asList(inspectContainerResponse.getVolumesRW()),
 				contains(volume1, volume2));
 
-		tmpContainers.add(container.getId());
 	}
 
 	@Test
@@ -116,7 +115,6 @@ public void startContainerWithDns() throws DockerException {
 		assertThat(Arrays.asList(inspectContainerResponse.getHostConfig().getDns()),
 				contains(aDnsServer, anotherDnsServer));
 
-		tmpContainers.add(container.getId());
 	}
 	
 	@Test
@@ -154,7 +152,6 @@ public void startContainerWithPortBindings() throws DockerException {
 		assertThat(inspectContainerResponse.getHostConfig().getPortBindings().getBindings().get(tcp23),
 				is(equalTo(Ports.Binding(11023))));
 
-		tmpContainers.add(container.getId());
 	}
 
 	@Test
@@ -165,8 +162,7 @@ public void startContainerWithLinking() throws DockerException {
 
 		LOG.info("Created container1 {}", container1.toString());
 		assertThat(container1.getId(), not(isEmptyString()));
-		tmpContainers.add(container1.getId());
-
+		
 		dockerClient.startContainerCmd(container1.getId()).exec();
 
 		InspectContainerResponse inspectContainerResponse1 = dockerClient
@@ -191,8 +187,7 @@ public void startContainerWithLinking() throws DockerException {
 
 		LOG.info("Created container2 {}", container2.toString());
 		assertThat(container2.getId(), not(isEmptyString()));
-		tmpContainers.add(container2.getId());
-
+		
 		dockerClient.startContainerCmd(container2.getId()).withLinks(new Link("container1", "container1Link")).exec();
 
 		InspectContainerResponse inspectContainerResponse2 = dockerClient
@@ -221,8 +216,7 @@ public void startContainer() throws DockerException {
 
 		LOG.info("Created container {}", container.toString());
 		assertThat(container.getId(), not(isEmptyString()));
-		tmpContainers.add(container.getId());
-
+		
 		dockerClient.startContainerCmd(container.getId()).exec();
 
 		InspectContainerResponse inspectContainerResponse = dockerClient
@@ -268,8 +262,6 @@ public void startContainerWithNetworkMode() throws DockerException {
 
         assertThat(container.getId(), not(isEmptyString()));
         
-        tmpContainers.add(container.getId());
-
         InspectContainerResponse inspectContainerResponse = dockerClient
                 .inspectContainerCmd(container.getId()).exec();
 
@@ -294,8 +286,6 @@ public void startContainerWithCapAddAndCapDrop() throws DockerException {
 
         assertThat(container.getId(), not(isEmptyString()));
 
-        tmpContainers.add(container.getId());
-
         dockerClient.startContainerCmd(container.getId())
         	.withCapAdd("NET_ADMIN")
         	.withCapDrop("MKNOD").exec();
@@ -323,8 +313,6 @@ public void startContainerWithDevices() throws DockerException {
 
         assertThat(container.getId(), not(isEmptyString()));
 
-        tmpContainers.add(container.getId());
-
         dockerClient.startContainerCmd(container.getId())
         	.withDevices(new Device("rwm", "/dev/nulo", "/dev/zero"))
         	.exec();
@@ -349,8 +337,6 @@ public void startContainerWithRestartPolicy() throws DockerException {
 
         assertThat(container.getId(), not(isEmptyString()));
 
-        tmpContainers.add(container.getId());
-
         RestartPolicy restartPolicy = RestartPolicy.onFailureRestart(5);
         
         dockerClient.startContainerCmd(container.getId())
diff --git a/src/test/java/com/github/dockerjava/core/command/StopContainerCmdImplTest.java b/src/test/java/com/github/dockerjava/core/command/StopContainerCmdImplTest.java
@@ -55,8 +55,7 @@ public void testStopContainer() throws DockerException {
 		LOG.info("Created container: {}", container.toString());
 		assertThat(container.getId(), not(isEmptyString()));
 		dockerClient.startContainerCmd(container.getId()).exec();
-		tmpContainers.add(container.getId());
-
+		
 		LOG.info("Stopping container: {}", container.getId());
 		dockerClient.stopContainerCmd(container.getId()).withTimeout(2).exec();
 
diff --git a/src/test/java/com/github/dockerjava/core/command/WaitContainerCmdImplTest.java b/src/test/java/com/github/dockerjava/core/command/WaitContainerCmdImplTest.java
@@ -50,8 +50,7 @@ public void testWaitContainer() throws DockerException {
 
 		LOG.info("Created container: {}", container.toString());
 		assertThat(container.getId(), not(isEmptyString()));
-		tmpContainers.add(container.getId());
-
+		
 		dockerClient.startContainerCmd(container.getId()).exec();
 
 		int exitCode = dockerClient.waitContainerCmd(container.getId()).exec();
diff --git a/src/test/java/com/github/dockerjava/jaxrs/TestDockerCmdExecFactory.java b/src/test/java/com/github/dockerjava/jaxrs/TestDockerCmdExecFactory.java

Original file line number	Diff line number	Diff line change
`@@ -87,7 +87,7 @@ public void init(DockerClientConfig dockerClientConfig) {`
`87`	`87`
`88`	`88`	`}`
`89`	`89`
`90`		`- private WebTarget getBaseResource() {`
	`90`	`+ protected WebTarget getBaseResource() {`
`91`	`91`	`Preconditions.checkNotNull(baseResource, "Factory not initialized. You probably forgot to call init()!");`
`92`	`92`	`return baseResource;`
`93`	`93`	`}`
Original file line number	Diff line number	Diff line change
`@@ -62,7 +62,7 @@ public void testRunShlex() throws DockerException {`
`62`	`62`	`CreateContainerResponse container = dockerClient`
`63`	`63`	`.createContainerCmd("busybox").withCmd(commands).exec();`
`64`	`64`	`dockerClient.startContainerCmd(container.getId());`
`65`		`- tmpContainers.add(container.getId());`
	`65`	`+`
`66`	`66`	`int exitcode = dockerClient.waitContainerCmd(container.getId()).exec();`
`67`	`67`	`assertThat(exitcode, equalTo(0));`
`68`	`68`	`}`