puppet-lint 0.4.0.pre1 → 1.0.0

data/lib/puppet-lint/tasks/puppet-lint.rb

@@ -1,14 +1,29 @@
 require 'puppet-lint'
+require 'puppet-lint/optparser'
 require 'rake'
 require 'rake/tasklib'
 
 class PuppetLint
+  # Public: A Rake task that can be loaded and used with everything you need.
+  #
+  # Examples
+  #
+  #   require 'puppet-lint'
+  #   PuppetLint::RakeTask.new
   class RakeTask < ::Rake::TaskLib
+    # Public: Initialise a new PuppetLint::RakeTask.
+    #
+    # args - Not used.
+    #
+    # Example
+    #
+    #   PuppetLint::RakeTask.new
     def initialize(*args)
       desc 'Run puppet-lint'
 
       task :lint do
         PuppetLint.configuration.with_filename = true
+        PuppetLint::OptParser.build
 
         RakeFileUtils.send(:verbose, true) do
           linter = PuppetLint.new
@@ -21,8 +36,9 @@ class PuppetLint
           matched_files.to_a.each do |puppet_file|
             linter.file = puppet_file
             linter.run
+            linter.print_problems
           end
-          fail if linter.errors? || (
+          abort if linter.errors? || (
             linter.warnings? && PuppetLint.configuration.fail_on_warnings
           )
         end

data/lib/puppet-lint/version.rb

@@ -1,3 +1,3 @@
 class PuppetLint
-  VERSION = '0.4.0.pre1'
+  VERSION = '1.0.0'
 end

data/puppet-lint.gemspec

@@ -14,8 +14,10 @@ Gem::Specification.new do |s|
   s.executables = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
   s.require_paths = ["lib"]
 
-  s.add_development_dependency 'rspec'
-  s.add_development_dependency 'rcov'
+  s.add_development_dependency 'rake', '~> 10.0'
+  s.add_development_dependency 'rspec', '~> 3.0'
+  s.add_development_dependency 'rspec-its', '~> 1.0'
+  s.add_development_dependency 'rspec-collection_matchers', '~> 1.0'
 
   s.authors = ['Tim Sharpe']
   s.email = 'tim@sharpe.id.au'

data/spec/fixtures/test/manifests/ignore.pp

@@ -0,0 +1 @@
+"test" # lint:ignore:double_quoted_strings

data/spec/fixtures/test/manifests/ignore_reason.pp

@@ -0,0 +1 @@
+"test" # lint:ignore:double_quoted_strings for a good reason

data/spec/puppet-lint/bin_spec.rb

@@ -38,20 +38,20 @@ describe PuppetLint::Bin do
   context 'when running normally' do
     let(:args) { 'spec/fixtures/test/manifests/init.pp' }
 
-    its(:exitstatus) { should == 0 }
+    its(:exitstatus) { is_expected.to eq(0) }
   end
 
   context 'when running without arguments' do
     let(:args) { [] }
 
-    its(:exitstatus) { should == 1 }
+    its(:exitstatus) { is_expected.to eq(1) }
   end
 
   context 'when asked to display version' do
     let(:args) { '--version' }
 
-    its(:exitstatus) { should == 0 }
-    its(:stdout) { should == "Puppet-lint #{PuppetLint::VERSION}" }
+    its(:exitstatus) { is_expected.to eq(0) }
+    its(:stdout) { is_expected.to eq("puppet-lint #{PuppetLint::VERSION}") }
   end
 
   context 'when passed multiple files' do
@@ -60,18 +60,18 @@ describe PuppetLint::Bin do
       'spec/fixtures/test/manifests/fail.pp',
     ] }
 
-    its(:exitstatus) { should == 1 }
-    its(:stdout) { should == [
-      'WARNING: optional parameter listed before required parameter on line 2',
-      'ERROR: test::foo not in autoload module layout on line 2',
-    ].join("\n") }
+    its(:exitstatus) { is_expected.to eq(1) }
+    its(:stdout) { is_expected.to eq([
+      "#{args[0]} - WARNING: optional parameter listed before required parameter on line 2",
+      "#{args[1]} - ERROR: test::foo not in autoload module layout on line 2",
+    ].join("\n")) }
   end
 
   context 'when passed a malformed file' do
     let(:args) { 'spec/fixtures/test/manifests/malformed.pp' }
 
-    its(:exitstatus) { should == 1 }
-    its(:stdout) { should == 'ERROR: Syntax error (try running `puppet parser validate <file>`) on line 1' }
+    its(:exitstatus) { is_expected.to eq(1) }
+    its(:stdout) { is_expected.to eq('ERROR: Syntax error (try running `puppet parser validate <file>`) on line 1') }
   end
 
   context 'when limited to errors only' do
