minor updates

Author: avmnu-sng

README.md

@@ -2,12 +2,55 @@
 
 An application to provide support for executing tests in the specific order and generate the customized XML report.
 
+## Installation
+
+- [Apache Maven](maven.apache.org)
+```
+<dependency>
+    <groupId>com.hackerrank.applications</groupId>
+    <artifactId>junit-ordered-test-runner</artifactId>
+    <version>1.0.0</version>
+</dependency>
+```
+
+- [Gradle Groovy DSL](gradle.org)
+```
+compile 'com.hackerrank.applications:junit-ordered-test-runner:1.0.0'
+```
+
+- [Gradle Kotlin DSL](github.com/gradle/kotlin-dsl)
+```
+compile(group = "com.hackerrank.applications", name = "junit-ordered-test-runner", version = "1.0.0")
+```
+
+- [Scala SBT](scala-sbt.org)
+```
+libraryDependencies += "com.hackerrank.applications" % "junit-ordered-test-runner" % "1.0.0"
+```
+
+- [Apache Ivy](ant.apache.org/ivy/)
+```
+<dependency org="com.hackerrank.applications" name="junit-ordered-test-runner" rev="1.0.0" />
+```
+
+- [Groovy Grape](groovy-lang.org/grape.html)
+```
+@Grapes(
+  @Grab(group='com.hackerrank.applications', module='junit-ordered-test-runner', version='1.0.0')
+)
+```
+
+- [Apache Builder](buildr.apache.org)
+```
+'com.hackerrank.applications:junit-ordered-test-runner:jar:1.0.0'
+```
+
 ## Sample Usage
 
 - The `OrderedTestRunner` should be used to run the test. The order of each test can be set by the `@Order` annotation. The test with lower order value is run first.
 - Run the tests with `TestWatcher` rule using `@Rule` annotation.
-- Register the test class using the `registerClass` method of TestWatcher in the `@BeforeClass` setup.
-- Finally, invoke the `createReport` method of TestWatcher in the `@AfterClass` setup.
+- Register the test class using the `registerClass` method of `TestWatcher` in the `@BeforeClass` setup.
+- Finally, invoke the `createReport` method of `TestWatcher` in the `@AfterClass` setup.
 
 For example,
 
