JarCastingJUnit Ordered Test Runner
An application to provide support for executing tests in the specific order and generate the customized XML report.
Installation
<dependency>
<groupId>com.hackerrank.applications</groupId>
<artifactId>junit-ordered-test-runner</artifactId>
<version>1.0.2</version>
</dependency>
compile 'com.hackerrank.applications:junit-ordered-test-runner:1.0.2'
compile(group = "com.hackerrank.applications", name = "junit-ordered-test-runner", version = "1.0.2")
libraryDependencies += "com.hackerrank.applications" % "junit-ordered-test-runner" % "1.0.2"
<dependency org="com.hackerrank.applications" name="junit-ordered-test-runner" rev="1.0.2" />
@Grapes(
@Grab(group='com.hackerrank.applications', module='junit-ordered-test-runner', version='1.0.2')
)
'com.hackerrank.applications:junit-ordered-test-runner:jar:1.0.2'
Sample Usage
- The
OrderedTestRunnershould be used to run the test. The order of each test can be set by the@Orderannotation. The test with lower order value is run first. - Run the tests with
TestWatcherrule using@Ruleannotation. - Register the test class using the
registerClassmethod ofTestWatcherin the@BeforeClasssetup. - Finally, invoke the
createReportmethod ofTestWatcherin the@AfterClasssetup.
For example,
@RunWith(OrderedTestRunner.class)
public class SampleOrderedTest {
@Rule
public TestWatcher watchman = TestWatchman.watchman;
public SampleOrderedTest() {
}
@BeforeClass
public static void setUpClass() {
TestWatchman.watchman.registerClass(SampleOrderedTest.class);
}
@AfterClass
public static void tearDownClass() {
TestWatchman.watchman.createReport(SampleOrderedTest.class);
}
@Test
@Order(1)
public void firstTest() {
assertTrue(0 == 0);
}
@Test
@Order(2)
public void secondTest() {
assertEquals(1, 1);
}
@Test
@Ordered(3)
public void thirdTest() {
assertNotEquals(1, null);
}
}
Also,
- If a
Runneris already being used to run the tests, then, an inner class can be used to run withOrderedTestRunner. Tests can be triggered using theJUnitCore.runClassesmethod. In this case, the test is always passing, so optional check can be performed usingallTestSucceeded.
For example,
public class SampleOrderedTest {
public SampleOrderedTest() {
}
@BeforeClass
public static void setUpClass() {
TestWatchman.watchman.registerClass(SampleOrderedTest.class);
}
@AfterClass
public static void tearDownClass() {
TestWatchman.watchman.createReport(SampleOrderedTest.class);
}
@Test
public void startTest() {
JUnitCore.runClasses(TestHelper.class);
assertTrue(TestWatchman.watchman.allTestsSucceeded());
}
@RunWith(OrderedTestRunner.class)
public static class TestHelper {
@Rule
public TestWatcher watchman = TestWatchman.watchman;
@Test
@Order(1)
public void firstTest() {
assertTrue(0 == 0);
}
@Test
@Order(3)
public void thirdTest() {
assertNotEquals(1, null);
}
@Test
@Order(2)
public void secondTest() {
assertEquals(1, 1);
}
}
}
And,
- When some tests are not assigned an order, then, these are run after the tests with an assigned order.
You can refer the given test examples for better understanding of writing tests with OrderedTestRunner.
Report Generation
- The
TestWatchergenerates an XML report in thetarget/hackerrank-reportdirectory. The filename isTEST-{test-class-canonical-name}.xml. - When running tests in a suite, suite report, as well as individual test reports, will be generated.
Building Project
- Use
mvn clean buildto build the project. - Use
mvn clean testto run the tests. - Use
mvn clean test -Dtest=TestSuiteto run the suite.
