RickRongen/puppetlabs-java
1
0
Fork 0
Code Releases Activity

(maint) modulesync 892c4cf

Browse Source
This commit is contained in:
Hailee Kenney
2017-09-18 14:56:13 -07:00
parent e4888a507e
commit 6397c0870b
2 changed files with 139 additions and 84 deletions
Download Patch File Download Diff File Expand all files Collapse all files

222
CONTRIBUTING.md
View File

@@ -1,63 +1,75 @@
Checklist (and a short version for the impatient) # Contributing to Puppet modules
=================================================
* Commits: So you want to contribute to a Puppet module: Great! Below are some instructions to get you started doing
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 1. [Getting Started](#getting-started)
committing. 1. [Commit Checklist](#commit-checklist)
1. [Submission](#submission)
1. [More about commits](#more-about-commits)
1. [Testing](#testing)
- [Running Tests](#running-tests)
- [Writing Tests](#writing-tests)
1. [Get Help](#get-help)
- Commit using Unix line endings (check the settings around "crlf" in ## Getting Started
git-config(1)).
- Do not check in commented out code or unneeded files. - Fork the module repository on GitHub and clone to your workspace
- The first line of the commit message should be a short - Make your changes!
description (50 characters is the soft limit, excluding ticket
number(s)), and should skip the full stop.
- Associate the issue in the message. The first line should include ## Commit Checklist
the issue number in the form "(#XXXX) Rest of message".
- The body should provide a meaningful commit message, which: ### The Basics
- uses the imperative, present tense: "change", not "changed" or - [x] my commit is a single logical unit of work
"changes".
- includes motivation for the change, and contrasts its - [x] I have checked for unnecessary whitespace with "git diff --check"
implementation with the previous behavior.
- Make sure that you have tests for the bug you are fixing, or - [x] my commit does not include commented out code or unneeded files
feature you are adding.
- Make sure the test suites passes after your commit: ### The Content
`bundle exec rspec spec/acceptance` More information on [testing](#Testing) below
- When introducing a new feature, make sure it is properly - [x] my commit includes tests for the bug I fixed or feature I added
documented in the README.md
* Submission: - [x] my commit includes appropriate documentation changes if it is introducing a new feature or changing existing functionality
* Pre-requisites: - [x] my code passes existing test suites
- Make sure you have a [GitHub account](https://github.com/join) ### The Commit Message
- [Create a ticket](https://tickets.puppet.com/secure/CreateIssue!default.jspa), or [watch the ticket](https://tickets.puppet.com/browse/) you are patching for. - [x] the first line of my commit message includes:
* Preferred method: - [x] an issue number (if applicable), e.g. "(MODULES-xxxx) This is the first line"
- Fork the repository on GitHub. - [x] a short description (50 characters is the soft limit, excluding ticket number(s))
- Push your changes to a topic branch in your fork of the - [x] the body of my commit message:
repository. (the format ticket/1234-short_description_of_change is
usually preferred for this project).
- Submit a pull request to the repository in the puppetlabs - [x] is meaningful
organization.
The long version - [x] uses the imperative, present tense: "change", not "changed" or "changes"
================
- [x] includes motivation for the change, and contrasts its implementation with the previous behavior
## Submission
### 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. 1. Make separate commits for logically separate changes.
@@ -104,37 +116,32 @@ The long version
GitHub has some pretty good GitHub has some pretty good
[general documentation](http://help.github.com/) on using [general documentation](http://help.github.com/) on using
their site. They also have documentation on 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 In general, after pushing your topic branch up to your
repository on GitHub, you can switch to the branch in the repository on GitHub, you can switch to the branch in the
GitHub UI and click "Pull Request" towards the top of the page GitHub UI and click "Pull Request" towards the top of the page
in order to open a pull request. 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 submitted, then you should update the ticket to include the
location of your branch, along with any other commentary you location of your branch, along with any other commentary you
may wish to make. may wish to make.
Testing # Testing
=======
Getting Started ## Getting Started
---------------
Our puppet modules provide [`Gemfile`](./Gemfile)s which can tell a ruby Our Puppet modules provide [`Gemfile`](./Gemfile)s, which can tell a Ruby package manager such as [bundler](http://bundler.io/) what Ruby packages,
package manager such as [bundler](http://bundler.io/) what Ruby packages,
or Gems, are required to build, develop, and test this software. 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 % bundle install --path .bundle/gems
Fetching gem metadata from https://rubygems.org/........ Fetching gem metadata from https://rubygems.org/........
Fetching gem metadata from https://rubygems.org/.. Fetching gem metadata from https://rubygems.org/..
Using rake (10.1.0) Using rake (10.1.0)
@@ -148,7 +155,7 @@ Your bundle is complete!
Use `bundle show [gemname]` to see where a bundled gem is installed. 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: If you already have those gems installed, make sure they are up-to-date:
@@ -156,26 +163,27 @@ If you already have those gems installed, make sure they are up-to-date:
% bundle update % bundle update
``` ```
With all dependencies in place and up-to-date we can now run the tests: ## Running Tests
With all dependencies in place and up-to-date, run the tests:
### Unit Tests
```shell ```shell
% bundle exec rake spec % bundle exec rake spec
``` ```
This will execute all the [rspec tests](http://rspec-puppet.com/) tests 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.
under [spec/defines](./spec/defines), [spec/classes](./spec/classes), 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),
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),
rspec tests define them in [.fixtures.yml](./fixtures.yml). 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
[Vagrant](http://www.vagrantup.com/) to actually simulate scripted test
scenarios. In order to run these, you will need both of those tools
installed on your system.
You can run them by issuing the following command Some Puppet modules also come with acceptance tests, which use [beaker][]. These tests spin up a virtual machine under
[VirtualBox](https://www.virtualbox.org/), controlled with [Vagrant](http://www.vagrantup.com/), to simulate scripted test
scenarios. In order to run these, you need both Virtualbox and Vagrant installed on your system.
Run the tests by issuing the following command
```shell ```shell
% bundle exec rake spec_clean % bundle exec rake spec_clean
@@ -183,35 +191,81 @@ You can run them by issuing the following command
``` ```
This will now download a pre-fabricated image configured in the [default node-set](./spec/acceptance/nodesets/default.yml), 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). and then run all the tests under [spec/acceptance](./spec/acceptance).
Writing Tests ## Writing Tests
-------------
XXX getting started writing tests. ### Unit Tests
If you have commit access to the repository When writing unit tests for Puppet, [rspec-puppet][] is your best friend. It provides tons of helper methods for testing your manifests against a
=========================================== 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
developer on the project (that did not write the code) to ensure that
all changes go through a code review process.
Having someone other than the author of the topic branch recorded as ```puppet
performing the merge is the record that they performed the code file { "a test file":
review. ensure => present,
path => "/etc/sample",
}
```
Sample test:
Additional Resources ```ruby
==================== it 'does a thing' do
expect(subject).to contain_file("a test file").with({:path => "/etc/sample"})
end
```
* [Getting additional help](http://puppet.com/community/get-help) ### Acceptance Tests
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) * [Writing tests](https://docs.puppet.com/guides/module_guides/bgtm.html#step-three-module-testing)
* [General GitHub documentation](http://help.github.com/) * [General GitHub documentation](http://help.github.com/)
* [GitHub pull request documentation](http://help.github.com/send-pull-requests/) * [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

1
locales/config.yaml
View File

@@ -22,4 +22,5 @@ gettext:
# Patterns for +Dir.glob+ used to find all files that might contain # Patterns for +Dir.glob+ used to find all files that might contain
# translatable content, relative to the project root directory # translatable content, relative to the project root directory
source_files: source_files:
- './lib/**/*.rb'