lint_trap 0.0.11 → 0.0.13

data/spec/integration/scsslint_spec.rb

@@ -1,25 +1,31 @@
 require 'spec_helper'
 
 describe LintTrap::Linter::SCSSLint do
-  let(:container){LintTrap::Container::Docker.new('lintci/spin_cycle:latest', fixture_path)}
+  let(:container){LintTrap::Container::Docker.new(linter.image_version, fixture_path)}
   let(:options){{}}
   subject(:linter){described_class.new}
 
+  describe '#version' do
+    subject(:dockerfile){Dockerfile.new(linter.name)}
+
+    it 'matches the linters version' do
+      expect(dockerfile.include_env?('SCSSLINT_VERSION', linter.version)).to be_truthy
+    end
+  end
+
   describe '#lint' do
     context 'when linting a bad file' do
       let(:file){fixture_path('bad.scss')}
 
       it 'generates lint' do
         expect{|b| linter.lint([file], container, options, &b)}.to yield_successive_args(
-          {
-            file: file,
-            line: '2',
-            column: '3',
-            length: '12',
-            rule: 'BorderZero',
-            severity: 'warning',
-            message: '`border: 0;` is preferred over `border: none;`'
-          }
+          file: file,
+          line: '2',
+          column: '3',
+          length: '12',
+          rule: 'BorderZero',
+          severity: 'warning',
+          message: '`border: 0 is preferred over `border: none`'
         )
       end
     end

data/spec/language/coffeescript_spec.rb

@@ -7,4 +7,5 @@ describe LintTrap::Language::CoffeeScript do
 
   its(:name){is_expected.to eq('CoffeeScript')}
   its(:linters){is_expected.to eq([LintTrap::Linter::CoffeeLint.new])}
+  it{is_expected.to be_known}
 end

data/spec/language/cpp_spec.rb

@@ -7,4 +7,5 @@ describe LintTrap::Language::CPP do
 
   its(:name){is_expected.to eq('C++')}
   its(:linters){is_expected.to eq([LintTrap::Linter::CPPCheck.new])}
+  it{is_expected.to be_known}
 end

data/spec/language/css_spec.rb

@@ -7,4 +7,5 @@ describe LintTrap::Language::CSS do
 
   its(:name){is_expected.to eq('CSS')}
   its(:linters){is_expected.to eq([LintTrap::Linter::CSSLint.new])}
+  it{is_expected.to be_known}
 end

data/spec/language/go_spec.rb

@@ -7,4 +7,5 @@ describe LintTrap::Language::Go do
 
   its(:name){is_expected.to eq('Go')}
   its(:linters){is_expected.to eq([LintTrap::Linter::GoLint.new])}
+  it{is_expected.to be_known}
 end

data/spec/language/java_spec.rb

@@ -7,4 +7,5 @@ describe LintTrap::Language::Java do
 
   its(:name){is_expected.to eq('Java')}
   its(:linters){is_expected.to eq([LintTrap::Linter::CheckStyle.new])}
+  it{is_expected.to be_known}
 end

data/spec/language/javascript_spec.rb

@@ -7,4 +7,5 @@ describe LintTrap::Language::JavaScript do
 
   its(:name){is_expected.to eq('JavaScript')}
   its(:linters){is_expected.to eq([LintTrap::Linter::JSHint.new])}
+  it{is_expected.to be_known}
 end

data/spec/language/json_spec.rb

@@ -7,4 +7,5 @@ describe LintTrap::Language::JSON do
 
   its(:name){is_expected.to eq('JSON')}
   its(:linters){is_expected.to eq([LintTrap::Linter::JSONLint.new])}
+  it{is_expected.to be_known}
 end

data/spec/language/python_spec.rb

@@ -7,4 +7,5 @@ describe LintTrap::Language::Python do
 
   its(:name){is_expected.to eq('Python')}
   its(:linters){is_expected.to eq([LintTrap::Linter::PyLint.new])}
+  it{is_expected.to be_known}
 end

