Spyrr NPM | npm.io

SPY R/R

v1.0.0

Spy on your inner controller processes, create and test actions against server request/response without spinning up a live instance, using the supertest API.

Usage

Import

You can import either via CommonJS or ES6, depending on what you're using.

var mockRequest = require( 'spyrr' );

or, ES6:

import mockRequest from 'spyrr';

Test a request/response, and spy on inner methods

ES5:

var controller = require( './routes/endpoint.js' );

describe( 'POST /endpoint', function() {

    var someTestObject = { test: true };

    beforeEach( function() {

        spyOn( controller.endpoint, 'checkAuthorization' ).and.callFake( function() {

            return false;
        });
    });

    it( 'should reject requests with an invalid auth token', function( done ) {

        mockRequest( controller.endpoint )
            .params( { path: 'testpath', id: 'my-test' } )
            .query( { authToken: 'someInvalidToken' } )
            .body( { someObject: someTestObject } )
            .expect( 'Content-Type', /json/ )
            .expect( 401, {

                    error: true
                }, done 
            )
        ;
    });
});

ES6:

import controller from './routes/endpoint.js';

describe( 'POST /endpoint', () => {

    let someTestObject = { test: true };

    beforeEach( () => {

        spyOn( controller.endpoint, 'checkAuthorization' ).and.callFake( () => {

            return false;
        });
    });

    it( 'should reject requests with an invalid auth token', done => {

        mockRequest( controller.endpoint )
            .params( { path: 'testpath', id: 'my-test' } )
            .query( { authToken: 'someInvalidToken' } )
            .body( { someObject: someTestObject } )
            .expect( 'Content-Type', /json/ )
            .expect( 401, {

                    error: true
                }, done 
            )
        ;
    });
});

Build

Note: there are only minimal tests thus far. More are on the way!

You can build easily with gulp, which will test then build. To just test, run gulp test.

Requirements

Built to work with jasmine, though it may work with other testing frameworks.

Contribute

Please fork the project, then use a pull request to make improvements and fixes. This is very new so there is likely to be many undocumented issues, especially with non-jasmine frameworks.