Skip to content

Commit 7e6173d

Browse files
patelritKostyaSha
patelrit
authored and
KostyaSha
committed
Add missing properties for InspectContainerResponse.Status
- add missing fields 1.22 - replace isXX to getXX for objects - annotated everything
1 parent e032730 commit 7e6173d

File tree

7 files changed

+150
-22
lines changed

7 files changed

+150
-22
lines changed

‎src/main/java/com/github/dockerjava/api/command/InspectContainerResponse.java‎

Lines changed: 130 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@
33
import java.util.List;
44
import java.util.Map;
55

6+
import com.github.dockerjava.core.RemoteApiVersion;
67
import org.apache.commons.lang.builder.ToStringBuilder;
78

89
import com.fasterxml.jackson.annotation.JsonIgnore;
@@ -16,6 +17,8 @@
1617
import com.github.dockerjava.api.model.VolumeRW;
1718
import com.github.dockerjava.api.model.VolumesRW;
1819

20+
import javax.annotation.CheckForNull;
21+
1922
/**
2023
*
2124
* @author Konstantin Pelykh (kpelykh@gmail.com)
@@ -225,44 +228,169 @@ public String toString() {
225228
@JsonIgnoreProperties(ignoreUnknown = true)
226229
public class ContainerState {
227230

231+
/**
232+
* @since {@link RemoteApiVersion#VERSION_1_20}
233+
*/
234+
@CheckForNull
235+
@JsonProperty("Status")
236+
private String status;
237+
238+
/**
239+
* @since < {@link RemoteApiVersion#VERSION_1_16}
240+
*/
241+
@CheckForNull
228242
@JsonProperty("Running")
229243
private Boolean running;
230244

245+
/**
246+
* @since {@link RemoteApiVersion#VERSION_1_17}
247+
*/
248+
@CheckForNull
231249
@JsonProperty("Paused")
232250
private Boolean paused;
233251

252+
/**
253+
* @since {@link RemoteApiVersion#VERSION_1_17}
254+
*/
255+
@CheckForNull
256+
@JsonProperty("Restarting")
257+
private Boolean restarting;
258+
259+
/**
260+
* @since {@link RemoteApiVersion#VERSION_1_17}
261+
*/
262+
@CheckForNull
263+
@JsonProperty("OOMKilled")
264+
private Boolean oomKilled;
265+
266+
/**
267+
* <a href="https://github.com/docker/docker/pull/18127">Unclear</a>
268+
* @since {@link RemoteApiVersion#UNKNOWN_VERSION}
269+
*/
270+
@CheckForNull
271+
@JsonProperty("Dead")
272+
private Boolean dead;
273+
274+
/**
275+
* @since < {@link RemoteApiVersion#VERSION_1_16}
276+
*/
277+
@CheckForNull
234278
@JsonProperty("Pid")
235279
private Integer pid;
236280

281+
/**
282+
* @since < {@link RemoteApiVersion#VERSION_1_16}
283+
*/
284+
@CheckForNull
237285
@JsonProperty("ExitCode")
238286
private Integer exitCode;
239287

288+
/**
289+
* @since {@link RemoteApiVersion#VERSION_1_17}
290+
*/
291+
@CheckForNull
292+
@JsonProperty("Error")
293+
private String error;
294+
295+
/**
296+
* @since < {@link RemoteApiVersion#VERSION_1_16}
297+
*/
298+
@CheckForNull
240299
@JsonProperty("StartedAt")
241300
private String startedAt;
242301

302+
/**
303+
* @since {@link RemoteApiVersion#VERSION_1_17}
304+
*/
305+
@CheckForNull
243306
@JsonProperty("FinishedAt")
244307
private String finishedAt;
245308

