https://github.com/twipped/tapsuite

A node-tap helper for creating test suites
https://github.com/twipped/tapsuite

Last synced: about 1 month ago
JSON representation

A node-tap helper for creating test suites

• Host: GitHub
• URL: https://github.com/twipped/tapsuite
• Owner: Twipped
• License: other
• Created: 2016-10-23T16:48:22.000Z (about 8 years ago)
• Default Branch: master
• Last Pushed: 2019-05-02T00:30:32.000Z (over 5 years ago)
• Last Synced: 2024-10-28T22:55:46.742Z (2 months ago)
• Language: JavaScript
• Size: 85.9 KB
• Stars: 0
• Watchers: 3
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE.txt

Awesome Lists containing this project

README

        
# tapsuite

A tool for creation of a suite of node-tap subtests in a file with dedicated pre-suite and post-suite behavior, as well as providing `t.only`, `t.skip` and `t.todo` functions for easier test development.

[![NPM version](https://img.shields.io/npm/v/tapsuite.svg)](http://badge.fury.io/js/tapsuite)

[![Licensed MIT](https://img.shields.io/npm/l/tapsuite.svg)](https://github.com/ChiperSoft/tapsuite/blob/master/LICENSE.txt)

[![Nodejs 4+](https://img.shields.io/badge/node.js-%3E=_4 LTS-brightgreen.svg)](http://nodejs.org)

[![Downloads](http://img.shields.io/npm/dm/tapsuite.svg)](http://npmjs.org/tapsuite)

[![Build Status](https://img.shields.io/travis/ChiperSoft/tapsuite.svg)](https://travis-ci.org/ChiperSoft/tapsuite)

## Installation

```

npm install tap tapsuite

```

Tapsuite has a peer dependency on node-tap, which must be installed alongside.

## Usage

```js

var suite = require('tapsuite');

suite('this is a suite of tests', (s) => {

	

	// All of the pre and post suite/test functions are asynchronous and must

	// declare when they are finished by either invoking the `done` callback

	// or by returning a promise

	s.before((done) => {

		// pre-suite setup tasks

		done();

	});

	s.after(() => {

		// post-suite teardown tasks

		return Promise.resolve();

	});

	s.beforeEach((done) => {

		// pre-test setup tasks

		done();

	});

	s.afterEach(() => {

		// post-test teardown tasks

		return Promise.resolve();

	});

	s.test('this is a normal tap test', (t) => {

		// Suite tests execute exactly like normal tap subtests, with one exception.

		// Normal tap tests execute instantly, tapsuite tests do not execute until after

		// the suite function has returned and the before task has finished.

		t.end();

	});

	s.only('this is the only tap test that will run', (t) => {

		// s.only is exactly like s.test, except that when a test

		// is created via .only, all other tests in the suite will

		// be ignored.

		t.end();

	});

	// Todo and Skip tests are identical to passing `skip:true` or `todo:true` on the

	// test options object. Tap will report the skipped tests like usual. The functions

	// exist to make marking these tests a little easier

	s.todo('this is a test that needs to be written');

	s.skip('this is a test that is being skipped', (t) => {

		t.end();

	});

	// Unlike with node-tap, a suite function executes synchronously and does not

	// require calling an s.end() function, which does not even exist.

}).then(() => {

	// The suite function returns a promise which resolves when the suite completes

})

```