puppet-lint-hiera 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ca0a683393755155dc9b77047a86910ae4e249731bafcf4373e32cb34078cec9
-  data.tar.gz: cdd44ed624b0d996e5ce045be413fd5ca1e94511b8ff8fdcd8d26fef60e56644
+  metadata.gz: 9b99396c72c814e8d1ba03e82198c36be022d8491c2d912c7cda8ca52a10b0e2
+  data.tar.gz: cd2fe399a7f41994e7e2d9d625952dcb92b159788f3ea673799d7b63184d824d
 SHA512:
-  metadata.gz: 9609186ce6b65883b2912a8e20e2c7fc7ef65fe9b7c882d3d0977acda1767c0fa51619315bb67222ccb72ed4526b23ab5a2e93f88c68e15af16c914804ded34b
-  data.tar.gz: ffb90799218ec423b58cc842219197db5510182e352b92c02f99e90959dae0de5be685753fc34e90d0d1c30f81a885fc9418bfe786857fde244e07b2be1ea62a
+  metadata.gz: 2f1cb7fdd099b858c8044953e33160050db25223440303814dfdf2528b857e1418689dc0dc586c694d261b556a394b860c3d3e0d7ac11a7fcf11799daa56451a
+  data.tar.gz: 652fe5bf8b8626d987796a8c9490754b0b6c7dd8b7377fb10448251ef979aab1d2bd9642669deec50fb5545fbcedadf734b26dd0eed5bc47271c25e06881240c

data/README.md

@@ -10,7 +10,6 @@ To add the provided lint checks into a module utilizing the PDK:
      optional:
        ':development':
          - gem: 'puppet-lint-hiera'
-           git: 'git@github.com:garrettrowell/puppet-lint-hiera.git'
    ```
 2. Run `pdk update` from the root of the module
 3. `pdk validate` will now also use the lint checks provided by this plugin
@@ -26,12 +25,26 @@ This check raises an error if the `hiera()` function is used.
 error: hiera() function call. Use lookup() instead.
 ```
 
-### **lookup**
+### **lookup_in_class**
 `--fix` support: No
 
-This check raises an error if the `lookup()` function is used outside of profile parameters.
+This check raises an error if the `lookup()` function is used within a class body.
 ```
-error: lookup() function call found in profile class. Only use in profile params.
-error: lookup() function call found in class params.
 error: lookup() function call found in class.
 ```
+
+### **lookup_in_class_params**
+`--fix` support: No
+
+This check raises an error if the `lookup()` function is used inside a classes parameters.
+```
+error: lookup() function call found in class params.
+```
+
+### **lookup_in_profile_class**
+`--fix` support: No
+
+This check raises an error if the `lookup()` function is used within a profile body.
+```
+error: lookup() function call found in profile class. Only use in profile params.
+```

data/lib/puppet-lint/plugins/{lookup.rb → lookup_in_class.rb}

@@ -1,9 +1,9 @@
-PuppetLint.new_check(:lookup) do
+PuppetLint.new_check(:lookup_in_class) do
   def check
     functions = ['lookup']
 
-    lookups_in_parameters = Array.new
-    parent_class = String.new
+    lookups_in_parameters = []
+    parent_class = ''
     class_indexes.each do |class_idx|
       parent_class = class_idx[:name_token]
       # return early if no params
@@ -20,22 +20,14 @@ PuppetLint.new_check(:lookup) do
       is_profile = parent_class_name.match(/^profile::.*/)
       in_params = lookups_in_parameters.include? function_token
       next unless function_token.next_code_token.type == :LPAREN
-      next if in_params && is_profile
+      next if is_profile
+      next if in_params
 
       key_token = function_token.next_code_token.next_code_token
-      lookup_key_token = function_token.prev_code_token.prev_code_token
 
