puppet-lint 2.4.0 → 2.5.2

data/spec/puppet-lint/lexer_spec.rb

@@ -253,6 +253,47 @@ describe PuppetLint::Lexer do # rubocop:disable Metrics/BlockLength
       end
     end
 
+    context 'treats a variable named the same as the keyword as a variable' do
+      PuppetLint::Lexer::KEYWORDS.keys.each do |keyword|
+        context "for '#{keyword}'" do
+          let(:segments) do
+            [
+              [:STRING, ''],
+              [:INTERP, keyword],
+              [:STRING, ''],
+            ]
+          end
+
+          it 'creates a tokenised string' do
+            expect(tokens).to have(3).tokens
+
+            expect(tokens[0]).to have_attributes(
+              :type   => :DQPRE,
+              :value  => '',
+              :line   => 1,
+              :column => 1
+            )
+            expect(tokens[1]).to have_attributes(
+              :type   => :VARIABLE,
+              :value  => keyword,
+              :line   => 1,
+              :column => 4
+            )
+            expect(tokens[2]).to have_attributes(
+              :type   => :DQPOST,
+              :value  => '',
+              :line   => 1,
+              :column => keyword.size + 4
+            )
+          end
+
+          it 'can render the result back into a manifest' do
+            expect(manifest).to eq("\"${#{keyword}}\"")
+          end
+        end
+      end
+    end
+
     context 'an interpolated variable with an unnecessary $' do
       let(:segments) do
         [
@@ -1590,6 +1631,21 @@ END
       expect(tokens[6].type).to eq(:HEREDOC)
       expect(tokens[6].value).to eq("  foo\n  ")
     end
+
+    it 'should handle a heredoc with no indentation' do
+      manifest = <<-END.gsub(%r{^ {6}}, '')
+      $str = @(EOT)
+      something
+      EOT
+      END
+      tokens = @lexer.tokenise(manifest)
+
+      expect(tokens.length).to eq(8)
+      expect(tokens[4].type).to eq(:HEREDOC_OPEN)
+      expect(tokens[4].value).to eq('EOT')
+      expect(tokens[6].type).to eq(:HEREDOC)
+      expect(tokens[6].value).to eq('something')
+    end
   end
 
   context ':HEREDOC with interpolation' do

data/spec/puppet-lint/plugins/check_classes/parameter_order_spec.rb

@@ -147,5 +147,23 @@ describe 'parameter_order' do
 
       it { expect(problems).to have(0).problems }
     end
+
+    context "#{type} parameter with array operation" do
+      let(:code) do
+        <<-END
+          #{type} ntp (
+            # XXX: remove self from list
+            Array[String] $ntp_servers = [
+              'foo',
+              'bar',
+              'baz',
+            ] - $::fqdn,
+            Array[String] $pools       = [],
+          ) { }
+        END
+      end
+
+      it { expect(problems).to have(0).problems }
+    end
   end
 end

data/spec/puppet-lint/plugins/check_classes/variable_scope_spec.rb

@@ -316,4 +316,18 @@ describe 'variable_scope' do
       expect(problems).to contain_warning(msg).on_line(2).in_column(14)
     end
   end
+
+  context 'assigning regex with multiple alternations to variable' do
+    let(:code) do
+      <<-END
+        class gh::issue859 {
+          $regex = /5|6|7/
+        }
+      END
+    end
+
+    it 'should not detect any problems' do
+      expect(problems).to have(0).problems
+    end
+  end
 end

data/spec/puppet-lint/plugins/check_documentation/documentation_spec.rb

@@ -29,6 +29,24 @@ describe 'documentation' do
     end
   end
 
+  describe 'incorrectly documented class' do
+    let(:code) do
+      <<-END
+        # foo
+
+        class test {}
+      END
+    end
+
+    it 'should only detect a single problem' do
+      expect(problems).to have(1).problem
+    end
+
+    it 'should create a warning' do
+      expect(problems).to contain_warning(class_msg).on_line(3).in_column(9)
+    end
+  end
+
   describe 'undocumented defined type' do
     let(:code) { 'define test {}' }
 

data/spec/puppet-lint/plugins/check_strings/double_quoted_strings_spec.rb

@@ -93,16 +93,17 @@ describe 'double_quoted_strings' do
       end
     end
 
-    context 'double quoted stings containing supported escape patterns' do
+    context 'double quoted strings containing supported escape patterns' do
       let(:code) do
         <<-END
-          $string1 = "this string contins \n newline"
-          $string2 = "this string contains \ttab"
+          $string1 = "this string contains \n newline"
+          $string2 = "this string contains \t tab"
           $string3 = "this string contains \${escaped} var"
           $string4 = "this string contains \\"escaped \\" double quotes"
           $string5 = "this string contains \\'escaped \\' single quotes"
-          $string6 = "this string contains \r line return"
+          $string6 = "this string contains \r carriage return"
           $string7 = "this string contains \\\\ an escaped backslash"
+          $string8 = "this string contains \\s"
         END
       end
 
