diff --git a/.fixtures.yml b/.fixtures.yml index 926942f..670c58e 100644 --- a/.fixtures.yml +++ b/.fixtures.yml @@ -1,5 +1,5 @@ fixtures: - repositories: - stdlib: git://github.com/puppetlabs/puppetlabs-stdlib.git + forge_modules: + stdlib: "puppetlabs/stdlib" symlinks: munin: "#{source_dir}" diff --git a/.gitignore b/.gitignore index 73da533..6dfe023 100644 --- a/.gitignore +++ b/.gitignore @@ -1,5 +1,12 @@ -spec/fixtures -vendor -.ruby-version -.bundle -Gemfile.lock +.*.sw? +/pkg +/spec/fixtures +/.rspec_system +/.vagrant +/.bundle +/vendor +/Gemfile.lock +/junit +/log +.yardoc +coverage diff --git a/.pmtignore b/.pmtignore new file mode 100644 index 0000000..e4e6ec9 --- /dev/null +++ b/.pmtignore @@ -0,0 +1,3 @@ +vendor/ +log/ +junit/ diff --git a/.rspec b/.rspec index 8c18f1a..4cd92bf 100644 --- a/.rspec +++ b/.rspec @@ -1,2 +1,3 @@ --format documentation --color +--fail-fast diff --git a/.travis.yml b/.travis.yml index aa02d0e..8d0faa7 100644 --- a/.travis.yml +++ b/.travis.yml @@ -1,17 +1,38 @@ --- -sudo: false language: ruby -cache: bundler -bundler_args: --without development +bundler_args: --without development system_tests +before_install: rm Gemfile.lock || true rvm: + - 1.8.7 - 1.9.3 - - 2.1.6 - - 2.2.2 + - 2.0.0 + - 2.1.0 +script: bundle exec rake test env: - - PUPPET_GEM_VERSION="~> 3.0" - - PUPPET_GEM_VERSION="~> 4.0" + - PUPPET_GEM_VERSION="~> 2.7.0" + - PUPPET_GEM_VERSION="~> 3.2.0" + - PUPPET_GEM_VERSION="~> 3.3.0" + - PUPPET_GEM_VERSION="~> 3.4.0" + - PUPPET_GEM_VERSION="~> 3.5.0" STRICT_VARIABLES=yes + - PUPPET_GEM_VERSION="~> 3.6.0" STRICT_VARIABLES=yes + - PUPPET_GEM_VERSION="~> 3.7.0" STRICT_VARIABLES=yes + - PUPPET_GEM_VERSION="~> 3.7.0" STRICT_VARIABLES=yes FUTURE_PARSER=yes matrix: exclude: - - rvm: 2.2.2 - env: PUPPET_GEM_VERSION="~> 3.0" -script: bundle exec rake spec + # Ruby 1.9.3 + - rvm: 1.9.3 + env: PUPPET_GEM_VERSION="~> 2.7.0" + + # Ruby 2.0.0 + - rvm: 2.0.0 + env: PUPPET_GEM_VERSION="~> 2.7.0" + + # Ruby 2.1.0 + - rvm: 2.1.0 + env: PUPPET_GEM_VERSION="~> 2.7.0" + - rvm: 2.1.0 + env: PUPPET_GEM_VERSION="~> 3.2.0" + - rvm: 2.1.0 + env: PUPPET_GEM_VERSION="~> 3.3.0" + - rvm: 2.1.0 + env: PUPPET_GEM_VERSION="~> 3.4.0" diff --git a/.yardopts b/.yardopts new file mode 100644 index 0000000..29c933b --- /dev/null +++ b/.yardopts @@ -0,0 +1 @@ +--markup markdown diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..36d07a8 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,92 @@ +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 + +1. Fork the repo. + +2. Run the tests. We only take pull requests with passing tests, and + it's great to know that you have a clean slate. + +3. 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. + +4. Make the test pass. + +5. Push to your fork and submit a pull request. + + +## 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="~> 3.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 syntax + +## 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. Running the test suite is done +with: + + bundle exec rake spec + +Note also you can run the syntax, style and unit tests in one go with: + + bundle exec rake test + +### Automatically run the tests + +During development of your puppet module you might want to run your unit +tests a couple of times. You can use the following command to automate +running the unit tests on every change made in the manifests folder. + + bundle exec guard + +## 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). + +Beaker fires up a new virtual machine (using Vagrant) and runs a series of +simple tests against it after applying the module. You can run our +Beaker tests with: + + bundle exec rake acceptance + +This will use the host described in `spec/acceptance/nodeset/default.yml` +by default. To run against another host, set the `BEAKER_set` environment +variable to the name of a host described by a `.yml` file in the +`nodeset` directory. For example, to run against CentOS 6.4: + + BEAKER_set=centos-64-x64 bundle exec rake acceptance + +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`. diff --git a/Gemfile b/Gemfile index 79f94c2..ca3fd4e 100644 --- a/Gemfile +++ b/Gemfile @@ -1,34 +1,33 @@ source "https://rubygems.org" group :test do gem "rake" gem "puppet", ENV['PUPPET_GEM_VERSION'] || '~> 3.8.0' gem "rspec", '< 3.2.0' - gem "rspec-puppet", :git => 'https://github.com/rodjek/rspec-puppet.git' + gem "rspec-puppet" gem "puppetlabs_spec_helper" gem "metadata-json-lint" gem "rspec-puppet-facts" gem 'rubocop', '0.33.0' - gem 'simplecov' + gem 'simplecov', '>= 0.11.0' gem 'simplecov-console' gem "puppet-lint-absolute_classname-check" gem "puppet-lint-leading_zero-check" gem "puppet-lint-trailing_comma-check" gem "puppet-lint-version_comparison-check" gem "puppet-lint-classes_and_types_beginning_with_digits-check" gem "puppet-lint-unquoted_string-check" end group :development do gem "travis" gem "travis-lint" gem "guard-rake" end group :system_tests do - gem "vagrant-wrapper" gem "beaker" gem "beaker-rspec" gem "beaker-puppet_install_helper" end diff --git a/Guardfile b/Guardfile index f84d6e4..fd50602 100644 --- a/Guardfile +++ b/Guardfile @@ -1,13 +1,5 @@ notification :off -directories %w(manifests templates spec/classes spec/defines) - guard 'rake', :task => 'test' do watch(%r{^manifests\/(.+)\.pp$}) - watch(%r{^templates\/(.+)\.erb$}) - watch(%r{^spec/.*_spec.rb}) -end - -guard 'rake', :task => 'metadata' do - watch('metadata.json') end diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..9f71055 --- /dev/null +++ b/LICENSE @@ -0,0 +1,202 @@ + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + +TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + +1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + +2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + +3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + +4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + +5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + +6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + +7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + +8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + +9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + +END OF TERMS AND CONDITIONS + +APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + +Copyright [yyyy] [name of copyright owner] + +Licensed under the Apache License, Version 2.0 (the "License"); +you may not use this file except in compliance with the License. +You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + +Unless required by applicable law or agreed to in writing, software +distributed under the License is distributed on an "AS IS" BASIS, +WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +See the License for the specific language governing permissions and +limitations under the License. + diff --git a/Rakefile b/Rakefile index 2479ec4..8ac719e 100644 --- a/Rakefile +++ b/Rakefile @@ -1,59 +1,62 @@ require 'rubygems' require 'bundler/setup' require 'puppetlabs_spec_helper/rake_tasks' require 'puppet/version' require 'puppet/vendor/semantic/lib/semantic' unless Puppet.version.to_f < 3.6 require 'puppet-lint/tasks/puppet-lint' require 'puppet-syntax/tasks/puppet-syntax' require 'metadata-json-lint/rake_task' require 'rubocop/rake_task' # These gems aren't always present, for instance # on Travis with --without development begin - require 'puppet_blacksmith/rake_tasks' rescue LoadError # rubocop:disable Lint/HandleExceptions end RuboCop::RakeTask.new exclude_paths = [ "bundle/**/*", "pkg/**/*", "vendor/**/*", "spec/**/*", ] +# Coverage from puppetlabs-spec-helper requires rcov which +# doesn't work in anything since 1.8.7 +Rake::Task[:coverage].clear + Rake::Task[:lint].clear PuppetLint.configuration.relative = true PuppetLint.configuration.disable_80chars PuppetLint.configuration.disable_class_inherits_from_params_class PuppetLint.configuration.disable_class_parameter_defaults PuppetLint.configuration.fail_on_warnings = true PuppetLint::RakeTask.new :lint do |config| config.ignore_paths = exclude_paths end PuppetSyntax.exclude_paths = exclude_paths desc "Run acceptance tests" RSpec::Core::RakeTask.new(:acceptance) do |t| t.pattern = 'spec/acceptance' end desc "Populate CONTRIBUTORS file" task :contributors do system("git log --format='%aN' | sort -u > CONTRIBUTORS") end desc "Run syntax, lint, and spec tests." task :test => [ :metadata_lint, :syntax, :lint, :rubocop, :spec, ]