# Appium Native C# Tutorial

Applitools SDKs work with existing test frameworks to take screenshots of pages, elements, regions or iframes and upload them along with DOM snapshots to our Eyes server. Our AI then compares them with previous test executions' screenshots (aka Baselines) and reports if there is a bug or not. It's that simple!

# 1.1 Baseline vs. Checkpoint images

When you first run the test, our A.I. server stores those first set of screenshots as Baseline images. When you run the same test again (and everytime there after), the A.I. server compares the new set of screenshots, aka Checkpoint images, with the corresponding Baseline images and highlights differences in a pink color.

# 1.2 Marking the test as "Pass" or "Fail"

When the AI compares the baseline and the checkpoint image, if it finds a legitimate difference, it will mark the test as Unresolved. This is because the AI doesn't know if the difference is because of a new feature or a real bug and will wait for you to manually mark it as a Pass/Fail for the 1st time.

If you mark the Unresolved checkpoint image as a "Fail", any further runs with similar difference will be automatically marked as "Failed".

If you mark the Unresolved checkpoint image as a "Pass", then it means that the difference is due to a new feature so we set the new checkpoint image as the new baseline and mark the current test as Pass. Going forward we'll compare any future tests with this new baseline.

# A powerful test results dashboard

We provide a state-of-the-art dashboard that makes it very easy for you to analyze differences, report bugs and much more. For more information on the Applitools dashboard check out these articles.

The following Gifs show various tools Applitools provides to easily analyze various differences

# Highlight differences between the baseline and checkpoint

# Zoom into differences

# Toggle between baseline and checkpoint

# Show both the baseline and checkpoint side-by-side

You can select a section of the image and directly file a bug in Jira or Github. No need to manually take screenshots, write steps and explain things! To read more about bug regions check out this article.

1. Create a free Applitools account and get your Applitools API KEY

2. Set the APPLITOOLS_API_KEY environment variable

   • Mac: export APPLITOOLS_API_KEY='YOUR_API_KEY'

   • Windows: set APPLITOOLS_API_KEY='YOUR_API_KEY'

   TIP

   1. You may skip this step if you want to hard code the API KEY inside the tutorial project's code.
   2. It's better to store APPLITOOLS_API_KEY in the system variables (in Windows) or in the ~/.bash_profile (in Mac) so that it is accessible from all Terminal shells

3. Install Visual Studio from here

4. Install git from https://git-scm.com​

   TIP

   Installing git is optional. You need this mainly to clone the demo project from the Github repository. Instead of installing git, you can simply download the Zip file from the repo. Further, If you are using Mac OSX, you already have git.

5. An iOS or Android Simulator/Device to run the app

6. Install Appium from here

1. Get the code:
   • Option 1: git clone https://github.com/applitools/tutorial-appium-csharp-basic
   • Option 2: Download it as a Zip file and unzip it.
2. Import the project into Visual Studio:
   • Open Visual Studio from the command line by running something similar to: open /Applications/Visual\ Studio.app/ rather than double-clicking on it. This approach will load all the environment variables such as APPLITOOLS_API_KEY from the command line shell.

3. In Visual Studio, open the ApplitoolsTutorial by navigating to the downloaded project via File | open and double click the ApplitoolsTutorials.sln file.

4. Update SDK and Dependencies:

   1. Right click the Dependencies folder in Visual Studio
   2. Select Update

5. Ensure Appium is downloaded and running

6. Hit Run button in Visual Studio to run the code

1. Include the SDK as a Nuget Package
   • In Visual Studio select Project > Manage Nuget Packages
   • Search for Eyes.Appium Package and select the package
   • Click "Add Package"

# Example Test On Android Simulator

using Applitools.Appium;
using NUnit.Framework;
using OpenQA.Selenium.Appium;
using OpenQA.Selenium.Appium.Enums;
using OpenQA.Selenium.Remote;
using System;

namespace ApplitoolsTutorial
{

    [TestFixture]
    public class BasicDemo
    {

        private RemoteWebDriver driver;
        private Eyes eyes;

        [Test]
        public void AndroidTest()
        {
            // Initialize the eyes SDK (IMPORTANT: make sure your API key is set in the APPLITOOLS_API_KEY env variable).
            eyes = new Eyes();

            // Set the desired capabilities. If using IOS, change capabilities accordingly
            AppiumOptions options = new AppiumOptions();
            options.AddAdditionalCapability(MobileCapabilityType.DeviceName, "Samsung Galaxy S9 WQHD GoogleAPI Emulator");
            options.AddAdditionalCapability(MobileCapabilityType.PlatformVersion, "9.0");
            options.AddAdditionalCapability(MobileCapabilityType.PlatformName, "Android");
            options.AddAdditionalCapability(MobileCapabilityType.App, "https://applitools.bintray.com/Examples/eyes-hello-world.apk");
            options.AddAdditionalCapability("deviceOrientation", "portrait");
            driver.Manage().Timeouts().ImplicitWait = TimeSpan.FromSeconds(60);

            // Start visual UI testing.
            eyes.Open(driver, "Contacts!", "My first Appium native C# test!");

            // Visual UI testing.
            eyes.CheckWindow("Contact list!");

            // End the test.
            eyes.Close();
        }

        [TearDown]
        public void AfterEach()
        {
            // Close the browser.
            driver.Quit();

            // If the test was aborted before eyes.close was called, ends the test as aborted.
            eyes.AbortIfNotClosed();
        }

    }
}

1. Forgetting to set your API key (or getting 401 exception):

   • Resolution: See here and here

2. Not properly loading the API key from the environment variable into your IDE (like Eclipse):

   • After setting the APPLITOOLS_API_KEY in the environment variable to hold your Applitools API key, open the IDE from the command line terminal (and not from the IDE directly). On Mac, it’d look like this: Open a Terminal and then type: open ~/Applications/Eclipse.app. This will load Eclipse with all the environment variables.

3. Trying to run the test but nothing happens:

   • Check if the APPLITOOLS_API_KEY is null

4. Debug logs:

   • See this article to enable debug logs to help file support ticket

5. Failed to connect to Appium:

   • Ensure you have Appium downloaded and running