npm package: @konfirm/labrat
Description: Convenience wrapper to globalize Hapi lab and code (BDD syntax)
Author: Rogier Spieker
Latest version: 2.0.2

# LabRat

[![Codacy Badge](https://api.codacy.com/project/badge/Grade/419c821984124e2190e03657f86391ab)](https://www.codacy.com/app/konfirm/node-labrat?utm_source=github.com&amp;utm_medium=referral&amp;utm_content=konfirm/node-labrat&amp;utm_campaign=Badge_Grade)
[![Build Status](https://travis-ci.org/konfirm/node-labrat.svg?branch=master)](https://travis-ci.org/konfirm/node-labrat)

A simple wrapper around Hapi's [lab](https://github.com/hapijs/lab) and [code](https://github.com/hapijs/code) modules to allow for easy BDD-style test bootstrapping.
It globally exposes several BDD-style methods from both [lab](https://github.com/hapijs/lab) and [code](https://github.com/hapijs/code) wich are cleaned up after the tests, this prevents lab from reporting (the defined globals) as possible leaks.

## Installation
Note that labrat is a so-called scoped npm module, hence you will need to specify the scope for both the installation and use.

```
$ npm install --save-dev @konfirm/labrat
```

## Usage
LabRat is intended to make the [lab](https://github.com/hapijs/lab) bootstrap slightly more convenient, to use the bootstrap create a file `test/index.spec.js` with the following contents:

```js
module.exports = require('@konfirm/labrat').export;
```

Now you can easily create your tests in subfolders of `test`, where you automatically have access to all of the BDD-style functions [lab](https://github.com/hapijs/lab) and [code](https://github.com/hapijs/code) offer.

If you'd like to add (and thus afterwards remove) your own custom global functions, simply provide this to the [`globalize`](#globalize) method;


### `describe` (lab)
```js
describe('Description', () => {
	//  your tests
});
```

### `it` (lab)
```js
it('does something', (next) => {
	//  your expectation(s)

	next();
})
```

### `each`
Inspired by the [Jest `test.each`](https://jestjs.io/docs/en/api#2-testeach-each-name-fn-timeout) syntax, LabRat (as of 1.4.0) provides the `each` method to run a test on a series of data

```js
	describe('iterates markdown tables', () => {
		each`
			title   | value             | json
			array   | ${[1, 2, 3]}      | [1,2,3]
			object  | ${{ a: 1, b: 2 }} | {"a":1,"b":2}
			string  | ${'foo'}          | "foo"
			string  | foo               | "foo"
			number  | ${123}            | 123
			boolean | ${true}           | true
			boolean | ${false}          | false
			null    | ${null}           | null
		`('$title turns into $json', ({ value, json }, next) => {
			expect(JSON.stringify(value)).to.equal(json);

			next();
		});
	});
```

The function returned by the `each` tagged template literal expects two arguments:
- the description (which has the `$[a-z]` pattern replaces with the respective value of the column)
- the test method, which receives the record (row data as object, containing the keys defined in the first row) and the `next` method, indicating the test is complete.

### `before` (lab)
Executes a function call before the tests inside a describe-block.

```js
describe('Description', () => {
	before((done) => {
		//  wait one second
		setTimeout(done, 1000);
	});
});
```

### `beforeEach` (lab)
Similar to `before` but executes the function call before each test inside the describe-block;

```js
describe('Description', () => {
	beforeEach((done) => {
		//  wait one second
		setTimeout(done, 1000);
	});
});
```

### `after` (lab)
Executes a function call after the tests inside a describe-block

```js
describe('Description', () => {
	after((done) => {
		//  wait one second
		setTimeout(done, 1000);
	});
});
```

### `afterEach` (lab)
Similar to `after` but executes a function call after each test inside a describe-block

```js
describe('Description', () => {
	afterEach((done) => {
		//  wait one second
		setTimeout(done, 1000);
	});
});
```

### `expect` (code)
Expect provides the `Code.expect` method, with full access to its [full assertion library](https://github.com/hapijs/code/blob/master/API.md)

```js
expect(true).to.be.a.boolean().and.to.not.equal(false);
```

### `globalize`
LabRat can make most functions available globally (and clean them up before [lab]() checks for any leaked properties).

```js
//  expose the platform, freemem and totalmem method from the native 'os' module
labrat.globalize(require('os'), 'platform', 'freemem', 'totalmem');
```

If the function to globalize is stand-alone (not part of a module/class/object), a slightly more elaborate syntax must be used:

```js
function hello(who) {
	return `hello ${who}`;
}

labrat.globalize({ hello }, 'hello');
```

The example above can also be written in a slightly more compact way
```js
labrat.globalize({ hello: (who) => `hello ${who}` }, 'hello');
```

### `source`
A lot of times requiring a local module to test can look a bit messy as the path may end up looking something like `../../path/to/module` in the test file.
In order to reduce this visual clutter, there's the `source` function, which is a wrapper around `require` with a prepared base path.

```js
const MyModule = source('mymodule');
```

By default LabRat will look for the following common module folders in the project root directory;
 - src
 - source
 - sources
 - lib
 - libs

If your project is structured differently, no worries, you can easily change the path.

```js
labrat.sourcePath = '/path/to/modules';
```

If the project uses the same location for its own modules, simply add this to the `test/index.spec.js` file:

```js
const labrat = require('@konfirm/labrat');
labrat.sourcePath = '/path/to/the/modules';

module.exports = labrat.export;
```

#### Tips to define a custom path
A pretty basic project setup would be something like

```
my_modules/
	*
node_modules/
	*
test/
	index.spec.js
package.json
```

From the `index.spec.js` there are to ways to set `my_modules` as the main module path for labrat:

_Relative to `index.spec.js`_
```js
labrat.sourcePath = `${__dirname}/../my_modules`;
```

_Relative to the project folder_
```js
labrat.sourcePath = `${process.cwd()}/my_modules`;
```

## License

MIT License
Copyright (c) 2017-2018 Rogier Spieker (Konfirm)

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.