forked from voxpupuli/puppet-prometheus
-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request voxpupuli#1 from voxpupuli/modulesync
modulesync 0.16.7
- Loading branch information
Showing
33 changed files
with
1,183 additions
and
92 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,100 @@ | ||
This module has grown over time based on a range of contributions from | ||
people using it. If you follow these contributing guidelines your patch | ||
will likely make it into a release a little quicker. | ||
|
||
## Contributing | ||
|
||
Please note that this project is released with a Contributor Code of Conduct. | ||
By participating in this project you agree to abide by its terms. | ||
[Contributor Code of Conduct](https://voxpupuli.org/coc/). | ||
|
||
1. Fork the repo. | ||
|
||
1. Create a separate branch for your change. | ||
|
||
1. Run the tests. We only take pull requests with passing tests, and | ||
documentation. | ||
|
||
1. Add a test for your change. Only refactoring and documentation | ||
changes require no new tests. If you are adding functionality | ||
or fixing a bug, please add a test. | ||
|
||
1. Squash your commits down into logical components. Make sure to rebase | ||
against the current master. | ||
|
||
1. Push the branch to your fork and submit a pull request. | ||
|
||
Please be prepared to repeat some of these steps as our contributors review | ||
your code. | ||
|
||
## Dependencies | ||
|
||
The testing and development tools have a bunch of dependencies, | ||
all managed by [bundler](http://bundler.io/) according to the | ||
[Puppet support matrix](http://docs.puppetlabs.com/guides/platforms.html#ruby-versions). | ||
|
||
By default the tests use a baseline version of Puppet. | ||
|
||
If you have Ruby 2.x or want a specific version of Puppet, | ||
you must set an environment variable such as: | ||
|
||
export PUPPET_VERSION="~> 4.2.0" | ||
|
||
Install the dependencies like so... | ||
|
||
bundle install | ||
|
||
## Syntax and style | ||
|
||
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 lint | ||
bundle exec rake validate | ||
|
||
It will also run some [Rubocop](http://batsov.com/rubocop/) tests | ||
against it. You can run those locally ahead of time with: | ||
|
||
bundle exec rake rubocop | ||
|
||
## 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 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 | ||
we want on a real machine. For that we're using | ||
[beaker](https://github.com/puppetlabs/beaker). | ||
|
||
This fires up a new virtual machine (using vagrant) and runs a series of | ||
simple tests against it after applying the module. You can run this | ||
with: | ||
|
||
bundle exec rake acceptance | ||
|
||
This will run the tests on an Ubuntu 12.04 virtual machine. You can also | ||
run the integration tests against Centos 6.6 with. | ||
|
||
BEAKER_set=centos-66-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 | ||
at least need `BEAKER_PROVISION` set to yes (the default). The Vagrantfile | ||
for the created virtual machines will be in `.vagrant/beaker_vagrant_fies`. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,26 @@ | ||
<!-- | ||
Thank you for contributing to this project! | ||
- This project has a Contributor Code of Conduct: https://voxpupuli.org/coc/ | ||
- Please check that here is no existing issue or PR that addresses your problem. | ||
- Please fill the following form to enable us to help you. | ||
- Our vulnerabilities reporting process is at https://voxpupuli.org/security/ | ||
--> | ||
|
||
## Affected Puppet, Ruby, OS and module versions/distributions | ||
|
||
- Puppet: | ||
- Ruby: | ||
- Distribution: | ||
- Module version: | ||
|
||
## How to reproduce (e.g Puppet code you use) | ||
|
||
## What are you seeing | ||
|
||
## What behaviour did you expect instead | ||
|
||
## Output log | ||
|
||
## Any additional information you'd like to impart |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,8 @@ | ||
<!-- | ||
Thank you for contributing to this project! | ||
- This project has a Contributor Code of Conduct: https://voxpupuli.org/coc/ | ||
- Please check that here is no existing issue or PR that addresses your problem. | ||
- Our vulnerabilities reporting process is at https://voxpupuli.org/security/ | ||
--> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,2 +1,15 @@ | ||
pkg/ | ||
Gemfile.lock | ||
spec/fixtures/modules/* | ||
Gemfile.local | ||
vendor/ | ||
.vendor/ | ||
spec/fixtures/manifests/ | ||
spec/fixtures/modules/ | ||
.vagrant/ | ||
.bundle/ | ||
coverage/ | ||
log/ | ||
.idea/ | ||
*.iml | ||
.*.sw? | ||
.yardoc/ |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
modulesync_config_version: '0.16.7' |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,2 @@ | ||
--format documentation | ||
--color |
Oops, something went wrong.