release: cut the 5.0.0 release (#194)

Author: SvetoslavTsenov

CHANGELOG.md

@@ -1,3 +1,43 @@
+<a name="5.0.0"></a>
+# [5.0.0]() (2019-01-29)
+
+### Bug Fixes
+* isDisplayed already checks whether actual coordinates of an element are in visible viewport of display
+* resolve app name when starting of appium server is skipped
+* **locators** android webView locator is renamed to android.webkit.WebView
+
+### Features
+* run tests without providing appium capabilities config/ --runType. 
+  This option is only available for local runs which means that 
+  device should already be started and the app should already be installed.
+* device properties can be passed as regex expression (this is not available in sauceLab)
+* isSelected method - works only if the element has tag select
+* --runType parameter is already case insensitive e.g. sim.iOS == sim.ios
+* waitForElement method = searched for element by automation text and wait time in milliseconds.
+* include support for jasmine.
+* include support for javascript, typescript, angular, vue and angular(shared project)
+
+### BREAKING CHANGES
+
+* --reuseDevice options is removed. This is not concerning test which uses sauceLabs
+
+Before:
+```
+$ npm run e2e -- --runType android23 --reuseDevice
+```
+After there are a few options in order to preserve device alive:
+
+1. If you are developing your application with `tns run android/ ios`
+
+```
+$ npm run e2e android or ios
+```
+2. If you are running on CI, change appium options as
+    --fullReset: false -> this will keep device alive
+    --noReset: false -> this will install app on device
+
+
+
 <a name="4.0.6"></a>
 # [4.0.6]() (2018-08-08)
 ### Bug Fixes
@@ -62,10 +102,10 @@ Default automation was 'Appium' for all api levels.
 ```
 After:
 ```
-For all api levels higer or equal than api23 (including) default automator name is 'UiAutomator2'
+For all api levels higher or equal than api23 (including) default automator name is 'UiAutomator2'
 For all api levels lower than api23 default automator is still 'Appium'
 ```
-* rename DeviceController to DeviceManager - In general this should not affect any user except those that are using DeviceManager explicity
+* rename DeviceController to DeviceManager - In general this should not affect any user except those that are using DeviceManager explicitly
 * bump version of mocha to ~5.1.0 which requires flag --exit to be set in mocha config file when the tests are run ot Travis 
 ```
 

README.md

@@ -147,6 +147,13 @@ or
 $ npm run e2e -- --runType sim.iPhone8.iOS110
 ```
 
+or for local runs during development 
+```
+$ npm run e2e android
+$ npm run e2e ios
+$ npm run e2e -- --device.name=/iPhone X/ --device.apiLevel=/12.1/
+```
+
 Generated tests are standard [Mocha](http://mochajs.org) tests.
 
 ## Blogs
@@ -258,7 +265,6 @@ As you can see, the `app` property can be left an empty string which will force
 |---|---|---|
 |runType| Select the capabilities from your config file `appium.capabilities.json`| Consider using `android`, `device`, `sim` strings as part of your `runType` option if you haven't provided `app` capability. Thus, the runner will look for app package in the right location for the current run. <br/> e.g. --runType ios-device10iPhone6|
 |appPath| Provide location of the app package to be tested. This will overwrite all provided capabilities for app| Possible values are:<br/> - app build package name (in case `--sauceLab` option is set it will prepend `sauce-storage:` in front of the app name so app has to be [uploaded to Sauce Labs](https://wiki.saucelabs.com/display/DOCS/Uploading+Mobile+Applications+to+Sauce+Storage+for+Testing) before execution starts)<br/> - path e.g. `platforms/android/build/outputs/apk/demo.apk`.<br/> Example: --appPath demo-debug.apk|
-| reuseDevice | Reuse the device specified in the `runType` capabilities. If the emulator/simulator is not running, it will launch, execute tests and remain running. The next execution of `npm run e2e` with the `reuseDevice` option will attach to the already running emulator/simulator, execute tests and keep it running. | e.g. --reuseDevice |
 | devMode | `devMode` capabilities. Skipping application instalation and will automatically reuse device. | e.g. --devMode |
 |sauceLab| Enable tests execution in [Sauce Labs](https://saucelabs.com/). As a prerequisite you will have to define `SAUCE_USER` and `SAUCE_KEY` as [environment variable](https://wiki.saucelabs.com/display/DOCS/Best+Practice%3A+Use+Environment+Variables+for+Authentication+Credentials)| e.g. --sauceLab|
 |appiumCapsLocation| Change the location where `appium.capabilities.json` config file can be. It should be relative to the root directory | e.g. --appiumCapsLocation /e2e-tests|

lib/appium-driver.ts

@@ -438,7 +438,7 @@ export class AppiumDriver {
      * @param xOffset
      */
     public async scroll(direction: Direction, y: number, x: number, yOffset: number, xOffset: number = 0) {
-        scroll(this._wd, this._driver, direction, this._webio.isIOS, y, x, yOffset, xOffset, this._args.verbose);
+        await scroll(this._wd, this._driver, direction, this._webio.isIOS, y, x, yOffset, xOffset, this._args.verbose);
     }
 
     /**

lib/device-manager.ts

@@ -133,7 +133,7 @@ export class DeviceManager implements IDeviceManager {
         }
     }
 
-    public static async getDevices(query: IDevice) {
+    public static async getDevices(query: IDevice): Promise<IDevice[]> {
         return await DeviceController.getDevices(query);
     }
 
@@ -160,11 +160,11 @@ export class DeviceManager implements IDeviceManager {
         }
     }
 
-    public static async getInstalledApps(device: IDevice) {
+    public static async getInstalledApps(device: IDevice): Promise<string[]> {
         return await DeviceController.getInstalledApplication(device);
     }
 
-    public static getDefaultDevice(args: INsCapabilities, deviceName?: string, token?: string, type?: DeviceType, platformVersion?: number) {
+    public static getDefaultDevice(args: INsCapabilities, deviceName?: string, token?: string, type?: DeviceType, platformVersion?: number): IDevice {
         let device: IDevice = {
             name: deviceName || args.appiumCaps.deviceName,
             type: type,

lib/parser.d.ts

@@ -1 +1 @@
-export declare const projectDir: string, projectBinary: string, pluginRoot: string, pluginBinary: string, port: number, verbose: boolean, appiumCapsLocation: string, testFolder: string, runType: string, isSauceLab: boolean, appPath: string, storage: string, testReports: string, devMode: boolean, ignoreDeviceController: boolean, wdaLocalPort: number, path: string, relaxedSecurity: boolean, cleanApp: boolean, attachToDebug: boolean, sessionId: string, startSession: boolean, capabilitiesName: string, imagesPath: string, startDeviceOptions: string, deviceTypeOrPlatform: string, device: import("mobile-devices-controller/lib/device").IDevice;
+export declare const projectDir: string, projectBinary: string, pluginRoot: string, pluginBinary: string, port: number, verbose: boolean, appiumCapsLocation: string, testFolder: string, runType: string, isSauceLab: boolean, appPath: string, storage: string, testReports: string, devMode: boolean, ignoreDeviceController: boolean, wdaLocalPort: number, path: string, relaxedSecurity: boolean, cleanApp: boolean, attachToDebug: boolean, sessionId: string, startSession: boolean, capabilitiesName: string, imagesPath: string, startDeviceOptions: string, deviceTypeOrPlatform: string, device: any;

package.json

@@ -1,6 +1,6 @@
 {
   "name": "nativescript-dev-appium",
-  "version": "4.0.9",
+  "version": "5.0.0",
   "description": "A NativeScript plugin to help integrate and run Appium tests",
   "author": "NativeScript",
   "license": "MIT",
@@ -37,7 +37,7 @@
     "frame-comparer": "^2.0.1",
     "glob": "^7.1.0",
     "inquirer": "^6.2.0",
-    "mobile-devices-controller": "~4.0.1-1",
+    "mobile-devices-controller": "~4.0.1-5",
     "wd": "~1.11.1",
     "webdriverio": "~4.14.0",
     "yargs": "~12.0.5"

test/device-manager.spec.ts

@@ -60,7 +60,7 @@ describe("ios devices", () => {
     before("Init: DeviceManager", () => {
         deviceManager = new DeviceManager();
         appiumArgs = new NsCapabilities(<any>{});
-        appiumArgs.extend(<any>{ appiumCaps: { platformName: Platform.IOS, fullReset: false, deviceName: /iPhone XR/ } })
+        appiumArgs.extend(<any>{ appiumCaps: { platformName: Platform.IOS, fullReset: false, deviceName: /iPhone X/ } })
         appiumArgs.shouldSetFullResetOption();
     });
 
@@ -218,7 +218,7 @@ describe("Start device by apiLevel", async () => {
         const nsCaps = new NsCapabilities({
             appPath: iosApp,
             appiumCaps: {
-                platformVersion: /12./,
+                platformVersion: /12.||11./,
                 platformName: Platform.IOS,
                 fullReset: true
             }