Playright support Module

.github/labeler.yml

@@ -33,3 +33,7 @@ devops:
 accessibility:
   - maqs-accessibility/*
   - maqs-accessibility/**/*
+
+playwright:
+  - maqs-playwright/*
+  - maqs-playwright/**/*

.github/workflows/maven.yml

@@ -61,7 +61,6 @@ jobs:
   getVersion:
     name: Get package version
     runs-on: ubuntu-latest
-    needs: draftRelease
     if: ${{ always() }}
     outputs:
       buildNumber: ${{ steps.ver.outputs.BUILD_NUMBER }}
@@ -109,14 +108,21 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        module-name: [ maqs-utilities, maqs-base, maqs-appium, maqs-selenium, maqs-webservices, maqs-cucumber, maqs-accessibility, maqs-database ]
+        module-name: [ maqs-utilities, maqs-base, maqs-appium, maqs-selenium, maqs-webservices, maqs-cucumber, maqs-accessibility, maqs-database, maqs-playwright ]
     steps:
       - name: Check if tests can be run
         if: matrix.module-name == 'maqs-appium' && github.actor == 'dependabot[bot]'
         run: |
           echo Cannot run Appium tests when build was triggered by dependabot
-          exit 1
+          exit 1  
       - uses: actions/checkout@v2
+      - uses: actions/setup-node@v2
+        if: matrix.module-name == 'maqs-playwright'
+        with:
+          node-version: '14.x'
+      - name: Install Playwright
+        if: matrix.module-name == 'maqs-playwright'
+        run: npx playwright install --with-deps  
       - name: Build and Start Unit Tests
         id: builder
         uses: ./.github/workflows/buildtest-action
@@ -148,7 +154,6 @@ jobs:
 
   sonarcloud:
     name: SonarCloud Analysis
-    if: github.actor != 'dependabot[bot]'
     runs-on: ubuntu-latest
     needs: [test-modules, getVersion]
     env:
@@ -218,7 +223,4 @@ jobs:
       - name: Label Pull Request
         uses: actions/labeler@v4
         with:
-          repo-token: "${{ secrets.GITHUB_TOKEN }}"
-
-
-
+          repo-token: "${{ secrets.GITHUB_TOKEN }}"

.gitignore

@@ -525,3 +525,4 @@ MigrationBackup/
 # Fody - auto-generated XML schema
 FodyWeavers.xsd
 
+*.zip

maqs-appium/src/main/java/com/cognizantsoftvision/maqs/appium/AppiumTestObject.java

@@ -24,9 +24,7 @@ public class AppiumTestObject extends BaseTestObject implements IAppiumTestObjec
    */
   public AppiumTestObject(AppiumDriver<WebElement> appiumDriver, ILogger logger,
       String fullyQualifiedTestName) {
-    super(logger, fullyQualifiedTestName);
-    this.getManagerStore().put(MobileDriverManager.class.getCanonicalName(),
-        new MobileDriverManager((() -> appiumDriver), this));
+    this(() -> appiumDriver, logger, fullyQualifiedTestName);
   }
 
   /**

maqs-cucumber/src/test/java/com/cognizantsoftvision/maqs/cucumber/unittestpagemodel/DummyBaseGenericStep.java

@@ -10,4 +10,5 @@
  * A Dummy DummyBaseGenericStep class for testing
  */
 public class DummyBaseGenericStep extends BaseGenericStep {
+
 }

maqs-playwright/config.xml

@@ -0,0 +1,64 @@
+<?xml version="1.0" encoding="utf-8"?>
+<configuration>
+    <GlobalMaqs>
+        <!-- Generic wait time in milliseconds - AKA how long do you wait for rechecking something -->
+        <WaitTime>100</WaitTime>
+
+        <!-- Generic time-out in milliseconds -->
+        <Timeout>10000</Timeout>
+
+        <!-- Do you want to create logs for your tests
+        <Log>YES</Log>
+        <Log>NO</Log>
+        <Log>OnFail</Log>-->
+        <Log>YES</Log>
+
+        <!--Logging Levels
+        <LogLevel>VERBOSE</LogLevel>
+        <LogLevel>INFORMATION</LogLevel>
+        <LogLevel>GENERIC</LogLevel>
+        <LogLevel>SUCCESS</LogLevel>
+        <LogLevel>WARNING</LogLevel>
+        <LogLevel>ERROR</LogLevel>-->
+        <LogLevel>VERBOSE</LogLevel>
+
+        <!-- Logging Types
+        <LogType>CONSOLE</LogType>
+        <LogType>TXT</LogType>
+        <LogType>HTML</LogType>-->
+        <LogType>TXT</LogType>
+
+        <!-- Log file path - Defaults to build location if no value is defined -->
+        <FileLoggerPath>./target/logs</FileLoggerPath>
+    </GlobalMaqs>
+    <PlaywrightMaqs>
+        <!--Default base web url-->
+        <WebBase>https://cognizantopensource.github.io/maqs-dotnet-templates/Static/Automation/</WebBase>
+
+        <!--Local browser settings
+        <add key="Browser" value="Chrome"/>
+        <add key="Browser" value="Chromium"/>
+        <add key="Browser" value="Firefox"/>
+        <add key="Browser" value="Edge"/>
+        <add key="Browser" value="Webkit"/>-->
+        <Browser>Chrome</Browser>
+        <Headless>YES</Headless>
+
+        <!--Playwright specific timeouts in milliseconds-->
+        <Timeout>20000</Timeout>
+        <CommandTimeout>200000</CommandTimeout>
+
+        <!--Browser Resize settings - The Default is 1280x720
+        <add key="BrowserSize" value="DEFAULT" />-->
+        <BrowserSize>DEFAULT</BrowserSize>
+
+        <!--Playwright specific logging options-->
+        <CaptureVideo>NO</CaptureVideo>
+        <CaptureScreenshots>NO</CaptureScreenshots>
+        <CaptureSnapshots>YES</CaptureSnapshots>
+
+        <!--Proxy  settings-->
+        <UseProxy>No</UseProxy>
+        <ProxyAddress>http://localhost:8002</ProxyAddress>
+    </PlaywrightMaqs>
+</configuration>

