puppet-lint 2.2.1 → 2.3.0

data/lib/puppet-lint/plugins/check_strings/puppet_url_without_modules.rb

@@ -0,0 +1,25 @@
+# Public: Check the manifest tokens for any puppet:// URL strings where the
+# path section doesn't start with modules/ and record a warning for each
+# instance found.
+#
+# No style guide reference
+PuppetLint.new_check(:puppet_url_without_modules) do
+  def check
+    tokens.select { |token|
+      (token.type == :SSTRING || token.type == :STRING || token.type == :DQPRE) && token.value.start_with?('puppet://')
+    }.reject { |token|
+      token.value[/puppet:\/\/.*?\/(.+)/, 1].start_with?('modules/') unless token.value[/puppet:\/\/.*?\/(.+)/, 1].nil?
+    }.each do |token|
+      notify :warning, {
+        :message => 'puppet:// URL without modules/ found',
+        :line    => token.line,
+        :column  => token.column,
+        :token   => token,
+      }
+    end
+  end
+
+  def fix(problem)
+    problem[:token].value.gsub!(/(puppet:\/\/.*?\/)/, '\1modules/')
+  end
+end

data/lib/puppet-lint/plugins/check_strings/quoted_booleans.rb

@@ -0,0 +1,26 @@
+# Public: Check the manifest tokens for any double or single quoted strings
+# containing only a boolean value and record a warning for each instance
+# found.
+#
+# No style guide reference
+PuppetLint.new_check(:quoted_booleans) do
+  STRING_TYPES = Set[:STRING, :SSTRING]
+  BOOLEANS = Set['true', 'false']
+
+  def check
+    tokens.select { |r|
+      STRING_TYPES.include?(r.type) && BOOLEANS.include?(r.value)
+    }.each do |token|
+      notify :warning, {
+        :message => 'quoted boolean value found',
+        :line    => token.line,
+        :column  => token.column,
+        :token   => token,
+      }
+    end
+  end
+
+  def fix(problem)
+    problem[:token].type = problem[:token].value.upcase.to_sym
+  end
+end

data/lib/puppet-lint/plugins/check_strings/single_quote_string_with_variables.rb

@@ -0,0 +1,17 @@
+# Public: Check the manifest tokens for any single quoted strings containing
+# a enclosed variable and record an error for each instance found.
+#
+# https://docs.puppet.com/guides/style_guide.html#quoting
+PuppetLint.new_check(:single_quote_string_with_variables) do
+  def check
+    tokens.select { |r|
+      r.type == :SSTRING && r.value.include?('${') && (! r.prev_token.prev_token.value.match(%r{inline_(epp|template)}) )
+    }.each do |token|
+      notify :error, {
+        :message => 'single quoted string containing a variable found',
+        :line    => token.line,
+        :column  => token.column,
+      }
+    end
+  end
+end

data/lib/puppet-lint/plugins/check_strings/variables_not_enclosed.rb

@@ -0,0 +1,23 @@
+# Public: Check the manifest tokens for any variables in a string that have
+# not been enclosed by braces ({}) and record a warning for each instance
+# found.
+#
+# https://docs.puppet.com/guides/style_guide.html#quoting
+PuppetLint.new_check(:variables_not_enclosed) do
+  def check
+    tokens.select { |r|
+      r.type == :UNENC_VARIABLE
+    }.each do |token|
+      notify :warning, {
+        :message => 'variable not enclosed in {}',
+        :line    => token.line,
+        :column  => token.column,
+        :token   => token,
+      }
+    end
+  end
+
+  def fix(problem)
+    problem[:token].type = :VARIABLE
+  end
+end

data/lib/puppet-lint/plugins/check_variables/variable_contains_dash.rb

@@ -0,0 +1,21 @@
+# Public: Test the manifest tokens for variables that contain a dash and
+# record a warning for each instance found.
+#
+# No style guide reference
+PuppetLint.new_check(:variable_contains_dash) do
+  VARIABLE_DASH_TYPES = Set[:VARIABLE, :UNENC_VARIABLE]
+
+  def check
+    tokens.select { |r|
+      VARIABLE_DASH_TYPES.include? r.type
+    }.each do |token|
+      if token.value.gsub(/\[.+?\]/, '').match(/-/)
+        notify :warning, {
+          :message => 'variable contains a dash',
+          :line    => token.line,
+          :column  => token.column,
+        }
+      end
+    end
+  end
+end

