Describe the parameters

This commit is contained in:
Erjan Gavalji
2015-10-22 15:00:10 +03:00
parent 24d2bb40c9
commit a60cedcde3

View File

@ -7,13 +7,17 @@ NativeScript is a framework for building applications on mobile devices. Many
of its components are UI elements which get tested most efficiently on the of its components are UI elements which get tested most efficiently on the
respective device or simulator/emulator. Thus, running the tests involves respective device or simulator/emulator. Thus, running the tests involves
the following steps: the following steps:
- Create a NativeScript project - Create a NativeScript project
- Build it to a native image - Build it to a native image
- Start a simulator/emulator - Start a simulator/emulator
- Deploy the application image - Deploy the application image
- Start the application - Start the application
- Monitor its output - Monitor its output
- Gather test output - Gather test output
These steps are automated via the `run-testsapp.grunt.js` grunt script, located
under the `build` directory. It gets called by the main `gruntfile.js`, but is
split to a separate file for simplicity.
# Prerequisites # Prerequisites
- Node JS - Node JS
@ -24,6 +28,24 @@ the following steps:
# Arguments: # Arguments:
> As this is a [grunt](http://gruntjs.com/) script, the arguments are passed
the grunt way (--argName=argValue)
- `platform`: The platform to run the tests application on: iOS or Android
- `tnsPath`: [Optional] The path to the NativeScript executable. If not
found, the globally installed `tns` gets called.
- `emuPId`: The ID of the emulator process. This one is used to refresh the
emulator process, as the emulator sometimes hangs.
- `avd`: The name of the Android Virtual Device to be started to run the
tests.
- `logFilePath`: [Optional] The path to the file, which the test app run
log will get saved to. Defaults to "./TestRunResult.txt".
- `androidRuntimePath`: [Optional] The path to a custom Android Runtime
package to have the tests run onto. If not specified, the newest available
build on [npmjs.com](http://npmjs.com).
- `showEmu`: [Optional] Specifies whether the emulator should get launched
in a window or headless mode. Defaults to `false`.
# Sample run: # Sample run:
``` ```
grunt testsapp --platform=Android [--tnsPath="tns"] --emuPId=".*emulator64-x86" grunt testsapp --platform=Android [--tnsPath="tns"] --emuPId=".*emulator64-x86"