puppet-check 1.2.0 → 1.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 67168965abee351700873ebf5c19daeb0b48bb6f
-  data.tar.gz: e06ae047c9365b3d6595770e1eed47cccac99c5e
+  metadata.gz: 1b2722f210a74837313e3463c41abd5f07018fcf
+  data.tar.gz: 5f36ae7fb5b25c86f4da1c56391aeacb61e14363
 SHA512:
-  metadata.gz: 9b72f7b8da7f5f541d45051ae2aa7bb695e7787973056da53b5541038795fbc5788f823c2c6b235ef7fe6d2dd844b37ae2ee6c6357f3c4d1a88292070b9a7458
-  data.tar.gz: 886bec5a3f9b876aab8a8c6aa2b6724a6d6797fed63103b22d7c872d6b07805e86a0f2a3adecd04d499dd68561bf4959915d9c0d7b8f4515f98375d17948869f
+  metadata.gz: 93a0d80d2958ff85aa42f28936b0988f8cbab2701f2a49e9b44eeb4e44fa9a2bd006b606e82de10939451d0656c27f38521c0d72fa1546fb3f5ea01e83c5d6fd
+  data.tar.gz: 44d9243626055c3e2578e6c6c5ef6bb1b5a89978a543caa7a12588e319f1b52620d948fc20d6989ba3c535d02ecb43c407992bece46ecaf419c0c4bdad305dc5

data/CHANGELOG.md

@@ -1,17 +1,17 @@
-### 1.4.0 (Roadmap)
-- minimum puppet version bump to 3.5 and future parser enabled by force for version < 4 (search code on 'future')
-
 ### 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)
+- minimum puppet version bump to 3.4
 - 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)
 - rudimentary catalog compilation testing?
+- rspec puppet stubbing
+- infrataster and analogous docker task like thing ripienaar did?
+- add additional hiera checks
 
-### 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.1
+- Code and output cleanup.
+- Add arguments support to external module download methods.
+- PuppetLint dependency version updated for 2.0 release.
 
 ### 1.2.0
 - Support for external module dependencies with RSpecPuppet.

data/README.md

