Package io.github.pod4dev.java.service

Class KubePlayer

java.lang.Object

io.github.pod4dev.java.service.KubePlayer

All Implemented Interfaces:

GenericContainer, AutoCloseable

public class KubePlayer
extends Object
implements GenericContainer

Work with /kube/play API.

Constructor Summary

Constructors

Constructor	Description
KubePlayer(String yamlPath)	Creates player with specified path for k8s YAML specification.

Method Summary

Modifier and Type	Method	Description
PodmanClient	getClient()	Get API client.
Integer	getMappedPort(String serviceName, Integer exposedPort)	Getting mapped port for the given service's name and exposed port.
boolean	isRunning()	Check if service is running.
void	start()	Creates the pod or container and immediately starts it.
void	stop()	Stops the pod or container with clearing created volumes.
KubePlayer	withCleanup(boolean doCleanup)	Do resources cleanup after stopping.
KubePlayer	withExposedService(String serviceName, Integer exposedPort)	Specify service and its port for expose.
KubePlayer	withRemoveVolumes(boolean doRemoveVolumes)	Do volumes cleanup after stopping.

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.github.pod4dev.java.core.GenericContainer

close, getMappedHost

Constructor Details

KubePlayer

public KubePlayer(String yamlPath)
           throws PodmanException

Creates player with specified path for k8s YAML specification. The socket path is autodetected via PODMAN_HOST environment variable.

Parameters:

yamlPath - path to k8s YAML specification.

Throws:

PodmanException - if yamlPath is empty or error during initialization is happened.

Method Details

getClient

public PodmanClient getClient()

Description copied from interface: GenericContainer

Get API client.

Specified by:

getClient in interface GenericContainer

Returns:

API client.

isRunning

public boolean isRunning()

Description copied from interface: GenericContainer

Check if service is running.

Specified by:

isRunning in interface GenericContainer

Returns:

check result.

withExposedService

public KubePlayer withExposedService(String serviceName,
 Integer exposedPort)
                              throws PodmanException

Description copied from interface: GenericContainer

Specify service and its port for expose.

Specified by:

withExposedService in interface GenericContainer

Parameters:

serviceName - name of service to expose.

exposedPort - port to expose.

Returns:

container with exposed services.

Throws:

PodmanException

withCleanup

public KubePlayer withCleanup(boolean doCleanup)

Description copied from interface: GenericContainer

Do resources cleanup after stopping.

Specified by:

withCleanup in interface GenericContainer

Parameters:

doCleanup - default is true.

Returns:

customised container.

withRemoveVolumes

public KubePlayer withRemoveVolumes(boolean doRemoveVolumes)

Description copied from interface: GenericContainer

Do volumes cleanup after stopping.

Specified by:

withRemoveVolumes in interface GenericContainer

Parameters:

doRemoveVolumes - default is true.

Returns:

customised container.

start

public void start()
           throws PodmanException

Description copied from interface: GenericContainer

Creates the pod or container and immediately starts it. All created resources will be cleared out when a SIGTERM is received or pods exit.

Specified by:

start in interface GenericContainer

Throws:

PodmanException

stop

public void stop()
          throws PodmanException

Description copied from interface: GenericContainer

Stops the pod or container with clearing created volumes.

Specified by:

stop in interface GenericContainer

Throws:

PodmanException

getMappedPort

public Integer getMappedPort(String serviceName,
 Integer exposedPort)
                      throws PodmanException

Description copied from interface: GenericContainer

Getting mapped port for the given service's name and exposed port.

Specified by:

getMappedPort in interface GenericContainer

Parameters:

serviceName - the service name.

exposedPort - the exposed port.

Returns:

mapped host.

Throws:

PodmanException