added maven surefire support (#77)

DmitryBogatko · web-flow · commit 9ac2b13d26ff · 2020-08-22T22:02:43.000+03:00
* added maven surefire support
* refactored HandlerFactory class
* api version increased to 1.0.2
* updated changelog
* refactored unit tests for imports of testng and junit types
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,10 @@
 # CHANGELOG
 
+## 1.0.2 (2020-08-18)
+
+Changes: 
+  - Added new import type - Maven Surefire, it will be used for JUnit/TestNG Java projects
+
 ## 1.0.1
 
 Bugfixes:
diff --git a/pom.xml b/pom.xml
@@ -6,7 +6,7 @@
     <groupId>unifi_reporting_api</groupId>
     <artifactId>api</artifactId>
     <packaging>war</packaging>
-    <version>1.0.1</version>
+    <version>1.0.2</version>
 
     <properties>
         <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
diff --git a/src/main/java/main/model/db/imports/HandlerFactory.java b/src/main/java/main/model/db/imports/HandlerFactory.java
@@ -4,24 +4,25 @@
 import main.model.db.imports.ImportHandlers.*;
 
 import java.io.File;
+import java.util.Arrays;
 import java.util.Date;
+import java.util.List;
+import java.util.stream.Collectors;
 
 class HandlerFactory {
+
     Handler getHandler(File file, String type, TestNameNodeType testNameNodeType, Date finishTime) throws AqualityException {
-        switch (ImportTypes.valueOf(type)){
+        validateTypeOnNameNodeRequirements(ImportTypes.valueOf(type), testNameNodeType);
+
+        switch (ImportTypes.valueOf(type)) {
             case MSTest:
-                if(testNameNodeType == null){
-                    throw new AqualityException("testNameNode is required");
-                }
                 return new TRX(file, testNameNodeType);
             case Robot:
                 return new Robot(file);
             case JUnit:
             case TestNG:
-                if(testNameNodeType == null){
-                    throw new AqualityException("testNameNode is required");
-                }
-                return new JavaJUnitTestNG(file, testNameNodeType, finishTime);
+            case MavenSurefire:
+                return new MavenSurefireHandler(file, testNameNodeType, finishTime);
             case Cucumber:
             case TestNGCucumber:
                 return new Cucumber(file, finishTime);
@@ -30,12 +31,25 @@ Handler getHandler(File file, String type, TestNameNodeType testNameNodeType, Da
             case NUnit_v2:
                 return new NUnitV2(file);
             case NUnit_v3:
-                if(testNameNodeType == null){
-                    throw new AqualityException("testNameNode is required");
-                }
                 return new NUnitV3(file, testNameNodeType);
             default:
-                throw new AqualityException(String.format("Import Type '%s' is not implemented", type));
+                throw new AqualityException(String.format("Import type '%s' is not implemented", type));
+        }
+    }
+
+    private void validateTypeOnNameNodeRequirements(ImportTypes type, TestNameNodeType nodeType) throws AqualityException {
+        List<ImportTypes> nameNodeRequiredTypes = Arrays.asList(
+                ImportTypes.MSTest,
+                ImportTypes.JUnit,
+                ImportTypes.TestNG,
+                ImportTypes.MavenSurefire,
+                ImportTypes.NUnit_v3);
+        if (nameNodeRequiredTypes.contains(type) && nodeType == null) {
+            throw new AqualityException(String.format("While you are using import type '%1$s' the TestNameNodeType is required. Allowed values: %2$s",
+                    type,
+                    Arrays.stream(TestNameNodeType.values())
+                            .map(TestNameNodeType::toString)
+                            .collect(Collectors.joining(","))));
         }
     }
 }
diff --git a/src/main/java/main/model/db/imports/ImportHandlers/MavenSurefireHandler.java b/src/main/java/main/model/db/imports/ImportHandlers/MavenSurefireHandler.java
@@ -2,7 +2,7 @@
 
 import main.exceptions.AqualityException;
 import main.model.db.imports.Handler;
-import main.model.db.imports.SAXHandlers.JavaJUnitTestNGHandler;
+import main.model.db.imports.SAXHandlers.MavenSurefireSaxHandler;
 import main.model.db.imports.TestNameNodeType;
 import main.model.dto.project.TestDto;
 import main.model.dto.project.TestResultDto;
@@ -15,11 +15,11 @@
 import java.util.Date;
 import java.util.List;
 
-public class JavaJUnitTestNG extends Handler {
-    private JavaJUnitTestNGHandler handler;
+public class MavenSurefireHandler extends Handler {
+    private MavenSurefireSaxHandler handler;
 
-    public JavaJUnitTestNG(File file, TestNameNodeType testNameNodeType, Date finishTime) throws AqualityException {
-        handler = new JavaJUnitTestNGHandler(testNameNodeType, finishTime);
+    public MavenSurefireHandler(File file, TestNameNodeType testNameNodeType, Date finishTime) throws AqualityException {
+        handler = new MavenSurefireSaxHandler(testNameNodeType, finishTime);
         try {
             this.parser.parse(file, handler);
         } catch (SAXException | IOException e) {
diff --git a/src/main/java/main/model/db/imports/ImportTypes.java b/src/main/java/main/model/db/imports/ImportTypes.java
@@ -9,5 +9,6 @@ public enum ImportTypes {
     TestNGCucumber,
     PHPCodeception,
     NUnit_v2,
-    NUnit_v3
+    NUnit_v3,
+    MavenSurefire
 }
diff --git a/src/main/java/main/model/db/imports/SAXHandlers/MavenSurefireSaxHandler.java b/src/main/java/main/model/db/imports/SAXHandlers/MavenSurefireSaxHandler.java
@@ -14,7 +14,7 @@
 
 import static main.model.db.imports.ResultStatus.*;
 
-public class JavaJUnitTestNGHandler extends Handler {
+public class MavenSurefireSaxHandler extends Handler {
     private TestSuiteDto testSuite = new TestSuiteDto();
     private List<TestResultDto> results = new ArrayList<>();
     private TestResultDto result;
@@ -27,7 +27,7 @@ public class JavaJUnitTestNGHandler extends Handler {
 
     private static final String BLANK_RESULT = "$blank";
 
-    public JavaJUnitTestNGHandler(TestNameNodeType testNameNodeType, Date finishTime) throws AqualityException {
+    public MavenSurefireSaxHandler(TestNameNodeType testNameNodeType, Date finishTime) throws AqualityException {
         super();
         this.testNameNodeType = testNameNodeType;
         testRun.setFinish_time(finishTime);
diff --git a/src/test/java/tests/workers/imports/JUnit/ClassNameJUnitHandlerTest.java b/src/test/java/tests/workers/imports/JUnit/ClassNameJUnitHandlerTest.java
diff --git a/src/test/java/tests/workers/imports/JUnit/TestNameJUnitHandlerTest.java b/src/test/java/tests/workers/imports/JUnit/TestNameJUnitHandlerTest.java
diff --git a/src/test/java/tests/workers/imports/TestNG/ClassNameTestNGHandlerTest.java b/src/test/java/tests/workers/imports/TestNG/ClassNameTestNGHandlerTest.java
diff --git a/src/test/java/tests/workers/imports/TestNG/TestNameTestNGHandlerTest.java b/src/test/java/tests/workers/imports/TestNG/TestNameTestNGHandlerTest.java
diff --git a/src/test/java/tests/workers/imports/surefire/AMavenSurefireHandlerTest.java b/src/test/java/tests/workers/imports/surefire/AMavenSurefireHandlerTest.java
@@ -1,34 +1,36 @@
-package tests.workers.imports.JUnit;
+package tests.workers.imports.surefire;
 
 import main.model.db.imports.Handler;
-import main.model.db.imports.ImportHandlers.JavaJUnitTestNG;
+import main.model.db.imports.ImportHandlers.MavenSurefireHandler;
 import main.model.db.imports.TestNameNodeType;
 import org.testng.annotations.BeforeMethod;
 import tests.workers.imports.IHandlerTest;
 import utils.FileUtils;
 
 import static org.testng.Assert.fail;
 
-public abstract class AJUnitHandlerTest implements IHandlerTest {
-    private JavaJUnitTestNG javaJUnitTestNG;
+public abstract class AMavenSurefireHandlerTest implements IHandlerTest {
+    private MavenSurefireHandler mavenSurefireHandler;
     private final String actualFileName;
     private final String resultsFileName;
     private final TestNameNodeType type;
+    private final String reportPath;
 
-    AJUnitHandlerTest(TestNameNodeType type, String actualFileName, String expectedFileName) {
+    AMavenSurefireHandlerTest(TestNameNodeType type, String actualFileName, String expectedFileName, String reportPath) {
         this.type = type;
         this.actualFileName = actualFileName;
         this.resultsFileName = expectedFileName;
+        this.reportPath = reportPath;
     }
 
     @Override
     public Handler getHandler() {
-        return javaJUnitTestNG;
+        return mavenSurefireHandler;
     }
 
     @Override
     public String getReportPath() {
-        return "reports/JUnit/";
+        return reportPath;
     }
 
     @Override
@@ -39,7 +41,7 @@ public String getTestFileName() {
     @BeforeMethod
     public void tryParse() {
         try {
-            javaJUnitTestNG = new JavaJUnitTestNG(FileUtils.getResourceFile(getFilePath(actualFileName)), type, getFinishTime());
+            mavenSurefireHandler = new MavenSurefireHandler(FileUtils.getResourceFile(getFilePath(actualFileName)), type, getFinishTime());
         } catch (Exception e) {
             fail(String.format("Failed on Handler Creating: %s", e.getMessage()), e);
         }
diff --git a/src/test/java/tests/workers/imports/surefire/ClassNameMavenSurefireOnJunitHandlerTest.java b/src/test/java/tests/workers/imports/surefire/ClassNameMavenSurefireOnJunitHandlerTest.java
@@ -0,0 +1,10 @@
+package tests.workers.imports.surefire;
+
+import main.model.db.imports.TestNameNodeType;
+
+public class ClassNameMavenSurefireOnJunitHandlerTest extends AMavenSurefireHandlerTest {
+
+    public ClassNameMavenSurefireOnJunitHandlerTest() {
+        super(TestNameNodeType.className, "TEST-JustTest.xml", "testWithClassName.json", "reports/JUnit/");
+    }
+}
diff --git a/src/test/java/tests/workers/imports/surefire/ClassNameMavenSurefireOnTestNGHandlerTest.java b/src/test/java/tests/workers/imports/surefire/ClassNameMavenSurefireOnTestNGHandlerTest.java
@@ -0,0 +1,10 @@
+package tests.workers.imports.surefire;
+
+import main.model.db.imports.TestNameNodeType;
+
+public class ClassNameMavenSurefireOnTestNGHandlerTest extends AMavenSurefireHandlerTest {
+
+    public ClassNameMavenSurefireOnTestNGHandlerTest() {
+        super(TestNameNodeType.className, "TEST-TestSuite.xml", "testWithClassName.json", "reports/TestNG/");
+    }
+}
diff --git a/src/test/java/tests/workers/imports/surefire/TestNameMavenSurefireOnJunitHandlerTest.java b/src/test/java/tests/workers/imports/surefire/TestNameMavenSurefireOnJunitHandlerTest.java
@@ -0,0 +1,10 @@
+package tests.workers.imports.surefire;
+
+import main.model.db.imports.TestNameNodeType;
+
+public class TestNameMavenSurefireOnJunitHandlerTest extends AMavenSurefireHandlerTest {
+
+    public TestNameMavenSurefireOnJunitHandlerTest() {
+        super(TestNameNodeType.testName, "TEST-JustTest.xml", "testWithTestName.json", "reports/JUnit/");
+    }
+}
diff --git a/src/test/java/tests/workers/imports/surefire/TestNameMavenSurefireOnTestNGHandlerTest.java b/src/test/java/tests/workers/imports/surefire/TestNameMavenSurefireOnTestNGHandlerTest.java
@@ -0,0 +1,9 @@
+package tests.workers.imports.surefire;
+
+import main.model.db.imports.TestNameNodeType;
+
+public class TestNameMavenSurefireOnTestNGHandlerTest extends AMavenSurefireHandlerTest {
+    public TestNameMavenSurefireOnTestNGHandlerTest() {
+        super(TestNameNodeType.testName, "TEST-TestSuite.xml", "testWithTestName.json", "reports/TestNG/");
+    }
+}

Original file line number	Diff line number	Diff line change
`@@ -9,5 +9,6 @@ public enum ImportTypes {`
`9`	`9`	`TestNGCucumber,`
`10`	`10`	`PHPCodeception,`
`11`	`11`	`NUnit_v2,`
`12`		`- NUnit_v3`
	`12`	`+ NUnit_v3,`
	`13`	`+ MavenSurefire`
`13`	`14`	`}`