Getting Started

1. Download.
2. Inside Maven surfire plugin.
3. Standalone in JUnit test class.
4. Configuration options.
5. Velocity variables.

1. Download.

pom.xml

<dependency>
  <groupId>com.github.jt-org</groupId>
  <artifactId>jt-report</artifactId>
  <version>0.0.1</version>
</dependency>

jt-report jar file

[Download](https://github.com/jt-org/jt-report/downloads https://github.com/jt-org/jt-report/downloads )

2. Inside Maven surfire plugin.

pom.xml

</plugin>  
	<groupId>org.apache.maven.plugins</groupId>
	<artifactId>maven-surefire-plugin</artifactId>
	<version>2.12</version>
	<configuration>
		<properties>
			<property>
				<name>listener</name>
				<value>com.github.jtreport.core.SurefireReportTestListner</value>
			</property>
		</properties>
		<systemProperties>
			<property>
				<name>jtreportConfig</name>
				<value>jtreport.properties</value>
			</property>
		</systemProperties>
	</configuration>
</plugin>

SimpleExamplesTest.java

@TestClassReport(description = "Put here the description for this test Class.")
public class SimpleExamplesTest {

	@Test
	@TestSingleReport(description = "Put here the description for this test...", expectations = "Put here the expectations test of the test...")
	public void simpleTest1() {
	}

	@Ignore("Put here why this test is skipped")
	@Test
	@TestSingleReport(description = "Put here the description for this test...", expectations = "Put here the expectations test of the test...")
	public void simpleTest2() {
	}
}

3. Standalone in JUnit test class.

SimpleExamplesTest.java

If you want to use it in a standalone you need to extends JtreportRunner class and use the ReportTestRunner to run the test. This mode is not incompatible with the previous Surfire mode.

@RunWith(ReportTestRunner.class)
@TestClassReport(description = "Put here the description for this test Class.")
public class SimpleExamplesTest extends JtreportRunner {

	@Override
	public ReportSummary initalizeReport() {
		return new ReportSummary("/tmp/jtreportDir",
				new ArrayList<ReportTypePrinterEnum>() {

					private static final long serialVersionUID = 1L;

					{
						this.add(ReportTypePrinterEnum.PDF);
						this.add(ReportTypePrinterEnum.ODT);
						this.add(ReportTypePrinterEnum.ODS);
					}
				});
	}

	@Test
	@TestSingleReport(description = "Put here the description for this test...", expectations = "Put here the expectations test of the test...")
	public void simpleTest1() {
	}

	@Ignore("Put here why this test is skipped")
	@Test
	@TestSingleReport(description = "Put here the description for this test...", expectations = "Put here the expectations test of the test...")
	public void simpleTest2() {
	}

	@Ignore("This comment was override in the report")
	@Test
	@TestSingleReport(description = "Put here the description for this test...", ignored = "Put here why this test is skipped. This comment go in the test report", expectations = "Put here the expectations test of the test...")
	public void simpleTest3() {
	}

	@Test
	@TestSingleReport(description = "Put here the description for this test...", expectations = "Put here the expectations test of the test...")
	public void simpleTest4() {
		Assert.assertEquals("Are the same", 0, 1);
	}

	@Test
	@TestSingleReport(description = "Put here the description for this test...", expectations = "Put here the expectations test of the test...", failed = "This ovverride the failed massage.")
	public void simpleTest5() {
		Assert.assertEquals("Are the same", 0, 1);
	}

	@Test
	@TestSingleReport(description = "Put here the description for this test...", expectations = "Put here the expectations test of the test...")
	public void simpleTest6() {
		final Integer x = null;
		x.intValue();
	}

	@Test
	@TestSingleReport(description = "Put here the description for this test...", expectations = "Put here the expectations test of the test...", error = "This ovverride the error massage.")
	public void simpleTest7() {
		final Integer x = null;
		x.intValue();
	}
}

4. Configuration options.

jtreport.properties

jtreportDir=Report destination directory
veolocityTemplatePath= path of velocity template, if needed
customPrinterClass=Custom printer class implements IPrinterStrategy, if needed
templateWithKey=[true|false], true if you want use template key variable, if needed
printerType=[DEFAULT|CUSTOM|VELOCITY] DEFAULT for default printer, CUSTOM if you want to use a personal printer defined in customPrinterClass, VELOCITY if you want to use a personal Velocity template defined in veolocityTemplatePath
reportPrinterFormat=[PDF,ODT,ODS,CSV,HTML,XHTML,XML,PNG,JRXML], one or more separated by comma
margeReport=[true|false] true if you want to merge the report in one single file.

5. Velocity variables.

with you templateWithKey=false

"testClassName"
"testDate"
"totalDuration"
"totalRun"
"totalPassed"
"totalFail"
"totalError"
"totalIgnore"
"summaryDescription"
"StringEscapeUtils"

look the example

<jtreport>
	<general>
		<testclass>
		Test report result: $StringEscapeUtils.escapeHtml($testClassName)
		</testclass>
		<generaldesciption>$StringEscapeUtils.escapeHtml($summaryDescription)</generaldesciption>
		<duration>$totalDuration ms</duration>
		<totpassed>$totalPassed</totpassed>
		<toterror>$totalError</toterror>
		<totfail>$totalFail</totfail>
		<totinogre>$totalIgnore</totinogre>
	</general>
	#foreach( $test in $testList )
	<test>
		<name>
		$StringEscapeUtils.escapeHtml($test.getTestClassName())#$StringEscapeUtils.escapeHtml($test.getTestMethodName())
		</name>
		<state>$test.getTestState().name()</state>
		<description>
		$StringEscapeUtils.escapeHtml($test.getDescriptionComment())
		</description>
		<statecomment>
		$StringEscapeUtils.escapeHtml($test.getResultDescription())
		</statecomment>
	</test>
	#end
</jtreport>

with you templateWithKey=true are the additional variables

testKey + "_descriptionComment"
testKey + "_descriptionResult"
testKey + "_testClassName"
testKey + "_testMethodName"
testKey + "_testDisplayName"
testKey + "_testState"
testKey + "_formattdDate"

where testKey are defined by keyCustomReport variable in TestClassReport annotation, and must be primary key for the report

look the example

@TestClassReport(description = "Put here the description for this test Class.")
public class SimpleExamplesTest {
	@TestSingleReport(keyCustomReport = "keyExampleTest1", description = "Put here the description for this test...", expectations = "Put here the expectations test of the test...")
	public void simpleTest1() {
	}
}

Velocity template file

<jtreport>
	<general>
		<testclass>
		Test report result: $StringEscapeUtils.escapeHtml($testClassName)
		</testclass>
		<generaldesciption>$StringEscapeUtils.escapeHtml($summaryDescription)</generaldesciption>
		<duration>$totalDuration ms</duration>
		<totpassed>$totalPassed</totpassed>
		<toterror>$totalError</toterror>
		<totfail>$totalFail</totfail>
		<totinogre>$totalIgnore</totinogre>
	</general>
	<test>
		<name>
		$StringEscapeUtils.escapeHtml($$keyExampleTest1_testClassName)#$StringEscapeUtils.escapeHtml($keyExampleTest1_testMethodName)
		</name>
		<state>$keyExampleTest1_testState</state>
		<description>
		$StringEscapeUtils.escapeHtml($keyExampleTest1_descriptionComment)
		</description>
		<statecomment>
		$StringEscapeUtils.escapeHtml($keyExampleTest1_resultDescription)
		</statecomment>
	</test>
</jtreport>