update the windows setup instructions to make them more simple (fix #6751)

This commit is contained in:
Jonathan Lipps
2016-10-06 16:38:02 -07:00
parent 1905d14747
commit 9ef89e04c6
2 changed files with 25 additions and 27 deletions
+17 -26
View File
@@ -11,43 +11,34 @@ See [Windows App Testing](/docs/en/writing-running-appium/windows-app-testing.md
To get started:
1. Download latest [node and npm tools](https://nodejs.org/download/release/v6.3.0/node-v6.3.0-x64.msi) MSI (version >= 6.0). The `npm` and `nodejs` paths should be in your PATH environment variable.
2. Download latest Java JDK [here](http://www.oracle.com/technetwork/java/javase/downloads/jdk8-downloads-2133151.html) (accept the license agreement first). Set 'JAVA_HOME' to be your JDK path. The `bin` in that directory should be added to your PATH variable.
3. Install the [Android SDK](http://developer.android.com/sdk/index.html). Set `ANDROID_HOME` to be
your Android SDK path and add the `tools` and `platform-tools` folders to your
PATH variable.
4. Install [Apache Ant](http://ant.apache.org/bindownload.cgi) or use the one that comes with the Android Windows SDK in the eclipse\plugins folder. Be sure to add the folder containing Ant to your PATH variable.
5. Install [Apache Maven](http://maven.apache.org/download.cgi) and set the M2HOME and M2 environment variables. Set `M2_HOME` to the directory maven is installed in, and set `M2` to the `bin` in that directory. Add the path you used for `M2` to your PATH.
6. Open admin cmd
7. run command: npm install -g appium
8. run command: appium
9. Run a test from any Appium client (including Visual Studio)
2. Open admin cmd prompt
3. Run the command `npm install -g appium` which will install Appium from NPM
4. To start Appium, you can now simply run `appium` from the prompt.
5. Follow the directions below for setup for either Android or Windows app testing.
6. Run a test from any Appium client.
## Additional Setup for Android App Testing
1. To run tests on Windows, you will need to have the Android Emulator booted or an Android Device connected that is running an AVD with API Level 17 or greater. Then run Appium on the command line (via the `appium` command)
2. Within test script, change value of 'platformVersion' to correspond with emulator version (i.e. '4.4.4')
3. Within test script, change value of 'app' to PATH('path of .apk') and ensure the entire path (including close parenthesis) is on one line
1. Download the latest Java JDK [here](http://www.oracle.com/technetwork/java/javase/downloads/jdk8-downloads-2133151.html) (accept the license agreement first). Set 'JAVA_HOME' to be your JDK path. The `bin` in that directory should be added to your PATH variable.
2. Install the [Android SDK](http://developer.android.com/sdk/index.html). Set the `ANDROID_HOME` environment variable to be your Android SDK path and add the `tools` and `platform-tools` folders to your PATH variable.
3. Install [Apache Ant](http://ant.apache.org/bindownload.cgi) or use the one that comes with the Android Windows SDK in the eclipse\plugins folder. Be sure to add the folder containing Ant to your PATH variable.
4. Install [Apache Maven](http://maven.apache.org/download.cgi) and set the M2HOME and M2 environment variables. Set `M2_HOME` to the directory maven is installed in, and set `M2` to the `bin` in that directory. Add the path you used for `M2` to your PATH.
5. To run tests on Windows, you will need to have the Android Emulator booted or an Android Device connected that is running an AVD with API Level 17 or greater. Then run Appium on the command line (via the `appium` command)
6. Your test script should ensure that the `platformVersion` capability corresponds to the emulator or device version you are testing, and that the `app` capability is an absolute path to the .apk file of the Android app.
## Additional Setup for Windows App Testing
1. To test a Windows app, make sure you have turned [developer mode](https://msdn.microsoft.com/en-us/windows/uwp/get-started/enable-your-device-for-development) on.
1. To test a Windows app, simply make sure you have turned [developer mode](https://msdn.microsoft.com/en-us/windows/uwp/get-started/enable-your-device-for-development) on.
(see the [Windows app testing](/docs/en/writing-running-appium/windows-app-testing.md) doc for instructions on how to run Windows app tests)
## Running Appium
See the [server documentation](/docs/en/writing-running-appium/server-args.md) for all the command line
arguments.
See the [server documentation](/docs/en/writing-running-appium/server-args.md) for all the command line arguments.
## Notes
- URL endpoint has to append "/wd/hub"
- DesiredCapabilities:
- platformName = "Windows"
- deviceName = "WindowsPC"
* On windows run appium.app as administrator or when running from source you need to run cmd as administrator.
* On Windows run Appium.exe as an administrator, or when running from source you need to run cmd as an administrator.
* You must supply the `--no-reset` or `--full-reset` flags for
Android to work on Windows.
* There exists a hardware accelerated emulator for Android, it has it's own
* There exists a hardware accelerated emulator for Android; it has it's own
limitations. For more information you can check out this
[page](/docs/en/appium-setup/android-hax-emulator.md).
* Make sure that `hw.battery=yes` in your AVD's `config.ini`.
@@ -8,7 +8,7 @@ Windows specific UI testing on Appium is powered by [WinAppDriver] (https://gith
## C# Samples
1. Pull and open `CalculatorTest.sln` under [CalculatorTest](https://github.com/Microsoft/WinAppDriver/tree/master/Samples/C%23/CalculatorTest)
2. In Visual Studio 2015 with the test solution open build the test and select **Test > Run > All Tests**
## Features
Windows Application Driver supports testing **Universal Windows Platform (UWP)** and **Classic Windows (Win32)** apps on **Windows 10 PC**
@@ -42,6 +42,13 @@ NotepadSession = new IOSDriver<IOSElement>(new Uri("http://127.0.0.1:4723"), app
// Control the AlarmClock app
NotepadSession.FindElementByClassName("Edit").SendKeys("This is some text");
```
### Starting a Session
Note that you should additionally use these capabilities to ensure you are getting a Windows App automation session:
`platformName`: `Windows`
`deviceName`: `WindowsPC`
### Inspecting UI Elements
Microsoft Visual Studio 2015 by default includes Windows SDK that provides 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 such as `C:\Program Files (x86)\Windows Kits\10\bin\x86`