Package org.apache.maven.plugin.surefire.extensions.timeout

Class JstackTimeoutExtension

java.lang.Object

org.apache.maven.plugin.surefire.extensions.timeout.JstackTimeoutExtension

All Implemented Interfaces:

ForkedProcessTimeoutExtension

public class JstackTimeoutExtension
extends Object
implements ForkedProcessTimeoutExtension

Built-in ForkedProcessTimeoutExtension that captures a jstack thread dump of the forked test JVM just before it is killed because of forkedProcessTimeoutInSeconds.

The output is written to <reportsDirectory>/surefire-timeout-jstack-<forkNumber>-<pid>.txt.

Activation: this extension is registered via META-INF/services but is disabled by default. To enable it set the system property surefire.timeout.jstack.enabled=true on the Maven process (for example with MAVEN_OPTS or -Dsurefire.timeout.jstack.enabled=true). The jstack binary is resolved from ${java.home}/bin/jstack, the parent JDK bin (Java 8 layout), $JAVA_HOME/bin/jstack, and finally from PATH.

Since:

3.6.0

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ENABLED_KEY	Extension-context key that enables this extension from the POM via the forkedProcessTimeoutExtensionContext Mojo parameter.
static final String	ENABLED_PROPERTY	System property that enables this extension.
static final String	OUTPUT_LOCATION_KEY	Extension context key that overrides the directory where the surefire-timeout-jstack-*.txt files are written.

Constructor Summary

Constructors

Constructor	Description
JstackTimeoutExtension()

Method Summary

Modifier and Type	Method	Description
void	onForkExited(ForkedProcessTimeoutContext context, RunResult runResult)
void	onTimeoutDetected(ForkedProcessTimeoutContext context)

Methods inherited from class java.lang.Object

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

Field Details

ENABLED_PROPERTY

public static final String ENABLED_PROPERTY

System property that enables this extension.

See Also:

• Constant Field Values

ENABLED_KEY

public static final String ENABLED_KEY

Extension-context key that enables this extension from the POM via the forkedProcessTimeoutExtensionContext Mojo parameter. Set to true to enable. When either this key or ENABLED_PROPERTY is set to true, the extension runs.

See Also:

• Constant Field Values

OUTPUT_LOCATION_KEY

public static final String OUTPUT_LOCATION_KEY

Extension context key that overrides the directory where the surefire-timeout-jstack-*.txt files are written. When the key is missing or blank, the Surefire reports directory is used.

See Also:

• Constant Field Values

Constructor Details

JstackTimeoutExtension

public JstackTimeoutExtension()

Method Details

onTimeoutDetected

public void onTimeoutDetected(ForkedProcessTimeoutContext context)

Specified by:

onTimeoutDetected in interface ForkedProcessTimeoutExtension

onForkExited

public void onForkExited(ForkedProcessTimeoutContext context,
 RunResult runResult)

Specified by:

onForkExited in interface ForkedProcessTimeoutExtension