Skip to content

Commit

Permalink
Merge pull request #125 from qase-tms/cucmber6-params
Browse files Browse the repository at this point in the history 
cucumber 6 parameterization support
  • Loading branch information
@savkk
savkk committed Nov 18, 2023
2 parents b8c6c74 + 5faba3f commit 03051e4
Show file tree
Hide file tree
Showing 7 changed files with 185 additions and 10 deletions.
5 changes: 3 additions & 2 deletions qase-cucumber5-jvm/src/test/java/io/qase/cucumber5/QaseEventListenerTests.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -73,7 +73,8 @@ void bulk() {
String[] args = new String[]{
"-g", "io.qase.cucumber5",
"--add-plugin", "io.qase.cucumber5.QaseEventListener",
"classpath:features/"
"classpath:features/",
"--threads", "4"
};
Main.run(args, Thread.currentThread().getContextClassLoader());

Expand Down Expand Up @@ -247,7 +248,7 @@ void bulk() {
" \"action\" : \"Given success step\"\n" +
" } ]\n" +
" } ]\n" +
"}")));
"}", true, false)));
}

@Test
Expand Down
5 changes: 5 additions & 0 deletions qase-cucumber6-jvm/pom.xml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,11 @@
<artifactId>cucumber-java</artifactId>
<version>${cucumber6-java.version}</version>
</dependency>
<dependency>
<groupId>io.cucumber</groupId>
<artifactId>gherkin</artifactId>
<version>18.0.0</version>
</dependency>
<dependency>
<groupId>org.projectlombok</groupId>
<artifactId>lombok</artifactId>
Expand Down
67 changes: 62 additions & 5 deletions qase-cucumber6-jvm/src/main/java/io/qase/cucumber6/QaseEventListener.java
View file
Original file line number Diff line number Diff line change
@@ -1,5 +1,8 @@
package io.qase.cucumber6;

import io.cucumber.gherkin.Gherkin;
import io.cucumber.messages.IdGenerator;
import io.cucumber.messages.Messages;
import io.cucumber.plugin.ConcurrentEventListener;
import io.cucumber.plugin.event.*;
import io.qase.api.QaseClient;
Expand All @@ -16,18 +19,22 @@
import lombok.AccessLevel;
import lombok.Getter;

import java.util.LinkedList;
import java.util.List;
import java.util.Optional;
import java.net.URI;
import java.util.*;
import java.util.stream.Stream;

import static io.cucumber.gherkin.Gherkin.makeSourceEnvelope;
import static io.qase.api.utils.CucumberUtils.getHash;
import static io.qase.api.utils.IntegrationUtils.getStacktrace;