@@ -5,6 +5,7 @@
 - [Usage](#usage)
   - [CLI](#cli)
   - [Rake](#rake)
+  - [Docker](#docker)
   - [Exit Codes](#exit-codes)
   - [Optional Dependencies](#optional-dependencies)
 - [Contributing](#contributing)
@@ -112,10 +113,13 @@ The following files have unrecognized formats and therefore were not processed:
 - 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.
+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.
 
 ## 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` or specified paths with that directory during file checks.
+Puppet Check requires `ruby >= 1.9.3`, `puppet >= 3.2`, 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.
+
+#### Important Note for Ruby 1.9.3
+If you are using Ruby 1.9.3, there is currently an issue where Hiera has an unspecified version dependency on JSonPure. Since JSonPure 2.0.2 requires `ruby >= 2.0.0`, this breaks Hiera installs on Ruby 1.9.3, which breaks Puppet installs, which breaks PuppetCheck installs. Therefore, you will need to restrict your installed version of JSonPure to something lower than 2.0.2 if you are using Ruby 1.9.3. A ticket with Puppet has been filed by me for this issue, so hopefully a resolution is forthcoming.
 
 ### CLI
 ```
@@ -132,7 +136,7 @@ The command line interface enables the ability to select the Puppet future parse
 
 Example:
 ```
-puppet-check -s --puppet-lint no-hard_tabs-check,no-80chars-check --rubocop Metrics/LineLength,Style/Encoding path/to/code_and_data
+puppet-check -s --puppet-lint no-hard_tabs-check,no-140chars-check --rubocop Metrics/LineLength,Style/Encoding path/to/code_and_data
 ```
 
 ### Rake
@@ -156,11 +160,11 @@ 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`. 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.
+The spec tests will be executed against everything that matches the pattern `**/{classes, defines, facter, functions, hosts, puppet, unit, types}/**/*_spec.rb`. Any of these directories inside of a `fixtures` directory will be ignored. This means everything in the current path that appears to be a Puppet module spec test for your module (not dependencies) 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 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.
+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`:
 
@@ -168,15 +172,18 @@ Puppet Check will also automatically download specified external module dependen
 "dependencies": [
   {
     "name": "module-name",
-    "forge": "forge-name"
+    "forge": "forge-name",
+    "args": "puppet module install optional-arguments"
   },
   {
     "name": "module-name",
-    "git": "git-url"
+    "git": "git-url",
+    "args": "git clone optional-arguments"
   },
   {
     "name": "module-name",
-    "hg": "hg-url"
+    "hg": "hg-url",
+    "args": "hg clone optional-arguments"
   }
 ]
 ```
@@ -187,7 +194,8 @@ Example:
 "dependencies": [
   {
     "name": "puppetlabs/stdlib",
-    "forge": "puppetlabs-stdlib"
+    "forge": "puppetlabs-stdlib",
+    "args": "--do-something-cool"
   },
   {
     "name": "puppetlabs/lvm",
@@ -197,14 +205,37 @@ Example:
 ```
 
 #### 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.
+The spec tests will be executed against everything that matches the pattern `**/acceptance`. Any of these directories inside of a `fixtures` directory will be ignored. This means everything in the current path that appears to be a Puppet module acceptance test for your module (not dependencies) will be regarded as such and executed during this rake task.
 
 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.
 
+### Docker
+
+You can also use Puppet Check inside of Docker for quick, portable, and disposable testing. Below is an example Dockerfile for this purpose:
+
+```dockerfile
+# a reliable and small container at the moment
+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
+# 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 and change directory into it
+WORKDIR /module_name
+# copy the module contents into the module directory inside the container
+COPY / .
+# execute your tests; in this example we are executing the full suite of tests for this module
+RUN rake puppetcheck
+```
+
+You can also build your own general container for testing various Puppet situations by removing the last three lines. You can then test each module, directory environment, etc. on top of that container by merely adding and modifying the final three lines to a Dockerfile that uses the container you built from the first four lines. This is recommended usage due to being very efficient and stable.
+
 ### Exit Codes
 - 0: PuppetCheck exited with no internal exceptions or errors in your Puppet code and data.
 - 1: PuppetCheck exited with an internal exception (takes preference over other non-zero exit codes).
-- 2: PuppetCheck exited with errors in your Puppet code and data.
+- 2: PuppetCheck exited with one or more errors in your Puppet code and data.
 
 ### Optional dependencies
 - **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`.

data/lib/puppet-check.rb

@@ -26,7 +26,7 @@ class PuppetCheck
   # main runner for PuppetCheck
   def run(paths)
     # grab all of the files to be processed
-    files = parse_paths(paths)
+    files = self.class.parse_paths(paths)
 
     # parse the files
     execute_parsers(files)
@@ -39,7 +39,7 @@ class PuppetCheck
   end
 
   # parse the paths and return the array of files
-  def parse_paths(paths)
+  def self.parse_paths(paths)
     files = []
 
     # traverse the unique paths and return all files
@@ -50,12 +50,12 @@ class PuppetCheck
         files.push(path)
       end
     end
-    # do not process fixtures
-    files.reject! { |file| file =~ /fixtures/ }
 
-    # check that at least one file was found, remove double slashes, and return unique files
+    # do not process fixtures, check that at least one file was found, and remove double slashes
+    files.reject! { |file| file =~ /fixtures/ }
     raise "puppet-check: no files found in supplied paths #{paths.join(', ')}." if files.empty?
     files.map! { |file| file.gsub('//', '/') }
+
     files.uniq
   end
 

data/lib/puppet-check/cli.rb

@@ -5,6 +5,7 @@ require_relative '../puppet-check'
 class PuppetCheck::CLI
   # run method for the cli
   def self.run(args)
+    # gather the user arguments
     parse(args)
     raise 'puppet-check: no paths specified' if args.empty?
 
@@ -18,14 +19,21 @@ class PuppetCheck::CLI
       # usage
       opts.banner = 'usage: puppet-check [options] paths'
 
+      # base options
+      opts.on('--version', 'Display the current version.') do
+        puts 'puppet-check 1.2.1'
+        exit 0
+      end
+
       # bool options
       opts.on('-f', '--future', 'Enable future parser') { PuppetCheck.future_parser = true }
       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}" }
       end
-      opts.on('-c', '--config file', 'Load PuppetLint options from file.') do |file|
+      opts.on('-c', '--config file', String, '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] }

data/lib/puppet-check/puppet_parser.rb

@@ -24,7 +24,7 @@ class PuppetParser
         next PuppetCheck.error_files.push("-- #{file}:\n#{errors.map(&:to_s).join("\n").gsub("#{File.absolute_path(file)}:", '')}")
       end
 
-      # initialize warnings with output from the parser if it exists since they are warnings if they did not trigger a SystemExit
+      # initialize warnings with output from the parser if it exists, since the output is warnings if Puppet::Face did not trigger a SystemExit
       warnings = errors.empty? ? "-- #{file}:" : "-- #{file}:\n#{errors.map(&:to_s).join("\n").gsub("#{File.absolute_path(file)}:", '')}"
       Puppet::Util::Log.close_all
 
@@ -37,7 +37,7 @@ class PuppetParser
         begin
           PuppetLint::OptParser.build.parse!(PuppetCheck.puppetlint_args)
         rescue OptionParser::InvalidOption
-          raise 'puppet-lint: invalid option'
+          raise "puppet-lint: invalid option supplied among #{PuppetCheck.puppetlint_args}"
         end
 
         # prepare the PuppetLint object for style checks

data/lib/puppet-check/rspec_puppet_support.rb

@@ -0,0 +1,91 @@
+# class to prepare spec directory for rspec puppet testing
+class RSpecPuppetSupport
+  # code diagram:
+  # 'puppetcheck:spec' task invokes 'run'
+  # 'run' invokes 'file_setup' always and 'dependency_setup' if metadata.json exists
+  # 'dependency_setup' invokes 'git/forge/hg' if dependencies exist and git/forge/hg is download option
+
+  # prepare the spec fixtures directory for rspec-puppet testing
+  def self.run
+    # 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')
+
+      # move up to module directory
+      Dir.chdir(specdir + '/..')
+
+      # grab the module name from the directory name of the module to pass to file_setup
+      file_setup(File.basename(Dir.pwd))
+
+      # invoke dependency_setup for module dependencies if metadata.json present
+      dependency_setup if File.file?('metadata.json')
+    end
+  end
+
+  # setup the files, directories, and symlinks for rspec-puppet testing
+  def self.file_setup(module_name)
+    require 'fileutils'
+
+    # 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.dependency_setup
+    require 'json'
+
+    # parse the metadata.json (assumes DataParser.json has 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')
+          git(dependency_hash['git'], dependency_hash['args'])
+        elsif dependency_hash.key?('forge')
+          forge(dependency_hash['forge'], dependency_hash['args'])
+        elsif dependency_hash.key?('hg')
+          hg(dependency_hash['hg'], dependency_hash['args'])
+        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.git(git_url, args = '')
+    system("git -C spec/fixtures/modules/ clone #{args} #{git_url}")
+  end
+
+  # download external module dependency with forge
+  def self.forge(forge_name, args = '')
+    system("puppet module install --modulepath spec/fixtures/modules/ --force #{args} #{forge_name}")
+  end
+
+  # download external module dependency with hg
+  def self.hg(hg_url, args = '')
+    system("hg --cwd spec/fixtures/modules/ clone #{args} #{hg_url}")
+  end
+end

data/lib/puppet-check/ruby_parser.rb

@@ -76,7 +76,7 @@ class RubyParser
 
           # check Rubocop
           rubocop_args = PuppetCheck.rubocop_args.clone
-          # 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 is grumpy about non-snake_case filenames 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

@@ -1,15 +1,13 @@
 require 'rspec/core/rake_task'
 require 'rake/tasklib'
-require 'rake/task'
 require_relative '../puppet-check'
+require_relative 'rspec_puppet_support'
 
 # the rake interface for PuppetCheck
 class PuppetCheck::Tasks < ::Rake::TaskLib
   def initialize
     desc 'Execute all Puppet-Check checks'
-    task :puppetcheck do
-      %w(puppetcheck:file puppetcheck:spec puppetcheck:beaker).each { |task| Rake::Task[task.to_sym].invoke }
-    end
+    task puppetcheck: %w(puppetcheck:file puppetcheck:spec puppetcheck:beaker)
 
     namespace :puppetcheck do
       desc 'Execute Puppet-Check file checks'
@@ -21,7 +19,7 @@ class PuppetCheck::Tasks < ::Rake::TaskLib
 
       desc 'Execute RSpec and RSpec-Puppet tests'
       RSpec::Core::RakeTask.new(:spec) do |task|
-        self.class.rspec_puppet_setup
+        RSpecPuppetSupport.run
         # 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
@@ -35,91 +33,6 @@ class PuppetCheck::Tasks < ::Rake::TaskLib
       end
     end
   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')
-
-      # move up to module directory
-      Dir.chdir(specdir + '/..')
-
-      # 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/puppet-check/rspec_puppet_support_spec.rb

@@ -0,0 +1,31 @@
+require_relative '../spec_helper.rb'
+require_relative '../../lib/puppet-check/rspec_puppet_support'
+
+describe RSpecPuppetSupport do
+  context '.run' do
+    let(:rspec_puppet_setup) { RSpecPuppetSupport.run }
+    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
+
+      # .file_setup
+      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
+
+      # .dependency_setup
+      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/tasks_spec.rb

@@ -31,29 +31,4 @@ describe PuppetCheck::Tasks do
       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

@@ -2,8 +2,6 @@ require_relative 'spec_helper'
 require_relative '../lib/puppet-check'
 
 describe PuppetCheck do
-  let(:puppetcheck) { PuppetCheck.new }
-
   context 'self' do
     it 'future parser can be altered' do
       PuppetCheck.future_parser = true
@@ -26,11 +24,11 @@ describe PuppetCheck do
   context '.parse_paths' do
     before(:each) { Dir.chdir(fixtures_dir) }
 
-    let(:no_files) { puppetcheck.parse_paths(%w(foo bar baz)) }
-    let(:file) { puppetcheck.parse_paths(['lib/good.rb']) }
-    let(:dir) { puppetcheck.parse_paths(['.']) }
-    let(:multi_dir) { puppetcheck.parse_paths(%w(hieradata lib manifests)) }
-    let(:repeats) { puppetcheck.parse_paths(['hieradata', 'hieradata', 'lib', 'hieradata/good.json', 'manifests/good.pp', 'manifests/good.pp']) }
+    let(:no_files) { PuppetCheck.parse_paths(%w(foo bar baz)) }
+    let(:file) { PuppetCheck.parse_paths(['lib/good.rb']) }
+    let(:dir) { PuppetCheck.parse_paths(['.']) }
+    let(:multi_dir) { PuppetCheck.parse_paths(%w(hieradata lib manifests)) }
+    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, 'puppet-check: no files found in supplied paths foo, bar, baz.')

data/spec/system/system_spec.rb

@@ -5,7 +5,7 @@ require_relative '../../lib/puppet-check/tasks'
 
 describe 'PuppetCheck' do
   context 'executed as a system from the CLI with arguments and various files to be processed' do
-    let(:cli) { PuppetCheck::CLI.run(%w(-s --puppet-lint no-hard_tabs-check,no-80chars-check --rubocop Metrics/LineLength,Style/Encoding .)) }
+    let(:cli) { PuppetCheck::CLI.run(%w(-s --puppet-lint no-hard_tabs-check,no-140chars-check --rubocop Metrics/LineLength,Style/Encoding .)) }
 
     it 'outputs diagnostic results correctly after processing all of the files' do
       Dir.chdir(fixtures_dir)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: puppet-check
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.2.1
 platform: ruby
 authors:
 - Matt Schuchard
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-06-07 00:00:00.000000000 Z
+date: 2016-07-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: puppet
@@ -50,14 +50,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.1'
+        version: '2.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.1'
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: spdx-licenses
   requirement: !ruby/object:Gem::Requirement
@@ -123,6 +123,7 @@ files:
 - lib/puppet-check/cli.rb
 - lib/puppet-check/data_parser.rb
 - lib/puppet-check/puppet_parser.rb
+- lib/puppet-check/rspec_puppet_support.rb
 - lib/puppet-check/ruby_parser.rb
 - lib/puppet-check/tasks.rb
 - lib/puppet-check/utils.rb
@@ -158,6 +159,7 @@ files:
 - spec/puppet-check/cli_spec.rb
 - spec/puppet-check/data_parser_spec.rb
 - spec/puppet-check/puppet_parser_spec.rb
+- spec/puppet-check/rspec_puppet_support_spec.rb
 - spec/puppet-check/ruby_parser_spec.rb
 - spec/puppet-check/tasks_spec.rb
 - spec/puppet-check/utils_spec.rb
@@ -222,6 +224,7 @@ test_files:
 - spec/puppet-check/cli_spec.rb
 - spec/puppet-check/data_parser_spec.rb
 - spec/puppet-check/puppet_parser_spec.rb
+- spec/puppet-check/rspec_puppet_support_spec.rb
 - spec/puppet-check/ruby_parser_spec.rb
 - spec/puppet-check/tasks_spec.rb
 - spec/puppet-check/utils_spec.rb