Sample end-to-end workflow scenarios

Author: wakaleo

pom.xml

@@ -90,6 +90,11 @@
             <artifactId>allure-cucumber7-jvm</artifactId>
             <scope>test</scope>
         </dependency>
+        <dependency>
+            <groupId>com.github.javafaker</groupId>
+            <artifactId>javafaker</artifactId>
+            <version>1.0.2</version>
+        </dependency>
     </dependencies>
     <build>
         <plugins>

src/test/java/com/serenitydojo/playwright/toolshop/actions/api/UserAPIClient.java

@@ -0,0 +1,27 @@
+package com.serenitydojo.playwright.toolshop.actions.api;
+
+import com.microsoft.playwright.Page;
+import com.microsoft.playwright.options.RequestOptions;
+import com.serenitydojo.playwright.toolshop.domain.User;
+
+public class UserAPIClient {
+    private final Page page;
+
+    private static final String REGISTER_USER = "https://api.practicesoftwaretesting.com/users/register";
+
+    public UserAPIClient(Page page) {
+        this.page = page;
+    }
+
+    public void registerUser(User user) {
+        var response = page.request().post(
+                REGISTER_USER,
+                RequestOptions.create()
+                        .setData(user)
+                        .setHeader("Content-Type", "application/json")
+                        .setHeader("Accept", "application/json"));
+        if (response.status() != 201) {
+            throw new IllegalStateException("Could not create user: " + response.text());
+        }
+    }
+}

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

