puppet-check 1.0.0

data/spec/fixtures/lib/syntax.rb

@@ -0,0 +1 @@
+i => am : a '' ruby.file { with } &bad syntax

data/spec/fixtures/librarian_good/Puppetfile

@@ -0,0 +1,5 @@
+mod 'i',
+    am: 'a',
+    good: 'librarian'
+
+mod 'puppet', 'file'

data/spec/fixtures/librarian_style/Puppetfile

@@ -0,0 +1,5 @@
+mod 'i',
+  am: 'a',
+  librarian: 'puppet'
+
+mod 'file', :with => 'bad style'

data/spec/fixtures/librarian_syntax/Puppetfile

@@ -0,0 +1,7 @@
+mod 'i',
+    am: 'a'
+    librarian: 'puppet'
+
+mod 'file', with:
+
+mod 'bad', :'syntax'

data/spec/fixtures/manifests/good.pp

@@ -0,0 +1 @@
+notify { 'i am a good manifest': }

data/spec/fixtures/manifests/style_lint.pp

@@ -0,0 +1,4 @@
+notify { 'i am':
+  a => "manifest",
+  with => 'bad lint style',
+}

data/spec/fixtures/manifests/style_parser.pp

@@ -0,0 +1,2 @@
+#test for warnings
+notify { 'i am a manifest with': message => "bad parser \[\] and lint style" }

data/spec/fixtures/manifests/syntax.pp

@@ -0,0 +1 @@
+$"iam${amanifest}$withbadsyntax"

data/spec/fixtures/metadata_good/metadata.json

@@ -0,0 +1,35 @@
+{
+  "name": "puppetlabs-stdlib",
+  "version": "4.11.0",
+  "author": "puppetlabs",
+  "summary": "Standard library of resources for Puppet modules.",
+  "license": "Apache-2.0",
+  "source": "https://github.com/puppetlabs/puppetlabs-stdlib",
+  "project_page": "https://github.com/puppetlabs/puppetlabs-stdlib",
+  "issues_url": "https://tickets.puppetlabs.com/browse/MODULES",
+  "operatingsystem_support": [
+    {
+      "operatingsystem": "RedHat",
+      "operatingsystemrelease": [
+        "4",
+        "5",
+        "6",
+        "7"
+      ]
+    }
+  ],
+  "requirements": [
+    {
+      "name": "pe",
+      "version_requirement": ">= 3.0.0 < 2015.4.0"
+    },
+    {
+      "name": "puppet",
+      "version_requirement": ">=2.7.20 <5.0.0"
+    }
+  ],
+  "description": "Standard Library for Puppet Modules",
+  "dependencies": [
+
+  ]
+}

data/spec/fixtures/metadata_style/metadata.json

@@ -0,0 +1,35 @@
+{
+  "name": "puppetlabs-stdlib",
+  "version": "4.11.0",
+  "author": "puppetlabs",
+  "summary": "Standard library of resources for Puppet modules.",
+  "license": "Imaginary",
+  "source": "https://github.com/puppetlabs/puppetlabs-stdlib",
+  "project_page": "https://github.com/puppetlabs/puppetlabs-stdlib",
+  "issues_url": "https://tickets.puppetlabs.com/browse/MODULES",
+  "operatingsystem_support": [
+    {
+      "operatingsystem": "RedHat",
+      "operatingsystemrelease": [
+        "4",
+        "5",
+        "6",
+        "7"
+      ]
+    }
+  ],
+  "requirements": [
+    {
+      "name": "pe",
+      "version_requirement": ">= 3.0.0 < 2015.4.0"
+    },
+    {
+      "name": "puppet",
+      "version_requirement": ">=2.7.20 <5.0.0"
+    }
+  ],
+  "description": "Standard Library for Puppet Modules",
+  "dependencies": [
+
+  ]
+}

data/spec/fixtures/metadata_syntax/metadata.json

@@ -0,0 +1,15 @@
+{
+  "name": "puppetlabs-stdlib",
+  "author": "puppetlabs",
+  "summary": "This is the song that never ends. Yes it goes on and on my friends. Some people, started singing it not knowing what it was. And they will keep singing it forever just because.",
+  "license": "Apache-2.0",
+  "source": "https://github.com/puppetlabs/puppetlabs-stdlib",
+  "project_page": "https://github.com/puppetlabs/puppetlabs-stdlib",
+  "issues_url": "https://tickets.puppetlabs.com/browse/MODULES",
+  "description": "Standard Library for Puppet Modules",
+  "dependencies": [
+    {"name": "puppetlabs/nothing", "version_requirement": ">=1.1.1 < 2.2.2"},
+    {"name": "puppetlabs/nothing", "version_requirement": ">=1.1.1 < 2.2.2"}
+  ],
+  "checksum": "foo"
+}