data/spec/language/ruby_spec.rb

@@ -7,4 +7,5 @@ describe LintTrap::Language::Ruby do
 
   its(:name){is_expected.to eq('Ruby')}
   its(:linters){is_expected.to eq([LintTrap::Linter::RuboCop.new])}
+  it{is_expected.to be_known}
 end

data/spec/language/scss_spec.rb

@@ -7,4 +7,5 @@ describe LintTrap::Language::SCSS do
 
   its(:name){is_expected.to eq('SCSS')}
   its(:linters){is_expected.to eq([LintTrap::Linter::SCSSLint.new])}
+  it{is_expected.to be_known}
 end

data/spec/language/unknown_spec.rb

@@ -16,4 +16,5 @@ describe LintTrap::Language::Unknown do
   end
 
   its(:linters){is_expected.to eq([LintTrap::Linter::Unknown.new])}
+  it{is_expected.to_not be_known}
 end

data/spec/linter/base_spec.rb

@@ -0,0 +1,24 @@
+require 'spec_helper'
+
+describe LintTrap::Linter::Base do
+  let(:container){LintTrap::Container::Docker.new('lintci/rubocop', '/src')}
+  subject(:linter) do
+    Class.new(described_class) do
+      def name
+        'ErrorLinter'
+      end
+    end.new
+  end
+
+  describe '#version' do
+    it 'raises an error if not overriden' do
+      expect{linter.version}.to raise_error(NotImplementedError, 'Must implement version.')
+    end
+  end
+
+  describe '#lint' do
+    it 'raises an error if #flags is not overriden' do
+      expect{linter.lint([], container, {})}.to raise_error(NotImplementedError, 'Must implement flags.')
+    end
+  end
+end

data/spec/linter/checkstyle_spec.rb

@@ -10,6 +10,10 @@ describe LintTrap::Linter::CheckStyle do
   it_behaves_like 'linter'
 
   its(:languages){is_expected.to eq([LintTrap::Language::Java.new])}
+  its(:version){is_expected.to eq('6.6')}
+  its(:image){is_expected.to eq('lintci/checkstyle')}
+  its(:image_version){is_expected.to eq('lintci/checkstyle:6.6')}
+  its(:jar){is_expected.to eq('checkstyle/checkstyle_logger-6.6-all.jar')}
 
   describe '#lint' do
     context 'when config is provided' do
@@ -19,12 +23,12 @@ describe LintTrap::Linter::CheckStyle do
         expect(LintTrap::Command).to receive(:new).with(
           'java',
           [
-            '-jar', container.config_path(described_class::JAR),
+            '-jar', container.config_path(linter.jar),
             '-c', options[:config]
           ],
           files
         ).and_return(command)
-        expect(command).to receive(:run).with(container)
+        expect(command).to receive(:run).with(container).and_return(true)
 
         linter.lint(files, container, options)
       end
@@ -35,12 +39,12 @@ describe LintTrap::Linter::CheckStyle do
         expect(LintTrap::Command).to receive(:new).with(
           'java',
           [
-            '-jar', container.config_path(described_class::JAR),
+            '-jar', container.config_path(linter.jar),
             '-c', container.config_path(described_class::CHECKS_XML)
           ],
           files
         ).and_return(command)
-        expect(command).to receive(:run).with(container)
+        expect(command).to receive(:run).with(container).and_return(true)
 
         linter.lint(files, container, options)
       end

data/spec/linter/coffeelint_spec.rb

@@ -10,6 +10,9 @@ describe LintTrap::Linter::CoffeeLint do
   it_behaves_like 'linter'
 
   its(:languages){is_expected.to eq([LintTrap::Language::CoffeeScript.new])}
+  its(:version){is_expected.to eq('1.9.7')}
+  its(:image){is_expected.to eq('lintci/coffeelint')}
+  its(:image_version){is_expected.to eq('lintci/coffeelint:1.9.7')}
 
   describe '#lint' do
     context 'when config is provided' do
