Sample solution for Cucumber

Author: wakaleo

.idea/compiler.xml

@@ -12,7 +12,7 @@
         <maven.compiler.source>17</maven.compiler.source>
         <maven.compiler.target>17</maven.compiler.target>
         <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
-        <allure.version>2.25.0</allure.version>
+        <allure.version>2.29.0</allure.version>
         <aspectj.version>1.9.21</aspectj.version>
     </properties>
 
@@ -38,7 +38,28 @@
         <dependency>
             <groupId>org.junit.jupiter</groupId>
             <artifactId>junit-jupiter</artifactId>
-            <version>5.11.1</version>
+            <version>5.11.3</version>
+            <scope>test</scope>
+        </dependency>
+        <dependency>
+            <groupId>io.cucumber</groupId>
+            <artifactId>cucumber-java</artifactId>
+            <version>7.20.1</version>
+        </dependency>
+        <dependency>
+            <groupId>io.cucumber</groupId>
+            <artifactId>cucumber-junit</artifactId>
+            <version>7.20.1</version>
+        </dependency>
+        <dependency>
+            <groupId>io.cucumber</groupId>
+            <artifactId>cucumber-junit-platform-engine</artifactId>
+            <version>7.20.1</version>
+        </dependency>
+        <dependency>
+            <groupId>org.junit.platform</groupId>
+            <artifactId>junit-platform-suite</artifactId>
+            <version>1.11.3</version>
             <scope>test</scope>
         </dependency>
         <dependency>
@@ -56,9 +77,29 @@
             <artifactId>allure-junit5</artifactId>
             <scope>test</scope>
         </dependency>
+        <dependency>
+            <groupId>io.qameta.allure</groupId>
+            <artifactId>allure-cucumber7-jvm</artifactId>
+            <scope>test</scope>
+        </dependency>
+        <dependency>
+            <groupId>io.qameta.allure</groupId>
+            <artifactId>allure-junit-platform</artifactId>
+            <scope>test</scope>
+        </dependency>
     </dependencies>
     <build>
         <plugins>
+            <plugin>
+                <groupId>org.apache.maven.plugins</groupId>
+                <artifactId>maven-compiler-plugin</artifactId>
+                <version>3.8.1</version>
+                <configuration>
+                    <compilerArgs>
+                        <arg>-parameters</arg>
+                    </compilerArgs>
+                </configuration>
+            </plugin>
             <plugin>
                 <groupId>org.apache.maven.plugins</groupId>
                 <artifactId>maven-surefire-plugin</artifactId>

pom.xml

@@ -2,6 +2,8 @@
 
 import com.serenitydojo.playwright.toolshop.catalog.pageobjects.*;
 import com.serenitydojo.playwright.toolshop.fixtures.PlaywrightTestCase;
+import io.qameta.allure.Feature;
+import io.qameta.allure.Story;
 import org.assertj.core.api.Assertions;
 import org.junit.jupiter.api.BeforeEach;
 import org.junit.jupiter.api.DisplayName;
@@ -10,6 +12,7 @@
 import java.util.List;
 
 @DisplayName("Shopping Cart")
