rochdev/tinto

# Tinto
[![Version](https://img.shields.io/npm/v/tinto.svg)](https://www.npmjs.com/package/tinto)
[![Build Status](https://travis-ci.org/rochdev/tinto.svg?branch=master)](https://travis-ci.org/rochdev/tinto)
[![Test Coverage](https://codeclimate.com/github/rochdev/tinto/badges/coverage.svg)](https://codeclimate.com/github/rochdev/tinto)
[![Code Climate](https://codeclimate.com/github/rochdev/tinto/badges/gpa.svg)](https://codeclimate.com/github/rochdev/tinto)
[![Dependency Status](https://gemnasium.com/rochdev/tinto.svg)](https://gemnasium.com/rochdev/tinto)
[![Inline docs](http://inch-ci.org/github/rochdev/tinto.svg?branch=master)](http://inch-ci.org/github/rochdev/tinto)

A functional testing framework for component-based web applications

## Usage

### Installation

```sh
$ npm install --save-dev tinto
```

### Configuration

Tinto is configured from an optional `tinto.conf.js` file that should be placed in your project root. It should export the configuration object directly.

#### Options

* **includeStack**: Whether or not to include a stack trace in assertion error messages.
* **bundles**: An array of bundle names or bundle instances to load.
* **browser**: Which browser to use. See the WebDriver documentation for the list of supported browsers.

#### Defaults

```js
{
  includeStack: false,
  bundles: [],
  browser: 'firefox'
}
```

### Assertions syntax

#### Components

##### Property assertion
```js
searchButton.should.have.text('Search');
```

##### Property assertion (alternate syntax)
```js
searchButton.text.should.equal('Search');
```

##### State assertion
```js
searchButton.should.be.enabled;
```

##### Count assertion
```js
grid.should.have(3).rows;
```

##### Equality assertion
```js
grid.rows(0).should.equal(firstRow);
```

##### Containing assertion
```js
grid.should.contain(firstRow, secondRow);
```

##### Multiple assertions
```js
searchButton.should.have.text('Search').and.be.enabled;
```

##### Multiple assertions (alternate syntax)
```js
searchButton.should(
  have.text('Search'),
  be.enabled
);
```

##### Awaiting assertion
```js
searchButton.should.eventually.have.text('Search').and.be.enabled;
```

##### Awaiting assertion (alternate syntax)
```js
searchButton.should.eventually(
  have.text('Search'),
  be.enabled
);
```

### Component definition

##### ES5
```js
function Grid() {
  Component.apply(this, arguments);

  this.getter('rows', function() {
    return this.find('tr');
  });
}

tinto.inherits(Grid, Component);
```

##### ES6
```js
class Grid extends Component {
  get rows() {
    return this.find('tr');
  }
}
```

##### .extend
```js
var Grid = Component.extend({
  get rows() {
    return this.find('tr');
  }
});
```

### Command-line interface

In order to use the CLI, you must install tinto globally. You can then run `tinto --help` to list available commands.

## Examples

See the [example](example) folder for a complete example.

## License

[MIT License](http://en.wikipedia.org/wiki/MIT_License)

## Credits

This project was inspired by the excellent [Testatoo](http://www.testatoo.org) functional testing library for Java.