other/Puppet: modules/firewall/CONTRIBUTING.md comparison

comparison modules/firewall/CONTRIBUTING.md @ 275:d9352a684e62

Mass update of modules to remove deprecation warnings

author	IBBoard <dev@ibboard.co.uk>
date	Sun, 26 Jan 2020 11:36:07 +0000
parents	d6f2a0ee45c0
children	66c406eec60d

comparison

equal deleted inserted replaced

-:b2571c28fc27
+:d9352a684e62
-Checklist (and a short version for the impatient)
+# Contributing to Puppet modules
-=================================================
+So you want to contribute to a Puppet module: Great! Below are some instructions to get you started doing
-* Commits:
+that very thing while setting expectations around code quality as well as a few tips for making the
+process as easy as possible.
-- Make commits of logical units.
+### Table of Contents
-- Check for unnecessary whitespace with "git diff --check" before
-committing.
+1. [Getting Started](#getting-started)
+1. [Commit Checklist](#commit-checklist)
-- Commit using Unix line endings (check the settings around "crlf" in
+1. [Submission](#submission)
-git-config(1)).
+1. [More about commits](#more-about-commits)
+1. [Testing](#testing)
-- Do not check in commented out code or unneeded files.
+- [Running Tests](#running-tests)
+- [Writing Tests](#writing-tests)
-- The first line of the commit message should be a short
+1. [Get Help](#get-help)
-description (50 characters is the soft limit, excluding ticket
-number(s)), and should skip the full stop.
+## Getting Started
-- Associate the issue in the message. The first line should include
+- Fork the module repository on GitHub and clone to your workspace
-the issue number in the form "(#XXXX) Rest of message".
+- Make your changes!
-- The body should provide a meaningful commit message, which:
+## Commit Checklist
-- uses the imperative, present tense: "change", not "changed" or
-"changes".
+### The Basics
-- includes motivation for the change, and contrasts its
+- [x] my commit is a single logical unit of work
-implementation with the previous behavior.
+- [x] I have checked for unnecessary whitespace with "git diff --check"
-- Make sure that you have tests for the bug you are fixing, or
-feature you are adding.
+- [x] my commit does not include commented out code or unneeded files
-- Make sure the test suites passes after your commit:
+### The Content
-`bundle exec rspec spec/acceptance` More information on [testing](#Testing) below
+- [x] my commit includes tests for the bug I fixed or feature I added
-- When introducing a new feature, make sure it is properly
-documented in the README.md
+- [x] my commit includes appropriate documentation changes if it is introducing a new feature or changing existing functionality
-* Submission:
+- [x] my code passes existing test suites
-* Pre-requisites:
+### The Commit Message
-- Make sure you have a [GitHub account](https://github.com/join)
+- [x] the first line of my commit message includes:
-- [Create a ticket](https://tickets.puppetlabs.com/secure/CreateIssue!default.jspa), or [watch the ticket](https://tickets.puppetlabs.com/browse/) you are patching for.
+- [x] an issue number (if applicable), e.g. "(MODULES-xxxx) This is the first line"
-* Preferred method:
+- [x] a short description (50 characters is the soft limit, excluding ticket number(s))
-- Fork the repository on GitHub.
+- [x] the body of my commit message:
-- Push your changes to a topic branch in your fork of the
+- [x] is meaningful
-repository. (the format ticket/1234-short_description_of_change is
-usually preferred for this project).
+- [x] uses the imperative, present tense: "change", not "changed" or "changes"
-- Submit a pull request to the repository in the puppetlabs
+- [x] includes motivation for the change, and contrasts its implementation with the previous behavior
-organization.
+## Submission
-The long version
-================
+### Pre-requisites
+- Make sure you have a [GitHub account](https://github.com/join)
+- [Create a ticket](https://tickets.puppet.com/secure/CreateIssue!default.jspa), or [watch the ticket](https://tickets.puppet.com/browse/) you are patching for.
+### Push and PR
+- Push your changes to your fork
+- [Open a Pull Request](https://help.github.com/articles/creating-a-pull-request-from-a-fork/) against the repository in the puppetlabs organization
+## More about commits
 1.  Make separate commits for logically separate changes.
 Please break your commits down into logically consistent units
 which include new or changed tests relevant to the rest of the
 is merged in.
 GitHub has some pretty good
 [general documentation](http://help.github.com/) on using
 their site.  They also have documentation on
-[creating pull requests](http://help.github.com/send-pull-requests/).
+[creating pull requests](https://help.github.com/articles/creating-a-pull-request-from-a-fork/).
 In general, after pushing your topic branch up to your
 repository on GitHub, you can switch to the branch in the
 GitHub UI and click "Pull Request" towards the top of the page
 in order to open a pull request.
+3.  Update the related JIRA issue.
-3.  Update the related GitHub issue.
+If there is a JIRA issue associated with the change you
-If there is a GitHub issue associated with the change you
 submitted, then you should update the ticket to include the
 location of your branch, along with any other commentary you
 may wish to make.
-Testing
+# Testing
-=======
+## Getting Started
-Getting Started
----------------
+Our Puppet modules provide [`Gemfile`](./Gemfile)s, which can tell a Ruby package manager such as [bundler](http://bundler.io/) what Ruby packages,
-Our puppet modules provide [`Gemfile`](./Gemfile)s which can tell a ruby
-package manager such as [bundler](http://bundler.io/) what Ruby packages,
 or Gems, are required to build, develop, and test this software.
-Please make sure you have [bundler installed](http://bundler.io/#getting-started)
+Please make sure you have [bundler installed](http://bundler.io/#getting-started) on your system, and then use it to
-on your system, then use it to install all dependencies needed for this project,
+install all dependencies needed for this project in the project root by running
-by running
+```shell
-```shell
+% bundle install --path .bundle/gems
-% bundle install
 Fetching gem metadata from https://rubygems.org/........
 Fetching gem metadata from https://rubygems.org/..
 Using rake (10.1.0)
 Using builder (3.2.2)
 -- 8><-- many more --><8 --
 Using bundler (1.3.5)
 Your bundle is complete!
 Use `bundle show [gemname]` to see where a bundled gem is installed.
 ```
-NOTE some systems may require you to run this command with sudo.
+NOTE: some systems may require you to run this command with sudo.
 If you already have those gems installed, make sure they are up-to-date:
 ```shell
 % bundle update
 ```
-With all dependencies in place and up-to-date we can now run the tests:
+## Running Tests
-```shell
+With all dependencies in place and up-to-date, run the tests:
-% rake spec
-```
+### Unit Tests
-This will execute all the [rspec tests](http://rspec-puppet.com/) tests
+```shell
-under [spec/defines](./spec/defines), [spec/classes](./spec/classes),
+% bundle exec rake spec
-and so on. rspec tests may have the same kind of dependencies as the
+```
-module they are testing. While the module defines in its [Modulefile](./Modulefile),
+This executes all the [rspec tests](http://rspec-puppet.com/) in the directories defined [here](https://github.com/puppetlabs/puppetlabs_spec_helper/blob/699d9fbca1d2489bff1736bb254bb7b7edb32c74/lib/puppetlabs_spec_helper/rake_tasks.rb#L17) and so on.
+rspec tests may have the same kind of dependencies as the module they are testing. Although the module defines these dependencies in its [metadata.json](./metadata.json),
 rspec tests define them in [.fixtures.yml](./fixtures.yml).
-Some puppet modules also come with [beaker](https://github.com/puppetlabs/beaker)
+### Acceptance Tests
-tests. These tests spin up a virtual machine under
-[VirtualBox](https://www.virtualbox.org/)) with, controlling it with
+Some Puppet modules also come with acceptance tests, which use [beaker][]. These tests spin up a virtual machine under
-[Vagrant](http://www.vagrantup.com/) to actually simulate scripted test
+[VirtualBox](https://www.virtualbox.org/), controlled with [Vagrant](http://www.vagrantup.com/), to simulate scripted test
-scenarios. In order to run these, you will need both of those tools
+scenarios. In order to run these, you need both Virtualbox and Vagrant installed on your system.
-installed on your system.
+Run the tests by issuing the following command
-You can run them by issuing the following command
+```shell
-```shell
+% bundle exec rake spec_clean
-% rake spec_clean
+% bundle exec rspec spec/acceptance
-% rspec spec/acceptance
 ```
 This will now download a pre-fabricated image configured in the [default node-set](./spec/acceptance/nodesets/default.yml),
-install puppet, copy this module and install its dependencies per [spec/spec_helper_acceptance.rb](./spec/spec_helper_acceptance.rb)
+install Puppet, copy this module, and install its dependencies per [spec/spec_helper_acceptance.rb](./spec/spec_helper_acceptance.rb)
 and then run all the tests under [spec/acceptance](./spec/acceptance).
-Writing Tests
+## Writing Tests
--------------
+### Unit Tests
-XXX getting started writing tests.
+When writing unit tests for Puppet, [rspec-puppet][] is your best friend. It provides tons of helper methods for testing your manifests against a
-If you have commit access to the repository
+catalog (e.g. contain_file, contain_package, with_params, etc). It would be ridiculous to try and top rspec-puppet's [documentation][rspec-puppet_docs]
-===========================================
+but here's a tiny sample:
-Even if you have commit access to the repository, you will still need to
+Sample manifest:
-go through the process above, and have someone else review and merge
-in your changes.  The rule is that all changes must be reviewed by a
+```puppet
-developer on the project (that did not write the code) to ensure that
+file { "a test file":
-all changes go through a code review process.
+ensure => present,
+path   => "/etc/sample",
-Having someone other than the author of the topic branch recorded as
+}
-performing the merge is the record that they performed the code
+```
-review.
+Sample test:
-Additional Resources
+```ruby
-====================
+it 'does a thing' do
+expect(subject).to contain_file("a test file").with({:path => "/etc/sample"})
-* [Getting additional help](http://puppetlabs.com/community/get-help)
+end
+```
-* [Writing tests](http://projects.puppetlabs.com/projects/puppet/wiki/Development_Writing_Tests)
+### Acceptance Tests
-* [Patchwork](https://patchwork.puppetlabs.com)
+Writing acceptance tests for Puppet involves [beaker][] and its cousin [beaker-rspec][]. A common pattern for acceptance tests is to create a test manifest, apply it
+twice to check for idempotency or errors, then run expectations.
+```ruby
+it 'does an end-to-end thing' do
+pp = <<-EOF
+file { 'a test file':
+ensure  => present,
+path    => "/etc/sample",
+content => "test string",
+}
+apply_manifest(pp, :catch_failures => true)
+apply_manifest(pp, :catch_changes => true)
+end
+describe file("/etc/sample") do
+it { is_expected.to contain "test string" }
+end
+```
+# If you have commit access to the repository
+Even if you have commit access to the repository, you still need to go through the process above, and have someone else review and merge
+in your changes.  The rule is that **all changes must be reviewed by a project developer that did not write the code to ensure that
+all changes go through a code review process.**
+The record of someone performing the merge is the record that they performed the code review. Again, this should be someone other than the author of the topic branch.
+# Get Help
+### On the web
+* [Puppet help messageboard](http://puppet.com/community/get-help)
+* [Writing tests](https://docs.puppet.com/guides/module_guides/bgtm.html#step-three-module-testing)
 * [General GitHub documentation](http://help.github.com/)
 * [GitHub pull request documentation](http://help.github.com/send-pull-requests/)
+### On chat
+* Slack (slack.puppet.com) #forge-modules, #puppet-dev, #windows, #voxpupuli
+* IRC (freenode) #puppet-dev, #voxpupuli
+[rspec-puppet]: http://rspec-puppet.com/
+[rspec-puppet_docs]: http://rspec-puppet.com/documentation/
+[beaker]: https://github.com/puppetlabs/beaker
+[beaker-rspec]: https://github.com/puppetlabs/beaker-rspec

Mercurial > repos > other > Puppet

comparison modules/firewall/CONTRIBUTING.md @ 275:d9352a684e62