Class JsonReport

java.lang.Object

com.carrotsearch.ant.tasks.junit4.listeners.json.JsonReport

All Implemented Interfaces:

AggregatedEventListener

public class JsonReport
extends Object
implements AggregatedEventListener

A report listener that produces a single JSON file for all suites and tests.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
private static enum	JsonReport.OutputMethod

Field Summary

Fields

Modifier and Type	Field	Description
private String	jsonpMethod
private JsonWriter	jsonWriter
private JUnit4	junit4
private JsonReport.OutputMethod	method	How should the report be written?
private boolean	outputStreams
private String	projectName
private Map<Integer, ForkedJvmInfo>	slaves
private File	targetFile
private OutputStreamWriter	writer

Constructor Summary

Constructors

Constructor	Description
JsonReport()

Method Summary

Modifier and Type	Method	Description
private void	copyScaffolding(File targetFile)	Copy HTML/JS/CSS scaffolding to a targetFile's directory.
private String	getProjectName()	Return the project name or the default project name.
void	onQuit(AggregatedQuitEvent e)	All tests completed.
void	onSuiteResult(AggregatedSuiteResultEvent e)	Emit information about a single suite and all of its tests.
private String	removeExtension(String name)
void	setFile(File file)	Output file for the report file.
void	setJsonpMethod(String method)	Sets wrapper method name for JSONP.
void	setOuter(JUnit4 junit4)	Link to the container.
void	setOutputStreams(boolean outputStreams)	Include output streams? Mind that with large outputs the report may OOM.
void	setProjectName(String projectName)	Set project name for the output model.

Methods inherited from class Object

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

Field Details

junit4

private JUnit4 junit4

targetFile

private File targetFile

jsonpMethod

private String jsonpMethod

jsonWriter

private JsonWriter jsonWriter

projectName

private String projectName

slaves

private Map<Integer, ForkedJvmInfo> slaves

writer

private OutputStreamWriter writer

method

private JsonReport.OutputMethod method

How should the report be written?

outputStreams

private boolean outputStreams

See Also:

• setOutputStreams(boolean)

Constructor Details

JsonReport

public JsonReport()

Method Details

setFile

public void setFile(File file)

Output file for the report file. The name of the output file will also trigger how the report is written. If the name of the output file ends with ".htm(l)?" then the output file is a HTML file and CSS/JS scaffolding is also written to visualize the JSON model. If the name of the file ends with ".json(p)?" a JSON file is written.

setJsonpMethod

public void setJsonpMethod(String method)

Sets wrapper method name for JSONP. If set to non-empty value, will change the output format to JSONP. The name of the JSONP function for the HTML wrapper must be "testData".

See Also:

• "http://en.wikipedia.org/wiki/JSONP"

setProjectName

public void setProjectName(String projectName)

Set project name for the output model.

setOutputStreams

public void setOutputStreams(boolean outputStreams)

Include output streams? Mind that with large outputs the report may OOM.

setOuter

public void setOuter(JUnit4 junit4)

Description copied from interface: AggregatedEventListener

Link to the container. Listener can throw BuildException if parameter validation doesn't succeed, for example.

Specified by:

setOuter in interface AggregatedEventListener

removeExtension

private String removeExtension(String name)

getProjectName

private String getProjectName()

Return the project name or the default project name.

onSuiteResult

public void onSuiteResult(AggregatedSuiteResultEvent e)

Emit information about a single suite and all of its tests.

onQuit

public void onQuit(AggregatedQuitEvent e)

All tests completed.

copyScaffolding

private void copyScaffolding(File targetFile)
                      throws IOException

Copy HTML/JS/CSS scaffolding to a targetFile's directory.

Throws:

IOException