puppet-lint-check_unsafe_interpolations 0.0.1 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b2b3947d9ad43f6c66444615c2b99e36c2424d6a16af5fccb3d10281af284c07
-  data.tar.gz: 85c6f142a583957f1c02886810b021a46945e8a06fb7787667d108748f30f5b5
+  metadata.gz: 1e90440a4433f82202315ae44353245ca75123974ba549af84cd46d47bc9b1b3
+  data.tar.gz: 29e8dbe2d2e16fe3593dcc3ec4f1b7ef2d87b0d88df7b626086001e93562aeca
 SHA512:
-  metadata.gz: fb54a1464f86518214e7abf90ccdfc38b83dca687ba97f281fd51f476463918d44b69be8b35c6b5da7108184228422c77c0872496df6f691568458475b8b21f5
-  data.tar.gz: d19f8aa3e6b931b1a6240876335a04bb48a56a8b6124446d52887e51dac239afc75111e8f3c3eb1697be69a545042cf7fa2c50c63b5a4047fdd522c295d9fb6f
+  metadata.gz: 3e01934881a975c45ca0b2e874694fe8fa7dcde5c5ef83e67bce31fba3f27b630a35a9790ab380c6915790f22ae95d313d967bc6e7efbbe17047d1b6d0fa3adc
+  data.tar.gz: 8acb71fac65eaa6389e70f821ef3c5eda2477c1de8265815ad9f703b7edfc506dce5ebcb5ff959e8c0494d8f3eb98d6e93c77ba1227574364ed94738fb346a38

data/lib/puppet-lint/plugins/check_unsafe_interpolations.rb

@@ -1,6 +1,7 @@
 PuppetLint.new_check(:check_unsafe_interpolations) do
   COMMANDS = Array['command', 'onlyif', 'unless']
   INTERPOLATED_STRINGS = Array[:DQPRE, :DQMID]
+  USELESS_CHARS = Array[:WHITESPACE, :COMMA]
   def check
     # Gather any exec commands' resources into an array
     exec_resources = resource_indexes.map { |resource|
@@ -8,14 +9,9 @@ PuppetLint.new_check(:check_unsafe_interpolations) do
       resource if resource[:type].value == 'exec' && !(COMMANDS & resource_parameters).empty?
     }.compact
 
-    # Filter the list of titles returned by get_title_tokens for those contained in an exec
-    exec_title_tokens = get_title_tokens.select { |title|
-      title if title[:resource_type].value == 'exec'
-    }.compact
-
     # Iterate over title tokens and raise a warning if any are variables
-    unless exec_title_tokens.empty?
-      exec_title_tokens.each do |title|
+    unless get_exec_titles.empty?
+      get_exec_titles.each do |title|
         check_unsafe_title(title)
       end
     end
@@ -28,7 +24,7 @@ PuppetLint.new_check(:check_unsafe_interpolations) do
 
   # Iterate over the tokens in a title and raise a warning if an interpolated variable is found
   def check_unsafe_title(title)
-    title[:tokens].each do |token|
+    title.each do |token|
       notify_warning(token.next_code_token) if interpolated?(token)
     end
   end
@@ -83,43 +79,36 @@ PuppetLint.new_check(:check_unsafe_interpolations) do
 
   # This function is a replacement for puppet_lint's title_tokens function which assumes titles have single quotes
   # This function adds a check for titles in double quotes where there could be interpolated variables
-  def get_title_tokens
+  def get_exec_titles
     result = []
     tokens.each_index do |token_idx|
-      next unless tokens[token_idx].type == :COLON
+      next unless ['exec'].include?(tokens[token_idx].value)
+      # We have a resource declaration. Now find the title
       tokens_array = []
       # Check if title is an array
-      if tokens[token_idx - 1].type == :RBRACK
-        array_start_idx = tokens.rindex do |r|
-          r.type == :LBRACK
-        end
-        title_array_tokens = tokens[(array_start_idx + 1)..(token_idx - 2)]
-        tokens_array.concat(title_array_tokens.select do |token|
-          { STRING: true, NAME: true }.include?(token.type)
+      if tokens[token_idx].next_code_token.next_code_token.type == :LBRACK
+        # Get the start and end indices of the array of titles
+        array_start_idx = tokens.rindex { |r| r.type == :LBRACK }
+        array_end_idx = tokens.rindex { |r| r.type == :RBRACK }
+
+        # Grab everything within the array
+        title_array_tokens = tokens[(array_start_idx + 1)..(array_end_idx - 1)]
+        tokens_array.concat(title_array_tokens.reject do |token|
+          USELESS_CHARS.include?(token.type)
         end)
-        result << {
-          tokens: tokens_array,
-          resource_type: tokens[array_start_idx].prev_code_token.prev_code_token
-        }
+        result << tokens_array
       # Check if title is double quotes string
-      elsif tokens[token_idx - 1].type == :DQPOST
-        # Find index of the start of the title
-        title_start_idx = tokens.rindex do |r|
-          r.type == :DQPRE
-        end
-        result << {
-          # Title is tokens from :DQPRE to the index before :COLON
-          tokens: tokens[title_start_idx..(token_idx - 1)],
-          resource_type: tokens[title_start_idx].prev_code_token.prev_code_token
-        }
+      elsif tokens[token_idx].next_code_token.next_code_token.type == :DQPRE
+        # Find the start and end of the title
+        title_start_idx = tokens.rindex { |r| r.type == :DQPRE }
+        title_end_idx = tokens.rindex { |r| r.type == :DQPOST }
+
+        result << tokens[title_start_idx..title_end_idx]
       # Title is in single quotes
       else
-        next_token = tokens[token_idx].next_code_token
-        tokens_array.concat([tokens[token_idx - 1]]) unless next_token.type == :LBRACE
-        result << {
-          tokens: tokens_array,
-          resource_type: tokens[token_idx - 1].prev_code_token.prev_code_token
-        }
+        tokens_array.concat([tokens[token_idx].next_code_token.next_code_token])
+
+        result << tokens_array
       end
     end
     result

data/lib/puppet-lint/plugins/version.rb

@@ -1,4 +1,4 @@
 # version of this gem
 class CheckUnsafeInterpolations
-  VERSION ||= '0.0.1'.freeze
+  VERSION ||= '0.0.3'.freeze
 end

data/spec/puppet-lint/plugins/check_unsafe_interpolations_spec.rb

@@ -160,5 +160,27 @@ describe 'check_unsafe_interpolations' do
         expect(problems).to have(1).problems
       end
     end
+
+    context 'case statement and an exec' do
+      let(:code) do
+        <<-PUPPET
+        class foo {
+          case bar {
+            baz : {
+              echo qux
+            }
+          }
+
+          exec { 'foo':
+            command => "echo bar",
+          }
+        }
+        PUPPET
+      end
+
+      it 'detects zero problems' do
+        expect(problems).to have(0).problems
+      end
+    end
   end
 end

metadata

@@ -1,29 +1,35 @@
 --- !ruby/object:Gem::Specification
 name: puppet-lint-check_unsafe_interpolations
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.3
 platform: ruby
 authors:
 - Puppet, Inc.
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-12-01 00:00:00.000000000 Z
+date: 2022-12-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: puppet-lint
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 3.0.0
+        version: '1.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '4'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.0'
+    - - "<"
       - !ruby/object:Gem::Version
-        version: 3.0.0
+        version: '4'
 description: "    A puppet-lint plugin to check for unsafe interpolations.\n"
 email: 
 executables: []