Test utilities and helpers in Postman

Introduction

Test utilities and helpers make writing tests easier and faster. They help you reuse code and keep tests clean.

When you need to check the same condition in many tests.

When you want to format data before testing it.

When you want to create custom assertions for your API responses.

When you want to organize your test code for better readability.

When you want to avoid repeating code in multiple test scripts.

Syntax

Postman

// Define a helper function
function isStatusOk(response) {
  return response.code === 200;
}

// Use the helper in a test
pm.test('Status is OK', function () {
  pm.expect(isStatusOk(pm.response)).to.be.true;
});

Helpers are regular JavaScript functions you write inside Postman test scripts.

You can call helpers anywhere in your test scripts after defining them.

Examples

This helper checks if the response header says the content is JSON.

Postman

// Helper to check if response has JSON content type
function isJsonResponse(response) {
  return response.headers.get('Content-Type').includes('application/json');
}

pm.test('Response is JSON', () => {
  pm.expect(isJsonResponse(pm.response)).to.be.true;
});

This helper tries to parse JSON and returns null if it fails, avoiding errors.

Postman

// Helper to parse JSON safely
function safeJsonParse(text) {
  try {
    return JSON.parse(text);
  } catch (e) {
    return null;
  }
}

pm.test('Body parses as JSON', () => {
  const data = safeJsonParse(pm.response.text());
  pm.expect(data).to.not.be.null;
});

This helper checks if a specific field exists in the JSON response.

Postman

// Helper to check if a field exists in JSON response
function hasField(json, field) {
  return json && Object.prototype.hasOwnProperty.call(json, field);
}

pm.test('Response has userId field', () => {
  const json = pm.response.json();
  pm.expect(hasField(json, 'userId')).to.be.true;
});

Sample Program

This test script defines two helpers and uses them to check the response status and content type.

Postman

// Helper function to check if status code is 200
function isStatusOk(response) {
  return response.code === 200;
}

// Helper to check if response has JSON content type
function isJsonResponse(response) {
  return response.headers.get('Content-Type').includes('application/json');
}

// Test using helpers
pm.test('Status code is 200', () => {
  pm.expect(isStatusOk(pm.response)).to.be.true;
});

pm.test('Response is JSON', () => {
  pm.expect(isJsonResponse(pm.response)).to.be.true;
});

Important Notes

Helpers keep your test scripts clean and easy to read.

You can store helpers in Postman collections or environments for reuse.

Always test your helpers separately to make sure they work correctly.

Summary

Test utilities and helpers simplify writing and maintaining tests.

They help avoid repeating code and make tests easier to understand.

Use helpers to check common conditions and format data in your tests.