add report formatter

Author: avmnu-sng

README.md

@@ -9,40 +9,40 @@ An application to provide support for executing tests in the specific order and
 <dependency>
     <groupId>com.hackerrank.applications</groupId>
     <artifactId>junit-ordered-test-runner</artifactId>
-    <version>1.0.0</version>
+    <version>1.0.1</version>
 </dependency>
 ```
 
 - [Gradle Groovy DSL](gradle.org)
 ```
-compile 'com.hackerrank.applications:junit-ordered-test-runner:1.0.0'
+compile 'com.hackerrank.applications:junit-ordered-test-runner:1.0.1'
 ```
 
 - [Gradle Kotlin DSL](github.com/gradle/kotlin-dsl)
 ```
-compile(group = "com.hackerrank.applications", name = "junit-ordered-test-runner", version = "1.0.0")
+compile(group = "com.hackerrank.applications", name = "junit-ordered-test-runner", version = "1.0.1")
 ```
 
 - [Scala SBT](scala-sbt.org)
 ```
-libraryDependencies += "com.hackerrank.applications" % "junit-ordered-test-runner" % "1.0.0"
+libraryDependencies += "com.hackerrank.applications" % "junit-ordered-test-runner" % "1.0.1"
 ```
 
 - [Apache Ivy](ant.apache.org/ivy/)
 ```
-<dependency org="com.hackerrank.applications" name="junit-ordered-test-runner" rev="1.0.0" />
+<dependency org="com.hackerrank.applications" name="junit-ordered-test-runner" rev="1.0.1" />
 ```
 
 - [Groovy Grape](groovy-lang.org/grape.html)
 ```
 @Grapes(
-  @Grab(group='com.hackerrank.applications', module='junit-ordered-test-runner', version='1.0.0')
+  @Grab(group='com.hackerrank.applications', module='junit-ordered-test-runner', version='1.0.1')
 )
 ```
 
 - [Apache Builder](buildr.apache.org)
 ```
-'com.hackerrank.applications:junit-ordered-test-runner:jar:1.0.0'
+'com.hackerrank.applications:junit-ordered-test-runner:jar:1.0.1'
 ```
 
 ## Sample Usage
@@ -161,6 +161,26 @@ You can refer the given [test examples](src/test/java/com/hackerrank/test/utilit
 - The `TestWatcher` generates an XML report in the `target/hackerrank-report` directory. The filename is `TEST-{test-class-canonical-name}.xml`.
 - When running tests in a suite, suite report, as well as individual test reports, will be generated.
 
+## Report Formatting
+
+In test suite use `ReportFormatter.format(path)` to update the test name in canonical format, i.e., `{package}.{class_name}.{test_name}`. The path must be relative to the project directory. For example:
+```java
+package com.hackerrank.test;
+
+@RunWith(Suite.class)
+@Suite.SuiteClasses({
+    com.hackerrank.test.FirstTest.class,
+    com.hackerrank.test.SecondTest.class
+})
+public class TestSuite {
+
+    @AfterClass
+    public static void tearDownClass() throws Exception {
+        ReportFormatter.format("target/surefire-reports/TEST-com.hackerrank.test.TestSuite.xml");
+    }
+}
+```
+
 ## Building Project
 
 - Use `mvn clean build` to build the project.

pom.xml

@@ -4,7 +4,7 @@
 
     <groupId>com.hackerrank.applications</groupId>
     <artifactId>junit-ordered-test-runner</artifactId>
-    <version>1.0.0</version>
+    <version>1.0.1</version>
     <packaging>jar</packaging>
 
     <name>${project.groupId}:${project.artifactId}</name>

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

@@ -0,0 +1,69 @@
+/*
+ * Copyright 2018 HackerRank.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package com.hackerrank.test.utility;
+
+import java.io.File;
+import java.io.FileWriter;
+import java.io.IOException;
+import java.util.List;
+import org.jdom.Attribute;
+import org.jdom.Document;
+import org.jdom.Element;
+import org.jdom.JDOMException;
+import org.jdom.input.SAXBuilder;
+import org.jdom.output.Format;
+import org.jdom.output.XMLOutputter;
+
+/**
+ * @author Abhimanyu Singh
+ * @author [email protected]
+ * @version 1.0.1
+ * @since 1.0.1
+ */
+public class ReportFormatter {
+    /**
+     * @param reportPath XML report path relative to project root
+     * @throws java.io.IOException no such file exception
+     * @throws org.jdom.JDOMException XML document build exception
+     */
+    public static void format(String reportPath) throws JDOMException, IOException {
+        SAXBuilder builder = new SAXBuilder();
+        File xmlFile = new File(reportPath);
+
+        Document report = (Document) builder.build(xmlFile);
+
+        List<Element> testcases = report.getRootElement().getChildren("testcase");
+
+        for (int i = 0; i < testcases.size(); i++) {
+            Element testcase = testcases.get(i);
+
+            String testname = testcase.getAttributeValue("name");
+            String testclass = testcase.getAttributeValue("classname");
+
+            Attribute test = new Attribute("name", testclass + "." + testname);
+
+            testcase.setAttribute(test);
+
+            System.out.println(testcase.getAttributeValue("name"));
+        }
+
+        XMLOutputter outputter = new XMLOutputter();
+
+        outputter.setFormat(Format.getPrettyFormat());
+        outputter.output(report, new FileWriter(xmlFile));
+    }
+}