simp-rake-helpers 3.7.0 → 4.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6c1179db907c046e2587aba51d6d8bafb4387ccd
-  data.tar.gz: a8b41cc9cb002d18a0bec544ea7389328198588d
+  metadata.gz: 7e36e07cbe0fae048754924ae3a40caba0af5adc
+  data.tar.gz: ca2aa327bc13f6e3daacba40fb337f122cc869c6
 SHA512:
-  metadata.gz: 85ebb2471f4f3648d3ab3235ad2c268daa8bc09466b76c28c649b7bcb6915be019f495d7e1dd42a25a5d7e48a8613e1da6821db0d18621a0f8efcf5b68db6b03
-  data.tar.gz: b35605270a2148c09f2ca1803c55703bacf4ff56223a343ecce39b3f1732e79463e30f20614db161e4fba522240e33795ff471bb118efa3b530ac1475a8d84fa
+  metadata.gz: e7a65f9772cc1647c25a0c1e5385cef0175110f23baf24d0f3e8b6a0120953d9a7bc0c7565979dd8c7e9d08a13ecfe129964f1a7d46365c7f1fd154b213326b9
+  data.tar.gz: efddde79768468a7d9ed3a72b12aef3887abfc90b08f6b8e261a35196f1de061f450b4fc83b64288229051f8f2109153a28444685a73ca8d8d3c0c7ac75c644d

data/.travis.yml

@@ -1,21 +1,26 @@
 language: ruby
 sudo: required
+dist: trusty
 before_install:
   - sudo apt-get update -qq
   - sudo apt-get install -y rpm
   - rm Gemfile.lock || true
+  - rvm @global do gem uninstall bundler -a -x
+  - rvm @global do gem install bundler -v '~> 1.14.0'
 bundler_args: "--without development --path .vendor"
 notifications:
   email: false
 rvm:
   - 2.1.9
   - 2.3.3
+  - 2.4.1
 script:
   - 'bundle exec rake spec'
 matrix:
   fast_finish: true
   allow_failures:
     - rvm: 2.3.3
+    - rvm: 2.4.1
 before_deploy:
   - 'bundle exec rake clobber'
   - "export GEM_VERSION=`ruby -r ./lib/simp/rake/helpers/version.rb -e 'puts Simp::Rake::Helpers::VERSION'`"

data/CHANGELOG.md

@@ -1,3 +1,13 @@
+### 4.0.0 / 2017-07-31
+* Pinned bundler to '~> 1.14.0' to allow building on FIPS-enabled systems
+* Updated to simp-rspec-puppet-facts 2.0.0
+
+### 3.7.1 / 2017-07-20
+* Fixed bug in `:changelog_annotation` task
+* `:test` now uses `:metadata_lint` instead of `:metadata`
+* `:metadata` is now an alias for `:metadata_lint`
+* Added tests and fixtures for changelog logic
+
 ### 3.7.0 / 2017-07-10
 * Added compare_latest_tag task
 

data/lib/simp/rake/helpers/version.rb

@@ -2,5 +2,5 @@ module Simp; end
 module Simp::Rake; end
 
 class Simp::Rake::Helpers
-  VERSION = '3.7.0'
+  VERSION = '4.0.0'
 end

data/lib/simp/rake/pupmod/helpers.rb

@@ -19,6 +19,9 @@ module Simp::Rake::Pupmod; end
 
 # Rake tasks for SIMP Puppet modules
 class Simp::Rake::Pupmod::Helpers < ::Rake::TaskLib
+  # See https://fedoraproject.org/wiki/Packaging:Guidelines?rd=Packaging/Guidelines#Changelogs
+  CHANGELOG_ENTRY_REGEX = /^\*\s+((?:Mon|Tue|Wed|Thu|Fri|Sat|Sun) (?:Jan|Feb|Mar|Apr|May|Jun|Jul|Aug|Sep|Oct|Nov|Dec) \d{1,2} \d{4})\s+(.+<.+>)(?:\s+|\s*-\s*)?(\d+\.\d+\.\d+)/
+
   def initialize( base_dir = Dir.pwd )
     @base_dir = base_dir
     Dir[ File.join(File.dirname(__FILE__),'*.rb') ].each do |rake_file|
@@ -39,7 +42,6 @@ class Simp::Rake::Pupmod::Helpers < ::Rake::TaskLib
     rescue LoadError
     end
 
