Fluent-GWT

Fluent-GWT is a native-Javascript Given/When/Then library which integrates into node test flows. The API helps codify the G/W/T or Arrange/Act/Assert workflow in your tests, making it easier to understand which part of the test is accomplishing what work.

Fluent-GWT provides extra helping information when tests fail, by logging which section of the test generated the error. This reduces time spent searching for the misbehaving code.

Why Another GWT Library?

Though Jasmine-Given, Mocha-Given, and Mocha-GWT exist, they all require, at the very least, a parser/interpreter and a new language in the toolchain. This makes them hard to integrate into current testing solutions and unfriendly if users are already feeling tooling fatigue. Fluent-GWT aims to simplify this problem and improve testing for people who aren't comfortable with the extra build tooling.

Setup

Install with npm:

npm install fluent-gwt --save-dev

Usage

Fluent-GWT can be used by requiring it into your test file (node) -- client test are currently unsupported.

Requiring in node looks like this:

const gwt = require('fluent-gwt')
    .configure({
        verbose: true // default is false
    });

Below is an example of a test using Fluent-GWT (used in Mocha):

it('tests a behavior when a user defines a simple, synchronous test', function () {
    return gwt
        .given(
            'User event is described and has an initial state',
            () => 'test string'
        )
        .when(
            'Behavior is called, capture outcome',
            (valueToUse) => valueToUse + ': success'
        )
        .then(
            'Outcome should match expectation',
            (outcomeToTest) => assert.equal(outcomeToTest, 'test string: success')
        );
});

Fluent-GWT supports Arrange/Act/Assert (otherwise known as A/A/A or triple-A) style test setup:

it('works as expected when arrange/act/assert is preferred by the user', function () {
    return gwt
        .arrange(
            'a promise-returning function is used',
            () => Promise.resolve('async string')
        )
        .act(
            'an asynchronous when is used',
            (givenResult) => Promise.resolve(givenResult)
        )
        .assert(
            'the async string should pass through',
            (actualResult) => assert.equal(actualResult, 'async string')
        )
});

Fluent-GWT also supports callback-resolving functions this way:

it('supports callback-style behaviors when a user needs to', function () {
    return gwt
        .given(
            'a promise-returning function is used',
            // gwt.fromCallback converts the callback-resolving function
            // into something Fluent-GWT can use
            gwt.fromCallback(callback => callback(null, 'callback string'))
        )
        .when(
            'an asynchronous when is used',
            (givenResult) => Promise.resolve(givenResult)
        )
        .then(
            'the async string should pass through',
            (actualResult) => assert.equal(actualResult, 'callback string')
        )
});

Fluent-GWT is promise-returning, so you can always "then" or "catch" against it:

it('provides GWT output when a test fails', function () {
    return gwt
        .given(
            'User event is described and has an initial state',
            () => 'test string'
        )
        .when(
            'Behavior is called, capture outcome',
            (valueToUse) => valueToUse + ': success'
        )
        .then(
            'Outcome should match expectation',
            () => {
                throw new Error('This test failed because reasons');
            })

        .then(function () {
            assert.isFalse(true);
        })
        .catch(function (error) {
            const failureMessage = 'Test failed:\n\n' +
                'Given: User event is described and has an initial state\n' +
                'When: Behavior is called, capture outcome\n' +
                'Then: Outcome should match expectation\n' +
                '\n' +
                'Error message: This test failed because reasons'

            assert.equal(error.message, failureMessage);
        });
});