Added AcmeBankTest

Author: AutomationPanda

Applitools.Example.Tests/AcmeBankTest.cs

@@ -1,15 +1,158 @@
+using Applitools;
+using Applitools.Selenium;
+using Applitools.VisualGrid;
+using NUnit.Framework;
+using OpenQA.Selenium;
+using OpenQA.Selenium.Chrome;
+using System.Drawing;
+using System.Runtime;
+using ScreenOrientation = Applitools.VisualGrid.ScreenOrientation;
+
 namespace Applitools.Example.Tests;
 
-public class Tests
+public class AcmeBankTest
 {
+    // Test control inputs to read once and share for all tests
+    private static string? ApplitoolsApiKey;
+    private static bool Headless;
+
+    // Applitools objects to share for all tests
+    private static BatchInfo Batch;
+    private static Configuration Config;
+    private static VisualGridRunner Runner;
+
+    // Test-specific objects
+    private WebDriver Driver;
+    private Eyes Eyes;
+
+    [OneTimeSetUp]
+    public static void SetUpConfigAndRunner()
+    {
+        // This method sets up the configuration for running visual tests in the Ultrafast Grid.
+        // The configuration is shared by all tests in a test suite, so it belongs in a `OneTimeSetUp` 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 = Environment.GetEnvironmentVariable("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 = Environment.GetEnvironmentVariable("HEADLESS")?.ToLower() == "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));
+
+        // Create a new batch for tests.
+        // A batch is the collection of visual checkpoints for a test suite.
+        // Batches are displayed in the dashboard, so use meaningful names.
+        Batch = new BatchInfo("Example: Selenium C# NUnit with the Ultrafast Grid");
+
+        // Create a configuration for Applitools Eyes.
+        Config = new Configuration();
+
+        // Set the Applitools API key so test results are uploaded to your account.
+        // If you don't explicitly set the API key with this call,
+        // then the SDK will automatically read the `APPLITOOLS_API_KEY` environment variable to fetch it.
+        Config.SetApiKey(ApplitoolsApiKey);
+
+        // 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);
+
+        // 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);
+    }
+
     [SetUp]
-    public void Setup()
+    public void OpenBrowserAndEyes()
     {
+        // This method sets up each test with its own ChromeDriver and Applitools Eyes objects.
+
+        // Open the browser with the ChromeDriver instance.
+        // Even though this test will run visual checkpoints on different browsers in the Ultrafast Grid,
+        // it still needs to run the test one time locally to capture snapshots.
+        ChromeOptions options = new ChromeOptions();
+        if (Headless) options.AddArgument("headless");
+        Driver = new ChromeDriver(options);
+
+        // Set an implicit wait of 10 seconds.
+        // For larger projects, use explicit waits for better control.
+        // https://www.selenium.dev/documentation/webdriver/waits/
+        // The following call works for Selenium 4:
+        Driver.Manage().Timeouts().ImplicitWait = TimeSpan.FromSeconds(10);
+
+        // Create the Applitools Eyes object connected to the VisualGridRunner and set its configuration.
+        Eyes = new Eyes(Runner);
+        Eyes.SetConfiguration(Config);
+
+        // Open Eyes to start visual testing.
+        // It is a recommended practice to set all four inputs:
+        string testName = NUnit.Framework.TestContext.CurrentContext.Test.Name;
+        Eyes.Open(
+            Driver,                         // WebDriver object to "watch"
+            "ACME Bank Web App",            // The name of the app under test
+            testName,                       // The name of the test case
+            new Size(1024, 768));           // The viewport size for the local browser
     }
 
     [Test]
-    public void Test1()
+    public void LogIntoBankAccount()
     {
-        Assert.Pass();
+        // This test covers login for the Applitools demo site, which is a dummy banking app.
+        // The interactions use typical Selenium WebDriver calls,
+        // but the verifications use one-line snapshot calls with Applitools Eyes.
+        // If the page ever changes, then Applitools will detect the changes and highlight them in the dashboard.
+        // Traditional assertions that scrape the page for text values are not needed here.
+
+        // Load the login page.
+        Driver.Navigate().GoToUrl("https://demo.applitools.com");
+
+        // Verify the full login page loaded correctly.
+        Eyes.Check(Target.Window().Fully().WithName("Login page"));
+
+        // Perform login.
+        Driver.FindElement(By.Id("username")).SendKeys("applibot");
+        Driver.FindElement(By.Id("password")).SendKeys("I<3VisualTests");
+        Driver.FindElement(By.Id("log-in")).Click();
+
+        // Verify the full main page loaded correctly.
+        // This snapshot uses LAYOUT match level to avoid differences in closing time text.
+        Eyes.Check(Target.Window().Fully().WithName("Main page").Layout());
+    }
+
+    [TearDown]
+    public void CleanUpTest() {
+
+        // Quit the WebDriver instance.
+        Driver.Quit();
+
+        // Close Eyes to tell the server it should display the results.
+        Eyes.CloseAsync();
+
+        // Warning: `Eyes.CloseAsync()` will NOT wait for visual checkpoints to complete.
+        // You will need to check the Applitools dashboard for visual results per checkpoint.
+        // Note that "unresolved" and "failed" visual checkpoints will not cause the NUnit test to fail.
+
+        // If you want the NUnit test to wait synchronously for all checkpoints to complete, then use `eyes.close()`.
+        // If any checkpoints are unresolved or failed, then `eyes.close()` will make the NUnit test fail.
+    }
+
+    [OneTimeTearDown]
+    public static void PrintResults() {
+
+        // Close the batch and report visual differences to the console.
+        // Note that it forces NUnit to wait synchronously for all visual checkpoints to complete.
+        TestResultsSummary allTestResults = Runner.GetAllTestResults();
+        Console.WriteLine(allTestResults);
     }
 }

Applitools.Example.Tests/Applitools.Example.Tests.csproj

@@ -9,6 +9,7 @@
   </PropertyGroup>
 
   <ItemGroup>
+    <PackageReference Include="Eyes.Selenium4" Version="3.33.0" />
     <PackageReference Include="Microsoft.NET.Test.Sdk" Version="17.3.2" />
     <PackageReference Include="NUnit" Version="3.13.3" />
     <PackageReference Include="NUnit3TestAdapter" Version="4.2.1" />