puppet-check 1.3.1 → 1.3.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5eed739fa10d5c5223812d0e88edf139d4c5e0e7
-  data.tar.gz: b6cc39fa5d43da1a090ca7be86315876285d94b7
+  metadata.gz: 0c73e077873c45fd337c09547f436ad7c0176f1f
+  data.tar.gz: a40a24c8f2e710c7d0e57bff54738003ae9ad7de
 SHA512:
-  metadata.gz: c259d0803a2fae163241ef523e6c326b402be1d7363929adf857db87b2fc82b1f9af5dbe673a4eaf6ce0fee6ec4b3464f0931f5e000e97e3fa3e15fef913f926
-  data.tar.gz: 3159e4d695987cd9f4ccde352bb69a965fedc3204fdf7fbced757b93f9c777f49ef9408fc8189d71aebd78bbf7f9490c6a0382b43aec1b9a36c80186f1dae7ed
+  metadata.gz: bbf1b361bd6e6ae303e3e242aea111774beb1234b4a9affa45fbaa178af7b3c0ccb4315babab6d937b24a95b025bc339a469aeeefe232b954bd1aaf4d633b535
+  data.tar.gz: 2c537882049dadf1924de9021f0957932f7142a307f1f343598924474d4d11bae034bde0b2e1e1ce5e2fb01ed65a45d1b6025bf8861affaba8462955b1530838

data/CHANGELOG.md

@@ -1,12 +1,17 @@
 ### 1.4.0 (Roadmap)
 - optional dep octocatalog-diff interface (minor)
-- minimum Puppet version increased from 3.4 to 3.7 (minor)
 - rakefile interface with puppet-lint, rubocop, reek (minor)
 - rspec puppet stubbing (minor)
 - acceptance testing with vagrant/docker+serverspec (minor)
 - improved json and yaml output formats support (file arrays become file hashes and output results further handles formatting) (minor; this would be a big refactoring effort)
 - split syntax and style checks to separate methods for style (patch)
-- add additional hiera checks (patch)
+
+### 1.3.2 (Roadmap)
+- For the Puppet Forge method of downloading external module dependencies as spec fixtures, the module is now updated if it is already present. Previously, a fresh forced install was always attempted.
+- A good `spec_helper` for RSpec Puppet is now generated if one is missing. This is instead of the buggy one that `rspec-puppet-init` generates.
+- Fix blocking of hieradata checks on `hiera.yaml`.
+- A check was added for '---' appearing more than once in YAML hieradata as Hiera attempts to parse these additional lines as data.
+- Additional `metadata.json` warnings for `version_requirement` nested key.
 
 ### 1.3.1
 - For the git and mercurial methods of downloading external module dependencies as spec fixtures, the module is now updated if it is already present and previously retrieved with git or mercurial respectively. Previously, a fresh clone was always attempted.

data/README.md

