Merge pull request #5 from YuriiChere/master

Update tutorial test and README

Author: rajaraodv

ApplitoolsTutorial/ApplitoolsTutorial.csproj

@@ -8,7 +8,7 @@
   </PropertyGroup>
 
   <ItemGroup>
-    <PackageReference Include="Eyes.Selenium" Version="2.22.31" />
+    <PackageReference Include="Eyes.Selenium" Version="*" />
     <PackageReference Include="Microsoft.NET.Test.Sdk" Version="16.5.0" />
     <PackageReference Include="NUnit" Version="3.12.0" />
     <PackageReference Include="NUnit3TestAdapter" Version="3.16.1">

ApplitoolsTutorial/VisualGridDemo.cs

@@ -14,71 +14,79 @@ namespace ApplitoolsTutorial
     public class VisualGridDemo
     {
 
-        [Test]
-        public void VGTest()
-        {
-            // Create a new webdriver
-            IWebDriver webDriver = new ChromeDriver();
-
-            // Navigate to the url we want to test
-            webDriver.Url = "https://demo.applitools.com";
+        IWebDriver driver;
+        VisualGridRunner runner;
+        Eyes eyes;
 
-            // ⭐️ Note to see visual bugs, run the test using the above URL for the 1st run.
-            //but then change the above URL to https://demo.applitools.com/index_v2.html (for the 2nd run)
+        [SetUp]
+        public void BeforeEach()
+        {
+            // Use Chrome browser
+            driver = new ChromeDriver();
 
-            // Create a runner with concurrency of 10
-            VisualGridRunner runner = new VisualGridRunner(10);
+            //Create a runner with concurrency of 10
+            runner = new VisualGridRunner(10);
 
-            // Create Eyes object with the runner, meaning it'll be a Visual Grid eyes.
-            Eyes eyes = new Eyes(runner);
+            // Initialize the eyes SDK (IMPORTANT: make sure your API key is set in the APPLITOOLS_API_KEY env variable).
+            eyes = new Eyes(runner);
 
             // Get current Eyes configuration object
             Configuration conf = eyes.GetConfiguration();
 
 
-            //conf.SetApiKey("APPLITOOLS_API_KEY");  // Set the Applitools API KEY here or as an environment variable "APPLITOOLS_API_KEY"
-            conf.SetTestName("C# VisualGrid demo")   // Set test name
-                .SetAppName("Demo app");             // Set app name
+            conf.SetApiKey("APPLITOOLS_API_KEY");  // Set the Applitools API KEY here or as an environment variable "APPLITOOLS_API_KEY"
 
             // Add browsers with different viewports
             conf.AddBrowser(800, 600, BrowserType.CHROME);
             conf.AddBrowser(700, 500, BrowserType.FIREFOX);
-            conf.AddBrowser(1200, 800, BrowserType.IE_10);
             conf.AddBrowser(1600, 1200, BrowserType.IE_11);
-            conf.AddBrowser(1024, 768, BrowserType.EDGE);
+            conf.AddBrowser(1024, 768, BrowserType.EDGE_CHROMIUM);
             conf.AddBrowser(800, 600, BrowserType.SAFARI);
 
             // Add iPhone 4 device emulation in Portrait mode
-            conf.AddDeviceEmulation(DeviceName.iPhone_4, ScreenOrientation.Portrait);
+            conf.AddDeviceEmulation(DeviceName.iPhone_X, ScreenOrientation.Portrait);
+            conf.AddDeviceEmulation(DeviceName.Pixel_2, ScreenOrientation.Portrait);
 
 
             // Set the configuration object to eyes
             eyes.SetConfiguration(conf);
+        }
 
-            try
-            {
-                // Call Open on eyes to initialize a test session
-                eyes.Open(webDriver);
+        [Test]
+        public void VGTest()
+        {
+            // Navigate to the url we want to test
+            driver.Url = "https://demo.applitools.com";
+            // ⭐️ Note to see visual bugs, run the test using the above URL for the 1st run.
+            //but then change the above URL to https://demo.applitools.com/index_v2.html (for the 2nd run)
+
+            // Call Open on eyes to initialize a test session
+            eyes.Open(driver, "Demo App", "Ultrafast grid demo");
 
-                // check the login page
-                eyes.Check(Target.Window().Fully().WithName("Login page"));
-                webDriver.FindElement(By.Id("log-in")).Click();
+            // check the login page
+            eyes.Check(Target.Window().Fully().WithName("Login page"));
+            driver.FindElement(By.Id("log-in")).Click();
 
-                // Check the app page
-                eyes.Check(Target.Window().Fully().WithName("App page"));
+            // Check the app page
+            eyes.Check(Target.Window().Fully().WithName("App page"));
 
-                // Call Close on eyes to let the server know it should display the results
-                eyes.CloseAsync();
-            }
-            finally
-            {
-                // Close the browser
-                webDriver.Quit();
-            }
+            // Call Close on eyes to let the server know it should display the results
+            eyes.CloseAsync();
+        }
 
+        [TearDown]
+        public void AfterEach()
+        {
+            // Close the browser
+            driver.Quit();
             // Wait and collect all test results
-            TestResultsSummary allTestResults = runner.GetAllTestResults();
-            TestContext.Progress.WriteLine(allTestResults);
+            // we pass false to this method to suppress the exception that is thrown if we
+            // find visual differences
+            TestResultsSummary allTestResults = runner.GetAllTestResults(false);
+            // Print results
+            System.Console.WriteLine(allTestResults);
+            // If the test was aborted before eyes.close was called, ends the test as aborted.
+            eyes.AbortIfNotClosed();
         }
 
     }

README.md

@@ -12,7 +12,10 @@
 1. Git clone this repo
     * `git clone https://github.com/applitools/tutorial-selenium-csharp-ultrafastgrid.git`
 2. Open the folder `tutorial-selenium-csharp-ultrafastgrid`
-3. Double click the `ApplitoolsTutorial.sln`. This will open the project in Visual Studio
-3. Change the `APPLITOOLS_API_KEY` with your own.
+3. Get your API key to set it in code (or in the APPLITOOLS_API_KEY environment variable).
+    * You can get your API key by logging into Applitools > Person Icon > My API Key.
+4. Double click the `ApplitoolsTutorial.sln`. This will open the project in Visual Studio
+5. Change the `APPLITOOLS_API_KEY` with your own.
     * Login to Applitools > Click on the Person icon > My API Key
-4. Hit Run
+   Set your ApiKey in string 'conf.SetApiKey("...") ' (or comment the string and set APPLITOOLS_API_KEY environment variable)
+6. Navigate to Test Explorer, select test VGTest and hit Run