Skip to content
This repository was archived by the owner on Aug 7, 2021. It is now read-only.

docs(CONTRIBUTING): update guide to add info about running e2e tests #424

Merged
merged 2 commits into from
Feb 16, 2018
Merged

docs(CONTRIBUTING): update guide to add info about running e2e tests #424

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
f1e05d3
docs(CONTRIBUTING): update guide to add info about running e2e tests
sis0k0 Jan 26, 2018
dfc1b30
docs(CONTRIBUTING): fix e2e steps order
sis0k0 Feb 16, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
30 changes: 22 additions & 8 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,22 +45,36 @@ The repository contains several ingredients:
The last command also runs `npm prepare` which compiles the TypeScript files in the plugin.
You are good to go! You're strongly encouraged to follow the official NativeScript [Coding Conventions](https://github.com/NativeScript/NativeScript/blob/master/CodingConvention.md) and to use ES features available in NodeJS v6. If unsure, check on [node.green](http://node.green/).

## Testing locally
## Testing locally by running e2e tests

There are three apps in the repository, located in the `/demo` directory.
1. Create a new NativeScript project with NativeScript CLI:
NOTE: There are three test apps in the repository, located in the `/demo` directory. The steps below describe how to run the tests for the `AngularApp`, but the same approach can be used to run any other `e2e` tests.

1. Navigate to `demo/AngularApp`
``` bash
tns create testapp # pass --ng/--tsc for Angular/TypeScript app
cd demo/AngularApp
```

2. Install dependencies. This also installs your local copy of the nativescript-angular plugin.
``` bash
npm install
```
3. Make sure to have an emulator set up or connect a physical Android/iOS device.

2. Install your local copy of the plugin.
4. Build the app for Android or iOS
``` bash
npm install /path/to/repo/nativescript-dev-webpack
tns run android/ios
```

3. Make sure to force-update the project's configuration files if it's already using Webpack.
5. Install [appium](http://appium.io/) globally.
``` bash
npm install -g appium
```

6. Follow the instructions in the [nativescript-dev-appium](https://github.com/nativescript/nativescript-dev-appium#custom-appium-capabilities) plugin to add an appium capability for your device inside `./e2e/renderer/e2e/config/appium.capabilities.json`.

7. Run the automated tests. The value of the `runType` argument should match the name of the capability that you just added.
``` bash
./node_modules/.bin/update-ns-webpack --deps --configs
npm run e2e -- --runType capabilityName
```

## Reporting Bugs
Expand Down