C# With Appium
Tutorial To Run Your First Test On LambdaTest
In this topic, you will learn how to configure and run your C# automation testing scripts with Appium on LambdaTest Real Device Cloud platform.
Objective
By the end of this topic, you will be able to:
- Run a sample automation script of C# for application testing with Appium on LambdaTest.
- Run test cases in parallel using C# with Appium to reduce build times.
- Learn more about AppiumOptions for Appium testing.
- Explore advanced features of LambdaTest.
All the code samples in this documentation can be found on LambdaTest's Github Repository. You can either download or clone the repository to quickly run your tests. View on GitHub
Pre-requisites
Before you can start performing App automation testing with Appium, you have to set up Visual Studio:
- Ensure you have access to LambdaTest username and accessKey. If you have not registered yet, you can do the same by visiting our website. You will be able to access the credentials in the LambdaTest Profile
Run your first test
1. Upload your application
Upload your iOS application (.ipa file) or android application (.apk file) to the LambdaTest servers using our REST API. You need to provide your Username and AccessKey in the format Username:AccessKey
in the cURL command for authentication. Make sure to add the path of the appFile in the cURL request. Here is an example cURL request to upload your app using our REST API:
Using App File from System:
curl -u "undefined:undefined" -X POST "https://manual-api.lambdatest.com/app/upload/realDevice" -F "appFile=@"/Users/macuser/Downloads/proverbial_android.apk"" -F "name="proverbial_app""
Using App URL:
curl -u "undefined:undefined" -X POST "https://manual-api.lambdatest.com/app/upload/realDevice" -F "url=:https://prod-mobile-artefacts.lambdatest.com/assets/docs/proverbial_android.apk" -F "name=Proverbial_App"
If you do not have any .apk or .ipa file, you can run your sample tests on LambdaTest by using our sample 🔗 Android app or sample 🔗 iOS app.
Response of above cURL will be a JSON object containing the
APP_URL
of the format - lt://APP123456789123456789 and will be used in the next step.
2. Clone the sample project
Clone the LambdaTest’s 🔗 LT-appium-java repository.
Open the Android/iOS project using the file with a .sln extension.
3. Set up your authentication
Make sure you have your LambdaTest credentials with you to run test automation scripts on LambdaTest. To obtain your access credentials, purchase a plan or access the Automation Dashboard. Then, set LambdaTest Username
and Access Key
in environment variables with following commands.
- Linux / MacOS
- Windows
export LT_USERNAME=undefined \
export LT_ACCESS_KEY=undefined
set LT_USERNAME=undefined `
set LT_ACCESS_KEY=undefined
4. Write your automation script
An automation script for the sample application available above has been provided here. Ensure to update the APP_URL
, username
and accesKey
in the code scripts before running the tests.
- iOS
- Android
using System;
using OpenQA.Selenium.Appium;
using OpenQA.Selenium.Support.UI;
using OpenQA.Selenium.Appium.iOS;
using System.Threading;
namespace csharp_appium_first
{
class Program
{
static void Main(string[] args)
{
AppiumOptions caps = new AppiumOptions();
// Set your LambdaTest access credentials
caps.AddAdditionalCapability("LT_USERNAME", "username"); //Enter the Username here
caps.AddAdditionalCapability("LT_ACCESSKEY", "accessKey"); //Enter the Access key here
// Set URL of the application under test
caps.AddAdditionalCapability("app", "APP_URL"); //Enter the App URL here.
// Specify device and os_version
caps.AddAdditionalCapability("deviceName", "iPhone 12"); //Change the device name here
caps.AddAdditionalCapability("platformVersion", "15");
caps.AddAdditionalCapability("platformName", "iOS");
caps.AddAdditionalCapability("isRealMobile", true);
caps.AddAdditionalCapability("network", false);
// Specify the platformName
//caps.PlatformName = "iOS";
// Set other LambdaTest capabilities
caps.AddAdditionalCapability("project", "First CSharp project");
caps.AddAdditionalCapability("build", "CSharp iOS");
caps.AddAdditionalCapability("name", "first_test");
// Initialize the remote Webdriver using LambdaTest remote URL
// and desired capabilities defined above
IOSDriver<IOSElement> driver = new IOSDriver<IOSElement>(
new Uri("https://mobile-hub.lambdatest.com/wd/hub"), caps);
// Test case for the sample iOS app.
// If you have uploaded your app, update the test case here.
IOSElement color = (IOSElement)new WebDriverWait(driver, TimeSpan.FromSeconds(30)).Until(
SeleniumExtras.WaitHelpers.ExpectedConditions.ElementToBeClickable(MobileBy.Id("color"))
);
color.Click();
color.Click();
IOSElement text = (IOSElement)new WebDriverWait(driver, TimeSpan.FromSeconds(30)).Until(
SeleniumExtras.WaitHelpers.ExpectedConditions.ElementToBeClickable(MobileBy.Id("Text"))
);
text.Click();
IOSElement toast = (IOSElement)new WebDriverWait(driver, TimeSpan.FromSeconds(30)).Until(
SeleniumExtras.WaitHelpers.ExpectedConditions.ElementToBeClickable(MobileBy.Id("toast"))
);
toast.Click();
IOSElement nf = (IOSElement)new WebDriverWait(driver, TimeSpan.FromSeconds(30)).Until(
SeleniumExtras.WaitHelpers.ExpectedConditions.ElementToBeClickable(MobileBy.Id("notification"))
);
nf.Click();
IOSElement gl = (IOSElement)new WebDriverWait(driver, TimeSpan.FromSeconds(30)).Until(
SeleniumExtras.WaitHelpers.ExpectedConditions.ElementToBeClickable(MobileBy.Id("geoLocation"))
);
gl.Click();
Thread.Sleep(5000);
driver.Navigate().Back();
IOSElement st = (IOSElement)new WebDriverWait(driver, TimeSpan.FromSeconds(30)).Until(
SeleniumExtras.WaitHelpers.ExpectedConditions.ElementToBeClickable(MobileBy.Id("speedTest"))
);
st.Click();
Thread.Sleep(5000);
driver.Navigate().Back();
IOSElement browser = (IOSElement)new WebDriverWait(driver, TimeSpan.FromSeconds(30)).Until(
SeleniumExtras.WaitHelpers.ExpectedConditions.ElementToBeClickable(MobileBy.AccessibilityId("Browser"))
);
browser.Click();
IOSElement inputBox = (IOSElement)new WebDriverWait(driver, TimeSpan.FromSeconds(30)).Until(
SeleniumExtras.WaitHelpers.ExpectedConditions.ElementToBeClickable(MobileBy.Id("url"))
);
inputBox.Click();
driver.Quit();
}
}
}
using System;
using OpenQA.Selenium.Appium;
using OpenQA.Selenium.Support.UI;
using OpenQA.Selenium.Appium.Android;
using System.Threading;
namespace csharp_appium {
class Program {
static void Main(string[] args) {
AppiumOptions caps = new AppiumOptions();
caps.AddAdditionalCapability("user", "########"); //Add the LT Username
caps.AddAdditionalCapability("accessKey", "########"); //Add the LT Access key
// Set URL of the application under test
caps.AddAdditionalCapability("app", "###########"); //Add the App ID
// Specify device and os_version
caps.AddAdditionalCapability("deviceName", "Galaxy S21 Ultra 5G"); //Add the Device Details
caps.AddAdditionalCapability("platformVersion", "11");
caps.AddAdditionalCapability("platformName", "Android");
caps.AddAdditionalCapability("isRealMobile", true);
caps.AddAdditionalCapability("network", false);
caps.AddAdditionalCapability("w3c", true);
caps.AddAdditionalCapability("visual", true);
caps.AddAdditionalCapability("video", true);
caps.AddAdditionalCapability("project", "CSharp Sample Android");
caps.AddAdditionalCapability("build", "CSharp Sample Android");
caps.AddAdditionalCapability("name", "CSharp Sample Android");
// Initialize the remote Webdriver using LambdaTest remote URL
// and desired capabilities defined above
AndroidDriver < AndroidElement > driver = new AndroidDriver < AndroidElement > (
new Uri("https://mobile-hub.lambdatest.com/wd/hub"), caps);
// Test case for the sample Android app.
// If you have uploaded your app, update the test case here.
AndroidElement color = (AndroidElement) new WebDriverWait(driver, TimeSpan.FromSeconds(30)).Until(
SeleniumExtras.WaitHelpers.ExpectedConditions.ElementToBeClickable(MobileBy.Id("color"))
);
color.Click();
color.Click();
AndroidElement text = (AndroidElement) new WebDriverWait(driver, TimeSpan.FromSeconds(30)).Until(
SeleniumExtras.WaitHelpers.ExpectedConditions.ElementToBeClickable(MobileBy.Id("Text"))
);
text.Click();
AndroidElement toast = (AndroidElement) new WebDriverWait(driver, TimeSpan.FromSeconds(30)).Until(
SeleniumExtras.WaitHelpers.ExpectedConditions.ElementToBeClickable(MobileBy.Id("toast"))
);
toast.Click();
AndroidElement nf = (AndroidElement) new WebDriverWait(driver, TimeSpan.FromSeconds(30)).Until(
SeleniumExtras.WaitHelpers.ExpectedConditions.ElementToBeClickable(MobileBy.Id("notification"))
);
nf.Click();
AndroidElement gl = (AndroidElement) new WebDriverWait(driver, TimeSpan.FromSeconds(30)).Until(
SeleniumExtras.WaitHelpers.ExpectedConditions.ElementToBeClickable(MobileBy.Id("geoLocation"))
);
gl.Click();
Thread.Sleep(5000);
driver.Navigate().Back();
AndroidElement st = (AndroidElement) new WebDriverWait(driver, TimeSpan.FromSeconds(30)).Until(
SeleniumExtras.WaitHelpers.ExpectedConditions.ElementToBeClickable(MobileBy.Id("speedTest"))
);
st.Click();
Thread.Sleep(5000);
driver.Navigate().Back();
Configure the test capabilities
You can update your custom capabilities in test scripts. In this sample project, we are passing platform name, platform version, device name and app url (generated earlier) along with other capabilities like build name and test name via capabilities object. The capabilities object in the sample code are defined as:
- iOS
- Android
AppiumOptions caps = new AppiumOptions();
caps.AddAdditionalCapability("LT_USERNAME", "username");
caps.AddAdditionalCapability("LT_ACCESSKEY", "accessKey");
caps.setCapability("platformName", "iOS");
caps.setCapability("deviceName", "iPhone 13 Pro");
caps.setCapability("isRealMobile", true);
caps.setCapability("platformVersion","15.0");
caps.setCapability("Visual", true);
caps.setCapability("Console", true);
caps.setCapability("Network", false);
AppiumOptions caps = new AppiumOptions();
caps.AddAdditionalCapability("LT_USERNAME", "username");
caps.AddAdditionalCapability("LT_ACCESSKEY", "accessKey");
caps.setCapability("platformName", "Android");
caps.setCapability("deviceName", "Galaxy S20");
caps.setCapability("isRealMobile", true);
caps.setCapability("platformVersion","11");
caps.setCapability("Visual", true);
caps.setCapability("Console", true);
caps.setCapability("Network", false);
- You must add the generated APP_URL to the
"app"
capability in the config file. - You can generate capabilities for your test requirements with the help of our inbuilt Capabilities Generator tool. For more details, please refer to our guide on Desired Capabilities in Appium.
5. Execute your test case
Click the Play icon to run the test.
Your test results would be displayed on the test console (or command-line interface if you are using terminal/cmd) and on the 🔗 LambdaTest App Automation Dashboard.