@@ -112,7 +113,7 @@ describe 'double_quoted_strings' do
     end
 
     context 'double quoted string with random escape should be rejected' do
-      let(:code) { %( $ztring = "this string contains \l random esape" ) }
+      let(:code) { %( $ztring = "this string contains \l random escape" ) }
 
       it 'should only detect a single problem' do
         expect(problems).to have(1).problem

data/spec/puppet-lint/plugins/check_variables/variable_is_lowercase_spec.rb

@@ -22,4 +22,32 @@ describe 'variable_is_lowercase' do
       expect(problems).to have(0).problems
     end
   end
+
+  context 'when typecasting inside an interpolation' do
+    let(:code) { %("${Integer(fact('memory.system.total_bytes'))}") }
+
+    it 'should not detect any problems' do
+      expect(problems).to have(0).problems
+    end
+  end
+
+  context 'when an interpolated variable contains an uppercase letter' do
+    let(:code) { '"${fooBar}"' }
+
+    it 'should only detect a single problem' do
+      expect(problems).to have(1).problem
+    end
+
+    it 'should create a warning' do
+      expect(problems).to contain_warning(msg).on_line(1).in_column(4)
+    end
+  end
+
+  context 'when an interpolated variable only contains lowercase letters' do
+    let(:code) { '"${foobar}"' }
+
+    it 'should not detect any problems' do
+      expect(problems).to have(0).problems
+    end
+  end
 end

data/spec/spec_helper.rb

@@ -1,8 +1,10 @@
-require 'simplecov'
-SimpleCov.start do
-  add_filter('/spec/')
-  add_filter('/vendor/')
-  add_group('Checks', 'lib/puppet-lint/plugins')
+if ENV['COVERAGE'] == 'yes' && RUBY_VERSION.start_with?('2.6.')
+  require 'simplecov'
+  SimpleCov.start do
+    add_filter('/spec/')
+    add_filter('/vendor/')
+    add_group('Checks', 'lib/puppet-lint/plugins')
+  end
 end
 
 require 'puppet-lint'

metadata

@@ -1,35 +1,32 @@
 --- !ruby/object:Gem::Specification
 name: puppet-lint
 version: !ruby/object:Gem::Version
-  version: 2.4.0
+  version: 2.5.2
 platform: ruby
 authors:
 - Tim Sharpe
-autorequire: 
+- Puppet, Inc.
+- Community Contributors
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2019-10-08 00:00:00.000000000 Z
+date: 2021-09-14 00:00:00.000000000 Z
 dependencies: []
 description: |-
   Checks your Puppet manifests against the Puppetlabs
     style guide and alerts you to any discrepancies.
-email: tim@sharpe.id.au
+email:
+- tim@sharpe.id.au
+- modules-team@puppet.com
 executables:
 - puppet-lint
 extensions: []
 extra_rdoc_files: []
 files:
-- ".gitignore"
-- ".rspec"
-- ".rubocop.yml"
-- ".rubocop_todo.yml"
-- ".travis.yml"
 - CHANGELOG.md
-- Gemfile
+- HISTORY.md
 - LICENSE
 - README.md
-- Rakefile
-- appveyor.yml
 - bin/puppet-lint
 - lib/puppet-lint.rb
 - lib/puppet-lint/bin.rb
@@ -84,7 +81,6 @@ files:
 - lib/puppet-lint/tasks/puppet-lint.rb
 - lib/puppet-lint/tasks/release_test.rb
 - lib/puppet-lint/version.rb
-- puppet-lint.gemspec
 - spec/fixtures/test/manifests/fail.pp
 - spec/fixtures/test/manifests/ignore.pp
 - spec/fixtures/test/manifests/ignore_multiple_block.pp
@@ -144,10 +140,11 @@ files:
 - spec/puppet-lint/plugins/check_whitespace/trailing_whitespace_spec.rb
 - spec/puppet-lint_spec.rb
 - spec/spec_helper.rb
-homepage: https://github.com/rodjek/puppet-lint/
-licenses: []
+homepage: https://github.com/puppetlabs/puppet-lint/
+licenses:
+- MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -162,8 +159,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.6
-signing_key: 
+rubyforge_project:
+rubygems_version: 2.7.6.3
+signing_key:
 specification_version: 4
 summary: Ensure your Puppet manifests conform with the Puppetlabs style guide
 test_files:

data/.gitignore

