Skip to content
This repository has been archived by the owner on Jul 29, 2024. It is now read-only.

Commit

Permalink
docs(custom-frameworks): add instructions for Serenity/JS
Browse files Browse the repository at this point in the history
  • Loading branch information
jan-molak authored and heathkit committed Apr 11, 2017
1 parent d74356b commit 104d9b4
Showing 1 changed file with 28 additions and 0 deletions.
28 changes: 28 additions & 0 deletions docs/frameworks.md
Original file line number Diff line number Diff line change
Expand Up @@ -111,6 +111,34 @@ exports.config = {
};
```

Using Serenity/JS
-----------------

[Serenity/JS](http://serenity-js.org) is an acceptance testing library which can be integrated as a drop-in replacement of [Mocha](http://serenity-js.org/mocha/readme.html) or [Cucumber](http://serenity-js.org/cucumber/readme.html) framework adapters to provide advanced [scalability and reporting capabilities](http://serenity-js.org/overview/readme.html).

To use it, [install](http://serenity-js.org/overview/installation.html) and [configure](http://serenity-js.org/overview/configuration.html) your test framework of choice.

Next, [install Serenity/JS](http://serenity-js.org/overview/installation.html):

```
npm install serenity-js --save-dev
```

and instruct Protractor to use the Serenity/JS adapter:

```js
exports.config = {
framework: 'custom',
frameworkPath: require.resolve('serenity-js')

// ...
};
```

Specifying either `cucumberOpts` or `mochaOpts` in your Protractor configuration will make Serenity/JS infer that it should delegate the execution to [Cucumber](https://github.com/cucumber/cucumber-js) or [Mocha](https://mochajs.org/), respectively.

To learn more, [visit the project website](http://serenity-js.org/) or [follow the tutorial](http://serenity-js.org/from-scripts-to-serenity/readme.html).

Using a Custom Framework
------------------------

Expand Down

0 comments on commit 104d9b4

Please sign in to comment.