Skip to content

Commit

Permalink
Merge pull request #139 from voxpupuli/modulesync
Browse files Browse the repository at this point in the history
modulesync 0.8.0
  • Loading branch information
Richard Pijnenburg authored Jun 14, 2016
2 parents eff3980 + b831b75 commit 0a4a8a1
Show file tree
Hide file tree
Showing 9 changed files with 689 additions and 85 deletions.
95 changes: 95 additions & 0 deletions .github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,95 @@
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

## 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.5 with.

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
at least need `BEAKER_PROVISION` set to yes (the default). The Vagrantfile
for the created virtual machines will be in `.vagrant/beaker_vagrant_fies`.
26 changes: 26 additions & 0 deletions .github/ISSUE_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
Please check the following items before submitting an issue -- thank you!

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/).

- [ ] There is no existing issue or PR that addresses this problem

Optional, but makes our lives much easier:

- [ ] The issue affects the latest release of this module at the time of
submission

- - -

### Affected Puppet, Ruby, OS and module versions/distributions

### What are you seeing

### What behaviour did you expect instead

### How did this behaviour get triggered

### Output log

### Any additional information you'd like to impart
33 changes: 33 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
Please check the following items before submitting a PR -- thank you!

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/).

- [ ] There is no existing PR that addresses this problem
- [ ] Mentioned any existing issues in your commit so they get linked and
closed once this PR gets merged, i.e: `Closes #1554` in the body of a commit
- [ ] Followed the instructions in the [Contributing](CONTRIBUTING.md) document
- [ ] Ran the unit/spec tests and ensured they still pass
- [ ] Added tests to cover the new behaviour
- [ ] Updated the documentation to match the changes
- [ ] When possible, add an entry to the CHANGELOG file
- [ ] Squashed your PR down to a single commit. You may forego this if the PR
tries to address multiple issues. Though we prefer one PR per feature/fix,
sometimes that's not feasible. In that case ensure that a single feature/fix
and associated tests and documentation is bundled up in one commit

Optional, but extra points:

- [ ] Added tests to ensure the old behaviour cannot accidentally be
reintroduced

- - -

<!--
Please provide further information about your PR.
It should contain all the necessary information for the maintainers to be
able to understand the issue at hand and the code behind fixing it.
PROVIDE THIS INFORMATION OUTSIDE OF THIS COMMENT BLOCK OR DELETE THIS BLOCK
-->
Loading

0 comments on commit 0a4a8a1

Please sign in to comment.