postman-formula
Formula to install Postman (and Newman) on GNU/Linux and MacOS.
Table of Contents
General notes
See the full SaltStack Formulas installation and usage instructions.
If you are interested in writing or contributing to formulas, please pay attention to the Writing Formula Section.
If you want to use this formula, please pay attention to the FORMULA
file and/or git tag
,
which contains the currently released version. This formula is versioned according to Semantic Versioning.
See Formula Versioning Section for more details.
Contributing to this repo
Commit message formatting is significant!!
Please see How to contribute for more details.
Available states
postman
Meta-state (This is a state that includes other states).
This installs Postman and Newman packages
postman.config
This state will install Postman environment file.
postman.archive
This state will install Postman from archive.
postman.newman
This state will install Newman using homebrew or npm.
postman.archive.clean
This state will remove Postman package archive.
postman.newman.clean
This state will remove Newman with npm or homebrew.
postman.config.clean
This state will remove the Postman environment file.
postman.clean
Meta-state (This is a state that includes other states).
this state will undo everything performed in the postman
meta-state in reverse order.
Testing
Linux testing is done with kitchen-salt
.
Requirements
- Ruby
- Docker
$ gem install bundler
$ bundle install
$ bin/kitchen test [platform]
Where [platform]
is the platform name defined in kitchen.yml
,
e.g. debian-9-2019-2-py3
.
bin/kitchen converge
Creates the docker instance and runs the postman
main state, ready for testing.
bin/kitchen verify
Runs the inspec
tests on the actual instance.
bin/kitchen destroy
Removes the docker instance.
bin/kitchen test
Runs all of the stages above in one go: i.e. destroy
+ converge
+ verify
+ destroy
.
bin/kitchen login
Gives you SSH access to the instance for manual testing.