@@ -81,33 +81,46 @@ describe PuppetLint::Bin do
       'spec/fixtures/test/manifests/fail.pp',
     ] }
 
-    its(:exitstatus) { should == 1 }
-    its(:stdout) { should match(/^ERROR/) }
+    its(:exitstatus) { is_expected.to eq(1) }
+    its(:stdout) { is_expected.to match(/^#{args.last} - ERROR/) }
   end
 
-  context 'when limited to errors only' do
+  context 'when limited to warnings only' do
     let(:args) { [
       '--error-level', 'warning',
       'spec/fixtures/test/manifests/warning.pp',
       'spec/fixtures/test/manifests/fail.pp',
     ] }
 
-    its(:exitstatus) { should == 1 }
-    its(:stdout) { should match(/^WARNING/) }
+    its(:exitstatus) { is_expected.to eq(1) }
+    its(:stdout) { is_expected.to match(/WARNING/) }
+    its(:stdout) { is_expected.to_not match(/ERROR/) }
+  end
+
+  context 'when specifying a specific check to run' do
+    let(:args) { [
+      '--only-check', 'parameter_order',
+      'spec/fixtures/test/manifests/warning.pp',
+      'spec/fixtures/test/manifests/fail.pp',
+    ] }
+
+    its(:exitstatus) { is_expected.to eq(0) }
+    its(:stdout) { is_expected.to_not match(/ERROR/) }
+    its(:stdout) { is_expected.to match(/WARNING/) }
   end
 
   context 'when asked to display filenames ' do
     let(:args) { ['--with-filename', 'spec/fixtures/test/manifests/fail.pp'] }
 
-    its(:exitstatus) { should == 1 }
-    its(:stdout) { should match(%r{^spec/fixtures/test/manifests/fail\.pp -}) }
+    its(:exitstatus) { is_expected.to eq(1) }
+    its(:stdout) { is_expected.to match(%r{^spec/fixtures/test/manifests/fail\.pp -}) }
   end
 
   context 'when not asked to fail on warnings' do
     let(:args) { ['spec/fixtures/test/manifests/warning.pp'] }
 
-    its(:exitstatus) { should == 0 }
-    its(:stdout) { should match(/optional parameter/) }
+    its(:exitstatus) { is_expected.to eq(0) }
+    its(:stdout) { is_expected.to match(/optional parameter/) }
   end
 
   context 'when asked to provide context to problems' do
@@ -116,13 +129,13 @@ describe PuppetLint::Bin do
       'spec/fixtures/test/manifests/warning.pp',
     ] }
 
-    its(:exitstatus) { should == 0 }
-    its(:stdout) { should == [
+    its(:exitstatus) { is_expected.to eq(0) }
+    its(:stdout) { is_expected.to eq([
       'WARNING: optional parameter listed before required parameter on line 2',
       '',
       "  define test::warning($foo='bar', $baz) { }",
       '                                   ^',
-    ].join("\n")
+    ].join("\n"))
     }
   end
 
@@ -132,29 +145,29 @@ describe PuppetLint::Bin do
       'spec/fixtures/test/manifests/warning.pp',
     ] }
 
-    its(:exitstatus) { should == 1 }
-    its(:stdout) { should match(/optional parameter/) }
+    its(:exitstatus) { is_expected.to eq(1) }
+    its(:stdout) { is_expected.to match(/optional parameter/) }
   end
 
   context 'when used with an invalid option' do
     let(:args) { '--foo-bar-baz' }
 
-    its(:exitstatus) { should == 1 }
-    its(:stdout) { should match(/invalid option/) }
+    its(:exitstatus) { is_expected.to eq(1) }
+    its(:stdout) { is_expected.to match(/invalid option/) }
   end
 
   context 'when passed a file that does not exist' do
     let(:args) { 'spec/fixtures/test/manifests/enoent.pp' }
 
-    its(:exitstatus) { should == 1 }
-    its(:stdout) { should match(/specified file does not exist/) }
+    its(:exitstatus) { is_expected.to eq(1) }
+    its(:stdout) { is_expected.to match(/specified file does not exist/) }
   end
 
   context 'when passed a directory' do
     let(:args) { 'spec/fixtures/' }
 
-    its(:exitstatus) { should == 1 }
-    its(:stdout) { should match(/^ERROR/) }
+    its(:exitstatus) { is_expected.to eq(1) }
+    its(:stdout) { is_expected.to match(/ERROR/) }
   end
 
   context 'when disabling a check' do
@@ -163,8 +176,8 @@ describe PuppetLint::Bin do
       'spec/fixtures/test/manifests/fail.pp'
     ] }
 