@@ -25,7 +28,7 @@ describe LintTrap::Linter::CoffeeLint do
           ],
           files
         ).and_return(command)
-        expect(command).to receive(:run).with(container)
+        expect(command).to receive(:run).with(container).and_return(true)
 
         linter.lint(files, container, options)
       end
@@ -41,7 +44,7 @@ describe LintTrap::Linter::CoffeeLint do
           ],
           files
         ).and_return(command)
-        expect(command).to receive(:run).with(container)
+        expect(command).to receive(:run).with(container).and_return(true)
 
         linter.lint(files, container, options)
       end

data/spec/linter/cppcheck_spec.rb

@@ -10,6 +10,9 @@ describe LintTrap::Linter::CPPCheck do
   it_behaves_like 'linter'
 
   its(:languages){is_expected.to eq([LintTrap::Language::CPP.new])}
+  its(:version){is_expected.to eq('1.67-1')}
+  its(:image){is_expected.to eq('lintci/cppcheck')}
+  its(:image_version){is_expected.to eq('lintci/cppcheck:1.67-1')}
 
   describe '#lint' do
     it 'runs the lint command with the correct arguments' do
@@ -22,7 +25,7 @@ describe LintTrap::Linter::CPPCheck do
         ],
         files
       ).and_return(command)
-      expect(command).to receive(:run).with(container)
+      expect(command).to receive(:run).with(container).and_return(true)
 
       linter.lint(files, container, options)
     end

data/spec/linter/csslint_spec.rb

@@ -10,6 +10,9 @@ describe LintTrap::Linter::CSSLint do
   it_behaves_like 'linter'
 
   its(:languages){is_expected.to eq([LintTrap::Language::CSS.new])}
+  its(:version){is_expected.to eq('0.10.0')}
+  its(:image){is_expected.to eq('lintci/csslint')}
+  its(:image_version){is_expected.to eq('lintci/csslint:0.10.0')}
 
   describe '#lint' do
     context 'when config is provided' do
@@ -24,7 +27,7 @@ describe LintTrap::Linter::CSSLint do
           ],
           files
         ).and_return(command)
-        expect(command).to receive(:run).with(container)
+        expect(command).to receive(:run).with(container).and_return(true)
 
         linter.lint(files, container, options)
       end
@@ -39,7 +42,7 @@ describe LintTrap::Linter::CSSLint do
           ],
           files
         ).and_return(command)
-        expect(command).to receive(:run).with(container)
+        expect(command).to receive(:run).with(container).and_return(true)
 
         linter.lint(files, container, options)
       end

data/spec/linter/golint_spec.rb

@@ -10,6 +10,9 @@ describe LintTrap::Linter::GoLint do
   it_behaves_like 'linter'
 
   its(:languages){is_expected.to eq([LintTrap::Language::Go.new])}
+  its(:version){is_expected.to eq(LintTrap::VERSION)}
+  its(:image){is_expected.to eq('lintci/golint')}
+  its(:image_version){is_expected.to eq('lintci/golint:' + LintTrap::VERSION)}
 
   describe '#lint' do
     it 'runs the lint command with the correct arguments' do
@@ -18,7 +21,7 @@ describe LintTrap::Linter::GoLint do
         [],
         files
       ).and_return(command)
-      expect(command).to receive(:run).with(container)
+      expect(command).to receive(:run).with(container).and_return(true)
 
       linter.lint(files, container, options)
     end

data/spec/linter/jshint_spec.rb

@@ -10,6 +10,9 @@ describe LintTrap::Linter::JSHint do
   it_behaves_like 'linter'
 
   its(:languages){is_expected.to eq([LintTrap::Language::JavaScript.new])}
+  its(:version){is_expected.to eq('2.5.11')}
+  its(:image){is_expected.to eq('lintci/jshint')}
+  its(:image_version){is_expected.to eq('lintci/jshint:2.5.11')}
 
   describe '#lint' do
     context 'when config is provided' do
