puppet-lint 2.5.2 → 3.0.1

data/spec/{puppet-lint → unit/puppet-lint}/bin_spec.rb

@@ -26,7 +26,7 @@ class CommandRun
 end
 
 describe PuppetLint::Bin do
-  subject do
+  subject(:bin) do
     sane_args = if args.is_a?(Array)
                   args
                 else
@@ -57,18 +57,19 @@ describe PuppetLint::Bin do
 
   context 'when asked to display available checks' do
     let(:args) { '--list-checks' }
+
     all_checks = PuppetLint.configuration.checks.map(&:to_s)
 
     its(:exitstatus) { is_expected.to eq(0) }
 
     all_checks.each do |c|
       it "includes check #{c} in its output" do
-        expect(subject.stdout).to include c
+        expect(bin.stdout).to include c
       end
     end
   end
 
-  context 'when passed a backslash separated path on Windows', :if => Gem.win_platform? do
+  context 'when passed a backslash separated path on Windows', if: Gem.win_platform? do
     let(:args) do
       [
         'spec\fixtures\test\manifests',
@@ -93,7 +94,7 @@ describe PuppetLint::Bin do
         [
           "#{args[0]} - WARNING: optional parameter listed before required parameter on line 2 (check: parameter_order)",
           "#{args[1]} - ERROR: test::foo not in autoload module layout on line 2 (check: autoloader_layout)",
-        ].join("\n")
+        ].join("\n"),
       )
     end
   end
@@ -144,8 +145,10 @@ describe PuppetLint::Bin do
     end
 
     its(:exitstatus) { is_expected.to eq(1) }
-    its(:stdout) { is_expected.to match(%r{WARNING}) }
-    its(:stdout) { is_expected.to_not match(%r{ERROR}) }
+    its(:stdout) do
+      is_expected.to match(%r{WARNING})
+      is_expected.not_to match(%r{ERROR})
+    end
   end
 
   context 'when specifying a specific check to run' do
@@ -159,8 +162,10 @@ describe PuppetLint::Bin do
     end
 
     its(:exitstatus) { is_expected.to eq(0) }
-    its(:stdout) { is_expected.to_not match(%r{ERROR}) }
-    its(:stdout) { is_expected.to match(%r{WARNING}) }
+    its(:stdout) do
+      is_expected.not_to match(%r{ERROR})
+      is_expected.to match(%r{WARNING})
+    end
   end
 
   context 'when asked to display filenames ' do
@@ -202,7 +207,7 @@ describe PuppetLint::Bin do
           '',
           "  define test::warning($foo='bar', $baz) { }",
           '                                   ^',
-        ].join("\n")
+        ].join("\n"),
       )
     end
   end
@@ -397,6 +402,41 @@ describe PuppetLint::Bin do
     end
   end
 
+  context 'when displaying results as SARIF' do
+    let(:args) do
+      [
+        '--sarif',
+        'spec/fixtures/test/manifests/warning.pp',
+      ]
+    end
+
+    its(:exitstatus) { is_expected.to eq(0) }
+
+    its(:stdout) do
+      is_expected.to match(%r{"ruleId": "parameter_order"})
+      is_expected.to match(%r{"uri": "warning.pp"})
+    end
+  end
+
+  context 'when displaying results for multiple targets as SARIF' do
+    let(:args) do
+      [
+        '--sarif',
+        'spec/fixtures/test/manifests/fail.pp',
+        'spec/fixtures/test/manifests/warning.pp',
+      ]
+    end
+
+    its(:exitstatus) { is_expected.to eq(1) }
+
+    its(:stdout) do
+      is_expected.to match(%r{"ruleId": "autoloader_layout"})
+      is_expected.to match(%r{"uri": "fail.pp"})
+      is_expected.to match(%r{"ruleId": "parameter_order"})
+      is_expected.to match(%r{"uri": "warning.pp"})
+    end
+  end
+
   context 'when hiding ignored problems' do
     let(:args) do
       [
@@ -405,7 +445,7 @@ describe PuppetLint::Bin do
     end
 
     its(:exitstatus) { is_expected.to eq(0) }
-    its(:stdout) { is_expected.to_not match(%r{IGNORED}) }
+    its(:stdout) { is_expected.not_to match(%r{IGNORED}) }
   end
 
   context 'when showing ignored problems' do
@@ -434,7 +474,7 @@ describe PuppetLint::Bin do
         [
           'IGNORED: double quoted string containing no variables on line 3 (check: double_quoted_strings)',
           '  for a good reason',
-        ].join("\n")
+        ].join("\n"),
       )
     end
   end