-
     # Lint & Syntax exclusions
     exclude_paths = [
       "bundle/**/*",
@@ -76,10 +78,62 @@ class Simp::Rake::Pupmod::Helpers < ::Rake::TaskLib
     end
 
     desc 'lint metadata.json'
-    task :metadata do
-      sh "metadata-json-lint metadata.json"
+    Rake::Task[:metadata].clear
+    task :metadata => :metadata_lint
+
+    # Read the metadata.json as a data structure
+    def metadata( file_path = nil )
+      require 'json'
+      _file = file_path || File.join(@base_dir, 'metadata.json')
+      fail "ERROR: file not found: '#{_file}'" unless File.exists? _file
+      @metadata ||= JSON.parse( File.read(_file) )
+    end
+
+
+    # Generate an appropriate annotated tag entry from the modules' CHANGELOG
+    #
+    # @note this currently does not support the valid RPM `%changelog` format
+    #       that places the version number on the next line:
+    #
+    #       * Fri Mar 02 2012 Maintenance
+    #       4.0.0-2
+    #       - Improved test stubs.
+    #
+    def changelog_annotation( quiet = false, file = nil )
+      result         = ""
+      changelog_file = file || File.join(@base_dir, 'CHANGELOG')
+      module_version = metadata['version']
+      changelogs      = {}
+
+      _entry = {} # current log entry's metadata (empty unless valid entry)
+      File.read(changelog_file).each_line do |line|
+        if line =~ /^\*/
+          if CHANGELOG_ENTRY_REGEX.match(line).nil?
+             warn %Q[WARNING: invalid changelogs entry: "#{line}"] unless quiet
+             _entry = {}
+          else
+            _entry = {
+              :date    => $1,
+              :user    => $2,
+              :release => $3,
+            }
+            changelogs[_entry[:release]] ||= []
+            changelogs[_entry[:release]] << line
+            next
+          end
+        end
+
+        # Don't add anything to the annotation unless reach the next valid entry
+        changelogs[_entry[:release]] << "  #{line}" if _entry.fetch(:release, false)
+      end
+
+      fail "Did not find any changelogs entries for version #{module_version}" if changelogs[module_version].nil?
+
+      result += "\nRelease of #{module_version}\n\n"
+      result += changelogs[module_version].join
     end
 
+
     desc <<-EOM
       Generate an appropriate annotated tag entry from a CHANGELOG.
 
@@ -105,45 +159,8 @@ class Simp::Rake::Pupmod::Helpers < ::Rake::TaskLib
     # That will give Travis a way of warning us if the changelog
     # will prevent the rpm from building.
     task :changelog_annotation, [:quiet] do |t,args|
-      require 'json'
-
       quiet = true if args[:quiet].to_s == 'true'
-
-      module_version = JSON.parse(File.read('metadata.json'))['version']
-
-      changelog = Hash.new
-      delim = nil
-      ignore_line = false
-
-      File.read('CHANGELOG').each_line do |line|
-        if line =~ /^\*/
-          if /^\*\s+((?:Mon|Tue|Wed|Thu|Fri|Sat|Sun) (?:Jan|Feb|Mar|Apr|May|Jun|Jul|Aug|Sep|Oct|Nov|Dec) \d{2} \d{4})\s+(.+<.+>)(?:\s+|\s*-\s*)?(\d+\.\d+\.\d+)/.match(line).nil?
-             warn "WARNING: invalid changelog entry: #{line}" unless quiet
-             # Don't add anything to the annotation until we reach the next
-             # valid entry
-             ignore_line = true
-          else
-            ignore_line = false
-            delim           = Hash.new
-            delim[:date]    = $1
-            delim[:user]    = $2
-            delim[:release] = $3
-
-            changelog[delim[:release]] ||= Array.new
-            changelog[delim[:release]] << line
-          end
-
-          next
-        end
-
-        if delim && delim[:release]
-          changelog[delim[:release]] << '  ' + line unless ignore_line
-        end
-      end
-
-      fail "Did not find any changelog entries for version #{module_version}" if changelog[module_version].nil?
-      puts "\nRelease of #{module_version}\n\n"
-      puts changelog[module_version]
+      puts changelog_annotation( quiet )
     end
 
     desc <<-EOM
@@ -158,7 +175,7 @@ class Simp::Rake::Pupmod::Helpers < ::Rake::TaskLib
 
       NOTES:
       Compares mission-impacting (significant) files with the latest
-      tag and identifies the relevant files that have changed.  
+      tag and identifies the relevant files that have changed.
 
       Does nothing if the project owner, as specified in the
       metadata.json file, is not 'simp'.
@@ -187,10 +204,9 @@ class Simp::Rake::Pupmod::Helpers < ::Rake::TaskLib
       require 'puppet/util/package'
 
       tags_source = args[:tags_source].nil? ? 'origin' : args[:tags_source]
-      ignore_owner = true if args[:ignore_owner].to_s == 'true' 
-      verbose = true if args[:verbose].to_s == 'true' 
+      ignore_owner = true if args[:ignore_owner].to_s == 'true'
+      verbose = true if args[:verbose].to_s == 'true'
 
-      metadata = JSON.load(File.read('metadata.json'))
       module_version = metadata['version']
       owner =  metadata['name'].split('-')[0]
 
@@ -211,7 +227,7 @@ class Simp::Rake::Pupmod::Helpers < ::Rake::TaskLib
           files_changed.delete_if do |file|
             file[0] ==  '.' or file =~ /^Gemfile/ or file == 'Rakefile' or file =~/^spec\// or file =~/^doc/
           end
-        
+
           if files_changed.empty?
             puts "  No new tag required: No significant files have changed since '#{last_tag}' tag"
           else
@@ -237,7 +253,7 @@ class Simp::Rake::Pupmod::Helpers < ::Rake::TaskLib
             end
           end
         end
-      else     
+      else
         puts "  Not evaluating module owned by '#{owner}'"
       end
     end
@@ -247,7 +263,7 @@ class Simp::Rake::Pupmod::Helpers < ::Rake::TaskLib
       :syntax,
       :lint,
       :spec_parallel,
-      :metadata,
+      :metadata_lint,
     ]
 
     desc <<-EOM

