Added an additonal edge case for search filtering

Author: wakaleo

.github/workflows/playwright-tests.yml

@@ -19,7 +19,7 @@ jobs:
         uses: actions/checkout@v3
 
       - name: Set up Node.js
-        uses: actions/setup-node@v3
+        uses: actions/setup-node@v4
         with:
           node-version: '20'
 
@@ -39,9 +39,9 @@ jobs:
           java-distribution: temurin
           maven-version: 3.9.9
 
-      # Step 4: Verify Maven installation
-      - name: Verify Maven version
-        run: mvn --version
+      # Step 4: Install playwright OS libraries
+      - name: Install Playwright dependencies
+        run: npx playwright install-deps
 
       # Step 5: Cache Maven dependencies
       - name: Cache Maven dependencies
@@ -52,20 +52,17 @@ jobs:
           restore-keys: |
             ${{ runner.os }}-maven
 
-      - name: Install Playwright dependencies
-        run: npx playwright install-deps
-
       # Step 6: Run Maven to execute Playwright tests
       - name: Run Playwright Tests
         run: mvn verify
 
-#      # Step 7: Archive ZIP files in the root directory
-#      - name: Archive ZIP files
-#        if: always()  # Ensure this step runs even if previous steps fail
-#        uses: actions/upload-artifact@v4
-#        with:
-#          name: zip-archives
-#          path: 'target/*.zip'
+      # Step 7: Archive any trace files
+      - name: Archive trace files
+        if: always()
+        uses: actions/upload-artifact@v4
+        with:
+          name: traces
+          path: target/traces/*.zip
 
       # Step 8: Deploy Allure report to GitHub Pages
       - name: Deploy Allure Report to GitHub Pages

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

@@ -5,6 +5,7 @@
 import com.serenitydojo.playwright.toolshop.catalog.pageobjects.*;
 import com.serenitydojo.playwright.toolshop.fixtures.ChromeHeadlessOptions;
 import com.serenitydojo.playwright.toolshop.fixtures.TakesFinalScreenshot;
+import com.serenitydojo.playwright.toolshop.fixtures.WithTracing;
 import io.qameta.allure.Feature;
 import io.qameta.allure.Story;
 import org.assertj.core.api.Assertions;
@@ -17,7 +18,7 @@
 @DisplayName("Shopping Cart")
 @Feature("Shopping Cart")
 @UsePlaywright(ChromeHeadlessOptions.class)
-public class AddToCartTest implements TakesFinalScreenshot {
+public class AddToCartTest implements TakesFinalScreenshot, WithTracing {
 
     SearchComponent searchComponent;
     ProductList productList;

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

@@ -6,6 +6,7 @@
 import com.serenitydojo.playwright.toolshop.catalog.pageobjects.SearchComponent;
 import com.serenitydojo.playwright.toolshop.fixtures.ChromeHeadlessOptions;
 import com.serenitydojo.playwright.toolshop.fixtures.TakesFinalScreenshot;
+import com.serenitydojo.playwright.toolshop.fixtures.WithTracing;
 import io.qameta.allure.Feature;
 import io.qameta.allure.Story;
 import org.assertj.core.api.Assertions;
@@ -17,7 +18,7 @@
 @DisplayName("Searching for products")
 @Feature("Product Catalog")
 @UsePlaywright(ChromeHeadlessOptions.class)
-public class SearchForProductsTest implements TakesFinalScreenshot {
+public class SearchForProductsTest implements TakesFinalScreenshot, WithTracing {
 
     @BeforeEach
     void openHomePage(Page page) {

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

@@ -7,6 +7,7 @@
 import com.serenitydojo.playwright.toolshop.catalog.pageobjects.NavBar;
 import com.serenitydojo.playwright.toolshop.fixtures.ChromeHeadlessOptions;
 import com.serenitydojo.playwright.toolshop.fixtures.TakesFinalScreenshot;
+import com.serenitydojo.playwright.toolshop.fixtures.WithTracing;
 import io.qameta.allure.Feature;
 import io.qameta.allure.Story;
 import org.assertj.core.api.Assertions;
@@ -25,7 +26,7 @@
 @DisplayName("Contact form")
 @Feature("Contacts")
 @UsePlaywright(ChromeHeadlessOptions.class)
-public class ContactFormTest implements TakesFinalScreenshot {
+public class ContactFormTest implements TakesFinalScreenshot, WithTracing {
 
     ContactForm contactForm;
     NavBar navigate;

src/test/java/com/serenitydojo/playwright/toolshop/cucumber/stepdefinitions/PlaywrightCucumberFixtures.java

@@ -34,7 +34,7 @@ public void setUpBrowserContext() {
         page.set(browserContext.get().newPage());
     }
 
-    @After
+    @After(order = 100)
     public void closeContext() {
         browserContext.get().close();
     }
@@ -51,4 +51,9 @@ public static void tearDown() {
     public static Page getPage() {
         return page.get();
     }
+
+    public static BrowserContext getBrowserContext() {
+        return browserContext.get();
+    }
+
 }

src/test/java/com/serenitydojo/playwright/toolshop/cucumber/stepdefinitions/ScenarioTracingFixtures.java

@@ -0,0 +1,33 @@
+package com.serenitydojo.playwright.toolshop.cucumber.stepdefinitions;
+
+import com.microsoft.playwright.Tracing;
+import io.cucumber.java.After;
+import io.cucumber.java.Before;
+import io.cucumber.java.Scenario;
+
+import java.nio.file.Paths;
+
+public class ScenarioTracingFixtures {
+
+
+    @Before
+    public void setupTrace() {
+        PlaywrightCucumberFixtures.getBrowserContext().tracing().start(
+                new Tracing.StartOptions()
+                        .setScreenshots(true)
+                        .setSnapshots(true)
+                        .setSources(true)
+        );
+    }
+
+    @After(order = 1000)
+    public void recordTrace(Scenario scenario) {
+
+        String traceName = scenario.getName();
+        PlaywrightCucumberFixtures.getBrowserContext().tracing().stop(
+                new Tracing.StopOptions()
+                        .setPath(Paths.get("target/traces/trace-" + traceName + ".zip"))
+        );
+    }
+
+}

src/test/java/com/serenitydojo/playwright/toolshop/fixtures/WithTracing.java

@@ -0,0 +1,33 @@
+package com.serenitydojo.playwright.toolshop.fixtures;
+
+import com.microsoft.playwright.BrowserContext;
+import com.microsoft.playwright.Tracing;
+import org.junit.jupiter.api.AfterEach;
+import org.junit.jupiter.api.BeforeEach;
+import org.junit.jupiter.api.TestInfo;
+
+import java.nio.file.Paths;
+
+public interface WithTracing {
+
+
+    @BeforeEach
+    default void setupTrace(BrowserContext context) {
+        context.tracing().start(
+                new Tracing.StartOptions()
+                        .setScreenshots(true)
+                        .setSnapshots(true)
+                        .setSources(true)
+        );
+    }
+
+    @AfterEach
+    default void recordTrace(TestInfo testInfo, BrowserContext context) {
+        String traceName = testInfo.getDisplayName().replace(" ","-").toLowerCase();
+        context.tracing().stop(
+                new Tracing.StopOptions()
+                        .setPath(Paths.get("target/traces/trace-" + traceName + ".zip"))
+        );
+    }
+
+}

src/test/resources/features/catalog/product_catalog.feature

@@ -36,6 +36,14 @@ Feature: Product Catalog
         | Product  | Price  |
         | Wood Saw | $12.18 |
 
+    Example: The one where Sally only wants to see Power Drills
+      Given Sally is on the home page
+      When she searches for "drill"
+      And she filters by "Power Tools"
+      Then the following products should be displayed:
+        | Product  | Price  |
+        | Cordless Drill 24V | $66.54 |
+        | Cordless Drill 12V | $46.50 |
 
   Rule: Customers should be able to sort products by various criteria
     Scenario Outline: Sally sorts by different criteria