@@ -24,7 +24,7 @@ public class AddToCartTest implements TakesFinalScreenshot, WithTracing {
     ProductList productList;
     ProductDetails productDetails;
     NavBar navBar;
-    CheckoutCart checkoutCart;
+    ShoppingCart shoppingCart;
 
     @BeforeEach
     void openHomePage() {
@@ -37,7 +37,7 @@ void setUp(Page page) {
         productList = new ProductList(page);
         productDetails = new ProductDetails(page);
         navBar = new NavBar(page);
-        checkoutCart = new CheckoutCart(page);
+        shoppingCart = new ShoppingCart(page);
     }
 
 
@@ -48,12 +48,12 @@ void whenCheckingOutASingleItem() {
         searchComponent.searchBy("pliers");
         productList.viewProductDetails("Combination Pliers");
 
-        productDetails.increaseQuanityBy(2);
+        productDetails.setQuantityTo(2);
         productDetails.addToCart();
 
         navBar.openCart();
 
-        List<CartLineItem> lineItems = checkoutCart.getLineItems();
+        List<CartLineItem> lineItems = shoppingCart.getLineItems();
 
         Assertions.assertThat(lineItems)
                 .hasSize(1)
@@ -72,7 +72,7 @@ void whenCheckingOutMultipleItems() {
         navBar.openHomePage();
 
         productList.viewProductDetails("Bolt Cutters");
-        productDetails.increaseQuanityBy(2);
+        productDetails.setQuantityTo(2);
         productDetails.addToCart();
 
         navBar.openHomePage();
@@ -81,7 +81,7 @@ void whenCheckingOutMultipleItems() {
 
         navBar.openCart();
 
-        List<CartLineItem> lineItems = checkoutCart.getLineItems();
+        List<CartLineItem> lineItems = shoppingCart.getLineItems();
 
         Assertions.assertThat(lineItems).hasSize(2);
         List<String> productNames = lineItems.stream().map(CartLineItem::title).toList();

src/test/java/com/serenitydojo/playwright/toolshop/catalog/pageobjects/AddressForm.java

@@ -0,0 +1,17 @@
+package com.serenitydojo.playwright.toolshop.catalog.pageobjects;
+
+import com.microsoft.playwright.Page;
+
+import java.util.List;
+
+public class AddressForm {
+    private final Page page;
+
+    public AddressForm(Page page) {
+        this.page = page;
+    }
+
+    public void confirmAddress() {
+        page.getByTestId("proceed-3").click();
+    }
+}

src/test/java/com/serenitydojo/playwright/toolshop/catalog/pageobjects/PaymentForm.java

@@ -0,0 +1,33 @@
+package com.serenitydojo.playwright.toolshop.catalog.pageobjects;
+
+import com.microsoft.playwright.Page;
+import com.microsoft.playwright.options.AriaRole;
+
+import java.util.HashMap;
+import java.util.Map;
+
+import static com.microsoft.playwright.assertions.PlaywrightAssertions.assertThat;
+
+public class PaymentForm {
+    private final Page page;
+
+    public PaymentForm(Page page) {
+        this.page = page;
+    }
+
+    public void choosePaymentMethod(String paymentMethod) {
+        choosePaymentMethod(paymentMethod, new HashMap<>());
+    }
+    public void choosePaymentMethod(String paymentMethod, Map<String,String> paymentDetails) {
+        page.getByTestId("payment-method").selectOption(paymentMethod);
+
+        // Complete details if required for payment type
+
+        page.getByRole(AriaRole.BUTTON, new Page.GetByRoleOptions().setName("Confirm")).click();
+
+        assertThat(page.locator(".alert-success")).hasText("Payment was successful");
+
+        page.getByRole(AriaRole.BUTTON, new Page.GetByRoleOptions().setName("Confirm")).click();
+
+    }
+}

src/test/java/com/serenitydojo/playwright/toolshop/catalog/pageobjects/ProductDetails.java

@@ -12,8 +12,8 @@ public ProductDetails(Page page) {
     }
 
     @Step("Increase product quantity")
-    public void increaseQuanityBy(int increment) {
-        for (int i = 1; i <= increment; i++) {
+    public void setQuantityTo(int quantity) {
+        for (int i = 1; i <= quantity; i++) {
             page.getByTestId("increase-quantity").click();
         }
     }
@@ -28,4 +28,5 @@ public void addToCart() {
                 }
         );
     }
+
 }

src/test/java/com/serenitydojo/playwright/toolshop/catalog/pageobjects/CheckoutCart.java renamed to src/test/java/com/serenitydojo/playwright/toolshop/catalog/pageobjects/ShoppingCart.java

@@ -1,14 +1,13 @@
 package com.serenitydojo.playwright.toolshop.catalog.pageobjects;
 
 import com.microsoft.playwright.Page;
-import io.qameta.allure.Step;
 
 import java.util.List;
 
-public class CheckoutCart {
+public class ShoppingCart {
     private final Page page;
 
-    public CheckoutCart(Page page) {
+    public ShoppingCart(Page page) {
         this.page = page;
     }
 
@@ -36,4 +35,11 @@ private String price(String value) {
         return value.replace("$", "");
     }
 
+    public void proceedToCheckout() {
+        page.getByTestId("proceed-1").click();
+    }
+
+    public void proceedToCheckoutAfterAuthentication() {
+        page.getByTestId("proceed-2").click();
+    }
 }

src/test/java/com/serenitydojo/playwright/toolshop/catalog/workflow/AuthenticationWorkflow.java

@@ -0,0 +1,28 @@
+package com.serenitydojo.playwright.toolshop.catalog.workflow;
+
+import com.microsoft.playwright.Page;
+import com.serenitydojo.playwright.toolshop.actions.api.UserAPIClient;
+import com.serenitydojo.playwright.toolshop.domain.User;
+import com.serenitydojo.playwright.toolshop.login.LoginPage;
+
+public class AuthenticationWorkflow {
+
+    private final UserAPIClient userAPI;
+    private final LoginPage loginPage;
+
+    public AuthenticationWorkflow(Page page) {
+        this.userAPI = new UserAPIClient(page);
+        this.loginPage = new LoginPage(page);
+    }
+
+    public User registerUserCalled(String firstName) {
+        User someUser = User.randomUserNamed(firstName);
+        userAPI.registerUser(someUser);
+        return someUser;
+    }
+
+    public void loginAs(User user) {
+        loginPage.open();
+        loginPage.loginAs(user);
+    }
+}

src/test/java/com/serenitydojo/playwright/toolshop/catalog/workflow/PurchaseWorkflow.java

@@ -0,0 +1,58 @@
+package com.serenitydojo.playwright.toolshop.catalog.workflow;
+
+import com.microsoft.playwright.Page;
+import com.serenitydojo.playwright.toolshop.catalog.pageobjects.*;
+import io.qameta.allure.Step;
+
+public class PurchaseWorkflow {
+
+    Page page;
+    NavBar navBar;
+    SearchComponent searchComponent;
+    ProductList productList;
+    ProductDetails productDetails;
+    ShoppingCart shoppingCart;
+    AddressForm addressForm;
+    PaymentForm paymentForm;
+
+    public PurchaseWorkflow(Page page) {
+        this.page = page;
+        this.navBar = new NavBar(page);
+        this.searchComponent = new SearchComponent(page);
+        this.productList = new ProductList(page);
+        this.productDetails = new ProductDetails(page);
+        this.shoppingCart = new ShoppingCart(page);
+        this.addressForm = new AddressForm(page);
+        this.paymentForm = new PaymentForm(page);
+    }
+
+    @Step("Add product to cart")
+    public void addProductToCart(String productName, int quantity) {
+        navBar.openHomePage();
+        searchComponent.searchBy(productName);
+        productList.viewProductDetails(productName);
+        productDetails.setQuantityTo(quantity);
+        productDetails.addToCart();
+    }
+
+    public void checkOutCart() {
+        navBar.openCart();
+        shoppingCart.proceedToCheckout();
+    }
+
+    public void proceedToCheckoutAfterAuthentication() {
+        shoppingCart.proceedToCheckoutAfterAuthentication();
+    }
+
+    public void confirmAddress() {
+        addressForm.confirmAddress();
+    }
+
+    public void choosePaymentMethod(String paymentMethod) {
+        paymentForm.choosePaymentMethod(paymentMethod);
+    }
+
+    public String confirmationMessage() {
+        return page.locator("#order-confirmation").textContent();
+    }
+}

src/test/java/com/serenitydojo/playwright/toolshop/domain/User.java

@@ -0,0 +1,62 @@
+package com.serenitydojo.playwright.toolshop.domain;
+
+import com.github.javafaker.Faker;
+
+import java.time.LocalDate;
+import java.time.format.DateTimeFormatter;
+
+/**
+ * {
+ *   "first_name": "John",
+ *   "last_name": "Doe",
+ *   "address": "Street 1",
+ *   "city": "City",
+ *   "state": "State",
+ *   "country": "Country",
+ *   "postcode": "1234AA",
+ *   "phone": "0987654321",
+ *   "dob": "1970-01-01",
+ *   "password": "S1!uper-secret",
+ *   "email": "[email protected]"
+ * }
+ */
+public record User(
+    String first_name,
+    String last_name,
+    String address,
+    String city,
+    String state,
+    String country,
+    String postcode,
+    String phone,
+    String dob,
+    String password,
+    String email
+) {
+    public static User randomUserNamed(String firstName) {
+        Faker fake = new Faker();
+        int year = fake.number().numberBetween(1970,2000);
+        int month = fake.number().numberBetween(1,12);
+        int day = fake.number().numberBetween(1,28);
+        LocalDate date = LocalDate.of(year,month,day);
+        String formattedDate = date.format(DateTimeFormatter.ofPattern("yyyy-MM-dd"));
+
+        return new User(
+                firstName,
+                fake.name().lastName(),
+                fake.address().streetAddress(),
+                fake.address().city(),
+                fake.address().state(),
+                fake.address().country(),
+                fake.address().zipCode(),
+                fake.phoneNumber().phoneNumber(),
+                formattedDate,
+                "Az1234£!3",
+                fake.internet().emailAddress()
+        );
+    }
+
+    public User withPassword(String password) {
+        return new User(first_name, last_name, address, city, state, country, postcode, phone, dob, password, email);
+    }
+}