https://github.com/dmarcelino/it-optional

Mocha add-on method it.optional() which marks a test as pending if it would fail
https://github.com/dmarcelino/it-optional

Last synced: 2 days ago
JSON representation

Mocha add-on method it.optional() which marks a test as pending if it would fail

• Host: GitHub
• URL: https://github.com/dmarcelino/it-optional
• Owner: dmarcelino
• License: mit
• Created: 2015-04-24T15:40:07.000Z (over 9 years ago)
• Default Branch: master
• Last Pushed: 2015-05-31T22:08:51.000Z (over 9 years ago)
• Last Synced: 2024-09-29T22:24:06.370Z (6 days ago)
• Language: JavaScript
• Homepage:
• Size: 148 KB
• Stars: 4
• Watchers: 2
• Forks: 1
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
[![npm version](https://badge.fury.io/js/it-optional.svg)](http://badge.fury.io/js/it-optional)

[![Build Status](https://travis-ci.org/dmarcelino/it-optional.svg?branch=master)](https://travis-ci.org/dmarcelino/it-optional)

[![Dependency Status](https://david-dm.org/dmarcelino/it-optional.svg)](https://david-dm.org/dmarcelino/it-optional)

# it-optional

Mocha add-on method it.optional() which marks a test as pending if it would fail

## Overview

it-optional was created with adapter/plugin test suites in mind where a common set of tests is used to test different modules. If one or more tests is not mandatory for all it can be marked as optional using `it.optional(title, fn)`. If the test passes then its marked as "passing" if the test fails then it's marked as "pending". This way optional functionality can be tested without breaking the whole suite.

## Instalation

```

npm i it-optional -S

```

## Usage

```javascript

it.optional = require('it-optional');

it.optional('should do xyz', function(done){

  done();

});

// ✓ should do xyz

it.optional('should do xyz eventually', function(done){

  done(new Error('oops'));

});

// - PENDING: should do xyz async eventually

it.optional('should do abc eventually', function(done){

  Assert.equal(1, 2);

});

// - PENDING: should do abc async eventually

// custom messages

it.optional('should do xyz eventually', 'xyz not implemented yet', function(done){

  done(new Error('oops'));

});

// - xyz not implemented yet

```