You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@cordova.apache.org by alsorokin <gi...@git.apache.org> on 2016/04/19 18:49:43 UTC
[GitHub] cordova-medic pull request: CB-11112 Added Appium documentation
GitHub user alsorokin opened a pull request:
https://github.com/apache/cordova-medic/pull/93
CB-11112 Added Appium documentation
https://issues.apache.org/jira/browse/CB-11112
You can merge this pull request into a Git repository by running:
$ git pull https://github.com/MSOpenTech/cordova-medic CB-11112
Alternatively you can review and apply these changes as the patch at:
https://github.com/apache/cordova-medic/pull/93.patch
To close this pull request, make a commit to your master/trunk branch
with (at least) the following in the commit message:
This closes #93
----
commit 2bbf2cd20983abd002f49434e6df1a1b0f6fc52d
Author: Alexander Sorokin <al...@akvelon.com>
Date: 2016-04-19T16:46:13Z
CB-11112 Added Appium documentation
----
---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@cordova.apache.org
For additional commands, e-mail: dev-help@cordova.apache.org
[GitHub] cordova-medic pull request: CB-11112 Added Appium documentation
Posted by alsorokin <gi...@git.apache.org>.
Github user alsorokin commented on a diff in the pull request:
https://github.com/apache/cordova-medic/pull/93#discussion_r60443408
--- Diff: APPIUM.md ---
@@ -58,7 +71,17 @@ Command sample to run tests on the "iPhone 6" simulator with iOS 8.4:
> node cordova-medic/medic/medic.js appium --app test-app --platform ios --deviceName "iPhone 6" --platformVersion 8.4 --plugins "cordova-plugin-camera cordova-plugin-contacts"
```
+When running on real iOS device, please make sure that it is located in the same network with the machine you're launching tests from and that the `UI Automation` option is enabled in `Settings -> Developer` menu.
+Please note the `--device` argument which tells Appium that we want to run the tests on a real device. You also need to specify a device UDID here.
+
+Command sample to run tests on the real iPad 2 with iOS 8.1:
+
+``` shell
+ > node cordova-medic/medic/medic.js appium --app test-app --platform ios --deviceName "iPad 2" --platformVersion 8.1 --plugins "cordova-plugin-camera cordova-plugin-contacts" --device --udid <device UDID>
+```
+
[appium_docs]: https://github.com/appium/appium/blob/master/docs/en/advanced-concepts/ios-webkit-debug-proxy.md
[brew]: http://brew.sh/
[plugin_camera]: https://github.com/apache/cordova-plugin-camera
[plugin_contacts]: https://github.com/apache/cordova-plugin-contacts
+[appium_docs]: http://appium.io/getting-started.html
--- End diff --
Nice catch. Fixed
---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@cordova.apache.org
For additional commands, e-mail: dev-help@cordova.apache.org
[GitHub] cordova-medic pull request: CB-11112 Added Appium documentation
Posted by riknoll <gi...@git.apache.org>.
Github user riknoll commented on the pull request:
https://github.com/apache/cordova-medic/pull/93#issuecomment-212523226
LGTM
---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@cordova.apache.org
For additional commands, e-mail: dev-help@cordova.apache.org
[GitHub] cordova-medic pull request: CB-11112 Added Appium documentation
Posted by alsorokin <gi...@git.apache.org>.
Github user alsorokin commented on a diff in the pull request:
https://github.com/apache/cordova-medic/pull/93#discussion_r60378697
--- Diff: APPIUM.md ---
@@ -0,0 +1,64 @@
+Cordova Medic Appium Runner
+===========================
+
+This document describes a method to run Cordova Appium tests without full-blown CI setup with [Camera][plugin_camera] and [Contacts][plugin_contacts] plugins taken as an example.
+Appium tests can be ran on Android and iOS.
+
+## Setup
+
+Clone medic repository by running
+
+``` shell
+ > git clone https://github.com/apache/cordova-medic
+```
+
+You will need an app to test, so create it and add the platform and the plugins:
+
+``` shell
+ > cordova create test-app
+ > cd test-app
+ > cordova platform add <android or ios>
+ > cordova plugin add cordova-plugin-camera cordova-plugin-contacts
+```
+
+### Running on Android
+
+Cordova Appium tests for Android can be ran on either real device or an emulator. If you're running tests on the emulator you will need to launch it manually before the test run. Please also note that Appium tests are written with Android API 19 (KitKat) and 21 (Lollipop) in mind. They're not yet tested on higher versions of Android OS.
+
--- End diff --
Thanks a lot for this. I clearly need to practice English more.
---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@cordova.apache.org
For additional commands, e-mail: dev-help@cordova.apache.org
[GitHub] cordova-medic pull request: CB-11112 Added Appium documentation
Posted by alsorokin <gi...@git.apache.org>.
Github user alsorokin commented on the pull request:
https://github.com/apache/cordova-medic/pull/93#issuecomment-212523371
Thanks guys. Merging
---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@cordova.apache.org
For additional commands, e-mail: dev-help@cordova.apache.org
[GitHub] cordova-medic pull request: CB-11112 Added Appium documentation
Posted by alsorokin <gi...@git.apache.org>.
Github user alsorokin commented on the pull request:
https://github.com/apache/cordova-medic/pull/93#issuecomment-212375911
@riknoll @rakatyal Addressed review notes, please see https://github.com/apache/cordova-medic/pull/93/commits/0e7ff36d9a53d72e361eb86574a224f904e535e6
---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@cordova.apache.org
For additional commands, e-mail: dev-help@cordova.apache.org
[GitHub] cordova-medic pull request: CB-11112 Added Appium documentation
Posted by rakatyal <gi...@git.apache.org>.
Github user rakatyal commented on a diff in the pull request:
https://github.com/apache/cordova-medic/pull/93#discussion_r60442607
--- Diff: APPIUM.md ---
@@ -58,7 +71,17 @@ Command sample to run tests on the "iPhone 6" simulator with iOS 8.4:
> node cordova-medic/medic/medic.js appium --app test-app --platform ios --deviceName "iPhone 6" --platformVersion 8.4 --plugins "cordova-plugin-camera cordova-plugin-contacts"
```
+When running on real iOS device, please make sure that it is located in the same network with the machine you're launching tests from and that the `UI Automation` option is enabled in `Settings -> Developer` menu.
+Please note the `--device` argument which tells Appium that we want to run the tests on a real device. You also need to specify a device UDID here.
+
+Command sample to run tests on the real iPad 2 with iOS 8.1:
+
+``` shell
+ > node cordova-medic/medic/medic.js appium --app test-app --platform ios --deviceName "iPad 2" --platformVersion 8.1 --plugins "cordova-plugin-camera cordova-plugin-contacts" --device --udid <device UDID>
+```
+
[appium_docs]: https://github.com/appium/appium/blob/master/docs/en/advanced-concepts/ios-webkit-debug-proxy.md
[brew]: http://brew.sh/
[plugin_camera]: https://github.com/apache/cordova-plugin-camera
[plugin_contacts]: https://github.com/apache/cordova-plugin-contacts
+[appium_docs]: http://appium.io/getting-started.html
--- End diff --
There is already [appium_docs] defined so consider renaming it. Also you may directly point it to 'http://appium.io/getting-started.html#requirements'.
---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@cordova.apache.org
For additional commands, e-mail: dev-help@cordova.apache.org
[GitHub] cordova-medic pull request: CB-11112 Added Appium documentation
Posted by asfgit <gi...@git.apache.org>.
Github user asfgit closed the pull request at:
https://github.com/apache/cordova-medic/pull/93
---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@cordova.apache.org
For additional commands, e-mail: dev-help@cordova.apache.org
[GitHub] cordova-medic pull request: CB-11112 Added Appium documentation
Posted by riknoll <gi...@git.apache.org>.
Github user riknoll commented on the pull request:
https://github.com/apache/cordova-medic/pull/93#issuecomment-212168418
Very helpful guide! I was able to get the tests running on my machine (for Android, didn't try iOS). One thing to note is that it seems like the tests are very dependent on the apps installed on the device running them and it might be helpful to document that. For example, the tests for camera that use PHOTOLIBRARY as a source do not work with the gallery app that comes with the VS Android emulator (they just time out).
---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@cordova.apache.org
For additional commands, e-mail: dev-help@cordova.apache.org
[GitHub] cordova-medic pull request: CB-11112 Added Appium documentation
Posted by rakatyal <gi...@git.apache.org>.
Github user rakatyal commented on a diff in the pull request:
https://github.com/apache/cordova-medic/pull/93#discussion_r60278921
--- Diff: APPIUM.md ---
@@ -0,0 +1,64 @@
+Cordova Medic Appium Runner
+===========================
+
+This document describes a method to run Cordova Appium tests without full-blown CI setup with [Camera][plugin_camera] and [Contacts][plugin_contacts] plugins taken as an example.
+Appium tests can be ran on Android and iOS.
+
+## Setup
+
+Clone medic repository by running
+
+``` shell
+ > git clone https://github.com/apache/cordova-medic
+```
+
+You will need an app to test, so create it and add the platform and the plugins:
+
+``` shell
+ > cordova create test-app
+ > cd test-app
+ > cordova platform add <android or ios>
+ > cordova plugin add cordova-plugin-camera cordova-plugin-contacts
+```
+
+### Running on Android
+
+Cordova Appium tests for Android can be ran on either real device or an emulator. If you're running tests on the emulator you will need to launch it manually before the test run. Please also note that Appium tests are written with Android API 19 (KitKat) and 21 (Lollipop) in mind. They're not yet tested on higher versions of Android OS.
+
+``` shell
+ > emulator -avd <avd name, for example, api19>
+```
+
+Now you're ready to run the tests. Command sample to run the tests on the emulator with the name "api19" and API level 19:
+
+``` shell
+ > node cordova-medic/medic/medic.js appium --app test-app --platform android --deviceName api19 --platformVersion 19 --plugins "cordova-plugin-camera cordova-plugin-contacts"
+```
+
+### Running on iOS
+
+You can run Cordova Appium tests for iOS on either real device or a simulator.
+
+To run Appium tests on real iOS device you may need to install `ios-webkit-debug-proxy`. If you don't have Homebrew installed, please install it according to the [Homebrew docs][brew].
+
+When you've got Homebrew installed, just run the following commands:
+
+ ``` shell
+ > brew update
+ > brew install ios-webkit-debug-proxy
+ ```
+
+More info on installing `ios-webkit-debug-proxy` can be found in [Appium docs][appium_docs].
+
+If running on simulator, no need to launch it manually - Appium will do it automatically.
+
+Command sample to run tests on the "iPhone 6" simulator with iOS 8.4:
--- End diff --
Should we include an example to run it on a device for android/ios?
---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@cordova.apache.org
For additional commands, e-mail: dev-help@cordova.apache.org
[GitHub] cordova-medic pull request: CB-11112 Added Appium documentation
Posted by riknoll <gi...@git.apache.org>.
Github user riknoll commented on a diff in the pull request:
https://github.com/apache/cordova-medic/pull/93#discussion_r60287104
--- Diff: APPIUM.md ---
@@ -0,0 +1,64 @@
+Cordova Medic Appium Runner
+===========================
+
+This document describes a method to run Cordova Appium tests without full-blown CI setup with [Camera][plugin_camera] and [Contacts][plugin_contacts] plugins taken as an example.
+Appium tests can be ran on Android and iOS.
+
+## Setup
+
+Clone medic repository by running
+
+``` shell
+ > git clone https://github.com/apache/cordova-medic
--- End diff --
You also need to run `npm install` in the repo
---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@cordova.apache.org
For additional commands, e-mail: dev-help@cordova.apache.org
[GitHub] cordova-medic pull request: CB-11112 Added Appium documentation
Posted by rakatyal <gi...@git.apache.org>.
Github user rakatyal commented on a diff in the pull request:
https://github.com/apache/cordova-medic/pull/93#discussion_r60279661
--- Diff: APPIUM.md ---
@@ -0,0 +1,64 @@
+Cordova Medic Appium Runner
+===========================
+
+This document describes a method to run Cordova Appium tests without full-blown CI setup with [Camera][plugin_camera] and [Contacts][plugin_contacts] plugins taken as an example.
+Appium tests can be ran on Android and iOS.
+
+## Setup
+
+Clone medic repository by running
+
+``` shell
+ > git clone https://github.com/apache/cordova-medic
+```
+
+You will need an app to test, so create it and add the platform and the plugins:
+
+``` shell
+ > cordova create test-app
+ > cd test-app
+ > cordova platform add <android or ios>
+ > cordova plugin add cordova-plugin-camera cordova-plugin-contacts
+```
+
+### Running on Android
+
+Cordova Appium tests for Android can be ran on either real device or an emulator. If you're running tests on the emulator you will need to launch it manually before the test run. Please also note that Appium tests are written with Android API 19 (KitKat) and 21 (Lollipop) in mind. They're not yet tested on higher versions of Android OS.
--- End diff --
Are there any OS/software requirements to run Appium tests? Like min OSX version/Xcode version or something?
---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@cordova.apache.org
For additional commands, e-mail: dev-help@cordova.apache.org
[GitHub] cordova-medic pull request: CB-11112 Added Appium documentation
Posted by rakatyal <gi...@git.apache.org>.
Github user rakatyal commented on the pull request:
https://github.com/apache/cordova-medic/pull/93#issuecomment-212504995
LGTM.
---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@cordova.apache.org
For additional commands, e-mail: dev-help@cordova.apache.org
[GitHub] cordova-medic pull request: CB-11112 Added Appium documentation
Posted by riknoll <gi...@git.apache.org>.
Github user riknoll commented on a diff in the pull request:
https://github.com/apache/cordova-medic/pull/93#discussion_r60279829
--- Diff: APPIUM.md ---
@@ -0,0 +1,64 @@
+Cordova Medic Appium Runner
+===========================
+
+This document describes a method to run Cordova Appium tests without full-blown CI setup with [Camera][plugin_camera] and [Contacts][plugin_contacts] plugins taken as an example.
+Appium tests can be ran on Android and iOS.
+
+## Setup
+
+Clone medic repository by running
+
+``` shell
+ > git clone https://github.com/apache/cordova-medic
+```
+
+You will need an app to test, so create it and add the platform and the plugins:
+
+``` shell
+ > cordova create test-app
+ > cd test-app
+ > cordova platform add <android or ios>
+ > cordova plugin add cordova-plugin-camera cordova-plugin-contacts
+```
+
+### Running on Android
+
+Cordova Appium tests for Android can be ran on either real device or an emulator. If you're running tests on the emulator you will need to launch it manually before the test run. Please also note that Appium tests are written with Android API 19 (KitKat) and 21 (Lollipop) in mind. They're not yet tested on higher versions of Android OS.
+
--- End diff --
Grammar nitpick:
Cordova Appium tests for Android can be *run* on either *a* real device or an emulator.
*They* have not yet *been* tested on higher versions of Android
---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@cordova.apache.org
For additional commands, e-mail: dev-help@cordova.apache.org
[GitHub] cordova-medic pull request: CB-11112 Added Appium documentation
Posted by rakatyal <gi...@git.apache.org>.
Github user rakatyal commented on the pull request:
https://github.com/apache/cordova-medic/pull/93#issuecomment-212044839
Minor comments. Otherwise LGTM.
---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@cordova.apache.org
For additional commands, e-mail: dev-help@cordova.apache.org