org.microbean.helm.maven

Class TestReleaseMojo

java.lang.Object

org.apache.maven.plugin.AbstractMojo

org.microbean.helm.maven.AbstractHelmMojo

org.microbean.helm.maven.AbstractReleaseMojo

org.microbean.helm.maven.AbstractSingleReleaseMojo

org.microbean.helm.maven.TestReleaseMojo

All Implemented Interfaces:

ContextEnabled, Mojo

@Mojo(name="test")
public class TestReleaseMojo
extends AbstractSingleReleaseMojo

Runs tests against a Helm release.

Author:

Laird Nelson

Field Summary

Fields inherited from interface org.apache.maven.plugin.Mojo

ROLE

Constructor Summary

Constructors

Constructor and Description
TestReleaseMojo() Creates a new TestReleaseMojo.

Method Summary

Modifier and Type	Method and Description
void	addReleaseTestListener(ReleaseTestListener listener) Adds a ReleaseTestListener that will be notified when the tests complete.
protected void	execute(Callable<ReleaseManager> releaseManagerCallable) Performs a release-oriented task using a ReleaseManager available from the supplied Callable.
boolean	getCleanup() Returns true if test Pods should be deleted after the tests complete.
ReleaseTestListener[]	getReleaseTestListeners() Invokes the getReleaseTestListenersList() method and converts its return value to an array.
List<ReleaseTestListener>	getReleaseTestListenersList() Returns the List of ReleaseTestListeners whose elements will be notified when the tests complete.
long	getTimeout() Returns the timeout value, in seconds, for Kubernetes operations.
void	removeReleaseTestListener(ReleaseTestListener listener) Removes a ReleaseTestListener from this TestReleaseMojo.
void	setCleanup(boolean cleanup) Sets whether test Pods should be deleted after the tests complete.
void	setReleaseTestListenersList(List<ReleaseTestListener> releaseTestListeners) Installs the List of ReleaseTestListeners whose elements will be notified when the tests complete.
void	setTimeout(long timeout) Sets the timeout value, in seconds, for Kubernetes operations.

Methods inherited from class org.microbean.helm.maven.AbstractSingleReleaseMojo

getReleaseName, setReleaseName, validateReleaseName

Methods inherited from class org.microbean.helm.maven.AbstractReleaseMojo

createClient, createReleaseManager, createTiller, execute, getClientConfiguration, getSkip, getTillerLabels, getTillerNamespace, getTillerPort, setClientConfiguration, setSkip, setTillerLabels, setTillerNamespace, setTillerPort, validateNamespace

Methods inherited from class org.apache.maven.plugin.AbstractMojo

getLog, getPluginContext, setLog, setPluginContext

Methods inherited from class java.lang.Object

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

Constructor Detail

TestReleaseMojo

public TestReleaseMojo()

Creates a new TestReleaseMojo.

Method Detail

execute

protected void execute(Callable<ReleaseManager> releaseManagerCallable)
                throws Exception

Performs a release-oriented task using a ReleaseManager available from the supplied Callable.

This implementation runs tests against a release.

Specified by:

execute in class AbstractReleaseMojo

Parameters:

releaseManagerCallable - the Callable that will provide a ReleaseManager; must not be null

Throws:

Exception - if an error occurs

getCleanup

public boolean getCleanup()

Returns true if test Pods should be deleted after the tests complete.

Returns:

true if test Pods should be deleted after the tests complete; false otherwise

See Also:

setCleanup(boolean)

setCleanup

public void setCleanup(boolean cleanup)

Sets whether test Pods should be deleted after the tests complete.

Parameters:

cleanup - if true, test Pods will be deleted after the tests complete

See Also:

getCleanup()

getTimeout

public long getTimeout()

Returns the timeout value, in seconds, for Kubernetes operations.

Returns:

the timeout value, in seconds, for Kubernetes operations

See Also:

setTimeout(long)

setTimeout

public void setTimeout(long timeout)

Sets the timeout value, in seconds, for Kubernetes operations.

Parameters:

timeout - the timeout value, in seconds, for Kubernetes operations

See Also:

getTimeout()

addReleaseTestListener

public void addReleaseTestListener(ReleaseTestListener listener)

Adds a ReleaseTestListener that will be notified when the tests complete.

Parameters:

listener - the ReleaseTestListener to add; may be null in which case no action will be taken

See Also:

removeReleaseTestListener(ReleaseTestListener), getReleaseTestListenersList()

removeReleaseTestListener

public void removeReleaseTestListener(ReleaseTestListener listener)

Removes a ReleaseTestListener from this TestReleaseMojo.

Parameters:

listener - the ReleaseTestListener to remove; may be null in which case no action will be taken

See Also:

addReleaseTestListener(ReleaseTestListener), getReleaseTestListenersList()

getReleaseTestListeners

public ReleaseTestListener[] getReleaseTestListeners()

Invokes the getReleaseTestListenersList() method and converts its return value to an array.

This method never returns null.

Overrides of this method must not return null.

Returns:

a non-null array of ReleaseTestListeners

See Also:

getReleaseTestListenersList()

getReleaseTestListenersList

public List<ReleaseTestListener> getReleaseTestListenersList()

Returns the List of ReleaseTestListeners whose elements will be notified when the tests complete.

This method may return null.

Overrides of this method are permitted to return null.

Returns:

a List of ReleaseTestListeners, or null

See Also:

setReleaseTestListenersList(List), addReleaseTestListener(ReleaseTestListener), removeReleaseTestListener(ReleaseTestListener)

setReleaseTestListenersList

public void setReleaseTestListenersList(List<ReleaseTestListener> releaseTestListeners)

Installs the List of ReleaseTestListeners whose elements will be notified when the tests complete.

Parameters:

releaseTestListeners - the List of ReleaseTestListeners whose elements will be notified when the tests complete; may be null

See Also:

getReleaseTestListenersList(), addReleaseTestListener(ReleaseTestListener), removeReleaseTestListener(ReleaseTestListener)