misc improvements

Author: Tahanima

.gitignore

@@ -16,4 +16,9 @@ out
 *.iml
 atlassian-ide-plugin.xml
 
+### Mac OS ###
+.DS_Store
+
+allure-results
+
 src/test/resources/testvideo/

README.md

@@ -159,10 +159,10 @@ The project is structured as follows:
 - ### Test Data
   The project uses *csv* file to store test data and [*univocity-parsers*](https://github.com/uniVocity/univocity-parsers) to retrieve the data and map it to a Java bean.
 
-  To add configurations for new test data, add a new Java bean in the [*dto*](./src/main/java/io/github/tahanima/dto) package. For example, let's say I want to add test data for a `User` with the attributes `First Name` and `Last Name`. The code for this is as follows:
+  To add configurations for new test data, add a new Java bean in the [*dto*](./src/main/java/io/github/tahanima/fixture) package. For example, let's say I want to add test data for a `User` with the attributes `First Name` and `Last Name`. The code for this is as follows:
 
    ```java
-   package io.github.tahanima.dto;
+   package io.github.tahanima.fixture;
 
    import com.univocity.parsers.annotations.Parsed;
 
@@ -187,7 +187,7 @@ The project is structured as follows:
    Test Case ID,First Name,Last Name
    TC-1,Tahanima,Chowdhury
    ```
-   For reference, check [this](./src/main/java/io/github/tahanima/dto/LoginDto.java), [this](./src/test/resources/testdata/login.csv) and [this](./src/test/java/io/github/tahanima/e2e/LoginTest.java).
+   For reference, check [this](./src/main/java/io/github/tahanima/fixture/LoginDto.java), [this](./src/test/resources/testdata/login.csv) and [this](./src/test/java/io/github/tahanima/e2e/LoginTest.java).
 
 - ### Page Objects and Page Component Objects
   The project uses [*Page Objects* and *Page Component Objects*](https://www.selenium.dev/documentation/test_practices/encouraged/page_object_models/) to capture the relevant behaviors of a web page. Check the [*ui*](./src/main/java/io/github/tahanima/ui) package for reference.

build.gradle

@@ -6,37 +6,49 @@ plugins {
 group 'io.github.tahanima'
 version '1.0-SNAPSHOT'
 
+configurations {
+    agent {
+        canBeResolved = true
+        canBeConsumed = true
+    }
+}
+
 repositories {
     mavenCentral()
 }
 
 dependencies {
+    agent "org.aspectj:aspectjweaver:1.9.24"
+
+    implementation 'com.microsoft.playwright:playwright:1.52.0'
     implementation 'org.aeonbits.owner:owner:1.0.12'
     implementation 'com.univocity:univocity-parsers:2.9.1'
-    implementation 'com.microsoft.playwright:playwright:1.43.0'
+    implementation 'io.qameta.allure:allure-junit5:2.29.1'
+    implementation 'com.github.automatedowl:allure-environment-writer:1.0.0'
     implementation 'org.apache.commons:commons-lang3:3.14.0'
     implementation 'org.slf4j:slf4j-api:2.0.13'
-    implementation 'io.qameta.allure:allure-junit-platform:2.27.0'
-    implementation 'com.github.automatedowl:allure-environment-writer:1.0.0'
 
-    compileOnly 'org.projectlombok:lombok:1.18.32'
-    annotationProcessor 'org.projectlombok:lombok:1.18.32'
-    testCompileOnly 'org.projectlombok:lombok:1.18.32'
-    testAnnotationProcessor 'org.projectlombok:lombok:1.18.32'
+    compileOnly 'org.projectlombok:lombok:1.18.38'
+    annotationProcessor 'org.projectlombok:lombok:1.18.38'
+    testCompileOnly 'org.projectlombok:lombok:1.18.38'
+    testAnnotationProcessor 'org.projectlombok:lombok:1.18.38'
 
-    testImplementation platform('org.junit:junit-bom:5.10.2')
+    testImplementation platform('org.junit:junit-bom:5.9.1')
     testImplementation 'org.junit.jupiter:junit-jupiter'
     testImplementation 'io.github.artsok:rerunner-jupiter:2.1.6'
     testImplementation 'org.slf4j:slf4j-simple:2.0.13'
 }
 
 test {
-    systemProperties = System.getProperties() as Map<String, ?>
+    ignoreFailures = true
+    systemProperties = System.getProperties().collectEntries { k, v -> [(k.toString()): v] }
     def group = System.getProperty('group', 'regression')
 
-    useJUnitPlatform() {
+    useJUnitPlatform {
         includeTags group
     }
+
+    jvmArgs = ["-javaagent:${configurations.agent.singleFile}"]
 }
 
 tasks.register('playwright', JavaExec) {

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

@@ -1,9 +1,7 @@
 package io.github.tahanima.factory;
 
 import com.microsoft.playwright.Page;
-
 import io.github.tahanima.ui.page.BasePage;
-
 import lombok.extern.slf4j.Slf4j;
 
 /**

src/main/java/io/github/tahanima/factory/BrowserFactory.java

@@ -1,12 +1,12 @@
 package io.github.tahanima.factory;
 
-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.config;
+
 /**
  * @author tahanima
  */

src/main/java/io/github/tahanima/dto/BaseDto.java renamed to src/main/java/io/github/tahanima/fixture/BaseFixture.java

@@ -1,7 +1,6 @@
-package io.github.tahanima.dto;
+package io.github.tahanima.fixture;
 
 import com.univocity.parsers.annotations.Parsed;
-
 import lombok.Getter;
 import lombok.ToString;
 
@@ -10,7 +9,7 @@
  */
 @Getter
 @ToString
-public class BaseDto {
+public class BaseFixture {
 
     @Parsed(field = "Test Case ID", defaultNullRead = "")
     private String testCaseId;

src/main/java/io/github/tahanima/dto/LoginDto.java renamed to src/main/java/io/github/tahanima/fixture/LoginFixture.java

@@ -1,7 +1,6 @@
-package io.github.tahanima.dto;
+package io.github.tahanima.fixture;
 
 import com.univocity.parsers.annotations.Parsed;
-
 import lombok.Getter;
 import lombok.ToString;
 
@@ -10,7 +9,7 @@
  */
 @Getter
 @ToString(callSuper = true)
-public class LoginDto extends BaseDto {
+public class LoginFixture extends BaseFixture {
 
     @Parsed(field = "Username", defaultNullRead = "")
     private String username;

src/main/java/io/github/tahanima/dto/ProductsDto.java renamed to src/main/java/io/github/tahanima/fixture/ProductsFixture.java

@@ -1,7 +1,6 @@
-package io.github.tahanima.dto;
+package io.github.tahanima.fixture;
 
 import com.univocity.parsers.annotations.Parsed;
-
 import lombok.Getter;
 import lombok.ToString;
 
@@ -10,7 +9,7 @@
  */
 @Getter
 @ToString(callSuper = true)
-public final class ProductsDto extends BaseDto {
+public final class ProductsFixture extends BaseFixture {
 
     @Parsed(field = "Username", defaultNullRead = "")
     private String username;

src/main/java/io/github/tahanima/report/AllureManager.java

@@ -0,0 +1,26 @@
+package io.github.tahanima.report;
+
+import com.google.common.collect.ImmutableMap;
+import org.apache.commons.lang3.StringUtils;
+
+import static com.github.automatedowl.tools.AllureEnvironmentWriter.allureEnvironmentWriter;
+import static io.github.tahanima.config.ConfigurationManager.config;
+
+/**
+ * @author tahanima
+ */
+public final class AllureManager {
+
+    private AllureManager() {}
+
+    public static void setAllureEnvironmentInfo() {
+        allureEnvironmentWriter(
+                ImmutableMap.<String, String>builder()
+                        .put("Platform", System.getProperty("os.name"))
+                        .put("Version", System.getProperty("os.version"))
+                        .put("Browser", StringUtils.capitalize(config().browser()))
+                        .put("Context URL", config().baseUrl())
+                        .build(),
+                config().allureResultsDir() + "/");
+    }
+}

src/main/java/io/github/tahanima/ui/component/Header.java

@@ -1,6 +1,7 @@
 package io.github.tahanima.ui.component;
 
 import com.microsoft.playwright.Page;
+import io.qameta.allure.Step;
 
 /**
  * @author tahanima
@@ -11,6 +12,7 @@ public Header(final Page page) {
         super(page);
     }
 
+    @Step("Click on the hamburger icon")
     public void clickOnHamburgerIcon() {
         page.click("#react-burger-menu-btn");
     }