Skip to content

Add ability to add labels when running commit #795

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
KostyaSha merged 1 commit into from
Feb 14, 2017
Merged

Add ability to add labels when running commit #795

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
10 changes: 10 additions & 0 deletions src/main/java/com/github/dockerjava/api/command/CommitCmd.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,8 @@
import javax.annotation.CheckForNull;
import javax.annotation.Nonnull;

import java.util.Map;

import com.github.dockerjava.api.exception.NotFoundException;
import com.github.dockerjava.api.model.ExposedPorts;
import com.github.dockerjava.api.model.Volumes;
Expand All @@ -29,6 +31,9 @@ public interface CommitCmd extends SyncDockerCmd<String> {
@CheckForNull
String getHostname();

@CheckForNull
Map<String, String> getLabels();

@CheckForNull
Integer getMemory();

Expand Down Expand Up @@ -88,6 +93,11 @@ public interface CommitCmd extends SyncDockerCmd<String> {

CommitCmd withHostname(String hostname);

/**
* @since 1.19
*/
CommitCmd withLabels(Map<String, String> labels);

CommitCmd withMemory(Integer memory);

CommitCmd withMemorySwap(Integer memorySwap);
Expand Down
19 changes: 19 additions & 0 deletions src/main/java/com/github/dockerjava/core/command/CommitCmdImpl.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@

import static com.google.common.base.Preconditions.checkNotNull;

import java.util.Map;

import com.fasterxml.jackson.annotation.JsonProperty;
import com.github.dockerjava.api.command.CommitCmd;
import com.github.dockerjava.api.exception.NotFoundException;
Expand Down Expand Up @@ -43,6 +45,12 @@ public class CommitCmdImpl extends AbstrDockerCmd<CommitCmd, String> implements
@JsonProperty("Hostname")
private String hostname;

/**
* @since 1.19
*/
@JsonProperty("Labels")
private Map<String, String> labels;

@JsonProperty("Memory")
private Integer memory;

Expand Down Expand Up @@ -189,6 +197,17 @@ public CommitCmdImpl withEnv(String... env) {
return this;
}

@Override
public Map<String, String> getLabels() {
return labels;
}

@Override
public CommitCmdImpl withLabels(Map<String, String> labels) {
this.labels = labels;
return this;
}

@Override
public ExposedPorts getExposedPorts() {
return exposedPorts;
Expand Down
24 changes: 23 additions & 1 deletion src/test/java/com/github/dockerjava/core/command/CommitCmdImplTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,9 @@
import static org.testinfected.hamcrest.jpa.HasFieldWithValue.hasField;

import java.lang.reflect.Method;
import java.util.Map;

import com.google.common.collect.ImmutableMap;
import org.testng.ITestResult;
import org.testng.annotations.AfterMethod;
import org.testng.annotations.AfterTest;
Expand Down Expand Up @@ -54,7 +56,7 @@ public void commit() throws DockerException {
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();

InspectImageResponse inspectImageResponse = dockerClient.inspectImageCmd(imageId).exec();
Expand All @@ -68,6 +70,26 @@ public void commit() throws DockerException {
assertThat(inspectImageResponse.getParent(), equalTo(busyboxImg.getId()));
}

@Test
public void commitWithLabels() throws DockerException {

CreateContainerResponse container = dockerClient.createContainerCmd("busybox").withCmd("touch", "/test").exec();

LOG.info("Created container: {}", container.toString());
assertThat(container.getId(), not(isEmptyString()));
dockerClient.startContainerCmd(container.getId()).exec();

LOG.info("Committing container: {}", container.toString());
Map<String, String> labels = ImmutableMap.of("label1", "abc", "label2", "123");
String imageId = dockerClient.commitCmd(container.getId()).withLabels(labels).exec();

InspectImageResponse inspectImageResponse = dockerClient.inspectImageCmd(imageId).exec();
LOG.info("Image Inspect: {}", inspectImageResponse.toString());
Map<String, String> responseLabels = inspectImageResponse.getContainerConfig().getLabels();
assertThat(responseLabels.get("label1"), equalTo("abc"));
assertThat(responseLabels.get("label2"), equalTo("123"));
}

@Test(expectedExceptions = NotFoundException.class)
public void commitNonExistingContainer() throws DockerException {

Expand Down
24 changes: 23 additions & 1 deletion src/test/java/com/github/dockerjava/netty/exec/CommitCmdExecTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,9 @@
import static org.testinfected.hamcrest.jpa.HasFieldWithValue.hasField;

import java.lang.reflect.Method;
import java.util.Map;

import com.google.common.collect.ImmutableMap;
import org.testng.ITestResult;
import org.testng.annotations.AfterMethod;
import org.testng.annotations.AfterTest;
Expand Down Expand Up @@ -54,7 +56,7 @@ public void commit() throws DockerException {
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();

InspectImageResponse inspectImageResponse = dockerClient.inspectImageCmd(imageId).exec();
Expand All @@ -68,6 +70,26 @@ public void commit() throws DockerException {
assertThat(inspectImageResponse.getParent(), equalTo(busyboxImg.getId()));
}

@Test
public void commitWithLabels() throws DockerException {

CreateContainerResponse container = dockerClient.createContainerCmd("busybox").withCmd("touch", "/test").exec();

LOG.info("Created container: {}", container.toString());
assertThat(container.getId(), not(isEmptyString()));
dockerClient.startContainerCmd(container.getId()).exec();

LOG.info("Committing container: {}", container.toString());
Map<String, String> labels = ImmutableMap.of("label1", "abc", "label2", "123");
String imageId = dockerClient.commitCmd(container.getId()).withLabels(labels).exec();

InspectImageResponse inspectImageResponse = dockerClient.inspectImageCmd(imageId).exec();
LOG.info("Image Inspect: {}", inspectImageResponse.toString());
Map<String, String> responseLabels = inspectImageResponse.getContainerConfig().getLabels();
assertThat(responseLabels.get("label1"), equalTo("abc"));
assertThat(responseLabels.get("label2"), equalTo("123"));
}

@Test(expectedExceptions = NotFoundException.class)
public void commitNonExistingContainer() throws DockerException {

Expand Down