@@ -468,7 +508,7 @@ describe PuppetLint::Bin do
     end
 
     its(:exitstatus) { is_expected.to eq(0) }
-    its(:stdout) { is_expected.to match(%r{WARNING: lint:endignore comment with no opening lint:ignore:<check> comment found on line 1}) }
+    its(:stderr) { is_expected.to match(%r{WARNING: lint:endignore comment with no opening lint:ignore:<check> comment found on line 1}) }
   end
 
   context 'when a lint:ignore control comment block is not terminated properly' do
@@ -478,48 +518,52 @@ describe PuppetLint::Bin do
       ]
     end
 
-    its(:stdout) { is_expected.to match(%r{WARNING: lint:ignore:140chars comment on line 2 with no closing lint:endignore comment}) }
+    its(:stderr) { is_expected.to match(%r{WARNING: lint:ignore:140chars comment on line 2 with no closing lint:endignore comment}) }
   end
 
   context 'when fixing a file with \n line endings' do
-    before(:context) do
-      @windows_file = Tempfile.new('windows')
-      @posix_file = Tempfile.new('posix')
-
-      @windows_file.binmode
-      @posix_file.binmode
-
-      @windows_file.write("\r\n")
-      @posix_file.write("\n")
-
-      @windows_file.close
-      @posix_file.close
+    let(:windows_file) do
+      Tempfile.new('windows')
     end
 
-    after(:context) do
-      @windows_file.unlink
-      @posix_file.unlink
+    let(:posix_file) do
+      Tempfile.new('posix')
     end
 
     let(:args) do
       [
         '--fix',
-        @posix_file.path,
-        @windows_file.path,
+        posix_file.path,
+        windows_file.path,
       ]
     end
 
+    before(:each) do
+      windows_file.binmode
+      windows_file.write("\r\n")
+      windows_file.close
+
+      posix_file.binmode
+      posix_file.write("\n")
+      posix_file.close
+    end
+
+    after(:each) do
+      windows_file.unlink
+      posix_file.unlink
+    end
+
     its(:exitstatus) { is_expected.to eq(0) }
 
     it 'does not change the line endings' do
-      File.open(@posix_file.path, 'rb') do |f|
+      File.open(posix_file.path, 'rb') do |f|
         data = f.read
 
         expect(data).to match(%r{\n\Z}m)
-        expect(data).to_not match(%r{\r\n\Z}m)
+        expect(data).not_to match(%r{\r\n\Z}m)
       end
 
-      File.open(@windows_file.path, 'rb') do |f|
+      File.open(windows_file.path, 'rb') do |f|
         data = f.read
 
         expect(data).to match(%r{\r\n\Z}m)
@@ -543,7 +587,7 @@ describe PuppetLint::Bin do
 
       context 'and command-line does not override "--only-checks"' do
         let(:args) do
-          File.join(File.dirname(__FILE__), '..', 'fixtures', 'test', 'manifests', 'two_warnings.pp')
+          File.join(File.dirname(__FILE__), '..', '..', 'fixtures', 'test', 'manifests', 'two_warnings.pp')
         end
 
         its(:exitstatus) { is_expected.to eq(0) }
@@ -556,7 +600,7 @@ describe PuppetLint::Bin do
         let(:args) do
           [
             '--only-checks=variable_is_lowercase',
-            File.join(File.dirname(__FILE__), '..', 'fixtures', 'test', 'manifests', 'two_warnings.pp'),
+            File.join(File.dirname(__FILE__), '..', '..', 'fixtures', 'test', 'manifests', 'two_warnings.pp'),
           ]
         end
 

data/spec/{puppet-lint → unit/puppet-lint}/checks_spec.rb

@@ -7,18 +7,18 @@ describe PuppetLint::Checks do
   let(:content) { "notify { 'test': }" }
 
   describe '#initialize' do
-    it { is_expected.to have_attributes(:problems => []) }
+    it { is_expected.to have_attributes(problems: []) }
   end
 
   describe '#load_data' do
     let(:lexer) { PuppetLint::Lexer.new }
 
-    before do
+    before(:each) do
       allow(PuppetLint::Lexer).to receive(:new).and_return(lexer)
     end
 
     context 'when the tokeniser encounters an error' do
-      before do
+      before(:each) do
         allow(lexer).to receive(:tokenise).with(content).and_raise(lexer_error)
         instance.load_data(path, content)
       end
