Merge pull request #129 from glennsarti/fix-puppet-lint

(GH-125) Honor inline puppet lint directives

Author: jpogran

server/lib/puppet-languageserver/document_validator.rb

@@ -31,20 +31,26 @@ def self.validate(content, workspace, _max_problems = 100)
 
       # Find module root and attempt to build PuppetLint options
       module_root = find_module_root_from_path(workspace)
+      linter_options = nil
       if module_root.nil?
-        PuppetLint::OptParser.build
+        linter_options = PuppetLint::OptParser.build
       else
-        Dir.chdir(module_root.to_s) { PuppetLint::OptParser.build }
+        Dir.chdir(module_root.to_s) { linter_options = PuppetLint::OptParser.build }
       end
+      linter_options.parse!([])
 
       begin
         linter = PuppetLint::Checks.new
+        linter.load_data(nil, content)
+
         problems = linter.run(nil, content)
         unless problems.nil?
           problems.each do |problem|
             # Syntax errors are better handled by the puppet parser, not puppet lint
             next if problem[:kind] == :error && problem[:check] == :syntax
-
+            # Ignore linting errors what were ignored by puppet-lint
+            next if problem[:kind] == :ignored
+            
             severity = case problem[:kind]
                        when :error
                          LanguageServer::DIAGNOSTICSEVERITY_ERROR

server/spec/integration/puppet-languageserver/document_validator_spec.rb

@@ -21,5 +21,57 @@
       end
     end
 
+    describe "Given a complete manifest with a single linting error" do
+      let(:manifest) { "
+        user { 'Bob':
+          ensure  => 'present',
+          comment => '123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890',
+        }"
+      }
+
+      it "should return an array with one entry" do
+        expect(subject.validate(manifest, nil).count).to eq(1)
+      end
+
+      it "should return an entry with linting error information" do
+        lint_error = subject.validate(manifest, nil)[0]
+
+        expect(lint_error['source']).to eq('Puppet')
+        expect(lint_error['message']).to match('140')
+        expect(lint_error['range']).to_not be_nil
+        expect(lint_error['code']).to_not be_nil
+        expect(lint_error['severity']).to_not be_nil
+      end
+
+      context "but disabled" do
+        context "on a single line" do
+          let(:manifest) { "
+            user { 'Bob':
+              ensure  => 'present',
+              comment => '123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890'   # lint:ignore:140chars
+            }"
+          }
+
+          it "should return an empty array" do
+            expect(subject.validate(manifest, nil)).to eq([])
+          end
+        end
+
+        context "in a linting block" do
+          let(:manifest) { "
+            user { 'Bob':
+              ensure  => 'present',
+              # lint:ignore:140chars
+              comment => '123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890',
+              # lint:endignore
+            }"
+          }
+
+          it "should return an empty array" do
+            expect(subject.validate(manifest, nil)).to eq([])
+          end
+        end
+      end
+    end
   end
 end