Integrating with Travis CI

Continuous Integration (CI) is a development practice that encourages developers to regularly commit their code changes to a shared repository, usually several times a day. Committing early and often helps the team avoid technical debt and detect problems quickly, when conflicts are still relatively easy to fix.

With CI, every code commit triggers an automated process that builds the code and runs tests. The process can even deploy the updated code if all checks pass, a practice referred to as Continuous Delivery (CD).

Developing an API? Postman offers built-in tools to integrate your API with some of the most widely-used Continuous Integration (CI) tools, including Travis CI. After you set up CI integration for your API, you can view the status of builds or kick off a new build, all from within Postman. You can also use Newman to run API tests as part of your CI pipeline. To learn more, see CI integrations.

Running Postman tests with Travis CI

In general, integrating your Postman tests with Travis CI is the same process as running on Jenkins, AppVeyor, or any other build system. You will set up your CI configuration to run a shell command when starting your build. The command is a Newman script that runs the collection containing the tests and returns a pass or fail exit code that’s logged in your CI system.

This example shows you how to integrate Postman with Travis CI, a continuous integration platform that development teams use to automatically build and test code changes. When you're finished, Travis CI will run your tests every time you make a commit to your GitHub repo.

travis workflow

Getting started

  1. Choose the Postman collection with your tests. In most cases, you'll already have a Postman collection with your tests. For this example, you can import a sample "Hello World" collection into your workspace by selecting the Run in Postman button below.

    Run in Postman

  2. Set up a GitHub repository. Travis CI is free for open source projects on GitHub. For this example, you'll store the collection with your Postman tests in a public GitHub repository. Create a new public repo on GitHub and clone the project to your local system.

  3. Set up Travis CI: Follow the Travis CI getting started guide for a complete walk through. You will need to sign in to Travis CI and activate Travis CI integration for your new public GitHub repo.

Connecting Postman to Travis CI

  1. Export the "Hello World" collection as a JSON file and rename the exported file hello_world.postman_collection.json.

  2. Create a folder named tests at the root of your local project, and move the exported JSON file into the new tests folder.

    .
    └── tests
        └── hello_world.postman_collection.json

    If your collection uses an environment, you should also export the environment as a JSON file and move it to the tests folder.

  3. Create a new file named .travis.yml at the root of your project repository. You'll use this file to tell Travis CI the programming language for your project and how to build it.

    .
    ├── .travis.yml
    └── tests
        └── hello_world.postman_collection.json

    Any step of the build process can be customized. The scripts in the .travis.ymlfile will execute the next time you commit and push a change to your repo.

  4. In the .travis.yml file, add a command to install Newman in the CI environment, and then add a script telling Newman to run the Postman tests (which you placed in the tests folder).

    Because Travis CI doesn’t know where Newman is located, you need to update the PATH. In this example, the newman tool is located in the .bin folder which is in the node_modules folder.

    For this example, your .travis.yml file should look like the following:

    language: node_js
    node_js:
    - "16.13.2"
    
    install:
    - npm install newman
    
    before_script:
    - node --version
    - npm --version
    - node_modules/.bin/newman --version
    
    script:
    - node_modules/.bin/newman run tests/hello_world.postman_collection.json

    Note that if you exported an environment, you need to add it to the script as well:

    script:
    - node_modules/.bin/newman run tests/hello_world.postman_collection.json -e tests/tests.postman_environment.json
  5. Commit all the changes to your local project and push them to your public GitHub repo.

    Travis CI will automatically trigger a build and run your tests every time you push a commit to your repo. Navigate to the Travis CI dashboard to see the status of your build. If all went well, your build passed successfully.

    Travis CI build successful

Fixing test failures

To see what things look like when a test fails, make a change in your imported "Hello Word" collection in Postman so that one of the test breaks.

  1. Open the collection, select the "Hello World" request, and then select the Tests tab.

  2. Change the final test so that it looks for the text "Hello, Everyone!" instead of "Hello, World!"

    Tests tab error

  3. Save the change and then export the collection again. As before, rename the exported file hello_world.postman_collection.json and move it into the tests directory in your local project.

  4. Commit and push the change to your public GitHub repo. This will trigger a new build in Travis CI, and this time the build should fail.

    Travis CI build failed

  5. Select the failed build link to view the build logs in Travis CI. Looking at the logs, you can see that the assertion failed. If this was your own collection, you could use the error message to help understand why the test failed and debug the problem.

    Travis CI error log

  6. For this example, if you want, you can correct the error in the test in Postman and export the collection again. As before, rename the JSON file, add it to the tests folder in your local project, then commit and push. This time your build in Travis CI should be successful.

Next Steps

For more information about collection runs, see the following topics.

Last modified: 2022/01/18