Skip to content

Commit

Permalink
updated the contributing guide, added e2e coverage tests usage instru…
Browse files Browse the repository at this point in the history
…ctions.
  • Loading branch information
rotemmiz committed May 14, 2017
1 parent 7a4b02a commit adc3a32
Show file tree
Hide file tree
Showing 4 changed files with 26 additions and 4 deletions.
2 changes: 1 addition & 1 deletion .travis.yml
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ install:
- gem install xcpretty >/dev/null 2>&1

script:
- ./scripts/travis.sh
- ./scripts/ci.sh
notifications:
email: true
slack:
Expand Down
2 changes: 1 addition & 1 deletion detox/.nvmrc
Original file line number Diff line number Diff line change
@@ -1 +1 @@
7.3.0
7.10.0
24 changes: 23 additions & 1 deletion docs/Guide.Contributing.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
# Contributing to detox


### Clone detox and submodules

```sh
Expand Down Expand Up @@ -69,7 +70,28 @@ npm run unit:watch
After running the tests, jest will create a coverage report.

```sh
cd detox/detox
cd detox
open coverage/lcov-report/index.html
```

### Running detox e2e covarage tests
Detox has a suite of e2e tests to test its own API while developing (and for regression). The way we do is is by maintaining a special application that is "tested" against detox's API, but essentially, it's the API that is tested, not the app.
To run the e2e tests, go to `detox/detox/test`

```sh
cd detox/test
```

To build the application (if you already ran `lerna run build` you're covered)

```sh
npm run build
```

To run the e2e tests, after the application was built.

```sh
npm run e2e
```

**NOTE: The updated flow can always be found in [our CI build script](../scripts/ci.sh)**
2 changes: 1 addition & 1 deletion scripts/travis.sh → scripts/ci.sh
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,6 @@ lerna run --ignore detox-demo* build
lerna run --ignore detox-demo* test

cd detox/test
detox test --configuration ios.sim.release
npm run e2e

#lerna publish --cd-version patch

0 comments on commit adc3a32

Please sign in to comment.