public class QaseEventListener implements ConcurrentEventListener {

private static final Map<Integer, Map<String, String>> EXAMPLES = new HashMap<>();
private static final String REPORTER_NAME = "Cucumber 6-JVM";

@Getter(lazy = true, value = AccessLevel.PRIVATE)
private final QaseTestCaseListener qaseTestCaseListener = createQaseListener();
private final Map<URI, String> sources = new HashMap<>();

static {
System.setProperty(QaseConfig.QASE_CLIENT_REPORTER_NAME_KEY, REPORTER_NAME);
Expand All @@ -36,6 +43,7 @@ public class QaseEventListener implements ConcurrentEventListener {
@Override
public void setEventPublisher(EventPublisher publisher) {
if (QaseClient.isEnabled()) {
publisher.registerHandlerFor(TestSourceRead.class, this::testSourceRead);
publisher.registerHandlerFor(TestCaseStarted.class, this::testCaseStarted);
publisher.registerHandlerFor(TestCaseFinished.class, this::testCaseFinished);
publisher.registerHandlerFor(TestRunFinished.class, this::testRunFinished);
Expand All @@ -44,6 +52,10 @@ public void setEventPublisher(EventPublisher publisher) {
}
}

private void testSourceRead(TestSourceRead testSourceRead) {
sources.put(testSourceRead.getUri(), testSourceRead.getSource());
}

private void testCaseStarted(TestStepStarted testStepStarted) {
if (testStepStarted.getTestStep() instanceof PickleStepTestStep) {
StepStorage.startStep();
Expand Down Expand Up @@ -88,20 +100,63 @@ private void testRunFinished(TestRunFinished testRunFinished) {
}

private void testCaseStarted(TestCaseStarted event) {
URI uri = event.getTestCase().getUri();
if (EXAMPLES.get(getHash(uri, (long) event.getTestCase().getLine())) == null && sources.containsKey(uri)) {

Messages.Envelope envelope = makeSourceEnvelope(this.sources.get(uri), uri.toString());

Stream<Messages.Envelope> envelopes = Gherkin.fromSources(
Collections.singletonList(envelope),
true,
true,
true,
new IdGenerator.UUID());

envelopes
.filter(Messages.Envelope::hasGherkinDocument)
.map(Messages.Envelope::getGherkinDocument)
.findFirst()
.ifPresent(gherkinDocument -> parseExamples(uri, gherkinDocument));
}
getQaseTestCaseListener().onTestCaseStarted();
}

private void parseExamples(URI uri, Messages.GherkinDocument gherkinDocument) {
Messages.GherkinDocument.Feature feature = gherkinDocument.getFeature();
List<Messages.GherkinDocument.Feature.FeatureChild> childrenList = feature.getChildrenList();
for (int i = 0; i < childrenList.size(); i++) {
List<Messages.GherkinDocument.Feature.Scenario.Examples> examplesList = childrenList.get(i).getScenario().getExamplesList();
for (int j = 0; j < examplesList.size(); j++) {
List<String> headers = new ArrayList<>();
Messages.GherkinDocument.Feature.TableRow tableHeader = examplesList.get(j).getTableHeader();
tableHeader.getCellsList().forEach(h -> headers.add(h.getValue()));
List<Messages.GherkinDocument.Feature.TableRow> tableBodyList = examplesList.get(j).getTableBodyList();
for (int k = 0; k < tableBodyList.size(); k++) {
Messages.GherkinDocument.Feature.TableRow tableRow = tableBodyList.get(k);
List<Messages.GherkinDocument.Feature.TableRow.TableCell> cellsList = tableRow.getCellsList();
HashMap<String, String> example = new HashMap<>();
for (int l = 0; l < cellsList.size(); l++) {
String value = cellsList.get(l).getValue();
example.put(headers.get(l), value);
}
EXAMPLES.put(getHash(uri, (long) tableRow.getLocation().getLine()), example);
}
}
}
}

private void testCaseFinished(TestCaseFinished event) {
getQaseTestCaseListener().onTestCaseFinished(resultCreate -> setupResultItem(resultCreate, event));
}

private void setupResultItem(ResultCreate resultCreate, TestCaseFinished event) {
List<String> tags = event.getTestCase().getTags();
TestCase testCase = event.getTestCase();
List<String> tags = testCase.getTags();
Long caseId = CucumberUtils.getCaseId(tags);

String caseTitle = null;
if (caseId == null) {
caseTitle = event.getTestCase().getName();
caseTitle = testCase.getName();
}

StatusEnum status = convertStatus(event.getResult().getStatus());
Expand All @@ -122,6 +177,8 @@ private void setupResultItem(ResultCreate resultCreate, TestCaseFinished event)
.stacktrace(stacktrace)
.steps(steps.isEmpty() ? null : steps)
.defect(isDefect);
Map<String, String> params = EXAMPLES.get(getHash(testCase.getUri(), (long) testCase.getLocation().getLine()));
resultCreate.param(params);
}

private StatusEnum convertStatus(Status status) {
Expand Down
97 changes: 95 additions & 2 deletions qase-cucumber6-jvm/src/test/java/io/qase/cucumber6/QaseEventListenerTests.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -74,7 +74,8 @@ void bulk() {
String[] args = new String[]{
"-g", "io.qase.cucumber6",
"--plugin", "io.qase.cucumber6.QaseEventListener",
"classpath:features/"
"classpath:features/",
"--threads", "4"
};
Main.run(args, Thread.currentThread().getContextClassLoader());

Expand Down Expand Up @@ -155,8 +156,100 @@ void bulk() {
" \"status\" : \"passed\",\n" +
" \"action\" : \"Given success step\"\n" +
" } ]\n" +
" }, {\n" +
" \"case\" : {\n" +
" \"title\" : \"success with Positive Examples\"\n" +
" },\n" +
" \"status\" : \"passed\",\n" +
" \"time_ms\" : \"${json-unit.ignore}\",\n" +
" \"defect\" : false,\n" +
" \"param\" : {\n" +
" \"a\" : \"\\\"1\\\"\",\n" +
" \"b\" : \"\\\"2\\\"\"\n" +
" },\n" +
" \"steps\" : [ {\n" +
" \"position\" : 1,\n" +
" \"status\" : \"passed\",\n" +
" \"action\" : \"Given success step with parameter \\\"1\\\"\"\n" +
" }, {\n" +
" \"position\" : 2,\n" +
" \"status\" : \"passed\",\n" +
" \"action\" : \"Given success step with parameter \\\"2\\\"\"\n" +
" } ]\n" +
" }, {\n" +
" \"case\" : {\n" +
" \"title\" : \"success with Positive Examples\"\n" +
" },\n" +
" \"status\" : \"passed\",\n" +
" \"time_ms\" : \"${json-unit.ignore}\",\n" +
" \"defect\" : false,\n" +
" \"param\" : {\n" +
" \"a\" : \"\\\"3\\\"\",\n" +
" \"b\" : \"\\\"4\\\"\"\n" +
" },\n" +
" \"steps\" : [ {\n" +
" \"position\" : 1,\n" +
" \"status\" : \"passed\",\n" +
" \"action\" : \"Given success step with parameter \\\"3\\\"\"\n" +
" }, {\n" +
" \"position\" : 2,\n" +
" \"status\" : \"passed\",\n" +
" \"action\" : \"Given success step with parameter \\\"4\\\"\"\n" +
" } ]\n" +
" }, {\n" +
" \"case\" : {\n" +
" \"title\" : \"success with Positive Examples\"\n" +
" },\n" +
" \"status\" : \"passed\",\n" +
" \"time_ms\" : \"${json-unit.ignore}\",\n" +
" \"defect\" : false,\n" +
" \"param\" : {\n" +
" \"a\" : \"\\\"5\\\"\",\n" +
" \"b\" : \"\\\"6\\\"\"\n" +
" },\n" +
" \"steps\" : [ {\n" +
" \"position\" : 1,\n" +
" \"status\" : \"passed\",\n" +
" \"action\" : \"Given success step with parameter \\\"5\\\"\"\n" +
" }, {\n" +
" \"position\" : 2,\n" +
" \"status\" : \"passed\",\n" +
" \"action\" : \"Given success step with parameter \\\"6\\\"\"\n" +
" } ]\n" +
" }, {\n" +
" \"case\" : {\n" +
" \"title\" : \"success with Positive Examples\"\n" +
" },\n" +
" \"status\" : \"passed\",\n" +
" \"time_ms\" : \"${json-unit.ignore}\",\n" +
" \"defect\" : false,\n" +
" \"param\" : {\n" +
" \"a\" : \"\\\"7\\\"\",\n" +
" \"b\" : \"\\\"8\\\"\"\n" +
" },\n" +
" \"steps\" : [ {\n" +
" \"position\" : 1,\n" +
" \"status\" : \"passed\",\n" +
" \"action\" : \"Given success step with parameter \\\"7\\\"\"\n" +
" }, {\n" +
" \"position\" : 2,\n" +
" \"status\" : \"passed\",\n" +
" \"action\" : \"Given success step with parameter \\\"8\\\"\"\n" +
" } ]\n" +
" }, {\n" +
" \"case\" : {\n" +
" \"title\" : \"Success scenario\"\n" +
" },\n" +
" \"status\" : \"passed\",\n" +
" \"time_ms\" : \"${json-unit.ignore}\",\n" +
" \"defect\" : false,\n" +
" \"steps\" : [ {\n" +
" \"position\" : 1,\n" +
" \"status\" : \"passed\",\n" +
" \"action\" : \"Given success step\"\n" +
" } ]\n" +
" } ]\n" +
"}")));
"}", true, false)));
}

@Test
Expand Down
4 changes: 4 additions & 0 deletions qase-cucumber6-jvm/src/test/java/io/qase/cucumber6/Steps.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,10 @@ public class Steps {
public void success() {
}

@Given("success step with parameter {string}")
public void success_step_with_parameter(String string) {
}

@Given("timeout {int} seconds")
public void success(int integer) throws InterruptedException {
TimeUnit.SECONDS.sleep(integer);
Expand Down
15 changes: 15 additions & 0 deletions qase-cucumber6-jvm/src/test/resources/features/with_examples.feature
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
Feature: New case with examples

Scenario Outline: success with Positive Examples
Given success step with parameter <a>
Given success step with parameter <b>

Examples:
| a | b |
| "1" | "2" |
| "3" | "4" |
| "5" | "6" |
| "7" | "8" |

Scenario: Success scenario
Given success step
2 changes: 1 addition & 1 deletion qase-cucumber7-jvm/src/test/java/io/qase/cucumber7/QaseEventListenerTests.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -75,7 +75,7 @@ void bulk() {
"-g", "io.qase.cucumber7",
"--plugin", "io.qase.cucumber7.QaseEventListener",
"classpath:features/",
"--threads", "2"
"--threads", "4"
};
Main.run(args, Thread.currentThread().getContextClassLoader());

Expand Down

0 comments on commit 03051e4

Please sign in to comment.