@@ -33,14 +33,14 @@ describe PuppetLint::Checks do
         it 'creates a syntax error problem for the file' do
           expect(instance.problems).to have(1).problem
           expect(instance.problems.first).to include(
-            :kind     => :error,
-            :check    => :syntax,
-            :message  => 'Syntax error',
-            :line     => 1,
-            :column   => 2,
-            :path     => anything,
-            :fullpath => anything,
-            :filename => anything
+            kind: :error,
+            check: :syntax,
+            message: 'Syntax error',
+            line: 1,
+            column: 2,
+            path: anything,
+            fullpath: anything,
+            filename: anything,
           )
         end
       end
@@ -55,14 +55,14 @@ describe PuppetLint::Checks do
         it 'creates a syntax error problem for the file' do
           expect(instance.problems).to have(1).problem
           expect(instance.problems.first).to include(
-            :kind     => :error,
-            :check    => :syntax,
-            :message  => 'Syntax error (some reason)',
-            :line     => 1,
-            :column   => 2,
-            :path     => anything,
-            :fullpath => anything,
-            :filename => anything
+            kind: :error,
+            check: :syntax,
+            message: 'Syntax error (some reason)',
+            line: 1,
+            column: 2,
+            path: anything,
+            fullpath: anything,
+            filename: anything,
           )
         end
       end
@@ -74,12 +74,12 @@ describe PuppetLint::Checks do
     let(:data) { "notify { 'test': }" }
     let(:enabled_checks) { [] }
 
-    before do
-      allow(instance).to receive(:enabled_checks).and_return(enabled_checks)
+    before(:each) do
+      allow(instance).to receive(:enabled_checks).and_return(enabled_checks) # rubocop: disable RSpec/SubjectStub
     end
 
     it 'loads the manifest data' do
-      expect(instance).to receive(:load_data).with(fileinfo, data).and_call_original
+      expect(instance).to receive(:load_data).with(fileinfo, data).and_call_original # rubocop: disable RSpec/SubjectStub
       instance.run(fileinfo, data)
     end
 
@@ -98,7 +98,7 @@ describe PuppetLint::Checks do
       it 'does not run the disabled checks' do
         # expect().to_not all(matcher) is not supported
         disabled_check_classes.each do |check_class|
-          expect(check_class).to_not receive(:new)
+          expect(check_class).not_to receive(:new)
         end
 
         instance.run(fileinfo, data)
@@ -110,12 +110,12 @@ describe PuppetLint::Checks do
         let(:mock_arrow_alignment) do
           instance_double(
             PuppetLint::CheckPlugin,
-            :run          => [{ :kind => :error, :check => :arrow_alignment }],
-            :fix_problems => [{ :kind => :fixed, :check => :arrow_alignment }]
+            run: [{ kind: :error, check: :arrow_alignment }],
+            fix_problems: [{ kind: :fixed, check: :arrow_alignment }],
           )
         end
         let(:mock_hard_tabs) do
-          instance_double(PuppetLint::CheckPlugin, :run => [], :fix_problems => [])
+          instance_double(PuppetLint::CheckPlugin, run: [], fix_problems: [])
         end
         let(:fix_state) { false }
 
@@ -127,22 +127,22 @@ describe PuppetLint::Checks do
         end
 
         it 'adds the found problems to the problems array' do
-          expect(instance).to have_attributes(:problems => [{ :kind => :error, :check => :arrow_alignment }])
+          expect(instance).to have_attributes(problems: [{ kind: :error, check: :arrow_alignment }])
         end
 
         context 'and fix is enabled' do
           let(:fix_state) { true }
 
           it 'calls #fix_problems on the check and adds the results to the problems array' do
-            expect(instance).to have_attributes(:problems => [{ :kind => :fixed, :check => :arrow_alignment }])
+            expect(instance).to have_attributes(problems: [{ kind: :fixed, check: :arrow_alignment }])
           end
         end
       end
     end
 
     context 'when an unhandled exception is raised' do
-      before do
-        allow(instance).to receive(:load_data).with(fileinfo, data).and_raise(StandardError.new('test message'))
+      before(:each) do
+        allow(instance).to receive(:load_data).with(fileinfo, data).and_raise(StandardError.new('test message')) # rubocop: disable RSpec/SubjectStub
         allow($stdout).to receive(:puts).with(anything)
       end
 
@@ -173,7 +173,7 @@ describe PuppetLint::Checks do
       end
 
       context 'and the file being linted is readable' do
-        before do
+        before(:each) do
           allow(File).to receive(:readable?).with(fileinfo).and_return(true)
           allow(File).to receive(:read).with(fileinfo).and_return(data)
         end