+@Feature("Shopping Cart")
 public class AddToCartTest extends PlaywrightTestCase {
 
     SearchComponent searchComponent;
@@ -33,6 +36,7 @@ void setUp() {
     }
 
     @Test
+    @Story("Check out")
     @DisplayName("Checking out a single item")
     void whenCheckingOutASingleItem() {
         searchComponent.searchBy("pliers");
@@ -56,6 +60,7 @@ void whenCheckingOutASingleItem() {
     }
 
     @Test
+    @Story("Check out")
     @DisplayName("Checking out multiple items")
     void whenCheckingOutMultipleItems() {
         navBar.openHomePage();

src/test/java/com/serenitydojo/playwright/toolshop/catalog/AddToCartTest.java

@@ -3,13 +3,16 @@
 import com.serenitydojo.playwright.toolshop.catalog.pageobjects.ProductList;
 import com.serenitydojo.playwright.toolshop.catalog.pageobjects.SearchComponent;
 import com.serenitydojo.playwright.toolshop.fixtures.PlaywrightTestCase;
+import io.qameta.allure.Feature;
+import io.qameta.allure.Story;
 import org.assertj.core.api.Assertions;
 import org.junit.jupiter.api.BeforeEach;
 import org.junit.jupiter.api.DisplayName;
 import org.junit.jupiter.api.Nested;
 import org.junit.jupiter.api.Test;
 
 @DisplayName("Searching for products")
+@Feature("Searching for products")
 public class SearchForProductsTest extends PlaywrightTestCase {
 
     @BeforeEach
@@ -19,6 +22,7 @@ void openHomePage() {
 
     @Nested
     @DisplayName("Searching by keyword")
+    @Story("Searching by keyword")
     class SearchingByKeyword {
 
         @Test
@@ -46,21 +50,22 @@ void whenThereIsNoMatchingProduct() {
             Assertions.assertThat(matchingProducts).isEmpty();
             Assertions.assertThat(productList.getSearchCompletedMessage()).contains("There are no products found.");
         }
+    }
 
-        @Test
-        @DisplayName("When the user clears a previous search results")
-        void clearingTheSearchResults() {
-            SearchComponent searchComponent = new SearchComponent(page);
-            ProductList productList = new ProductList(page);
-            searchComponent.searchBy("saw");
+    @Test
+    @Story("Clearing the previous search results")
+    @DisplayName("When the user clears a previous search results")
+    void clearingTheSearchResults() {
+        SearchComponent searchComponent = new SearchComponent(page);
+        ProductList productList = new ProductList(page);
+        searchComponent.searchBy("saw");
 
-            var matchingFilteredProducts = productList.getProductNames();
-            Assertions.assertThat(matchingFilteredProducts).hasSize(2);
+        var matchingFilteredProducts = productList.getProductNames();
+        Assertions.assertThat(matchingFilteredProducts).hasSize(2);
 
-            searchComponent.clearSearch();
+        searchComponent.clearSearch();
 
-            var matchingProducts = productList.getProductNames();
-            Assertions.assertThat(matchingProducts).hasSize(9);
-        }
+        var matchingProducts = productList.getProductNames();
+        Assertions.assertThat(matchingProducts).hasSize(9);
     }
 }

src/test/java/com/serenitydojo/playwright/toolshop/catalog/SearchForProductsTest.java

@@ -4,6 +4,8 @@
 import com.serenitydojo.playwright.toolshop.catalog.pageobjects.NavBar;
 import com.serenitydojo.playwright.toolshop.fixtures.PlaywrightTestCase;
 import io.qameta.allure.Allure;
+import io.qameta.allure.Feature;
+import io.qameta.allure.Story;
 import org.assertj.core.api.Assertions;
 import org.junit.jupiter.api.BeforeEach;
 import org.junit.jupiter.api.DisplayName;
@@ -18,19 +20,20 @@
 import static com.microsoft.playwright.assertions.PlaywrightAssertions.assertThat;
 
 @DisplayName("Contact form")
+@Feature("Contact form")
 public class ContactFormTest extends PlaywrightTestCase {
 
     ContactForm contactForm;
     NavBar navigate;
 
-    @DisplayName("When submitting a request")
     @BeforeEach
     void openContactPage() {
         contactForm = new ContactForm(page);
         navigate = new NavBar(page);
         navigate.toTheContactPage();
     }
 
+    @Story("Submitting a request")
     @DisplayName("Customers can use the contact form to contact us")
     @Test
     void completeForm() throws URISyntaxException {
@@ -49,12 +52,11 @@ void completeForm() throws URISyntaxException {
                 .contains("Thanks for your message! We will contact you shortly.");
     }
 
+    @Story("Submitting a request")
     @DisplayName("First name, last name, email and message are mandatory")
-    @ParameterizedTest
+    @ParameterizedTest(name = "{arguments} is a mandatory field")
     @ValueSource(strings = {"First name", "Last name", "Email", "Message"})
     void mandatoryFields(String fieldName) {
-        Allure.parameter("fieldName", fieldName);
-
         // Fill in the field values
         contactForm.setFirstName("Sarah-Jane");
         contactForm.setLastName("Smith");
@@ -73,6 +75,7 @@ void mandatoryFields(String fieldName) {
         assertThat(errorMessage).isVisible();
     }
 
+    @Story("Submitting a request")
     @DisplayName("The message must be at least 50 characters long")
     @Test
     void messageTooShort() {
@@ -88,12 +91,11 @@ void messageTooShort() {
         assertThat(page.getByRole(AriaRole.ALERT)).hasText("Message must be minimal 50 characters");
     }
 
+    @Story("Submitting a request")
     @DisplayName("The email address must be correctly formatted")
-    @ParameterizedTest
+    @ParameterizedTest(name = "'{arguments}' should be rejected")
     @ValueSource(strings = {"not-an-email", "not-an.email.com", "notanemail"})
     void invalidEmailField(String invalidEmail) {
-        Allure.parameter("invalidEmail", invalidEmail);
-
         contactForm.setFirstName("Sarah-Jane");
         contactForm.setLastName("Smith");
         contactForm.setEmail(invalidEmail);
@@ -104,6 +106,4 @@ void invalidEmailField(String invalidEmail) {
 
         assertThat(page.getByRole(AriaRole.ALERT)).hasText("Email format is invalid");
     }
-
-
 }

src/test/java/com/serenitydojo/playwright/toolshop/contact/ContactFormTest.java

@@ -0,0 +1,17 @@
+package com.serenitydojo.playwright.toolshop.cucumber;
+
+import org.junit.platform.suite.api.ConfigurationParameter;
+import org.junit.platform.suite.api.IncludeEngines;
+import org.junit.platform.suite.api.SelectClasspathResource;
+import org.junit.platform.suite.api.Suite;
+
+@Suite
+@IncludeEngines("cucumber")
+@ConfigurationParameter(key="cucumber.plugin",
+        value = "io.qameta.allure.cucumber7jvm.AllureCucumber7Jvm, " +
+                "pretty, " +
+                "html:target/cucumber-reports/cucumber.html, " +
+                "json:target/cucumber-reports/cucumber.json")
+@SelectClasspathResource("/features")
+public class AcceptanceTestSuite {
+}

src/test/java/com/serenitydojo/playwright/toolshop/cucumber/AcceptanceTestSuite.java

@@ -0,0 +1,54 @@
+package com.serenitydojo.playwright.toolshop.cucumber;
+
+import com.microsoft.playwright.*;
+import io.cucumber.java.After;
+import io.cucumber.java.AfterAll;
+import io.cucumber.java.Before;
+import io.cucumber.java.BeforeAll;
+
+import java.util.Arrays;
+
+public class PlaywrightHooks {
+
+    static Playwright playwright;
+    static Browser browser;
+
+    static ThreadLocal<BrowserContext> contextHolder = new ThreadLocal<>();
+    static ThreadLocal<Page> pageHolder = new ThreadLocal<>();
+
+    @BeforeAll
+    public static void beforeAll() {
+        playwright = Playwright.create();
+        playwright.selectors().setTestIdAttribute("data-test");
+        browser = playwright.chromium().launch(
+                new BrowserType.LaunchOptions()
+                        .setHeadless(true)
+                        .setArgs(Arrays.asList("--no-sandbox", "--disable-extensions", "--disable-gpu"))
+        );
+    }
+
+    @Before(order = 100)
+    public void beforeEach() {
+        contextHolder.set(browser.newContext());
+        pageHolder.set(browser.newPage());
+    }
+
+    @After
+    public void shutdownContext() {
+        if (contextHolder.get() != null) {
+            contextHolder.get().close();
+            contextHolder.remove();
+        }
+    }
+
+    @AfterAll
+    public static void afterAll() {
+        if (playwright != null) {
+            playwright.close();
+        }
+    }
+
+    public static Page getPage() {
+        return pageHolder.get();
+    }
+}

src/test/java/com/serenitydojo/playwright/toolshop/cucumber/PlaywrightHooks.java

@@ -0,0 +1,53 @@
+package com.serenitydojo.playwright.toolshop.cucumber;
+
+import com.serenitydojo.playwright.toolshop.catalog.pageobjects.NavBar;
+import com.serenitydojo.playwright.toolshop.catalog.pageobjects.ProductList;
+import com.serenitydojo.playwright.toolshop.catalog.pageobjects.SearchComponent;
+import io.cucumber.java.Before;
+import io.cucumber.java.en.Given;
+import io.cucumber.java.en.Then;
+import io.cucumber.java.en.When;
+
+import java.util.List;
+
+import static org.assertj.core.api.Assertions.assertThat;
+
+public class SearchStepDefinitions {
+
+    NavBar navBar;
+    ProductList productList;
+    SearchComponent searchComponent;
+
+    @Before
+    public void setUp() {
+        navBar = new NavBar(PlaywrightHooks.getPage());
+        searchComponent = new SearchComponent(PlaywrightHooks.getPage());
+        productList = new ProductList(PlaywrightHooks.getPage());
+    }
+
+    @Given("Sharon is on the home page")
+    public void sharon_is_on_the_home_page() {
+        navBar.openHomePage();
+    }
+
+    @When("she searches for {string}")
+    public void she_searches_for(String searchTerm) {
+        searchComponent.searchBy(searchTerm);
+
+    }
+
+    @Then("she should be presented with the following products:")
+    public void she_should_be_presented_with_the_following_products(List<String> expectedProducts) {
+
+        var matchingProducts = productList.getProductNames();
+
+        assertThat(matchingProducts).containsExactlyElementsOf(expectedProducts);
+    }
+
+    @Then("she should not see any products")
+    public void she_should_not_see_any_products() {
+        var matchingProducts = productList.getProductNames();
+        assertThat(matchingProducts).isEmpty();
+    }
+
+}

src/test/java/com/serenitydojo/playwright/toolshop/cucumber/SearchStepDefinitions.java

@@ -19,7 +19,8 @@ public abstract class PlaywrightTestCase {
 
     protected static ThreadLocal<Browser> browser = ThreadLocal.withInitial(() ->
         playwright.get().chromium().launch(
-                new BrowserType.LaunchOptions().setHeadless(true)
+                new BrowserType.LaunchOptions()
+                        .setHeadless(true)
                         .setArgs(Arrays.asList("--no-sandbox", "--disable-extensions", "--disable-gpu"))
         )
     );