Reorganising tests for Allure

Author: wakaleo

.idea/compiler.xml

@@ -86,6 +86,7 @@
                     </dependency>
                 </dependencies>
             </plugin>
+
             <plugin>
                 <groupId>io.qameta.allure</groupId>
                 <artifactId>allure-maven</artifactId>
@@ -94,8 +95,16 @@
                     <reportVersion>${allure.version}</reportVersion>
                     <resultsDirectory>${project.build.directory}/allure-results</resultsDirectory>
                 </configuration>
+                <executions>
+                    <execution>
+                        <id>allure-reports</id>
+                        <phase>verify</phase>
+                        <goals>
+                            <goal>report</goal>
+                        </goals>
+                    </execution>
+                </executions>
             </plugin>
         </plugins>
     </build>
-
 </project>

pom.xml

@@ -3,6 +3,7 @@
 import com.serenitydojo.playwright.toolshop.catalog.pageobjects.*;
 import com.serenitydojo.playwright.toolshop.fixtures.PlaywrightTestCase;
 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;
@@ -23,7 +24,7 @@ public class AddToCartTest extends PlaywrightTestCase {
 
     @BeforeEach
     void openHomePage() {
-        page.navigate("https://practicesoftwaretesting.com");
+        navBar.openHomePage();
     }
 
     @BeforeEach
@@ -36,7 +37,7 @@ void setUp() {
     }
 
     @Test
-    @Story("Check out")
+    @Story("Checking out a product")
     @DisplayName("Checking out a single item")
     void whenCheckingOutASingleItem() {
         searchComponent.searchBy("pliers");
@@ -60,7 +61,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/AddToCartTest.java

@@ -12,7 +12,7 @@
 import org.junit.jupiter.api.Test;
 
 @DisplayName("Searching for products")
-@Feature("Searching for products")
+@Feature("Product Catalog")
 public class SearchForProductsTest extends PlaywrightTestCase {
 
     @BeforeEach
@@ -22,7 +22,7 @@ void openHomePage() {
 
     @Nested
     @DisplayName("Searching by keyword")
-    @Story("Searching by keyword")
+    @Story("Searching for products")
     class SearchingByKeyword {
 
         @Test
@@ -66,6 +66,5 @@ void clearingTheSearchResults() {
             var matchingProducts = productList.getProductNames();
             Assertions.assertThat(matchingProducts).hasSize(9);
         }
-
     }
 }

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

@@ -1,6 +1,7 @@
 package com.serenitydojo.playwright.toolshop.catalog.pageobjects;
 
 import com.microsoft.playwright.Page;
+import com.serenitydojo.playwright.toolshop.fixtures.ScreenshotManager;
 import io.qameta.allure.Step;
 
 public class NavBar {
@@ -10,18 +11,21 @@ public NavBar(Page page) {
         this.page = page;
     }
 
-    @Step("Open cart")
+    @Step("Open the shopping cart")
     public void openCart() {
         page.getByTestId("nav-cart").click();
+        ScreenshotManager.takeScreenshot(page, "Shopping cart");
     }
 
-    @Step("Open the home page")
+    @Step("Open home page")
     public void openHomePage() {
         page.navigate("https://practicesoftwaretesting.com");
+        ScreenshotManager.takeScreenshot(page, "Home page");
     }
 
-    @Step("Open the Contact page")
+    @Step("Open contact page")
     public void toTheContactPage() {
         page.navigate("https://practicesoftwaretesting.com/contact");
+        ScreenshotManager.takeScreenshot(page, "Contact page");
     }
 }

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

@@ -2,6 +2,7 @@
 
 import com.microsoft.playwright.Page;
 import com.microsoft.playwright.options.AriaRole;
+import com.serenitydojo.playwright.toolshop.fixtures.ScreenshotManager;
 import io.qameta.allure.Step;
 
 public class ProductDetails {
@@ -11,11 +12,12 @@ public ProductDetails(Page page) {
         this.page = page;
     }
 
-    @Step("Increase product quantity")
+    @Step("Increase quantity")
     public void increaseQuanityBy(int increment) {
         for (int i = 1; i <= increment; i++) {
             page.getByTestId("increase-quantity").click();
         }
+        ScreenshotManager.takeScreenshot(page, "Quantity increased by " + increment);
     }
 
     @Step("Add to cart")
@@ -27,5 +29,6 @@ public void addToCart() {
                     page.getByRole(AriaRole.ALERT).click();
                 }
         );
+        ScreenshotManager.takeScreenshot(page, "Added to cart");
     }
 }

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

@@ -1,6 +1,7 @@
 package com.serenitydojo.playwright.toolshop.catalog.pageobjects;
 
 import com.microsoft.playwright.Page;
+import com.serenitydojo.playwright.toolshop.fixtures.ScreenshotManager;
 import io.qameta.allure.Step;
 
 import java.util.List;
@@ -19,6 +20,7 @@ public List<String> getProductNames() {
 
     @Step("View product details")
     public void viewProductDetails(String productName) {
+        ScreenshotManager.takeScreenshot(page, "View product details for " + productName);
         page.locator(".card").getByText(productName).click();
     }
 

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

@@ -2,6 +2,7 @@
 
 import com.microsoft.playwright.Page;
 import com.microsoft.playwright.options.AriaRole;
+import io.qameta.allure.Step;
 
 public class SearchComponent {
     private final Page page;
@@ -10,13 +11,15 @@ public SearchComponent(Page page) {
         this.page = page;
     }
 
+    @Step("Search for keyword")
     public void searchBy(String keyword) {
         page.waitForResponse("**/products/search?q=" + keyword, () -> {
             page.getByPlaceholder("Search").fill(keyword);
             page.getByRole(AriaRole.BUTTON, new Page.GetByRoleOptions().setName("Search")).click();
         });
     }
 
+    @Step("Clear the search criteria")
     public void clearSearch() {
         page.waitForResponse("**/products**", () -> {
             page.getByTestId("search-reset").click();

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

@@ -20,7 +20,7 @@
 import static com.microsoft.playwright.assertions.PlaywrightAssertions.assertThat;
 
 @DisplayName("Contact form")
-@Feature("Contact form")
+@Feature("Contacts")
 public class ContactFormTest extends PlaywrightTestCase {
 
     ContactForm contactForm;
@@ -33,7 +33,7 @@ void openContactPage() {
         navigate.toTheContactPage();
     }
 
-    @Story("Submitting a request")
+    @Story("Contact form")
     @DisplayName("Customers can use the contact form to contact us")
     @Test
     void completeForm() throws URISyntaxException {
@@ -52,7 +52,7 @@ void completeForm() throws URISyntaxException {
                 .contains("Thanks for your message! We will contact you shortly.");
     }
 
-    @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"})
@@ -75,7 +75,7 @@ void mandatoryFields(String fieldName) {
         assertThat(errorMessage).isVisible();
     }
 
-    @Story("Submitting a request")
+    @Story("Contact form")
     @DisplayName("The message must be at least 50 characters long")
     @Test
     void messageTooShort() {
@@ -91,7 +91,7 @@ void messageTooShort() {
         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"})

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

@@ -1,10 +1,13 @@
 package com.serenitydojo.playwright.toolshop.fixtures;
 
 import com.microsoft.playwright.*;
+import io.qameta.allure.Allure;
 import org.junit.jupiter.api.AfterAll;
 import org.junit.jupiter.api.AfterEach;
 import org.junit.jupiter.api.BeforeEach;
 
+import java.io.ByteArrayInputStream;
+import java.nio.file.Paths;
 import java.util.Arrays;
 
 public abstract class PlaywrightTestCase {
@@ -21,7 +24,7 @@ public abstract class PlaywrightTestCase {
         playwright.get().chromium().launch(
                 new BrowserType.LaunchOptions()
                         .setHeadless(true)
-                        .setArgs(Arrays.asList("--no-sandbox", "--disable-extensions", "--disable-gpu"))
+                       .setArgs(Arrays.asList("--no-sandbox", "--disable-extensions", "--disable-gpu"))
         )
     );
 
@@ -37,6 +40,7 @@ void setUpBrowserContext() {
 
     @AfterEach
     void closeContext() {
+        ScreenshotManager.takeScreenshot(page, "End of test");
         browserContext.close();
     }
 
@@ -48,5 +52,4 @@ static void tearDown() {
         playwright.get().close();
         playwright.remove();
     }
-
 }