Merge pull request #61 from AutomateThePlanet/vrt-getting-started

VRT getting started

Author: mei-kyoseva

bellatrix.playwright/src/main/java/solutions/bellatrix/playwright/services/NavigationService.java

@@ -14,8 +14,11 @@
 package solutions.bellatrix.playwright.services;
 
 import com.google.common.base.Strings;
+import lombok.SneakyThrows;
 import solutions.bellatrix.core.utilities.SingletonFactory;
+import solutions.bellatrix.playwright.pages.WebPage;
 
+import java.lang.reflect.Method;
 import java.net.MalformedURLException;
 import java.net.URL;
 import java.net.URLDecoder;
@@ -28,6 +31,13 @@
 
 @SuppressWarnings("ALL")
 public class NavigationService extends WebService {
+    @SneakyThrows
+    public void to(WebPage page) {
+        Method method = page.getClass().getDeclaredMethod("getUrl");
+        method.setAccessible(true);
+        wrappedBrowser().getCurrentPage().navigate((String)method.invoke(page));
+    }
+
     public void to(String url) {
         wrappedBrowser().getCurrentPage().navigate(url);
     }

bellatrix.plugins.visual-regression-tracker/src/main/java/solutions/bellatrix/plugins/vrt/VisualRegressionService.java

@@ -76,6 +76,7 @@ public static TestRunResult track(String name) {
 
     public static String takeSnapshot(String name) {
         var screenshotPlugin = SingletonFactory.getInstance(ScreenshotPlugin.class);
+
         if (screenshotPlugin == null) {
             throw new IllegalArgumentException("It seems that the screenshot plugin isn't registered by the 'ScreenshotPlugin.class' key inside SingletonFactory's map or isn't registered at all!");
         }

bellatrix.web/src/main/java/solutions/bellatrix/web/services/NavigationService.java

@@ -14,11 +14,14 @@
 package solutions.bellatrix.web.services;
 
 import com.google.common.base.Strings;
+import lombok.SneakyThrows;
 import org.openqa.selenium.TimeoutException;
 import org.openqa.selenium.support.ui.WebDriverWait;
 import solutions.bellatrix.core.configuration.ConfigurationService;
 import solutions.bellatrix.web.configuration.WebSettings;
+import solutions.bellatrix.web.pages.WebPage;
 
+import java.lang.reflect.Method;
 import java.net.MalformedURLException;
 import java.net.URL;
 import java.net.URLDecoder;
@@ -37,6 +40,14 @@ public void to(String url) {
         getWrappedDriver().navigate().to(url);
     }
 
+    @SneakyThrows
+    public void to(WebPage page) {
+        Method method = page.getClass().getDeclaredMethod("getUrl");
+        method.setAccessible(true);
+        
+        getWrappedDriver().navigate().to((String)method.invoke(page));
+    }
+
     public void toLocalPage(String filePath) {
         URL testAppUrl = Thread.currentThread().getContextClassLoader().getResource(filePath);
         if (testAppUrl != null) {

getting-started/bellatrix.playwright.getting.started/pom.xml

@@ -45,6 +45,12 @@
             <version>1.0</version>
             <scope>compile</scope>
         </dependency>
+        <dependency>
+            <groupId>solutions.bellatrix</groupId>
+            <artifactId>bellatrix.plugins.visual-regression-tracker</artifactId>
+            <version>1.0-SNAPSHOT</version>
+            <scope>test</scope>
+        </dependency>
     </dependencies>
 
 </project>

getting-started/bellatrix.playwright.getting.started/src/test/java/O25_visual_regression_tracker/VisualRegressionTests.java

@@ -0,0 +1,61 @@
+package O25_visual_regression_tracker;
+
+import O25_visual_regression_tracker.data.MobileServicePage;
+import org.junit.jupiter.api.Test;
+import solutions.bellatrix.playwright.infrastructure.junit.WebTest;
+import solutions.bellatrix.plugins.vrt.VisualRegression;
+import solutions.bellatrix.plugins.vrt.VisualRegressionAssertions;
+import solutions.bellatrix.plugins.vrt.VisualRegressionPlugin;
+/*
+    To begin tracking visual regression with BELLATRIX, one must have this in the config file:
+    "visualRegressionSettings": {
+      "apiUrl": "", (REQUIRED)
+      "apiKey": "", (REQUIRED)
+      "project": "", (REQUIRED)
+      "branch": "vrt", (REQUIRED)
+      "enableSoftAssert": "true", (REQUIRED)
+      "ciBuildId": "vrt", (REQUIRED)
+      "httpTimeout": "15", (REQUIRED)
+      "defaultDiffTolerance": "0.1" (REQUIRED)
+    }
+
+    These settings are all required to start. After we have set them, we can then begin.
+ */
+
+// To mark a test class for visual regression, we simply use @VisualRegression annotation
+// One can also provide the VRT project name and the resolution, otherwise default values will be used
+@VisualRegression
+public class VisualRegressionTests extends WebTest {
+    protected void configure() {
+        super.configure();
+        addPlugin(VisualRegressionPlugin.class);
+
+        // it is also important to have the screenshot plugin registered as the base class
+        // addPluginAs(ScreenshotPlugin.class, WebScreenshotPlugin.class);
+        // check in your base test if it is registered as that
+    }
+    // We need @VisualRegression annotation so that the tracker process could start at the beginning of the test
+    // and be ready for use in said test.
+    // After the test is over, the tracker is closed.
+
+    @Test
+    public void visualRegressionTest_using_assertions() {
+        app().navigate().to("https://www.automatetheplanet.com/services/web-automation/");
+
+        VisualRegressionAssertions.assertSameAsBaseline("web-automation-service-page");
+        // This is the simplest way to start using VRT: by inserting a visual regression assertion method
+        // here, the name required is the name of the baseline
+    }
+
+    @Test
+    @VisualRegression // If only one of our tests is for visual regression tracking,
+    // the @VisualRegression annotation can be used on the method instead
+    public void visualRegressionTest_using_assertByPageObjectModel() {
+        var mobileServicePage = new MobileServicePage();
+
+        app().navigate().to(mobileServicePage);
+
+        // If our baseline has the same name as the POM, we can just pass the POM.
+        VisualRegressionAssertions.assertSameAsBaseline(mobileServicePage);
+    }
+}

getting-started/bellatrix.playwright.getting.started/src/test/java/O25_visual_regression_tracker/data/MobileServiceAssertions.java

@@ -0,0 +1,6 @@
+package O25_visual_regression_tracker.data;
+
+import solutions.bellatrix.playwright.pages.PageAsserts;
+
+public class MobileServiceAssertions extends PageAsserts<MobileServiceMap> {
+}

getting-started/bellatrix.playwright.getting.started/src/test/java/O25_visual_regression_tracker/data/MobileServiceMap.java

@@ -0,0 +1,10 @@
+package O25_visual_regression_tracker.data;
+
+import solutions.bellatrix.playwright.components.Div;
+import solutions.bellatrix.playwright.pages.PageMap;
+
+public class MobileServiceMap extends PageMap {
+    public Div rightPeopleSection() {
+        return app().create().byId(Div.class, "right-people-section bottom-40");
+    }
+}

getting-started/bellatrix.playwright.getting.started/src/test/java/O25_visual_regression_tracker/data/MobileServicePage.java

@@ -0,0 +1,10 @@
+package O25_visual_regression_tracker.data;
+
+import solutions.bellatrix.playwright.pages.WebPage;
+
+public class MobileServicePage extends WebPage<MobileServiceMap, MobileServiceAssertions> {
+    @Override
+    public String getUrl() {
+        return "https://www.automatetheplanet.com/services/mobile-automation/";
+    }
+}

getting-started/bellatrix.web.getting.started/pom.xml

@@ -50,6 +50,12 @@
             <version>5.9.2</version>
             <scope>test</scope>
         </dependency>
+        <dependency>
+            <groupId>solutions.bellatrix</groupId>
+            <artifactId>bellatrix.plugins.visual-regression-tracker</artifactId>
+            <version>1.0-SNAPSHOT</version>
+            <scope>test</scope>
+        </dependency>
     </dependencies>
 
 </project>

getting-started/bellatrix.web.getting.started/src/main/resources/testFrameworkSettings.dev.json

@@ -2,6 +2,16 @@
   "troubleshootingSettings": {
     "debugInformationEnabled": "true"
   },
+  "visualRegressionSettings": {
+    "apiUrl": "http://localhost:4200",
+    "apiKey": "DEFAULTUSERAPIKEYTOBECHANGED",
+    "project": "vrt",
+    "branch": "bellatrix-tests",
+    "enableSoftAssert": "true",
+    "ciBuildId": "local-automation-run",
+    "httpTimeout": "15",
+    "defaultDiffTolerance": "0.1"
+  },
   "webSettings": {
     "baseUrl": "http://demos.bellatrix.solutions/",
    "executionType":"regular",
@@ -17,6 +27,7 @@
     "screenshotsSaveLocation": "${user.home}/BELLATRIX/Screenshots",
     "videosOnFailEnabled": "false",
     "videosSaveLocation": "${user.home}/BELLATRIX/Videos",
+    "toastNotificationBddLogging": "false",
     "timeoutSettings": {
       "elementWaitTimeout": "30",
       "pageLoadTimeout": "30",