postman-runtime/test/integration/sanity/simple-sanity.test.js

Underlying library of executing Postman Collections (used by Newman)

var expect = require('chai').expect;

describe('sanity test', function () {
    var testrun;

    before(function (done) {
        this.run({
            collection: {
                item: {request: 'https://postman-echo.com/get?testvar={{testVar}}'}
            },
            environment: {
                values: [{key: 'testVar', value: 'test-var-value'}]
            }
        }, function (err, results) {
            testrun = results;
            done(err);
        });
    });

    it('should have started and completed the test run', function () {
        expect(testrun).to.be.ok;
        expect(testrun).to.nested.include({
            'done.calledOnce': true,
            'start.calledOnce': true
        });
    });

    it('should resolve variable and send request', function () {
        var request = testrun.beforeRequest.getCall(0).args[2];

        expect(testrun).to.nested.include({ // one request
            'beforeRequest.calledOnce': true
        });
        expect(request).to.be.ok;
        expect(request.url.toString()).eql('https://postman-echo.com/get?testvar=test-var-value');
        expect(request).to.have.property('method', 'GET');
    });

    it('should receive response with the query param sent', function () {
        var response = testrun.request.getCall(0).args[2];

        expect(testrun.request.calledOnce).to.be.ok; // one request
        expect(response.json()).to.have.nested.property('args.testvar', 'test-var-value');
    });
});