data/lib/simp/rake/rubygem.rb

@@ -62,6 +62,7 @@ module Simp::Rake
       desc "Run spec tests"
       RSpec::Core::RakeTask.new(:spec) do |t|
           t.rspec_opts = ['--color']
+          t.exclude_pattern = '**/{acceptance,fixtures,files}/**/*_spec.rb'
           t.pattern = 'spec/lib/simp/**/*_spec.rb'
       end
     end

data/spec/lib/simp/rake/pupmod/fixtures/othermod/Gemfile

@@ -0,0 +1,18 @@
+source ENV['GEM_SOURCE'] || 'https://rubygems.org'
+
+puppetversion = ENV.key?('PUPPET_VERSION') ? ENV['PUPPET_VERSION'] : ['>= 3.3']
+gem 'metadata-json-lint'
+gem 'puppet', puppetversion
+gem 'puppetlabs_spec_helper', '>= 1.0.0'
+gem 'puppet-lint', '>= 1.0.0'
+gem 'facter', '>= 1.7.0'
+gem 'rspec-puppet'
+
+# rspec must be v2 for ruby 1.8.7
+if RUBY_VERSION >= '1.8.7' && RUBY_VERSION < '1.9'
+  gem 'rspec', '~> 2.0'
+  gem 'rake', '~> 10.0'
+else
+  # rubocop requires ruby >= 1.9
+  gem 'rubocop'
+end

data/spec/lib/simp/rake/pupmod/fixtures/othermod/README.md