data/lib/puppet-lint/plugins/{check_variables.rb → check_variables/variable_is_lowercase.rb}

@@ -1,25 +1,3 @@
-# Public: Test the manifest tokens for variables that contain a dash and
-# record a warning for each instance found.
-#
-# No style guide reference
-PuppetLint.new_check(:variable_contains_dash) do
-  VARIABLE_DASH_TYPES = Set[:VARIABLE, :UNENC_VARIABLE]
-
-  def check
-    tokens.select { |r|
-      VARIABLE_DASH_TYPES.include? r.type
-    }.each do |token|
-      if token.value.gsub(/\[.+?\]/, '').match(/-/)
-        notify :warning, {
-          :message => 'variable contains a dash',
-          :line    => token.line,
-          :column  => token.column,
-        }
-      end
-    end
-  end
-end
-
 # Public: Test the manifest tokens for variables that contain an uppercase
 # letter and record a warning for each instance found.
 #

data/lib/puppet-lint/plugins/check_whitespace/140chars.rb

@@ -0,0 +1,21 @@
+# Public: Test the raw manifest string for lines containing more than 140
+# characters and record a warning for each instance found.  The only exceptions
+# to this rule are lines containing URLs and template() calls which would hurt
+# readability if split.
+#
+# https://docs.puppet.com/guides/style_guide.html#spacing-indentation-and-whitespace
+PuppetLint.new_check(:'140chars') do
+  def check
+    manifest_lines.each_with_index do |line, idx|
+      unless line =~ /:\/\// || line =~ /template\(/
+        if line.scan(/./mu).size > 140
+          notify :warning, {
+            :message => 'line has more than 140 characters',
+            :line    => idx + 1,
+            :column  => 140,
+          }
+        end
+      end
+    end
+  end
+end

data/lib/puppet-lint/plugins/check_whitespace/2sp_soft_tabs.rb

@@ -0,0 +1,19 @@
+# Public: Check the manifest tokens for any indentation not using 2 space soft
+# tabs and record an error for each instance found.
+#
+# https://docs.puppet.com/guides/style_guide.html#spacing-indentation-and-whitespace
+PuppetLint.new_check(:'2sp_soft_tabs') do
+  def check
+    tokens.select { |r|
+      r.type == :INDENT
+    }.reject { |r|
+      r.value.length % 2 == 0
+    }.each do |token|
+      notify :error, {
+        :message => 'two-space soft tabs not used',
+        :line    => token.line,
+        :column  => token.column,
+      }
+    end
+  end
+end

data/lib/puppet-lint/plugins/check_whitespace/80chars.rb

@@ -0,0 +1,21 @@
+# Public: Test the raw manifest string for lines containing more than 80
+# characters. This is DISABLED by default and behaves like the default
+# 140chars check by excepting URLs and template() calls.
+#
+# https://docs.puppet.com/guides/style_guide.html#spacing-indentation-and-whitespace (older version)
+PuppetLint.new_check(:'80chars') do
+  def check
+    manifest_lines.each_with_index do |line, idx|
+      unless line =~ /:\/\// || line =~ /template\(/
+        if line.scan(/./mu).size > 80
+          notify :warning, {
+            :message => 'line has more than 80 characters',
+            :line    => idx + 1,
+            :column  => 80,
+          }
+        end
+      end
+    end
+  end
+end
+PuppetLint.configuration.send("disable_80chars")

data/lib/puppet-lint/plugins/{check_whitespace.rb → check_whitespace/arrow_alignment.rb}

@@ -1,121 +1,3 @@
-# Public: Check the raw manifest string for lines containing hard tab
-# characters and record an error for each instance found.
-#
-# https://docs.puppet.com/guides/style_guide.html#spacing-indentation-and-whitespace
-PuppetLint.new_check(:hard_tabs) do
-  WHITESPACE_TYPES = Set[:INDENT, :WHITESPACE]
-
-  def check
-    tokens.select { |r|
-      WHITESPACE_TYPES.include?(r.type) && r.value.include?("\t")
-    }.each do |token|
-      notify :error, {
-        :message => 'tab character found',
-        :line    => token.line,
-        :column  => token.column,
-        :token   => token,
-      }
-    end
-  end
-
-  def fix(problem)
-    problem[:token].value.gsub!("\t", '  ')
-  end
-end
-
-# Public: Check the manifest tokens for lines ending with whitespace and record
-# an error for each instance found.
-#
-# https://docs.puppet.com/guides/style_guide.html#spacing-indentation-and-whitespace
-PuppetLint.new_check(:trailing_whitespace) do
-  def check
-    tokens.select { |token|
-      [:WHITESPACE, :INDENT].include?(token.type)
-    }.select { |token|
-      token.next_token.nil? || token.next_token.type == :NEWLINE
-    }.each do |token|
-      notify :error, {
-        :message => 'trailing whitespace found',
-        :line    => token.line,
-        :column  => token.column,
-        :token   => token,
-      }
-    end
-  end
-
-  def fix(problem)
-    prev_token = problem[:token].prev_token
-    next_token = problem[:token].next_token
-    prev_token.next_token = next_token
-    next_token.prev_token = prev_token unless next_token.nil?
-    tokens.delete(problem[:token])
-  end
-end
-
-# Public: Test the raw manifest string for lines containing more than 140
-# characters and record a warning for each instance found.  The only exceptions
-# to this rule are lines containing URLs and template() calls which would hurt
-# readability if split.
-#
-# https://docs.puppet.com/guides/style_guide.html#spacing-indentation-and-whitespace
-PuppetLint.new_check(:'140chars') do
-  def check
-    manifest_lines.each_with_index do |line, idx|
-      unless line =~ /:\/\// || line =~ /template\(/
-        if line.scan(/./mu).size > 140
-          notify :warning, {
-            :message => 'line has more than 140 characters',
-            :line    => idx + 1,
-            :column  => 140,
-          }
-        end
-      end
-    end
-  end
-end
-
-# Public: Test the raw manifest string for lines containing more than 80
-# characters. This is DISABLED by default and behaves like the default
-# 140chars check by excepting URLs and template() calls.
-#
-# https://docs.puppet.com/guides/style_guide.html#spacing-indentation-and-whitespace (older version)
-PuppetLint.new_check(:'80chars') do
-  def check
-    manifest_lines.each_with_index do |line, idx|
-      unless line =~ /:\/\// || line =~ /template\(/
-        if line.scan(/./mu).size > 80
-          notify :warning, {
-            :message => 'line has more than 80 characters',
-            :line    => idx + 1,
-            :column  => 80,
-          }
-        end
-      end
-    end
-  end
-end
-PuppetLint.configuration.send("disable_80chars")
-
-# Public: Check the manifest tokens for any indentation not using 2 space soft
-# tabs and record an error for each instance found.
-#
-# https://docs.puppet.com/guides/style_guide.html#spacing-indentation-and-whitespace
-PuppetLint.new_check(:'2sp_soft_tabs') do
-  def check
-    tokens.select { |r|
-      r.type == :INDENT
-    }.reject { |r|
-      r.value.length % 2 == 0
-    }.each do |token|
-      notify :error, {
-        :message => 'two-space soft tabs not used',
-        :line    => token.line,
-        :column  => token.column,
-      }
-    end
-  end
-end
-
 # Public: Check the manifest tokens for any arrows (=>) in a grouping ({}) that
 # are not aligned with other arrows in that grouping.
 #

data/lib/puppet-lint/plugins/check_whitespace/hard_tabs.rb