246-
public Boolean isRunning() {
309+
310+
/**
311+
* See {@link #status}
312+
*/
313+
@CheckForNull
314+
public String getStatus() {
315+
return status;
316+
}
317+
318+
/**
319+
* See {@link #running}
320+
*/
321+
@CheckForNull
322+
public Boolean getRunning() {
247323
return running;
248324
}
249325

250-
public Boolean isPaused() {
326+
/**
327+
* See {@link #paused}
328+
*/
329+
@CheckForNull
330+
public Boolean getPaused() {
251331
return paused;
252332
}
253333

334+
/**
335+
* See {@link #restarting}
336+
*/
337+
@CheckForNull
338+
public Boolean getRestarting() {
339+
return restarting;
340+
}
341+
342+
/**
343+
* See {@link #oomKilled}
344+
*/
345+
@CheckForNull
346+
public Boolean getOOMKilled() {
347+
return oomKilled;
348+
}
349+
350+
/**
351+
* See {@link #dead}
352+
*/
353+
@CheckForNull
354+
public Boolean getDead() {
355+
return dead;
356+
}
357+
358+
/**
359+
* See {@link #pid}
360+
*/
361+
@CheckForNull
254362
public Integer getPid() {
255363
return pid;
256364
}
257365

366+
/**
367+
* See {@link #exitCode}
368+
*/
369+
@CheckForNull
258370
public Integer getExitCode() {
259371
return exitCode;
260372
}
261373

374+
/**
375+
* See {@link #error}
376+
*/
377+
@CheckForNull
378+
public String getError() {
379+
return error;
380+
}
381+
382+
/**
383+
* See {@link #startedAt}
384+
*/
385+
@CheckForNull
262386
public String getStartedAt() {
263387
return startedAt;
264388
}
265389

390+
/**
391+
* See {@link #finishedAt}
392+
*/
393+
@CheckForNull
266394
public String getFinishedAt() {
267395
return finishedAt;
268396
}

‎src/test/java/com/github/dockerjava/core/command/CreateContainerCmdImplTest.java‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -253,7 +253,7 @@ public void createContainerWithLink() throws DockerException {
253253
InspectContainerResponse inspectContainerResponse1 = dockerClient.inspectContainerCmd(container1.getId())
254254
.exec();
255255
LOG.info("Container1 Inspect: {}", inspectContainerResponse1.toString());
256-
assertThat(inspectContainerResponse1.getState().isRunning(), is(true));
256+
assertThat(inspectContainerResponse1.getState().getRunning(), is(true));
257257

258258
CreateContainerResponse container2 = dockerClient.createContainerCmd("busybox").withName("container2")
259259
.withCmd("env").withLinks(new Link("container1", "container1Link")).exec();
@@ -406,9 +406,9 @@ public void createContainerWithLinking() throws DockerException {
406406
assertThat(inspectContainerResponse1.getName(), equalTo("/container1"));
407407
assertThat(inspectContainerResponse1.getImageId(), not(isEmptyString()));
408408
assertThat(inspectContainerResponse1.getState(), is(notNullValue()));
409-
assertThat(inspectContainerResponse1.getState().isRunning(), is(true));
409+
assertThat(inspectContainerResponse1.getState().getRunning(), is(true));
410410

411-
if (!inspectContainerResponse1.getState().isRunning()) {
411+
if (!inspectContainerResponse1.getState().getRunning()) {
412412
assertThat(inspectContainerResponse1.getState().getExitCode(), is(equalTo(0)));
413413
}
414414

‎src/test/java/com/github/dockerjava/core/command/KillContainerCmdImplTest.java‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -62,7 +62,7 @@ public void killContainer() throws DockerException {
6262
InspectContainerResponse inspectContainerResponse = dockerClient.inspectContainerCmd(container.getId()).exec();
6363
LOG.info("Container Inspect: {}", inspectContainerResponse.toString());
6464

65-
assertThat(inspectContainerResponse.getState().isRunning(), is(equalTo(false)));
65+
assertThat(inspectContainerResponse.getState().getRunning(), is(equalTo(false)));
6666
assertThat(inspectContainerResponse.getState().getExitCode(), not(equalTo(0)));
6767

6868
}

‎src/test/java/com/github/dockerjava/core/command/RestartContainerCmdImplTest.java‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -66,7 +66,7 @@ public void restartContainer() throws DockerException {
6666

6767
assertThat(startTime, not(equalTo(startTime2)));
6868

69-
assertThat(inspectContainerResponse.getState().isRunning(), is(equalTo(true)));
69+
assertThat(inspectContainerResponse.getState().getRunning(), is(equalTo(true)));
7070

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

‎src/test/java/com/github/dockerjava/core/command/StartContainerCmdImplTest.java‎

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -289,9 +289,9 @@ public void startContainerWithLinkingDeprecated() throws DockerException {
289289
assertThat(inspectContainerResponse1.getName(), equalTo("/container1"));
290290
assertThat(inspectContainerResponse1.getImageId(), not(isEmptyString()));
291291
assertThat(inspectContainerResponse1.getState(), is(notNullValue()));
292-
assertThat(inspectContainerResponse1.getState().isRunning(), is(true));
292+
assertThat(inspectContainerResponse1.getState().getRunning(), is(true));
293293

294-
if (!inspectContainerResponse1.getState().isRunning()) {
294+
if (!inspectContainerResponse1.getState().getRunning()) {
295295
assertThat(inspectContainerResponse1.getState().getExitCode(), is(equalTo(0)));
296296
}
297297

@@ -317,7 +317,7 @@ public void startContainerWithLinkingDeprecated() throws DockerException {
317317
assertThat(inspectContainerResponse2.getName(), equalTo("/container2"));
318318
assertThat(inspectContainerResponse2.getImageId(), not(isEmptyString()));
319319
assertThat(inspectContainerResponse2.getState(), is(notNullValue()));
320-
assertThat(inspectContainerResponse2.getState().isRunning(), is(true));
320+
assertThat(inspectContainerResponse2.getState().getRunning(), is(true));
321321

322322
}
323323

@@ -342,9 +342,9 @@ public void startContainerWithLinking() throws DockerException {
342342
assertThat(inspectContainerResponse1.getName(), equalTo("/container1"));
343343
assertThat(inspectContainerResponse1.getImageId(), not(isEmptyString()));
344344
assertThat(inspectContainerResponse1.getState(), is(notNullValue()));
345-
assertThat(inspectContainerResponse1.getState().isRunning(), is(true));
345+
assertThat(inspectContainerResponse1.getState().getRunning(), is(true));
346346

347-
if (!inspectContainerResponse1.getState().isRunning()) {
347+
if (!inspectContainerResponse1.getState().getRunning()) {
348348
assertThat(inspectContainerResponse1.getState().getExitCode(), is(equalTo(0)));
349349
}
350350

@@ -370,7 +370,7 @@ public void startContainerWithLinking() throws DockerException {
370370
assertThat(inspectContainerResponse2.getName(), equalTo("/container2"));
371371
assertThat(inspectContainerResponse2.getImageId(), not(isEmptyString()));
372372
assertThat(inspectContainerResponse2.getState(), is(notNullValue()));
373-
assertThat(inspectContainerResponse2.getState().isRunning(), is(true));
373+
assertThat(inspectContainerResponse2.getState().getRunning(), is(true));
374374

375375
}
376376

@@ -396,9 +396,9 @@ public void startContainer() throws DockerException {
396396
assertThat(inspectContainerResponse.getImageId(), not(isEmptyString()));
397397
assertThat(inspectContainerResponse.getState(), is(notNullValue()));
398398

399-
assertThat(inspectContainerResponse.getState().isRunning(), is(true));
399+
assertThat(inspectContainerResponse.getState().getRunning(), is(true));
400400

401-
if (!inspectContainerResponse.getState().isRunning()) {
401+
if (!inspectContainerResponse.getState().getRunning()) {
402402
assertThat(inspectContainerResponse.getState().getExitCode(), is(equalTo(0)));
403403
}
404404
}
@@ -452,7 +452,7 @@ public void startContainerWithCapAddAndCapDrop() throws DockerException {
452452

453453
InspectContainerResponse inspectContainerResponse = dockerClient.inspectContainerCmd(container.getId()).exec();
454454

455-
assertThat(inspectContainerResponse.getState().isRunning(), is(true));
455+
assertThat(inspectContainerResponse.getState().getRunning(), is(true));
456456

457457
assertThat(Arrays.asList(inspectContainerResponse.getHostConfig().getCapAdd()), contains(NET_ADMIN));
458458

@@ -473,7 +473,7 @@ public void startContainerWithDevices() throws DockerException {
473473

474474
InspectContainerResponse inspectContainerResponse = dockerClient.inspectContainerCmd(container.getId()).exec();
475475

476-
assertThat(inspectContainerResponse.getState().isRunning(), is(true));
476+
assertThat(inspectContainerResponse.getState().getRunning(), is(true));
477477

478478
assertThat(Arrays.asList(inspectContainerResponse.getHostConfig().getDevices()), contains(new Device("rwm",
479479
"/dev/nulo", "/dev/zero")));
@@ -493,7 +493,7 @@ public void startContainerWithExtraHosts() throws DockerException {
493493

494494
InspectContainerResponse inspectContainerResponse = dockerClient.inspectContainerCmd(container.getId()).exec();
495495

496-
assertThat(inspectContainerResponse.getState().isRunning(), is(true));
496+
assertThat(inspectContainerResponse.getState().getRunning(), is(true));
497497

498498
assertThat(Arrays.asList(inspectContainerResponse.getHostConfig().getExtraHosts()),
499499
contains("dockerhost:127.0.0.1"));
@@ -515,7 +515,7 @@ public void startContainerWithRestartPolicy() throws DockerException {
515515

516516
InspectContainerResponse inspectContainerResponse = dockerClient.inspectContainerCmd(container.getId()).exec();
517517

518-
assertThat(inspectContainerResponse.getState().isRunning(), is(true));
518+
assertThat(inspectContainerResponse.getState().getRunning(), is(true));
519519

520520
assertThat(inspectContainerResponse.getHostConfig().getRestartPolicy(), is(equalTo(restartPolicy)));
521521
}

‎src/test/java/com/github/dockerjava/core/command/StopContainerCmdImplTest.java‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -62,7 +62,7 @@ public void testStopContainer() throws DockerException {
6262
InspectContainerResponse inspectContainerResponse = dockerClient.inspectContainerCmd(container.getId()).exec();
6363
LOG.info("Container Inspect: {}", inspectContainerResponse.toString());
6464

65-
assertThat(inspectContainerResponse.getState().isRunning(), is(equalTo(false)));
65+
assertThat(inspectContainerResponse.getState().getRunning(), is(equalTo(false)));
6666
assertThat(inspectContainerResponse.getState().getExitCode(), not(equalTo(0)));
6767
}
6868

‎src/test/java/com/github/dockerjava/core/command/WaitContainerCmdImplTest.java‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -64,7 +64,7 @@ public void testWaitContainer() throws DockerException {
6464
InspectContainerResponse inspectContainerResponse = dockerClient.inspectContainerCmd(container.getId()).exec();
6565
LOG.info("Container Inspect: {}", inspectContainerResponse.toString());
6666

67-
assertThat(inspectContainerResponse.getState().isRunning(), is(equalTo(false)));
67+
assertThat(inspectContainerResponse.getState().getRunning(), is(equalTo(false)));
6868
assertThat(inspectContainerResponse.getState().getExitCode(), is(equalTo(exitCode)));
6969
}
7070

@@ -102,6 +102,6 @@ public void testWaitContainerAbort() throws Exception {
102102
InspectContainerResponse inspectContainerResponse = dockerClient.inspectContainerCmd(container.getId()).exec();
103103
LOG.info("Container Inspect: {}", inspectContainerResponse.toString());
104104

105-
assertThat(inspectContainerResponse.getState().isRunning(), is(equalTo(false)));
105+
assertThat(inspectContainerResponse.getState().getRunning(), is(equalTo(false)));
106106
}
107107
}

0 commit comments

Comments
 (0)