pm_asserts.js

/**
 * This script defines global variables to provide Asserts for Postman unit test case Runner.
 */

/* global pm */
/* global tv4 */
/* global tests */
/* global postman */

/**
 * Check if Response have JSON body
 * @returns void
 */
function isJsonResponse() {
    pm.test("Response should have JSON Body", function () {
        pm.response.to.have.jsonBody();
    });
}

/**
 * Check if Response have expected Status Code
 * @param {integer} statusCode
 * @returns void
 */
function isResponseStatus(statusCode) {
    pm.test("Status code is " + statusCode, function () {
        pm.response.to.have.status(statusCode);
    });
}

/**
 * Validate JSON Response with Tiny Validator (tv4, built-in into Postman), using JSON Schema
 * @param {object} schema - JSON Schema for Validation
 * @returns void
 */
function validateJsonSchema(schema) {
    tests["Response Data is Valid"] = tv4.validate(pm.response.json(), schema);

    if (tv4.error !== null) {
        tests["Validation ERROR => " + tv4.error.message] = "";
    }
}

/**
 * Check if two agruments are Equals.
 * Optional: message - you can provide your custom text
 * @param {any} expected
 * @param {any} actual
 * @param {string} message
 * @returns void
 */
function isEquals(expected, actual, message) {
    message = message || "Expected value is Equals to actual";

    pm.test(message, function () {
        pm.expect(expected).to.eql(actual);
    });
}

/**
 * Check if Raw Response Body Contains `needle`.
 * Optional: message - you can provide your custom text
 * @param {string} message
 * @param {string} needle
 * @returns void
 */
function isRawResponseBodyContains(needle, message) {
    message = message || "Raw Response Body contains " + needle;

    pm.test(message, function () {
        pm.expect(pm.response.text()).to.include(needle);
    });
}

/**
 * Set up and Validate Variable from Response to local ENV
 *
 * @param {string} localVar - Postman ENV variable name
 * @param {string | number | boolean} jsonValue - pm.response Object value
 * @returns void
 */
function ensureEnv(localVar, jsonValue) {
    pm.environment.unset(localVar);
    pm.environment.set(localVar, jsonValue);

    var envValue = pm.environment.get(localVar);
    var message  = "Variable is set to ENV: " + localVar + " = " + envValue;

    pm.test(message, function () {
        pm.expect(jsonValue).to.eql(envValue);
    });
}

/**
 * Set next request
 *
 * @param {string} requestName - the next request name
 */
function nextRequest(requestName){
    postman.setNextRequest(requestName);
}

/**
 * Log Header param to Test Result
 *
 * @param {string} key - header param key
 * @param {string} message - key name for example
 * @returns void
 */
function logHeader(key, message) {
    message = message || "Header " + key + ":";

    pm.test(message + " " + pm.request.headers.get(key));
}