org.testcontainers.utility

Class DockerStatus

java.lang.Object

org.testcontainers.utility.DockerStatus

public class DockerStatus
extends Object

Utility functions for dealing with docker status based on the information available to us, and trying to be defensive.

In docker-java version 2.2.0, which we're using, only these fields are available in the container state returned from Docker Inspect: "isRunning", "isPaused", "startedAt", and "finishedAt". There are states that can occur (including "created", "OOMkilled" and "dead") that aren't directly shown through this result.

Docker also doesn't seem to use null values for timestamps; see DOCKER_TIMESTAMP_ZERO, below.

Constructor Summary

Constructors

Constructor and Description
DockerStatus()

Method Summary

Modifier and Type	Method and Description
static boolean	isContainerExitCodeSuccess(com.github.dockerjava.api.command.InspectContainerResponse.ContainerState state)
static boolean	isContainerRunning(com.github.dockerjava.api.command.InspectContainerResponse.ContainerState state, Duration minimumRunningDuration, Instant now) Based on this status, is this container running, and has it been doing so for the specified amount of time?
static boolean	isContainerStopped(com.github.dockerjava.api.command.InspectContainerResponse.ContainerState state) Based on this status, has the container halted?
static boolean	isDockerTimestampNonEmpty(String dockerTimestamp)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DockerStatus

public DockerStatus()

Method Detail

isContainerRunning

public static boolean isContainerRunning(com.github.dockerjava.api.command.InspectContainerResponse.ContainerState state,
                                         Duration minimumRunningDuration,
                                         Instant now)

Based on this status, is this container running, and has it been doing so for the specified amount of time?

Parameters:

state - the state provided by InspectContainer

minimumRunningDuration - minimum duration to consider this as "solidly" running, or null

now - the time to consider as the current time

Returns:

true if we can conclude that the container is running, false otherwise

isContainerStopped

public static boolean isContainerStopped(com.github.dockerjava.api.command.InspectContainerResponse.ContainerState state)

Based on this status, has the container halted?

Parameters:

state - the state provided by InspectContainer

Returns:

true if we can conclude that the container has started but is now stopped, false otherwise.

isDockerTimestampNonEmpty

public static boolean isDockerTimestampNonEmpty(String dockerTimestamp)

isContainerExitCodeSuccess

public static boolean isContainerExitCodeSuccess(com.github.dockerjava.api.command.InspectContainerResponse.ContainerState state)