puppet-check 1.1.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9ef6e25a3e4df73cbaddd5f509626cc853b4cb9d
-  data.tar.gz: bbfa05df7d4d1d92f27a0b270d102bf2434c0ecb
+  metadata.gz: 67168965abee351700873ebf5c19daeb0b48bb6f
+  data.tar.gz: e06ae047c9365b3d6595770e1eed47cccac99c5e
 SHA512:
-  metadata.gz: 791c901be64ebca7dc49db9f5aa99940b1e138be58e5fd5605b881b32c97b36819c5bd7d2f353914bd2756c6a0c75f6cfc455de7429d27b20eca099a1a6498d5
-  data.tar.gz: 1e2f6c6c65ee1af874689f9fe2aab3fb7d4865c4047294de7808ed81d7c6541b16c2b2d9e749dac3bf01f16df2b3059f0875533e65e426e1220cc0250a069803
+  metadata.gz: 9b72f7b8da7f5f541d45051ae2aa7bb695e7787973056da53b5541038795fbc5788f823c2c6b235ef7fe6d2dd844b37ae2ee6c6357f3c4d1a88292070b9a7458
+  data.tar.gz: 886bec5a3f9b876aab8a8c6aa2b6724a6d6797fed63103b22d7c872d6b07805e86a0f2a3adecd04d499dd68561bf4959915d9c0d7b8f4515f98375d17948869f

data/CHANGELOG.md

@@ -1,15 +1,30 @@
-### 1.3.0 (Roadmap)
+### 1.4.0 (Roadmap)
 - minimum puppet version bump to 3.5 and future parser enabled by force for version < 4 (search code on 'future')
-- minimum ruby version bump to 2.0.0 (switch vagrant to centos7, remove 1.9.3 from travis.yml, add 2.3.x to travis.yml, update readme, remove psych::syntaxerror from dataparser.yaml, and remove 1.9.3 test from rubyparser.template style spec)
 
-### 1.2.0 (Roadmap)
+### 1.3.0 (Roadmap)
+- minimum ruby version bump to 2.0.0 (switch vagrant to centos7, remove 1.9.3 from travis.yml, add 2.3.x to travis.yml, update readme, remove psych::syntaxerror from dataparser.yaml, and remove 1.9.3 test from rubyparser.template style spec)
+- rakefile interface with puppet-lint, rubocop, reek
 - json and yaml output formats support (error_files becomes hash with file keys and array of issues; refactor output_results)
-- rspec-puppet external dependencies support
-- add additional hiera checks, including nested hash parsing
-- explore puppet-catalog-test integration
+- rudimentary catalog compilation testing?
+
+### 1.2.1 (Roadmap)
+- move rspec_puppet support to separate class
+- improve rspec_puppet_git/forge/hg (check librarian puppet, git man, hg man, forge docs for ideas)
+- direct interface to rubocop and reek in rubyparser
+- add additional hiera checks,
+
+### 1.2.0
+- Support for external module dependencies with RSpecPuppet.
+- Support for nested hash parsing in Hieradata checks.
+- Support for `.puppet-lint.rc` config files in manually specified paths.
+- A few bug fixes for RSpecPuppet support.
+
+### 1.1.1 (yanked from rubygems.org)
+- Rewrote and optimized RSpecPuppet module support.
+- A variety of minor fixes, cleanup, and improvements (e.g. ignored files now outputs in cyan and not blue)
 
 ### 1.1.0
-- Support for RSpec, RSpec-Puppet, and Beaker.
+- Support for RSpec, RSpecPuppet, and Beaker.
 - Empty hieradata file bug fix.
 
 ### 1.0.0

data/README.md

