Skip to content

list filtered images as described in the remote api docs #101

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
marcuslinke merged 1 commit into from
Nov 24, 2014
Merged

list filtered images as described in the remote api docs #101

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions src/main/java/com/github/dockerjava/api/command/ListImagesCmd.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,18 +8,18 @@
* List images
*
* @param showAll - Show all images (by default filter out the intermediate images used to build)
* @param filter - TODO: undocumented in docker remote api reference
* @param filters - a json encoded value of the filters (a map[string][]string) to process on the images list.
*/
public interface ListImagesCmd extends DockerCmd<List<Image>> {

public String getFilter();
public String getFilters();

public boolean hasShowAllEnabled();

public ListImagesCmd withShowAll(boolean showAll);

public ListImagesCmd withFilter(String filter);
public ListImagesCmd withFilters(String filters);

public static interface Exec extends DockerCmdExec<ListImagesCmd, List<Image>> {
}

Expand Down
20 changes: 10 additions & 10 deletions src/main/java/com/github/dockerjava/core/command/ListImagesCmdImpl.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,21 +11,21 @@
* List images
*
* @param showAll - Show all images (by default filter out the intermediate images used to build)
* @param filter - TODO: undocumented in docker remote api reference
* @param filters - a json encoded value of the filters (a map[string][]string) to process on the images list.
*/
public class ListImagesCmdImpl extends AbstrDockerCmd<ListImagesCmd, List<Image>> implements ListImagesCmd {

private String filter;
private String filters;

private boolean showAll = false;

public ListImagesCmdImpl(ListImagesCmd.Exec exec) {
super(exec);
}

@Override
public String getFilter() {
return filter;
public String getFilters() {
return filters;
}

@Override
Expand All @@ -40,17 +40,17 @@ public ListImagesCmd withShowAll(boolean showAll) {
}

@Override
public ListImagesCmd withFilter(String filter) {
Preconditions.checkNotNull(filter, "filter was not specified");
this.filter = filter;
public ListImagesCmd withFilters(String filter) {
Preconditions.checkNotNull(filter, "filters have not been specified");
this.filters = filter;
return this;
}

@Override
public String toString() {
return new StringBuilder("images ")
.append(showAll ? "--all=true" : "")
.append(filter != null ? "--filter " + filter : "")
.append(filters != null ? "--filter " + filters : "")
.toString();
}
}
19 changes: 12 additions & 7 deletions src/main/java/com/github/dockerjava/jaxrs/ListImagesCmdExec.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,16 +6,19 @@
import javax.ws.rs.core.GenericType;
import javax.ws.rs.core.MediaType;

import com.google.common.net.UrlEscapers;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

import com.github.dockerjava.api.command.ListImagesCmd;
import com.github.dockerjava.api.model.Image;

import static com.google.common.net.UrlEscapers.urlPathSegmentEscaper;

public class ListImagesCmdExec extends AbstrDockerCmdExec<ListImagesCmd, List<Image>> implements ListImagesCmd.Exec {

private static final Logger LOGGER = LoggerFactory.getLogger(ListImagesCmdExec.class);

public ListImagesCmdExec(WebTarget baseResource) {
super(baseResource);
}
Expand All @@ -24,15 +27,17 @@ public ListImagesCmdExec(WebTarget baseResource) {
protected List<Image> execute(ListImagesCmd command) {
WebTarget webResource = getBaseResource()
.path("/images/json")
.queryParam("filter", command.getFilter())
.queryParam("filters", urlPathSegmentEscaper().escape(command.getFilters()))
.queryParam("all", command.hasShowAllEnabled() ? "1" : "0");

LOGGER.trace("GET: {}", webResource);

List<Image> images = webResource.request().accept(MediaType.APPLICATION_JSON).get(new GenericType<List<Image>>() {
});

List<Image> images = webResource.request()
.accept(MediaType.APPLICATION_JSON)
.get(new GenericType<List<Image>>() {
});
LOGGER.trace("Response: {}", images);

return images;
}

Expand Down
22 changes: 11 additions & 11 deletions src/test/java/com/github/dockerjava/client/AbstractDockerClientTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@
import java.net.ServerSocket;

public abstract class AbstractDockerClientTest extends Assert {

public static final Logger LOG = LoggerFactory
.getLogger(AbstractDockerClientTest.class);
public static final String DOCKER_JAVA = "dockerjava";
Expand All @@ -39,8 +39,8 @@ public void beforeTest() {
LOG.info("Pulling image 'busybox'");
// need to block until image is pulled completely
asString(dockerClient.pullImageCmd("busybox").withTag("latest").exec());



assertNotNull(dockerClient);
LOG.info("======================= END OF BEFORETEST =======================\n\n");
Expand Down Expand Up @@ -75,7 +75,7 @@ public void afterMethod(ITestResult result) {

for (String container : dockerCmdExecFactory.getContainerNames()) {
LOG.info("Cleaning up temporary container {}", container);

try {
dockerClient.removeContainerCmd(container).withForce().exec();
} catch (DockerException ignore) {
Expand All @@ -90,17 +90,17 @@ public void afterMethod(ITestResult result) {
} catch (DockerException ignore) {
ignore.printStackTrace();
}
}
}

LOG.info(
"################################## END OF {} ##################################\n",
result.getName());
}

protected String asString(InputStream response) {

StringWriter logwriter = new StringWriter();

try {
LineIterator itr = IOUtils.lineIterator(
response, "UTF-8");
Expand All @@ -110,20 +110,20 @@ protected String asString(InputStream response) {
logwriter.write(line + (itr.hasNext() ? "\n" : ""));
//LOG.info("line: "+line);
}

return logwriter.toString();
} catch (IOException e) {
throw new RuntimeException(e);
} finally {
IOUtils.closeQuietly(response);
}
}

// UTIL

/**
* Checks to see if a specific port is available.
*
*
* @param port
* the port to check for availability
*/
Expand Down
42 changes: 40 additions & 2 deletions src/test/java/com/github/dockerjava/core/command/ListImagesCmdImplTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@
import java.lang.reflect.Method;
import java.util.List;

import com.github.dockerjava.api.command.CreateContainerResponse;
import org.testng.ITestResult;
import org.testng.annotations.AfterMethod;
import org.testng.annotations.AfterTest;
Expand All @@ -25,7 +26,7 @@ public class ListImagesCmdImplTest extends AbstractDockerClientTest {
public void beforeTest() throws DockerException {
super.beforeTest();
}

@AfterTest
public void afterTest() {
super.afterTest();
Expand All @@ -40,7 +41,7 @@ public void beforeMethod(Method method) {
public void afterMethod(ITestResult result) {
super.afterMethod(result);
}

@Test
public void listImages() throws DockerException {
List<Image> images = dockerClient.listImagesCmd().withShowAll(true).exec();
Expand All @@ -57,5 +58,42 @@ public void listImages() throws DockerException {
assertThat(img.getRepoTags(), not(emptyArray()));
}

@Test
public void listDanglingImages() throws DockerException {
String imageId = createDanglingImage();
List<Image> images = dockerClient.listImagesCmd()
.withFilters("{\"dangling\":[\"true\"]}")
.withShowAll(true).exec();
assertThat(images, notNullValue());
LOG.info("Images List: {}", images);
assertThat(images.size(), is(greaterThan(0)));
boolean imageInFilteredList = isImageInFilteredList(images, imageId);
assertTrue(imageInFilteredList);
}

private boolean isImageInFilteredList(List<Image> images, String expectedImageId) {
for (Image image : images) {
if (expectedImageId.equals(image.getId())) {
return true;
}
}
return false;
}

private String createDanglingImage() {
CreateContainerResponse container = dockerClient
.createContainerCmd("busybox").withCmd("sleep", "5").exec();
LOG.info("Created container: {}", container.toString());
assertThat(container.getId(), not(isEmptyString()));
dockerClient.startContainerCmd(container.getId()).exec();

LOG.info("Committing container {}", container.toString());
String imageId = dockerClient
.commitCmd(container.getId()).exec();

dockerClient.stopContainerCmd(container.getId()).exec();
dockerClient.killContainerCmd(container.getId()).exec();
dockerClient.removeContainerCmd(container.getId()).exec();
return imageId;
}
}
8 changes: 4 additions & 4 deletions src/test/java/com/github/dockerjava/core/command/RemoveImageCmdImplTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -59,11 +59,11 @@ public void removeImage() throws DockerException, InterruptedException {
LOG.info("Created container: {}", container.toString());
assertThat(container.getId(), not(isEmptyString()));
dockerClient.startContainerCmd(container.getId()).exec();
LOG.info("Commiting container {}", container.toString());

LOG.info("Committing container {}", container.toString());
String imageId = dockerClient
.commitCmd(container.getId()).exec();

dockerClient.stopContainerCmd(container.getId()).exec();
dockerClient.killContainerCmd(container.getId()).exec();
dockerClient.removeContainerCmd(container.getId()).exec();
Expand All @@ -72,7 +72,7 @@ public void removeImage() throws DockerException, InterruptedException {
dockerClient.removeImageCmd(imageId).exec();

List<Container> containers = dockerClient.listContainersCmd().withShowAll(true).exec();

Matcher matcher = not(hasItem(hasField("id", startsWith(imageId))));
assertThat(containers, matcher);
}
Expand Down