fix jbehave runtime api (via #1022)

allure-framework · Mar 26, 2024 · c2268cb · c2268cb
1 parent 6ff650c
commit c2268cb
Show file tree

Hide file tree

Showing 4 changed files with 88 additions and 3 deletions.
diff --git a/allure-jbehave5/src/main/java/io/qameta/allure/jbehave5/AllureJbehave5.java b/allure-jbehave5/src/main/java/io/qameta/allure/jbehave5/AllureJbehave5.java
@@ -24,6 +24,7 @@
 import io.qameta.allure.model.StatusDetails;
 import io.qameta.allure.model.StepResult;
 import io.qameta.allure.model.TestResult;
+import io.qameta.allure.util.ResultsUtils;
 import org.jbehave.core.failures.UUIDExceptionWrapper;
 import org.jbehave.core.model.ExamplesTable;
 import org.jbehave.core.model.Scenario;
@@ -227,13 +228,15 @@ protected void startTestCase(final String uuid,
                 .map(entry -> createParameter(entry.getKey(), entry.getValue()))
                 .collect(Collectors.toList());
 
-        final List<Label> labels = Arrays.asList(
+        final List<Label> labels = new ArrayList<>(Arrays.asList(
                 createStoryLabel(story.getName()),
                 createHostLabel(),
                 createThreadLabel(),
                 createFrameworkLabel("jbehave"),
                 createLanguageLabel("java")
-        );
+        ));
+
+        labels.addAll(ResultsUtils.getProvidedLabels());
 
         final String historyId = getHistoryId(fullName, parameters);
 

diff --git a/allure-jbehave5/src/test/java/io/qameta/allure/jbehave5/AllureJbehave5Test.java b/allure-jbehave5/src/test/java/io/qameta/allure/jbehave5/AllureJbehave5Test.java
@@ -17,7 +17,10 @@
 
 import io.qameta.allure.Issue;
 import io.qameta.allure.jbehave5.samples.BrokenStorySteps;
+import io.qameta.allure.jbehave5.samples.RuntimeApiSteps;
 import io.qameta.allure.jbehave5.samples.SimpleStorySteps;
+import io.qameta.allure.model.Attachment;
+import io.qameta.allure.model.Label;
 import io.qameta.allure.model.Parameter;
 import io.qameta.allure.model.Stage;
 import io.qameta.allure.model.Status;
@@ -259,6 +262,47 @@ void shouldNotFailIfGivenStoriesSpecified() {
 
     }
 
+    @Test
+    void shouldSupportRuntimeApiInSteps() {
+        final AllureResults results = runStories("stories/runtimeapi.story");
+
+        assertThat(results.getTestResults())
+                .extracting(TestResult::getName, TestResult::getStatus)
+                .containsExactly(tuple("Runtime API", Status.PASSED));
+
+        assertThat(results.getTestResults())
+                .filteredOn("name", "Runtime API")
+                .flatExtracting(TestResult::getLabels)
+                .extracting(Label::getName, Label::getValue)
+                .contains(
+                        tuple("jbehave-test-label", "some-value")
+                );
+
+        assertThat(results.getTestResults())
+                .filteredOn("name", "Runtime API")
+                .flatExtracting(TestResult::getSteps)
+                .filteredOn("name", "Given runtime api")
+                .flatExtracting(StepResult::getSteps)
+                .extracting(StepResult::getName)
+                .containsExactlyInAnyOrder("sub step 1", "sub step 2");
+
+        assertThat(results.getTestResults())
+                .filteredOn("name", "Runtime API")
+                .flatExtracting(TestResult::getParameters)
+                .extracting(Parameter::getName, Parameter::getValue)
+                .containsExactlyInAnyOrder(
+                        tuple("test param", "param value")
+                );
+
+        assertThat(results.getTestResults())
+                .filteredOn("name", "Runtime API")
+                .flatExtracting(TestResult::getSteps)
+                .filteredOn("name", "Given runtime api")
+                .flatExtracting(StepResult::getAttachments)
+                .extracting(Attachment::getName)
+                .containsExactlyInAnyOrder("some attachment");
+    }
+
     private AllureResults runStories(final String... storyResources) {
         return RunUtils.runTests(lifecycle -> {
             final Embedder embedder = new Embedder();
@@ -283,7 +327,8 @@ private AllureResults runStories(final String... storyResources) {
             final InjectableStepsFactory stepsFactory = new InstanceStepsFactory(
                     embedder.configuration(),
                     new SimpleStorySteps(),
-                    new BrokenStorySteps()
+                    new BrokenStorySteps(),
+                    new RuntimeApiSteps()
             );
             embedder.useStepsFactory(stepsFactory);
             embedder.runStoriesAsPaths(Arrays.asList(storyResources));

diff --git a/allure-jbehave5/src/test/java/io/qameta/allure/jbehave5/samples/RuntimeApiSteps.java b/allure-jbehave5/src/test/java/io/qameta/allure/jbehave5/samples/RuntimeApiSteps.java
@@ -0,0 +1,34 @@
+/*
+ *  Copyright 2016-2024 Qameta Software Inc
+ *
+ *  Licensed under the Apache License, Version 2.0 (the "License");
+ *  you may not use this file except in compliance with the License.
+ *  You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ *  Unless required by applicable law or agreed to in writing, software
+ *  distributed under the License is distributed on an "AS IS" BASIS,
+ *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ *  See the License for the specific language governing permissions and
+ *  limitations under the License.
+ */
+package io.qameta.allure.jbehave5.samples;
+
+import io.qameta.allure.Allure;
+import org.jbehave.core.annotations.Given;
+
+public class RuntimeApiSteps {
+
+    @Given("runtime api")
+    public void given() {
+        Allure.label("jbehave-test-label", "some-value");
+        Allure.parameter("test param", "param value");
+        Allure.step("sub step 1");
+        Allure.step("sub step 2", () -> {
+        });
+
+        Allure.addAttachment("some attachment", "some content");
+    }
+
+}
diff --git a/allure-jbehave5/src/test/resources/stories/runtimeapi.story b/allure-jbehave5/src/test/resources/stories/runtimeapi.story
@@ -0,0 +1,3 @@
+Scenario: Runtime API
+
+Given runtime api