Add Robot Framework 7.0 support (#64)

* Add a basic test case to test rf7 parsing * Add primitive support for RF 7.0 * Calculate duration for the test cases * Add unit tests for getter functions * Add clarifying comment for schemaversion Co-authored-by: Tatu Kairi <280218+Tattoo@users.noreply.github.com> --------- Co-authored-by: Tatu Kairi <280218+Tattoo@users.noreply.github.com>
jenkinsci · Jan 18, 2024 · 63e17c1 · 63e17c1
1 parent 63fbdf9
commit 63e17c1
Show file tree

Hide file tree

Showing 6 changed files with 114 additions and 22 deletions.
diff --git a/src/main/java/hudson/plugins/robot/RobotParser.java b/src/main/java/hudson/plugins/robot/RobotParser.java
@@ -57,6 +57,11 @@ public static final class RobotParserCallable implements
 		private final String logFileName;
 		private final String reportFileName;
 
+		private int schemaVersion;
+		private String startLocalName = "starttime";
+		private String elapsedLocalName = "elapsedtime";
+		private String endLocalName = "endtime";
+
 		public RobotParserCallable(String outputFileLocations, String logFileName, String reportFileName) {
 			this.outputFileLocations = outputFileLocations;
 			this.logFileName = logFileName;
@@ -116,6 +121,16 @@ private RobotResult parseResult(RobotResult result, XMLStreamReader reader, File
 						//we already have all data from suites and tests so we can stop parsing
 						break;
 					else if("robot".equals(tagName)){
+						String value = reader.getAttributeValue(null, "schemaversion");
+						value = value == null ? "0" : value;
+						schemaVersion = Integer.parseInt(value);
+// RF schemaVersion does not follow major version number. 
+// schemaVersion 5 == RF7.0 
+						if (schemaVersion >= 5) {
+							startLocalName = "start";
+							elapsedLocalName = "elapsed";
+							// endLocalName is no longer used
+						}
 						result.setTimeStamp(reader.getAttributeValue(null, "generated"));
 					} else if("suite".equals(tagName)){
 						result.addSuite(processSuite(reader, result, baseDirectory));
@@ -131,6 +146,7 @@ private RobotSuiteResult processSuite(XMLStreamReader reader, RobotTestObject pa
 				return getSplitXMLSuite(parent, baseDirectory, splitXMLPath);
 			}
 			RobotSuiteResult suite = new RobotSuiteResult();
+			suite.setSchemaVersion(schemaVersion);
 			suite.setLogFile(this.logFileName);
 			suite.setReportFile(this.reportFileName);
 			suite.setParent(parent);
@@ -157,9 +173,9 @@ private RobotSuiteResult processSuite(XMLStreamReader reader, RobotTestObject pa
 							suite.failTeardown();
 						}
 					} else if("status".equals(tagName)){
-						suite.setElapsedTime(reader.getAttributeValue(null, "elapsedtime"));
-						suite.setStartTime(reader.getAttributeValue(null, "starttime"));
-						suite.setEndTime(reader.getAttributeValue(null, "endtime"));
+						suite.setElapsedTime(reader.getAttributeValue(null, elapsedLocalName));
+						suite.setStartTime(reader.getAttributeValue(null, startLocalName));
+						suite.setEndTime(reader.getAttributeValue(null, endLocalName));
 					}
 				} else if (reader.isEndElement() && "suite".equals(reader.getLocalName())) {
 					return suite;
@@ -324,8 +340,12 @@ private RobotCaseResult processTest(XMLStreamReader reader, RobotSuiteResult res
 			//parse test details from nested status
 			caseResult.setPassed("PASS".equals(reader.getAttributeValue(null, "status")));
 			caseResult.setSkipped("SKIP".equals(reader.getAttributeValue(null, "status")));
-			caseResult.setStarttime(reader.getAttributeValue(null, "starttime"));
-			caseResult.setEndtime(reader.getAttributeValue(null, "endtime"));
+
+			caseResult.setStarttime(reader.getAttributeValue(null, startLocalName));
+			caseResult.setEndtime(reader.getAttributeValue(null, endLocalName));
+			if (schemaVersion >= 5) {
+				caseResult.setElapsedTime(reader.getAttributeValue(null, elapsedLocalName));
+			}
 			setCriticalityIfAvailable(reader, caseResult);
 			while(reader.hasNext()){
 				reader.next();

diff --git a/src/main/java/hudson/plugins/robot/model/RobotCaseResult.java b/src/main/java/hudson/plugins/robot/model/RobotCaseResult.java
@@ -47,6 +47,7 @@ public class RobotCaseResult extends RobotTestObject{
 	private String description;
 	private String starttime;
 	private String endtime;
+	private double elapsedtime;
 	private List<String> tags;
 	private String stackTrace;
 
@@ -61,9 +62,10 @@ public class RobotCaseResult extends RobotTestObject{
 	 * @return Elapsed time from start to end
 	 * @throws ParseException thrown exception
 	 */
-	public static long timeDifference(String time1, String time2) throws ParseException{
+	public static long timeDifference(String time1, String time2) throws ParseException {
 		long difference = 0;
-		DateFormat format = new SimpleDateFormat("yyyyMMdd HH:mm:ss.SS");
+		String dateFormat = "yyyyMMdd HH:mm:ss.SS";
+		DateFormat format = new SimpleDateFormat(dateFormat);
 
 		Date startDate = format.parse(time1);
 		Date endDate = format.parse(time2);
@@ -83,7 +85,7 @@ public String getName() {
 	public void setName(String name) {
 		this.name = name;
 	}
-	
+
 	/**
 	 * {@inheritDoc}
 	 */
@@ -112,7 +114,8 @@ public void setParent(RobotSuiteResult parent){
 	public long getDuration() {
 		if (duration != 0)
 			return duration;
-
+		if (elapsedtime != 0)
+			return Double.valueOf(elapsedtime * 1000).longValue(); // convert seconds to milliseconds
 		try{
 			return timeDifference(this.starttime, this.endtime);
 		} catch (ParseException e){
@@ -137,14 +140,22 @@ public void setEndtime(String endtime) {
 		this.endtime = endtime;
 	}
 
+	public double getElapsedtime() {
+		return elapsedtime;
+	}
+
+	public void setElapsedTime(String elapsed) {
+		this.elapsedtime = Double.parseDouble(elapsed);
+	}
+
 	public String getErrorMsg() {
 		return errorMsg;
 	}
 
 	public void setErrorMsg(String errorMsg) {
 		this.errorMsg = errorMsg;
 	}
-	
+
 	public String getStackTrace() {
 		return stackTrace;
 	}

diff --git a/src/main/java/hudson/plugins/robot/model/RobotSuiteResult.java b/src/main/java/hudson/plugins/robot/model/RobotSuiteResult.java
@@ -49,6 +49,8 @@ public class RobotSuiteResult extends RobotTestObject {
 	private transient int criticalPassed;
 	private transient int criticalFailed;
 
+	private int schemaVersion;
+
 
 	/**
 	 * Adds a nested suite to this suite. If a suite exists with the same name
@@ -122,7 +124,7 @@ public void setDescription(String description){
 	public Collection<RobotCaseResult> getCaseResults() {
 		if(caseResults != null) {
 			List<RobotCaseResult> res = new ArrayList(caseResults.values());
-			Collections.sort(res, new RobotCaseComparator());
+			res.sort(new RobotCaseComparator());
 			return res;
 		}
 		return Collections.emptyList();
@@ -180,6 +182,10 @@ public int getCriticalTotal() {
 		return criticalPassed + criticalFailed;
 	}
 
+	public void setSchemaVersion(int version) {
+		this.schemaVersion = version;
+	}
+
 	/**
 	 * Adds a test case result to this suite. If a case exists with the same
 	 * name it will be overwritten with this one.
@@ -202,7 +208,7 @@ public void addCaseResult(RobotCaseResult caseResult) {
 	public void setElapsedTime(String elapsedTime) {
 		this.elapsedTime = elapsedTime;
 	}
-	
+
 	public void setStartTime(String startTime){
 		this.startTime = startTime;
 	}
@@ -213,6 +219,10 @@ public void setEndTime(String endTime){
 
 	@Override
 	public long getDuration() {
+		if (schemaVersion >= 5) {
+			double d = Double.parseDouble(this.elapsedTime) * 1000;
+			return Double.valueOf(d).longValue();
+		}
 		if (StringUtils.isNotEmpty(this.elapsedTime)) {
 			return Long.parseLong(this.elapsedTime);
 		} else if (StringUtils.isEmpty(this.startTime) || StringUtils.isEmpty(this.endTime)) {

diff --git a/src/test/java/hudson/plugins/robot/RobotParserTest.java b/src/test/java/hudson/plugins/robot/RobotParserTest.java
@@ -202,4 +202,11 @@ public void testEmptyArgTags() {
         final String mask = "empty_args-output.xml";
         parse(dir, mask);
     }
+
+    @Test
+    public void testRF7InlineVar() {
+        final String dir = "robot7";
+        final String mask = "inline_var_output.xml";
+        parse(dir, mask);
+    }
 }
diff --git a/src/test/java/hudson/plugins/robot/model/RobotResultTest.java b/src/test/java/hudson/plugins/robot/model/RobotResultTest.java
@@ -17,21 +17,16 @@
 
 import hudson.plugins.robot.RobotParser;
 
-import static org.junit.Assert.assertEquals;
-import static org.junit.Assert.assertFalse;
-import static org.junit.Assert.assertNotNull;
-import static org.junit.Assert.assertTrue;
-
 import java.io.File;
-import java.util.ArrayList;
-import java.util.Arrays;
-import java.util.Collection;
 import java.util.List;
 
+import hudson.plugins.robot.RobotParserTest;
 import org.apache.commons.lang.StringUtils;
 import org.junit.Before;
 import org.junit.Test;
 
+import static org.junit.Assert.*;
+
 
 public class RobotResultTest {
 
@@ -75,7 +70,7 @@ public void testShouldParseCases(){
 		RobotCaseResult caseResult = suite.getCase("Hello");
 		assertNotNull(caseResult);
 	}
-	
+
 	@Test
 	public void testShouldParseCaseDescription(){
 		RobotSuiteResult suite = result.getSuite("Othercases & Testcases");
@@ -111,7 +106,7 @@ public void testShouldParseFailMessages(){
 		String errorMsg = caseResult.getErrorMsg();
 		assertEquals("Test failed miserably!", errorMsg.trim());
 	}
-	
+
 	@Test
 	public void testShouldParseNewCriticalCases() throws Exception{
 
@@ -346,6 +341,24 @@ public void testSuiteNameAttributeMightBeMissingInRobot4() throws Exception {
 		// passing null as `thisObject` should not matter, as the name resolving fails first
 		// due to getName() returning `null`
 		caseResult.getRelativePackageName(null);
+	}
+
+	@Test
+	public void testCaseResultsShouldBeCorrectlySet() throws  Exception {
+		File directory = new File(RobotParserTest.class.getResource("robot7").toURI());
+		RobotParser.RobotParserCallable remoteOperation = new RobotParser.RobotParserCallable("inline_var_output.xml", null, null);
+		result = remoteOperation.invoke(directory, null);
+		result.tally(null);
+
+		RobotSuiteResult suite = result.getSuite("Rf7");
+		RobotCaseResult caseResult = suite.getCase("Test Inline Var");
+
+		// suite results
+		assertEquals(35.0, suite.getDuration(), 0.01);
 
+		// case results
+		assertEquals("2023-11-13T15:33:07.168330", caseResult.getStarttime());
+		assertEquals(0.001748, caseResult.getElapsedtime(), 0.01);
+		assertNull(caseResult.getEndtime());
 	}
 }
diff --git a/src/test/resources/hudson/plugins/robot/robot7/inline_var_output.xml b/src/test/resources/hudson/plugins/robot/robot7/inline_var_output.xml
@@ -0,0 +1,31 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<robot generator="Robot 7.0a1 (Python 3.8.5 on darwin)" generated="2023-11-13T15:33:07.131714" rpa="false" schemaversion="5">
+<suite id="s1" name="Rf7" source="/Users/aleksisimell/projects/tmp/rf7.robot">
+<test id="s1-t1" name="Test Inline Var" line="2">
+<variable name="${local}">
+<var>mikki hiiri</var>
+<status status="PASS" start="2023-11-13T15:33:07.168900" elapsed="0.000162"/>
+</variable>
+<kw name="Should Be Equal" owner="BuiltIn">
+<arg>${local}</arg>
+<arg>mikki hiiri</arg>
+<doc>Fails if the given objects are unequal.</doc>
+<status status="PASS" start="2023-11-13T15:33:07.169409" elapsed="0.000416"/>
+</kw>
+<status status="PASS" start="2023-11-13T15:33:07.168330" elapsed="0.001748"/>
+</test>
+<status status="PASS" start="2023-11-13T15:33:07.134805" elapsed="0.035963"/>
+</suite>
+<statistics>
+<total>
+<stat pass="1" fail="0" skip="0">All Tests</stat>
+</total>
+<tag>
+</tag>
+<suite>
+<stat pass="1" fail="0" skip="0" id="s1" name="Rf7">Rf7</stat>
+</suite>
+</statistics>
+<errors>
+</errors>
+</robot>