Next-Level Testing: Automating Postman with Jenkins

Are you looking to optimize your API testing process? I'd like you to learn how to integrate your Postman tests with Jenkins using Newman, ensuring efficient and reliable testing in your CI/CD pipeline.

Postman's powerful testing environment lets you create and run tests for your API using JavaScript. With Newman, Postman's command-line tool, you can easily combine API tests with your CI/CD setup.

Here's a step-by-step guide to setting up a Jenkins build that leverages Newman to execute your Postman collection:

Installation Process:

To install:

1. Set up Jenkins on your computer. For more information, see the Jenkins documentation at https://www.jenkins.io.
2. Get Node.js and Newman in Jenkins:

• Go to your Jenkins server (it's at https://localhost:8080 by default if you are running it locally) and sign in.
• Go to Manage Jenkins > Manage Plugins and install the NodeJS plugin.
• Go to Manage Jenkins > Global Tool Configuration and under NodeJS, select Add NodeJS.
• Enter a name for the Node.js installation.
• In Global npm packages to install, enter Newman.
• Select Save.

Create a Postman Collection

Import a sample "Hello World" collection into your workspace using the provided "Run in Postman" button. Customize the collection by adding requests with tests. To simulate troubleshooting, intentionally break a test within the collection.

Set up Jenkins

• Access Jenkins and create a new Freestyle project.

• Configure the project to execute a shell command using Newman to run your Postman collection. Enter a shell command to run, such as

newman run ~/Desktop/jenkins_demo_postman_collection.json.        

• Ensure Node & npm bin/ folder is provided to PATH in the Build Environment settings, selecting the NodeJS installation configured with Newman.
• Select Save to finish creating the project.

Troubleshooting

1. Run this build test manually by selecting Build Now in the sidebar.

Jenkins indicates that the build has failed with a red cross next to the build in the build history. This is because of the intentionally failed tests in the collection.

2. Select the build in the history list, then select Console Output to inspect what Newman returned.

3. Fix these tests inside your collection. Export it and then run the build again.

Jenkins indicates that the build succeeded with a green checkmark.

Configure Frequency of Runs

Customize the frequency of Jenkins builds by configuring build triggers under Build Triggers. Specify the desired schedule using Jenkins' syntax, ensuring regular execution of Newman tests.

1. Open the build window.
2. Select Configure.
3. Go to Build Triggers and select Build periodically.
4. Enter a schedule. The syntax for setting the frequency to every 30 minutes is H/(30) * * * *.
5. Select Save.

In a real-world scenario, Newman becomes an integral part of your production environment. Customize Jenkins notifications and explore various configurations to enhance the dynamism of your Postman collection testing.

By seamlessly integrating Postman tests with Jenkins using Newman, you streamline your testing workflow, ensuring the reliability and efficiency of your API testing process. Start optimizing your CI/CD pipeline today!