puppet-lint-explicit_hiera_class_param_lookup-check 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 25f922c2cb240bc79774e4407794ebd6b09cb6b4
+  data.tar.gz: 1185f445dd37b80d5fa737bb25b1d43624a70325
+SHA512:
+  metadata.gz: 2696348e5561792596abe245b667b2abbe056d8a2c8b4ecc1ab9ae44806eb471e75e1739d3b6c7805d90e1901b2f1dd5bbb6f030e775f1ea7f88e3ba7b1f2912
+  data.tar.gz: dd5cc305e7468711d443b52607c2bac50d768f3375fc7ac9cd10e54cd47b758b83af79e108732637a0008e29073899c99d637a8d7e13c71a24c9f255a06987c5

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,40 @@
+# puppet-lint explicit Hiera class parameter lookup check
+
+Extends puppet-lint to ensure there are no explicit calls to hiera()
+in the class parameters.
+
+In our code base we would rather have a class lookup values for its
+parameters using Puppets automatic data binding functionality rather than
+scatter a number of direct, unpredictably name spaced, hiera calls
+throughout our manifests. This puppet-lint plugin helps us with that goal by
+finding any explicit `hiera` calls in a classes parameter section.
+
+    class no_explicit_lookups (
+      $my_content = hiera('my::nested::key', 'baz')
+    ) {
+      file { '/tmp/foo':
+        content => $my_content,
+      }
+    }
+
+## Installation
+
+To use this plugin add the following line to your Gemfile
+
+    gem 'puppet-lint-explicit_hiera_class_param_lookup-check'
+
+and then run `bundle install`.
+
+## Usage
+
+This plugin provides a new check to `puppet-lint`.
+
+    explicit hiera() lookup of my::sample::key
+
+#### Author
+
+[Dean Wilson](http://www.unixdaemon.net)
+
+### License
+
+ * MIT

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

@@ -0,0 +1,20 @@
+PuppetLint.new_check(:explicit_hiera_class_param_lookup) do
+  def check
+    class_indexes.each do |class_idx|
+
+      class_idx[:param_tokens].select { |t|
+        t.type == :NAME and t.value == 'hiera'
+      }.each do |token|
+
+        hiera_key = token.next_code_token.next_code_token
+
+        notify :error, {
+          :message => "explicit hiera() lookup of #{hiera_key.value}",
+          :line    => hiera_key.line,
+          :column  => hiera_key.column,
+        }
+
+      end
+    end
+  end
+end

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

@@ -0,0 +1,48 @@
+require 'spec_helper'
+
+describe 'explicit_hiera_class_param_lookup' do
+
+  context 'class with no explicit hiera() lookups' do
+    let(:code) do
+      <<-EOS
+        class no_explicit_lookups(
+          $my_content = undef
+        ) {
+          file { '/tmp/foo':
+            content => 'bar',
+          }
+        }
+      EOS
+    end
+
+    it 'should not detect any problems' do
+      expect(problems).to have(0).problems
+    end
+  end
+
+
+  context 'class with an explicit hiera() lookup' do
+    let(:msg) { "explicit hiera() lookup of my::nested::key" }
+
+    let(:code) do
+      <<-EOS
+        class no_explicit_lookups(
+          $my_content = hiera('my::nested::key', 'baz')
+        ) {
+          file { '/tmp/foo':
+            content => $my_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(31)
+    end
+  end
+
+end

data/spec/spec_helper.rb

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

metadata

@@ -0,0 +1,151 @@
+--- !ruby/object:Gem::Specification
+name: puppet-lint-explicit_hiera_class_param_lookup-check
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Dean Wilson
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-06-28 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'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+- !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-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: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: |2
+      Extends puppet-lint to ensure there are no explicit calls to hiera()
+      in the class parameters.
+email: dean.wilson@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- lib/puppet-lint/plugins/explicit_hiera_class_param_lookup.rb
+- spec/puppet-lint/plugins/puppet-lint-explicit_hiera_class_param_lookup_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/deanwilson/puppet-lint-explicit_hiera_class_param_lookup-check
+licenses:
+- MIT
+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.4.8
+signing_key: 
+specification_version: 4
+summary: puppet-lint explicit_hiera_class_param_lookup check
+test_files:
+- spec/spec_helper.rb
+- spec/puppet-lint/plugins/puppet-lint-explicit_hiera_class_param_lookup_spec.rb
+has_rdoc: