Merge pull request #64 from reportportal/develop

Release

Author: HardNorth

CHANGELOG.md

@@ -1,5 +1,29 @@
 # Changelog
 
-[Unreleased]
+## [Unreleased]
+### Fixed
+- A bug whe ambiguous item cases a Null Pointer Exception
+- Incorrect item type settings
+### Added
+- Nested steps support
 
 ## [5.0.0-BETA-12]
+### Added
+- multi-thread execution support
+- Test Case ID support
+### Fixed
+- codeRef reporting was added for every item in an item tree
+
+## [3.0.0]
+### New Features 
+- Migrate to 3x client generation
+- Asynchronous reporting
+
+## [2.6.1]
+### Changed 
+- access modifier to 'protected' for rootSuiteId in ScenarioReporter to allow inherit this reporter without unnecessary code duplication.
+
+## [2.6.0]
+### Released: 20 November 2016
+### New Features
+- Initial release to Public Maven Repositories

README.md

@@ -1,6 +1,7 @@
 # Cucumber Agent for ReportPortal
  [ ![Download](https://api.bintray.com/packages/epam/reportportal/agent-java-cucumber/images/download.svg) ](https://bintray.com/epam/reportportal/agent-java-cucumber/_latestVersion)
 
+![CI Build](https://github.com/reportportal/agent-java-cucumber/workflows/CI%20Build/badge.svg)
 [![Join Slack chat!](https://reportportal-slack-auto.herokuapp.com/badge.svg)](https://reportportal-slack-auto.herokuapp.com)
 [![stackoverflow](https://img.shields.io/badge/reportportal-stackoverflow-orange.svg?style=flat)](http://stackoverflow.com/questions/tagged/reportportal)
 [![UserVoice](https://img.shields.io/badge/uservoice-vote%20ideas-orange.svg?style=flat)](https://rpp.uservoice.com/forums/247117-report-portal)

build.gradle

@@ -48,12 +48,13 @@ publishing {
 }
 
 dependencies {
-    api 'com.epam.reportportal:client-java:5.0.6'
+    api 'com.epam.reportportal:client-java:5.0.7'
     api 'com.epam.reportportal:commons-model:5.0.0'
     api 'com.google.code.findbugs:jsr305:3.0.2'
 
     implementation 'info.cukes:gherkin:2.12.2'
 
+    testImplementation 'org.aspectj:aspectjweaver:1.9.2'
     testImplementation 'info.cukes:cucumber-java:1.2.6'
     testImplementation 'info.cukes:cucumber-testng:1.2.6'
     testImplementation 'org.hamcrest:hamcrest-core:2.2'
@@ -73,7 +74,17 @@ dependencies {
 }
 
 test {
+    outputs.upToDateWhen { return false }
     useJUnitPlatform()
+    maxParallelForks(5) // it's forks - separate JVMs, should not interfere each other
+    doFirst {
+        def weaver = configurations.testRuntimeClasspath.find { it.name.contains("aspectjweaver") }
+        jvmArgs += "-javaagent:$weaver"
+    }
+    testLogging {
+        events "failed"
+        exceptionFormat "full"
+    }
 }
 
 wrapper {

src/main/java/com/epam/reportportal/cucumber/AbstractReporter.java

@@ -51,11 +51,6 @@ public abstract class AbstractReporter implements Formatter, Reporter {
 	protected static final String COLON_INFIX = ": ";
 	private static final String SKIPPED_ISSUE_KEY = "skippedIssue";
 
-	protected String stepPrefix;
-
-	protected Queue<String> outlineIterations;
-	private Boolean inBackground;
-
 	protected final ThreadLocal<String> currentFeatureUri = new ThreadLocal<>();
 	protected final ThreadLocal<RunningContext.FeatureContext> currentFeatureContext = new ThreadLocal<>();
 	protected final ThreadLocal<RunningContext.ScenarioContext> currentScenarioContext = new ThreadLocal<>();
@@ -98,12 +93,6 @@ public Launch get() {
 		}
 	});
 
-	protected AbstractReporter() {
-		outlineIterations = new ArrayDeque<>();
-		stepPrefix = "";
-		inBackground = false;
-	}
-
 	/**
 	 * Extension point to customize ReportPortal instance
 	 *
@@ -152,6 +141,15 @@ protected void afterFeature() {
 		}
 	}
 
+	protected RunningContext.ScenarioContext getCurrentScenarioContext() {
+		RunningContext.ScenarioContext context = currentScenarioContext.get();
+		if (context == null) {
+			context = new RunningContext.ScenarioContext();
+			currentScenarioContext.set(context);
+		}
+		return context;
+	}
+
 	/**
 	 * Start Cucumber Feature (if not started) and Scenario
 	 *
@@ -179,27 +177,30 @@ protected void beforeScenario(Scenario scenario, String outlineIteration) {
 		Maybe<String> id = Utils.startNonLeafNode(
 				launch.get(),
 				currentFeature.getId(),
-				Utils.buildStatementName(scenario, null, AbstractReporter.COLON_INFIX, outlineIteration),
+				Utils.buildStatementName(scenario, null, outlineIteration),
 				currentFeatureUri.get(),
 				codeRef,
 				scenario.getTags(),
 				getScenarioTestItemType()
 		);
-		currentScenarioContext.set(new RunningContext.ScenarioContext(id));
+		RunningContext.ScenarioContext context = getCurrentScenarioContext();
+		context.setId(id);
 	}
 
 	/**
 	 * Finish Cucumber scenario
 	 */
 	protected void afterScenario() {
-		RunningContext.ScenarioContext context = currentScenarioContext.get();
+		RunningContext.ScenarioContext context = getCurrentScenarioContext();
 		Utils.finishTestItem(launch.get(), context.getId(), context.getStatus());
+		currentScenarioContext.set(null);
 	}
 
 	/**
 	 * Start Cucumber step
 	 *
-	 * @param step Step object
+	 * @param step  Step object
+	 * @param match Match object
 	 */
 	protected abstract void beforeStep(Step step, Match match);
 
@@ -250,10 +251,8 @@ protected void reportResult(Result result, String message) {
 		if (message != null) {
 			Utils.sendLog(message, level, null);
 		}
-		RunningContext.ScenarioContext currentScenario = currentScenarioContext.get();
-		if (currentScenario != null) {
-			currentScenario.updateStatus(Utils.mapStatus(result.getStatus()));
-		}
+		RunningContext.ScenarioContext currentScenario = getCurrentScenarioContext();
+		currentScenario.updateStatus(Utils.mapStatus(result.getStatus()));
 	}
 
 	/**
@@ -281,7 +280,8 @@ public void before(Match match, Result result) {
 	@Override
 	public void result(Result result) {
 		afterStep(result);
-		if (!inBackground && currentScenarioContext.get().noMoreSteps()) {
+		RunningContext.ScenarioContext context = getCurrentScenarioContext();
+		if (!context.isInBackground() && context.noMoreSteps()) {
 			beforeHooks(false);
 		}
 	}
@@ -293,7 +293,7 @@ public void after(Match match, Result result) {
 
 	@Override
 	public void match(Match match) {
-		beforeStep(currentScenarioContext.get().getNextStep(), match);
+		beforeStep(getCurrentScenarioContext().getNextStep(), match);
 	}
 
 	@Override
@@ -334,40 +334,46 @@ public void scenarioOutline(ScenarioOutline scenarioOutline) {
 	@Override
 	public void examples(Examples examples) {
 		// examples always have headers; therefore up to num - 1
-		IntStream.range(1, examples.getRows().size()).forEach(it -> outlineIterations.add(String.format("[%d]", it)));
+		RunningContext.ScenarioContext context = getCurrentScenarioContext();
+		Queue<String> iterations = context.getOutlineIterations();
+		IntStream.range(1, examples.getRows().size()).forEach(it -> iterations.add(String.format("[%d]", it)));
 	}
 
 	@Override
 	public void startOfScenarioLifeCycle(Scenario scenario) {
-		inBackground = false;
-		beforeScenario(scenario, outlineIterations.poll());
+		RunningContext.ScenarioContext context = getCurrentScenarioContext();
+		String iteration = context.getOutlineIterations().poll();
+		context.setInBackground(false);
+		beforeScenario(scenario, iteration);
 		beforeHooks(true);
 	}
 
 	@Override
 	public void background(Background background) {
 		afterHooks(true);
-		inBackground = true;
-		stepPrefix = background.getKeyword().toUpperCase() + AbstractReporter.COLON_INFIX;
+		RunningContext.ScenarioContext context = getCurrentScenarioContext();
+		context.setInBackground(true);
+		context.setStepPrefix(background.getKeyword().toUpperCase() + AbstractReporter.COLON_INFIX);
 	}
 
 	@Override
 	public void scenario(Scenario scenario) {
-		if (!inBackground) { // if there was no background
+		RunningContext.ScenarioContext context = getCurrentScenarioContext();
+		if (!context.isInBackground()) { // if there was no background
 			afterHooks(true);
 		} else {
-			inBackground = false;
+			context.setInBackground(false);
 		}
-		stepPrefix = "";
+		context.setStepPrefix("");
 	}
 
 	@Override
 	public void step(Step step) {
-		RunningContext.ScenarioContext currentScenario = currentScenarioContext.get();
-		if (currentScenario != null) {
-			currentScenario.addStep(step);
+		RunningContext.ScenarioContext context = currentScenarioContext.get();
+		if (context != null) {
+			// Skip scenario outlines steps without initialized parameters
+			context.addStep(step);
 		}
-		// otherwise it's a step collection in an outline, useless.
 	}
 
 	@Override

src/main/java/com/epam/reportportal/cucumber/RunningContext.java

@@ -5,6 +5,7 @@
 import gherkin.formatter.model.Step;
 import io.reactivex.Maybe;
 
+import javax.annotation.Nonnull;
 import java.util.ArrayDeque;
 import java.util.Queue;
 
@@ -33,20 +34,55 @@ public StartTestItemRQ getItemRq() {
 
 	public static class ScenarioContext {
 
+		private boolean inBackground;
+		private String stepPrefix;
 		private Maybe<String> currentStepId;
 		private Maybe<String> hookStepId;
 		private ItemStatus hookStatus;
 
-		private final Maybe<String> id;
 		private final Queue<Step> steps;
+		private final Queue<String> outlineIterations;
+
+		private Maybe<String> id;
 		private ItemStatus status;
 
-		public ScenarioContext(Maybe<String> newId) {
-			id = newId;
+		public ScenarioContext() {
+			stepPrefix = "";
 			steps = new ArrayDeque<>();
+			outlineIterations = new ArrayDeque<>();
 			status = ItemStatus.PASSED;
 		}
 
+		public ScenarioContext(Maybe<String> newId) {
+			this();
+			id = newId;
+		}
+
+		@Nonnull
+		public Queue<String> getOutlineIterations() {
+			return outlineIterations;
+		}
+
+		public void setId(Maybe<String> id) {
+			this.id = id;
+		}
+
+		public boolean isInBackground() {
+			return inBackground;
+		}
+
+		public void setInBackground(boolean inBackground) {
+			this.inBackground = inBackground;
+		}
+
+		public String getStepPrefix() {
+			return stepPrefix;
+		}
+
+		public void setStepPrefix(String prefix) {
+			stepPrefix = prefix;
+		}
+
 		public Maybe<String> getCurrentStepId() {
 			return currentStepId;
 		}