{"id":9458,"date":"2022-09-05T18:51:04","date_gmt":"2022-09-05T18:51:04","guid":{"rendered":"http:\/\/putridparrot.com\/blog\/?p=9458"},"modified":"2022-09-05T18:51:04","modified_gmt":"2022-09-05T18:51:04","slug":"appium-android-and-maui","status":"publish","type":"post","link":"https:\/\/putridparrot.com\/blog\/appium-android-and-maui\/","title":{"rendered":"Appium, Android and MAUI"},"content":{"rendered":"

Prerequisites<\/strong><\/p>\n

You’ll need Appium server (I’m using Appium Server UI<\/a>), I installed into my Windows c:\\tools\\Appium folder and next (whilst not a requirement but is very useful) grab the latest version of Appium Inspector<\/a> this will allows us to inspect elements within our running Android application, I unzipped this to c:\\tools\\AppiumInspector. <\/p>\n

Appium Server GUI has a button to run the inspector but, unless I’m missing something, this simply sends you to the GitHub repo for the inspector, so run the inspector yourself separately.<\/em><\/p>\n

Creating a simple app.<\/strong><\/p>\n

Create yourself a MAUI application (mine’s call MauiUIAutomationTest, so you’re see this listed in various places below, if you create your own name, remember to update in the code as well). <\/p>\n

Like my previous Appium test samples the code is simple (I’ll recreate here). The MainPage.xaml within the ContentPage looks like this<\/p>\n

\r\n<Grid>\r\n   <Grid.RowDefinitions>\r\n      <RowDefinition \/>\r\n      <RowDefinition \/>\r\n      <RowDefinition \/>\r\n   <\/Grid.RowDefinitions>\r\n\r\n   <Entry Grid.Row="0" AutomationId="input" Margin="10" Text="{Binding Input}" \/>\r\n   <Button Grid.Row="1" AutomationId="copy" Margin="10" Command="{Binding ProcessCommand}" Text="Copy" \/>\r\n   <Label Grid.Row="2" AutomationId="output" Margin="10" Text="{Binding Output}"\/>\r\n<\/Grid>\r\n<\/pre>\n
I’m using MVVM Community Toolkit and so MainPageViewModel.cs is simply this<\/p>\n
\r\npublic partial class MainPageViewModel : ObservableObject\r\n{\r\n    [ObservableProperty] private string input;\r\n    [ObservableProperty] private string output;\r\n\r\n    [RelayCommand]\r\n    private void Process()\r\n    {\r\n       Output = Input;\r\n    }\r\n}\r\n<\/pre>\n
Creating our test code<\/strong><\/p>\n
I’ve created an NUnit test class library and added the NuGet package Appium.WebDriver (yes I know it’s an app. but that’s the NuGet package we need). If you’re creating your unit test class library from scratch you’ll need NUnit and NUnit3TestAdapter installed as dependencies as well).<\/p>\n
Now my first unit test is, as follows<\/p>\n
\r\npublic class Tests\r\n{\r\n    private AndroidDriver<AndroidElement> _driver;\r\n\r\n    [SetUp]\r\n    public void Setup()\r\n    {\r\n        var driverOptions = new AppiumOptions();\r\n        driverOptions.AddAdditionalCapability(MobileCapabilityType.PlatformName, "Android");\r\n        driverOptions.AddAdditionalCapability(MobileCapabilityType.AutomationName, "UiAutomator2"); \r\n        driverOptions.AddAdditionalCapability(MobileCapabilityType.DeviceName, "Pixel_3_XL_API_29");\r\n\r\n        _driver = new AndroidDriver<AndroidElement>(new Uri("http:\/\/localhost:4723\/wd\/hub"), driverOptions); \r\n        _driver.ActivateApp("com.companyname.mauiuiautomationtest");\r\n    }\r\n\r\n    [TearDown]\r\n    public void TearDown()\r\n    {\r\n        _driver.Quit();\r\n    }\r\n\r\n    [Test]\r\n    public void ChangeInput_ThenCopy_ExpectMatchingOutput()\r\n    {\r\n        var entry = _driver.FindElementById("com.companyname.mauiuiautomationtest:id\/input666");\r\n        entry.Clear();\r\n        entry.SendKeys("Hello World");\r\n        var button = _driver.FindElementById("com.companyname.mauiuiautomationtest:id\/copy666");\r\n        button.Click();\r\n        var label = _driver.FindElementById("com.companyname.mauiuiautomationtest:id\/output666");\r\n        Assert.That(label.Text, Is.EqualTo("Hello World"));\r\n    }\r\n}\r\n<\/pre>\n
Obviously this is not perfect as we’re running the setup and tear down code after every test, but as I only have one test, I don’t care (it’s for the reader to do this correctly). Now we setup the driver options, the platformName is ofcourse Android, the deviceName relates to the device you’re using, I’m using the Android emulator for the Pixel 3 API 29, finally automationName specifies the automation engine to use, to be honest you could remove this and it’ll default the standard Appium engine but UiAutomator2<\/a> is listed as Appiums flagship engine, so let’s use that.<\/p>\n
I had all sorts of issues trying to get Appium to start my MAUI app (as it will try to install it), however I think this is likely down to the way Visual Studio builds the apk, i.e. I probably need to publish a signed apk or the likes, but for now I’ll let Visual Studio deploy the app and then access it via Appium. Hence we have the following code to active an already installed app.<\/p>\n
 \r\n_driver.ActivateApp("com.companyname.mauiuiautomationtest");\r\n<\/pre>\n
Eager to see something working?<\/strong><\/p>\n
If you’re eager to see something working, then <\/p>\n
    \n
  • Deploy your application to your Android emulator (I just get Visual Studio to deploy it)<\/li>\n
  • Run the Appium Server GUI and start a new session<\/li>\n
  • Run your unit test<\/li>\n<\/ul>\n
    If all went well the test was green and if not, check your application name etc. <\/p>\n
    Appium Inspector<\/strong><\/p>\n
    The Appium server does not come with an inspector now, you need to download it separately (as stated earlier). Ofcourse we can probably get a lot done without an inspector, but it helps and gives confidence that if it see’s our id’s etc. then Appium will. You’ll need to tell the inspector to connect to the Appium server – make sure that Remote Path has the URL \/wd\/hub<\/em> and you have valid the following Desired Capabilities<\/p>\n
    \r\n{\r\n  "appium:automationName": "UIAutomator2",\r\n  "appium:deviceName": "Pixel_3_XL_API_29",\r\n  "platformName": "Android"\r\n}\r\n<\/pre>\n
    Ensure your have Appium server is running. Before you run the inspector just make sure your app. is running (just makes things simpler) and now start a session from your Appium Inspector. It should show you the screen of the current running application.<\/p>\n
    As you can see from the code below, we expect a “copy” automation id<\/p>\n
    \r\n<Button Grid.Row="1" AutomationId="copy" Margin="10" Command="{Binding ProcessCommand}" Text="Copy" \/>\r\n<\/pre>\n
    MAUI AutomationId’s do not appear as AutomationId or Accessibility Id for that matter, but instead they become id’s but prefixed with you app name, i.e. that’s why our unit tests has com.companyname.mauiuiautomationtest:id\/output<\/em>. All that really matters is that we have a unique value on an Appium accessible property to do some UI Automation testing. We do have the option of XPath locators, but these should probably be used as a the last resort, if we do not have anything else to locate against. <\/p>\n","protected":false},"excerpt":{"rendered":"
    Prerequisites You’ll need Appium server (I’m using Appium Server UI), I installed into my Windows c:\\tools\\Appium folder and next (whilst not a requirement but is very useful) grab the latest version of Appium Inspector this will allows us to inspect elements within our running Android application, I unzipped this to c:\\tools\\AppiumInspector. Appium Server GUI has […]<\/p>\n","protected":false},"author":1,"featured_media":0,"comment_status":"closed","ping_status":"open","sticky":false,"template":"","format":"standard","meta":{"_jetpack_memberships_contains_paid_content":false,"footnotes":""},"categories":[120,334,330],"tags":[],"class_list":["post-9458","post","type-post","status-publish","format-standard","hentry","category-android","category-appium","category-maui"],"jetpack_sharing_enabled":true,"jetpack_featured_media_url":"","_links":{"self":[{"href":"https:\/\/putridparrot.com\/blog\/wp-json\/wp\/v2\/posts\/9458","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/putridparrot.com\/blog\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/putridparrot.com\/blog\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/putridparrot.com\/blog\/wp-json\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/putridparrot.com\/blog\/wp-json\/wp\/v2\/comments?post=9458"}],"version-history":[{"count":5,"href":"https:\/\/putridparrot.com\/blog\/wp-json\/wp\/v2\/posts\/9458\/revisions"}],"predecessor-version":[{"id":9472,"href":"https:\/\/putridparrot.com\/blog\/wp-json\/wp\/v2\/posts\/9458\/revisions\/9472"}],"wp:attachment":[{"href":"https:\/\/putridparrot.com\/blog\/wp-json\/wp\/v2\/media?parent=9458"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/putridparrot.com\/blog\/wp-json\/wp\/v2\/categories?post=9458"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/putridparrot.com\/blog\/wp-json\/wp\/v2\/tags?post=9458"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}