@@ -1,12 +0,0 @@
-*.gem
-.bundle/
-.rbenv-version
-.ruby-version
-Gemfile.lock
-vendor/
-coverage/
-*.swp
-/_site/
-.idea
-/*.pp
-/tmp/

data/.rspec

@@ -1,2 +0,0 @@
---format documentation
---color

data/.rubocop.yml

@@ -1,74 +0,0 @@
----
-inherit_from: './.rubocop_todo.yml'
-AllCops:
-    TargetRubyVersion: 1.9
-
-Style/HashSyntax:
-    EnforcedStyle: hash_rockets
-
-Layout/FirstArrayElementLineBreak:
-    Enabled: true
-Layout/FirstHashElementLineBreak:
-    Enabled: true
-Layout/FirstMethodArgumentLineBreak:
-    Enabled: true
-Layout/FirstMethodParameterLineBreak:
-    Enabled: true
-Layout/IndentArray:
-    EnforcedStyle: consistent
-Layout/MultilineArrayBraceLayout:
-    EnforcedStyle: new_line
-Layout/MultilineAssignmentLayout:
-    Enabled: true
-    EnforcedStyle: same_line
-Layout/MultilineHashBraceLayout:
-    EnforcedStyle: new_line
-Layout/MultilineMethodDefinitionBraceLayout:
-    EnforcedStyle: new_line
-
-Style/AutoResourceCleanup:
-    Enabled: true
-Style/BlockDelimiters:
-    EnforcedStyle: braces_for_chaining
-Style/BracesAroundHashParameters:
-    EnforcedStyle: context_dependent
-Style/Encoding:
-    Enabled: false
-Style/MethodCallWithArgsParentheses:
-    Enabled: true
-    IgnoreMacros: true
-    IgnoredMethods:
-        - puts
-        - require
-        - include
-        - it
-        - context
-        - describe
-        - to
-        - to_not
-        - raise
-        - desc
-        - task
-        - exit
-        - should
-        - gem
-        - group
-        - attr_reader
-        - attr_accessor
-        - attr_writer
-        - source
-Style/MethodCalledOnDoEndBlock:
-    Enabled: true
-Style/RegexpLiteral:
-    EnforcedStyle: percent_r
-Style/TrailingCommaInArguments:
-    EnforcedStyleForMultiline: no_comma
-Style/TrailingCommaInLiteral:
-    EnforcedStyleForMultiline: comma
-Style/FormatStringToken:
-    Enabled: false
-Style/FileName:
-    Exclude:
-        - 'lib/puppet-lint.rb'
-        - 'lib/puppet-lint/tasks/puppet-lint.rb'
-        - 'spec/puppet-lint_spec.rb'

data/.rubocop_todo.yml

@@ -1,89 +0,0 @@
-# This configuration was generated by
-# `rubocop --auto-gen-config`
-# on 2017-08-28 12:57:58 +1000 using RuboCop version 0.49.1.
-# The point is for the user to remove these configuration records
-# one by one as the offenses are removed from the code base.
-# Note that changes in the inspected code, or installation of new
-# versions of RuboCop, may require this file to be generated again.
-
-# Offense count: 3
-# Configuration parameters: Include.
-# Include: **/Gemfile, **/gems.rb
-Bundler/DuplicatedGem:
-  Exclude:
-    - 'Gemfile'
-
-# Offense count: 2
-# Cop supports --auto-correct.
-# Configuration parameters: Include, TreatCommentsAsGroupSeparators.
-# Include: **/Gemfile, **/gems.rb
-Bundler/OrderedGems:
-  Exclude:
-    - 'Gemfile'
-
-# Offense count: 9
-# Configuration parameters: AllowSafeAssignment.
-Lint/AssignmentInCondition:
-  Exclude:
-    - 'lib/puppet-lint/lexer.rb'
-    - 'lib/puppet-lint/plugins/check_classes/variable_scope.rb'
-
-# Offense count: 52
-Metrics/AbcSize:
-  Max: 153
-
-# Offense count: 121
-# Configuration parameters: CountComments, ExcludedMethods.
-Metrics/BlockLength:
-  Max: 1136
-
-# Offense count: 8
-# Configuration parameters: CountBlocks.
-Metrics/BlockNesting:
-  Max: 5
-
-# Offense count: 2
-# Configuration parameters: CountComments.
-Metrics/ClassLength:
-  Max: 384
-
-# Offense count: 20
-Metrics/CyclomaticComplexity:
-  Max: 26
-
-# Offense count: 238
-# Configuration parameters: AllowHeredoc, AllowURI, URISchemes, IgnoreCopDirectives, IgnoredPatterns.
-# URISchemes: http, https
-Metrics/LineLength:
-  Max: 223
-
-# Offense count: 65
-# Configuration parameters: CountComments.
-Metrics/MethodLength:
-  Max: 105
-
-# Offense count: 18
-Metrics/PerceivedComplexity:
-  Max: 28
-
-# Offense count: 1
-# Cop supports --auto-correct.
-Performance/RedundantBlockCall:
-  Exclude:
-    - 'lib/puppet-lint/tasks/puppet-lint.rb'
-
-# Offense count: 7
-# Configuration parameters: EnforcedStyle, SupportedStyles.
-# SupportedStyles: nested, compact
-Style/ClassAndModuleChildren:
-  Exclude:
-    - 'lib/puppet-lint.rb'
-    - 'lib/puppet-lint/bin.rb'
-    - 'lib/puppet-lint/checkplugin.rb'
-    - 'lib/puppet-lint/checks.rb'
-    - 'lib/puppet-lint/data.rb'
-    - 'lib/puppet-lint/optparser.rb'
-
-# Offense count: 20
-Style/MultilineBlockChain:
-  Enabled: false