puppet-check 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 1ffc2e861ac23804ea044caf8772a9a73e217d84
+  data.tar.gz: e97edbae606ba57e138b47668a94419b3e0cef48
+SHA512:
+  metadata.gz: e08a269bd34024edc353a0f9d5fd60cb1370a3cec7b66f451b83979f8c9b6f5f67d9595423fc7cf43e2e85beb8aa0cd96930499531a25a5e4775d7fd4ce427b9
+  data.tar.gz: 27c1c67568bfdcdd805ae14814fbb1c62ce8bde32e17f6d59e7612eeaae40027a35cc51059bfda7d8270ed48806387bfb41289b45dfbb623ac5e676ec5fb2dc6

data/.rubocop.yml

@@ -0,0 +1,11 @@
+---
+AllCops:
+  Include:
+    - 'lib/**/*.rb'
+    - 'bin/*.rb'
+    - 'spec/**/*.rb'
+  Exclude:
+    - 'spec/fixtures/**/*.rb'
+
+Metrics/LineLength:
+  Enabled: false

data/.travis.yml

@@ -0,0 +1,21 @@
+sudo: false
+notifications:
+  email: false
+
+language: ruby
+cache: bundler
+
+matrix:
+  include:
+    - rvm: 1.9.3
+      env: TEST=spec
+    - rvm: 2.0.0
+      env: TEST=spec
+    - rvm: 2.1.9
+      env: TEST=default
+    - rvm: 2.2.5
+      env: TEST=spec
+
+before_install: gem update bundler
+install: bundle install --retry=3
+script: bundle exec rake $TEST

data/CHANGELOG.md

@@ -0,0 +1,14 @@
+### 1.3.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 | already initialized constant from rubyparser.template style spec)
+
+### 1.2.0 (Roadmap)
+- json and yaml output formats support
+- beaker as optional task
+
+### 1.1.0 (Roadmap)
+- rspec and rspec puppet as optional tasks
+- add additional hiera checks, including nested hash parsing
+
+### 1.0.0
+- Initial release.

data/Dockerfile

@@ -0,0 +1,22 @@
+# PuppetCheck: automated rake testing in reproducible environment
+
+# Build container to automatically provision environment and execute tests.
+# sudo docker build -t puppetcheck .
+
+# Start and enter container for troubleshooting if necessary.
+# sudo docker run -it -d puppetcheck
+# sudo docker exec -it `sudo docker ps -qa | awk '{print $1}' | head -n 1` bash
+
+# Remove running containers before rebuild.
+# sudo docker ps -qa | xargs sudo docker kill
+
+# Cleanup all instances when you are finished.
+# sudo docker ps -qa | xargs sudo docker rm
+# sudo docker images | grep puppetcheck | awk '{print $3}' | xargs sudo docker rmi
+
+FROM ubuntu:15.10
+RUN apt-get update && apt-get install ruby -y
+RUN gem install --no-rdoc --no-ri puppet rspec rake rubocop reek puppet-lint spdx-licenses
+COPY / /
+# Exit 0 to ensure container is built with tag for troubleshooting.
+RUN rake; exit 0

data/Gemfile

@@ -0,0 +1,5 @@
+source 'https://rubygems.org'
+
+gemspec
+
+gem 'reek' if Gem::Version.new(RUBY_VERSION.dup) >= Gem::Version.new('2.1.0')

data/LICENSE.md

