Sample allure code

Author: wakaleo

pom.xml

@@ -12,8 +12,22 @@
         <maven.compiler.source>17</maven.compiler.source>
         <maven.compiler.target>17</maven.compiler.target>
         <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
+        <allure.version>2.25.0</allure.version>
+        <aspectj.version>1.9.21</aspectj.version>
     </properties>
 
+    <dependencyManagement>
+        <dependencies>
+            <dependency>
+                <groupId>io.qameta.allure</groupId>
+                <artifactId>allure-bom</artifactId>
+                <version>${allure.version}</version>
+                <type>pom</type>
+                <scope>import</scope>
+            </dependency>
+        </dependencies>
+    </dependencyManagement>
+
     <dependencies>
         <dependency>
             <groupId>com.microsoft.playwright</groupId>
@@ -37,6 +51,41 @@
             <artifactId>playwright</artifactId>
             <version>4.10.0</version>
         </dependency>
+        <dependency>
+            <groupId>io.qameta.allure</groupId>
+            <artifactId>allure-junit5</artifactId>
+            <scope>test</scope>
+        </dependency>
     </dependencies>
+    <build>
+        <plugins>
+            <plugin>
+                <groupId>org.apache.maven.plugins</groupId>
+                <artifactId>maven-surefire-plugin</artifactId>
+                <version>3.2.3</version>
+                <configuration>
+                    <argLine>
+                        -javaagent:"${settings.localRepository}/org/aspectj/aspectjweaver/${aspectj.version}/aspectjweaver-${aspectj.version}.jar"
+                    </argLine>
+                </configuration>
+                <dependencies>
+                    <dependency>
+                        <groupId>org.aspectj</groupId>
+                        <artifactId>aspectjweaver</artifactId>
+                        <version>${aspectj.version}</version>
+                    </dependency>
+                </dependencies>
+            </plugin>
+            <plugin>
+                <groupId>io.qameta.allure</groupId>
+                <artifactId>allure-maven</artifactId>
+                <version>2.15.0</version>
+                <configuration>
+                    <reportVersion>${allure.version}</reportVersion>
+                    <resultsDirectory>${project.build.directory}/allure-results</resultsDirectory>
+                </configuration>
+            </plugin>
+        </plugins>
+    </build>
 
 </project>

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

@@ -4,10 +4,12 @@
 import com.serenitydojo.playwright.toolshop.fixtures.PlaywrightTestCase;
 import org.assertj.core.api.Assertions;
 import org.junit.jupiter.api.BeforeEach;
+import org.junit.jupiter.api.DisplayName;
 import org.junit.jupiter.api.Test;
 
 import java.util.List;
 
