Record a screenshot at the end of each test

Author: wakaleo

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

@@ -1,9 +1,11 @@
 package com.serenitydojo.playwright.toolshop.catalog;
 
+import com.microsoft.playwright.Page;
+import com.microsoft.playwright.junit.UsePlaywright;
 import com.serenitydojo.playwright.toolshop.catalog.pageobjects.*;
-import com.serenitydojo.playwright.toolshop.fixtures.PlaywrightTestCase;
+import com.serenitydojo.playwright.toolshop.fixtures.ChromeHeadlessOptions;
+import com.serenitydojo.playwright.toolshop.fixtures.TakesFinalScreenshot;
 import io.qameta.allure.Feature;
-import io.qameta.allure.Step;
 import io.qameta.allure.Story;
 import org.assertj.core.api.Assertions;
 import org.junit.jupiter.api.BeforeEach;
@@ -14,7 +16,8 @@
 
 @DisplayName("Shopping Cart")
 @Feature("Shopping Cart")
-public class AddToCartTest extends PlaywrightTestCase {
+@UsePlaywright(ChromeHeadlessOptions.class)
+public class AddToCartTest implements TakesFinalScreenshot {
 
     SearchComponent searchComponent;
     ProductList productList;
@@ -28,14 +31,15 @@ void openHomePage() {
     }
 
     @BeforeEach
-    void setUp() {
+    void setUp(Page page) {
         searchComponent = new SearchComponent(page);
         productList = new ProductList(page);
         productDetails = new ProductDetails(page);
         navBar = new NavBar(page);
         checkoutCart = new CheckoutCart(page);
     }
 
+
     @Test
     @Story("Checking out a product")
     @DisplayName("Checking out a single item")

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

@@ -1,8 +1,11 @@
 package com.serenitydojo.playwright.toolshop.catalog;
 
+import com.microsoft.playwright.Page;
+import com.microsoft.playwright.junit.UsePlaywright;
 import com.serenitydojo.playwright.toolshop.catalog.pageobjects.ProductList;
 import com.serenitydojo.playwright.toolshop.catalog.pageobjects.SearchComponent;
-import com.serenitydojo.playwright.toolshop.fixtures.PlaywrightTestCase;
+import com.serenitydojo.playwright.toolshop.fixtures.ChromeHeadlessOptions;
+import com.serenitydojo.playwright.toolshop.fixtures.TakesFinalScreenshot;
 import io.qameta.allure.Feature;
 import io.qameta.allure.Story;
 import org.assertj.core.api.Assertions;
@@ -13,10 +16,11 @@
 
 @DisplayName("Searching for products")
 @Feature("Product Catalog")
-public class SearchForProductsTest extends PlaywrightTestCase {
+@UsePlaywright(ChromeHeadlessOptions.class)
+public class SearchForProductsTest implements TakesFinalScreenshot {
 
     @BeforeEach
-    void openHomePage() {
+    void openHomePage(Page page) {
         page.navigate("https://practicesoftwaretesting.com");
     }
 
@@ -27,7 +31,7 @@ class SearchingByKeyword {
 
         @Test
         @DisplayName("When there are matching results")
-        void whenSearchingByKeyword() {
+        void whenSearchingByKeyword(Page page) {
             SearchComponent searchComponent = new SearchComponent(page);
             ProductList productList = new ProductList(page);
 
@@ -40,7 +44,7 @@ void whenSearchingByKeyword() {
 
         @Test
         @DisplayName("When there are no matching results")
-        void whenThereIsNoMatchingProduct() {
+        void whenThereIsNoMatchingProduct(Page page) {
             SearchComponent searchComponent = new SearchComponent(page);
             ProductList productList = new ProductList(page);
             searchComponent.searchBy("unknown");
@@ -53,7 +57,7 @@ void whenThereIsNoMatchingProduct() {
 
         @Test
         @DisplayName("When the user clears a previous search results")
-        void clearingTheSearchResults() {
+        void clearingTheSearchResults(Page page) {
             SearchComponent searchComponent = new SearchComponent(page);
             ProductList productList = new ProductList(page);
             searchComponent.searchBy("saw");

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

@@ -1,9 +1,11 @@
 package com.serenitydojo.playwright.toolshop.contact;
 
+import com.microsoft.playwright.Page;
+import com.microsoft.playwright.junit.UsePlaywright;
 import com.microsoft.playwright.options.AriaRole;
 import com.serenitydojo.playwright.toolshop.catalog.pageobjects.NavBar;
-import com.serenitydojo.playwright.toolshop.fixtures.PlaywrightTestCase;
-import io.qameta.allure.Allure;
+import com.serenitydojo.playwright.toolshop.fixtures.ChromeHeadlessOptions;
+import com.serenitydojo.playwright.toolshop.fixtures.TakesFinalScreenshot;
 import io.qameta.allure.Feature;
 import io.qameta.allure.Story;
 import org.assertj.core.api.Assertions;
@@ -21,13 +23,14 @@
 
 @DisplayName("Contact form")
 @Feature("Contacts")
-public class ContactFormTest extends PlaywrightTestCase {
+@UsePlaywright(ChromeHeadlessOptions.class)
+public class ContactFormTest implements TakesFinalScreenshot {
 
     ContactForm contactForm;
     NavBar navigate;
 
     @BeforeEach
-    void openContactPage() {
+    void openContactPage(Page page) {
         contactForm = new ContactForm(page);
         navigate = new NavBar(page);
         navigate.toTheContactPage();
@@ -56,7 +59,7 @@ void completeForm() throws URISyntaxException {
     @DisplayName("First name, last name, email and message are mandatory")
     @ParameterizedTest(name = "{arguments} is a mandatory field")
     @ValueSource(strings = {"First name", "Last name", "Email", "Message"})
-    void mandatoryFields(String fieldName) {
+    void mandatoryFields(String fieldName, Page page) {
         // Fill in the field values
         contactForm.setFirstName("Sarah-Jane");
         contactForm.setLastName("Smith");
@@ -78,7 +81,7 @@ void mandatoryFields(String fieldName) {
     @Story("Contact form")
     @DisplayName("The message must be at least 50 characters long")
     @Test
-    void messageTooShort() {
+    void messageTooShort(Page page) {
 
         contactForm.setFirstName("Sarah-Jane");
         contactForm.setLastName("Smith");
@@ -95,7 +98,7 @@ void messageTooShort() {
     @DisplayName("The email address must be correctly formatted")
     @ParameterizedTest(name = "'{arguments}' should be rejected")
     @ValueSource(strings = {"not-an-email", "not-an.email.com", "notanemail"})
-    void invalidEmailField(String invalidEmail) {
+    void invalidEmailField(String invalidEmail, Page page) {
         contactForm.setFirstName("Sarah-Jane");
         contactForm.setLastName("Smith");
         contactForm.setEmail(invalidEmail);

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

@@ -0,0 +1,18 @@
+package com.serenitydojo.playwright.toolshop.fixtures;
+
+import com.microsoft.playwright.BrowserType;
+import com.microsoft.playwright.junit.Options;
+import com.microsoft.playwright.junit.OptionsFactory;
+
+import java.util.Arrays;
+
+public class ChromeHeadlessOptions implements OptionsFactory {
+    @Override
+    public Options getOptions() {
+        return new Options().setLaunchOptions(
+                        new BrowserType.LaunchOptions()
+                                .setArgs(Arrays.asList("--no-sandbox", "--disable-extensions", "--disable-gpu"))
+                ).setHeadless(true)
+                .setTestIdAttribute("data-test");
+    }
+}

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

@@ -0,0 +1,12 @@
+package com.serenitydojo.playwright.toolshop.fixtures;
+
+import com.microsoft.playwright.Page;
+import org.junit.jupiter.api.AfterEach;
+
+public interface TakesFinalScreenshot {
+
+    @AfterEach
+    default void takeScreenshot(Page page)  {
+        ScreenshotManager.takeScreenshot(page, "Final screenshot");
+    }
+}