Skip to content

Implement container rename api #504

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

Closed
lujian0571 wants to merge 4 commits into from
Closed

Implement container rename api #504

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
faf0be8
RenameContainer
lujian0571 Mar 17, 2016
8046e45
RenameContainer
lujian0571 Mar 17, 2016
5c5ed1b
RenameContainer test
lujian0571 Mar 17, 2016
8a16070
remove same notes
lujian0571 Mar 17, 2016
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
3 changes: 3 additions & 0 deletions src/main/java/com/github/dockerjava/api/DockerClient.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -56,6 +56,7 @@
import com.github.dockerjava.api.command.UpdateContainerCmd;
import com.github.dockerjava.api.command.VersionCmd;
import com.github.dockerjava.api.command.WaitContainerCmd;
import com.github.dockerjava.api.command.RenameContainerCmd;
import com.github.dockerjava.api.exception.DockerException;
import com.github.dockerjava.api.model.AuthConfig;
import com.github.dockerjava.api.model.Identifier;
Expand Down Expand Up @@ -185,6 +186,8 @@ public interface DockerClient extends Closeable {
*/
UpdateContainerCmd updateContainerCmd(@Nonnull String containerId);

RenameContainerCmd renameContainerCmd(@Nonnull String containerId);

RestartContainerCmd restartContainerCmd(@Nonnull String containerId);

CommitCmd commitCmd(@Nonnull String containerId);
Expand Down
2 changes: 2 additions & 0 deletions src/main/java/com/github/dockerjava/api/command/DockerCmdExecFactory.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -71,6 +71,8 @@ public interface DockerCmdExecFactory extends Closeable {

UpdateContainerCmd.Exec createUpdateContainerCmdExec();

RenameContainerCmd.Exec createRenameContainerCmdExec();

RestartContainerCmd.Exec createRestartContainerCmdExec();

CommitCmd.Exec createCommitCmdExec();
Expand Down
35 changes: 35 additions & 0 deletions src/main/java/com/github/dockerjava/api/command/RenameContainerCmd.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
package com.github.dockerjava.api.command;

import com.github.dockerjava.api.exception.NotFoundException;
import com.github.dockerjava.core.RemoteApiVersion;

import javax.annotation.CheckForNull;
import javax.annotation.Nonnull;

/**
* rename a container.
Copy link
Copy Markdown
Member

@KostyaSha KostyaSha Mar 17, 2016

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please start with capital letter :)

*
* @since {@link RemoteApiVersion#VERSION_1_22}
*/
public interface RenameContainerCmd extends SyncDockerCmd<Void> {

@CheckForNull
String getContainerId();

RenameContainerCmd withContainerId(@Nonnull String containerId);

@CheckForNull
String getName();

RenameContainerCmd withName(@Nonnull String name);


/**
* @throws com.github.dockerjava.api.exception.NotFoundException No such container
*/
@Override
Void exec() throws NotFoundException;

interface Exec extends DockerCmdSyncExec<RenameContainerCmd, Void> {
}
}
7 changes: 7 additions & 0 deletions src/main/java/com/github/dockerjava/core/DockerClientImpl.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -58,6 +58,7 @@
import com.github.dockerjava.api.command.UpdateContainerCmd;
import com.github.dockerjava.api.command.VersionCmd;
import com.github.dockerjava.api.command.WaitContainerCmd;
import com.github.dockerjava.api.command.RenameContainerCmd;
import com.github.dockerjava.api.model.AuthConfig;
import com.github.dockerjava.api.model.Identifier;
import com.github.dockerjava.core.command.AttachContainerCmdImpl;
Expand Down Expand Up @@ -109,6 +110,7 @@
import com.github.dockerjava.core.command.UpdateContainerCmdImpl;
import com.github.dockerjava.core.command.VersionCmdImpl;
import com.github.dockerjava.core.command.WaitContainerCmdImpl;
import com.github.dockerjava.core.command.RenameContainerCmdImpl;

import javax.annotation.Nonnull;

Expand Down Expand Up @@ -364,6 +366,11 @@ public UpdateContainerCmd updateContainerCmd(@Nonnull String containerId) {
return new UpdateContainerCmdImpl(getDockerCmdExecFactory().createUpdateContainerCmdExec(), containerId);
}

@Override
public RenameContainerCmd renameContainerCmd(@Nonnull String containerId) {
return new RenameContainerCmdImpl(getDockerCmdExecFactory().createRenameContainerCmdExec(), containerId);
}

@Override
public RestartContainerCmd restartContainerCmd(String containerId) {
return new RestartContainerCmdImpl(getDockerCmdExecFactory().createRestartContainerCmdExec(), containerId);
Expand Down
55 changes: 55 additions & 0 deletions src/main/java/com/github/dockerjava/core/command/RenameContainerCmdImpl.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,55 @@
package com.github.dockerjava.core.command;

import com.github.dockerjava.api.command.RenameContainerCmd;
import com.github.dockerjava.api.exception.NotFoundException;

import javax.annotation.Nonnull;
import static com.google.common.base.Preconditions.checkNotNull;

/**
* rename a container.
*/
public class RenameContainerCmdImpl extends AbstrDockerCmd<RenameContainerCmd, Void> implements RenameContainerCmd {
Copy link
Copy Markdown
Member

@KostyaSha KostyaSha Mar 17, 2016

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

one space between


private String containerId;

private String name;

public RenameContainerCmdImpl(RenameContainerCmd.Exec exec, String containerId) {
super(exec);
withContainerId(containerId);
}

@Override
public String getContainerId() {
return containerId;
}

@Override
public String getName() {
return name;
}

@Override
public RenameContainerCmd withContainerId(String containerId) {
checkNotNull(containerId, "containerId was not specified");
this.containerId = containerId;
return this;
}

@Override
public RenameContainerCmd withName(@Nonnull String name) {
checkNotNull(name, "name was not specified");
this.name = name;
return this;
}

/**
* @throws NotFoundException
* No such container
*/
@Override
public Void exec() throws NotFoundException {
return super.exec();
}
}
6 changes: 6 additions & 0 deletions src/main/java/com/github/dockerjava/jaxrs/DockerCmdExecFactoryImpl.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -80,6 +80,7 @@
import com.github.dockerjava.api.command.UnpauseContainerCmd;
import com.github.dockerjava.api.command.VersionCmd;
import com.github.dockerjava.api.command.WaitContainerCmd;
import com.github.dockerjava.api.command.RenameContainerCmd;
import com.github.dockerjava.api.exception.DockerClientException;
import com.github.dockerjava.core.DockerClientConfig;
import com.github.dockerjava.core.LocalDirectorySSLConfig;
Expand Down Expand Up @@ -417,6 +418,11 @@ public UpdateContainerCmd.Exec createUpdateContainerCmdExec() {
return new UpdateContainerCmdExec(getBaseResource(), getDockerClientConfig());
}

@Override
public RenameContainerCmd.Exec createRenameContainerCmdExec() {
return new RenameContainerCmdExec(getBaseResource(), getDockerClientConfig());
}

@Override
public RestartContainerCmd.Exec createRestartContainerCmdExec() {
return new RestartContainerCmdExec(getBaseResource(), getDockerClientConfig());
Expand Down
31 changes: 31 additions & 0 deletions src/main/java/com/github/dockerjava/jaxrs/RenameContainerCmdExec.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
package com.github.dockerjava.jaxrs;

import javax.ws.rs.client.WebTarget;
import javax.ws.rs.core.MediaType;

import com.github.dockerjava.api.command.RenameContainerCmd;
import com.github.dockerjava.core.DockerClientConfig;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

public class RenameContainerCmdExec extends AbstrSyncDockerCmdExec<RenameContainerCmd, Void> implements RenameContainerCmd.Exec {

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

public RenameContainerCmdExec(WebTarget baseResource, DockerClientConfig dockerClientConfig) {
super(baseResource, dockerClientConfig);
}

@Override
protected Void execute(RenameContainerCmd command) {
WebTarget webResource = getBaseResource().path("/containers/{id}/rename").resolveTemplate("id", command.getContainerId())
.queryParam("name", command.getName());


LOGGER.trace("POST: {}", webResource);
webResource.request().accept(MediaType.APPLICATION_JSON).post(null);

return null;
}

}
7 changes: 7 additions & 0 deletions src/main/java/com/github/dockerjava/netty/DockerCmdExecFactoryImpl.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50,6 +50,7 @@
import com.github.dockerjava.api.command.UpdateContainerCmd;
import com.github.dockerjava.api.command.VersionCmd;
import com.github.dockerjava.api.command.WaitContainerCmd;
import com.github.dockerjava.api.command.RenameContainerCmd;
import com.github.dockerjava.core.DockerClientConfig;
import com.github.dockerjava.core.DockerClientImpl;
import com.github.dockerjava.core.LocalDirectorySSLConfig;
Expand Down Expand Up @@ -102,6 +103,7 @@
import com.github.dockerjava.netty.exec.UpdateContainerCmdExec;
import com.github.dockerjava.netty.exec.VersionCmdExec;
import com.github.dockerjava.netty.exec.WaitContainerCmdExec;
import com.github.dockerjava.netty.exec.RenameContainerCmdExec;

import io.netty.bootstrap.Bootstrap;
import io.netty.channel.ChannelInitializer;
Expand Down Expand Up @@ -465,6 +467,11 @@ public UpdateContainerCmd.Exec createUpdateContainerCmdExec() {
return new UpdateContainerCmdExec(getBaseResource(), getDockerClientConfig());
}

@Override
public RenameContainerCmd.Exec createRenameContainerCmdExec() {
return new RenameContainerCmdExec(getBaseResource(), getDockerClientConfig());
}

@Override
public RestartContainerCmd.Exec createRestartContainerCmdExec() {
return new RestartContainerCmdExec(getBaseResource(), getDockerClientConfig());
Expand Down
31 changes: 31 additions & 0 deletions src/main/java/com/github/dockerjava/netty/exec/RenameContainerCmdExec.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
package com.github.dockerjava.netty.exec;

import com.github.dockerjava.api.command.RenameContainerCmd;
import com.github.dockerjava.core.DockerClientConfig;
import com.github.dockerjava.netty.MediaType;
import com.github.dockerjava.netty.WebTarget;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

/**
* rename a container.
*/
public class RenameContainerCmdExec extends AbstrSyncDockerCmdExec<RenameContainerCmd, Void> implements RenameContainerCmd.Exec {
Copy link
Copy Markdown
Member

@KostyaSha KostyaSha Mar 17, 2016

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Could you try wrote javadoc in interface and check that it inherited by default to classes? (in IDEA just check javadoc on this class)


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

public RenameContainerCmdExec(WebTarget baseResource, DockerClientConfig dockerClientConfig) {
super(baseResource, dockerClientConfig);
}

@Override
protected Void execute(RenameContainerCmd command) {
WebTarget webResource = getBaseResource().path("/containers/{id}/rename").resolveTemplate("id", command.getContainerId())
.queryParam("name", command.getName());

LOGGER.trace("POST: {}", webResource);
webResource.request().accept(MediaType.APPLICATION_JSON).post(null);

return null;
}
}
5 changes: 5 additions & 0 deletions src/test/java/com/github/dockerjava/core/TestDockerCmdExecFactory.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -240,6 +240,11 @@ public UpdateContainerCmd.Exec createUpdateContainerCmdExec() {
return delegate.createUpdateContainerCmdExec();
}

@Override
public RenameContainerCmd.Exec createRenameContainerCmdExec(){
return delegate.createRenameContainerCmdExec();
}

@Override
public RestartContainerCmd.Exec createRestartContainerCmdExec() {
return delegate.createRestartContainerCmdExec();
Expand Down
72 changes: 72 additions & 0 deletions src/test/java/com/github/dockerjava/core/command/RenameContainerCmdImplTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,72 @@
package com.github.dockerjava.core.command;

import com.github.dockerjava.api.command.CreateContainerResponse;
import com.github.dockerjava.api.command.InspectContainerResponse;
import com.github.dockerjava.api.exception.DockerException;
import com.github.dockerjava.api.exception.NotFoundException;
import com.github.dockerjava.client.AbstractDockerClientTest;
import org.testng.ITestResult;
import org.testng.annotations.*;

import java.lang.reflect.Method;

import static org.hamcrest.MatcherAssert.assertThat;
import static org.hamcrest.Matchers.*;

@Test(groups = "integration")
public class RenameContainerCmdImplTest extends AbstractDockerClientTest {
@BeforeTest
public void beforeTest() throws Exception {
super.beforeTest();
}

@AfterTest
public void afterTest() {
super.afterTest();
}

@BeforeMethod
public void beforeMethod(Method method) {
super.beforeMethod(method);
}

@AfterMethod
public void afterMethod(ITestResult result) {
super.afterMethod(result);
}

@Test
public void renameContainer() throws DockerException {

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

InspectContainerResponse inspectContainerResponse = dockerClient.inspectContainerCmd(container.getId()).exec();
LOG.info("Container Inspect: {}", inspectContainerResponse.toString());

String name1 = inspectContainerResponse.getName();

dockerClient.renameContainerCmd(container.getId()).withName(String.valueOf(System.currentTimeMillis())+String.valueOf(System.nanoTime())).exec();

InspectContainerResponse inspectContainerResponse2 = dockerClient.inspectContainerCmd(container.getId()).exec();
LOG.info("Container Inspect After Rename: {}", inspectContainerResponse2.toString());

String name2 = inspectContainerResponse2.getName();

assertNotEquals(name1, name2);

dockerClient.killContainerCmd(container.getId()).exec();
}

@Test
public void renameExistingContainer() throws DockerException, InterruptedException {
try {
dockerClient.renameContainerCmd("non-existing").withName(String.valueOf(System.currentTimeMillis())+String.valueOf(System.nanoTime())).exec();
fail("expected NotFoundException");
} catch (NotFoundException e) {
}

}
}
Loading