puppet-lint-hiera 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: ca0a683393755155dc9b77047a86910ae4e249731bafcf4373e32cb34078cec9
+  data.tar.gz: cdd44ed624b0d996e5ce045be413fd5ca1e94511b8ff8fdcd8d26fef60e56644
+SHA512:
+  metadata.gz: 9609186ce6b65883b2912a8e20e2c7fc7ef65fe9b7c882d3d0977acda1767c0fa51619315bb67222ccb72ed4526b23ab5a2e93f88c68e15af16c914804ded34b
+  data.tar.gz: ffb90799218ec423b58cc842219197db5510182e352b92c02f99e90959dae0de5be685753fc34e90d0d1c30f81a885fc9418bfe786857fde244e07b2be1ea62a

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Dean Wilson
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,37 @@
+# puppet-lint hiera functions check
+
+## Installation
+To add the provided lint checks into a module utilizing the PDK:
+
+1. Add the following to the `.sync.yml` in the root of your module
+   ``` yaml
+   ---
+   Gemfile:
+     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
+
+## Usage
+This plugin provides two new checks to `puppet-lint`
+
+### **no_hiera**
+`--fix` support: No
+
+This check raises an error if the `hiera()` function is used.
+```
+error: hiera() function call. Use lookup() instead.
+```
+
+### **lookup**
+`--fix` support: No
+
+This check raises an error if the `lookup()` function is used outside of profile parameters.
+```
+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.
+```

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

@@ -0,0 +1,45 @@
+PuppetLint.new_check(:lookup) do
+  def check
+    functions = ['lookup']
+
+    lookups_in_parameters = Array.new
+    parent_class = String.new
+    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 in_params && is_profile
+
+      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
+
+      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,
+      }
+    end
+  end
+end

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

@@ -0,0 +1,18 @@
+PuppetLint.new_check(:no_hiera) do
+  def check
+    functions = ['hiera']
+
+    tokens.select { |t| (t.type == :NAME or t.type == :FUNCTION_NAME) and functions.include? t.value }.each do |function_token|
+      next unless function_token.next_code_token.type == :LPAREN
+
+      key_token = function_token.next_code_token.next_code_token
+      original_function = function_token.value
+
+      notify :error, {
+        message: "#{original_function}() function call. Use lookup() instead.",
+        line:    key_token.line,
+        column:  key_token.column,
+      }
+    end
+  end
+end

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

@@ -0,0 +1,106 @@
+require 'spec_helper'
+
+describe 'lookup' 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
+
+  # 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 profile::lookup_call_class {
+          file { '/tmp/foo':
+            content => lookup('some_key'),
+          }
+        }
+      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)
+    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 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
+
+  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/no_hiera_spec.rb

@@ -0,0 +1,68 @@
+require 'spec_helper'
+
+describe 'no_hiera' do
+  context 'class with no hiera calls' do
+    let(:code) do
+      <<-EOS
+        class no_hiera_calls {
+          file { '/tmp/foo':
+            content => 'bar',
+          }
+        }
+      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 hiera call in class' do
+    let(:msg) { 'hiera() function call. Use lookup() instead.' }
+
+    let(:code) do
+      <<-EOS
+        class hiera_call {
+          file { '/tmp/foo':
+            content => hiera('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(30)
+    end
+  end
+
+  context 'class with a hiera call in params' do
+    let(:msg) { 'hiera() function call. Use lookup() instead.' }
+
+    let(:code) do
+      <<-EOS
+        class hiera_call (
+          $content = hiera('some_key')
+        ){
+          file { '/tmp/foo':
+            content => $content,
+          }
+        }
+      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(2).in_column(28)
+    end
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,3 @@
+require 'puppet-lint'
+
+PuppetLint::Plugins.load_spec_helper

metadata

@@ -0,0 +1,171 @@
+--- !ruby/object:Gem::Specification
+name: puppet-lint-hiera
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Garrett Rowell
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2022-06-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: puppet-lint
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.1'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.1'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.9.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.9.0
+- !ruby/object:Gem::Dependency
+  name: rspec-its
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: rspec-collection_matchers
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.80.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.80.0
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 13.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 13.0.0
+- !ruby/object:Gem::Dependency
+  name: rspec-json_expectations
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.18.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.18.0
+description: "    Extends puppet-lint to ensure no hiera functions are called and
+  that lookups are only used in class parameters.\n"
+email: garrett@puppet.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- lib/puppet-lint/plugins/lookup.rb
+- lib/puppet-lint/plugins/no_hiera.rb
+- spec/puppet-lint/plugins/lookup_spec.rb
+- spec/puppet-lint/plugins/no_hiera_spec.rb
+- spec/spec_helper.rb
+homepage: 
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.6
+signing_key: 
+specification_version: 4
+summary: puppet-lint hiera and lookup function checks
+test_files:
+- spec/spec_helper.rb
+- spec/puppet-lint/plugins/no_hiera_spec.rb
+- spec/puppet-lint/plugins/lookup_spec.rb