Combined UFG + Classic runner into one project

Author: AutomationPanda

README.md

@@ -1,10 +1,9 @@
-# Applitools Example: Playwright Java JUnit with the Ultrafast Grid
+# Applitools Example: Playwright in Java with JUnit
 
 This is the example project for the [Playwright Java tutorial](https://applitools.com/tutorials/quickstart/web/playwright/java).
 It shows how to start automating visual tests
 with [Applitools Eyes](https://applitools.com/platform/eyes/)
-and the [Ultrafast Grid](https://applitools.com/platform/ultrafast-grid/)
-using [Playwright](https://playwright.dev/java) in Java.
+and [Playwright](https://playwright.dev/java) in Java.
 
 It uses:
 
@@ -14,6 +13,9 @@ It uses:
 * [Apache Maven](https://maven.apache.org/index.html) for dependency management
 * [JUnit 5](https://junit.org/junit5/) as the core test framework
 * [Applitools Eyes](https://applitools.com/platform/eyes/) for visual testing
+
+It can also run tests with:
+
 * [Applitools Ultrafast Grid](https://applitools.com/platform/ultrafast-grid/) for cross-browser execution
 
 To run this example project, you'll need:
@@ -24,6 +26,8 @@ To run this example project, you'll need:
 4. [Apache Maven](https://maven.apache.org/download.cgi) (typically bundled with IDEs).
 
 The main test case is [`AcmeBankTests.java`](src/test/java/com/applitools/example/AcmeBankTests.java).
+By default, the project will run tests with Ultrafast Grid.
+You can change these settings in the test class.
 
 To execute tests, set the `APPLITOOLS_API_KEY` environment variable
 to your [account's API key](https://applitools.com/tutorials/guides/getting-started/registering-an-account),

pom.xml

@@ -5,8 +5,8 @@
     <modelVersion>4.0.0</modelVersion>
 
     <groupId>com.applitools.example</groupId>
-    <artifactId>example-playwright-java-ufg</artifactId>
-    <version>1.0.0</version>
+    <artifactId>example-playwright-java</artifactId>
+    <version>2.0.0</version>
 
     <properties>
         <maven.compiler.source>1.8</maven.compiler.source>
@@ -18,7 +18,7 @@
             <plugin>
                 <groupId>org.apache.maven.plugins</groupId>
                 <artifactId>maven-surefire-plugin</artifactId>
-                <version>3.0.0-M6</version>
+                <version>3.1.0</version>
             </plugin>
         </plugins>
     </build>
@@ -27,13 +27,13 @@
         <dependency>
             <groupId>com.applitools</groupId>
             <artifactId>eyes-playwright-java5</artifactId>
-            <version>5.41.0</version>
+            <version>5.50.0</version>
             <scope>test</scope>
         </dependency>
         <dependency>
             <groupId>org.junit.jupiter</groupId>
             <artifactId>junit-jupiter</artifactId>
-            <version>5.9.1</version>
+            <version>5.9.3</version>
             <scope>test</scope>
         </dependency>
     </dependencies>

src/test/java/com/applitools/example/AcmeBankTests.java

@@ -1,9 +1,11 @@
 package com.applitools.example;
 
 import com.applitools.eyes.BatchInfo;
+import com.applitools.eyes.EyesRunner;
 import com.applitools.eyes.RectangleSize;
 import com.applitools.eyes.TestResultsSummary;
 import com.applitools.eyes.config.Configuration;
+import com.applitools.eyes.playwright.ClassicRunner;
 import com.applitools.eyes.playwright.Eyes;
 import com.applitools.eyes.playwright.fluent.Target;
 import com.applitools.eyes.visualgrid.BrowserType;
@@ -21,17 +23,22 @@
 
 public class AcmeBankTests {
     // This JUnit test case class contains everything needed to run a full visual test against the ACME bank site.
-    // It runs the test once locally,
-    // and then it performs cross-browser testing against multiple unique browsers in Applitools Ultrafast Grid.
+    // It runs the test once locally.
+    // If you use the Ultrafast Grid, then it performs cross-browser testing against multiple unique browsers.
+
+    // Runner Settings.
+    // These could be set by environment variables or other input mechanisms.
+    // They are hard-coded here to keep the example project simple.
+    private final static boolean USE_ULTRAFAST_GRID = true;
+    private final static boolean HEADLESS = false;
 
     // Test control inputs to read once and share for all tests
     private static String applitoolsApiKey;
-    private static boolean headless;
 
     // Applitools objects to share for all tests
     private static BatchInfo batch;
     private static Configuration config;
-    private static VisualGridRunner runner;
+    private static EyesRunner runner;
 
     // Test-specific objects
     private static Playwright playwright;
@@ -42,27 +49,29 @@ public class AcmeBankTests {
 
     @BeforeAll
     public static void setUpConfigAndRunner() {
-        // This method sets up the configuration for running visual tests in the Ultrafast Grid.
+        // This method sets up the configuration for running visual tests.
         // The configuration is shared by all tests in a test suite, so it belongs in a `BeforeAll` method.
         // If you have more than one test class, then you should abstract this configuration to avoid duplication.
 
         // Read the Applitools API key from an environment variable.
         applitoolsApiKey = System.getenv("APPLITOOLS_API_KEY");
 
-        // Read the headless mode setting from an environment variable.
-        // Use headless mode for Continuous Integration (CI) execution.
-        // Use headed mode for local development.
-        headless = Boolean.parseBoolean(System.getenv().getOrDefault("HEADLESS", "true"));
-
-        // Create the runner for the Ultrafast Grid.
-        // Concurrency refers to the number of visual checkpoints Applitools will perform in parallel.
-        // Warning: If you have a free account, then concurrency will be limited to 1.
-        runner = new VisualGridRunner(new RunnerOptions().testConcurrency(5));
+        if (USE_ULTRAFAST_GRID) {
+            // Create the runner for the Ultrafast Grid.
+            // Concurrency refers to the number of visual checkpoints Applitools will perform in parallel.
+            // Warning: If you have a free account, then concurrency will be limited to 1.
+            runner = new VisualGridRunner(new RunnerOptions().testConcurrency(5));
+        }
+        else {
+            // Create the Classic runner.
+            runner = new ClassicRunner();
+        }
 
         // Create a new batch for tests.
         // A batch is the collection of visual checkpoints for a test suite.
         // Batches are displayed in the Eyes Test Manager, so use meaningful names.
-        batch = new BatchInfo("Example: Playwright Java JUnit with the Ultrafast Grid");
+        String runnerName = (USE_ULTRAFAST_GRID) ? "Ultrafast Grid" : "Classic runner";
+        batch = new BatchInfo("Example: Playwright Java JUnit with the " + runnerName);
 
         // Create a configuration for Applitools Eyes.
         config = new Configuration();
@@ -75,20 +84,24 @@ public static void setUpConfigAndRunner() {
         // Set the batch for the config.
         config.setBatch(batch);
 
-        // Add 3 desktop browsers with different viewports for cross-browser testing in the Ultrafast Grid.
-        // Other browsers are also available, like Edge and IE.
-        config.addBrowser(800, 600, BrowserType.CHROME);
-        config.addBrowser(1600, 1200, BrowserType.FIREFOX);
-        config.addBrowser(1024, 768, BrowserType.SAFARI);
+        // If running tests on the Ultrafast Grid, configure browsers.
+        if (USE_ULTRAFAST_GRID) {
+
+            // Add 3 desktop browsers with different viewports for cross-browser testing in the Ultrafast Grid.
+            // Other browsers are also available, like Edge and IE.
+            config.addBrowser(800, 600, BrowserType.CHROME);
+            config.addBrowser(1600, 1200, BrowserType.FIREFOX);
+            config.addBrowser(1024, 768, BrowserType.SAFARI);
 
-        // Add 2 mobile emulation devices with different orientations for cross-browser testing in the Ultrafast Grid.
-        // Other mobile devices are available, including iOS.
-        config.addDeviceEmulation(DeviceName.Pixel_2, ScreenOrientation.PORTRAIT);
-        config.addDeviceEmulation(DeviceName.Nexus_10, ScreenOrientation.LANDSCAPE);
+            // Add 2 mobile emulation devices with different orientations for cross-browser testing in the Ultrafast Grid.
+            // Other mobile devices are available, including iOS.
+            config.addDeviceEmulation(DeviceName.Pixel_2, ScreenOrientation.PORTRAIT);
+            config.addDeviceEmulation(DeviceName.Nexus_10, ScreenOrientation.LANDSCAPE);
+        }
 
         // Start Playwright and launch the browser.
         playwright = Playwright.create();
-        browser = playwright.chromium().launch(new com.microsoft.playwright.BrowserType.LaunchOptions().setHeadless(headless));
+        browser = playwright.chromium().launch(new com.microsoft.playwright.BrowserType.LaunchOptions().setHeadless(HEADLESS));
     }
 
     @BeforeEach
@@ -103,7 +116,7 @@ public void openBrowserAndEyes(TestInfo testInfo) {
         // page = browser.newPage();
         page = context.newPage();
 
-        // Create the Applitools Eyes object connected to the VisualGridRunner and set its configuration.
+        // Create the Applitools Eyes object connected to the runner and set its configuration.
         eyes = new Eyes(runner);
         eyes.setConfiguration(config);