@@ -0,0 +1,24 @@
+# Public: Check the raw manifest string for lines containing hard tab
+# characters and record an error for each instance found.
+#
+# https://docs.puppet.com/guides/style_guide.html#spacing-indentation-and-whitespace
+PuppetLint.new_check(:hard_tabs) do
+  WHITESPACE_TYPES = Set[:INDENT, :WHITESPACE]
+
+  def check
+    tokens.select { |r|
+      WHITESPACE_TYPES.include?(r.type) && r.value.include?("\t")
+    }.each do |token|
+      notify :error, {
+        :message => 'tab character found',
+        :line    => token.line,
+        :column  => token.column,
+        :token   => token,
+      }
+    end
+  end
+
+  def fix(problem)
+    problem[:token].value.gsub!("\t", '  ')
+  end
+end

data/lib/puppet-lint/plugins/check_whitespace/trailing_whitespace.rb

@@ -0,0 +1,28 @@
+# Public: Check the manifest tokens for lines ending with whitespace and record
+# an error for each instance found.
+#
+# https://docs.puppet.com/guides/style_guide.html#spacing-indentation-and-whitespace
+PuppetLint.new_check(:trailing_whitespace) do
+  def check
+    tokens.select { |token|
+      [:WHITESPACE, :INDENT].include?(token.type)
+    }.select { |token|
+      token.next_token.nil? || token.next_token.type == :NEWLINE
+    }.each do |token|
+      notify :error, {
+        :message => 'trailing whitespace found',
+        :line    => token.line,
+        :column  => token.column,
+        :token   => token,
+      }
+    end
+  end
+
+  def fix(problem)
+    prev_token = problem[:token].prev_token
+    next_token = problem[:token].next_token
+    prev_token.next_token = next_token
+    next_token.prev_token = prev_token unless next_token.nil?
+    tokens.delete(problem[:token])
+  end
+end

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

@@ -68,6 +68,10 @@ class PuppetLint
           @ignore_paths = PuppetLint.configuration.ignore_paths
         end
 
+        if PuppetLint.configuration.pattern
+          @pattern = PuppetLint.configuration.pattern
+        end
+
         RakeFileUtils.send(:verbose, true) do
           linter = PuppetLint.new
           matched_files = FileList[@pattern]

data/lib/puppet-lint/version.rb

@@ -1,3 +1,3 @@
 class PuppetLint
-  VERSION = '2.2.1'
+  VERSION = '2.3.0'
 end

data/spec/puppet-lint/bin_spec.rb

@@ -272,7 +272,24 @@ describe PuppetLint::Bin do
     its(:exitstatus) { is_expected.to eq(0) }
     its(:stdout) do
       if respond_to?(:include_json)
-        is_expected.to include_json([{'KIND' => 'WARNING'}])
+        is_expected.to include_json([[{'KIND' => 'WARNING'}]])
+      else
+        is_expected.to match(/\[\n  \{/)
+      end
+    end
+  end
+
+  context 'when displaying results for multiple targets as json' do
+
+    let(:args) { [
+      '--json',
+      'spec/fixtures/test/manifests/fail.pp',
+      'spec/fixtures/test/manifests/warning.pp',
+    ] }
+    its(:exitstatus) { is_expected.to eq(1) }
+    its(:stdout) do
+      if respond_to?(:include_json)
+        is_expected.to include_json([[{'KIND' => 'ERROR'}],[{'KIND' => 'WARNING'}]])
       else
         is_expected.to match(/\[\n  \{/)
       end

data/spec/puppet-lint/lexer_spec.rb

@@ -546,6 +546,25 @@ describe PuppetLint::Lexer do
       expect(token.type).to eq(:FARROW)
       expect(token.column).to eq(12)
     end
+
+    it 'should calculate the column number correctly after an enclosed variable starting with a string' do
+      token = @lexer.tokenise('  "bar${foo}" =>').last
+      expect(token.type).to eq(:FARROW)
+      expect(token.column).to eq(15)
+    end
+
+    it 'should calculate the column number correctly after an enclosed variable ending with a string' do
+      token = @lexer.tokenise('  "${foo}bar" =>').last
+      expect(token.type).to eq(:FARROW)
+      expect(token.column).to eq(15)
+    end
+
+    it 'should calculate the column number correctly after an enclosed variable surround by a string' do
+      token = @lexer.tokenise('  "foo${bar}baz" =>').last
+      expect(token.type).to eq(:FARROW)
+      expect(token.column).to eq(18)
+    end
+
   end
 
   [