@@ -1,6 +1,14 @@
 # Puppet Check
 [![Build Status](https://travis-ci.org/mschuchard/puppet-check.svg?branch=master)](https://travis-ci.org/mschuchard/puppet-check)
 
+- [Description](#description)
+- [Usage](#usage)
+  - [CLI](#cli)
+  - [Rake](#rake)
+  - [Exit Codes](#exit-codes)
+  - [Optional Dependencies](#optional-dependencies)
+- [Contributing](#contributing)
+
 ## 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.
 
@@ -71,7 +79,8 @@ double quoted string containing no variables at line 2, column 45
 2: previous definition of TEMPLATE was here
 
 -- hieradata/style.yaml:
-Values missing in key 'value'.
+Value(s) missing in key 'value'.
+Value(s) missing in key 'and'.
 
 -- metadata_style/metadata.json:
 License identifier 'Imaginary' is not in the SPDX list: http://spdx.org/licenses/
@@ -101,11 +110,12 @@ The following files have unrecognized formats and therefore were not processed:
 - Puppetlabs Spec Helper does not allow interfacing through it to the gems executing the checks.
 - Puppetlabs Spec Helper has no CLI.
 - Puppetlabs Spec Helper intrinsically only executes spec tests against one module at a time.
+- Puppetlabs Spec Helper requires an additional config file for RSpec Puppet support.
 
-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), you will likely prefer Puppetlabs Spec Helper's spec testing in conjunction with Puppet Check's file validation. Also, Puppet Check currently has no intrinsic support for external dependencies during spec testing, so you will need Puppetlabs Spec Helper or Librarian Puppet for that.
+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), you will likely prefer Puppetlabs Spec Helper's spec testing in conjunction with Puppet Check's file validation.
 
 ## Usage
-Puppet Check requires `ruby >= 1.9.3`, `puppet >= 3.2`, and `puppet-lint >= 1.1.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` during file checks.
+Puppet Check requires `ruby >= 1.9.3`, `puppet >= 3.2`, and `puppet-lint >= 1.1.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.
 
 ### CLI
 ```
@@ -114,13 +124,14 @@ usage: puppet-check [options] paths
     -s, --style                      Enable style checks
         --puppet-lint arg_one,arg_two
                                      Arguments for PuppetLint ignored checks
+    -c, --config file                Load PuppetLint options from file.
         --rubocop arg_one,arg_two    Arguments for Rubocop disabled cops
 ```
 
-The command line interface enables the ability to select the Puppet future parser, additional style checks besides the syntax checks, and to specify PuppetLint and Rubocop checks to ignore. It should be noted that your `.puppet-lint.rc`, `.rubocop.yml`, and `*.reek` files should still be automatically respected by the individual style checkers if you prefer those to a simplified CLI.
+The command line interface enables the ability to select the Puppet future parser, additional style checks besides the syntax checks, and to specify PuppetLint and Rubocop checks to ignore. If you require a more robust interface to PuppetLint, Rubocop, and Reek, then please use `.puppet-lint.rc`, `.rubocop.yml` and `*.reek` config files. The `.puppet-lint.rc` can be specified with the `-c` argument. If it is not specified, then PuppetLint will automatically load one from `.puppet-lint.rc`, `~/.puppet-lint.rc`, or `/etc/puppet-lint.rc`, in that order of preference. The nearest `.rubocop.yml` and `*.reek` will be automatically respected.
 
-```
 Example:
+```
 puppet-check -s --puppet-lint no-hard_tabs-check,no-80chars-check --rubocop Metrics/LineLength,Style/Encoding path/to/code_and_data
 ```
 
@@ -142,14 +153,48 @@ PuppetCheck.style_check = true
 PuppetCheck.future_parser = true
 ```
 
-The style checks from within `rake puppetcheck:file` are directly interfaced to `puppet-lint`, `rubocop`, and `reek`. This means that all arguments and options should be specified from within your `.puppet-lint.rc`, `.rubocop.yml`, and `*.reek`. However, `puppet-lint` can still be interfaced with from within the `Rakefile` with the normal method of `PuppetLint.configuration.send('foo')` after the require. The capability to pass ruby style arguments and options from within the `Rakefile` task block will be considered for future versions.
+The style checks from within `rake puppetcheck:file` are directly interfaced to `puppet-lint`, `rubocop`, and `reek`. This means that all arguments and options should be specified from within your `.puppet-lint.rc`, `.rubocop.yml`, and `*.reek`. The capability to pass style arguments and options from within the `Rakefile` task block will be considered for future versions.
 
 #### puppetcheck:spec
 The spec tests will be executed against everything that matches the pattern `**/{classes, defines, facter, functions, hosts, puppet, unit, types}/**/*_spec.rb`. This means everything in the current path that appears to be a Puppet module spec test will be regarded as such and executed during this rake task.
 
-Please note it is perfectly acceptable to only execute standard RSpec tests in your modules and not use the extended RSpec Puppet matchers. If RSpec Puppet is not installed, then no RSpec Puppet related actions (including those described below) will be performed.
+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.
+
+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`:
+
+```json
+"dependencies": [
+  {
+    "name": "module-name",
+    "forge": "forge-name"
+  },
+  {
+    "name": "module-name",
+    "git": "git-url"
+  },
+  {
+    "name": "module-name",
+    "hg": "hg-url"
+  }
+]
+```
 
-Prior to executing the spec tests, Puppet Check will parse everything in the current path and identify all `spec` directories. It will then execute `RSpec::Puppet::Setup` inside each assumed module directory containing these `spec` directories. This ensures any missing configuration items or non-current symlinks are created without altering your current configuration items, directories, or symlinks. The drawback to this is that your modules will be populated with useless `Rakefiles` if they do not already exist.
+Example:
+
+```json
+"dependencies": [
+  {
+    "name": "puppetlabs/stdlib",
+    "forge": "puppetlabs-stdlib"
+  },
+  {
+    "name": "puppetlabs/lvm",
+    "git": "https://github.com/puppetlabs/puppetlabs-lvm.git"
+  }
+]
+```
 
 #### puppetcheck:beaker
 The spec tests will be executed against everything that matches the pattern `**/acceptance`. This means everything in the current path that appears to be a Puppet module acceptance test will be regarded as such and executed during this rake task.
@@ -162,15 +207,17 @@ Please note this is merely a frontend to Beaker and that Beaker itself has a sel
 - 2: PuppetCheck exited with errors in your Puppet code and data.
 
 ### Optional dependencies
-- **reek**: will automatically be installed as a dependency and checks enabled during style checks if your Ruby version is `>= 2.1.0`.
+- **reek**: will automatically (with `bundler`, otherwise manually) be installed as a dependency and checks enabled during style checks if your Ruby version is `>= 2.1.0`.
 - **rake**: install this if you want to use Puppet Check with `rake` tasks in addition to the CLI.
 - **rspec**: install this if you want to use Puppet Check to execute the spec tests for your ruby files during `rake`.
 - **rspec-puppet**: install this if you want to use Puppet Check to execute the spec tests for your Puppet files during `rake`.
 - **beaker**: install this if you want to use Puppet Check to execute the acceptance tests during `rake`.
+- **git**: install this if you want to use Puppet Check to download external module dependencies with `git` commands during RSpec Puppet testing.
+- **mercurial**: install this if you want to use Puppet Check to download external module dependencies with `hg` commands during RSpec Puppet testing.
 
 ## Contributing
 Code should pass all spec tests. New features should involve new spec tests. Adherence to Rubocop and Reek is expected where not overly onerous or where the check is of dubious cost/benefit.
 
-A `Dockerfile` is provided for easy `rake` testing. A `Vagrantfile` is provided for easy gem building, installation, and post-installation testing.
+A [Dockerfile](Dockerfile) is provided for easy rake testing. A [Vagrantfile](Vagrantfile) is provided for easy gem building, installation, and post-installation testing.
 
-Please consult the `CHANGELOG` for the current development roadmap.
+Please consult the [CHANGELOG](CHANGELOG.md) for the current development roadmap.

data/lib/puppet-check.rb

@@ -18,7 +18,7 @@ class PuppetCheck
   @puppetlint_args = []
   @rubocop_args = []
 
-  # let the parser methods read user options and append to the file arrays; let CLI and tasks write to user options
+  # allow the parser methods read user options and append to the file arrays; allow CLI and tasks write to user options
   class << self
     attr_accessor :future_parser, :style_check, :error_files, :warning_files, :clean_files, :ignored_files, :puppetlint_args, :rubocop_args
   end
@@ -42,7 +42,7 @@ class PuppetCheck
   def parse_paths(paths)
     files = []
 
-    # traverse the unique paths, return all files, and replace // with /
+    # traverse the unique paths and return all files
     paths.uniq.each do |path|
       if File.directory?(path)
         files.concat(Dir.glob("#{path}/**/*").select { |subpath| File.file? subpath })
@@ -54,7 +54,7 @@ class PuppetCheck
     files.reject! { |file| file =~ /fixtures/ }
 
     # check that at least one file was found, remove double slashes, and return unique files
-    raise "No files found in supplied paths #{paths.join(', ')}." if files.empty?
+    raise "puppet-check: no files found in supplied paths #{paths.join(', ')}." if files.empty?
     files.map! { |file| file.gsub('//', '/') }
     files.uniq
   end
@@ -69,12 +69,12 @@ class PuppetCheck
     files.reject! { |file| File.extname(file) == '.rb' }
     RubyParser.template(files.select { |file| File.extname(file) == '.erb' })
     files.reject! { |file| File.extname(file) == '.erb' }
-    DataParser.yaml(files.select { |file| file =~ /.*\.ya?ml$/ })
-    files.reject! { |file| file =~ /.*\.ya?ml$/ }
+    DataParser.yaml(files.select { |file| File.extname(file) =~ /\.ya?ml$/ })
+    files.reject! { |file| File.extname(file) =~ /\.ya?ml$/ }
     DataParser.json(files.select { |file| File.extname(file) == '.json' })
     files.reject! { |file| File.extname(file) == '.json' }
-    RubyParser.librarian(files.select { |file| file =~ /.*(Puppet|Module|Rake|Gem)file$/ })
-    files.reject! { |file| file =~ /.*(?:Puppet|Module|Rake|Gem)file$/ }
+    RubyParser.librarian(files.select { |file| File.basename(file) =~ /(?:Puppet|Module|Rake|Gem)file$/ })
+    files.reject! { |file| File.basename(file) =~ /(?:Puppet|Module|Rake|Gem)file$/ }
     files.each { |file| self.class.ignored_files.push("-- #{file}") }
   end
 
@@ -83,6 +83,6 @@ class PuppetCheck
     puts "\033[31mThe following files have errors:\033[0m", error_files.join("\n\n") unless error_files.empty?
     puts "\n\033[33mThe following files have warnings:\033[0m", warning_files.join("\n\n") unless warning_files.empty?
     puts "\n\033[32mThe following files have no errors or warnings:\033[0m", clean_files unless clean_files.empty?
-    puts "\n\033[34mThe following files have unrecognized formats and therefore were not processed:\033[0m", ignored_files unless ignored_files.empty?
+    puts "\n\033[36mThe following files have unrecognized formats and therefore were not processed:\033[0m", ignored_files unless ignored_files.empty?
   end
 end

data/lib/puppet-check/cli.rb

@@ -23,7 +23,10 @@ class PuppetCheck::CLI
       opts.on('-s', '--style', 'Enable style checks') { PuppetCheck.style_check = true }
       # arguments to style checkers
       opts.on('--puppet-lint arg_one,arg_two', Array, 'Arguments for PuppetLint ignored checks') do |puppetlint_args|
-        PuppetCheck.puppetlint_args = puppetlint_args.map { |arg| "--#{arg}" }
+        PuppetCheck.puppetlint_args += puppetlint_args.map { |arg| "--#{arg}" }
+      end
+      opts.on('-c', '--config file', 'Load PuppetLint options from file.') do |file|
+        PuppetCheck.puppetlint_args += File.read(file).split("\n")
       end
       opts.on('--rubocop arg_one,arg_two', String, 'Arguments for Rubocop disabled cops') { |arg| PuppetCheck.rubocop_args = ['--except', arg] }
     end

data/lib/puppet-check/data_parser.rb

@@ -35,8 +35,8 @@ class DataParser
         warnings = []
 
         # check metadata.json
-        if file =~ /.*metadata\.json$/
-          # metadata-json-lint has issues and is essentially no longer maintained so here is an improved and leaner version of it
+        if File.basename(file) == 'metadata.json'
+          # metadata-json-lint has issues and is essentially no longer maintained, so here is an improved and leaner version of it
           require 'spdx-licenses'
 
           # check for errors
@@ -44,7 +44,7 @@ class DataParser
 
           # check for required keys
           %w(name version author license summary source dependencies).each do |key|
-            errors.push("Required field '#{key}' not found in metadata.json.") unless parsed.key?(key)
+            errors.push("Required field '#{key}' not found.") unless parsed.key?(key)
           end
 
           # check for duplicate dependencies and requirements
@@ -73,6 +73,7 @@ class DataParser
           if parsed.key?('license') && !SpdxLicenses.exist?(parsed['license']) && parsed['license'] !~ /[pP]roprietary/
             warnings.push("License identifier '#{parsed['license']}' is not in the SPDX list: http://spdx.org/licenses/")
           end
+        # assume this is hieradata
         else
           # perform some rudimentary hiera checks if data exists
           warnings = hiera(parsed) unless parsed.class.to_s == 'NilClass'
@@ -87,7 +88,10 @@ class DataParser
   def self.hiera(data)
     warnings = []
     data.each do |key, value|
-      warnings.push("Values missing in key '#{key}'.") if value.class.to_s == 'NilClass'
+      # 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

data/lib/puppet-check/puppet_parser.rb

@@ -47,7 +47,7 @@ class PuppetParser
 
         # collect the warnings
         if puppet_lint.warnings?
-          puppet_lint.problems.each { |values| warnings += "\n#{values[:message]} at line #{values[:line]}, column #{values[:column]}" }
+          puppet_lint.problems.each { |values| warnings += "\n#{values[:line]}:#{values[:column]}: #{values[:message]}" }
         end
       end
       next PuppetCheck.warning_files.push(warnings) unless warnings == "-- #{file}:"
@@ -61,7 +61,7 @@ class PuppetParser
 
     files.each do |file|
       # puppet before version 4 cannot check template syntax
-      next PuppetCheck.ignored_files.push("-- #{file}: ignored due to Puppet Agent < 4.0.0") if Puppet::PUPPETVERSION.to_i < 4
+      next PuppetCheck.ignored_files.push("-- #{file}: ignored due to Puppet < 4.0.0") if Puppet::PUPPETVERSION.to_i < 4
 
       # check puppet template syntax
       begin

data/lib/puppet-check/ruby_parser.rb

@@ -8,6 +8,7 @@ class RubyParser
     files.each do |file|
       # check ruby syntax
       begin
+        # prevents ruby code from actually executing
         catch(:good) { instance_eval("BEGIN {throw :good}; #{File.read(file)}") }
       rescue ScriptError, StandardError => err
         PuppetCheck.error_files.push("-- #{file}:\n#{err}")
@@ -20,7 +21,7 @@ class RubyParser
           rubocop_warnings = Utils.capture_stdout { RuboCop::CLI.new.run(PuppetCheck.rubocop_args + ['--format', 'emacs', file]) }
           warnings = rubocop_warnings == '' ? '' : rubocop_warnings.split("#{File.absolute_path(file)}:").join('')
 
-          # check Reek
+          # check Reek and collect warnings
           if Gem::Version.new(RUBY_VERSION.dup) >= Gem::Version.new('2.1.0')
             require 'reek'
             require 'reek/cli/application'
@@ -62,19 +63,20 @@ class RubyParser
   # checks librarian puppet (Puppetfile/Modulefile) and misc ruby (Rakefile/Gemfile)
   def self.librarian(files)
     files.each do |file|
+      # check librarian puppet syntax
       begin
-        # check librarian puppet syntax
+        # prevents ruby code from actually executing
         catch(:good) { instance_eval("BEGIN {throw :good}; #{File.read(file)}") }
       rescue SyntaxError, LoadError, ArgumentError => err
         PuppetCheck.error_files.push("-- #{file}:\n#{err}")
+      # check librarian puppet style
       else
-        # check librarian puppet style
         if PuppetCheck.style_check
           require 'rubocop'
 
           # check Rubocop
           rubocop_args = PuppetCheck.rubocop_args.clone
-          # RuboCop is confused about the first 'mod' argument in librarian puppet (and Rakefiles and Gemfiles) so disable the Style/FileName check
+          # RuboCop is confused about the first 'mod' argument in librarian puppet (and first requires in Rakefiles and Gemfiles) so disable the Style/FileName check
           rubocop_args.include?('--except') ? rubocop_args[rubocop_args.index('--except') + 1] = "#{rubocop_args[rubocop_args.index('--except') + 1]},Style/FileName" : rubocop_args.concat(['--except', 'Style/FileName'])
           warnings = Utils.capture_stdout { RuboCop::CLI.new.run(rubocop_args + ['--format', 'emacs', file]) }
 

data/lib/puppet-check/tasks.rb

@@ -21,33 +21,105 @@ class PuppetCheck::Tasks < ::Rake::TaskLib
 
       desc 'Execute RSpec and RSpec-Puppet tests'
       RSpec::Core::RakeTask.new(:spec) do |task|
-        rspec_puppet_setup
-        # generate tasks for all recognized directories inside of spec directories
-        task.pattern = '**/{classes, defines, facter, functions, hosts, puppet, unit, types}/**/*_spec.rb'
+        self.class.rspec_puppet_setup
+        # generate tasks for all recognized directories and ensure spec tests inside module dependencies are ignored
+        spec_dirs = Dir.glob('**/{classes,defines,facter,functions,hosts,puppet,unit,types}/**/*_spec.rb').reject { |dir| dir =~ /fixtures/ }
+        task.pattern = spec_dirs.empty? ? 'skip_rspec' : spec_dirs
       end
 
       desc 'Execute Beaker acceptance tests'
       RSpec::Core::RakeTask.new(:beaker) do |task|
-        task.pattern = '**/acceptance'
+        # generate tasks for all recognized directories and ensure acceptance tests inside module dependencies are ignored
+        acceptance_dirs = Dir.glob('**/acceptance').reject { |dir| dir =~ /fixtures/ }
+        task.pattern = acceptance_dirs.empty? ? 'skip_beaker' : acceptance_dirs
       end
     end
   end
 
-  # prepare the directories for rspec-puppet testing
-  def rspec_puppet_setup
-    # leave method immediately if there is no rspec-puppet installed
-    begin
-      require 'rspec-puppet/setup'
-    rescue LoadError
-      return
-    end
+  # code diagram for rspec-puppet support:
+  # puppetcheck:spec task invokes rspec_puppet_setup
+  # rspec_puppet_setup invokes rspec_puppet_file_setup always and rspec_puppet_dependency_setup if metadata.json exists
+  # rspec_puppet_dependency_setup invokes rspec_puppet_git/forge/hg if git/forge/hg is download option and dependencies exist
+
+  # prepare the spec fixtures directory for rspec-puppet testing
+  def self.rspec_puppet_setup
+    # ensure this method does not do anything inside module dependencies
+    specdirs = Dir.glob('**/spec').reject { |dir| dir =~ /fixtures/ }
+    return if specdirs.class.to_s == 'NilClass'
+
+    # setup fixtures for rspec-puppet testing
+    specdirs.each do |specdir|
+      # skip to next specdir if it does not seem like a puppet module
+      next unless File.directory?(specdir + '/../manifests')
 
-    # executes rspec::puppet::setup in every module directory to ensure module spec directories are configured correctly
-    Dir.glob('**/spec').each do |specdir|
+      # move up to module directory
       Dir.chdir(specdir + '/..')
-      RSpec::Puppet::Setup.run
+
+      # grab the module name from the directory name of the module to pass to rspec_puppet_file_setup
+      rspec_puppet_file_setup(File.basename(Dir.pwd))
+
+      # invoke rspec_puppet_dependency_setup for module dependencies if metadata.json present
+      rspec_puppet_dependency_setup if File.file?('metadata.json')
+    end
+  end
+
+  # setup the files, directories, and symlinks for rspec-puppet testing
+  def self.rspec_puppet_file_setup(module_name)
+    # create all the necessary fixture dirs that are missing
+    ['spec/fixtures', 'spec/fixtures/manifests', 'spec/fixtures/modules', "spec/fixtures/modules/#{module_name}"].each do |dir|
+      FileUtils.mkdir(dir) unless File.directory?(dir)
+    end
+
+    # create empty site.pp if missing
+    FileUtils.touch('spec/fixtures/manifests/site.pp') unless File.file?('spec/fixtures/manifests/site.pp')
+
+    # symlink over everything the module needs for compilation
+    %w(hiera.yaml data hieradata functions manifests lib files templates).each do |file|
+      FileUtils.ln_s("../../../../#{file}", "spec/fixtures/modules/#{module_name}/#{file}") if File.exist?(file) && !File.exist?("spec/fixtures/modules/#{module_name}/#{file}")
+    end
+
+    # create spec_helper if missing
+    unless File.file?('spec/spec_helper.rb')
+      File.open('spec/spec_helper.rb', 'w') { |file| file.puts "require 'rspec-puppet/spec_helper'\n" }
+    end
+  end
+
+  # setup the module dependencies for rspec-puppet testing
+  def self.rspec_puppet_dependency_setup
+    # parse the metadata.json (assumes PuppetCheck file checks have already given it a pass)
+    parsed = JSON.parse(File.read('metadata.json'))
+
+    # grab dependencies if they exist
+    unless parsed['dependencies'].empty?
+      parsed['dependencies'].each do |dependency_hash|
+        # determine how the user wants to download the module dependency
+        if dependency_hash.key?('git')
+          rspec_puppet_git(dependency_hash['git'])
+        elsif dependency_hash.key?('forge')
+          rspec_puppet_forge(dependency_hash['forge'])
+        elsif dependency_hash.key?('hg')
+          rspec_puppet_hg(dependency_hash['hg'])
+        else
+          warn "#{dependency_hash['name']} has an unspecified, or specified but unsupported, download method."
+        end
+      end
     end
   end
+
+  # download external module dependency with git
+  def self.rspec_puppet_git(git_url)
+    system("git -C spec/fixtures/modules/ clone #{git_url}")
+  end
+
+  # download external module dependency with forge
+  def self.rspec_puppet_forge(forge_name)
+    system("puppet module install #{forge_name} --modulepath spec/fixtures/modules/ --force")
+  end
+
+  # download external module dependency with hg
+  def self.rspec_puppet_hg(hg_url)
+    system("hg --cwd spec/fixtures/modules/ clone #{hg_url}")
+  end
 end
 
 PuppetCheck::Tasks.new

data/spec/fixtures/manifests/good.pp

@@ -1,4 +1 @@
-# class is for rspec-puppet to generate module name for testing
-class fixtures::good {
-  notify { 'i am a good manifest': }
-}
+notify { 'i am a good manifest': }

data/spec/fixtures/metadata.json

@@ -0,0 +1,49 @@
+{
+  "name": "puppetlabs-awesomesauce",
+  "version": "1.1.1",
+  "author": "puppetlabs",
+  "summary": "Makes sauce that is awesome.",
+  "license": "Proprietary",
+  "source": "https://github.com/puppetlabs/puppetlabs-awesomesauce",
+  "project_page": "https://github.com/puppetlabs/puppetlabs-awesomesauce",
+  "issues_url": "https://tickets.puppetlabs.com/browse/MODULES",
+  "operatingsystem_support": [
+    {
+      "operatingsystem": "RedHat",
+      "operatingsystemrelease": [
+        "100",
+        "5",
+        "6",
+        "7"
+      ]
+    }
+  ],
+  "requirements": [
+    {
+      "name": "pe",
+      "version_requirement": ">= 3.0.0 < 2035.1.0"
+    },
+    {
+      "name": "puppet",
+      "version_requirement": ">=2.7.20 <5.0.0"
+    }
+  ],
+  "description": "Makes sauce that is awesome. What part of that is confusing?",
+  "dependencies": [
+    {
+      "name": "puppetlabs/stdlib",
+      "version_requirement": ">= 4.1.0 < 5.0.0",
+      "forge": "puppetlabs-stdlib"
+    },
+    {
+      "name": "puppetlabs/lvm",
+      "version_requirement": ">= 0.5.0 < 1.0.0",
+      "git": "https://github.com/puppetlabs/puppetlabs-lvm.git"
+    },
+    {
+      "name": "puppetlabs/gruntmaster",
+      "version_requirement": ">= 6000 < 9000",
+      "software": "upgradeable"
+    }
+  ]
+}

data/spec/puppet-check/cli_spec.rb

@@ -27,6 +27,12 @@ describe PuppetCheck::CLI do
       expect(PuppetCheck.puppetlint_args).to eql(['--puppetlint-arg-one', '--puppetlint-arg-two'])
     end
 
+    it 'correctly loads a .puppet-lint.rc' do
+      PuppetCheck.puppetlint_args = []
+      PuppetCheck::CLI.parse(%W(-c #{fixtures_dir}/manifests/.puppet-lint.rc))
+      expect(PuppetCheck.puppetlint_args).to eql(['--puppetlint-arg-one', '--puppetlint-arg-two'])
+    end
+
     it 'correctly parses Rubocop arguments' do
       PuppetCheck.rubocop_args = []
       PuppetCheck::CLI.parse(%w(--rubocop rubocop-arg-one,rubocop-arg-two foo))

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:\nValues 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})
       expect(PuppetCheck.clean_files).to eql([])
     end
     it 'puts a good yaml file in the clean files array' do

data/spec/puppet-check/puppet_parser_spec.rb

@@ -23,14 +23,14 @@ describe PuppetParser do
       PuppetCheck.style_check = true
       PuppetParser.manifest([fixtures_dir + 'manifests/style_parser.pp'])
       expect(PuppetCheck.error_files).to eql([])
-      expect(PuppetCheck.warning_files[0]).to match(%r{^\-\- #{fixtures_dir}manifests/style_parser.pp:\nUnrecognized escape sequence.*\nUnrecognized escape sequence.*\ndouble quoted string containing})
+      expect(PuppetCheck.warning_files[0]).to match(%r{^\-\- #{fixtures_dir}manifests/style_parser.pp:\nUnrecognized escape sequence.*\nUnrecognized escape sequence.*\n.*double quoted string containing})
       expect(PuppetCheck.clean_files).to eql([])
     end
     it 'puts a bad lint style Puppet manifest in the warning files array' do
       PuppetCheck.style_check = true
       PuppetParser.manifest([fixtures_dir + 'manifests/style_lint.pp'])
       expect(PuppetCheck.error_files).to eql([])
-      expect(PuppetCheck.warning_files[0]).to match(%r{^\-\- #{fixtures_dir}manifests/style_lint.pp:\ndouble quoted string containing.*\nindentation of})
+      expect(PuppetCheck.warning_files[0]).to match(%r{^\-\- #{fixtures_dir}manifests/style_lint.pp:\n.*double quoted string containing.*\n.*indentation of})
       expect(PuppetCheck.clean_files).to eql([])
     end
     it 'puts a bad style Puppet manifest in the clean files array when puppetlint_args ignores its warnings' do

data/spec/puppet-check/tasks_spec.rb

@@ -10,22 +10,50 @@ describe PuppetCheck::Tasks do
       Dir.chdir(fixtures_dir)
 
       # rspec task executed
-      expect { spec_tasks }.to output(/ruby.*rspec/).to_stdout
+      expect { spec_tasks }.to output(%r{spec/facter/facter_spec.rb}).to_stdout
       # if this is first then the stdout is not captured for testing
       expect { spec_tasks }.not_to raise_exception
-      # rspec-puppet setup executed
-      expect(File.directory?('spec/fixtures/modules/fixtures')).to be true
 
-      # cleanup rspec-puppet setup
-      %w(Rakefile spec/spec_helper.rb).each { |file| File.delete(file) }
+      # cleanup rspec_puppet_setup
+      %w(spec/spec_helper.rb).each { |file| File.delete(file) }
       %w(manifests modules).each { |dir| FileUtils.rm_r('spec/fixtures/' + dir) }
     end
   end
 
   context 'puppetcheck:beaker' do
+    let(:beaker_tasks) { Rake::Task['puppetcheck:beaker'.to_sym].invoke }
+
     it 'verifies the Beaker task exists' do
       Dir.chdir(fixtures_dir)
-      expect { Rake::Task['puppetcheck:spec'.to_sym].invoke }.not_to raise_exception
+
+      # beaker task executed
+      expect { beaker_tasks }.to output(%r{spec/acceptance}).to_stdout
+      expect { beaker_tasks }.not_to raise_exception
+    end
+  end
+
+  context '.rspec_puppet_setup' do
+    let(:rspec_puppet_setup) { PuppetCheck::Tasks.rspec_puppet_setup }
+    before(:each) { Dir.chdir(fixtures_dir) }
+
+    it 'creates missing directories, missing site.pp, missing symlinks, and a missing spec_helper' do
+      expect { rspec_puppet_setup }.to output("puppetlabs/gruntmaster has an unspecified, or specified but unsupported, download method.\n").to_stderr
+
+      expect(File.directory?('spec/fixtures/manifests')).to be true
+      expect(File.directory?('spec/fixtures/modules/fixtures')).to be true
+      expect(File.file?('spec/fixtures/manifests/site.pp')).to be true
+      expect(File.symlink?('spec/fixtures/modules/fixtures/hieradata')).to be true
+      expect(File.symlink?('spec/fixtures/modules/fixtures/manifests')).to be true
+      expect(File.symlink?('spec/fixtures/modules/fixtures/lib')).to be true
+      expect(File.symlink?('spec/fixtures/modules/fixtures/templates')).to be true
+      expect(File.file?('spec/spec_helper.rb')).to be true
+
+      expect(File.directory?('spec/fixtures/modules/puppetlabs-lvm')).to be true
+      expect(File.directory?('spec/fixtures/modules/stdlib')).to be true
+
+      # cleanup rspec_puppet_setup
+      %w(spec/spec_helper.rb).each { |file| File.delete(file) }
+      %w(manifests modules).each { |dir| FileUtils.rm_r('spec/fixtures/' + dir) }
     end
   end
 end

data/spec/puppet-check_spec.rb

@@ -4,7 +4,7 @@ require_relative '../lib/puppet-check'
 describe PuppetCheck do
   let(:puppetcheck) { PuppetCheck.new }
 
-  context 'initializes and' do
+  context 'self' do
     it 'future parser can be altered' do
       PuppetCheck.future_parser = true
       expect(PuppetCheck.future_parser).to eql(true)
@@ -33,7 +33,7 @@ describe PuppetCheck do
     let(:repeats) { puppetcheck.parse_paths(['hieradata', 'hieradata', 'lib', 'hieradata/good.json', 'manifests/good.pp', 'manifests/good.pp']) }
 
     it 'raises an error if no files were found' do
-      expect { no_files }.to raise_error(RuntimeError, 'No files found in supplied paths foo, bar, baz.')
+      expect { no_files }.to raise_error(RuntimeError, 'puppet-check: no files found in supplied paths foo, bar, baz.')
     end
 
     it 'correctly parses one file and returns it' do
@@ -42,7 +42,7 @@ describe PuppetCheck do
 
     it 'correctly parses one directory and returns all of its files' do
       dir.each { |file| expect(File.file?(file)).to be true }
-      expect(dir.length).to eql(27)
+      expect(dir.length).to eql(28)
     end
 
     it 'correctly parses multiple directories and returns all of their files' do
@@ -78,7 +78,7 @@ describe PuppetCheck do
     end
     it 'outputs files that were not processed' do
       PuppetCheck.ignored_files = ['-- foo: who knows what i am']
-      expect { PuppetCheck.output_results }.to output("\n\033[34mThe following files have unrecognized formats and therefore were not processed:\033[0m\n-- foo: who knows what i am\n").to_stdout
+      expect { PuppetCheck.output_results }.to output("\n\033[36mThe following files have unrecognized formats and therefore were not processed:\033[0m\n-- foo: who knows what i am\n").to_stdout
     end
   end
 end

data/spec/{integration/integration_spec.rb → system/system_spec.rb}

@@ -14,7 +14,7 @@ describe 'PuppetCheck' do
       expect { cli }.not_to raise_exception
       expect(PuppetCheck.error_files.length).to eql(8)
       expect(PuppetCheck.warning_files.length).to eql(8)
-      expect(PuppetCheck.clean_files.length).to eql(10)
+      expect(PuppetCheck.clean_files.length).to eql(11)
       expect(PuppetCheck.ignored_files.length).to eql(1)
     end
   end
@@ -35,7 +35,7 @@ describe 'PuppetCheck' do
       expect { tasks }.not_to raise_exception
       expect(PuppetCheck.error_files.length).to eql(8)
       expect(PuppetCheck.warning_files.length).to eql(8)
-      expect(PuppetCheck.clean_files.length).to eql(10)
+      expect(PuppetCheck.clean_files.length).to eql(11)
       expect(PuppetCheck.ignored_files.length).to eql(1)
     end
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: puppet-check
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.2.0
 platform: ruby
 authors:
 - Matt Schuchard
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-05-22 00:00:00.000000000 Z
+date: 2016-06-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: puppet
@@ -106,20 +106,6 @@ dependencies:
     - - "<"
       - !ruby/object:Gem::Version
         version: '12'
-- !ruby/object:Gem::Dependency
-  name: rspec-puppet
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.0'
 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.
@@ -157,6 +143,7 @@ files:
 - spec/fixtures/manifests/style_lint.pp
 - spec/fixtures/manifests/style_parser.pp
 - spec/fixtures/manifests/syntax.pp
+- spec/fixtures/metadata.json
 - spec/fixtures/metadata_good/metadata.json
 - spec/fixtures/metadata_style/metadata.json
 - spec/fixtures/metadata_syntax/metadata.json
@@ -168,7 +155,6 @@ files:
 - spec/fixtures/templates/style.erb
 - spec/fixtures/templates/syntax.epp
 - spec/fixtures/templates/syntax.erb
-- spec/integration/integration_spec.rb
 - spec/puppet-check/cli_spec.rb
 - spec/puppet-check/data_parser_spec.rb
 - spec/puppet-check/puppet_parser_spec.rb
@@ -177,6 +163,7 @@ files:
 - spec/puppet-check/utils_spec.rb
 - spec/puppet-check_spec.rb
 - spec/spec_helper.rb
+- spec/system/system_spec.rb
 homepage: https://www.github.com/mschuchard/puppet-check
 licenses:
 - MIT
@@ -220,6 +207,7 @@ test_files:
 - spec/fixtures/manifests/style_lint.pp
 - spec/fixtures/manifests/style_parser.pp
 - spec/fixtures/manifests/syntax.pp
+- spec/fixtures/metadata.json
 - spec/fixtures/metadata_good/metadata.json
 - spec/fixtures/metadata_style/metadata.json
 - spec/fixtures/metadata_syntax/metadata.json
@@ -231,7 +219,6 @@ test_files:
 - spec/fixtures/templates/style.erb
 - spec/fixtures/templates/syntax.epp
 - spec/fixtures/templates/syntax.erb
-- spec/integration/integration_spec.rb
 - spec/puppet-check/cli_spec.rb
 - spec/puppet-check/data_parser_spec.rb
 - spec/puppet-check/puppet_parser_spec.rb
@@ -240,3 +227,4 @@ test_files:
 - spec/puppet-check/utils_spec.rb
 - spec/puppet-check_spec.rb
 - spec/spec_helper.rb
+- spec/system/system_spec.rb