@@ -24,7 +27,7 @@ describe LintTrap::Linter::JSHint do
           ],
           files
         ).and_return(command)
-        expect(command).to receive(:run).with(container)
+        expect(command).to receive(:run).with(container).and_return(true)
 
         linter.lint(files, container, options)
       end
@@ -39,7 +42,7 @@ describe LintTrap::Linter::JSHint do
           ],
           files
         ).and_return(command)
-        expect(command).to receive(:run).with(container)
+        expect(command).to receive(:run).with(container).and_return(true)
 
         linter.lint(files, container, options)
       end

data/spec/linter/jsonlint_spec.rb

@@ -10,6 +10,9 @@ describe LintTrap::Linter::JSONLint do
   it_behaves_like 'linter'
 
   its(:languages){is_expected.to eq([LintTrap::Language::JSON.new])}
+  its(:version){is_expected.to eq('0.0.4')}
+  its(:image){is_expected.to eq('lintci/jsonlint')}
+  its(:image_version){is_expected.to eq('lintci/jsonlint:0.0.4')}
 
   describe '#lint' do
     it 'runs the lint command with the correct arguments' do
@@ -18,7 +21,7 @@ describe LintTrap::Linter::JSONLint do
         ['--format', '{{file}}:{{line}}:{{column}}:::error:{{{description}}}'],
         files
       ).and_return(command)
-      expect(command).to receive(:run).with(container)
+      expect(command).to receive(:run).with(container).and_return(true)
 
       linter.lint(files, container, options)
     end

data/spec/linter/pylint_spec.rb

@@ -10,6 +10,9 @@ describe LintTrap::Linter::PyLint do
   it_behaves_like 'linter'
 
   its(:languages){is_expected.to eq([LintTrap::Language::Python.new])}
+  its(:version){is_expected.to eq('1.3.1-3')}
+  its(:image){is_expected.to eq('lintci/pylint')}
+  its(:image_version){is_expected.to eq('lintci/pylint:1.3.1-3')}
 
   describe '#lint' do
     context 'when config is provided' do
@@ -25,7 +28,7 @@ describe LintTrap::Linter::PyLint do
           ],
           files
         ).and_return(command)
-        expect(command).to receive(:run).with(container)
+        expect(command).to receive(:run).with(container).and_return(true)
 
         linter.lint(files, container, options)
       end
@@ -41,7 +44,7 @@ describe LintTrap::Linter::PyLint do
           ],
           files
         ).and_return(command)
-        expect(command).to receive(:run).with(container)
+        expect(command).to receive(:run).with(container).and_return(true)
 
         linter.lint(files, container, options)
       end

data/spec/linter/rubocop_spec.rb

@@ -10,6 +10,9 @@ describe LintTrap::Linter::RuboCop do
   it_behaves_like 'linter'
 
   its(:languages){is_expected.to eq([LintTrap::Language::Ruby.new])}
+  its(:version){is_expected.to eq('0.31.0')}
+  its(:image){is_expected.to eq('lintci/rubocop')}
+  its(:image_version){is_expected.to eq('lintci/rubocop:0.31.0')}
 
   describe '#lint' do
     context 'when config is provided' do
@@ -26,7 +29,7 @@ describe LintTrap::Linter::RuboCop do
           ],
           files
         ).and_return(command)
-        expect(command).to receive(:run).with(container)
+        expect(command).to receive(:run).with(container).and_return(true)
 
         linter.lint(files, container, options)
       end
@@ -43,7 +46,7 @@ describe LintTrap::Linter::RuboCop do
           ],
           files
         ).and_return(command)
-        expect(command).to receive(:run).with(container)
+        expect(command).to receive(:run).with(container).and_return(true)
 
         linter.lint(files, container, options)
       end

data/spec/linter/scsslint_spec.rb

@@ -10,6 +10,9 @@ describe LintTrap::Linter::SCSSLint do
   it_behaves_like 'linter'
 
   its(:languages){is_expected.to eq([LintTrap::Language::SCSS.new])}