@@ -0,0 +1,83 @@
+# othermod
+
+#### Table of Contents
+
+1. [Description](#description)
+1. [Setup - The basics of getting started with othermod](#setup)
+    * [What othermod affects](#what-othermod-affects)
+    * [Setup requirements](#setup-requirements)
+    * [Beginning with othermod](#beginning-with-othermod)
+1. [Usage - Configuration options and additional functionality](#usage)
+1. [Reference - An under-the-hood peek at what the module is doing and how](#reference)
+1. [Limitations - OS compatibility, etc.](#limitations)
+1. [Development - Guide for contributing to the module](#development)
+
+## Description
+
+Start with a one- or two-sentence summary of what the module does and/or what
+problem it solves. This is your 30-second elevator pitch for your module.
+Consider including OS/Puppet version it works with.
+
+You can give more descriptive information in a second paragraph. This paragraph
+should answer the questions: "What does this module *do*?" and "Why would I use
+it?" If your module has a range of functionality (installation, configuration,
+management, etc.), this is the time to mention it.
+
+## Setup
+
+### What othermod affects **OPTIONAL**
+
+If it's obvious what your module touches, you can skip this section. For
+example, folks can probably figure out that your mysql_instance module affects
+their MySQL instances.
+
+If there's more that they should know about, though, this is the place to mention:
+
+* A list of files, packages, services, or operations that the module will alter,
+  impact, or execute.
+* Dependencies that your module automatically installs.
+* Warnings or other important notices.
+
+### Setup Requirements **OPTIONAL**
+
+If your module requires anything extra before setting up (pluginsync enabled,
+etc.), mention it here.
+
+If your most recent release breaks compatibility or requires particular steps
+for upgrading, you might want to include an additional "Upgrading" section
+here.
+
+### Beginning with othermod
+
+The very basic steps needed for a user to get the module up and running. This
+can include setup steps, if necessary, or it can be an example of the most
+basic use of the module.
+
+## Usage
+
+This section is where you describe how to customize, configure, and do the
+fancy stuff with your module here. It's especially helpful if you include usage
+examples and code samples for doing things with your module.
+
+## Reference
+
+Here, include a complete list of your module's classes, types, providers,
+facts, along with the parameters for each. Users refer to this section (thus
+the name "Reference") to find specific details; most users don't read it per
+se.
+
+## Limitations
+
+This is where you list OS compatibility, version compatibility, etc. If there
+are Known Issues, you might want to include them under their own heading here.
+
+## Development
+
+Since your module is awesome, other users will want to play with it. Let them
+know what the ground rules for contributing are.
+
+## Release Notes/Contributors/Etc. **Optional**
+
+If you aren't using changelog, put your release notes here (though you should
+consider using changelog). You can also add any additional sections you feel
+are necessary or important to include here. Please use the `## ` header.

data/spec/lib/simp/rake/pupmod/fixtures/othermod/Rakefile

@@ -0,0 +1,32 @@
+require 'puppetlabs_spec_helper/rake_tasks'
+require 'puppet-lint/tasks/puppet-lint'
+require 'metadata-json-lint/rake_task'
+
+if RUBY_VERSION >= '1.9'
+  require 'rubocop/rake_task'
+  RuboCop::RakeTask.new
+end
+
+PuppetLint.configuration.send('disable_80chars')
+PuppetLint.configuration.relative = true
+PuppetLint.configuration.ignore_paths = ['spec/**/*.pp', 'pkg/**/*.pp']
+
+desc 'Validate manifests, templates, and ruby files'
+task :validate do
+  Dir['manifests/**/*.pp'].each do |manifest|
+    sh "puppet parser validate --noop #{manifest}"
+  end
+  Dir['spec/**/*.rb', 'lib/**/*.rb'].each do |ruby_file|
+    sh "ruby -c #{ruby_file}" unless ruby_file =~ %r{spec/fixtures}
+  end
+  Dir['templates/**/*.erb'].each do |template|
+    sh "erb -P -x -T '-' #{template} | ruby -c"
+  end
+end
+
+desc 'Run metadata_lint, lint, validate, and spec tests.'
+task :test do
+  [:metadata_lint, :lint, :validate, :spec].each do |test|
+    Rake::Task[test].invoke
+  end
+end

data/spec/lib/simp/rake/pupmod/fixtures/othermod/examples/init.pp

@@ -0,0 +1,12 @@
+# The baseline for module testing used by Puppet Inc. is that each manifest
+# should have a corresponding test manifest that declares that class or defined
+# type.
+#
+# Tests are then run by using puppet apply --noop (to check for compilation
+# errors and view a log of events) or by fully applying the test in a virtual
+# environment (to compare the resulting system state to the desired state).
+#
+# Learn more about module testing here:
+# https://docs.puppet.com/guides/tests_smoke.html
+#
+include ::othermod

data/spec/lib/simp/rake/pupmod/fixtures/othermod/manifests/init.pp

@@ -0,0 +1,48 @@
+# Class: othermod
+# ===========================
+#
+# Full description of class othermod here.
+#
+# Parameters
+# ----------
+#
+# Document parameters here.
+#
+# * `sample parameter`
+# Explanation of what this parameter affects and what it defaults to.
+# e.g. "Specify one or more upstream ntp servers as an array."
+#
+# Variables
+# ----------
+#
+# Here you should define a list of variables that this module would require.
+#
+# * `sample variable`
+#  Explanation of how this variable affects the function of this class and if
+#  it has a default. e.g. "The parameter enc_ntp_servers must be set by the
+#  External Node Classifier as a comma separated list of hostnames." (Note,
+#  global variables should be avoided in favor of class parameters as
+#  of Puppet 2.6.)
+#
+# Examples
+# --------
+#
+# @example
+#    class { 'othermod':
+#      servers => [ 'pool.ntp.org', 'ntp.local.company.com' ],
+#    }
+#
+# Authors
+# -------
+#
+# Author Name <author@domain.com>
+#
+# Copyright
+# ---------
+#
+# Copyright 2017 Your name here, unless otherwise noted.
+#
+class othermod {
+
+
+}