data/spec/fixtures/templates/good.epp

@@ -0,0 +1,3 @@
+<%# i am %>
+<% $a = 'good' -%>
+puppet template

data/spec/fixtures/templates/good.erb

@@ -0,0 +1 @@
+i am a good <%= @ruby -%> template

data/spec/fixtures/templates/no_method_error.erb

@@ -0,0 +1,3 @@
+i am a
+<% @ruby.upcase @template.downcase %>
+with nomethoderror

data/spec/fixtures/templates/style.erb

@@ -0,0 +1,3 @@
+i am a ruby
+<% TEMPLATE = 'with' %>
+<% TEMPLATE = 'bad style' %>

data/spec/fixtures/templates/syntax.epp

@@ -0,0 +1,3 @@
+i am a
+<% puppet template %>
+< $with = 'bad syntax %>

data/spec/fixtures/templates/syntax.erb

@@ -0,0 +1 @@
+i am <%= @a ruby %> template <%= @with -> bad syntax

data/spec/integration/integration_spec.rb

@@ -0,0 +1,41 @@
+require 'rake'
+require_relative '../spec_helper.rb'
+require_relative '../../lib/puppet-check/cli'
+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 #{fixtures_dir})) }
+
+    it 'outputs diagnostic results correctly after processing all of the files' do
+      expect(cli).to eql(1)
+      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(9)
+      expect(PuppetCheck.ignored_files.length).to eql(1)
+    end
+  end
+
+  context 'executed as a system from the Rakefile with arguments and various files to be processed' do
+    let(:tasks) { Rake::Task['puppetcheck:file'].invoke }
+
+    before(:each) do
+      FileUtils.cd fixtures_dir
+      PuppetCheck.error_files = []
+      PuppetCheck.warning_files = []
+      PuppetCheck.clean_files = []
+      PuppetCheck.ignored_files = []
+      PuppetCheck.style_check = true
+    end
+
+    it 'outputs diagnostic results correctly after processing all of the files' do
+      expect(tasks).to eql(1)
+      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(9)
+      expect(PuppetCheck.ignored_files.length).to eql(1)
+    end
+  end
+end

data/spec/puppet-check/cli_spec.rb

@@ -0,0 +1,48 @@
+require_relative '../spec_helper'
+require_relative '../../lib/puppet-check/cli'
+
+describe PuppetCheck::CLI do
+  context '.run' do
+    it 'raises an error if no paths were specified' do
+      expect { PuppetCheck::CLI.run(%w(-s -f)) }.to raise_error(RuntimeError, 'puppet-check: no paths specified')
+    end
+  end
+
+  context '.parse' do
+    it 'raises an error if an invalid option was specified' do
+      expect { PuppetCheck::CLI.parse(%w(-s -f -asdf foo)) }.to raise_error(OptionParser::InvalidOption)
+    end
+
+    it 'allows future parser and style check to be enabled' do
+      PuppetCheck.future_parser = false
+      PuppetCheck.style_check = false
+      PuppetCheck::CLI.parse(%w(-s -f foo))
+      expect(PuppetCheck.future_parser).to eql(true)
+      expect(PuppetCheck.style_check).to eql(true)
+    end
+
+    it 'correctly parses PuppetLint arguments' do
+      PuppetCheck.puppetlint_args = []
+      PuppetCheck::CLI.parse(%w(--puppet-lint puppetlint-arg-one,puppetlint-arg-two foo))
+      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))
+      expect(PuppetCheck.rubocop_args).to eql(['--except', 'rubocop-arg-one,rubocop-arg-two'])
+    end
+
+    it 'correctly parses multiple sets of arguments' do
+      PuppetCheck.future_parser = false
+      PuppetCheck.style_check = false
+      PuppetCheck.puppetlint_args = []
+      PuppetCheck.rubocop_args = []
+      PuppetCheck::CLI.parse(%w(-s -f --puppet-lint puppetlint-arg-one,puppetlint-arg-two --rubocop rubocop-arg-one,rubocop-arg-two foo))
+      expect(PuppetCheck.future_parser).to eql(true)
+      expect(PuppetCheck.style_check).to eql(true)
+      expect(PuppetCheck.puppetlint_args).to eql(['--puppetlint-arg-one', '--puppetlint-arg-two'])
+      expect(PuppetCheck.rubocop_args).to eql(['--except', 'rubocop-arg-one,rubocop-arg-two'])
+    end
+  end
+end

data/spec/puppet-check/data_parser_spec.rb