+  its(:version){is_expected.to eq('0.38.0')}
+  its(:image){is_expected.to eq('lintci/scsslint')}
+  its(:image_version){is_expected.to eq('lintci/scsslint:0.38.0')}
 
   describe '#lint' do
     context 'when config is provided' do
@@ -24,7 +27,7 @@ describe LintTrap::Linter::SCSSLint do
           ],
           files
         ).and_return(command)
-        expect(command).to receive(:run).with(container)
+        expect(command).to receive(:run).with(container).and_return(true)
 
         linter.lint(files, container, options)
       end
@@ -39,7 +42,7 @@ describe LintTrap::Linter::SCSSLint do
           ],
           files
         ).and_return(command)
-        expect(command).to receive(:run).with(container)
+        expect(command).to receive(:run).with(container).and_return(true)
 
         linter.lint(files, container, options)
       end

data/spec/linter/unknown_spec.rb

@@ -10,6 +10,9 @@ describe LintTrap::Linter::Unknown do
   it_behaves_like 'linter'
 
   its(:languages){is_expected.to eq([LintTrap::Language::Unknown.new])}
+  its(:version){is_expected.to eq(LintTrap::VERSION)}
+  its(:image){is_expected.to eq('lintci/unknown')}
+  its(:image_version){is_expected.to eq('lintci/unknown:' + LintTrap::VERSION)}
 
   describe '#lint' do
     it 'is a noop' do

data/spec/linter_spec.rb

@@ -1,8 +1,27 @@
 require 'spec_helper'
 
 describe LintTrap::Linter do
+  describe '.all' do
+    subject(:all_linters){described_class.all}
+
+    it do
+      is_expected.to match([
+        be_a(described_class::CheckStyle),
+        be_a(described_class::CoffeeLint),
+        be_a(described_class::CPPCheck),
+        be_a(described_class::CSSLint),
+        be_a(described_class::GoLint),
+        be_a(described_class::JSHint),
+        be_a(described_class::JSONLint),
+        be_a(described_class::PyLint),
+        be_a(described_class::RuboCop),
+        be_a(described_class::SCSSLint)
+      ])
+    end
+  end
+
   describe '.find' do
-    subject(:language){described_class.find(linter_name)}
+    subject(:linter){described_class.find(linter_name)}
 
     context 'when given CheckStyle' do
       let(:linter_name){'CheckStyle'}

data/spec/parser/base_spec.rb

@@ -0,0 +1,13 @@
+require 'spec_helper'
+
+describe LintTrap::Parser::Base do
+  let(:image){LintTrap::Linter::RuboCop.new.image_version}
+  let(:container){LintTrap::Container::Docker.new(image, fixture_path)}
+  subject(:parser){Class.new(described_class).new(StringIO.new, container)}
+
+  describe '#parse' do
+    it 'raises an error if not overriden' do
+      expect{parser.parse}.to raise_error(NotImplementedError, 'Must implement parse.')
+    end
+  end
+end

data/spec/parser/csslint_spec.rb

@@ -11,7 +11,7 @@ describe LintTrap::Parser::CSSLint do
 
   describe '.parse' do
     it 'parses violations from io' do
-      expect{|b| parser.parse(&b)}.to yield_successive_args(
+      expect{|b| @result = parser.parse(&b)}.to yield_successive_args(
         file: 'bad.css',
         line: '2',
         column: '5',
@@ -20,6 +20,8 @@ describe LintTrap::Parser::CSSLint do
         severity: 'Error',
         message: 'Using width with border can sometimes make elements larger than you expect.'
       )
+
+      expect(@result).to eq("\n")
     end
   end
 end

data/spec/parser/line_spec.rb

@@ -0,0 +1,13 @@
+require 'spec_helper'
+
+describe LintTrap::Parser::Line do
+  let(:image){LintTrap::Linter::RuboCop.new.image_version}
+  let(:container){LintTrap::Container::Docker.new(image, fixture_path)}
+  subject(:parser){Class.new(described_class).new(StringIO.new('violation'), container)}
+
+  describe '#parse' do
+    it 'raises an error if #violation_regex not overriden' do
+      expect{parser.parse}.to raise_error(NotImplementedError, 'Must implement violation_regex.')
+    end
+  end
+end

data/spec/parser/standard_spec.rb

@@ -2,7 +2,7 @@ require 'spec_helper'
 
 describe LintTrap::Parser::Standard do
   let(:parser_output) do
-    "bad.java:1:0::com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocTypeCheck:error:"\
+    'bad.java:1:0::com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocTypeCheck:error:'\
     "Missing a Javadoc comment.\n"\
     "bad.coffee:1:::camel_case_classes:error:Class names should be camel cased\n"\
     "bad.js:2:13::W030:warning:Expected an assignment or function call and instead saw an expression.\n"\
@@ -16,7 +16,7 @@ describe LintTrap::Parser::Standard do
 
   describe '.parse' do
     it 'parses violations from io' do
-      expect{|b| parser.parse(&b)}.to yield_successive_args(
+      expect{|b| @result = parser.parse(&b)}.to yield_successive_args(
         {
           file: 'bad.java',
           line: '1',
@@ -72,6 +72,8 @@ describe LintTrap::Parser::Standard do
           message: '`border: 0;` is preferred over `border: none;`'
         }
       )
+
+      expect(@result).to eq('')
     end
   end
 end

data/spec/parser/vim_quickfix_spec.rb

@@ -10,17 +10,17 @@ describe LintTrap::Parser::VimQuickfix do
 
   describe '#parse' do
     it 'parses violations from io' do
-      expect{|b| parser.parse(&b)}.to yield_successive_args(
-        {
-          file: 'bad.go',
-          line: '5',
-          column: '1',
-          length: nil,
-          rule: nil,
-          severity: nil,
-          message: 'exported function Main should have comment or be unexported'
-        }
+      expect{|b| @result = parser.parse(&b)}.to yield_successive_args(
+        file: 'bad.go',
+        line: '5',
+        column: '1',
+        length: nil,
+        rule: nil,
+        severity: nil,
+        message: 'exported function Main should have comment or be unexported'
       )
+
+      expect(@result).to eq('')
     end
   end
 end

data/spec/spec_helper.rb

@@ -1,8 +1,23 @@
 $LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+
+require 'simplecov'
+SimpleCov.start do
+  add_filter '/spec/'
+  add_filter '/config/'
+
+  add_group 'Containers', 'lib/lint_trap/container'
+  add_group 'Languages', 'lib/lint_trap/language'
+  add_group 'Linters', 'lib/lint_trap/linter'
+  add_group 'Parser', 'lib/lint_trap/parser'
+
+  coverage_dir ENV['CIRCLE_ARTIFACTS'] if ENV['CIRCLE_ARTIFACTS']
+end
+
 require 'rspec/its'
 require 'lint_trap'
 require 'pry'
 require_relative 'support/fixture_file_helper'
+require_relative 'support/dockerfile'
 require_relative 'support/examples/language'
 require_relative 'support/examples/linter'
 

data/spec/support/dockerfile.rb

@@ -0,0 +1,12 @@
+# Wraps a dockerfile to allow it to be easily tested
+class Dockerfile
+  attr_reader :path
+
+  def initialize(name)
+    @path = Pathname.new(File.expand_path("../../../docker/#{name.downcase}/Dockerfile", __FILE__))
+  end
+
+  def include_env?(name, value)
+    path.read =~ /ENV #{name} (#{value}|"#{value}")/
+  end
+end

data/spec/support/examples/language.rb

@@ -5,7 +5,7 @@ shared_examples_for 'language' do
     it 'returns a list of linters which reference this language' do
       language.linters.each do |linter|
         expect(linter.languages).to include(language),
-          "expected #{linter.name} to reference #{language.name} as one of it's languages"
+                                    "expected #{linter.name} to reference #{language.name} as one of it's languages"
       end
     end
   end