update

Author: Tahanima

.gitignore

@@ -16,4 +16,4 @@ out
 *.iml
 atlassian-ide-plugin.xml
 
-report
+testoutput

build.gradle

@@ -20,22 +20,24 @@ dependencies {
     implementation 'com.univocity:univocity-parsers:2.9.1'
     implementation 'com.aventstack:extentreports:5.0.9'
     implementation 'com.microsoft.playwright:playwright:1.31.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'
 
-    testCompileOnly 'org.projectlombok:lombok:1.18.26'
-    testAnnotationProcessor 'org.projectlombok:lombok:1.18.26'
+    compileOnly 'org.projectlombok:lombok:1.18.26'
+    annotationProcessor 'org.projectlombok:lombok:1.18.26'
 
     testImplementation 'org.testng:testng:7.7.1'
     testImplementation 'org.slf4j:slf4j-simple:2.0.6'
 }
 
 test {
     systemProperties = System.getProperties() as Map<String, ?>
-    def groups = System.getProperty('groups', 'regression')
-    def thread = System.getProperty('thread', '5')
+    def group = System.getProperty('group', 'regression')
+    def thread = System.getProperty('thread', '100')
 
     useTestNG() {
-        includeGroups groups
+        includeGroups group
         parallel 'classes'
         threadCount thread as int
     }

settings.gradle

@@ -1,2 +1,2 @@
-rootProject.name = 'playwright-test-automation-boilerplate'
+rootProject.name = 'playwright-java-test-automation-architecture'
 

src/test/java/io/github/tahanima/config/Configuration.java renamed to src/main/java/io/github/tahanima/config/Configuration.java

@@ -14,7 +14,7 @@ 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 configuration() {
+    public static Configuration config() {
         return ConfigCache.getOrCreate(Configuration.class);
     }
 }

src/test/java/io/github/tahanima/config/ConfigurationManager.java renamed to src/main/java/io/github/tahanima/config/ConfigurationManager.java

@@ -1,6 +1,7 @@
 package io.github.tahanima.data;
 
 import com.univocity.parsers.annotations.Parsed;
+
 import lombok.Getter;
 import lombok.ToString;
 
@@ -11,7 +12,7 @@
  */
 @Getter
 @ToString
-public class BaseData {
+public class BaseTestData {
     @Parsed(field = "Test Case ID", defaultNullRead = "")
     private String testCaseId;
 

src/test/java/io/github/tahanima/data/BaseData.java renamed to src/main/java/io/github/tahanima/data/BaseTestData.java

@@ -1,7 +1,9 @@
 package io.github.tahanima.data.login;
 
 import com.univocity.parsers.annotations.Parsed;
-import io.github.tahanima.data.BaseData;
+
+import io.github.tahanima.data.BaseTestData;
+
 import lombok.Getter;
 import lombok.ToString;
 
@@ -12,7 +14,7 @@
  */
 @Getter
 @ToString(callSuper = true)
-public class LoginData extends BaseData {
+public class LoginTestData extends BaseTestData {
     @Parsed(field = "User Name", defaultNullRead = "")
     private String userName;
 

src/test/java/io/github/tahanima/data/login/LoginData.java renamed to src/main/java/io/github/tahanima/data/login/LoginTestData.java

@@ -0,0 +1,30 @@
+package io.github.tahanima.page;
+
+import static io.github.tahanima.config.ConfigurationManager.config;
+
+import com.microsoft.playwright.Page;
+
+import java.nio.file.Path;
+
+/**
+ * @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));
+    }
+}

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

@@ -1,4 +1,4 @@
-package io.github.tahanima.pages;
+package io.github.tahanima.page;
 
 import com.microsoft.playwright.Page;
 

src/test/java/io/github/tahanima/pages/BasePageFactory.java renamed to src/main/java/io/github/tahanima/page/BasePageFactory.java

@@ -1,39 +1,40 @@
-package io.github.tahanima.pages.login;
+package io.github.tahanima.page.login;
+
+import static io.github.tahanima.config.ConfigurationManager.config;
 
 import com.microsoft.playwright.Locator;
-import io.github.tahanima.pages.BasePage;
 
-import static io.github.tahanima.config.ConfigurationManager.configuration;
+import io.github.tahanima.page.BasePage;
 
 /**
  * This class captures the relevant UI components and functionalities of the login page.
  *
  * @author tahanima
  */
 public class LoginPage extends BasePage {
-    public LoginPage goTo() {
-        page.navigate(configuration().baseUrl());
+    public LoginPage navigateToUrl() {
+        page.navigate(config().baseUrl());
 
         return this;
     }
 
-    public LoginPage enterUsername(String username) {
+    public LoginPage fillUsernameInTextBox(String username) {
         page.fill("id=user-name", username);
 
         return this;
     }
 
-    public LoginPage enterPassword(String password) {
+    public LoginPage fillPasswordInTextBox(String password) {
         page.fill("id=password", password);
 
         return this;
     }
 
-    public Locator getErrorMessageLocator() {
+    public Locator getErrorMessage() {
         return page.locator(".error-message-container h3");
     }
 
-    public void clickLogin() {
+    public void clickOnLoginButton() {
         page.click("id=login-button");
     }
 }

src/test/java/io/github/tahanima/pages/login/LoginPage.java renamed to src/main/java/io/github/tahanima/page/login/LoginPage.java

@@ -1,7 +1,8 @@
-package io.github.tahanima.pages.product;
+package io.github.tahanima.page.product;
 
 import com.microsoft.playwright.Locator;
-import io.github.tahanima.pages.BasePage;
+
+import io.github.tahanima.page.BasePage;
 
 /**
  * This class captures only those features needed to support test functionalities of the login page.

src/test/java/io/github/tahanima/pages/product/ProductsPage.java renamed to src/main/java/io/github/tahanima/page/product/ProductsPage.java

@@ -1,13 +1,15 @@
-package io.github.tahanima.utils;
+package io.github.tahanima.report;
+
+import static io.github.tahanima.config.ConfigurationManager.config;
 
 import com.aventstack.extentreports.ExtentReports;
 import com.aventstack.extentreports.reporter.ExtentSparkReporter;
 
+import org.apache.commons.lang3.StringUtils;
+
 import java.text.SimpleDateFormat;
 import java.util.Date;
 
-import static io.github.tahanima.config.ConfigurationManager.configuration;
-
 /**
  * @author tahanima
  */
@@ -16,19 +18,24 @@ private ExtentReportManager() {}
 
     public static ExtentReports createReport() {
         String currentDate = new SimpleDateFormat("yyyy-MM-dd HH-mm-ss").format(new Date());
-
         String fileName =
-                String.format(
-                        "%sTestReport_%s.html", configuration().baseReportPath(), currentDate);
+                String.format("%sE2ETestReport_%s.html", config().baseReportPath(), currentDate);
 
         ExtentReports extentReport = new ExtentReports();
         ExtentSparkReporter spark = new ExtentSparkReporter(fileName);
-        extentReport.attachReporter(spark);
 
+        spark.config().setTimeStampFormat("dd MMM yyyy HH:mm:ss z");
+        spark.config().setTimelineEnabled(false);
+
+        extentReport.attachReporter(spark);
         extentReport.setSystemInfo("Platform", System.getProperty("os.name"));
         extentReport.setSystemInfo("Version", System.getProperty("os.version"));
-        extentReport.setSystemInfo("Browser", configuration().browser());
-        extentReport.setSystemInfo("Base URL", configuration().baseUrl());
+        extentReport.setSystemInfo("Browser", StringUtils.capitalize(config().browser()));
+        extentReport.setSystemInfo("Context URL", config().baseUrl());
+        extentReport.setSystemInfo(
+                "Test Group",
+                StringUtils.capitalize(
+                        StringUtils.defaultString(System.getProperty("groups"), "regression")));
 
         return extentReport;
     }

src/test/java/io/github/tahanima/utils/ExtentReportManager.java renamed to src/main/java/io/github/tahanima/report/ExtentReportManager.java

@@ -1,12 +1,12 @@
-package io.github.tahanima.browser;
+package io.github.tahanima.util;
+
+import static io.github.tahanima.config.ConfigurationManager.config;
 
 import com.microsoft.playwright.Browser;
 import com.microsoft.playwright.BrowserType;
 import com.microsoft.playwright.BrowserType.LaunchOptions;
 import com.microsoft.playwright.Playwright;
 
-import static io.github.tahanima.config.ConfigurationManager.configuration;
-
 /**
  * @author tahanima
  */
@@ -26,8 +26,8 @@ public Browser initialize(Playwright playwright) {
 
     public LaunchOptions options() {
         return new BrowserType.LaunchOptions()
-                .setHeadless(configuration().headless())
-                .setSlowMo(configuration().slowMotion());
+                .setHeadless(config().headless())
+                .setSlowMo(config().slowMotion());
     }
 
     public abstract Browser initialize(Playwright playwright);

src/test/java/io/github/tahanima/browser/BrowserFactory.java renamed to src/main/java/io/github/tahanima/util/BrowserFactory.java

@@ -1,18 +1,18 @@
-package io.github.tahanima.browser;
+package io.github.tahanima.util;
+
+import static io.github.tahanima.config.ConfigurationManager.config;
 
 import com.microsoft.playwright.Browser;
 import com.microsoft.playwright.Playwright;
 
-import static io.github.tahanima.config.ConfigurationManager.configuration;
-
 /**
  * @author tahanima
  */
 public final class BrowserManager {
     private BrowserManager() {}
 
     public static Browser browser(Playwright playwright) {
-        return BrowserFactory.valueOf(configuration().browser().toUpperCase())
+        return BrowserFactory.valueOf(config().browser().toUpperCase())
                 .initialize(playwright);
     }
 }

src/test/java/io/github/tahanima/browser/BrowserManager.java renamed to src/main/java/io/github/tahanima/util/BrowserManager.java

@@ -3,15 +3,11 @@ browser=chromium
 headless=true
 slow.motion=50
 timeout=10000
-
 # saucedemo base url
 base.url=https://www.saucedemo.com/
-
 # base path for test data
-base.test.data.path=src/test/resources/testData/
-
+base.test.data.path=src/test/resources/testdata/
 # base path for report
-base.report.path=report/
-
+base.report.path=testoutput/report/
 # base path for screenshot
-base.screenshot.path=screenshot/
+base.screenshot.path=testoutput/screenshot/

src/test/resources/config.properties renamed to src/main/resources/config.properties

@@ -1,13 +1,17 @@
 package io.github.tahanima.e2e;
 
+import static io.github.tahanima.config.ConfigurationManager.config;
+
 import com.microsoft.playwright.Browser;
 import com.microsoft.playwright.BrowserContext;
 import com.microsoft.playwright.Page;
 import com.microsoft.playwright.Playwright;
-import io.github.tahanima.browser.BrowserManager;
-import io.github.tahanima.pages.BasePage;
-import io.github.tahanima.pages.BasePageFactory;
-import io.github.tahanima.utils.TestListener;
+
+import io.github.tahanima.page.BasePage;
+import io.github.tahanima.page.BasePageFactory;
+import io.github.tahanima.util.BrowserManager;
+import io.github.tahanima.util.TestListener;
+
 import org.testng.annotations.AfterClass;
 import org.testng.annotations.BeforeClass;
 import org.testng.annotations.Listeners;
@@ -22,6 +26,14 @@ public class BaseE2ETest {
     protected BrowserContext browserContext;
     protected Page page;
 
+    protected String getTestDataFilePath(String path) {
+        return config().baseTestDataPath() + path;
+    }
+
+    protected String getScreenshotFilePath(String path) {
+        return config().baseScreenshotPath() + path;
+    }
+
     protected <T extends BasePage> T createInstance(Class<T> basePage) {
         return BasePageFactory.createInstance(page, basePage);
     }