Merge pull request #1155 from NativeScript/ikoevska/ns-1-5-x/unit-testing

ikoevska · ikoevska · commit bb75dd535684 · 2015-11-11T11:16:45.000+02:00
Updating docs for unit testing
diff --git a/README.md b/README.md
@@ -309,6 +309,8 @@ Run `tns help` to view all available commands in the browser. Run `tns help <Com
 * `deploy <Platform> [--device <Device ID>]` deploys an already built application on connected device.
 * `run <Platform> [--device <Device ID>]` executes `prepare`, `build`, and `deploy`.
 * `livesync <Platform>` synchronizes changes from your project to an already deployed application on device.
+* `test init` configures your project for unit testing with a selected framework.
+* `test <Platform>` runs your unit tests on a connected device or in the native emulator.
 * `device` lists connected devices, including any running Android Virtual Devices or Genymotion virtual devices.
 * `device log` opens the log stream for the selected device.
 * `device run` runs a selected application on a connected device.
diff --git a/docs/man_pages/index.md b/docs/man_pages/index.md
@@ -30,7 +30,7 @@ Command | Description
 [emulate `<Platform>`](project/testing/emulate.html) | Deploys the project in the native emulator for the selected target platform.
 [run `<Platform>`](project/testing/run.html) | Runs your project on a connected device or in the native emulator, if configured.
 [debug `<Platform>`](project/testing/debug.html) | Debugs your project on a connected physical or virtual device.
-[test init](project/testing/test-init.html) | Adds support for unit testing to your project.
+[test init](project/testing/test-init.html) | Configures your project for unit testing with a selected framework.
 [test `<Platform>`](project/testing/test.html) | Runs the unit tests in your project on a connected physical or virtual device.
 [install](project/configuration/install.html) | Installs all platforms and dependencies described in the `package.json` file in the current directory.
 [plugin](lib-management/plugin.html) | Lets you manage the plugins for your project.
diff --git a/docs/man_pages/project/testing/build-android.md b/docs/man_pages/project/testing/build-android.md
@@ -47,4 +47,7 @@ Command | Description
 [run android](run-android.html) | Runs your project on a connected Android device or in a native Android emulator, if configured.
 [run ios](run-ios.html) | Runs your project on a connected iOS device or in the iOS Simulator, if configured.
 [run](run.html) | Runs your project on a connected device or in the native emulator for the selected platform.
+[test init](test-init.html) | Configures your project for unit testing with a selected framework.
+[test android](test-android.html) | Runs the tests in your project on Android devices or native emulators. 
+[test ios](test-ios.html) | Runs the tests in your project on iOS devices or the iOS Simulator.
 <% } %>
diff --git a/docs/man_pages/project/testing/build-ios.md b/docs/man_pages/project/testing/build-ios.md
@@ -40,4 +40,7 @@ Command | Description
 [run android](run-android.html) | Runs your project on a connected Android device or in a native Android emulator, if configured.
 [run ios](run-ios.html) | Runs your project on a connected iOS device or in the iOS Simulator, if configured.
 [run](run.html) | Runs your project on a connected device or in the native emulator for the selected platform.
+[test init](test-init.html) | Configures your project for unit testing with a selected framework.
+[test android](test-android.html) | Runs the tests in your project on Android devices or native emulators. 
+[test ios](test-ios.html) | Runs the tests in your project on iOS devices or the iOS Simulator.
 <% } %>
diff --git a/docs/man_pages/project/testing/build.md b/docs/man_pages/project/testing/build.md
@@ -36,4 +36,7 @@ Command | Description
 [run android](run-android.html) | Runs your project on a connected Android device or in a native Android emulator, if configured.
 [run ios](run-ios.html) | Runs your project on a connected iOS device or in the iOS Simulator, if configured.
 [run](run.html) | Runs your project on a connected device or in the native emulator for the selected platform.
+[test init](test-init.html) | Configures your project for unit testing with a selected framework.
+[test android](test-android.html) | Runs the tests in your project on Android devices or native emulators. 
+[test ios](test-ios.html) | Runs the tests in your project on iOS devices or the iOS Simulator.
 <% } %>
diff --git a/docs/man_pages/project/testing/debug-android.md b/docs/man_pages/project/testing/debug-android.md
@@ -55,4 +55,7 @@ Command | Description
 [run android](run-android.html) | Runs your project on a connected Android device or in a native Android emulator, if configured.
 [run ios](run-ios.html) | Runs your project on a connected iOS device or in the iOS Simulator, if configured.
 [run](run.html) | Runs your project on a connected device or in the native emulator for the selected platform.
+[test init](test-init.html) | Configures your project for unit testing with a selected framework.
+[test android](test-android.html) | Runs the tests in your project on Android devices or native emulators. 
+[test ios](test-ios.html) | Runs the tests in your project on iOS devices or the iOS Simulator.
 <% } %>
diff --git a/docs/man_pages/project/testing/debug-ios.md b/docs/man_pages/project/testing/debug-ios.md
@@ -54,4 +54,7 @@ Command | Description
 [run android](run-android.html) | Runs your project on a connected Android device or in a native Android emulator, if configured.
 [run ios](run-ios.html) | Runs your project on a connected iOS device or in the iOS Simulator, if configured.
 [run](run.html) | Runs your project on a connected device or in the native emulator for the selected platform.
+[test init](test-init.html) | Configures your project for unit testing with a selected framework.
+[test android](test-android.html) | Runs the tests in your project on Android devices or native emulators. 
+[test ios](test-ios.html) | Runs the tests in your project on iOS devices or the iOS Simulator.
 <% } %>
diff --git a/docs/man_pages/project/testing/debug.md b/docs/man_pages/project/testing/debug.md
@@ -36,4 +36,7 @@ Command | Description
 [run android](run-android.html) | Runs your project on a connected Android device or in a native Android emulator, if configured.
 [run ios](run-ios.html) | Runs your project on a connected iOS device or in the iOS Simulator, if configured.
 [run](run.html) | Runs your project on a connected device or in the native emulator for the selected platform.
+[test init](test-init.html) | Configures your project for unit testing with a selected framework.
+[test android](test-android.html) | Runs the tests in your project on Android devices or native emulators. 
+[test ios](test-ios.html) | Runs the tests in your project on iOS devices or the iOS Simulator.
 <% } %>
diff --git a/docs/man_pages/project/testing/deploy.md b/docs/man_pages/project/testing/deploy.md
@@ -51,4 +51,7 @@ Command | Description
 [run android](run-android.html) | Runs your project on a connected Android device or in a native Android emulator, if configured.
 [run ios](run-ios.html) | Runs your project on a connected iOS device or in the iOS Simulator, if configured.
 [run](run.html) | Runs your project on a connected device or in the native emulator for the selected platform.
+[test init](test-init.html) | Configures your project for unit testing with a selected framework.
+[test android](test-android.html) | Runs the tests in your project on Android devices or native emulators. 
+[test ios](test-ios.html) | Runs the tests in your project on iOS devices or the iOS Simulator.
 <% } %>
diff --git a/docs/man_pages/project/testing/emulate-android.md b/docs/man_pages/project/testing/emulate-android.md
@@ -63,4 +63,7 @@ Command | Description
 [run android](run-android.html) | Runs your project on a connected Android device or in a native Android emulator, if configured.
 [run ios](run-ios.html) | Runs your project on a connected iOS device or in the iOS Simulator, if configured.
 [run](run.html) | Runs your project on a connected device or in the native emulator for the selected platform.
+[test init](test-init.html) | Configures your project for unit testing with a selected framework.
+[test android](test-android.html) | Runs the tests in your project on Android devices or native emulators. 
+[test ios](test-ios.html) | Runs the tests in your project on iOS devices or the iOS Simulator.
 <% } %>
diff --git a/docs/man_pages/project/testing/emulate-ios.md b/docs/man_pages/project/testing/emulate-ios.md
@@ -47,4 +47,7 @@ Command | Description
 [run android](run-android.html) | Runs your project on a connected Android device or in a native Android emulator, if configured.
 [run ios](run-ios.html) | Runs your project on a connected iOS device or in the iOS Simulator, if configured.
 [run](run.html) | Runs your project on a connected device or in the native emulator for the selected platform.
+[test init](test-init.html) | Configures your project for unit testing with a selected framework.
+[test android](test-android.html) | Runs the tests in your project on Android devices or native emulators. 
+[test ios](test-ios.html) | Runs the tests in your project on iOS devices or the iOS Simulator.
 <% } %>
diff --git a/docs/man_pages/project/testing/emulate.md b/docs/man_pages/project/testing/emulate.md
@@ -32,4 +32,7 @@ Command | Description
 [run android](run-android.html) | Runs your project on a connected Android device or in a native Android emulator, if configured.
 [run ios](run-ios.html) | Runs your project on a connected iOS device or in the iOS Simulator, if configured.
 [run](run.html) | Runs your project on a connected device or in the native emulator for the selected platform.
+[test init](test-init.html) | Configures your project for unit testing with a selected framework.
+[test android](test-android.html) | Runs the tests in your project on Android devices or native emulators. 
+[test ios](test-ios.html) | Runs the tests in your project on iOS devices or the iOS Simulator.
 <% } %>
diff --git a/docs/man_pages/project/testing/livesync-android.md b/docs/man_pages/project/testing/livesync-android.md
@@ -37,4 +37,7 @@ Command | Description
 [livesync ios](livesync-ios.html) | Synchronizes the latest changes in your project to iOS devices or the iOS Simulator.
 [run android](run-android.html) | Runs your project on a connected Android device or in a native Android emulator, if configured.
 [run ios](run-ios.html) | Runs your project on a connected iOS device or in the iOS Simulator, if configured.
+[test init](test-init.html) | Configures your project for unit testing with a selected framework.
+[test android](test-android.html) | Runs the tests in your project on Android devices or native emulators. 
+[test ios](test-ios.html) | Runs the tests in your project on iOS devices or the iOS Simulator.
 <% } %>
diff --git a/docs/man_pages/project/testing/livesync-ios.md b/docs/man_pages/project/testing/livesync-ios.md
@@ -40,4 +40,7 @@ Command | Description
 [livesync android](livesync-android.html) | Synchronizes the latest changes in your project to Android devices.
 [run android](run-android.html) | Runs your project on a connected Android device or in a native Android emulator, if configured.
 [run ios](run-ios.html) | Runs your project on a connected iOS device or in the iOS Simulator, if configured.
+[test init](test-init.html) | Configures your project for unit testing with a selected framework.
+[test android](test-android.html) | Runs the tests in your project on Android devices or native emulators. 
+[test ios](test-ios.html) | Runs the tests in your project on iOS devices or the iOS Simulator.
 <% } %>
diff --git a/docs/man_pages/project/testing/livesync.md b/docs/man_pages/project/testing/livesync.md
@@ -35,4 +35,7 @@ Command | Description
 [livesync android](livesync-android.html) | Synchronizes the latest changes in your project to Android devices.
 [run android](run-android.html) | Runs your project on a connected Android device or in a native Android emulator, if configured.
 [run ios](run-ios.html) | Runs your project on a connected iOS device or in the iOS Simulator, if configured.
+[test init](test-init.html) | Configures your project for unit testing with a selected framework.
+[test android](test-android.html) | Runs the tests in your project on Android devices or native emulators. 
+[test ios](test-ios.html) | Runs the tests in your project on iOS devices or the iOS Simulator.
 <% } %>
diff --git a/docs/man_pages/project/testing/run-android.md b/docs/man_pages/project/testing/run-android.md
@@ -61,4 +61,7 @@ Command | Description
 [livesync android](livesync-android.html) | Synchronizes the latest changes in your project to Android devices.
 [run ios](run-ios.html) | Runs your project on a connected iOS device or in the iOS Simulator, if configured.
 [run](run.html) | Runs your project on a connected device or in the native emulator for the selected platform.
+[test init](test-init.html) | Configures your project for unit testing with a selected framework.
+[test android](test-android.html) | Runs the tests in your project on Android devices or native emulators. 
+[test ios](test-ios.html) | Runs the tests in your project on iOS devices or the iOS Simulator.
 <% } %>
diff --git a/docs/man_pages/project/testing/run-ios.md b/docs/man_pages/project/testing/run-ios.md
@@ -52,4 +52,7 @@ Command | Description
 [livesync android](livesync-android.html) | Synchronizes the latest changes in your project to Android devices.
 [run android](run-android.html) | Runs your project on a connected Android device or in a native Android emulator, if configured.
 [run](run.html) | Runs your project on a connected device or in the native emulator for the selected platform.
+[test init](test-init.html) | Configures your project for unit testing with a selected framework.
+[test android](test-android.html) | Runs the tests in your project on Android devices or native emulators. 
+[test ios](test-ios.html) | Runs the tests in your project on iOS devices or the iOS Simulator.
 <% } %>
diff --git a/docs/man_pages/project/testing/run.md b/docs/man_pages/project/testing/run.md
@@ -36,4 +36,7 @@ Command | Description
 [livesync android](livesync-android.html) | Synchronizes the latest changes in your project to Android devices.
 [run android](run-android.html) | Runs your project on a connected Android device or in a native Android emulator, if configured.
 [run ios](run-ios.html) | Runs your project on a connected iOS device or in the iOS Simulator, if configured.
+[test init](test-init.html) | Configures your project for unit testing with a selected framework.
+[test android](test-android.html) | Runs the tests in your project on Android devices or native emulators. 
+[test ios](test-ios.html) | Runs the tests in your project on iOS devices or the iOS Simulator.
 <% } %>
diff --git a/docs/man_pages/project/testing/test-android.md b/docs/man_pages/project/testing/test-android.md
@@ -3,21 +3,29 @@ test android
 
 Usage | Synopsis
 ------|-------
-General | `$ tns test android [--watch] [--device <Device ID>] [--debug-brk]`
+Run tests on all connected devices | `$ tns test android [--watch] [--debug-brk]`
+Run tests on a selected device | `$ tns test android --device <Device ID> [--watch] [--debug-brk]`
 
-Runs the tests in your project on connected Android devices and emulators.
+Runs the tests in your project on connected Android devices and running native emulators.<% if(isConsole) { %> Your project must already be configured for unit testing by running `$ tns test init`.<% } %>
 
 ### Options
 * `--watch` - If set, when you save changes to the project, changes are automatically synchronized to the connected device and tests are re-run.
 * `--device` - Specifies the serial number or the index of the connected device on which to run the tests. To list all connected devices, grouped by platform, run `$ tns device`
-* `--debug-brk` - Run the tests under the debugger. The debugger will break just before your tests are executed, so you have a chance to place breakpoints.
+* `--debug-brk` - Runs the tests under the debugger. The debugger will break just before your tests are executed, so you have a chance to place breakpoints.
 
 ### Attributes
 * `<Device ID>` is the device index or identifier as listed by `$ tns device`
 
 <% if(isHtml) { %>
-### Related commands
+### Prerequisites
+
+* Verify that [you have configured your project for unit testing](test-init.html).
+* Verify that [you have stored your unit tests in `app` &#8594; `tests`](http://docs.nativescript.org/testing).
+* Verify that [you have configured your system and devices properly](http://docs.nativescript.org/testing).
+
+### Related Commands
 Command | Description
 --------|------------
-[test init](test-init.html) | Creates a test project in an existing NativeScript project
+[test init](test-init.html) | Configures your project for unit testing with a selected framework.
+[test ios](test-ios.html) | Runs the tests in your project on iOS devices or the iOS Simulator.
 <% } %>
diff --git a/docs/man_pages/project/testing/test-init.md b/docs/man_pages/project/testing/test-init.md
@@ -5,14 +5,19 @@ Usage | Synopsis
 ------|-------
 General | `$ tns test init [--framework <Framework>]`
 
-Adds support for unit testing in an existing project.
+Configures your project for unit testing with a selected framework. This operation installs the nativescript-unit-test-runner npm module and its dependencies and creates a `tests` folder in the `app` directory.
 
 ### Options
-* `--framework <Framework>` - Specify the unit testing framework to install. Available frameworks are <%= formatListOfNames(constants.TESTING_FRAMEWORKS, 'and') %>.
+* `--framework <Framework>` - Sets the unit testing framework to install. The following frameworks are available: <%= formatListOfNames(constants.TESTING_FRAMEWORKS, 'and') %>.
 
 <% if(isHtml) { %>
-### Related commands
+### Command Limitations
+
+* You can configure only one unit testing framework per project.
+
+### Related Commands
 Command | Description
 --------|------------
-[test](test.html) | Run tests
+[test android](test-android.html) | Runs the tests in your project on Android devices or native emulators. 
+[test ios](test-ios.html) | Runs the tests in your project on iOS devices or the iOS Simulator.
 <% } %>
diff --git a/docs/man_pages/project/testing/test-ios.md b/docs/man_pages/project/testing/test-ios.md
@@ -7,17 +7,30 @@ Run tests on all connected devices | `$ tns test ios [--watch] [--debug-brk]`
 Run tests on a selected device | `$ tns test ios --device <Device ID> [--watch] [--debug-brk]`
 Run tests in the iOS Simulator | `$ tns test ios --emulator [--watch] [--debug-brk]`
 
-Runs the tests in your project on connected iOS devices or the iOS Simulator.
+Runs the tests in your project on connected iOS devices or the iOS Simulator.<% if(isConsole && isMacOS) { %> Your project must already be configured for unit testing by running `$ tns test init`.<% } %>
 
+<% if(isConsole && (isLinux || isWindows)) { %>WARNING: You can run this command only on OS X systems. To view the complete help for this command, run `$ tns help test ios`<% } %> 
+
+<% if((isConsole && isMacOS) || isHtml) { %>
 ### Options
 * `--watch` - If set, when you save changes to the project, changes are automatically synchronized to the connected device and tests are re-ran.
 * `--device` - Specifies the serial number or the index of the connected device on which you want to run tests. To list all connected devices, grouped by platform, run `$ tns device`. You cannot set `--device` and `--emulator` simultaneously.
 * `--emulator` - Runs tests on the iOS Simulator. You cannot set `--device` and `--emulator` simultaneously.
-* `--debug-brk` - Run the tests under the debugger. The debugger will break just before your tests are executed, so you have a chance to place breakpoints.
+* `--debug-brk` - Runs the tests under the debugger. The debugger will break just before your tests are executed, so you have a chance to place breakpoints.
+
+### Attributes
+* `<Device ID>` is the device index or identifier as listed by `$ tns device`<% } %>
 
 <% if(isHtml) { %>
-### Related commands
+### Prerequisites
+
+* Verify that [you have configured your project for unit testing](test-init.html).
+* Verify that [you have stored your unit tests in `app` &#8594; `tests`](http://docs.nativescript.org/testing).
+* Verify that [you have configured your system and devices properly](http://docs.nativescript.org/testing).
+
+### Related Commands
 Command | Description
 --------|------------
-[test init](test-init.html) | Creates a test project in an existing NativeScript project
+[test init](test-init.html) | Configures your project for unit testing with a selected framework.
+[test android](test-android.html) | Runs the tests in your project on Android devices or native emulators.
 <% } %>
diff --git a/docs/man_pages/project/testing/test.md b/docs/man_pages/project/testing/test.md