-      error_message = "#{function_token.value}() function call found in"
-      if in_params && !is_profile
-        error_message = error_message + " class params."
-      elsif is_profile && !in_params
-        error_message = error_message + " profile class. Only use in profile params."
-      else
-        error_message = error_message + " class."
-      end
+      error_message = "#{function_token.value}() function call found in class."
 
       notify :error, {
-#        message: "#{function_token.value}() function call found in class. Only use in class params.",
         message: error_message,
         line:    key_token.line,
         column:  key_token.column,

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

@@ -0,0 +1,37 @@
+PuppetLint.new_check(:lookup_in_class_params) do
+  def check
+    functions = ['lookup']
+
+    lookups_in_parameters = []
+    parent_class = ''
+    class_indexes.each do |class_idx|
+      parent_class = class_idx[:name_token]
+      # return early if no params
+      next if class_idx[:param_tokens].nil?
+
+      # iterate over each parameter token
+      class_idx[:param_tokens].each do |p_token|
+        lookups_in_parameters << p_token if ((p_token.type == :NAME or p_token.type == :FUNCTION_NAME) and functions.include? p_token.value)
+      end
+    end
+
+    tokens.select { |t| (t.type == :NAME or t.type == :FUNCTION_NAME) and functions.include? t.value }.each do |function_token|
+      parent_class_name = parent_class.value
+      is_profile = parent_class_name.match(/^profile::.*/)
+      in_params = lookups_in_parameters.include? function_token
+      next unless function_token.next_code_token.type == :LPAREN
+      next if is_profile
+      next unless in_params
+
+      key_token = function_token.next_code_token.next_code_token
+
+      error_message = "#{function_token.value}() function call found in class params."
+
+      notify :error, {
+        message: error_message,
+        line:    key_token.line,
+        column:  key_token.column,
+      }
+    end
+  end
+end

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

@@ -0,0 +1,37 @@
+PuppetLint.new_check(:lookup_in_profile_class) do
+  def check
+    functions = ['lookup']
+
+    lookups_in_parameters = []
+    parent_class = ''
+    class_indexes.each do |class_idx|
+      parent_class = class_idx[:name_token]
+      # return early if no params
+      next if class_idx[:param_tokens].nil?
+
+      # iterate over each parameter token
+      class_idx[:param_tokens].each do |p_token|
+        lookups_in_parameters << p_token if ((p_token.type == :NAME or p_token.type == :FUNCTION_NAME) and functions.include? p_token.value)
+      end
+    end
+
+    tokens.select { |t| (t.type == :NAME or t.type == :FUNCTION_NAME) and functions.include? t.value }.each do |function_token|
+      parent_class_name = parent_class.value
+      is_profile = parent_class_name.match(/^profile::.*/)
+      in_params = lookups_in_parameters.include? function_token
+      next unless function_token.next_code_token.type == :LPAREN
+      next if is_profile && in_params
+      next unless is_profile
+
+      key_token = function_token.next_code_token.next_code_token
+
+      error_message = "#{function_token.value}() function call found in profile class. Only use in profile params."
+
+      notify :error, {
+        message: error_message,
+        line:    key_token.line,
+        column:  key_token.column,
+      }
+    end
+  end
+end

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

@@ -0,0 +1,98 @@
+require 'spec_helper'
+
+describe 'lookup_in_class_params' do
+  context 'class with no lookup calls' do
+    let(:code) do
+      <<-EOS
+        class no_lookup_calls {
+          file { '/tmp/foo':
+            content => 'bar',
+          }
+        }
+      EOS
+    end
+
+    it 'should not detect any problems' do
+      expect(problems).to have(0).problems
+    end
+  end
+
+  context 'profile with a lookup call in params' do
+    let(:code) do
+      <<-EOS
+        class profile::lookup_call_params (
+          $content = lookup('some_key')
+        ) {
+          file { '/tmp/foo':
+            content => $content,
+          }
+        }
+      EOS
+    end
+
+    it 'should not detect any problems' do
+      expect(problems).to have(0).problems
+    end
+  end
+
+  context 'class with a lookup call in class' do
+    let(:msg) { 'lookup() function call found in class.' }
+
+    let(:code) do
+      <<-EOS
+        class lookup_call_class {
+          file { '/tmp/foo':
+            content => lookup('some_key'),
+          }
+        }
+      EOS
+    end
+
+    it 'should not detect any problems' do
+      expect(problems).to have(0).problem
+    end
+  end
+
+  context 'profile with a lookup call in class' do
+    let(:msg) { 'lookup() function call found in profile class. Only use in profile params.' }
+
+    let(:code) do
+      <<-EOS
+        class profile::lookup_call_class {
+          file { '/tmp/foo':
+            content => lookup('some_key'),
+          }
+        }
+      EOS
+    end
+
+    it 'should not detect any problems' do
+      expect(problems).to have(0).problems
+    end
+  end
+
+  # and these should cause failiures
+  context 'class with a lookup call in params' do
+    let(:msg) { 'lookup() function call found in class params.' }
+
+    let(:code) do
+      <<-EOS
+        class lookup_call_params (
+          $content = lookup('some_key')
+        ) {
+          file { '/tmp/foo':
+            content => $content,
+          }
+        }
+      EOS
+    end
+
+    it 'should detect a single problem' do
+      expect(problems).to have(1).problems
+    end
+
+    it 'should create an error' do
+      expect(problems).to contain_error(msg).on_line(2).in_column(29)
+    end
+  end
+end

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

@@ -0,0 +1,98 @@
+require 'spec_helper'
+
+describe 'lookup_in_class' do
+  context 'class with no lookup calls' do
+    let(:code) do
+      <<-EOS
+        class no_lookup_calls {
+          file { '/tmp/foo':
+            content => 'bar',
+          }
+        }
+      EOS
+    end
+
+    it 'should not detect any problems' do
+      expect(problems).to have(0).problems
+    end
+  end
+
+  context 'profile with a lookup call in params' do
+    let(:code) do
+      <<-EOS
+        class profile::lookup_call_params (
+          $content = lookup('some_key')
+        ) {
+          file { '/tmp/foo':
+            content => $content,
+          }
+        }
+      EOS
+    end
+
+    it 'should not detect any problems' do
+      expect(problems).to have(0).problems
+    end
+  end
+
+  context 'profile with a lookup call in class' do
+    let(:msg) { 'lookup() function call found in profile class. Only use in profile params.' }
+
+    let(:code) do
+      <<-EOS
+        class profile::lookup_call_class {
+          file { '/tmp/foo':
+            content => lookup('some_key'),
+          }
+        }
+      EOS
+    end
+
+    it 'should not detect any problems' do
+      expect(problems).to have(0).problems
+    end
+  end
+
+  context 'class with a lookup call in params' do
+    let(:msg) { 'lookup() function call found in class params.' }
+
+    let(:code) do
+      <<-EOS
+        class lookup_call_params (
+          $content = lookup('some_key')
+        ) {
+          file { '/tmp/foo':
+            content => $content,
+          }
+        }
+      EOS
+    end
+
+    it 'should not detect any problems' do
+      expect(problems).to have(0).problems
+    end
+  end
+
+  # and these should cause failiures
+  context 'class with a lookup call in class' do
+    let(:msg) { 'lookup() function call found in class.' }
+
+    let(:code) do
+      <<-EOS
+        class lookup_call_class {
+          file { '/tmp/foo':
+            content => lookup('some_key'),
+          }
+        }
+      EOS
+    end
+
+    it 'should detect a single problem' do
+      expect(problems).to have(1).problem
+    end
+
+    it 'should create an error' do
+      expect(problems).to contain_error(msg).on_line(3).in_column(31)
+    end
+  end
+end

data/spec/puppet-lint/plugins/{lookup_spec.rb → lookup_in_profile_class_spec.rb}

@@ -1,6 +1,6 @@
 require 'spec_helper'
 
-describe 'lookup' do
+describe 'lookup_in_profile_class' do
   context 'class with no lookup calls' do
     let(:code) do
       <<-EOS
@@ -35,13 +35,12 @@ describe 'lookup' do
     end
   end
 
-  # and these should cause failiures
-  context 'profile with a lookup call in class' do
-    let(:msg) { 'lookup() function call found in profile class. Only use in profile params.' }
+  context 'class with a lookup call in class' do
+    let(:msg) { 'lookup() function call found in class.' }
 
     let(:code) do
       <<-EOS
-        class profile::lookup_call_class {
+        class lookup_call_class {
           file { '/tmp/foo':
             content => lookup('some_key'),
           }
@@ -49,12 +48,8 @@ describe 'lookup' do
       EOS
     end
 
-    it 'should detect a single problem' do
-      expect(problems).to have(1).problems
-    end
-
-    it 'should create an error' do
-      expect(problems).to contain_error(msg).on_line(3).in_column(31)
+    it 'should not detect any problems' do
+      expect(problems).to have(0).problem
     end
   end
 
@@ -73,21 +68,19 @@ describe 'lookup' do
       EOS
     end
 
-    it 'should detect a single problem' do
-      expect(problems).to have(1).problems
+    it 'should not detect any problems' do
+      expect(problems).to have(0).problems
     end
 
-    it 'should create an error' do
-      expect(problems).to contain_error(msg).on_line(2).in_column(29)
-    end
   end
 
-  context 'class with a lookup call in class' do
-    let(:msg) { 'lookup() function call found in class.' }
+  # and these should cause failiures
+  context 'profile with a lookup call in class' do
+    let(:msg) { 'lookup() function call found in profile class. Only use in profile params.' }
 
     let(:code) do
       <<-EOS
-        class lookup_call_class {
+        class profile::lookup_call_class {
           file { '/tmp/foo':
             content => lookup('some_key'),
           }
@@ -96,7 +89,7 @@ describe 'lookup' do
     end
 
     it 'should detect a single problem' do
-      expect(problems).to have(1).problem
+      expect(problems).to have(1).problems
     end
 
     it 'should create an error' do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: puppet-lint-hiera
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Garrett Rowell
@@ -137,9 +137,13 @@ extra_rdoc_files: []
 files:
 - LICENSE
 - README.md
-- lib/puppet-lint/plugins/lookup.rb
+- lib/puppet-lint/plugins/lookup_in_class.rb
+- lib/puppet-lint/plugins/lookup_in_class_params.rb
+- lib/puppet-lint/plugins/lookup_in_profile_class.rb
 - lib/puppet-lint/plugins/no_hiera.rb
-- spec/puppet-lint/plugins/lookup_spec.rb
+- spec/puppet-lint/plugins/lookup_in_class_params_spec.rb
+- spec/puppet-lint/plugins/lookup_in_class_spec.rb
+- spec/puppet-lint/plugins/lookup_in_profile_class_spec.rb
 - spec/puppet-lint/plugins/no_hiera_spec.rb
 - spec/spec_helper.rb
 homepage: 
@@ -167,5 +171,7 @@ specification_version: 4
 summary: puppet-lint hiera and lookup function checks
 test_files:
 - spec/spec_helper.rb
+- spec/puppet-lint/plugins/lookup_in_class_params_spec.rb
 - spec/puppet-lint/plugins/no_hiera_spec.rb
-- spec/puppet-lint/plugins/lookup_spec.rb
+- spec/puppet-lint/plugins/lookup_in_profile_class_spec.rb
+- spec/puppet-lint/plugins/lookup_in_class_spec.rb