@@ -5,6 +5,7 @@
 - [Usage](#usage)
   - [CLI](#cli)
   - [Rake](#rake)
+  - [API](#api)
   - [Docker](#docker)
   - [Vagrant](#vagrant)
   - [Exit Codes](#exit-codes)
@@ -45,10 +46,11 @@ BEGIN {throw :good}; i => am : a '' ruby.file { with } &bad syntax
 block sequence entries are not allowed in this context at line 2 column 4
 
 -- hieradata/syntax.json:
-757: unexpected token at '{
+743: unexpected token at '{
 
 -- metadata_syntax/metadata.json:
-Required field 'version' not found in metadata.json.
+Required field 'version' not found.
+Field 'requirements' is not an array of hashes.
 Duplicate dependencies on puppetlabs/nothing.
 Deprecated field 'checksum' found.
 Summary exceeds 144 characters.
@@ -60,13 +62,13 @@ Summary exceeds 144 characters.
 
 The following files have warnings:
 -- manifests/style_lint.pp:
-double quoted string containing no variables at line 2, column 8
-indentation of => is not properly aligned at line 2, column 5
+2:8: double quoted string containing no variables
+2:5: indentation of => is not properly aligned (expected in column 8, but found it in column 5)
 
 -- manifests/style_parser.pp:
 Unrecognized escape sequence '\[' at 2:77
 Unrecognized escape sequence '\]' at 2:77
-double quoted string containing no variables at line 2, column 45
+2:45: double quoted string containing no variables
 
 -- lib/style.rb:
 1:1: W: Useless assignment to variable - `hash`.
@@ -83,10 +85,19 @@ double quoted string containing no variables at line 2, column 45
 -- hieradata/style.yaml:
 Value(s) missing in key 'value'.
 Value(s) missing in key 'and'.
+The string --- appears more than once in this data and Hiera will fail to parse it correctly.
 
 -- metadata_style/metadata.json:
+Recommended field 'operatingsystem_support' not found.
+'pe' is missing an upper bound.
 License identifier 'Imaginary' is not in the SPDX list: http://spdx.org/licenses/
 
+-- metadata_style_two/metadata.json:
+Recommended field 'operatingsystem' not found.
+Recommended field 'operatingsystemrelease' not found.
+'puppetlabs/one' has non-semantic versioning in its 'version_requirement' key.
+'puppetlabs/two' is missing an upper bound.
+
 -- librarian_style/Puppetfile:
 2:3: C: Align the parameters of a method call if they span more than one line.
 5:13: C: Use the new Ruby 1.9 hash syntax.
@@ -94,9 +105,12 @@ License identifier 'Imaginary' is not in the SPDX list: http://spdx.org/licenses
 The following files have no errors or warnings:
 -- manifests/good.pp
 -- templates/good.epp
+-- spec/facter/facter_spec.rb
 -- lib/good.rb
+-- templates/no_method_error.erb
 -- templates/good.erb
 -- hieradata/good.yaml
+-- metadata.json
 -- hieradata/good.json
 -- metadata_good/metadata.json
 -- librarian_good/Puppetfile
@@ -116,10 +130,10 @@ The following files have unrecognized formats and therefore were not processed:
 - Puppetlabs Spec Helper does not update external module dependencies in a stateful/persistent workspace and fails gracefully instead.
 - Puppetlabs Spec Helper requires extra configuration items to setup self-module RSpec testing.
 
-It is worth nothing that there is no current development objective for Puppet Check to achieve the same advanced level of robustness for spec testing that Puppetlabs Spec Helper enables. If you are performing standard spec testing on your Puppet code and data, then Puppet Check's spec testing is a fantastic lightweight and faster alternative to Puppetlabs Spec Helper. If you require advanced and intricate capabilities in your spec testing (e.g. direct interfacing to the `Puppet::Parser::Scope` API), then you will likely prefer Puppetlabs Spec Helper's spec testing in conjunction with Puppet Check's file validation.
+It is worth nothing that there is no current development objective for Puppet Check to achieve the same advanced level of robustness for spec testing that Puppetlabs Spec Helper enables. If you are performing standard spec testing on your Puppet code and data, then Puppet Check's spec testing is a fantastic lighter and faster alternative to Puppetlabs Spec Helper. If you require advanced and intricate capabilities in your spec testing (e.g. direct interfacing to the `Puppet::Parser::Scope` API), then you will likely prefer Puppetlabs Spec Helper's spec testing in conjunction with Puppet Check's file validation.
 
 ## Usage
-Puppet Check requires `ruby >= 2.0.0`, `puppet >= 3.4`, and `puppet-lint >= 2.0.0`. All other dependencies should be fine with various versions. Puppet Check can be used either with a CLI or Rake tasks. Please note both interfaces will ignore any directories named `fixtures` or specified paths with that directory during file checks and spec tests.
+Puppet Check requires `ruby >= 2.0.0`, `puppet >= 3.4`, and `puppet-lint >= 2.0.0`. All other dependencies should be fine with various versions. Puppet Check can be used with a CLI, Rake tasks, or API, from your system, rbenv, rvm, Docker, or Vagrant. Please note all interfaces (API by default, but can be modified) will ignore any directories named `fixtures` or specified paths with that directory during file checks and spec tests.
 
 #### Reek
 Reek dropped support for Ruby 2.0 when it went to 4.0. Since dependencies by Ruby version are allowed in Gemfiles but not gemspecs, this means that PuppetCheck installed with `bundler` will automatically pick up the correct version of Reek for your Ruby version and install it. If you are installing PuppetCheck via `gem`, then you can install reek normally with `gem` with Ruby >= 2.1, but you will need to specify `gem install reek -v 3.11` if you are using Ruby 2.0.
@@ -174,7 +188,7 @@ The spec tests will be executed against everything that matches the pattern `**/
 
 Please note it is perfectly acceptable to only execute standard RSpec tests in your modules and not use the extended RSpec Puppet matchers. If no Puppet module directories are identified during directory parsing, then no RSpec Puppet related actions (including those described below) will be performed.
 
-Prior to executing the spec tests, Puppet Check will parse everything in the current path and identify all `spec` directories not within `fixtures` directories. It will then execute RSpec Puppet setup actions inside all directories one level above that contain a `manifests` directory. This is assumed to be a Puppet module directory. These setup actions include creating all of the necessary directories inside of `spec/fixtures`, creating a blank `site.pp` if it is missing, symlinking everything from the module that is needed into fixtures (automatically replaces functionality of self module symlink in `.fixtures.yaml` from Puppetlabs Spec Helper), and creates the `spec_helper.rb` if it is missing. Note these setup actions can replace `rspec-puppet-init` from RSpec Puppet and currently are both faster and more  accurate.
+Prior to executing the spec tests, Puppet Check will parse everything in the current path and identify all `spec` directories not within `fixtures` directories. It will then execute RSpec Puppet setup actions inside all directories one level above that contain a `manifests` directory. This is assumed to be a Puppet module directory. These setup actions include creating all of the necessary directories inside of `spec/fixtures`, creating a blank `site.pp` if it is missing, symlinking everything from the module that is needed into fixtures (automatically replaces functionality of self module symlink in `.fixtures.yaml` from Puppetlabs Spec Helper), and creates the `spec_helper.rb` if it is missing. Note these setup actions can replace `rspec-puppet-init` from RSpec Puppet and currently are both faster and more accurate.
 
 Puppet Check will also automatically download specified external module dependencies for and during RSpec Puppet testing. Currently `git`, `puppet forge`, and `hg` commands are supported. They can be implemented in the following way in your modules' `metadata.json`:
 
@@ -221,6 +235,29 @@ The spec tests will be executed against everything that matches the pattern `**/
 
 Please note this is merely a frontend to Beaker and that Beaker itself has a self-contained scope compared to all the other tools Puppet Check interfaces with and utilizes. This means if you want to add Beaker-RSpec, Serverspec, etc., or perform advanced configurations, those would be all be performed within Beaker itself. This task merely provides an interface to integrate Beaker in with your other testing infrastructure.
 
+### API
+
+If you are performing your Puppet testing from within a Ruby script or your own custom Rakefile tasks, and want to execute Puppet Check intrinsically from the Ruby script or Rakefile, then you can call its API in the following simple way:
+
+```ruby
+# file checks
+require 'puppet-check'
+
+PuppetCheck.future_parser = true # default false
+PuppetCheck.style_check = true # default false
+PuppetCheck.output_format = 'yaml' # also 'json'; default 'text'
+PuppetCheck.puppetlint_args = ['--puppetlint-arg-one', '--puppetlint-arg-two'] # default []
+PuppetCheck.rubocop_args = ['--except', 'rubocop-arg-one,rubocop-arg-two'] # default []
+
+PuppetCheck.new.run([dirs, files])
+
+# rspec checks (as part of a RSpec::Core::RakeTask.new block with |task|)
+require 'puppet-check/rspec_puppet_support'
+
+RSpecPuppetSupport.run
+task.pattern = Dir.glob('**/{classes,defines,facter,functions,hosts,puppet,unit,types}/**/*_spec.rb').reject { |dir| dir =~ /fixtures/ }
+```
+
 ### Docker
 
 You can also use Puppet Check inside of Docker for quick, portable, and disposable testing. Below is an example Dockerfile for this purpose:
@@ -231,7 +268,7 @@ FROM ubuntu:16.04
 # you need ruby and any other extra dependencies that come from packages; in this example we install git to use it for downloading external module dependencies
 RUN apt-get update && apt-get install ruby git -y
 # you need puppet-check and any other extra dependencies that come from gems; in this example we install reek because the ruby ABI is 2.3 and then rspec-puppet and rake for extra testing
-RUN gem install --no-rdoc --no-ri puppet-check reek rspec-puppet rake
+RUN gem install --no-document puppet-check reek rspec-puppet rake
 # this is needed for the ruby json parser to not flip out on fresh os installs for some reason (change encoding value as necessary)
 ENV LANG en_US.UTF-8
 # create the directory for your module, directory environment, etc. and change directory into it
@@ -251,15 +288,15 @@ As an alternative to Docker, you can also use Vagrant for quick and disposable t
 ```ruby
 Vagrant.configure(2) do |config|
   # a reliable and small box at the moment
-  config.vm.box = 'fedora/23'
+  config.vm.box = 'fedora/24-cloud-base'
 
   config.vm.provision 'shell', inline: <<-SHELL
-    # cd to 'sync' if this is recent Vagrant; cd to '/vagrant' if this is older Vagrant
-    cd sync || cd /vagrant
+    # cd to '/vagrant'
+    cd /vagrant
     # you need ruby and any other extra dependencies that come from packages; in this example we install git to use it for downloading external module dependencies
     sudo dnf install ruby rubygems git -y
     # you need puppet-check and any other extra dependencies that come from gems; in this example we install reek because the ruby ABI is 2.2 and then rspec-puppet and rake for extra testing
-    sudo gem install --no-rdoc --no-ri puppet-check reek rspec-puppet rake
+    sudo gem install --no-document puppet-check reek rspec-puppet rake
     # this is needed for the ruby json parser to not flip out on fresh os installs for some reason (change encoding value as necessary)
     export LANG='en_US.UTF-8'
     # execute your tests; in this example we are executing the full suite of tests

data/lib/puppet-check/cli.rb

@@ -21,7 +21,7 @@ class PuppetCheck::CLI
 
       # base options
       opts.on('--version', 'Display the current version.') do
-        puts 'puppet-check 1.3.1'
+        puts 'puppet-check 1.3.2'
         exit 0
       end
 

data/lib/puppet-check/data_parser.rb

@@ -16,7 +16,10 @@ class DataParser
         warnings = []
 
         # perform some rudimentary hiera checks if data exists and is hieradata
-        warnings = hiera(parsed) unless (parsed.class.to_s == 'NilClass') || (file == 'hiera.yaml')
+        warnings = hiera(parsed) unless (parsed.class.to_s == 'NilClass') || (File.basename(file) == 'hiera.yaml')
+
+        # check that '---' does not show up more than once in the hieradata
+        warnings.push('The string --- appears more than once in this data and Hiera will fail to parse it correctly.') if File.read(file).scan(/---/).count >= 2
 
         next PuppetCheck.warning_files.push("#{file}:\n#{warnings.join("\n")}") unless warnings.empty?
         PuppetCheck.clean_files.push(file.to_s)
@@ -100,9 +103,19 @@ class DataParser
 
           # check for requirement and dependency upper bounds
           %w(requirements dependencies).each do |key|
+            # skip if key is missing or not an array
             next if parsed[key].empty?
+            next warnings.push("#{key}'s value is not an array.") unless parsed[key].is_a? Array
             parsed[key].each do |req_dep|
-              warnings.push("'#{req_dep['name']}' is missing an upper bound.") unless req_dep['version_requirement'].include?('<')
+              # warn and skip if key is missing
+              next warnings.push("'#{req_dep['name']}' is missing a 'version_requirement' key.") if req_dep['version_requirement'].class.to_s == 'NilClass'
+              # warn and skip if no upper bound
+              next warnings.push("'#{req_dep['name']}' is missing an upper bound.") unless req_dep['version_requirement'].include?('<')
+
+              # check for semantic versioning
+              if key == 'dependencies'
+                warnings.push("'#{req_dep['name']}' has non-semantic versioning in its 'version_requirement' key.") unless req_dep['version_requirement'] =~ /\d\.\d\.\d.*\d\.\d\.\d/
+              end
             end
           end
 
@@ -124,12 +137,14 @@ class DataParser
   # checks hieradata
   def self.hiera(data)
     warnings = []
+
     data.each do |key, value|
       # check for nil values in the data (nil keys are fine)
       if (value.is_a?(Hash) && value.values.any?(&:nil?)) || (value.class.to_s == 'NilClass')
         warnings.push("Value(s) missing in key '#{key}'.")
       end
     end
+
     warnings
   end
 end

data/lib/puppet-check/rspec_puppet_support.rb

@@ -45,7 +45,7 @@ class RSpecPuppetSupport
 
     # create spec_helper if missing
     return if File.file?('spec/spec_helper.rb')
-    File.open('spec/spec_helper.rb', 'w') { |file| file.puts "require 'rspec-puppet/spec_helper'\n" }
+    File.open('spec/spec_helper.rb', 'w') { |file| file.puts "require 'rspec-puppet'\n\nfixture_path = File.expand_path(File.join(__FILE__, '..', 'fixtures'))\n\nRSpec.configure do |c|\n  c.module_path     = File.join(fixture_path, 'modules')\n  c.manifest_dir    = File.join(fixture_path, 'manifests')\n  c.manifest        = File.join(File.dirname(File.expand_path(__FILE__)), 'fixtures', 'manifests', 'site.pp')\n  c.environmentpath = File.join(Dir.pwd, 'spec')\nend" }
   end
 
   # setup the module dependencies for rspec-puppet testing
@@ -81,7 +81,11 @@ class RSpecPuppetSupport
 
   # download external module dependency with forge
   def self.forge(forge_name, args = '')
-    system("puppet module install --modulepath spec/fixtures/modules/ --force #{args} #{forge_name}")
+    if File.directory?("spec/fixtures/modules/#{forge_name}")
+      system("puppet module upgrade --modulepath spec/fixtures/modules/ #{args} #{forge_name}")
+    else
+      system("puppet module install --modulepath spec/fixtures/modules/ #{args} #{forge_name}")
+    end
   end
 
   # download external module dependency with hg

data/lib/puppet-check/ruby_parser.rb

@@ -43,9 +43,8 @@ class RubyParser
       # check ruby template syntax
       begin
         # need to eventually have this associated with a different binding during each iteration
-        # warnings = Util.capture_stderr { ERB.new(File.read(file), nil, '-').result(RubyParser.new.binding) }
         warnings = Utils.capture_stderr { ERB.new(File.read(file), nil, '-').result }
-      # credits to gds-operations/puppet-syntax for errors to ignore
+        # ERB.new(File.read(file), nil, '-').result(RubyParser.new.bind)
       rescue NameError, TypeError
         # empty out warnings since it would contain an error if this pass triggers
         warnings = ''
@@ -86,7 +85,7 @@ class RubyParser
   end
 
   # potentially for unique erb bindings
-  def binding
+  def bind
     binding
   end
 end

data/spec/fixtures/hieradata/style.yaml

@@ -13,3 +13,4 @@ value:
 and:
   also: 'a'
   subvalue:
+---

data/spec/fixtures/metadata.json

@@ -42,7 +42,7 @@
     },
     {
       "name": "puppetlabs/gruntmaster",
-      "version_requirement": ">= 6000 < 9000",
+      "version_requirement": ">= 6000.0.0 < 9000.0.0",
       "software": "upgradeable"
     }
   ]

data/spec/fixtures/metadata_style_two/metadata.json

@@ -20,7 +20,7 @@
   ],
   "description": "Standard Library for Puppet Modules",
   "dependencies": [
-    { "name": "puppetlabs/one", "version_requirement": ">= 3.2.0 < 5.0.0" },
+    { "name": "puppetlabs/one", "version_requirement": ">= 3.2.0 <= 5.0" },
     { "name": "puppetlabs/two", "version_requirement": ">= 0.0.4" }
   ]
 }

data/spec/puppet-check/data_parser_spec.rb

@@ -18,7 +18,7 @@ describe DataParser do
     it 'puts a good yaml file with potential hiera issues in the warning files array' do
       DataParser.yaml([fixtures_dir + 'hieradata/style.yaml'])
       expect(PuppetCheck.error_files).to eql([])
-      expect(PuppetCheck.warning_files[0]).to match(%r{^#{fixtures_dir}hieradata/style.yaml:\nValue\(s\) missing in key.*\nValue\(s\) missing in key})
+      expect(PuppetCheck.warning_files[0]).to match(%r{^#{fixtures_dir}hieradata/style.yaml:\nValue\(s\) missing in key.*\nValue\(s\) missing in key.*\nThe string --- appears more than once in this data and Hiera will fail to parse it correctly})
       expect(PuppetCheck.clean_files).to eql([])
     end
     it 'puts a good yaml file in the clean files array' do
@@ -51,7 +51,7 @@ describe DataParser do
     it 'puts another bad style metadata json file in the warning files array' do
       DataParser.json([fixtures_dir + 'metadata_style_two/metadata.json'])
       expect(PuppetCheck.error_files).to eql([])
-      expect(PuppetCheck.warning_files[0]).to match(%r{^#{fixtures_dir}metadata_style_two/metadata.json:\n.*operatingsystem.*\n.*operatingsystemrelease.*\n'puppetlabs/two' is missing an upper bound})
+      expect(PuppetCheck.warning_files[0]).to match(%r{^#{fixtures_dir}metadata_style_two/metadata.json:\n.*operatingsystem.*\n.*operatingsystemrelease.*\n'puppetlabs/one' has non-semantic versioning.*\n'puppetlabs/two' is missing an upper bound})
       expect(PuppetCheck.clean_files).to eql([])
     end
     it 'puts a good json file in the clean files array' do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: puppet-check
 version: !ruby/object:Gem::Version
-  version: 1.3.1
+  version: 1.3.2
 platform: ruby
 authors:
 - Matt Schuchard
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-11-11 00:00:00.000000000 Z
+date: 2017-01-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: puppet
@@ -95,7 +95,7 @@ dependencies:
         version: '9'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '12'
+        version: '13'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -105,7 +105,7 @@ dependencies:
         version: '9'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '12'
+        version: '13'
 description: Puppet Check is a gem that provides a comprehensive, streamlined, and
   efficient analysis of the syntax, style, and validity of your entire Puppet code
   and data.