postman-runtime/test/integration/inherited-entities/variables.test.js

Underlying library of executing Postman Collections (used by Newman)

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

describe('Collection variables', function () {
    var testRun;

    before(function (done) {
        var runOptions = {
            collection: {
                item: {
                    event: [
                        {
                            listen: 'prerequest',
                            script: {
                                exec: `
                                pm.variables.set('key-1', 'value-1');
                                pm.variables.set('key-2', 'value-1');
                                pm.variables.set('key-3', 'value-1');
                                pm.variables.set('key-4', 'value-1');
                                console.log('collection pre', pm.variables.toObject())
                            `}
                        },
                        {
                            listen: 'test',
                            script: {
                                exec: `
                                pm.variables.set('key-3', 'value-3');
                                pm.variables.set('key-4', 'value-3');
                                console.log('collection test', pm.variables.toObject())
                            `}
                        }
                    ],
                    item: {
                        event: [
                            {
                                listen: 'prerequest',
                                script: {
                                    exec: `
                                    pm.variables.set('key-2', 'value-2');
                                    pm.variables.set('key-3', 'value-2');
                                    pm.variables.set('key-4', 'value-2');
                                    console.log('item pre', pm.variables.toObject())
                                `}
                            },
                            {
                                listen: 'test',
                                script: {
                                    exec: `
                                    pm.variables.set('key-4', 'value-4');
                                    console.log('item test', pm.variables.toObject())
                                `}
                            }
                        ],
                        request: 'https://postman-echo.com/get'
                    }
                }
            }
        };

        // perform the collection run
        this.run(runOptions, function (err, results) {
            testRun = results;

            done(err);
        });
    });

    it('should have completed the run', function () {
        expect(testRun).to.be.ok;
        expect(testRun).to.nested.include({
            'done.callCount': 1
        });
        testRun.done.getCall(0).args[0] && console.error(testRun.done.getCall(0).args[0].stack);
        expect(testRun.done.getCall(0).args[0]).to.be.null;
        expect(testRun).to.nested.include({
            'start.callCount': 1
        });
    });

    it('should have executed the events correctly', function () {
        expect(testRun).to.nested.include({
            'prerequest.callCount': 1,
            'test.callCount': 1,
            'console.callCount': 4
        });
    });

    it('should be persisted accross scripts ', function () {
        var collPreConsole = testRun.console.getCall(0).args.slice(2),
            itemPreConsole = testRun.console.getCall(1).args.slice(2),
            collTestConsole = testRun.console.getCall(2).args.slice(2),
            itemTestConsole = testRun.console.getCall(3).args.slice(2);

        expect(collPreConsole[0]).to.equal('collection pre');
        expect(collPreConsole).to.deep.include.ordered.members([
            'collection pre',
            {
                'key-1': 'value-1',
                'key-2': 'value-1',
                'key-3': 'value-1',
                'key-4': 'value-1'
            }
        ]);

        expect(itemPreConsole[0]).to.equal('item pre');
        expect(itemPreConsole).to.deep.include.ordered.members([
            'item pre',
            {
                'key-1': 'value-1',
                'key-2': 'value-2',
                'key-3': 'value-2',
                'key-4': 'value-2'
            }
        ]);

        expect(collTestConsole[0]).to.equal('collection test');
        expect(collTestConsole).to.deep.include.ordered.members([
            'collection test',
            {
                'key-1': 'value-1',
                'key-2': 'value-2',
                'key-3': 'value-3',
                'key-4': 'value-3'
            }
        ]);

        expect(itemTestConsole[0]).to.equal('item test');
        expect(itemTestConsole).to.deep.include.ordered.members([
            'item test',
            {
                'key-1': 'value-1',
                'key-2': 'value-2',
                'key-3': 'value-3',
                'key-4': 'value-4'
            }
        ]);
    });
});