maqs-playwright/pom.xml

@@ -0,0 +1,41 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project xmlns="http://maven.apache.org/POM/4.0.0"
+         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
+    <modelVersion>4.0.0</modelVersion>
+
+    <parent>
+        <groupId>com.cognizantsoftvision.maqs</groupId>
+        <artifactId>maqs-java</artifactId>
+        <version>${revision}</version>
+    </parent>
+
+    <groupId>com.cognizantsoftvision.maqs.playwright</groupId>
+    <artifactId>maqs-playwright</artifactId>
+    <name>MAQS Playwright Testing Module</name>
+    <version>${revision}</version>
+
+    <properties>
+        <playwright.version>1.21.0</playwright.version>
+    </properties>
+
+    <dependencies>
+        <dependency>
+            <groupId>com.cognizantsoftvision.maqs.base</groupId>
+            <artifactId>maqs-base</artifactId>
+        </dependency>
+        <dependency>
+            <groupId>com.cognizantsoftvision.maqs.utilities</groupId>
+            <artifactId>maqs-utilities</artifactId>
+        </dependency>
+        <dependency>
+            <groupId>org.testng</groupId>
+            <artifactId>testng</artifactId>
+        </dependency>
+        <dependency>
+            <groupId>com.microsoft.playwright</groupId>
+            <artifactId>playwright</artifactId>
+            <version>${playwright.version}</version>
+        </dependency>
+    </dependencies>
+</project>

maqs-playwright/src/main/java/com/cognizantsoftvision/maqs/playwright/BasePlaywrightPageModel.java

@@ -0,0 +1,119 @@
+/*
+ * Copyright 2022 (C) Cognizant SoftVision, All rights Reserved
+ */
+
+package com.cognizantsoftvision.maqs.playwright;
+
+import com.cognizantsoftvision.maqs.utilities.logging.ILogger;
+import com.cognizantsoftvision.maqs.utilities.performance.IPerfTimerCollection;
+
+/**
+ * The Base Playwright page model class.
+ */
+public abstract class BasePlaywrightPageModel {
+
+  /**
+   * Initializes a new instance of the BasePlaywrightPageModel class.
+   * @param testObject The Playwright test object
+   */
+  protected BasePlaywrightPageModel(IPlaywrightTestObject testObject) {
+    this.setTestObject(testObject);
+    this.setPageDriver(testObject.getPageDriver());
+  }
+
+  /**
+   * Initializes a new instance of the BasePlaywrightPageModel class.
+   * @param testObject The Playwright test object
+   * @param customDriver Driver to use instead of the default test object related driver
+   */
+  protected BasePlaywrightPageModel(IPlaywrightTestObject testObject, PageDriver customDriver) {
+    this.setTestObject(testObject);
+    this.setPageDriver(customDriver);
+  }
+
+  /**
+   * the playwright PageDriver from the test object.
+   */
+  protected PageDriver pageDriver;
+
+  /**
+   * Gets the playwright PageDriver from the test object.
+   * @return the page driver
+   */
+  public PageDriver getPageDriver() {
+    return this.pageDriver;
+  }
+
+  /**
+   * Sets the playwright PageDriver from the test object.
+   * @param driver the page driver to be set
+   */
+  private void setPageDriver(PageDriver driver) {
+    this.pageDriver = driver;
+  }
+
+  /**
+   * The log from the test object.
+   */
+  protected ILogger log;
+
+  /**
+   * Gets the log from the test object.
+   * @return the logger
+   */
+  public ILogger getLogger() {
+    return this.getTestObject().getLogger();
+  }
+
+  /**
+   * The performance timer collection from the test object.
+   */
+  protected IPerfTimerCollection perfTimerCollection;
+
+  /**
+   * Gets the performance timer collection from the test object.
+   * @return the perf timer collection
+   */
+  public IPerfTimerCollection getPerfTimerCollection() {
+    return this.getTestObject().getPerfTimerCollection();
+  }
+
+  /**
+   * the Playwright test object.
+   */
+  protected IPlaywrightTestObject testObject;
+
+  /**
+   * Gets the Playwright test object.
+   * @return the playwright test object interface
+   */
+  public IPlaywrightTestObject getTestObject() {
+    return this.testObject;
+  }
+
+  /**
+   * Sets the Playwright test object.
+   * @param testObject the playwright test object
+   */
+  protected void setTestObject(IPlaywrightTestObject testObject) {
+    this.testObject = testObject;
+  }
+
+  /**
+   * Override the playwright PageDriver.
+   * This allows you to use something other than the default tests
+   * object playwright PageDriver.
+   *
+   * @param pageDriver the new page driver
+   */
+  public void overridePageDriver(PageDriver pageDriver) {
+    // Override driver
+    this.pageDriver = pageDriver;
+  }
+
+  /**
+   * Check if the page has been loaded.
+   * @return True if the page was loaded
+   */
+  public abstract boolean isPageLoaded();
+}