Integrating with Travis CI
Continuous Integration (CI) is a practice that requires developers to integrate code in a shared repository several times a day.
By committing early and often, the team avoids a ton of technical debt by allowing teams to detect problems early while conflicts are relatively easy to fix.
Every check-in triggers an automated build process that typically includes testing. And if your commit hasn’t broken anything, might include deployment too.
You will set up your CI configuration to run a shell command upon starting your build. The command is a Newman script that runs your collection with the tests, returning a pass or fail exit code that’s logged in your CI system.
In this example, we’ll walk through how to integrate Postman with Travis CI, a continuous integration service that builds and tests projects on GitHub.
Travis CI runs your tests every time you commit to your GitHub repo. Then it submits a pull request, or some other specified configuration.
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.
Let's learn more about integration with Travis:
Select a Postman collection with tests: For now, let’s assume you already have a Postman collection with tests. Download the sample collection and environment by clicking the Run in Postman button if you want to follow this example.
Set up a GitHub repository: Travis CI is free for open source projects on GitHub. This example keeps Postman tests in a public GitHub repo.
Set up Travis CI: Follow the Travis CI getting started guide for the complete walk through.
Sign in to Travis CI with your GitHub account.
Go to your profile page and enable Travis CI for the public GitHub repo set up in the previous step.
Export the Postman Collection as a JSON file and move the file to your project directory. If you’re using an environment such as this example, download the Postman environment as a JSON file and move the file to your project directory as well.
In this example, we've moved both files into a directory called
testsplaced in the root of the project repository.
Remember to add and commit these two files to your repo.
Create a new file called
.travis.ymland move it to the root of your project repository.
Remember to add and commit it to your repo. This file tells Travis CI the programming language for your project and how to build it.
Any step of the build can be customized. These scripts will execute the next time you commit and push a change to your repo.
.travis.ymlfile, add a command to
installNewman in the CI environment, and then add a
scripttelling Newman to run the Postman tests (which we've placed in the
Since Travis CI doesn’t know where Newman is located, let's update the
PATH. In this node.js example, the
newmantool is located in my
.bindirectory which is located in my
.travis.ymlfile looks like this for this
language: node_js node_js: - "8.2.1" install: - npm install newman before_script: - node --version - npm --version - node_modules/.bin/newman --version script: - node_modules/.bin/newman run tests/bitcoinz.postman_collection.json -e tests/tests.postman_environment.json
Travis CI is now set up to run your Postman tests every time you trigger a build, for example, by pushing a commit to your repo.
Let’s try it out. The Travis CI build status page will show if the build passes or fails:
Travis CI is running the Newman command, but you see a failed exit code (1). Boo.
Stay calm. Let’s review the logs in Travis CI. Newman ran the tests, you see the first and second tests passed, but the last test
Updated in the last day failed.
Let’s go back to the Postman collection and fix the
Updated in the last day test.
Once you fix the mistake in the test, let’s save the changes, update the repo with the latest collection file, and then trigger a Travis CI build once again by committing and pushing the change.
And it's working! All the tests passed and the command exited with a successful exit code (0).
For more information about collection runs, see: