bayandin/Winium.StoreApps

English description | Описание на русском

Winium for Store Apps


Winium.Mobile is an open source test automation tool for both Windows StoreApps and Windows Silverlight apps tested on Windows Phone or Windows Mobile emulators.

Supported Platforms

• StoreApps and Silverlight
• Windows Phone 8.1
• Windows 10 Mobile

For Windows Desktop (WPF, WinForms) test automation tool see Winium Desktop.

Why Winium?

You have Selenium WebDriver for testing of web apps, Appium for testing of iOS and Android apps. And now you have Selenium-based tools for testing of Windows apps too. What are some of the benefits? As said by Appium:

• You can write tests with your favorite dev tools using any WebDriver-compatible language such as Java, Objective-C, JavaScript with Node.js (in promise, callback or generator flavors), PHP, Python, Ruby, C#, Clojure, or Perl with the Selenium WebDriver API and language-specific client libraries.
• You can use any testing framework.

Requirements

• Windows 8 or higher
• Visual Studio 2013 with Update 2 or higher
• Windows phone 8.1 SDK and/or Windows 10 SDK

You can get Visual Studio and SDK from Microsoft here.

Quick Start

App under test (AUT) is application that you would like to test.

1. Add reference to either Winium.StoreApps.InnerServer or Winium.Silverlight.InnerServer in AUT project (install Winium.StoreApps.InnerServer NuGet package / install Winium.Silverlight.InnerServer NuGet package or build project yourself)

2. In your AUT's source code add following lines to be called on UI thread after visual root is initialized (usually in MainPageOnLoaded for vanilla app or PrepareApplication if you use Caliburn.Micro)

   // For StoreApps
   AutomationServer.Instance.InitializeAndStart();
   
   // For Silverlight apps
   AutomationServer.Instance.InitializeAndStart(RootFrame);
   

   or (will include driver only for debug build)

   #if DEBUG
   	// For StoreApps
   	AutomationServer.Instance.InitializeAndStart();
   
   	// For Silverlight apps
   	AutomationServer.Instance.InitializeAndStart(RootFrame);
   #endif // DEBUG
   

3. Assure that Internet (Client & Server) capability is enabled in package manifest of your AUT. It should be enabled by default for Windows 8.1 apps. In UWP (Windows Mobile 10) it is disabled by default (only Internet (Client) is enabled).

4. Write your tests using you favorite language. In your tests use app desired capability to set path to tested app's appx/xap file. Here is python example:

   # put it in setUp
   app_path = 'C:\\path\\to\\testApp.appx' # For StoreApps
   app_path = 'C:\\path\\to\\testApp.xap' # For Silverlight apps
   self.driver = webdriver.Remote(
   	command_executor='http://localhost:9999',
   	desired_capabilities={'app': app_path}
   )
   # put it in test method body
   element = self.driver.find_element_by_id('SetButton')
   element.click()
   assert 'CARAMBA' == self.driver.find_element_by_id('MyTextBox').text
   

   Make sure to set deviceName capability to Emulator to run on Windows Phone 8.1 if you are using the driver on a system where Visula Studio 2015 or Winodws 10 SDK is installed.

5. Start Winium.Mobile.Driver.exe (download release from github or build it yourself)

6. Run your tests and watch the magic happening

Writing tests

Essentially, Winium.Mobile supports limited subset of WebDriver JSON Wire Protocol, which means that you can write tests just like you would write for Selenium or Appium, here are some docs. For test samples look at our functional tests or test samples page.

Winium.Mobile vs Winium.StoreApps.CodedUi

Winium.Mobile vs Winium.StoreApps.CodedUi

How it works

Winium.Mobile consists of two essential parts:

1. Winium.Mobile.Driver implements Selenium Remote WebDriver and listens for JsonWireProtocol commands. It is responsible for launching emulator, deploying AUT, simulating input, forwarding commands to Winium.StoreApps.InnerServer, etc.

2. Winium.StoreApps.InnerServer / Winium.Silverlight.InnerServer (the one that should be embedded into AUT) communicates with Winium.Mobile.Driver.exe and executes different commands, like finding elements, getting or setting text values, properties, etc., inside your application.

Contributing

Contributions are welcome!

1. Check for open issues or open a fresh issue to start a discussion around a feature idea or a bug.
2. Fork the repository to start making your changes to the master branch (or branch off of it).
3. We recommend to write a test which shows that the bug was fixed or that the feature works as expected.
4. Send a pull request and bug the maintainer until it gets merged and published. :smiley:

Contact

Have some questions? Found a bug? Create new issue or contact us at [email protected]

License

Winium is released under the MPL 2.0 license. See LICENSE for details.