Postman Script

From Chorke Wiki
Jump to navigation Jump to search 
global     : pm.globals.set("key", "value");
collection : pm.collectionVariables.set("key", "value");
environment: pm.environment.set("key", "value");
local      : pm.variables.set("key", "value");

global     : pm.globals.unset("key");
collection : pm.collectionVariables.unset("key");
environment: pm.environment.unset("key");
local      : pm.variables.unset("key");

Script Request

// GET Request
pm.sendRequest(activityInstanceURL, function (err, response) {
    activityInstance = response.json();
    // console.info(activityInstance);
});

//  POST Request
var payload = {
        'processInstanceIdIn': [processId],
        'sorting'            : [{
            'sortBy'   : 'variableName',
            'sortOrder': 'asc'
        }]
    },
    options = {
        url   :  variableInstanceURL, 
        method: 'POST',
        header: {
            'Accept'      : '*/*',
            'Cookie'        : cookie,
            'Content-Type': 'application/json'
        },
        body  : {
            mode: 'raw',
            raw : JSON.stringify(payload)
        }
    };

pm.sendRequest(options, function (err, response) {
    variables = response.json();
    //console.log(variables);
});

Before Request

let envBasedId = parseInt(pm.environment.get("env-based-id"));
var payload    = JSON.parse(pm.request.body.raw);
payload.id     = envBasedId;

let raw = JSON.stringify(payload);
pm.request.body.raw = raw;

var moment = require("moment"),
    init   = function(cli, ide, eon, today, birthDateMin, birthDateMax){
        birthDateMin = eon(today).subtract(18, 'years').add(1, 'days').format("DD/MM/YYYY");
        birthDateMax = eon(today).subtract(66, 'years').format("DD/MM/YYYY");
        ide.variables.set('adult.birth.date.invalid.min', birthDateMin);
        ide.variables.set('adult.birth.date.invalid.max', birthDateMax);
        cli.info(`adult.birth.date.invalid.min: ${birthDateMin}`);
        cli.info(`adult.birth.date.invalid.max: ${birthDateMax}`);
    };
init(console, pm, moment, new Date());

var moment    = require("moment"),
    format    = 'DD/MMM/YYYY',
    today     = new Date(),
    startDate = moment(today).format(format),
    endDate   = moment(today).add(1, 'years').format(format),
    keys      = {startDate: 'startDate', endDate: 'endDate'},
    preRequest= function(cli){
        pm.variables.set(keys.startDate, startDate);
        pm.variables.set(keys.endDate, endDate);
        
        cli.info(`${keys.startDate}: ${startDate}`);
        cli.info(`${keys.endDate}: ${endDate}`);
    },
    init      = function(cli){
        preRequest(cli)
    };
init(console);

After Request

pm.test("Status code is 200", function () {
    pm.response.to.have.status(200);
});

pm.test("Request & Response id match", function () {
    let envBasedId = parseInt(pm.environment.get("env-based-id"));
    pm.expect(pm.response.json().id).to.eql(envBasedId);
});

pm.test("Successful Quotation", function () {
    pm.response.to.have.status(200);
    pm.expect(pm.response.json().message).to.eql("Quotation has been created successfully.");
    pm.collectionVariables.set("quotationRefId", pm.response.json().refId);
});

OOP Script

var moment = require("moment"),
    init   = function(console, postman, moment, birthDate, debug){
        birthDate = new AdultBirthDate(console, postman, moment);
        birthDate.setUserVars(debug);
    };

const CHRONO_UNIT = { YEARS : 'years', DAYS  : 'days' },
      DATE_FORMAT = { DD_MM_YYY: 'DD/MM/YYYY' },
      USER_VARS   = { BIRTH_DATE: {
        VALID   : {
            MAX: 'adult.birth.date.valid.max',
            MIN: 'adult.birth.date.valid.min'
        },
        INVALID : {
            MAX: 'adult.birth.date.invalid.max',
            MIN: 'adult.birth.date.invalid.min'
        }
    }};

class AdultBirthDate {
    constructor(console, postman, moment){
        this.cli = console;
        this.ide = postman;
        this.eon = moment;
    }
    
    get validMinDate(){
        return this.eon(new Date()).subtract(18, CHRONO_UNIT.YEARS).format(DATE_FORMAT.DD_MM_YYY);
    }
    get validMaxDate(){
        return this.eon(new Date()).subtract(66, CHRONO_UNIT.YEARS).add(1, CHRONO_UNIT.DAYS).format(DATE_FORMAT.DD_MM_YYY);
    }
    get invalidMinDate(){
        return this.eon(new Date()).subtract(18, CHRONO_UNIT.YEARS).add(1, CHRONO_UNIT.DAYS).format(DATE_FORMAT.DD_MM_YYY);
    }
    get invalidMaxDate(){
        return this.eon(new Date()).subtract(66, CHRONO_UNIT.YEARS).format(DATE_FORMAT.DD_MM_YYY);
    }

    setUserVars(debug){
        debug && this.info();
        this.ide.variables.set(USER_VARS.BIRTH_DATE.VALID.MAX,   this.validMaxDate);
        this.ide.variables.set(USER_VARS.BIRTH_DATE.VALID.MIN,   this.validMinDate);
        this.ide.variables.set(USER_VARS.BIRTH_DATE.INVALID.MAX, this.invalidMaxDate);
        this.ide.variables.set(USER_VARS.BIRTH_DATE.INVALID.MIN, this.invalidMinDate);
    }

    info(message){
        message  = `${USER_VARS.BIRTH_DATE.VALID.MAX}  : ${this.validMaxDate}\n`;
        message += `${USER_VARS.BIRTH_DATE.VALID.MIN}  : ${this.validMinDate}\n`;
        message += `${USER_VARS.BIRTH_DATE.INVALID.MAX}: ${this.invalidMaxDate}\n`;
        message += `${USER_VARS.BIRTH_DATE.INVALID.MIN}: ${this.invalidMinDate}`;
        this.cli.info(message);
    }
}

init(console, pm, moment);

Playground

pm.request.body.formdata
pm.request.body.options
pm.request.body.raw
pm.request.header
pm.request.method
pm.request.body
pm.request.url

pm.request.body.mode = "raw";
pm.request.body.raw  = JSON.stringify({
    id       : 1,
    name     : "Chorke, Inc.",
    license  : "Incorporation",
    trademark: "Chorke"
});

pm.request.body.mode     = "formdata";
pm.request.body.formdata = [
    {type: "text", key: "name", value: "Chorke, Inc."       },
    {type: "file", key: "logo",   src: "/file/path/name.ext"},
    {type: "file", key: "sign", value: {name: "sign.png",
     type: "application/pdf", content: atob("<base64>")    }}
];

Knowledge

npm install -g newman
npm install -g moment
npm install -g path
npm install -g fs

pm.test("Check values", () => {
    pm.expect(pm.response.json().id).to.not.eql(null);
    pm.expect(pm.response.json().category.name).to.not.eql("");
});

pm.test("XSRF token checking", () => {
    pm.expect(pm.cookies.get('XSRF-TOKEN')).to.not.eql(null);
    pm.environment.set('xsrf-token' pm.cookies.get('XSRF-TOKEN'));
});

References

Retrieved from "https://cdn.chorke.org/weke/index.php?title=Postman_Script&oldid=11062"