Skip to content

saltstack-formulas/charles-formula

Repository files navigation

charles-formula

Travis CI Build Status Semantic Release

Formula to install Charles (Proxy) on GNU/Linux and MacOS.

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.

Commit message formatting is significant!!

Please see How to contribute for more details.

Meta-state (This is a state that includes other states).

This installs Charles (Proxy) packages

This state will install Charles (Proxy) environment file.

This state will install Charles (Proxy) from archive.

This state will install Charles (Proxy) package on Debian, RedHat, and MacOS.

This state will install Charles (Proxy) macpackage (not fully implemented)

This state will remove Charles (Proxy) package archive.

This state will remove Charles (Proxy) macpackage archive.

This state will remove Charles (Proxy) using deb/yum or homebrew.

This state will remove the Charles (Proxy) environment file.

Meta-state (This is a state that includes other states).

this state will undo everything performed in the charles meta-state in reverse order.

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 charles 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.