summaryrefslogtreecommitdiff
path: root/CONTRIBUTING.md
diff options
context:
space:
mode:
Diffstat (limited to 'CONTRIBUTING.md')
-rw-r--r--CONTRIBUTING.md19
1 files changed, 15 insertions, 4 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index 1ccfba6..00deb27 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -49,18 +49,29 @@ The test suite will run [Puppet Lint](http://puppet-lint.com/) and
[Puppet Syntax](https://github.com/gds-operations/puppet-syntax) to
check various syntax and style things. You can run these locally with:
- bundle exec rake test
+ bundle exec rake lint
+ bundle exec rake validate
## Running the unit tests
The unit test suite covers most of the code, as mentioned above please
add tests if you're adding new functionality. If you've not used
[rspec-puppet](http://rspec-puppet.com/) before then feel free to ask
-about how best to test your new feature. To run your specific spec test
-you can pass it to `SPEC`:
+about how best to test your new feature.
+
+To run your all the unit tests
+
+ bundle exec rake spec SPEC_OPTS='--format documentation'
+
+To run a specific spec test set the `SPEC` variable:
bundle exec rake spec SPEC=spec/foo_spec.rb
+To run the linter, the syntax checker and the unit tests:
+
+ bundle exec rake test
+
+
## Integration tests
The unit tests just check the code runs, not that it does exactly what
@@ -76,7 +87,7 @@ with:
This will run the tests on an Ubuntu 12.04 virtual machine. You can also
run the integration tests against Centos 6.5 with.
- RS_SET=centos-64-x64 bundle exec rake acceptances
+ BEAKER_set=centos-64-x64 bundle exec rake acceptances
If you don't want to have to recreate the virtual machine every time you
can use `BEAKER_DESTROY=no` and `BEAKER_PROVISION=no`. On the first run you will