feat: remove testng, extentreport and add junit5, allure report

Author: Tahanima

.gitignore

@@ -14,6 +14,4 @@ out
 *.ipr
 *.iws
 *.iml
-atlassian-ide-plugin.xml
-
-testoutput
+atlassian-ide-plugin.xml

build.gradle

@@ -1,5 +1,6 @@
 plugins {
     id 'java'
+    id 'io.qameta.allure' version '2.11.2'
 }
 
 group 'io.github.tahanima'
@@ -17,27 +18,25 @@ java {
 dependencies {
     implementation 'org.aeonbits.owner:owner:1.0.12'
     implementation 'com.univocity:univocity-parsers:2.9.1'
-    implementation 'com.aventstack:extentreports:5.0.9'
-    implementation 'com.microsoft.playwright:playwright:1.31.0'
+    implementation 'com.microsoft.playwright:playwright:1.33.0'
     implementation 'org.apache.commons:commons-lang3:3.12.0'
-    implementation 'org.apache.commons:commons-text:1.10.0'
     implementation 'org.slf4j:slf4j-api:2.0.6'
+    implementation 'io.qameta.allure:allure-junit-platform:2.22.0'
+    implementation 'com.github.automatedowl:allure-environment-writer:1.0.0'
 
     compileOnly 'org.projectlombok:lombok:1.18.26'
     annotationProcessor 'org.projectlombok:lombok:1.18.26'
 
-    testImplementation 'org.testng:testng:7.7.1'
+    testImplementation platform('org.junit:junit-bom:5.9.1')
+    testImplementation 'org.junit.jupiter:junit-jupiter'
     testImplementation 'org.slf4j:slf4j-simple:2.0.6'
 }
 
 test {
     systemProperties = System.getProperties() as Map<String, ?>
     def group = System.getProperty('group', 'regression')
-    def thread = System.getProperty('thread', '100')
 
-    useTestNG() {
-        includeGroups group
-        parallel 'classes'
-        threadCount thread as int
+    useJUnitPlatform() {
+        includeTags group
     }
 }

src/main/java/io/github/tahanima/config/Configuration.java

@@ -5,56 +5,27 @@
 import org.aeonbits.owner.Config.Sources;
 
 /**
- * Mapping interface for the global parameters contained within config.properties file.
- *
  * @author tahanima
  */
 @LoadPolicy(Config.LoadType.MERGE)
-@Sources({"system:properties", "classpath:config.properties"})
+@Sources({"system:properties", "classpath:general.properties", "classpath:allure.properties"})
 public interface Configuration extends Config {
-    /**
-     * @return a string containing the browser name
-     */
+
     String browser();
 
-    /**
-     * @return a string containing the base url of the AUT
-     */
     @Key("base.url")
     String baseUrl();
 
-    /**
-     * @return a boolean containing the choice whether the browser will run in headless mode
-     */
-    Boolean headless();
+    boolean headless();
 
-    /**
-     * @return an integer containing the slow motion value
-     */
     @Key("slow.motion")
     int slowMotion();
 
-    /**
-     * @return an integer containing the timeout value
-     */
-    @Key("timeout")
     int timeout();
 
-    /**
-     * @return a string containing the base path to store all the test data
-     */
     @Key("base.test.data.path")
     String baseTestDataPath();
 
-    /**
-     * @return a string containing the base path to store all the test reports
-     */
-    @Key("base.report.path")
-    String baseReportPath();
-
-    /**
-     * @return a string containing the base path to store all the failed test screenshots
-     */
-    @Key("base.screenshot.path")
-    String baseScreenshotPath();
+    @Key("allure.results.directory")
+    String allureResultsDir();
 }

src/main/java/io/github/tahanima/config/ConfigurationManager.java

@@ -3,17 +3,12 @@
 import org.aeonbits.owner.ConfigCache;
 
 /**
- * This class provides a singleton instance of the Configuration class.
- *
  * @author tahanima
  */
 public final class ConfigurationManager {
+
     private ConfigurationManager() {}
 
-    /**
-     * @return an instance of Configuration class from an internal cache
-     * @see <a href="http://owner.aeonbits.org/docs/singleton">reference</a>
-     */
     public static Configuration config() {
         return ConfigCache.getOrCreate(Configuration.class);
     }

src/main/java/io/github/tahanima/data/BaseTestData.java

@@ -6,16 +6,12 @@
 import lombok.ToString;
 
 /**
- * This class provides common properties for all the test data.
- *
  * @author tahanima
  */
 @Getter
 @ToString
 public class BaseTestData {
+
     @Parsed(field = "Test Case ID", defaultNullRead = "")
     private String testCaseId;
-
-    @Parsed(field = "Test Case Description", defaultNullRead = "")
-    private String testCaseDescription;
 }

src/main/java/io/github/tahanima/data/login/LoginTestData.java

@@ -8,13 +8,12 @@
 import lombok.ToString;
 
 /**
- * This class captures all the test data properties required for the login page.
- *
  * @author tahanima
  */
 @Getter
 @ToString(callSuper = true)
 public class LoginTestData extends BaseTestData {
+
     @Parsed(field = "User Name", defaultNullRead = "")
     private String userName;
 

src/main/java/io/github/tahanima/page/BasePage.java

@@ -4,27 +4,22 @@
 
 import com.microsoft.playwright.Page;
 
-import java.nio.file.Path;
+import io.qameta.allure.Step;
 
 /**
  * @author tahanima
  */
 public class BasePage {
+
     protected Page page;
 
     public void setAndConfigurePage(Page page) {
         this.page = page;
         page.setDefaultTimeout(config().timeout());
     }
 
-    private String getScreenshotFilePath(String path) {
-        return config().baseScreenshotPath() + path;
-    }
-
-    public void captureScreenshot(String fileName) {
-        page.screenshot(
-                new Page.ScreenshotOptions()
-                        .setPath(Path.of(String.format("%s.png", getScreenshotFilePath(fileName))))
-                        .setFullPage(true));
+    @Step
+    public byte[] captureScreenshot() {
+        return page.screenshot();
     }
 }

src/main/java/io/github/tahanima/page/BasePageFactory.java

@@ -6,6 +6,7 @@
  * @author tahanima
  */
 public final class BasePageFactory {
+
     private BasePageFactory() {}
 
     public static <T extends BasePage> T createInstance(Page page, Class<T> basePage) {

src/main/java/io/github/tahanima/page/login/LoginPage.java

@@ -5,35 +5,40 @@
 import com.microsoft.playwright.Locator;
 
 import io.github.tahanima.page.BasePage;
+import io.qameta.allure.Step;
 
 /**
- * This class captures the relevant UI components and functionalities of the login page.
- *
  * @author tahanima
  */
 public class LoginPage extends BasePage {
+
+    @Step
     public LoginPage navigateToUrl() {
         page.navigate(config().baseUrl());
 
         return this;
     }
 
+    @Step
     public LoginPage fillUsernameInTextBox(String username) {
         page.fill("id=user-name", username);
 
         return this;
     }
 
+    @Step
     public LoginPage fillPasswordInTextBox(String password) {
         page.fill("id=password", password);
 
         return this;
     }
 
+    @Step
     public Locator getErrorMessage() {
         return page.locator(".error-message-container h3");
     }
 
+    @Step
     public void clickOnLoginButton() {
         page.click("id=login-button");
     }

src/main/java/io/github/tahanima/page/product/ProductsPage.java

@@ -3,13 +3,14 @@
 import com.microsoft.playwright.Locator;
 
 import io.github.tahanima.page.BasePage;
+import io.qameta.allure.Step;
 
 /**
- * This class captures only those features needed to support test functionalities of the login page.
- *
  * @author tahanima
  */
 public class ProductsPage extends BasePage {
+
+    @Step
     public Locator getTitle() {
         return page.locator(".title");
     }