-    its(:exitstatus) { should == 0 }
-    its(:stdout) { should == "" }
+    its(:exitstatus) { is_expected.to eq(0) }
+    its(:stdout) { is_expected.to eq("") }
   end
 
   context 'when changing the log format' do
@@ -174,8 +187,8 @@ describe PuppetLint::Bin do
         'spec/fixtures/test/manifests/fail.pp'
       ] }
 
-      its(:exitstatus) { should == 1 }
-      its(:stdout) { should == 'fail.pp' }
+      its(:exitstatus) { is_expected.to eq(1) }
+      its(:stdout) { is_expected.to eq('fail.pp') }
     end
 
     context 'to print %{path}' do
@@ -184,8 +197,8 @@ describe PuppetLint::Bin do
         'spec/fixtures/test/manifests/fail.pp'
       ] }
 
-      its(:exitstatus) { should == 1 }
-      its(:stdout) { should == 'spec/fixtures/test/manifests/fail.pp' }
+      its(:exitstatus) { is_expected.to eq(1) }
+      its(:stdout) { is_expected.to eq('spec/fixtures/test/manifests/fail.pp') }
     end
 
     context 'to print %{fullpath}' do
@@ -194,9 +207,9 @@ describe PuppetLint::Bin do
         'spec/fixtures/test/manifests/fail.pp'
       ] }
 
-      its(:exitstatus) { should == 1 }
+      its(:exitstatus) { is_expected.to eq(1) }
       its(:stdout) {
-        should match(%r{^/.+/spec/fixtures/test/manifests/fail\.pp$})
+        is_expected.to match(%r{^/.+/spec/fixtures/test/manifests/fail\.pp$})
       }
     end
 
@@ -206,8 +219,19 @@ describe PuppetLint::Bin do
         'spec/fixtures/test/manifests/fail.pp'
       ] }
 
-      its(:exitstatus) { should == 1 }
-      its(:stdout) { should == '2' }
+      its(:exitstatus) { is_expected.to eq(1) }
+      its(:stdout) { is_expected.to eq('2') }
+      its(:stderr) { is_expected.to eq('DEPRECATION: Please use %{line} instead of %{linenumber}') }
+    end
+
+    context 'to print %{line}' do
+      let(:args) { [
+        '--log-format', '%{line}',
+        'spec/fixtures/test/manifests/fail.pp'
+      ] }
+
+      its(:exitstatus) { is_expected.to eq(1) }
+      its(:stdout) { is_expected.to eq('2') }
     end
 
     context 'to print %{kind}' do
@@ -216,8 +240,8 @@ describe PuppetLint::Bin do
         'spec/fixtures/test/manifests/fail.pp'
       ] }
 
-      its(:exitstatus) { should == 1 }
-      its(:stdout) { should == 'error' }
+      its(:exitstatus) { is_expected.to eq(1) }
+      its(:stdout) { is_expected.to eq('error') }
     end
 
     context 'to print %{KIND}' do
@@ -226,8 +250,8 @@ describe PuppetLint::Bin do
         'spec/fixtures/test/manifests/fail.pp'
       ] }
 
-      its(:exitstatus) { should == 1 }
-      its(:stdout) { should == 'ERROR' }
+      its(:exitstatus) { is_expected.to eq(1) }
+      its(:stdout) { is_expected.to eq('ERROR') }
     end
 
     context 'to print %{check}' do
@@ -236,8 +260,8 @@ describe PuppetLint::Bin do
         'spec/fixtures/test/manifests/fail.pp'
       ] }
 
-      its(:exitstatus) { should == 1 }
-      its(:stdout) { should == 'autoloader_layout' }
+      its(:exitstatus) { is_expected.to eq(1) }
+      its(:stdout) { is_expected.to eq('autoloader_layout') }
     end
 
     context 'to print %{message}' do
@@ -246,44 +270,40 @@ describe PuppetLint::Bin do
         'spec/fixtures/test/manifests/fail.pp'
       ] }
 
-      its(:exitstatus) { should == 1 }
-      its(:stdout) { should == 'test::foo not in autoload module layout' }
+      its(:exitstatus) { is_expected.to eq(1) }
+      its(:stdout) { is_expected.to eq('test::foo not in autoload module layout') }
     end
+  end
 
