Setting variables in scripts in Postman - Framework Patterns

Framework Mode - Setting variables in scripts

Folder Structure for Postman Test Automation

PostmanProject/
├── collections/
│   └── MyAPICollection.postman_collection.json
├── environments/
│   ├── dev.postman_environment.json
│   ├── staging.postman_environment.json
│   └── prod.postman_environment.json
├── scripts/
│   ├── pre-request-scripts/
│   │   └── setVariables.js
│   └── test-scripts/
│       └── validateResponse.js
├── globals.json
└── README.md

Test Framework Layers in Postman

• Collections: Group of API requests organized logically.
• Environments: Store variables for different deployment stages (dev, staging, prod).
• Scripts:
  • Pre-request scripts: Run before requests to set or update variables.
  • Test scripts: Run after requests to validate responses and set variables.
• Globals: Variables accessible across all collections and environments.
• Utilities: Reusable JavaScript functions for common tasks (can be included via external files or snippets).

Configuration Patterns for Variables in Postman

• Environment Variables: Define variables per environment (e.g., base URL, tokens). Switch environments to run tests in different contexts.
• Global Variables: Use for values shared across all environments and collections.
• Setting Variables in Scripts:

  pm.environment.set("variableName", "value");
  pm.globals.set("variableName", "value");
  pm.variables.set("variableName", "value");

  Use pm.variables for temporary variables valid only during the request execution.
• Clearing Variables: Remove variables when no longer needed:

  pm.environment.unset("variableName");

• Secure Variables: Store sensitive data in environment variables, not in collections.

Test Reporting and CI/CD Integration

• Newman CLI: Run Postman collections from command line for automation.
• Reports: Generate HTML, JSON, or JUnit reports using Newman reporters.
• CI/CD Integration: Integrate Newman runs in pipelines (Jenkins, GitHub Actions, GitLab CI) to run tests on code changes.
• Variable Management: Use environment files and secure storage in CI to manage variables safely.

Best Practices for Setting Variables in Postman Scripts

1. Use Environment Variables for Configurable Data: Keep URLs, tokens, and credentials in environment variables to easily switch contexts.
2. Set Variables Explicitly in Scripts: Use pm.environment.set() or pm.variables.set() to update variables clearly and predictably.
3. Clear Variables When Done: Remove temporary variables to avoid stale data affecting other tests.
4. Keep Sensitive Data Secure: Never hardcode secrets in scripts; use environment variables with restricted access.
5. Use Globals Sparingly: Prefer environment variables over globals to avoid unintended side effects.

Self Check

Where in this folder structure would you add a new script to set a variable before sending a request?

Key Result

Organize Postman tests with collections, environments, and scripts to manage variables clearly and securely.

Practice

1. What is the purpose of using pm.variables.set in Postman scripts?

easy

A. To store a value in a local variable for later use within the same request

B. To send a request to the server

C. To delete a variable from the environment

D. To log information to the console

Solution

1. Step 1: Understand the function of pm.variables.set

   This function stores a value in a local variable that can be used later in the same request or script.

2. Step 2: Differentiate from other actions

   Sending requests, deleting variables, or logging are done by other methods, not pm.variables.set.

3. Final Answer:

   To store a value in a local variable for later use within the same request -> Option A

4. Quick Check:

   pm.variables.set stores local variables [OK]

Hint: Remember: set means save value locally in script [OK]

Common Mistakes:

• Confusing variable setting with sending requests
• Thinking it deletes variables
• Assuming it logs output

2. Which of the following is the correct syntax to set a variable named token with value abc123 in a Postman test script?

easy

A. pm.variables.set['token', 'abc123'];

B. pm.variables.set(token, 'abc123');

C. pm.variables.set('token' = 'abc123');

D. pm.variables.set('token', 'abc123');

Solution

1. Step 1: Check the correct method signature

   The correct syntax uses pm.variables.set('variableName', 'value'); with the variable name as a string and value as the second argument.

2. Step 2: Identify syntax errors in other options

   pm.variables.set(token, 'abc123'); misses quotes around the variable name. pm.variables.set('token' = 'abc123'); uses an invalid assignment inside the method. pm.variables.set['token', 'abc123']; uses incorrect bracket notation.

3. Final Answer:

   pm.variables.set('token', 'abc123'); -> Option D

4. Quick Check:

   Use quotes for variable name in pm.variables.set [OK]

Hint: Variable names must be strings in quotes [OK]

Common Mistakes:

• Omitting quotes around variable names
• Using assignment inside set method
• Using wrong brackets for method call

3. Consider this Postman test script snippet:

pm.variables.set('userId', 42);
const id = pm.variables.get('userId');
console.log(id);

What will be printed in the Postman console?

medium

A. 42

B. undefined

C. '42'

D. null

Solution

1. Step 1: Understand variable setting and getting

   The script sets 'userId' to the number 42, then retrieves it with pm.variables.get.

2. Step 2: Check the console output

   The retrieved value is 42 (a number), so console.log(id); prints 42 without quotes.

3. Final Answer:

   42 -> Option A

4. Quick Check:

   Set and get return the same stored value [OK]

Hint: Get returns exactly what was set, including type [OK]

Common Mistakes:

• Assuming get returns string always
• Expecting undefined if variable not set
• Confusing quotes in console output

4. You wrote this Postman script:

pm.variables.set('session', 'abc');
pm.variables.get('session');

But the variable session is not accessible in later requests. What is the likely problem?

medium

A. You must call pm.variables.save() to save variables

B. You should use pm.environment.set to make it accessible across requests

C. Variable names cannot be strings

D. You need to restart Postman to apply changes

Solution

1. Step 1: Understand variable scopes in Postman

   pm.variables.set sets a local variable only for the current script execution, not across requests.

2. Step 2: Use environment variables for persistence

   To keep variables accessible across requests, use pm.environment.set instead.

3. Final Answer:

   You should use pm.environment.set to make it accessible across requests -> Option B

4. Quick Check:

   Local variables are temporary; environment variables persist [OK]

Hint: Use environment.set for cross-request variables [OK]

Common Mistakes:

• Expecting pm.variables.set to persist across requests
• Thinking a save method is needed
• Believing variable names can't be strings

5. You want to set a variable authToken in a Pre-request Script that depends on the response of a previous request stored in pm.response.json(). Which approach correctly sets authToken for use in the next request?

hard

A. Use pm.variables.set('authToken', pm.response.json().token); in the Pre-request Script

B. Use pm.environment.set('authToken', pm.response.json().token); in the Pre-request Script

C. Use pm.environment.set('authToken', pm.response.json().token); in the Tests script of the previous request

D. Use pm.variables.set('authToken', pm.response.json().token); in the Tests script of the previous request

Solution

1. Step 1: Identify when response data is available

   The response data from pm.response.json() is only available in the Tests script after the request completes, not in the Pre-request Script.

2. Step 2: Set variable for next request

   To use authToken in the next request, set it as an environment variable in the Tests script of the current request using pm.environment.set.

3. Step 3: Why not local variables?

   Local variables set with pm.variables.set do not persist across requests, so they won't be available in the next request.

4. Final Answer:

   Use pm.environment.set('authToken', pm.response.json().token); in the Tests script of the previous request -> Option C

5. Quick Check:

   Set environment variables in Tests to share data between requests [OK]

Hint: Set environment vars in Tests script to share between requests [OK]

Common Mistakes:

• Trying to access response in Pre-request Script
• Using pm.variables.set for cross-request data
• Setting variables in wrong script phase