# valtech-testing-framework

> Framework for automated testing using Cucumber, WebdriverIO and Selenium

Latest version **0.3.0** (published 2018-10-24) · MIT license · 0 weekly downloads

## Install

```sh
npm install valtech-testing-framework
pnpm add valtech-testing-framework
yarn add valtech-testing-framework
bun add valtech-testing-framework
```

Provides the command `vtf`.

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.3.0 |
| Published | 2018-10-24 |
| First published | 2018-04-18 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 19 |
| Unpacked size | 46.9 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Alex Schouls |
| Maintainers | physer |
| Keywords | testing, webdriverio, cucumber, automated, automation, selenium |

## Links

- npm: https://www.npmjs.com/package/valtech-testing-framework
- Repository: https://github.com/Physer/Valtech-Testing-Framework
- Homepage: https://github.com/Physer/Valtech-Testing-Framework#readme
- Issues: https://github.com/Physer/Valtech-Testing-Framework/issues
- npm.io page: https://npm.io/package/valtech-testing-framework

## Dependencies (19)

- [chai](https://npm.io/package/chai.md) ^4.1.2
- [jest](https://npm.io/package/jest.md) ^22.4.3
- [yargs](https://npm.io/package/yargs.md) ^11.0.0
- [babel-cli](https://npm.io/package/babel-cli.md) ^6.26.0
- [fancy-log](https://npm.io/package/fancy-log.md) ^1.3.2
- [babel-jest](https://npm.io/package/babel-jest.md) ^22.4.3
- [dateformat](https://npm.io/package/dateformat.md) ^3.0.3
- [ansi-colors](https://npm.io/package/ansi-colors.md) ^1.1.0
- [webdriverio](https://npm.io/package/webdriverio.md) ^4.12.0
- [babel-polyfill](https://npm.io/package/babel-polyfill.md) ^6.26.0
- [babel-register](https://npm.io/package/babel-register.md) ^6.26.0
- [cucumber-junit](https://npm.io/package/cucumber-junit.md) ^1.7.1
- [babel-preset-env](https://npm.io/package/babel-preset-env.md) ^1.6.1
- [allure-commandline](https://npm.io/package/allure-commandline.md) ^2.5.0
- [wdio-spec-reporter](https://npm.io/package/wdio-spec-reporter.md) ^0.1.4
- [wdio-allure-reporter](https://npm.io/package/wdio-allure-reporter.md) ^0.6.0
- [cucumber-html-reporter](https://npm.io/package/cucumber-html-reporter.md) ^4.0.2
- [wdio-cucumber-framework](https://npm.io/package/wdio-cucumber-framework.md) ^1.1.1
- [wdio-selenium-standalone-service](https://npm.io/package/wdio-selenium-standalone-service.md) 0.0.10

## Alternatives

- [@snazzah/davey](https://npm.io/package/@snazzah/davey.md) — 1.5M weekly downloads
- [@vendure/testing](https://npm.io/package/@vendure/testing.md) — 8.3K weekly downloads
- [vue-simple-context-menu](https://npm.io/package/vue-simple-context-menu.md) — 6.6K weekly downloads
- [cypress-webpack-preprocessor-v5](https://npm.io/package/cypress-webpack-preprocessor-v5.md) — 2.1K weekly downloads
- [@backstage/plugin-catalog-backend-module-puppetdb](https://npm.io/package/@backstage/plugin-catalog-backend-module-puppetdb.md) — 1.3K weekly downloads

## Recent versions

- 0.3.0 (latest) — 2018-10-24
- 0.2.0 — 2018-04-19
- 0.0.1 — 2018-04-18

## README

# Valtech Testing Framework
Valtech Testing Framework (VTF) is a framework combining Cucumber(.js), WebdriverIO and Selenium for setting up a quick and easy testing environment.

## Installation
You can install VTF using NPM:
```bash
npm install valtech-testing-framework --save-dev
```

## Usage
Using a commandline tool you first need to setup the required output folders. You can simply do this by running the following command:
```bash
vtf setup
```
After the setup is completed you can run VTF using the command below. 
```bash
vtf run --options options.js [--config config.js]
```

## Configuration
When running the vtf run command it is mandatory to specify an options file. The following code shows an example of what your options.js could look like:
```js
// options.js
module.exports.config = {
    baseUrl: 'https://github.com',
    specs: ['./features/**/*.feature'],
    cucumberOpts: {
        tagExpression: '@tag1'
    }
}
```
Optionally you can also specify an config file, which will be used to override the default config file from WebdriverIO. The following code shows an example of what the config.js would look like if you wanted to run the tests in Firefox:
```js
// config.js
module.exports.config = {
    capabilities: [{
        browserName: 'firefox'
    }]
}
```
More about the WebdriverIO configuration can be found [here.](http://webdriver.io/guide/getstarted/configuration.html)
### Options.js
#### baseUrl
Base URL used for the tests being started.

Type: `String`<br>
Default: `null`<br>
Example: `https://github.com/`
#### specs
A list of path queries of the Cucumber tests which should be run.

Type: `String[]`<br>
Default: `[]`<br>
Example: `['./features/**/*.feature']`
#### logOutput
A list of path queries of the Cucumber tests which should be run.

Type: `String[]`<br>
Default: `[]`<br>
Example: `['./features/**/*.feature']`

---
_Source: https://npm.io/package/valtech-testing-framework · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._