@@ -0,0 +1,20 @@
+Copyright (c) 2016 Matt Schuchard
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,148 @@
+# Puppet Check
+[![Build Status](https://travis-ci.org/mschuchard/puppet-check.svg?branch=master)](https://travis-ci.org/mschuchard/puppet-check)
+
+## Description
+Puppet Check is a gem for comprehensive, efficient, streamlined, and easy verification and validation of your Puppet code and data.
+
+### Former Method for Code and Data Checks
+![Old](https://raw.githubusercontent.com/mschuchard/puppet-check/master/images/puppetcheck_old.png)
+
+### Puppet Check Method for Code and Data Checks
+![New](https://raw.githubusercontent.com/mschuchard/puppet-check/master/images/puppetcheck_new.png)
+
+### Example Output
+```
+The following files have errors:
+-- manifests/syntax.pp:
+This Variable has no effect. A value was produced and then forgotten (one or more preceding expressions may have the wrong form) at 1:1
+Illegal variable name, The given name '' does not conform to the naming rule /^((::)?[a-z]\w*)*((::)?[a-z_]\w*)$/ at 1:1
+Found 2 errors. Giving up
+
+-- templates/syntax.epp:
+This Name has no effect. A value was produced and then forgotten (one or more preceding expressions may have the wrong form) at 2:4
+
+-- lib/syntax.rb:
+(eval):1: syntax error, unexpected =>, expecting end-of-input
+BEGIN {throw :good}; i => am : a '' ruby.file { with } &bad syntax
+                         ^
+
+-- templates/syntax.erb:
+(erb):1: syntax error, unexpected tIDENTIFIER, expecting ')'
+... am "; _erbout.concat(( @a ruby ).to_s); _erbout.concat " te...
+...                               ^
+
+-- hieradata/syntax.yaml:
+block sequence entries are not allowed in this context at line 2 column 4
+
+-- hieradata/syntax.json:
+757: unexpected token at '{
+
+-- metadata_syntax/metadata.json:
+Required field 'version' not found in metadata.json.
+Duplicate dependencies on puppetlabs/nothing.
+Deprecated field 'checksum' found.
+Summary exceeds 144 characters.
+
+-- librarian_syntax/Puppetfile:
+(eval):3: syntax error, unexpected ':', expecting end-of-input
+    librarian: 'puppet'
+              ^
+
+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
+
+-- 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
+
+-- lib/style.rb:
+1:1: W: Useless assignment to variable - `hash`.
+1:10: C: Use the new Ruby 1.9 hash syntax.
+2:1: C: Do not introduce global variables.
+3:6: C: Prefer single-quoted strings when you don't need string interpolation or special symbols.
+[7]:Attribute: Issue#foobarbaz is a writable attribute [https://github.com/troessner/reek/blob/master/docs/Attribute.md]
+[6]:IrresponsibleModule: Issue has no descriptive comment [https://github.com/troessner/reek/blob/master/docs/Irresponsible-Module.md]
+
+-- templates/style.erb:
+3: already initialized constant TEMPLATE
+2: previous definition of TEMPLATE was here
+
+-- hieradata/style.yaml:
+Values missing in key 'value'.
+
+-- metadata_style/metadata.json:
+License identifier 'Imaginary' is not in the SPDX list: http://spdx.org/licenses/
+
+-- 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.
+
+The following files have no errors or warnings:
+-- manifests/good.pp
+-- templates/good.epp
+-- lib/good.rb
+-- templates/good.erb
+-- hieradata/good.yaml
+-- hieradata/good.json
+-- metadata_good/metadata.json
+-- librarian_good/Puppetfile
+
+The following files have unrecognized formats and therefore were not processed:
+-- foobarbaz
+```
+
+### Why not Puppetlabs Spec Helper?
+- Puppetlabs Spec Helper is a larger and varied gem with a different overall emphasis for its features.  Puppet Check is a lean and efficient gem solely for comprehensive Puppet code and data validation.
+- Puppetlabs Spec Helper performs fewer types of checks.
+- Puppetlabs Spec Helper has extra layers of gems in between it and the gems executing the checks.
+- Puppetlabs Spec Helper does not allow interfacing through it to the gems executing the checks.
+- Puppetlabs Spec Helper has no CLI.
+
+## 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.
+
+### CLI
+```
+usage: puppet-check [options] paths
+    -f, --future                     Enable future parser
+    -s, --style                      Enable style checks
+        --puppet-lint arg_one,arg_two
+                                     Arguments for PuppetLint ignored checks
+        --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.
+
+```
+Example:
+puppet-check -s --puppet-lint no-hard_tabs-check,no-80chars-check --rubocop Metrics/LineLength,Style/Encoding path/to/code_and_data
+```
+
+### Rake
+Interfacing with Puppet-Check via `rake` requires a `require puppet-check/tasks` in your Rakefile. This generates the following `rake` command:
+
+```
+rake puppetcheck:file      # Execute Puppet-Check file checks
+```
+
+You can add style checks to and select the future parser for the `rake` by adding the following after the require:
+
+```ruby
+PuppetCheck.style_check = true
+PuppetCheck.future_parser = true
+```
+
+The style checks from within `rake` 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 arguments and options to them from within the `Rakefile` task block will be considered for future versions.
+
+### Optional Checks
+`reek` will automatically be installed as a dependency and checks enabled during style checks if your Ruby version is `>= 2.1`. `rspec`, `rspec-puppet`, and `beaker` are forthcoming purely optional dependency checks.
+
+## 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.
+
+Please consult the `CHANGELOG` for the current development roadmap.

data/Rakefile

@@ -0,0 +1,24 @@
+require 'rspec/core/rake_task'
+require 'rubocop/rake_task'
+require 'reek/rake/task' if Gem::Version.new(RUBY_VERSION.dup) >= Gem::Version.new('2.1.0')
+
+task default: [:rubocop, :reek, :unit, :integration]
+
+RuboCop::RakeTask.new(:rubocop) do |task|
+  task.formatters = ['simple']
+  task.fail_on_error = false
+end
+
+if Gem::Version.new(RUBY_VERSION.dup) >= Gem::Version.new('2.1.0')
+  Reek::Rake::Task.new do |task|
+    task.fail_on_error = false
+  end
+end
+
+RSpec::Core::RakeTask.new(:unit) do |task|
+  task.pattern = 'spec/{puppet-check_spec.rb, puppet-check/*_spec.rb}'
+end
+
+RSpec::Core::RakeTask.new(:integration) do |task|
+  task.pattern = 'spec/integration/*_spec.rb'
+end

data/Vagrantfile

@@ -0,0 +1,77 @@
+# PuppetCheck: testing gem build, install, and execution
+
+# -*- mode: ruby -*-
+# vi: set ft=ruby :
+
+# All Vagrant configuration is done below. The "2" in Vagrant.configure
+# configures the configuration version (we support older styles for
+# backwards compatibility). Please don't change it unless you know what
+# you're doing.
+Vagrant.configure(2) do |config|
+  # The most common configuration options are documented and commented below.
+  # For a complete reference, please see the online documentation at
+  # https://docs.vagrantup.com.
+
+  # Every Vagrant development environment requires a box. You can search for
+  # boxes at https://atlas.hashicorp.com/search.
+  config.vm.box = 'ubuntu/trusty64'
+
+  # Disable automatic box update checking. If you disable this, then
+  # boxes will only be checked for updates when the user runs
+  # `vagrant box outdated`. This is not recommended.
+  # config.vm.box_check_update = false
+
+  # Create a forwarded port mapping which allows access to a specific port
+  # within the machine from a port on the host machine. In the example below,
+  # accessing "localhost:8080" will access port 80 on the guest machine.
+  # config.vm.network "forwarded_port", guest: 80, host: 8080
+
+  # Create a private network, which allows host-only access to the machine
+  # using a specific IP.
+  # config.vm.network "private_network", ip: "192.168.33.10"
+
+  # Create a public network, which generally matched to bridged network.
+  # Bridged networks make the machine appear as another physical device on
+  # your network.
+  # config.vm.network "public_network"
+
+  # Share an additional folder to the guest VM. The first argument is
+  # the path on the host to the actual folder. The second argument is
+  # the path on the guest to mount the folder. And the optional third
+  # argument is a set of non-required options.
+  # config.vm.synced_folder "../data", "/vagrant_data"
+
+  # Provider-specific configuration so you can fine-tune various
+  # backing providers for Vagrant. These expose provider-specific options.
+  # Example for VirtualBox:
+  #
+  # config.vm.provider "virtualbox" do |vb|
+  #   # Display the VirtualBox GUI when booting the machine
+  #   vb.gui = true
+  #
+  #   # Customize the amount of memory on the VM:
+  #   vb.memory = "1024"
+  # end
+  #
+  # View the documentation for the provider you are using for more
+  # information on available options.
+
+  # Define a Vagrant Push strategy for pushing to Atlas. Other push strategies
+  # such as FTP and Heroku are also available. See the documentation at
+  # https://docs.vagrantup.com/v2/push/atlas.html for more information.
+  # config.push.define "atlas" do |push|
+  #   push.app = "YOUR_ATLAS_USERNAME/YOUR_APPLICATION_NAME"
+  # end
+
+  # Enable provisioning with a shell script. Additional provisioners such as
+  # Puppet, Chef, Ansible, Salt, and Docker are also available. Please see the
+  # documentation for more information about their specific syntax and use.
+  config.vm.provision 'shell', inline: <<-SHELL
+    cd /vagrant
+    sudo apt-get install git -y
+    sudo gem build puppet-check.gemspec
+    sudo gem install --no-rdoc --no-ri puppet-check*.gem
+    sudo /usr/local/bin/puppet-check -s spec/fixtures
+    sudo rm -f puppet-check*.gem
+  SHELL
+end

data/bin/puppet-check

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+require_relative '../lib/puppet-check/cli'
+
+exit PuppetCheck::CLI.run(ARGV)

data/config.reek

@@ -0,0 +1,3 @@
+---
+exclude_paths:
+  - spec/fixtures

data/lib/puppet-check.rb

@@ -0,0 +1,86 @@
+require_relative 'puppet-check/puppet_parser'
+require_relative 'puppet-check/ruby_parser'
+require_relative 'puppet-check/data_parser'
+
+# interfaces from CLI/tasks and to individual parsers
+class PuppetCheck
+  # initialize future parser and style check bools
+  @future_parser = false
+  @style_check = false
+
+  # initialize diagnostic output arrays
+  @error_files = []
+  @warning_files = []
+  @clean_files = []
+  @ignored_files = []
+
+  # initialize style arg arrays
+  @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
+  class << self
+    attr_accessor :future_parser, :style_check, :error_files, :warning_files, :clean_files, :ignored_files, :puppetlint_args, :rubocop_args
+  end
+
+  # main runner for PuppetCheck
+  def run(paths)
+    # grab all of the files to be processed
+    files = parse_paths(paths)
+
+    # parse the files
+    execute_parsers(files)
+
+    # output the diagnostic results
+    self.class.output_results
+
+    # exit code
+    self.class.error_files.empty? ? 0 : 1
+  end
+
+  # parse the paths and return the array of files
+  def parse_paths(paths)
+    files = []
+
+    # traverse the unique paths, return all files, and replace // with /
+    paths.uniq.each do |path|
+      if File.directory?(path)
+        files.concat(Dir.glob("#{path}/**/*").select { |subpath| File.file? subpath })
+      elsif File.file?(path)
+        files.push(path)
+      end
+    end
+
+    # 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?
+    files.map! { |file| file.gsub('//', '/') }
+    files.uniq
+  end
+
+  # categorize and pass the files out to the parsers to determine their status
+  def execute_parsers(files)
+    PuppetParser.manifest(files.select { |file| File.extname(file) == '.pp' })
+    files.reject! { |file| File.extname(file) == '.pp' }
+    PuppetParser.template(files.select { |file| File.extname(file) == '.epp' })
+    files.reject! { |file| File.extname(file) == '.epp' }
+    RubyParser.ruby(files.select { |file| File.extname(file) == '.rb' })
+    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.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$/ }
+    files.each { |file| self.class.ignored_files.push("-- #{file}") }
+  end
+
+  # output the results for the files that were requested to be checked
+  def self.output_results
+    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?
+  end
+end