Merged updates from the allure reporting module

Author: wakaleo

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

@@ -2,9 +2,9 @@
 
 import com.microsoft.playwright.Page;
 import com.microsoft.playwright.junit.UsePlaywright;
-import com.serenitydojo.playwright.HeadlessChromeOptions;
-import com.serenitydojo.playwright.toolshop.fixtures.RecordsAllureScreenshots;
 import com.serenitydojo.playwright.toolshop.catalog.pageobjects.*;
+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;
@@ -16,8 +16,8 @@
 
 @DisplayName("Shopping Cart")
 @Feature("Shopping Cart")
-@UsePlaywright(HeadlessChromeOptions.class)
-public class AddToCartTest implements RecordsAllureScreenshots  {
+@UsePlaywright(ChromeHeadlessOptions.class)
+public class AddToCartTest implements TakesFinalScreenshot {
 
     SearchComponent searchComponent;
     ProductList productList;
@@ -26,8 +26,8 @@ public class AddToCartTest implements RecordsAllureScreenshots  {
     CheckoutCart checkoutCart;
 
     @BeforeEach
-    void openHomePage(Page page) {
-        page.navigate("https://practicesoftwaretesting.com");
+    void openHomePage() {
+        navBar.openHomePage();
     }
 
     @BeforeEach
@@ -39,8 +39,9 @@ void setUp(Page page) {
         checkoutCart = new CheckoutCart(page);
     }
 
+
     @Test
-    @Story("Check out")
+    @Story("Checking out a product")
     @DisplayName("Checking out a single item")
     void whenCheckingOutASingleItem() {
         searchComponent.searchBy("pliers");
@@ -64,7 +65,7 @@ void whenCheckingOutASingleItem() {
     }
 
     @Test
-    @Story("Check out")
+    @Story("Checking out a product")
     @DisplayName("Checking out multiple items")
     void whenCheckingOutMultipleItems() {
         navBar.openHomePage();

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

@@ -2,10 +2,10 @@
 
 import com.microsoft.playwright.Page;
 import com.microsoft.playwright.junit.UsePlaywright;
-import com.serenitydojo.playwright.HeadlessChromeOptions;
-import com.serenitydojo.playwright.toolshop.fixtures.RecordsAllureScreenshots;
 import com.serenitydojo.playwright.toolshop.catalog.pageobjects.ProductList;
 import com.serenitydojo.playwright.toolshop.catalog.pageobjects.SearchComponent;
+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;
@@ -15,9 +15,9 @@
 import org.junit.jupiter.api.Test;
 
 @DisplayName("Searching for products")
-@Feature("Searching for products")
-@UsePlaywright(HeadlessChromeOptions.class)
-public class SearchForProductsTest implements RecordsAllureScreenshots {
+@Feature("Product Catalog")
+@UsePlaywright(ChromeHeadlessOptions.class)
+public class SearchForProductsTest implements TakesFinalScreenshot {
 
     @BeforeEach
     void openHomePage(Page page) {
@@ -54,22 +54,21 @@ void whenThereIsNoMatchingProduct(Page page) {
             Assertions.assertThat(matchingProducts).isEmpty();
             Assertions.assertThat(productList.getSearchCompletedMessage()).contains("There are no products found.");
         }
-    }
 
-    @Test
-    @Story("Clearing the previous search results")
-    @DisplayName("When the user clears a previous search results")
-    void clearingTheSearchResults(Page page) {
-        SearchComponent searchComponent = new SearchComponent(page);
-        ProductList productList = new ProductList(page);
-        searchComponent.searchBy("saw");
+        @Test
+        @DisplayName("When the user clears a previous search results")
+        void clearingTheSearchResults(Page page) {
+            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/contact/ContactFormTest.java

@@ -1,18 +1,17 @@
 package com.serenitydojo.playwright.toolshop.contact;
 
-import com.microsoft.playwright.BrowserContext;
 import com.microsoft.playwright.Page;
-import com.microsoft.playwright.Tracing;
 import com.microsoft.playwright.junit.UsePlaywright;
 import com.microsoft.playwright.options.AriaRole;
-import com.serenitydojo.playwright.HeadlessChromeOptions;
-import com.serenitydojo.playwright.toolshop.fixtures.RecordsAllureScreenshots;
 import com.serenitydojo.playwright.toolshop.catalog.pageobjects.NavBar;
+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.*;
+import org.junit.jupiter.api.BeforeEach;
+import org.junit.jupiter.api.DisplayName;
+import org.junit.jupiter.api.Test;
 import org.junit.jupiter.params.ParameterizedTest;
 import org.junit.jupiter.params.provider.ValueSource;
 
@@ -23,9 +22,9 @@
 import static com.microsoft.playwright.assertions.PlaywrightAssertions.assertThat;
 
 @DisplayName("Contact form")
-@Feature("Contact form")
-@UsePlaywright(HeadlessChromeOptions.class)
-public class ContactFormTest implements RecordsAllureScreenshots {
+@Feature("Contacts")
+@UsePlaywright(ChromeHeadlessOptions.class)
+public class ContactFormTest implements TakesFinalScreenshot {
 
     ContactForm contactForm;
     NavBar navigate;
@@ -37,31 +36,10 @@ void openContactPage(Page page) {
         navigate.toTheContactPage();
     }
 
-
-    @BeforeEach
-    void setupTrace(BrowserContext context) {
-        context.tracing().start(
-                new Tracing.StartOptions()
-                        .setScreenshots(true)
-                        .setSnapshots(true)
-                        .setSources(true)
-        );
-    }
-
-    @AfterEach
-    void recordTrace(TestInfo testInfo, BrowserContext context) {
-        String traceName = testInfo.getDisplayName().replace(" ", "-").toLowerCase();
-        context.tracing().stop(
-                new Tracing.StopOptions()
-                        .setPath(Paths.get("target/trace-" + traceName + ".zip"))
-        );
-    }
-
-
-    @Story("Submitting a request")
+    @Story("Contact form")
     @DisplayName("Customers can use the contact form to contact us")
     @Test
-    void completeForm(Page page) throws URISyntaxException {
+    void completeForm() throws URISyntaxException {
         contactForm.setFirstName("Sarah-Jane");
         contactForm.setLastName("Smith");
         contactForm.setEmail("[email protected]");
@@ -71,19 +49,13 @@ void completeForm(Page page) throws URISyntaxException {
         Path fileToUpload = Paths.get(ClassLoader.getSystemResource("data/sample-data.txt").toURI());
         contactForm.setAttachment(fileToUpload);
 
-        recordScreenshot(page, "Submit form");
         contactForm.submitForm();
 
         Assertions.assertThat(contactForm.getAlertMessage())
                 .contains("Thanks for your message! We will contact you shortly.");
     }
 
-    @Step
-    void submitTheForm(Page page) {
-
-    }
-
-    @Story("Submitting a request")
+    @Story("Contact form")
     @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"})
@@ -98,7 +70,6 @@ void mandatoryFields(String fieldName, Page page) {
         // Clear one of the fields
         contactForm.clearField(fieldName);
 
-        recordScreenshot(page, "Submit form");
         contactForm.submitForm();
 
         // Check the error message for that field
@@ -107,7 +78,7 @@ void mandatoryFields(String fieldName, Page page) {
         assertThat(errorMessage).isVisible();
     }
 
-    @Story("Submitting a request")
+    @Story("Contact form")
     @DisplayName("The message must be at least 50 characters long")
     @Test
     void messageTooShort(Page page) {
@@ -118,13 +89,12 @@ void messageTooShort(Page page) {
         contactForm.setMessage("A short long message.");
         contactForm.selectSubject("Warranty");
 
-        recordScreenshot(page, "Submit form");
         contactForm.submitForm();
 
         assertThat(page.getByRole(AriaRole.ALERT)).hasText("Message must be minimal 50 characters");
     }
 
-    @Story("Submitting a request")
+    @Story("Contact form")
     @DisplayName("The email address must be correctly formatted")
     @ParameterizedTest(name = "'{arguments}' should be rejected")
     @ValueSource(strings = {"not-an-email", "not-an.email.com", "notanemail"})
@@ -135,7 +105,6 @@ void invalidEmailField(String invalidEmail, Page page) {
         contactForm.setMessage("A very long message to the warranty service about a warranty on a product!");
         contactForm.selectSubject("Warranty");
 
-        recordScreenshot(page, "Submit form");
         contactForm.submitForm();
 
         assertThat(page.getByRole(AriaRole.ALERT)).hasText("Email format is invalid");

src/test/java/com/serenitydojo/playwright/HeadlessChromeOptions.java renamed to src/test/java/com/serenitydojo/playwright/toolshop/fixtures/ChromeHeadlessOptions.java

@@ -1,12 +1,12 @@
-package com.serenitydojo.playwright;
+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 HeadlessChromeOptions implements OptionsFactory {
+public class ChromeHeadlessOptions implements OptionsFactory {
     @Override
     public Options getOptions() {
         return new Options().setLaunchOptions(

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

@@ -0,0 +1,15 @@
+package com.serenitydojo.playwright.toolshop.fixtures;
+
+import com.microsoft.playwright.Page;
+import io.qameta.allure.Allure;
+
+import java.io.ByteArrayInputStream;
+
+public class ScreenshotManager {
+    public static void takeScreenshot(Page page, String name) {
+        var screenshot = page.screenshot(
+                new Page.ScreenshotOptions().setFullPage(true)
+        );
+        Allure.addAttachment(name, new ByteArrayInputStream(screenshot));
+    }
+}

src/test/java/com/serenitydojo/playwright/toolshop/fixtures/TakesFinalScreenshot.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");
+    }
+}