https://github.com/applitools/winappdriver-examples
Applitools Code Examples for WinAppDriver
https://github.com/applitools/winappdriver-examples
Last synced: over 1 year ago
JSON representation
Applitools Code Examples for WinAppDriver
- Host: GitHub
- URL: https://github.com/applitools/winappdriver-examples
- Owner: applitools
- Created: 2017-08-31T20:34:58.000Z (almost 9 years ago)
- Default Branch: master
- Last Pushed: 2020-11-22T16:51:14.000Z (over 5 years ago)
- Last Synced: 2025-01-17T04:46:46.877Z (over 1 year ago)
- Size: 17.4 MB
- Stars: 1
- Watchers: 6
- Forks: 5
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# WinAppDriver-Examples
Applitools Code Examples for WinAppDriver
Windows Application Driver is a service to support Selenium-like UI Test Automation on Windows Applications. This service supports testing **Universal Windows Platform (UWP)** and **Classic Windows (Win32)** apps on **Windows 10 PCs**. Windows Application Driver complies to the [JSON Wire Protocol](https://github.com/SeleniumHQ/selenium/wiki/JsonWireProtocol) standard and some application management functionalities defined by **Appium**. If you've been looking for better support for using [Appium](http://appium.io) to test Windows Applications, then this service is for you!
## Getting Started
* More WinAppDriver information can be found [here](https://github.com/Microsoft/WinAppDriver) *
### System Requirements
- Windows 10 PC
- Any Appium test runner (Samples and Tests in this repository use Microsoft Visual Studio as the test runner)
### Installing and Running Windows Application Driver
1. Download Windows Application Driver installer from
2. Run the installer on a Windows 10 machine where your application under test is installed and will be tested
3. Run `WinAppDriver.exe` from the installation directory (E.g. `C:\Program Files (x86)\Windows Application Driver`)
Windows Application Driver will then be running on the test machine listening to requests on the default IP address and port (`127.0.0.1:4723`). You can then run any of our [Tests](/Tests/) or [Samples](/Samples). `WinAppDriver.exe` can be configured to listen to a different IP address and port as follows:
```
WinAppDriver.exe 4727
WinAppDriver.exe 10.0.0.10 4725
WinAppDriver.exe 10.0.0.10 4723/wd/hub
```
> **Note**: You must run `WinAppDriver.exe` as **administrator** to listen to a different IP address and port.
### Running on a Remote Machine
Windows Application Driver can run remotely on any Windows 10 machine with `WinAppDriver.exe` installed and running. This *test machine* can then serve any JSON wire protocol commands coming from the *test runner* remotely through the network. Below are the steps to the one time setup for the *test machine* to receive inbound requests:
1. On the *test machine* you want to run the test application on, open up **Windows Firewall with Advanced Security**
- Select **Inbound Rules** -> **New Rule...**
- **Rule Type** -> **Port**
- Select **TCP**
- Choose specific local port (4723 is WinAppDriver standard)
- **Action** -> **Allow the connection**
- **Profile** -> select all
- **Name** -> optional, choose name for rule (e.g. WinAppDriver remote)
2. Run `ipconfig.exe` to determine your machine's local IP address
> **Note**: Setting `*` as the IP address command line option will cause it to bind to all bound IP addresses on the machine
3. Run `WinAppDriver.exe` as **administrator** with command line arguments as seen above specifying local IP and port
4. On the *test runner* machine where the runner and scripts are, update the the test script to point to the IP of the remote *test machine*
5. Execute the test script on the *test runner* to perform the test actions against the test application on the remote *test machine*.
### Running the examples
* C# (Currently does not work)
1. Open `CalculatorTest.sln` in Visual Studio
2. Add your Applitools API key in ScenarioStandard.cs
3. Select **Test** > **Windows** > **Test Explorer**
4. Select **Run All** on the test pane or through menu **Test** > **Run** > **All Tests**
Once the project is successfully built, you can use the **TestExplorer** to pick and choose the test scenario(s) to run
* Java
1. Open WinAppDriver project in Eclipe or intelliJ
2. Build the project to download the maven dependencies.
3. Open WinAppDriver > src > test > java > CalculatorTest.java
4. Add your Applitools API key.
5. Right click and select run test.
* JavaScript (Currently does not work)
1. Open calculator.js in your favorite editor.
2. Add your applitools API key.
3. In terminal run: `node calculator.js`
* Python
1. Open calculator.py in your favorite editor.
2. Add your applitools key.
3. In terminal run: `python calculator.py`
* Ruby
1. Open calculator.rb in your favorite editor.
2. Add your applitools API Key.
3. In terminal run: `rspec calculator.rb`
## Inspecting UI Elements
The latest Microsoft Visual Studio version by default includes the Windows SDK with a great tool to inspect the application you are testing. This tool allows you to see every UI element/node that you can query using Windows Application Driver. This **inspect.exe** tool can be found under the Windows SDK folder which is typically `C:\Program Files (x86)\Windows Kits\10\bin\x86`
More detailed documentation on Inspect is available on MSDN <"https://msdn.microsoft.com/library/windows/desktop/dd318521(v=vs.85).aspx">.