@@ -53,7 +96,7 @@ public class SampleOrderedTest {
 
 Also,
 
-- If a `Runner` is already being used to run the tests, then, an inner class can be used to run with `OrderedTestRunner`. Tests can be triggered using the `JUnitCore.runClasses` method.
+- If a `Runner` is already being used to run the tests, then, an inner class can be used to run with `OrderedTestRunner`. Tests can be triggered using the `JUnitCore.runClasses` method. In this case, the test is always passing, so optional check can be performed using `allTestSucceeded`.
 
 For example,
 
@@ -76,6 +119,8 @@ public class SampleOrderedTest {
     @Test
     public void startTest() {
         JUnitCore.runClasses(TestHelper.class);
+
+        assertTrue(TestWatchman.watchman.allTestsSucceeded());
     }
 
     @RunWith(OrderedTestRunner.class)

pom.xml

@@ -4,7 +4,7 @@
 
     <groupId>com.hackerrank.applications</groupId>
     <artifactId>junit-ordered-test-runner</artifactId>
-    <version>1.0</version>
+    <version>1.0.0</version>
     <packaging>jar</packaging>
 
     <name>${project.groupId}:${project.artifactId}</name>
@@ -32,19 +32,19 @@
             <organizationUrl>https://www.hackerrank.com/</organizationUrl>
         </developer>
     </developers>
-    
+
     <scm>
         <connection>scm:git:git://github.com/interviewstreet/junit-ordered-test-runner.git</connection>
         <developerConnection>scm:git:ssh://github.com:interviewstreet/junit-ordered-test-runner.git</developerConnection>
         <url>http://github.com/interviewstreet/junit-ordered-test-runner/tree/master</url>
     </scm>
-    
+
     <distributionManagement>
         <snapshotRepository>
             <id>ossrh</id>
             <url>https://oss.sonatype.org/content/repositories/snapshots</url>
         </snapshotRepository>
-        
+
         <repository>
             <id>ossrh</id>
             <url>https://oss.sonatype.org/service/local/staging/deploy/maven2/</url>
@@ -80,14 +80,14 @@
             <type>jar</type>
         </dependency>
     </dependencies>
-    
+
     <build>
         <plugins>
             <plugin>
                 <groupId>org.apache.maven.plugins</groupId>
                 <artifactId>maven-source-plugin</artifactId>
                 <version>3.0.1</version>
-                
+
                 <executions>
                     <execution>
                         <id>attach-sources</id>
@@ -97,12 +97,12 @@
                     </execution>
                 </executions>
             </plugin>
-            
+
             <plugin>
                 <groupId>org.apache.maven.plugins</groupId>
                 <artifactId>maven-javadoc-plugin</artifactId>
                 <version>3.0.1</version>
-                
+
                 <executions>
                     <execution>
                         <id>attach-javadocs</id>
@@ -112,7 +112,7 @@
                     </execution>
                 </executions>
             </plugin>
-            
+
             <plugin>
                 <groupId>org.apache.maven.plugins</groupId>
                 <artifactId>maven-gpg-plugin</artifactId>

src/main/java/com/hackerrank/test/utility/Color.java

@@ -16,11 +16,10 @@
 package com.hackerrank.test.utility;
 
 /**
- *
  * @author Abhimanyu Singh
  * @author [email protected]
- * @version 1.0
- * @since 1.0
+ * @version 1.0.0
+ * @since 1.0.0
  */
 public class Color {
 

src/main/java/com/hackerrank/test/utility/NumberFormatter.java

@@ -18,35 +18,28 @@
 import java.math.BigDecimal;
 
 /**
- *
  * @author Abhimanyu Singh
  * @author [email protected]
- * @version 1.0
- * @since 1.0
+ * @version 1.0.0
+ * @since 1.0.0
  */
 public class NumberFormatter {
 
     /**
-     *
      * @param value double value
      * @param precision number of decimal places
      * @return string representation of rounded double to fixed decimal places
      */
     public static String stringValue(double value, int precision) {
-        return new BigDecimal(value)
-                .setScale(precision, BigDecimal.ROUND_HALF_EVEN)
-                .toString();
+        return new BigDecimal(value).setScale(precision, BigDecimal.ROUND_HALF_EVEN).toString();
     }
 
     /**
-     *
      * @param value double value
      * @param precision number of decimal places
      * @return rounded double to fixed decimal places
      */
     public static double doubleValue(double value, int precision) {
-        return new BigDecimal(value)
-                .setScale(precision, BigDecimal.ROUND_HALF_EVEN)
-                .doubleValue();
+        return new BigDecimal(value).setScale(precision, BigDecimal.ROUND_HALF_EVEN).doubleValue();
     }
 }

src/main/java/com/hackerrank/test/utility/Order.java

@@ -21,21 +21,15 @@
 import java.lang.annotation.Target;
 
 /**
- *
  * @author Abhimanyu Singh
  * @author [email protected]
- * @version 1.0
- * @since 1.0
+ * @version 1.0.0
+ * @since 1.0.0
  */
 @Retention(RetentionPolicy.RUNTIME)
-@Target({
-    ElementType.METHOD
-})
+@Target({ElementType.METHOD})
 public @interface Order {
 
-    /**
-     *
-     * @return order
-     */
+    /** @return order */
     public int value();
 }

src/main/java/com/hackerrank/test/utility/OrderedTestRunner.java

@@ -15,36 +15,32 @@
  */
 package com.hackerrank.test.utility;
 
+import static java.util.stream.Collectors.toList;
+
 import java.util.HashMap;
 import java.util.List;
 import java.util.Map;
-import static java.util.stream.Collectors.toList;
 import org.junit.runners.BlockJUnit4ClassRunner;
 import org.junit.runners.model.FrameworkMethod;
 import org.junit.runners.model.InitializationError;
 
 /**
- *
  * @author Abhimanyu Singh
  * @author [email protected]
- * @version 1.0
- * @since 1.0
+ * @version 1.0.0
+ * @since 1.0.0
  */
 public class OrderedTestRunner extends BlockJUnit4ClassRunner {
 
     /**
-     *
      * @param clazz test class
      * @throws InitializationError initialization error
      */
     public OrderedTestRunner(Class<?> clazz) throws InitializationError {
         super(clazz);
     }
 
-    /**
-     *
-     * @return test methods ordered by execution order
-     */
+    /** @return test methods ordered by execution order */
     @Override
     protected List<FrameworkMethod> computeTestMethods() {
         Map<FrameworkMethod, Integer> orders = new HashMap();

src/main/java/com/hackerrank/test/utility/ReportGenerator.java

@@ -15,32 +15,31 @@
  */
 package com.hackerrank.test.utility;
 
+import static java.util.stream.Collectors.toList;
+import static org.apache.commons.lang.exception.ExceptionUtils.getStackTrace;
+
 import java.io.File;
 import java.io.FileWriter;
 import java.io.IOException;
 import java.util.List;
 import java.util.Map;
 import java.util.Map.Entry;
-import static java.util.stream.Collectors.toList;
 import java.util.stream.Stream;
-import static org.apache.commons.lang.exception.ExceptionUtils.getStackTrace;
 import org.jdom.Attribute;
 import org.jdom.Document;
 import org.jdom.Element;
 import org.jdom.output.Format;
 import org.jdom.output.XMLOutputter;
 
 /**
- *
  * @author Abhimanyu Singh
  * @author [email protected]
- * @version 1.0
- * @since 1.0
+ * @version 1.0.0
+ * @since 1.0.0
  */
 public class ReportGenerator {
 
     /**
-     *
      * @param clazz test class
      * @param suiteTests test methods in the class
      */
@@ -50,7 +49,8 @@ public static void createReport(Class<?> clazz, Map<String, List<TestObject>> su
         Document report = new Document();
 
         if (suiteTests.containsKey(className)) {
-            report.setRootElement(ReportGenerator.createReport(className, suiteTests.get(className)));
+            report.setRootElement(
+                    ReportGenerator.createReport(className, suiteTests.get(className)));
         } else {
             Element testsuites = new Element("testsuites");
 
@@ -101,21 +101,19 @@ public static void createReport(Class<?> clazz, Map<String, List<TestObject>> su
         outputter.setFormat(Format.getPrettyFormat());
 
         try {
-            outputter.output(report, new FileWriter(new File(reportPath + "/TEST-" + className + ".xml")));
+            outputter.output(
+                    report, new FileWriter(new File(reportPath + "/TEST-" + className + ".xml")));
         } catch (IOException ex) {
             System.out.println(
                     String.join(
                             "\n",
                             Stream.of(getStackTrace(ex).split("\n"))
                                     .map(str -> Color.RED + str + Color.RESET)
-                                    .collect(toList())
-                    )
-            );
+                                    .collect(toList())));
         }
     }
 
     /**
-     *
      * @param className test class
      * @param tests test methods in the class
      * @return XML element for a test report