Add Serenity 4 Support (#170)

170: Added Serenity 4 Support

Author: grey-rain

.github/workflows/junit-test.yml

@@ -17,7 +17,7 @@ jobs:
       - name: Set up Java
         uses: actions/setup-java@v3
         with:
-          java-version: '8'
+          java-version: '11'
           distribution: 'adopt'
           cache: 'maven'
 

README.md

@@ -1,10 +1,11 @@
 <?xml version="1.0" encoding="UTF-8"?>
-<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
+<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
     <modelVersion>4.0.0</modelVersion>
 
     <groupId>com.github.invictum</groupId>
     <artifactId>serenity-reportportal-integration</artifactId>
-    <version>1.5.9-SNAPSHOT</version>
+    <version>1.6.0-SNAPSHOT</version>
 
     <packaging>jar</packaging>
 
@@ -37,34 +38,47 @@
     <properties>
         <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
         <project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
+        <serenity.version>4.0.8</serenity.version>
+        <rp.client.version>5.1.22</rp.client.version>
+        <rp.commons.version>5.8.1</rp.commons.version>
     </properties>
 
     <dependencies>
         <dependency>
             <groupId>net.serenity-bdd</groupId>
             <artifactId>serenity-core</artifactId>
-            <version>2.3.4</version>
+            <version>${serenity.version}</version>
         </dependency>
         <dependency>
             <groupId>com.epam.reportportal</groupId>
             <artifactId>client-java</artifactId>
-            <version>5.0.11</version>
+            <version>${rp.client.version}</version>
         </dependency>
         <dependency>
             <groupId>com.epam.reportportal</groupId>
             <artifactId>commons-model</artifactId>
-            <version>5.3.0</version>
+            <version>${rp.commons.version}</version>
         </dependency>
         <dependency>
             <groupId>junit</groupId>
             <artifactId>junit</artifactId>
             <version>4.13.1</version>
             <scope>test</scope>
         </dependency>
+        <dependency>
+            <groupId>com.google.inject</groupId>
+            <artifactId>guice</artifactId>
+            <version>7.0.0</version>
+        </dependency>
+        <dependency>
+            <groupId>org.apache.tika</groupId>
+            <artifactId>tika-core</artifactId>
+            <version>2.9.0</version>
+        </dependency>
         <dependency>
             <groupId>org.mockito</groupId>
             <artifactId>mockito-core</artifactId>
-            <version>3.0.0</version>
+            <version>5.5.0</version>
             <scope>test</scope>
         </dependency>
     </dependencies>
@@ -125,7 +139,7 @@
                     <plugin>
                         <groupId>org.apache.maven.plugins</groupId>
                         <artifactId>maven-javadoc-plugin</artifactId>
-                        <version>2.10.4</version>
+                        <version>3.6.0</version>
                         <executions>
                             <execution>
                                 <id>attach-javadocs</id>
@@ -138,7 +152,7 @@
                     <plugin>
                         <groupId>org.apache.maven.plugins</groupId>
                         <artifactId>maven-source-plugin</artifactId>
-                        <version>3.0.1</version>
+                        <version>3.3.0</version>
                         <executions>
                             <execution>
                                 <id>attach-sources</id>
@@ -151,7 +165,7 @@
                     <plugin>
                         <groupId>org.apache.maven.plugins</groupId>
                         <artifactId>maven-gpg-plugin</artifactId>
-                        <version>1.5</version>
+                        <version>3.1.0</version>
                         <executions>
                             <execution>
                                 <id>sign-artifacts</id>

pom.xml

@@ -2,7 +2,7 @@
 
 import com.epam.reportportal.service.ReportPortal;
 import com.epam.ta.reportportal.ws.model.log.SaveLogRQ;
-import net.thucydides.core.model.TestStep;
+import net.thucydides.model.domain.TestStep;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 

src/main/java/com/github/invictum/reportportal/LogUnitsHolder.java

@@ -4,7 +4,7 @@
 import com.github.invictum.reportportal.log.unit.*;
 import com.github.invictum.reportportal.log.unit.Error;
 import com.google.common.base.Preconditions;
-import net.thucydides.core.model.TestStep;
+import net.thucydides.model.domain.TestStep;
 
 import java.util.Collection;
 import java.util.function.Function;

src/main/java/com/github/invictum/reportportal/LogsPreset.java

@@ -1,8 +1,8 @@
 package com.github.invictum.reportportal;
 
-import net.thucydides.core.annotations.Narrative;
-import net.thucydides.core.model.TestOutcome;
-import net.thucydides.core.requirements.annotations.NarrativeFinder;
+import net.serenitybdd.annotations.Narrative;
+import net.thucydides.model.domain.TestOutcome;
+import net.thucydides.model.requirements.annotations.NarrativeFinder;
 
 import java.util.Optional;
 import java.util.function.Function;
@@ -32,7 +32,7 @@ public Optional<String> extract() {
     private String classNarrative() {
         Class testCase = test.getTestCase();
         //We test if test case is null, in that case narrative extracted from TestOutcome should be empty
-        if(testCase == null)    return "";
+        if (testCase == null) return "";
         return NarrativeFinder.forClass(testCase).map(formatter).orElse(null);
     }
 }

src/main/java/com/github/invictum/reportportal/NarrativeExtractor.java

@@ -1,6 +1,7 @@
 package com.github.invictum.reportportal;
 
-import net.thucydides.core.annotations.Narrative;
+
+import net.serenitybdd.annotations.Narrative;
 
 import java.util.Objects;
 import java.util.function.Function;

src/main/java/com/github/invictum/reportportal/ReportIntegrationConfig.java

@@ -3,15 +3,19 @@
 import com.github.invictum.reportportal.injector.IntegrationInjector;
 import com.github.invictum.reportportal.recorder.TestRecorder;
 import com.google.inject.Inject;
-import net.thucydides.core.model.DataTable;
-import net.thucydides.core.model.Story;
-import net.thucydides.core.model.TestOutcome;
-import net.thucydides.core.steps.ExecutedStepDescription;
-import net.thucydides.core.steps.StepFailure;
-import net.thucydides.core.steps.StepListener;
 import net.thucydides.core.webdriver.ThucydidesWebDriverSupport;
+import net.thucydides.model.domain.DataTable;
+import net.thucydides.model.domain.Story;
+import net.thucydides.model.domain.TestOutcome;
+import net.thucydides.model.domain.TestResult;
+import net.thucydides.model.screenshots.ScreenshotAndHtmlSource;
+import net.thucydides.model.steps.ExecutedStepDescription;
+import net.thucydides.model.steps.StepFailure;
+import net.thucydides.model.steps.StepListener;
 import org.openqa.selenium.logging.Logs;
 
+import java.time.ZonedDateTime;
+import java.util.List;
 import java.util.Map;
 
 public class ReportPortalListener implements StepListener {
@@ -26,116 +30,173 @@ public ReportPortalListener() {
         IntegrationInjector.getInjector().injectMembers(this);
     }
 
-    public void testSuiteStarted(Class<?> storyClass) {
+    @Override
+    public void testSuiteStarted(Class<?> aClass) {
         // Not used by listener
     }
 
+    @Override
     public void testSuiteStarted(Story story) {
         // Not used by listener
     }
 
+    @Override
     public void testSuiteFinished() {
         suiteStorage.finalizeActive();
     }
 
-    public void testStarted(String description) {
+    @Override
+    public void testStarted(String s) {
         // Not used by listener
     }
 
-    public void testStarted(String description, String id) {
+    @Override
+    public void testStarted(String s, String s1) {
         // Not used by listener
     }
 
-    public void testFinished(TestOutcome result) {
-        TestRecorder recorder = TestRecorder.forTest(result);
-        recorder.record(result);
+    @Override
+    public void testStarted(String s, String s1, ZonedDateTime zonedDateTime) {
+        // Not used by listener
+    }
+
+    @Override
+    public void testFinished(TestOutcome testOutcome) {
+        TestRecorder recorder = TestRecorder.forTest(testOutcome);
+        recorder.record(testOutcome);
         logStorage.clean();
     }
 
+    @Override
+    public void testFinished(TestOutcome testOutcome, boolean b, ZonedDateTime zonedDateTime) {
+        testFinished(testOutcome);
+    }
+
+    @Override
     public void testRetried() {
         // Not used by listener
     }
 
-    public void stepStarted(ExecutedStepDescription description) {
+    @Override
+    public void stepStarted(ExecutedStepDescription executedStepDescription) {
         // Not used by listener
     }
 
-    public void skippedStepStarted(ExecutedStepDescription description) {
+    @Override
+    public void skippedStepStarted(ExecutedStepDescription executedStepDescription) {
         // Not used by listener
     }
 
-    public void stepFailed(StepFailure failure) {
+    @Override
+    public void stepFailed(StepFailure stepFailure) {
         harvestDriverLogs();
     }
 
-    public void lastStepFailed(StepFailure failure) {
+    @Override
+    public void stepFailed(StepFailure stepFailure, List<ScreenshotAndHtmlSource> list) {
+        harvestDriverLogs();
+    }
+
+    @Override
+    public void lastStepFailed(StepFailure stepFailure) {
         // Not used by listener
     }
 
+    @Override
     public void stepIgnored() {
         // Not used by listener
     }
 
+    @Override
     public void stepPending() {
         // Not used by listener
     }
 
-    public void stepPending(String message) {
+    @Override
+    public void stepPending(String s) {
         // Not used by listener
     }
 
+    @Override
     public void stepFinished() {
         harvestDriverLogs();
     }
 
-    public void testFailed(TestOutcome testOutcome, Throwable cause) {
+    @Override
+    public void stepFinished(List<ScreenshotAndHtmlSource> list, ZonedDateTime zonedDateTime) {
+        harvestDriverLogs();
+    }
+
+    @Override
+    public void testFailed(TestOutcome testOutcome, Throwable throwable) {
         // Not used by listener
     }
 
+    @Override
     public void testIgnored() {
         // Not used by listener
     }
 
+    @Override
     public void testSkipped() {
         // Not used by listener
     }
 
+    @Override
     public void testPending() {
         // Not used by listener
     }
 
+    @Override
     public void testIsManual() {
         // Not used by listener
     }
 
+    @Override
     public void notifyScreenChange() {
         // Not used by listener
     }
 
-    public void useExamplesFrom(DataTable table) {
+    @Override
+    public void useExamplesFrom(DataTable dataTable) {
         // Not used by listener
     }
 
-    public void addNewExamplesFrom(DataTable table) {
+    @Override
+    public void addNewExamplesFrom(DataTable dataTable) {
         // Not used by listener
     }
 
+    @Override
     public void exampleStarted(Map<String, String> data) {
         // Not used by listener
     }
 
+    @Override
     public void exampleFinished() {
         // Not used by listener
     }
 
+    @Override
     public void assumptionViolated(String message) {
         // Not used by listener
     }
 
+    @Override
     public void testRunFinished() {
         // Not used by listener
     }
 
+    @Override
+    public void takeScreenshots(List<ScreenshotAndHtmlSource> list) {
+        // Not used by listener
+    }
+
+    @Override
+    public void takeScreenshots(TestResult testResult, List<ScreenshotAndHtmlSource> list) {
+        // Not used by listener
+    }
+
     private void harvestDriverLogs() {
         boolean harvestLogs = ReportIntegrationConfig.get().harvestSeleniumLogs;
         if (harvestLogs && ThucydidesWebDriverSupport.isDriverInstantiated()) {

src/main/java/com/github/invictum/reportportal/ReportPortalListener.java

@@ -5,8 +5,8 @@
 import com.epam.ta.reportportal.ws.model.attribute.ItemAttributesRQ;
 import com.google.common.base.Preconditions;
 import com.google.common.base.Strings;
-import net.thucydides.core.model.DataTable;
-import net.thucydides.core.model.TestTag;
+import net.thucydides.model.domain.DataTable;
+import net.thucydides.model.domain.TestTag;
 import org.apache.commons.lang3.StringUtils;
 
 import java.time.ZonedDateTime;

src/main/java/com/github/invictum/reportportal/StartEventBuilder.java

@@ -1,6 +1,7 @@
 package com.github.invictum.reportportal;
 
-import net.thucydides.core.model.TestResult;
+
+import net.thucydides.model.domain.TestResult;
 
 import java.util.Arrays;
 import java.util.List;