puppet-lint-hiera_functions-check 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 2fd789c616e42ae4aeacb3f858b19c2f4f741ac6ad2f8521d800d4fa3d66be0b
+  data.tar.gz: 4ee89c18633c97cf151d7dba494e270be8e51858bb2b1e98f661955d2efaf87b
+SHA512:
+  metadata.gz: 31b75c0c6d1643c02de09ea34c5208014181728969f52265fde9ffb53ab4740df4b8adc21dac438151ec4fae418868267d600656948c58d098236762b95da935
+  data.tar.gz: b39eaaf4fe7c1024a525b3365de738dfc1c2ef471a446629dd8e828de3d5906b616bbf1566413199d7ccfc376fc101d11f5bd2f9f751781cc9d0fe4a19a484ab

data/LICENSE

@@ -0,0 +1,28 @@
+BSD 3-Clause License
+
+Copyright (c) 2024, Christopher Bowman
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice, this
+   list of conditions and the following disclaimer.
+
+2. Redistributions in binary form must reproduce the above copyright notice,
+   this list of conditions and the following disclaimer in the documentation
+   and/or other materials provided with the distribution.
+
+3. Neither the name of the copyright holder nor the names of its
+   contributors may be used to endorse or promote products derived from
+   this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

data/README.md

@@ -0,0 +1,62 @@
+puppet-lint-hiera_functions-check
+=================================
+
+[![License](https://img.shields.io/github/license/cbowman0/puppet-lint-hiera_functions-check.svg)](https://github.com/cbowman0/puppet-lint-hiera_functions-check/blob/master/LICENSE)
+[![CI](https://github.com/cbowman0/puppet-lint-hiera_functions-check/actions/workflows/ci.yaml/badge.svg)](https://github.com/cbowman0/puppet-lint-hiera_functions-check/actions/workflows/ci.yaml)
+[![RubyGem Version](https://img.shields.io/gem/v/puppet-lint-hiera_functions-check.svg)](https://rubygems.org/gems/puppet-lint-hiera_functions-check)
+[![RubyGem Downloads](https://img.shields.io/gem/dt/puppet-lint-hiera_functions-check.svg)](https://rubygems.org/gems/puppet-lint-hiera_functions-check)
+
+A puppet-lint plugin to check for deprecated hiera() function usage
+
+## Installing
+
+### From the command line
+
+```shell
+$ gem install puppet-lint-hiera_functions-check
+```
+
+### In a Gemfile
+
+```ruby
+gem 'puppet-lint-hiera_functions-check', :require => false
+```
+
+## Checks
+
+### Hiera function used
+
+Usage of the hiera() function is deprecated
+
+#### What you have done
+
+```puppet
+$key = hiera('key')
+$key = hiera_array('key')
+$key = hiera_hash('key')
+$key = hiera_include('key')
+```
+
+#### What you should have done
+
+```puppet
+$key = lookup('key')
+$key = lookup('key', {merge => unique})
+$key = lookup('key', {merge => hash})
+$key = lookup('key', {merge => unique}).include
+```
+
+#### Disabling the check
+
+To disable this check, you can add `--no-hiera_functions-check` to your puppet-lint command line.
+
+```shell
+$ puppet-lint --no-hiera_functions-check path/to/file.pp
+```
+
+Alternatively, if you’re calling puppet-lint via the Rake task, you should insert the following line to your `Rakefile`.
+
+```ruby
+PuppetLint.configuration.send('disable_hiear_functions')
+```
+

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

@@ -0,0 +1,75 @@
+# frozen_string_literal: true
+
+# Checks manifests for deprecated Hiera functions
+# hiera(), hiera_arrya(), hiera_hash() and hiera_include()
+#
+# @see https://www.puppet.com/docs/puppet/8/hiera_migrate.html
+#
+PuppetLint.new_check(:hiera_functions) do
+  def check
+    # Get all the functions.  The function_index in puppet-lint is supposed to do this,
+    # but it was always empty when I tried to use it
+    function_tokens = tokens.select { |token| token.type == :FUNCTION_NAME }
+
+    # Check each function for matching the hiera function list.
+    function_tokens.each do |function_token|
+      next unless function_token.value.match?(%r{^hiera(|_array|_hash|_include)$})
+
+      notify(
+        :warning,
+        message: "#{function_token.value} function is deprecated.  Use lookup()",
+        line: function_token.line,
+        column: function_token.column,
+        token: function_token,
+      )
+    end
+  end
+
+  # Attempt the fix
+  #
+  # hiera('key')         -> lookup('key')
+  # hiera_array('key')   -> lookup('key', {merge => unique})
+  # hiera_hash('key')    -> lookup('key', {merge => hash})
+  # hiera_include('key') -> lookup('key', {merge => unique}).include
+  #
+  def fix(problem)
+    case problem[:token].value
+    when 'hiera_array'
+      fix_hiera_with_merge(problem, 'unique')
+    when 'hiera_include'
+      fix_hiera_with_merge(problem, 'unique')
+      fix_hiera_append_include(problem)
+    when 'hiera_hash'
+      fix_hiera_with_merge(problem, 'hash')
+    end
+
+    # Always swap hiera() for lookup()
+    problem[:token].value = 'lookup'
+  end
+
+  private
+
+  def fix_hiera_with_merge(problem, merge_type)
+    index = tokens.index(problem[:token].next_token_of(:LPAREN).next_token_of(:RPAREN))
+
+    # Add the necessary tokens to the end in reverse order, so the index doesn't change =)
+    add_token(index, PuppetLint::Lexer::Token.new(:RBRACE, '}', 0, 0))
+    add_token(index, PuppetLint::Lexer::Token.new(:NAME, merge_type, 0, 0))
+    add_token(index, PuppetLint::Lexer::Token.new(:WHITESPACE, ' ', 0, 0))
+    add_token(index, PuppetLint::Lexer::Token.new(:FARROW, '=>', 0, 0))
+    add_token(index, PuppetLint::Lexer::Token.new(:WHITESPACE, ' ', 0, 0))
+    add_token(index, PuppetLint::Lexer::Token.new(:NAME, 'merge', 0, 0))
+    add_token(index, PuppetLint::Lexer::Token.new(:LBRACE, '{', 0, 0))
+    add_token(index, PuppetLint::Lexer::Token.new(:WHITESPACE, ' ', 0, 0))
+    add_token(index, PuppetLint::Lexer::Token.new(:COMMA, ',', 0, 0))
+  end
+
+  def fix_hiera_append_include(problem)
+    # Get the index of the token _past_ the right paren
+    index = tokens.index(problem[:token].next_token_of(:LPAREN).next_token_of(:RPAREN)) + 1
+
+    # Add the tokens in reverse order so the index doesn't change
+    add_token(index, PuppetLint::Lexer::Token.new(:NAME, 'include', 0, 0))
+    add_token(index, PuppetLint::Lexer::Token.new(:DOT, '.', 0, 0))
+  end
+end

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

@@ -0,0 +1,195 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe 'hiera_functions' do
+  let(:msg) { 'function is deprecated.  Use lookup()' }
+
+  context 'with fix disabled' do
+    context 'with hiera function' do
+      let(:code) do
+        <<-PP
+        class function_tester {
+          $test_key = hiera('test-key-name')
+        }
+        PP
+      end
+
+      it 'detects a single problem' do
+        expect(problems.size).to eq(1)
+      end
+
+      it 'creates warnings' do
+        expect(problems).to contain_warning("hiera #{msg}").on_line(2).in_column(23)
+      end
+    end
+
+    context 'with hiera_array function' do
+      let(:code) do
+        <<-PP
+        class function_tester {
+          $test_key = hiera_array('test-key-name')
+        }
+        PP
+      end
+
+      it 'detects a single problem' do
+        expect(problems.size).to eq(1)
+      end
+
+      it 'creates warnings' do
+        expect(problems).to contain_warning("hiera_array #{msg}").on_line(2).in_column(23)
+      end
+    end
+
+    context 'with hiera_hash function' do
+      let(:code) do
+        <<-PP
+        class function_tester {
+          $test_key = hiera_hash('test-key-name')
+        }
+        PP
+      end
+
+      it 'detects a single problem' do
+        expect(problems.size).to eq(1)
+      end
+
+      it 'creates warnings' do
+        expect(problems).to contain_warning("hiera_hash #{msg}").on_line(2).in_column(23)
+      end
+    end
+
+    context 'with hiera_include function' do
+      let(:code) do
+        <<-PP
+        class function_tester {
+          $test_key = hiera_include('test-key-name')
+        }
+        PP
+      end
+
+      it 'detects a single problem' do
+        expect(problems.size).to eq(1)
+      end
+
+      it 'creates warnings' do
+        expect(problems).to contain_warning("hiera_include #{msg}").on_line(2).in_column(23)
+      end
+    end
+  end
+
+  context 'with fix enabled' do
+    before(:each) do
+      PuppetLint.configuration.fix = true
+    end
+
+    after(:each) do
+      PuppetLint.configuration.fix = false
+    end
+
+    context 'with hiera function' do
+      let(:code) do
+        <<-PP
+        class function_tester {
+          $hiera = hiera('test-key-name')
+        }
+        PP
+      end
+
+      let(:fixed_code) do
+        <<-PP
+        class function_tester {
+          $hiera = lookup('test-key-name')
+        }
+        PP
+      end
+
+      it 'detects a single problem' do
+        expect(problems).to contain_fixed("hiera #{msg}").on_line(2)
+      end
+
+      it 'changes hiera to lookup' do
+        expect(manifest).to eq(fixed_code)
+      end
+    end
+
+    context 'with hiera_array function' do
+      let(:code) do
+        <<-PP
+        class function_tester {
+          $test_key = hiera_array('test-key-name')
+        }
+        PP
+      end
+
+      let(:fixed_code) do
+        <<-PP
+        class function_tester {
+          $test_key = lookup('test-key-name', {merge => unique})
+        }
+        PP
+      end
+
+      it 'detects a single problem' do
+        expect(problems).to contain_fixed("hiera_array #{msg}").on_line(2)
+      end
+
+      it 'changes hiera to lookup' do
+        expect(manifest).to eq(fixed_code)
+      end
+    end
+
+    context 'with hiera_hash function' do
+      let(:code) do
+        <<-PP
+        class function_tester {
+          $test_key = hiera_hash('test-key-name')
+        }
+        PP
+      end
+
+      let(:fixed_code) do
+        <<-PP
+        class function_tester {
+          $test_key = lookup('test-key-name', {merge => hash})
+        }
+        PP
+      end
+
+      it 'detects a single problem' do
+        expect(problems).to contain_fixed("hiera_hash #{msg}").on_line(2)
+      end
+
+      it 'changes hiera to lookup' do
+        expect(manifest).to eq(fixed_code)
+      end
+    end
+
+    context 'with hiera_include function' do
+      let(:code) do
+        <<-PP
+        class function_tester {
+          $test_key = hiera_include('test-key-name')
+        }
+        PP
+      end
+
+      let(:fixed_code) do
+        <<-PP
+        class function_tester {
+          $test_key = lookup('test-key-name', {merge => unique}).include
+        }
+        PP
+      end
+
+      it 'detects a single problem' do
+        expect(problems).to contain_fixed("hiera_include #{msg}").on_line(2)
+      end
+
+      it 'changes hiera to lookup' do
+        expect(manifest).to eq(fixed_code)
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+require 'puppet-lint'
+
+PuppetLint::Plugins.load_spec_helper

metadata

@@ -0,0 +1,155 @@
+--- !ruby/object:Gem::Specification
+name: puppet-lint-hiera_functions-check
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Christopher Bowman
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2024-11-26 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: '5.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.1'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.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: rspec-its
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.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: voxpupuli-rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: |2
+      A puppet-lint plugin to check for deprecated hieras function usage.
+
+      The legacy Hiera functions (hiera, hiera_array, hiera_hash, and hiera_include) should be replaced with lookup()
+email: cbowman0@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- lib/puppet-lint/plugins/hiera_functions.rb
+- spec/puppet-lint/plugins/check_hiera_functions_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/cbowman0/puppet-lint-hiera_functions-check
+licenses:
+- MIT
+metadata:
+  rubygems_mfa_required: 'true'
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.22
+signing_key: 
+specification_version: 4
+summary: A puppet-lint plugin to check for deprecated hiera functions usage.
+test_files: []