README.md in puppet-check-1.6.1 vs README.md in puppet-check-2.0.0

- old
+ new

@@ -129,11 +129,10 @@ ### CLI ``` usage: puppet-check [options] paths --version Display the current version. - -f, --future Enable future parser --fail-on-warnings Fail on warnings -s, --style Enable style checks --smoke Enable smoke testing -r, --regression Enable regression testing (in progress, do not use) --public cert.pem Public key for EYAML checks @@ -146,11 +145,11 @@ Arguments for PuppetLint ignored checks -c, --config file Load PuppetLint options from file --rubocop arg_one,arg_two Arguments for Rubocop disabled cops ``` -The command line interface enables the ability to select the Puppet future parser, additional style checks besides the syntax checks, and to specify PuppetLint and Rubocop checks to ignore. If you require a more robust interface to PuppetLint, Rubocop, and Reek, then please use `.puppet-lint.rc`, `.rubocop.yml` and `*.reek` config files. The `.puppet-lint.rc` can be specified with the `-c` argument. If it is not specified, then PuppetLint will automatically load one from `.puppet-lint.rc`, `~/.puppet-lint.rc`, or `/etc/puppet-lint.rc`, in that order of preference. The nearest `.rubocop.yml` and `*.reek` will be automatically respected. +The command line interface enables the ability to select additional style checks besides the syntax checks, and to specify PuppetLint and Rubocop checks to ignore. If you require a more robust interface to PuppetLint, Rubocop, and Reek, then please use `.puppet-lint.rc`, `.rubocop.yml` and `*.reek` config files. The `.puppet-lint.rc` can be specified with the `-c` argument. If it is not specified, then PuppetLint will automatically load one from `.puppet-lint.rc`, `~/.puppet-lint.rc`, or `/etc/puppet-lint.rc`, in that order of preference. The nearest `.rubocop.yml` and `*.reek` will be automatically respected. Example: ``` puppet-check -s --puppet-lint no-hard_tabs-check,no-140chars-check --rubocop Metrics/LineLength,Style/Encoding -o yaml path/to/code_and_data ``` @@ -165,19 +164,18 @@ rake puppetcheck:beaker # Execute Beaker acceptance tests rake puppetcheck:kitchen:* # Execute Test Kitchen acceptance tests ``` #### puppetcheck:file -You can add style, smoke, and regression checks to and select the future parser for the `rake puppetcheck:file`, or change the output format, by adding the following after the require: +You can add style, smoke, and regression checks to the `rake puppetcheck:file`, or change the output format, by adding the following after the require: ```ruby # example of modifying Puppet Check behavior -PuppetCheck.settings[:style_check] = true +PuppetCheck.settings[:style] = true PuppetCheck.settings[:fail_on_warnings] = true -PuppetCheck.settings[:future_parser] = true -PuppetCheck.settings[:smoke_check] = true -PuppetCheck.settings[:regression_check] = true # in progress, do not use +PuppetCheck.settings[:smoke] = true +PuppetCheck.settings[:regression] = true # in progress, do not use PuppetCheck.settings[:public] = 'public.pem' PuppetCheck.settings[:private] = 'private.pem' PuppetCheck.settings[:output_format] = 'yaml' PuppetCheck.settings[:octoconfig] = '.octocatalog-diff.cfg.rb' PuppetCheck.settings[:octonodes] = %w(localhost.localdomain) @@ -254,15 +252,14 @@ ```ruby # file checks require 'puppet-check' settings = {} -settings[:future_parser] = true # default false settings[:fail_on_warnings] = true # default false -settings[:style_check] = true # default false -settings[:smoke_check] = true # default false -settings[:regression_check] = true # in progress, do not use; default false +settings[:style] = true # default false +settings[:smoke] = true # default false +settings[:regression] = true # in progress, do not use; default false settings[:public] = 'public.pem' # default nil settings[:private] = 'private.pem' # default nil settings[:output_format] = 'yaml' # also 'json'; default 'text' settings[:octoconfig] = '$HOME/octocatalog-diff.cfg.rb' # default '.octocatalog-diff.cfg.rb' settings[:octonodes] = %w(server.example.com) # default: %w(localhost.localdomain) @@ -298,9 +295,11 @@ # execute your tests; in this example we are executing the full suite of tests ENTRYPOINT ["rake", "puppetcheck"] ``` You can also build your own general container for testing various Puppet situations by removing the last three lines. You can then test each module, directory environment, etc. on top of that container by merely adding and modifying the final three lines to a Dockerfile that uses the container you built from the first four lines. This is recommended usage due to being very efficient and stable. + +As an alternative to copying Puppet code and data into the image for testing, it is also recommended to bind volume mount the container to the directory with your Puppet code and data. ### Vagrant As an alternative to Docker, you can also use Vagrant for quick and disposable testing, but it is not as portable as Docker for these testing purposes. Below is an example Vagrantfile for this purpose.