+@DisplayName("Shopping Cart")
 public class AddToCartTest extends PlaywrightTestCase {
 
     SearchComponent searchComponent;
@@ -31,6 +33,7 @@ void setUp() {
     }
 
     @Test
+    @DisplayName("Checking out a single item")
     void whenCheckingOutASingleItem() {
         searchComponent.searchBy("pliers");
         productList.viewProductDetails("Combination Pliers");
@@ -53,8 +56,10 @@ void whenCheckingOutASingleItem() {
     }
 
     @Test
+    @DisplayName("Checking out multiple items")
     void whenCheckingOutMultipleItems() {
         navBar.openHomePage();
+
         productList.viewProductDetails("Bolt Cutters");
         productDetails.increaseQuanityBy(2);
         productDetails.addToCart();

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

@@ -1,6 +1,7 @@
 package com.serenitydojo.playwright.toolshop.catalog.pageobjects;
 
 import com.microsoft.playwright.Page;
+import io.qameta.allure.Step;
 
 import java.util.List;
 

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

@@ -1,19 +1,27 @@
 package com.serenitydojo.playwright.toolshop.catalog.pageobjects;
 
 import com.microsoft.playwright.Page;
+import io.qameta.allure.Step;
 
 public class NavBar {
-        private final Page page;
+    private final Page page;
 
-        public NavBar(Page page) {
-            this.page = page;
-        }
+    public NavBar(Page page) {
+        this.page = page;
+    }
+
+    @Step("Open cart")
+    public void openCart() {
+        page.getByTestId("nav-cart").click();
+    }
 
-        public void openCart() {
-             page.getByTestId("nav-cart").click();
-        }
+    @Step("Open the home page")
+    public void openHomePage() {
+        page.navigate("https://practicesoftwaretesting.com");
+    }
 
-        public void openHomePage() {
-            page.navigate("https://practicesoftwaretesting.com");
-        }
+    @Step("Open the Contact page")
+    public void toTheContactPage() {
+        page.navigate("https://practicesoftwaretesting.com/contact");
     }
+}

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

@@ -2,27 +2,30 @@
 
 import com.microsoft.playwright.Page;
 import com.microsoft.playwright.options.AriaRole;
+import io.qameta.allure.Step;
 
 public class ProductDetails {
-        private final Page page;
+    private final Page page;
 
-        public ProductDetails(Page page) {
-            this.page = page;
-        }
+    public ProductDetails(Page page) {
+        this.page = page;
+    }
 
-        public void increaseQuanityBy(int increment) {
-            for (int i = 1; i <= increment; i++) {
-                page.getByTestId("increase-quantity").click();
-            }
+    @Step("Increase product quantity")
+    public void increaseQuanityBy(int increment) {
+        for (int i = 1; i <= increment; i++) {
+            page.getByTestId("increase-quantity").click();
         }
+    }
 
-        public void addToCart() {
-            page.waitForResponse(
-                    response -> response.url().contains("/carts") && response.request().method().equals("POST"),
-                    () -> {
-                        page.getByText("Add to cart").click();
-                        page.getByRole(AriaRole.ALERT).click();
-                    }
-            );
-        }
+    @Step("Add to cart")
+    public void addToCart() {
+        page.waitForResponse(
+                response -> response.url().contains("/carts") && response.request().method().equals("POST"),
+                () -> {
+                    page.getByText("Add to cart").click();
+                    page.getByRole(AriaRole.ALERT).click();
+                }
+        );
     }
+}

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

@@ -1,6 +1,7 @@
 package com.serenitydojo.playwright.toolshop.catalog.pageobjects;
 
 import com.microsoft.playwright.Page;
+import io.qameta.allure.Step;
 
 import java.util.List;
 
@@ -16,6 +17,7 @@ public List<String> getProductNames() {
         return page.getByTestId("product-name").allInnerTexts();
     }
 
+    @Step("View product details")
     public void viewProductDetails(String productName) {
         page.locator(".card").getByText(productName).click();
     }

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

@@ -1,7 +1,9 @@
 package com.serenitydojo.playwright.toolshop.contact;
 
 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 org.assertj.core.api.Assertions;
 import org.junit.jupiter.api.BeforeEach;
 import org.junit.jupiter.api.DisplayName;
@@ -15,15 +17,18 @@
 
 import static com.microsoft.playwright.assertions.PlaywrightAssertions.assertThat;
 
+@DisplayName("Contact form")
 public class ContactFormTest extends PlaywrightTestCase {
 
     ContactForm contactForm;
+    NavBar navigate;
 
     @DisplayName("When submitting a request")
     @BeforeEach
     void openContactPage() {
         contactForm = new ContactForm(page);
-        page.navigate("https://practicesoftwaretesting.com/contact");
+        navigate = new NavBar(page);
+        navigate.toTheContactPage();
     }
 
     @DisplayName("Customers can use the contact form to contact us")
@@ -48,6 +53,8 @@ void completeForm() throws URISyntaxException {
     @ParameterizedTest
     @ValueSource(strings = {"First name", "Last name", "Email", "Message"})
     void mandatoryFields(String fieldName) {
+        Allure.parameter("fieldName", fieldName);
+
         // Fill in the field values
         contactForm.setFirstName("Sarah-Jane");
         contactForm.setLastName("Smith");
@@ -85,6 +92,7 @@ void messageTooShort() {
     @ParameterizedTest
     @ValueSource(strings = {"not-an-email", "not-an.email.com", "notanemail"})
     void invalidEmailField(String invalidEmail) {
+        Allure.parameter("invalidEmail", invalidEmail);
 
         contactForm.setFirstName("Sarah-Jane");
         contactForm.setLastName("Smith");

src/test/resources/allure.properties

@@ -0,0 +1 @@
+allure.results.directory=target/allure-results