Package rife.bld.extension

Class JUnitReporterOperation

java.lang.Object

rife.bld.operations.AbstractOperation<JUnitReporterOperation>

rife.bld.extension.JUnitReporterOperation

@NullMarked
public class JUnitReporterOperation
extends AbstractOperation<JUnitReporterOperation>

An operation that parses JUnit XML reports and prints test failure information grouped by test class.

Usage:

 @BuildCommand(summary = "Runs the JUnit reporter")
 public void reporter() throws Exception {
     new JUnitReporterOperation()
             .fromProject(this)
             .failOnSummary(true)
             .reportFile("build/test-results/test/TEST-junit-jupiter.xml")
             .execute();
 }
 

Arguments:

When configured via fromProject(BaseProject), the following arguments are consumed:

• --all - Print full details for all failed tests
• --index=N[.M] - Print details for test N, or parameterized subtest N.M

If no argument is provided and failures exist, a summary is printed.

Since:

1.0

Author:

Erik C. Thauvin

Constructor Summary

Constructors

Constructor	Description
JUnitReporterOperation()

Method Summary

Modifier and Type	Method	Description
void	execute()	Performs the operation.
boolean	failOnSummary()	Returns whether the operation should fail if test failures are found.
JUnitReporterOperation	failOnSummary(boolean failOnSummary)	Configures whether the operation should fail if test failures are found.
JUnitReporterOperation	fromProject(BaseProject project)	Configures the operation from a BaseProject.
@Nullable Path	reportFile()	Returns the path to the report file.
JUnitReporterOperation	reportFile(File reportFile)	Specifies the XML report file.
JUnitReporterOperation	reportFile(String reportFile)	Specifies the XML report file.
JUnitReporterOperation	reportFile(Path reportFile)	Specifies the XML report file.

Methods inherited from class rife.bld.operations.AbstractOperation

executeOnce, executeOnce, silent, silent, verbose, verbose

Methods inherited from class java.lang.Object

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

Constructor Details

JUnitReporterOperation

public JUnitReporterOperation()

Method Details

execute

public void execute()
             throws Exception

Performs the operation.

Specified by:

execute in class AbstractOperation<JUnitReporterOperation>

Throws:

ExitStatusException - if the operation fails

Exception

failOnSummary

public JUnitReporterOperation failOnSummary(boolean failOnSummary)

Configures whether the operation should fail if test failures are found.

When true, the bld command exits with failure if any test failures are present. When false, failures are printed but the command exits successfully.

Parameters:

failOnSummary - true to fail the build on test failures, false to not fail

Returns:

this operation

failOnSummary

public boolean failOnSummary()

Returns whether the operation should fail if test failures are found.

Returns:

true if the operation should fail on test failures, false otherwise

fromProject

public JUnitReporterOperation fromProject(BaseProject project)

Configures the operation from a BaseProject.

If not set, the report file is set to the default location for JUnit reports.

Consumes --all or --index=N[.M] from project.arguments() if present.

Parameters:

project - the project to use as the context for this operation

Returns:

this operation

Throws:

NullPointerException - if project is null

reportFile

public @Nullable Path reportFile()

Returns the path to the report file.

Returns:

the path, or null if not set

reportFile

public JUnitReporterOperation reportFile(Path reportFile)

Specifies the XML report file.

Parameters:

reportFile - the report file path

Returns:

this operation

Throws:

NullPointerException - if reportFile is null

See Also:

• reportFile(File)
• reportFile(String)

reportFile

public JUnitReporterOperation reportFile(File reportFile)

Specifies the XML report file.

Parameters:

reportFile - the report file path

Returns:

this operation

Throws:

NullPointerException - if reportFile is null

See Also:

• reportFile(Path)
• reportFile(String)

reportFile

public JUnitReporterOperation reportFile(String reportFile)

Specifies the XML report file.

Parameters:

reportFile - the report file path

Returns:

this operation

Throws:

NullPointerException - if reportFile is null

IllegalArgumentException - if reportFile is empty

See Also:

• reportFile(Path)
• reportFile(File)