Test utilities and helpers in Postman - Cheat Sheet & Quick Revision

Recall & Review

beginner

What are test utilities and helpers in Postman?

Test utilities and helpers are reusable scripts or functions that simplify writing tests by handling common tasks like data setup, assertions, or cleanup.

intermediate

How can you reuse test helper functions across multiple Postman requests?

You can define helper functions in the Postman Pre-request Script or Tests tab and save them in the Collection Scripts to reuse across requests in the collection.

beginner

Why use test utilities instead of writing assertions directly in each test?

Using utilities reduces repeated code, makes tests easier to maintain, and helps keep tests consistent and clear.

intermediate

Example: What does this Postman test helper do?
<pre>function checkStatus200() {
  pm.test('Status is 200', () => {
    pm.response.to.have.status(200);
  });
}</pre>

This helper function runs a test to check if the HTTP response status code is 200 (OK). You can call checkStatus200() in your tests to reuse this check.

intermediate

Where can you store common test utilities in Postman for easy access?

You can store common utilities in the Collection Scripts under the Pre-request Script or Tests tabs at the collection level, so all requests inherit them.

What is the main benefit of using test helpers in Postman?

A To make tests harder to read

B To avoid repeating code and simplify tests

C To slow down test execution

D To increase manual testing

Test helpers help avoid repeating code and make tests simpler and easier to maintain.

Where can you define test utilities to reuse them across all requests in a Postman collection?

A In the Postman console

B Only inside individual requests

C In the Postman environment variables

D In the Collection Scripts tab

Defining utilities in the Collection Scripts tab allows reuse across all requests in that collection.

Which Postman object is commonly used inside test helpers to access the response?

A pm.response

B pm.request

C pm.environment

D pm.collection

pm.response gives access to the HTTP response and is used in test helpers to assert response data.

What does this helper function check?

function checkJsonKey(key) {
  pm.test(`Response has key ${key}`, () => {
    pm.expect(pm.response.json()).to.have.property(key);
  });
}

A If the response JSON contains a specific key

B If the response status is 404

C If the request has a header

D If the response time is less than 1 second

This helper tests if the JSON response includes the given key.

Why is it good to keep test utilities small and focused?

A To confuse other testers

B To make tests run slower

C To make them easier to understand and reuse

D To increase code duplication

Small focused utilities are easier to understand, maintain, and reuse.

Explain how you would create and reuse a test helper function in Postman to check if a response status is 200.

Think about where to put reusable code and how to call it in tests.

Describe the advantages of using test utilities and helpers in your Postman API tests.

Consider how helpers affect code quality and testing speed.

Practice

1. What is the main purpose of using test utilities and helpers in Postman tests?

easy

A. To increase the number of test cases automatically

B. To make API requests faster

C. To simplify writing and maintaining tests by reusing code

D. To change the API endpoint dynamically

Solution

1. Step 1: Understand the role of helpers

   Helpers are small reusable functions that simplify test code and avoid repetition.

2. Step 2: Identify the main benefit

   They make tests easier to write and maintain by reusing common logic.

3. Final Answer:

   To simplify writing and maintaining tests by reusing code -> Option C

4. Quick Check:

   Helpers simplify tests = A [OK]

Hint: Helpers reduce repeated code in tests [OK]

Common Mistakes:

• Thinking helpers speed up API requests
• Believing helpers create more test cases automatically
• Confusing helpers with dynamic endpoint changes

2. Which of the following is the correct way to define a helper function in Postman test scripts?

easy

A. checkStatus(response) => response.status == 200

B. def checkStatus(response): return response.code == 200

C. var checkStatus = response => { response.code = 200 }

D. function checkStatus(response) { return response.code === 200; }

Solution

1. Step 1: Identify JavaScript syntax in Postman

   Postman test scripts use JavaScript, so function keyword is correct.

2. Step 2: Check function correctness

   function checkStatus(response) { return response.code === 200; } defines a function that returns true if response.code equals 200, which is valid.

3. Final Answer:

   function checkStatus(response) { return response.code === 200; } -> Option D

4. Quick Check:

   JavaScript function syntax = C [OK]

Hint: Use JavaScript function keyword for helpers [OK]

Common Mistakes:

• Using Python syntax in Postman scripts
• Using arrow function but with assignment errors
• Using single equals instead of triple equals

3. Given the helper function below, what will be the output of pm.test('Check status', () => { pm.expect(isSuccess({code: 200})).to.be.true; });?

function isSuccess(response) {
  return response.code === 200;
}

medium

A. Test passes because response code is 200

B. Test fails because response code is not 200

C. Syntax error in helper function

D. Runtime error due to undefined response

Solution

1. Step 1: Analyze helper function behavior

   The function returns true if response.code equals 200, which it does here.

2. Step 2: Evaluate test assertion

   The test expects isSuccess to be true, so the assertion passes.

3. Final Answer:

   Test passes because response code is 200 -> Option A

4. Quick Check:

   response.code === 200 -> true -> test passes [OK]

Hint: Check helper return value matches assertion [OK]

Common Mistakes:

• Assuming test fails without checking code value
• Confusing syntax error with correct JavaScript
• Thinking response is undefined when it is provided

4. You wrote this helper function in Postman tests but it throws an error:

function isValid(response) {
  return response.status = 200;
}

What is the error and how to fix it?

medium

A. Use '===' instead of '=' for comparison in return statement

B. Change function to arrow syntax

C. Remove the return keyword

D. Rename function to start with uppercase letter

Solution

1. Step 1: Identify assignment vs comparison

   The code uses '=' which assigns value instead of comparing.

2. Step 2: Correct the operator

   Replace '=' with '===' to compare response.status to 200.

3. Final Answer:

   Use '===' instead of '=' for comparison in return statement -> Option A

4. Quick Check:

   Comparison needs '===' not '=' [OK]

Hint: Use triple equals for comparisons in helpers [OK]

Common Mistakes:

• Confusing assignment '=' with comparison '==='
• Thinking arrow function fixes this error
• Removing return breaks function output

5. You want to create a helper that checks if a JSON response has a non-empty data array. Which helper function below correctly implements this check?

hard

A. function hasData(response) { return response.data == undefined; }

B. function hasData(response) { return Array.isArray(response.data) && response.data.length > 0; }

C. function hasData(response) { return response.data !== null; }

D. function hasData(response) { return response.data.length >= 0; }

Solution

1. Step 1: Check if response.data is an array

   Use Array.isArray to confirm data is an array.

2. Step 2: Verify array is not empty

   Check that length is greater than zero to ensure non-empty.

3. Final Answer:

   function hasData(response) { return Array.isArray(response.data) && response.data.length > 0; } -> Option B

4. Quick Check:

   Array check + length > 0 = D [OK]

Hint: Check array type and length > 0 for non-empty data [OK]

Common Mistakes:

• Only checking length without confirming array type
• Checking for null but ignoring empty arrays
• Using == undefined which is incorrect here