-    context 'when loading options from a file' do
-      let(:args) { 'spec/fixtures/test/manifests/fail.pp' }
-
-      it 'should have ~/.puppet-lintrc as depreciated' do
-        OptionParser.any_instance.stub(:load).
-          with(File.expand_path('~/.puppet-lintrc')).and_return(true)
-        OptionParser.any_instance.stub(:load).
-          with(File.expand_path('~/.puppet-lint.rc')).and_return(false)
-        OptionParser.any_instance.stub(:load).
-          with('.puppet-lintrc').and_return(false)
-        OptionParser.any_instance.stub(:load).
-          with('.puppet-lint.rc').and_return(false)
-        OptionParser.any_instance.stub(:load).
-          with('/etc/puppet-lint.rc').and_return(false)
-
-        msg = 'Depreciated: Found ~/.puppet-lintrc instead of ~/.puppet-lint.rc'
-        subject.stderr.should == msg
-      end
-
-      it 'should have .puppet-lintrc as depreciated' do
-        OptionParser.any_instance.stub(:load).
-          with(File.expand_path('~/.puppet-lintrc')).and_return(false)
-        OptionParser.any_instance.stub(:load).
-          with(File.expand_path('~/.puppet-lint.rc')).and_return(false)
-        OptionParser.any_instance.stub(:load).
-          with('.puppet-lintrc').and_return(true)
-        OptionParser.any_instance.stub(:load).
-          with('.puppet-lint.rc').and_return(false)
-        OptionParser.any_instance.stub(:load).
-          with('/etc/puppet-lint.rc').and_return(false)
-
-        msg = 'Depreciated: Read .puppet-lintrc instead of .puppet-lint.rc'
-        subject.stderr.should == msg
-      end
-    end
+  context 'when hiding ignored problems' do
+    let(:args) { [
+      'spec/fixtures/test/manifests/ignore.pp'
+    ] }
+
+    its(:exitstatus) { is_expected.to eq(0) }
+    its(:stdout) { is_expected.to_not match(/IGNORED/) }
+  end
+
+  context 'when showing ignored problems' do
+    let(:args) { [
+      '--show-ignored',
+      'spec/fixtures/test/manifests/ignore.pp',
+    ] }
+
+    its(:exitstatus) { is_expected.to eq(0) }
+    its(:stdout) { is_expected.to match(/IGNORED/) }
+  end
+
+  context 'when showing ignored problems with a reason' do
+    let(:args) { [
+      '--show-ignored',
+      'spec/fixtures/test/manifests/ignore_reason.pp',
+    ] }
+
+    its(:exitstatus) { is_expected.to eq(0) }
+    its(:stdout) { is_expected.to eq([
+      "IGNORED: double quoted string containing no variables on line 1",
+      "  for a good reason",
+    ].join("\n")) }
   end
 end

data/spec/puppet-lint/configuration_spec.rb

@@ -4,53 +4,53 @@ describe PuppetLint::Configuration do
   subject { PuppetLint::Configuration.new }
 
   it 'should create check methods on the fly' do
-    method = Proc.new { true }
-    subject.add_check('foo', &method)
+    klass = Class.new
+    subject.add_check('foo', klass)
 
-    subject.should respond_to(:foo_enabled?)
-    subject.should_not respond_to(:bar_enabled?)
-    subject.should respond_to(:enable_foo)
-    subject.should respond_to(:disable_foo)
+    expect(subject).to respond_to(:foo_enabled?)
+    expect(subject).to_not respond_to(:bar_enabled?)
+    expect(subject).to respond_to(:enable_foo)
+    expect(subject).to respond_to(:disable_foo)
 
     subject.disable_foo
-    subject.settings['foo_disabled'].should == true
-    subject.foo_enabled?.should == false
+    expect(subject.settings['foo_disabled']).to be_truthy
+    expect(subject.foo_enabled?).to be_falsey
 
     subject.enable_foo
-    subject.settings['foo_disabled'].should == false
-    subject.foo_enabled?.should == true
+    expect(subject.settings['foo_disabled']).to be_falsey
+    expect(subject.foo_enabled?).to be_truthy
   end
 
   it 'should know what checks have been added' do
-    method = Proc.new { true }
-    subject.add_check('foo', &method)
-    subject.checks.should include('foo')
+    klass = Class.new
+    subject.add_check('foo', klass)
+    expect(subject.checks).to include('foo')
   end
 
   it 'should respond nil to unknown config options' do
-    subject.foobarbaz.should == nil
+    expect(subject.foobarbaz).to be_nil
   end
 
   it 'should create options on the fly' do
     subject.add_option('bar')
 
-    subject.bar.should == nil
+    expect(subject.bar).to be_nil
 
     subject.bar = 'aoeui'
-    subject.bar.should == 'aoeui'
+    expect(subject.bar).to eq('aoeui')
   end
 
   it 'should be able to set sane defaults' do
     subject.defaults
 
-    subject.settings.should == {
+    expect(subject.settings).to eq({
       'with_filename' => false,
       'fail_on_warnings' => false,
       'error_level' => :all,
       'log_format' => '',
       'with_context' => false,
       'fix' => false,
-    }
+      'show_ignored' => false,
+    })
   end
 end
-