@@ -196,7 +196,7 @@ describe PuppetLint::Checks do
 
     let(:expected_enabled_checks) { [:arrow_alignment, :trailing_whitespace] }
 
-    before do
+    before(:each) do
       PuppetLint.configuration.checks.each do |check|
         allow(PuppetLint.configuration).to receive("#{check}_enabled?").and_return(expected_enabled_checks.include?(check))
       end
@@ -212,13 +212,13 @@ describe PuppetLint::Checks do
 
     let(:tokens) do
       [
-        instance_double(PuppetLint::Lexer::Token, :to_manifest => '1'),
-        instance_double(PuppetLint::Lexer::Token, :to_manifest => '2'),
-        instance_double(PuppetLint::Lexer::Token, :to_manifest => '3'),
+        instance_double(PuppetLint::Lexer::Token, to_manifest: '1'),
+        instance_double(PuppetLint::Lexer::Token, to_manifest: '2'),
+        instance_double(PuppetLint::Lexer::Token, to_manifest: '3'),
       ]
     end
 
-    before do
+    before(:each) do
       allow(PuppetLint::Data).to receive(:tokens).and_return(tokens)
     end
 

data/spec/unit/puppet-lint/configuration_spec.rb

@@ -0,0 +1,88 @@
+require 'spec_helper'
+
+describe PuppetLint::Configuration do
+  subject(:config) { described_class.new }
+
+  it 'creates check methods on the fly' do
+    klass = Class.new
+    config.add_check('foo', klass)
+
+    expect(config).to respond_to(:foo_enabled?)
+    expect(config).not_to respond_to(:bar_enabled?)
+    expect(config).to respond_to(:enable_foo)
+    expect(config).to respond_to(:disable_foo)
+
+    config.disable_foo
+    expect(config.settings['foo_disabled']).to be_truthy
+    expect(config.foo_enabled?).to be_falsey
+
+    config.enable_foo
+    expect(config.settings['foo_disabled']).to be_falsey
+    expect(config.foo_enabled?).to be_truthy
+  end
+
+  it 'knows what checks have been added' do
+    klass = Class.new
+    config.add_check('foo', klass)
+    expect(config.checks).to include('foo')
+  end
+
+  it 'responds nil to unknown config options' do
+    expect(config.foobarbaz).to be_nil
+  end
+
+  it 'is able to explicitly add options' do
+    config.add_option('bar')
+
+    expect(config.bar).to be_nil
+
+    config.bar = 'aoeui'
+    expect(config.bar).to eq('aoeui')
+  end
+
+  it 'is able to add options on the fly' do
+    expect(config.test_option).to eq(nil)
+
+    config.test_option = 'test'
+
+    expect(config.test_option).to eq('test')
+  end
+
+  it 'is able to set sane defaults' do
+    override_env do
+      ENV.delete('GITHUB_ACTION')
+      config.defaults
+    end
+
+    expect(config.settings).to eq(
+      'with_filename'    => false,
+      'fail_on_warnings' => false,
+      'error_level'      => :all,
+      'log_format'       => '',
+      'sarif'            => false,
+      'with_context'     => false,
+      'fix'              => false,
+      'github_actions'   => false,
+      'show_ignored'     => false,
+      'json'             => false,
+      'ignore_paths'     => ['vendor/**/*.pp'],
+    )
+  end
+
+  it 'detects github actions' do
+    override_env do
+      ENV['GITHUB_ACTION'] = 'action'
+      config.defaults
+    end
+
+    expect(config.settings['github_actions']).to be(true)
+  end
+
+  def override_env
+    old_env = ENV.to_h
+    yield
+  ensure
+    ENV.clear
+    ENV.update(old_env)
+  end
+end

data/spec/{puppet-lint → unit/puppet-lint}/data_spec.rb

@@ -1,7 +1,8 @@
 require 'spec_helper'
 
 describe PuppetLint::Data do
-  subject(:data) { PuppetLint::Data }
+  subject(:data) { described_class }
+
   let(:lexer) { PuppetLint::Lexer.new }
 
   describe '.resource_indexes' do
@@ -39,7 +40,8 @@ describe PuppetLint::Data do
     let(:new_token) { PuppetLint::Lexer::Token.new(:PLUS, '+', 0, 0) }
     let(:original_tokens) { lexer.tokenise(manifest) }
     let(:tokens) { original_tokens.dup }
-    before do
+
+    before(:each) do
       data.tokens = tokens
       data.insert(2, new_token)
     end
