How to contribute
Third-party patches are essential for keeping puppet great. We simply can’t access the huge number of platforms and myriad configurations for running puppet. We want to keep it as easy as possible to contribute changes that get things working in your environment. There are a few guidelines that we need contributors to follow so that we can have a chance of keeping on top of things.
- Make sure you have a Jira account
- Make sure you have a GitHub account
- Submit a ticket for your issue, assuming one does not already exist.
- Clearly describe the issue including steps to reproduce when it is a bug.
- Make sure you fill in the earliest version that you know has the issue.
- Fork the repository on GitHub
- Create a topic branch from where you want to base your work.
- This is usually the master branch.
- Only target release branches if you are certain your fix must be on that branch.
- To quickly create a topic branch based on master;
git checkout -b fix/master/my_contribution master. Please avoid working directly on the
- Make commits of logical units.
- Check for unnecessary whitespace with
git diff --checkbefore committing.
- Make sure your commit messages are in the proper format.
(PUP-1234) Make the example in CONTRIBUTING imperative and concrete Without this patch applied the example commit message in the CONTRIBUTING document is not a concrete example. This is a problem because the contributor is left to imagine what the commit message should look like based on a description rather than an example. This patch fixes the problem by making the example concrete and imperative. The first line is a real life imperative statement with a ticket number from our issue tracker. The body describes the behavior without the patch, why this is a problem, and how the patch fixes the problem when applied.
- Make sure you have added the necessary tests for your changes.
- Run all the tests to assure nothing else was accidentally broken.
The easiest way to run the tests until you need to do it often is to use the built-in sandbox harness. Assuming you the PostgreSQL binaries installed in /usr/lib/posgresql/9.6/bin, then you should be able to run the core tests like this:
$ ext/bin/boxed-core-tests \ --pgbin /usr/lib/posgresql/9.6/bin \ -- lein test
Copies of tools like
pgbox may be downloaded and
installed to a temporary directory during the process, if you don’t
already have the expected versions.
Similarly you should be able to run the integration tests against the default Puppet and Puppetserver versions like this:
$ ext/bin/boxed-integration-tests \ --pgbin /usr/lib/posgresql/9.6/bin \ -- lein test :integration
You can also select the integration test versions of puppet and
puppetserver with the
--puppet REF and
--server REF arguments.
The sandboxes are destroyed when the commands finish, but you can arrange to inspect the environment after a failure like this:
$ ext/bin/boxed-integration-tests \ --pgbin /usr/lib/posgresql/9.6/bin \ -- bash -c 'lein test || bash'
which will drop you into a shell if anything goes wrong.
If you’re running the tests all the time, you might want to set up
your own persistent sandbox instead (
something similar) so you can run them directly:
$ ext/bin/pdbbox-init \ --sandbox ./test-sandbox \ --pgbin /usr/lib/postgresql-9.6/bin \ --pgport 17961
After that you can start and stop the included database server like this:
$ export PDBBOX="$(pwd)/test-sandbox" $ ext/bin/pdbbox-env pg_ctl start -w $ ext/bin/pdbbox-env pg_ctl stop
and when the database server is running you can run the tests like this:
$ export PDBBOX="$(pwd)/test-sandbox" $ ext/bin/pdbbox-env lein test
Before you can run the integration tests directly, you’ll need to configure the puppet and puppetserver versions you want to use. Assuming you have suitable versions of Ruby and Bundler available, you can do this:
$ ext/bin/config-puppet-test-ref $ ext/bin/config-puppetserver-test-ref
The default puppet and puppetserver versions are recorded in
ext/test-conf/. You can request specific versions of puppet or
puppetserver by specifying arguments to the config tools like this:
$ ext/bin/config-puppet-test-ref 5.3.x $ ext/bin/config-puppetserver-test-ref 5.1.x
Run the tools again to change the requested versions, and
distclean will completely undo the configurations.
After configuration you should be able to run the tests by specifying
$ export PDBBOX="$(pwd)/test-sandbox" $ ext/bin/pdbbox-env lein test :integration
You can also run puppetdb itself with the config file included in the sandbox:
$ export PDBBOX="$(pwd)/test-sandbox" $ ext/bin/pdbbox-env lein run services \ -c test-sandbox/pdb.ini
To run the local rspec tests (e.g. for the PuppetDB terminus code),
you must have run
config-puppet-test-ref as described above, and
then from within the
puppet/ directory run:
$ bundle exec rspec spec
If you’d like to preserve the temporary test databases on failure, you can
PDB_TEST_PRESERVE_DB_ON_FAIL to true:
$ PDB_TEST_KEEP_DB_ON_FAIL=true lein test
And finally, you can of course set up and configure your own PostgreSQL server for testing, but then you’ll need to create the test users:
$ createuser -DRSP pdb_test $ createuser -dRsP pdb_test_admin
and do the other things that
pdbbox-init normally handles, like
setting environment variables if the default values aren’t
PDB_TEST_DB_HOST(defaults to localhost)
PDB_TEST_DB_PORT(defaults to 5432)
lein clean will clean up the relevant items related to
Clojure, but won’t affect some other things, including the integration
test configuration. To clean up “everything”, run
Making Trivial Changes
For changes of a trivial nature to comments and documentation, it is not always necessary to create a new ticket in Jira. In this case, it is appropriate to start the first line of a commit with ‘(doc)’ instead of a ticket number.
(doc) Add documentation commit example to CONTRIBUTING There is no example for contributing a documentation commit to the Puppet repository. This is a problem because the contributor is left to assume how a commit of this nature may appear. The first line is a real life imperative statement with '(doc)' in place of what would have been the ticket number in a non-documentation related commit. The body describes the nature of the new documentation or comments added.
- Sign the Contributor License Agreement.
- Push your changes to a topic branch in your fork of the repository.
- Submit a pull request to the repository in the puppetlabs organization.
- Update your Jira ticket to mark that you have submitted code and are ready for it to be reviewed (Status: Ready for Merge).
- Include a link to the pull request in the ticket.
- After feedback has been given we expect responses within two weeks. After two weeks will may close the pull request if it isn’t showing any activity.