@@ -0,0 +1,64 @@
+require_relative '../spec_helper'
+require_relative '../../lib/puppet-check/data_parser'
+
+describe DataParser do
+  before(:each) do
+    PuppetCheck.error_files = []
+    PuppetCheck.warning_files = []
+    PuppetCheck.clean_files = []
+  end
+
+  context '.yaml' do
+    it 'puts a bad syntax yaml file in the error files array' do
+      DataParser.yaml([fixtures_dir + 'hieradata/syntax.yaml'])
+      expect(PuppetCheck.error_files[0]).to match(%r{^\-\- #{fixtures_dir}hieradata/syntax.yaml:\nblock sequence entries are not allowed})
+      expect(PuppetCheck.warning_files).to eql([])
+      expect(PuppetCheck.clean_files).to eql([])
+    end
+    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.clean_files).to eql([])
+    end
+    it 'puts a good yaml file in the clean files array' do
+      DataParser.yaml([fixtures_dir + 'hieradata/good.yaml'])
+      expect(PuppetCheck.error_files).to eql([])
+      expect(PuppetCheck.warning_files).to eql([])
+      expect(PuppetCheck.clean_files).to eql(["-- #{fixtures_dir}hieradata/good.yaml"])
+    end
+  end
+
+  context '.json' do
+    it 'puts a bad syntax json file in the error files array' do
+      DataParser.json([fixtures_dir + 'hieradata/syntax.json'])
+      expect(PuppetCheck.error_files[0]).to match(%r{^\-\- #{fixtures_dir}hieradata/syntax.json:\n.*unexpected token})
+      expect(PuppetCheck.warning_files).to eql([])
+      expect(PuppetCheck.clean_files).to eql([])
+    end
+    it 'puts a bad metadata json file in the error files array' do
+      DataParser.json([fixtures_dir + 'metadata_syntax/metadata.json'])
+      expect(PuppetCheck.error_files[0]).to match(%r{^\-\- #{fixtures_dir}metadata_syntax/metadata.json:\nRequired field.*\nDuplicate dependencies.*\nDeprecated field.*\nSummary exceeds})
+      expect(PuppetCheck.warning_files).to eql([])
+      expect(PuppetCheck.clean_files).to eql([])
+    end
+    it 'puts a bad style metadata json file in the warning files array' do
+      DataParser.json([fixtures_dir + 'metadata_style/metadata.json'])
+      expect(PuppetCheck.error_files).to eql([])
+      expect(PuppetCheck.warning_files[0]).to match(%r{^\-\- #{fixtures_dir}metadata_style/metadata.json:\nLicense identifier})
+      expect(PuppetCheck.clean_files).to eql([])
+    end
+    it 'puts a good json file in the clean files array' do
+      DataParser.json([fixtures_dir + 'hieradata/good.json'])
+      expect(PuppetCheck.error_files).to eql([])
+      expect(PuppetCheck.warning_files).to eql([])
+      expect(PuppetCheck.clean_files).to eql(["-- #{fixtures_dir}hieradata/good.json"])
+    end
+    it 'puts a good metadata json file in the clean files array' do
+      DataParser.json([fixtures_dir + 'metadata_good/metadata.json'])
+      expect(PuppetCheck.error_files).to eql([])
+      expect(PuppetCheck.warning_files).to eql([])
+      expect(PuppetCheck.clean_files).to eql(["-- #{fixtures_dir}metadata_good/metadata.json"])
+    end
+  end
+end

data/spec/puppet-check/puppet_parser_spec.rb

@@ -0,0 +1,67 @@
+require_relative '../spec_helper'
+require_relative '../../lib/puppet-check/puppet_parser'
+
+describe PuppetParser do
+  before(:each) do
+    PuppetCheck.error_files = []
+    PuppetCheck.warning_files = []
+    PuppetCheck.clean_files = []
+    PuppetCheck.future_parser = false
+    PuppetCheck.style_check = false
+    PuppetCheck.puppetlint_args = []
+  end
+
+  context '.manifest' do
+    it 'puts a bad syntax Puppet manifest in the error files array' do
+      PuppetParser.manifest([fixtures_dir + 'manifests/syntax.pp'])
+      # expect(subject.instance_variable_get(:@error_files)[0]).to match(%r{^\-\- #{fixtures_dir}manifests/syntax.pp:.*syntax error})
+      expect(PuppetCheck.error_files[0]).to match(%r{^\-\- #{fixtures_dir}manifests/syntax.pp:\nThis Variable has no effect.*\nIllegal variable name})
+      expect(PuppetCheck.warning_files).to eql([])
+      expect(PuppetCheck.clean_files).to eql([])
+    end
+    it 'puts a bad parser and lint style Puppet manifest in the warning files array' 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.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.clean_files).to eql([])
+    end
+    it 'puts a bad style Puppet manifest in the clean files array when puppetlint_args ignores its warnings' do
+      PuppetCheck.style_check = true
+      PuppetCheck.puppetlint_args = ['--no-double_quoted_strings-check', '--no-arrow_alignment-check']
+      PuppetParser.manifest([fixtures_dir + 'manifests/style_lint.pp'])
+      expect(PuppetCheck.error_files).to eql([])
+      expect(PuppetCheck.warning_files).to eql([])
+      expect(PuppetCheck.clean_files).to eql(["-- #{fixtures_dir}manifests/style_lint.pp"])
+    end
+    it 'puts a good Puppet manifest in the clean files array' do
+      PuppetCheck.style_check = true
+      PuppetParser.manifest([fixtures_dir + 'manifests/good.pp'])
+      expect(PuppetCheck.error_files).to eql([])
+      expect(PuppetCheck.warning_files).to eql([])
+      expect(PuppetCheck.clean_files).to eql(["-- #{fixtures_dir}manifests/good.pp"])
+    end
+  end
+
+  context '.template' do
+    it 'puts a bad syntax Puppet template in the error files array' do
+      PuppetParser.template([fixtures_dir + 'templates/syntax.epp'])
+      expect(PuppetCheck.error_files[0]).to match(%r{^\-\- #{fixtures_dir}templates/syntax.epp:\nThis Name has no effect})
+      expect(PuppetCheck.warning_files).to eql([])
+      expect(PuppetCheck.clean_files).to eql([])
+    end
+    it 'puts a good Puppet template in the clean files array' do
+      PuppetParser.template([fixtures_dir + 'templates/good.epp'])
+      expect(PuppetCheck.error_files).to eql([])
+      expect(PuppetCheck.warning_files).to eql([])
+      expect(PuppetCheck.clean_files).to eql(["-- #{fixtures_dir}templates/good.epp"])
+    end
+  end
+end

data/spec/puppet-check/ruby_parser_spec.rb

@@ -0,0 +1,111 @@
+require_relative '../spec_helper'
+require_relative '../../lib/puppet-check/ruby_parser'
+
+describe RubyParser do
+  before(:each) do
+    PuppetCheck.error_files = []
+    PuppetCheck.warning_files = []
+    PuppetCheck.clean_files = []
+    PuppetCheck.style_check = false
+    PuppetCheck.rubocop_args = []
+  end
+
+  context '.ruby' do
+    it 'puts a bad syntax ruby file in the error files array' do
+      RubyParser.ruby([fixtures_dir + 'lib/syntax.rb'])
+      expect(PuppetCheck.error_files[0]).to match(%r{^\-\- #{fixtures_dir}lib/syntax.rb:\n.*syntax error})
+      expect(PuppetCheck.warning_files).to eql([])
+      expect(PuppetCheck.clean_files).to eql([])
+    end
+    if Gem::Version.new(RUBY_VERSION.dup) >= Gem::Version.new('2.1.0')
+      it 'puts a bad style ruby file in the warning files array' do
+        PuppetCheck.style_check = true
+        RubyParser.ruby([fixtures_dir + 'lib/style.rb'])
+        expect(PuppetCheck.error_files).to eql([])
+        expect(PuppetCheck.warning_files[0]).to match(%r{^\-\- #{fixtures_dir}lib/style.rb:\n.*Useless assignment.*\n.*Use the new.*\n.*Do not introduce.*\n.*Prefer single.*\n.*is a writable attribute.*\n.*Issue has no descriptive comment})
+        expect(PuppetCheck.clean_files).to eql([])
+      end
+    else
+      it 'puts a bad style ruby file in the warning files array' do
+        PuppetCheck.style_check = true
+        RubyParser.ruby([fixtures_dir + 'lib/style.rb'])
+        expect(PuppetCheck.error_files).to eql([])
+        expect(PuppetCheck.warning_files[0]).to match(%r{^\-\- #{fixtures_dir}lib/style.rb:\n.*Useless assignment.*\n.*Use the new.*\n.*Do not introduce.*\n.*Prefer single})
+        expect(PuppetCheck.clean_files).to eql([])
+      end
+    end
+    it 'puts a bad style ruby file in the clean files array when rubocop_args ignores its warnings' do
+      PuppetCheck.style_check = true
+      PuppetCheck.rubocop_args = ['--except', 'Lint/UselessAssignment,Style/HashSyntax,Style/GlobalVars,Style/StringLiterals']
+      RubyParser.ruby([fixtures_dir + 'lib/rubocop_style.rb'])
+      expect(PuppetCheck.error_files).to eql([])
+      expect(PuppetCheck.warning_files).to eql([])
+      expect(PuppetCheck.clean_files).to eql(["-- #{fixtures_dir}lib/rubocop_style.rb"])
+    end
+    it 'puts a good ruby file in the clean files array' do
+      PuppetCheck.style_check = true
+      RubyParser.ruby([fixtures_dir + 'lib/good.rb'])
+      expect(PuppetCheck.error_files).to eql([])
+      expect(PuppetCheck.warning_files).to eql([])
+      expect(PuppetCheck.clean_files).to eql(["-- #{fixtures_dir}lib/good.rb"])
+    end
+  end
+
+  context '.template' do
+    it 'puts a bad syntax ruby template file in the error files array' do
+      RubyParser.template([fixtures_dir + 'templates/syntax.erb'])
+      expect(PuppetCheck.error_files[0]).to match(%r{^\-\- #{fixtures_dir}templates/syntax.erb:\n.*syntax error, unexpected tIDENTIFIER})
+      expect(PuppetCheck.warning_files).to eql([])
+      expect(PuppetCheck.clean_files).to eql([])
+    end
+    it 'puts a bad style ruby template file in the warning files array' do
+      RubyParser.template([fixtures_dir + 'templates/style.erb'])
+      expect(PuppetCheck.error_files).to eql([])
+      expect(PuppetCheck.warning_files[0]).to match(%r{^\-\- #{fixtures_dir}templates/style.erb:\n.*already initialized constant.*\n.*(previous definition of|already initialized constant)})
+      expect(PuppetCheck.clean_files).to eql([])
+    end
+    it 'puts a ruby template file with ignored errors in the clean files array' do
+      RubyParser.template([fixtures_dir + 'templates/no_method_error.erb'])
+      expect(PuppetCheck.error_files).to eql([])
+      expect(PuppetCheck.warning_files).to eql([])
+      expect(PuppetCheck.clean_files).to eql(["-- #{fixtures_dir}templates/no_method_error.erb"])
+    end
+    it 'puts a good ruby template file in the clean files array' do
+      RubyParser.template([fixtures_dir + 'templates/good.erb'])
+      expect(PuppetCheck.error_files).to eql([])
+      expect(PuppetCheck.warning_files).to eql([])
+      expect(PuppetCheck.clean_files).to eql(["-- #{fixtures_dir}templates/good.erb"])
+    end
+  end
+
+  context '.librarian' do
+    it 'puts a bad syntax librarian Puppet file in the error files array' do
+      RubyParser.librarian([fixtures_dir + 'librarian_syntax/Puppetfile'])
+      expect(PuppetCheck.error_files[0]).to match(%r{^\-\- #{fixtures_dir}librarian_syntax/Puppetfile:\n.*syntax error})
+      expect(PuppetCheck.warning_files).to eql([])
+      expect(PuppetCheck.clean_files).to eql([])
+    end
+    it 'puts a bad style librarian Puppet file in the warning files array' do
+      PuppetCheck.style_check = true
+      RubyParser.librarian([fixtures_dir + 'librarian_style/Puppetfile'])
+      expect(PuppetCheck.error_files).to eql([])
+      expect(PuppetCheck.warning_files[0]).to match(%r{^\-\- #{fixtures_dir}librarian_style/Puppetfile:\n.*Align the parameters.*\n.*Use the new})
+      expect(PuppetCheck.clean_files).to eql([])
+    end
+    it 'puts a bad style librarian Puppet file in the clean files array when rubocop_args ignores its warnings' do
+      PuppetCheck.style_check = true
+      PuppetCheck.rubocop_args = ['--except', 'Style/AlignParameters,Style/HashSyntax']
+      RubyParser.librarian([fixtures_dir + 'librarian_style/Puppetfile'])
+      expect(PuppetCheck.error_files).to eql([])
+      expect(PuppetCheck.warning_files).to eql([])
+      expect(PuppetCheck.clean_files).to eql(["-- #{fixtures_dir}librarian_style/Puppetfile"])
+    end
+    it 'puts a good librarian Puppet file in the clean files array' do
+      PuppetCheck.style_check = true
+      RubyParser.librarian([fixtures_dir + 'librarian_good/Puppetfile'])
+      expect(PuppetCheck.error_files).to eql([])
+      expect(PuppetCheck.warning_files).to eql([])
+      expect(PuppetCheck.clean_files).to eql(["-- #{fixtures_dir}librarian_good/Puppetfile"])
+    end
+  end
+end