@@ -86,7 +88,8 @@ describe PuppetLint::Data do
     let(:token) { tokens[2] }
     let(:original_tokens) { lexer.tokenise(manifest) }
     let(:tokens) { original_tokens.dup }
-    before do
+
+    before(:each) do
       data.tokens = tokens
       data.delete(token)
     end

data/spec/{puppet-lint → unit/puppet-lint}/ignore_overrides_spec.rb

@@ -1,6 +1,6 @@
 require 'spec_helper'
 
-describe 'quoted_booleans', :type => :lint do
+describe 'quoted_booleans', type: :lint do
   let(:msg) { 'quoted boolean value found' }
 
   context 'with a single line ignore' do
@@ -12,16 +12,16 @@ describe 'quoted_booleans', :type => :lint do
       END
     end
 
-    it 'should detect three problems' do
+    it 'detects three problems' do
       expect(problems).to have(3).problems
     end
 
-    it 'should have two warnings' do
+    it 'has two warnings' do
       expect(problems).to contain_warning(msg).on_line(1).in_column(9)
       expect(problems).to contain_warning(msg).on_line(3).in_column(9)
     end
 
-    it 'should have one ignored problem' do
+    it 'has one ignored problem' do
       expect(problems).to contain_ignored(msg).on_line(2).in_column(9)
     end
   end
@@ -35,16 +35,16 @@ describe 'quoted_booleans', :type => :lint do
       END
     end
 
-    it 'should detect three problems' do
+    it 'detects three problems' do
       expect(problems).to have(3).problems
     end
 
-    it 'should have two warnings' do
+    it 'has two warnings' do
       expect(problems).to contain_warning(msg).on_line(1).in_column(9)
       expect(problems).to contain_warning(msg).on_line(3).in_column(9)
     end
 
-    it 'should have one ignored problem with a reason' do
+    it 'has one ignored problem with a reason' do
       expect(problems).to contain_ignored(msg).on_line(2).in_column(9).with_reason('some good reason')
     end
   end
@@ -61,16 +61,16 @@ describe 'quoted_booleans', :type => :lint do
       END
     end
 
-    it 'should detect four problems' do
+    it 'detects four problems' do
       expect(problems).to have(4).problems
     end
 
-    it 'should have two warnings' do
+    it 'has two warnings' do
       expect(problems).to contain_warning(msg).on_line(1).in_column(9)
       expect(problems).to contain_warning(msg).on_line(6).in_column(9)
     end
 
-    it 'should have two ignored problems' do
+    it 'has two ignored problems' do
       expect(problems).to contain_ignored(msg).on_line(3).in_column(9)
       expect(problems).to contain_ignored(msg).on_line(4).in_column(9)
     end
@@ -88,16 +88,16 @@ describe 'quoted_booleans', :type => :lint do
       END
     end
 
-    it 'should detect four problems' do
+    it 'detects four problems' do
       expect(problems).to have(4).problems
     end
 
-    it 'should have two warnings' do
+    it 'has two warnings' do
       expect(problems).to contain_warning(msg).on_line(1).in_column(9)
       expect(problems).to contain_warning(msg).on_line(6).in_column(9)
     end
 
-    it 'should have two ignored problems with a reason' do
+    it 'has two ignored problems with a reason' do
       expect(problems).to contain_ignored(msg).on_line(3).in_column(9).with_reason('another reason')
       expect(problems).to contain_ignored(msg).on_line(4).in_column(9).with_reason('another reason')
     end
@@ -106,11 +106,11 @@ describe 'quoted_booleans', :type => :lint do
   context 'disable multiple checks on a line with a reason' do
     let(:code) { '"true" # lint:ignore:quoted_booleans lint:ignore:double_quoted_string a reason' }
 
-    it 'should detect 1 problems' do
+    it 'detects 1 problems' do
       expect(problems).to have(1).problems
     end
 
-    it 'should have one ignored problems' do
+    it 'has one ignored problems' do
       expect(problems).to contain_ignored(msg).on_line(1).in_column(1).with_reason('a reason')
     end
   end
@@ -128,11 +128,11 @@ describe 'quoted_booleans', :type => :lint do
       END
     end
 
-    it 'should detect 2 problems' do
+    it 'detects 2 problems' do
       expect(problems).to have(2).problems
     end
 
-    it 'should ignore both problems' do
+    it 'ignores both problems' do
       expect(problems).to contain_ignored(msg).on_line(4).in_column(19).with_reason('')
       expect(problems).to contain_ignored(msg).on_line(5).in_column(25).with_reason('')
     end