tech: add job parameter that will parse test run's test name to test name part and test parameters part

Author: nissimshitrit

src/main/java/com/microfocus/application/automation/tools/octane/tests/junit/JUnitExtension.java

@@ -65,6 +65,7 @@
 import java.nio.file.Path;
 import java.nio.file.Paths;
 import java.util.*;
+import java.util.regex.Pattern;
 
 /**
  * Converter of Jenkins test report to ALM Octane test report format(junitResult.xml->mqmTests.xml)
@@ -75,6 +76,7 @@ public class JUnitExtension extends OctaneTestsExtension {
 
 	private static final String JUNIT_RESULT_XML = "junitResult.xml"; // NON-NLS
 	public static final String TEMP_TEST_RESULTS_FILE_NAME_PREFIX = "GetJUnitTestResults";
+	private static final String TEST_RESULT_NAME_REGEX_PATTERN_PARAMETER_NAME = "octane_test_result_name_run_regex_pattern";
 
 	@Inject
 	private ResultFieldsDetectionService resultFieldsDetectionService;
@@ -164,6 +166,7 @@ private static class GetJUnitTestResults implements FilePath.FileCallable<FilePa
 		private FilePath workspace;
 		private boolean stripPackageAndClass;
 		private String sharedCheckOutDirectory;
+		private Pattern testParserRegEx;
 
 		//this class is run on master and JUnitXmlIterator is runnning on slave.
 		//this object pass some master2slave data
@@ -220,6 +223,19 @@ public GetJUnitTestResults(Run<?, ?> build, HPRunnerType hpRunnerType, List<File
 					logger.error("Failed to add log file for StormRunnerLoad :" + e.getMessage());
 				}
 			}
+			if(build.getAction(ParametersAction.class) != null && build.getAction(ParametersAction.class).getParameter(TEST_RESULT_NAME_REGEX_PATTERN_PARAMETER_NAME) != null &&
+					build.getAction(ParametersAction.class).getParameter(TEST_RESULT_NAME_REGEX_PATTERN_PARAMETER_NAME).getValue() != null) {
+				try {
+					this.testParserRegEx = Pattern.compile(Objects.requireNonNull(build.getAction(ParametersAction.class).getParameter(TEST_RESULT_NAME_REGEX_PATTERN_PARAMETER_NAME).getValue()).toString());
+				} catch (IllegalArgumentException e){
+					logger.error("Failed to parse regular expression pattern for test result name extractor.Job name: {}, Build {}, Input: {}, Error massage: {}.",
+							this.jobName,
+							this.buildId,
+							Objects.requireNonNull(build.getAction(ParametersAction.class).getParameter(TEST_RESULT_NAME_REGEX_PATTERN_PARAMETER_NAME).getValue()).toString() +"\n",
+							e.getMessage());
+				}
+			}
+
 		}
 
 		@Override
@@ -230,7 +246,7 @@ public FilePath invoke(File f, VirtualChannel channel) throws IOException, Inter
 
 			try {
 				for (FilePath report : reports) {
-					JUnitXmlIterator iterator = new JUnitXmlIterator(report.read(), moduleDetection, workspace, sharedCheckOutDirectory, jobName, buildId, buildStarted, stripPackageAndClass, hpRunnerType, jenkinsRootUrl, additionalContext);
+					JUnitXmlIterator iterator = new JUnitXmlIterator(report.read(), moduleDetection, workspace, sharedCheckOutDirectory, jobName, buildId, buildStarted, stripPackageAndClass, hpRunnerType, jenkinsRootUrl, additionalContext,testParserRegEx);
 					while (iterator.hasNext()) {
 						oos.writeObject(iterator.next());
 					}

src/main/java/com/microfocus/application/automation/tools/octane/tests/junit/JUnitTestResult.java

@@ -55,9 +55,9 @@ final public class JUnitTestResult implements Serializable, XmlWritableTestResul
     private final TestError testError;
     private final String externalReportUrl;
     private final HPRunnerType runnerType;
+    private final String externalRunId;
 
-
-    public JUnitTestResult(String moduleName, String packageName, String className, String testName, TestResultStatus result, long duration, long started, TestError testError, String externalReportUrl, String description, HPRunnerType runnerType) {
+    public JUnitTestResult(String moduleName, String packageName, String className, String testName, TestResultStatus result, long duration, long started, TestError testError, String externalReportUrl, String description, HPRunnerType runnerType,String externalRunId) {
         this.moduleName = restrictSize(moduleName, DEFAULT_STRING_SIZE);
         this.packageName = restrictSize(packageName, DEFAULT_STRING_SIZE);
         this.className = restrictSize(className, DEFAULT_STRING_SIZE);
@@ -73,6 +73,7 @@ public JUnitTestResult(String moduleName, String packageName, String className,
         this.externalReportUrl = externalReportUrl;
         this.description = description;
         this.runnerType = runnerType;
+        this.externalRunId = externalRunId;
     }
 
     private String restrictSize(String value, int size) {
@@ -130,6 +131,9 @@ public void writeXmlElement(XMLStreamWriter writer) throws XMLStreamException {
         if(externalReportUrl != null && !externalReportUrl.isEmpty()) {
             writer.writeAttribute("external_report_url", externalReportUrl);
         }
+        if(externalRunId != null && !externalRunId.isEmpty()){
+            writer.writeAttribute("external_run_id", externalRunId);
+        }
         if (HPRunnerType.UFT_MBT.equals(runnerType)) {
             writer.writeAttribute("run_type", MFToolsDetectionExtension.UFT_MBT);
         }

src/main/java/com/microfocus/application/automation/tools/octane/tests/junit/JUnitXmlIterator.java

@@ -55,6 +55,8 @@
 import java.util.Collection;
 import java.util.List;
 import java.util.Optional;
+import java.util.regex.Matcher;
+import java.util.regex.Pattern;
 
 /**
  * JUnit result parser and enricher according to HPRunnerType
@@ -87,8 +89,10 @@ public class JUnitXmlIterator extends AbstractXmlIterator<JUnitTestResult> {
 	private Object additionalContext;
 	private String filePath;
 	public static final String SRL_REPORT_URL = "reportUrl";
+	private Pattern testParserRegEx;
+	private String externalRunId;
 
-	public JUnitXmlIterator(InputStream read, List<ModuleDetection> moduleDetection, FilePath workspace, String sharedCheckOutDirectory, String jobName, String buildId, long buildStarted, boolean stripPackageAndClass, HPRunnerType hpRunnerType, String jenkinsRootUrl, Object additionalContext) throws XMLStreamException {
+	public JUnitXmlIterator(InputStream read, List<ModuleDetection> moduleDetection, FilePath workspace, String sharedCheckOutDirectory, String jobName, String buildId, long buildStarted, boolean stripPackageAndClass, HPRunnerType hpRunnerType, String jenkinsRootUrl, Object additionalContext,Pattern testParserRegEx) throws XMLStreamException {
 		super(read);
 		this.stripPackageAndClass = stripPackageAndClass;
 		this.moduleDetection = moduleDetection;
@@ -100,6 +104,7 @@ public JUnitXmlIterator(InputStream read, List<ModuleDetection> moduleDetection,
 		this.hpRunnerType = hpRunnerType;
 		this.jenkinsRootUrl = jenkinsRootUrl;
 		this.additionalContext = additionalContext;
+		this.testParserRegEx = testParserRegEx;
 	}
 
 	private static long parseTime(String timeString) {
@@ -281,16 +286,28 @@ protected void onEvent(XMLEvent event) throws XMLStreamException, IOException, I
 
 			if ("case".equals(localName)) { // NON-NLS
 				TestError testError = new TestError(stackTraceStr, errorType, errorMsg);
+
+				if(this.testParserRegEx != null){
+					splitTestNameByPattern();
+				}
 				if (stripPackageAndClass) {
 					//workaround only for UFT - we do not want packageName="All-Tests" and className="&lt;None>" as it comes from JUnit report
-					addItem(new JUnitTestResult(moduleName, "", "", testName, status, duration, buildStarted, testError, externalURL, description, hpRunnerType));
+					addItem(new JUnitTestResult(moduleName, "", "", testName, status, duration, buildStarted, testError, externalURL, description, hpRunnerType,this.externalRunId));
 				} else {
-					addItem(new JUnitTestResult(moduleName, packageName, className, testName, status, duration, buildStarted, testError, externalURL, description, hpRunnerType));
+					addItem(new JUnitTestResult(moduleName, packageName, className, testName, status, duration, buildStarted, testError, externalURL, description, hpRunnerType,this.externalRunId));
 				}
 			}
 		}
 	}
 
+	private void splitTestNameByPattern(){
+		Matcher matcher = testParserRegEx.matcher(this.testName);
+		if (matcher.find()) {
+			this.externalRunId = this.testName.substring(matcher.start());
+			this.testName = this.testName.substring(0, matcher.start());
+		}
+	}
+
 
 	private void parseUftErrorMessages() {
 		try {

src/test/java/com/microfocus/application/automation/tools/octane/tests/TestResultIterator.java

@@ -78,7 +78,7 @@ public boolean hasNext() {
 							long duration = Long.valueOf(element.getAttributeByName(new QName("duration")).getValue());
 							TestResultStatus status = TestResultStatus.fromPrettyName(element.getAttributeByName(new QName("status")).getValue());
 							long started = Long.valueOf(element.getAttributeByName(new QName("started")).getValue());
-							items.add(new JUnitTestResult(moduleName, packageName, className, testName, status, duration, started, null, null, null,null));
+							items.add(new JUnitTestResult(moduleName, packageName, className, testName, status, duration, started, null, null, null,null,null));
 						} else if ("build".equals(localName)) {
 							attribute = element.getAttributeByName(new QName("server_id"));
 							if (attribute != null) {

src/test/java/com/microfocus/application/automation/tools/octane/tests/xml/TestResultXmlWriterTest.java

@@ -69,7 +69,7 @@ public class TestResultXmlWriterTest extends OctanePluginTestBase {
 	@BeforeClass
 	public static void initialize() {
 		List<XmlWritableTestResult> testResults = new ArrayList<>();
-		testResults.add(new JUnitTestResult("module", "package", "class", "testName", TestResultStatus.PASSED, 1, 2, null, null, null, null));
+		testResults.add(new JUnitTestResult("module", "package", "class", "testName", TestResultStatus.PASSED, 1, 2, null, null, null, null,null));
 		container = new TestResultContainer(testResults.iterator(), new ResultFields());
 		OctaneServerMock serverMock = OctaneServerMock.getInstance();
 		OctaneServerSettingsModel model = new OctaneServerSettingsModel(