Skip to content
This repository was archived by the owner on Nov 2, 2019. It is now read-only.

Commit

Permalink
Merge pull request #11 from miroswan/fix/documentation
Browse files Browse the repository at this point in the history
Updating the documentation
  • Loading branch information
miroswan authored Aug 10, 2016
2 parents 278a310 + e6fc0bf commit e0b6d58
Show file tree
Hide file tree
Showing 3 changed files with 11 additions and 12 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ distributed systems. vagrant-serverspec has similar pitfalls.
* vagrant_spec allows you to leverage your deployment tools just like you would
in staging and production. It generates an ansible inventory file after all
nodes are brought up. This allows you to run the same ansible_playbook commands
against the local node set as you would elsewhere.
against the Vagrant node set as you would elsewhere.

* routing tests to nodes is flexible and simple.

Expand Down
12 changes: 6 additions & 6 deletions lib/vagrant_spec/templates/init_help
Original file line number Diff line number Diff line change
@@ -1,16 +1,16 @@
The init subcommand initializes state-based configuration for vagrant_spec.

It creates a spec_helper.rb file under the configured serverspec directory. This
file is used to setup serverspec backend configuration and ease serverspec
It creates a spec_helper.rb file under the configured ServerSpec directory. This
file is used to setup ServerSpec backend configuration and ease ServerSpec
testing.

If config.spec.ansible_inventory configuration directive is used within the
If the config.spec.ansible_inventory configuration directive is used within the
Vagrantfile, then init will generate a test inventory file
vagrantspec_inventory. This file can be used for ansible orchestration against
the vagrant instances.
the Vagrant instances.

By default, init will generate a json file containing machine data for each
vagrant instance at .vagrantspec_machine_data. This file can be used by
orchestration tooling outside of ansible to map events to vagrant nodes. The
Vagrant instance at .vagrantspec_machine_data. This file can be used by
orchestration tooling aside from ansible to map events to vagrant nodes. The
config.spec.generate_machine_data configuration parameter controls the
generation of this file.
9 changes: 4 additions & 5 deletions lib/vagrant_spec/templates/test_help
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
The test subcommand will execute the serverspec tests configured in the
The test sub-command will execute the ServerSpec tests configured in the
Vagrantfile under the config.spec.test_plan directive. This directive accepts
an array of hashes. For example:

Expand All @@ -13,9 +13,8 @@ config.spec.test_plan = [
}
]

Each hash have two required keys: nodes and flags. The nodes key accepts a
regular expression object matching the names of the vagrant machines defined in
Each hash has two required keys: nodes and flags. The nodes key accepts a
regular expression object matching the names of the Vagrant machines defined in
the Vagrantfile. Alternatively, you can explicility pass an array of node names.
The flags key accepts a string of command line arguments to pass to rspec. Any
of the acceptable rspec options and parameters are leagle.

of the acceptable rspec options and parameters are legal.

0 comments on commit e0b6d58

Please sign in to comment.