Skip to content

Latest commit

 

History

History
199 lines (140 loc) · 5.89 KB

CONTRIBUTING.md

File metadata and controls

199 lines (140 loc) · 5.89 KB
Raw

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 more quickly.

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.

  1. Fork the repo.

  2. Create a separate branch for your change.

  3. We only take pull requests with passing tests, and documentation. travis-ci runs the tests for us. You can also execute them locally. This is explained in a later section.

  4. Checkout our docs we use to review a module and the official styleguide. They provide some guidance for new code that might help you before you submit a pull request.

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

  6. Squash your commits down into logical components. Make sure to rebase against our current master.

  7. 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 according to the Puppet support matrix.

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="~> 5.5.6"

You can install all needed gems for spec tests into the modules directory by running:

bundle install --path .vendor/ --without development system_tests release --jobs "$(nproc)"

If you also want to run acceptance tests:

bundle install --path .vendor/ --with system_tests --without development release --jobs "$(nproc)"

Our all in one solution if you don't know if you need to install or update gems:

bundle install --path .vendor/ --with system_tests --without development release --jobs "$(nproc)"; bundle update; bundle clean

As an alternative to the --jobs "$(nproc) parameter, you can set an environment variable:

BUNDLE_JOBS="$(nproc)"

Note for OS X users

nproc isn't a valid command unter OS x. As an alternative, you can do:

--jobs "$(sysctl -n hw.ncpu)"

Syntax and style

The test suite will run Puppet Lint and 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 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 before then feel free to ask about how best to test your new feature.

To run the linter, the syntax checker and the unit tests:

bundle exec rake test

To run your all the unit tests

bundle exec rake spec

To run a specific spec test set the SPEC variable:

bundle exec rake spec SPEC=spec/foo_spec.rb

Unit tests in docker

Some people don't want to run the dependencies locally or don't want to install ruby. We ship a Dockerfile that enables you to run all unit tests and linting. You only need to run:

docker build .

Please ensure that a docker daemon is running and that your user has the permission to talk to it. You can specify a remote docker host by setting the DOCKER_HOST environment variable. it will copy the content of the module into the docker image. So it will not work if a Gemfile.lock exists.

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.

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 the module's default nodeset. You can override the nodeset used, e.g.,

BEAKER_set=centos-7-x64 bundle exec rake acceptance

There are default rake tasks for the various acceptance test modules, e.g.,

bundle exec rake beaker:centos-7-x64
bundle exec rake beaker:ssh:centos-7-x64

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_files.

Beaker also supports docker containers. We also use that in our automated CI pipeline at travis-ci. To use that instead of Vagrant:

PUPPET_INSTALL_TYPE=agent BEAKER_IS_PE=no BEAKER_PUPPET_COLLECTION=puppet5 BEAKER_debug=true BEAKER_setfile=debian9-64{hypervisor=docker} BEAKER_destroy=yes bundle exec rake beaker

You can replace the string debian9 with any common operating system. The following strings are known to work:

  • ubuntu1604
  • ubuntu1804
  • debian8
  • debian9
  • centos6
  • centos7

The easiest way to debug in a docker container is to open a shell:

docker exec -it -u root ${container_id_or_name} bash

The source of this file is in our modulesync_config repository.