puppet-lint-duplicate_class_parameters-check 1.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: bbac51812f5327f9031fe74febda0f51332cd150
+  data.tar.gz: 22b89ff9affe12e6b1ecf7edfd4fc15fbeaaebe8
+SHA512:
+  metadata.gz: 76c7e7bcf168666e38b68861d4ecc44c1d4ea41a48d85fe3dd2b366428f6fa8a830edb15b700a03fc7baf916cb33df95a0f7fbbf151bb4e9bd5705691d031256
+  data.tar.gz: 60b2655f22bb6f1fbf9a395116095f29847b78b1a77475b46d718160af2063ef48027ee6b38b63c71de16c9790c757e833ca25df6aec32ebe8a733047dd62570

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,44 @@
+# puppet-lint duplicate_class_parameters check #
+
+A puppet-lint extension that ensures class parameter names are unique.
+
+[![Build Status](https://travis-ci.org/deanwilson/puppet-lint_duplicate_class_parameters-check.svg?branch=master)](https://travis-ci.org/deanwilson/puppet-lint_duplicate_class_parameters-check)
+
+Until Puppet 3.8.5 it was possible to have the same parameter name specified
+multiple times in a class definition without error. This could cause 
+confusion as only the last value for that name was taken and it was decided in
+[No error on duplicate parameters on classes and resources](https://tickets.puppetlabs.com/browse/PUP-5590)
+that this behaviour should change and now return an error. This `puppet-lint`
+plugin will help you catch those issues before you upgrade and suffer failures
+in your puppet runs.
+
+An exaggerated example of the previously valid, but awkward, behaviour can be found below -
+
+    class file_resource(
+      $duplicated = { 'a' => 1 },
+      $duplicated = 'foo',
+      $not_unique = 'bar',
+      $not_unique = '2nd bar',
+      $unique     = 'baz'
+    ) {
+
+      file { '/tmp/my-file':
+        mode => '0600',
+      }
+
+    }
+
+With this extension installed `puppet-lint` will return
+
+    found duplicate parameter 'duplicated' in class 'file_resource'
+
+## Installation ##
+
+To use this plugin add the following line to your Gemfile
+
+    gem 'puppet-lint-duplicate_class_parameters-check'
+
+and then run `bundle install`
+
+### Author ###
+[Dean Wilson](http://www.unixdaemon.net)

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

@@ -0,0 +1,29 @@
+PuppetLint.new_check(:duplicate_class_parameters) do
+  def check
+    class_indexes.each do |class_idx|
+      seen = Hash.new(0)
+
+      # if there are no params there is nothing to do, return early.
+      return if class_idx[:param_tokens].nil?
+
+      class_idx[:param_tokens].each do |token|
+        class_name = class_idx[:name_token].value
+
+        if token.type == :VARIABLE
+          param_name = token.value
+          seen[param_name] += 1
+
+          if seen[param_name] > 1
+            # warning output shows the parameter location each additional time it's seen
+            notify :warning, {
+              :message => "found duplicate parameter '#{param_name}' in class '#{class_name}'",
+              :line    => token.line,
+              :column  => token.column,
+            }
+          end
+
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,77 @@
+require 'spec_helper'
+
+describe 'duplicate_class_parameters' do
+
+  context 'class with no parameters' do
+   let(:code) do
+      <<-EOS
+        class file_resource {
+          file { '/tmp/my-file':
+            mode => '0600',
+          }
+        }
+      EOS
+    end
+
+    it 'should not detect any problems' do
+      expect(problems).to have(0).problems
+    end
+  end
+
+  context 'class without duplicate parameter' do
+    let(:code) do
+      <<-EOS
+        class file_resource(
+          $unique = 'bar',
+        ) {
+
+          file { '/tmp/my-file':
+            mode => '0600',
+          }
+
+          $baz = 'xxzzy'
+        }
+      EOS
+    end
+
+    it 'should not detect any problems' do
+      expect(problems).to have(0).problems
+    end
+  end
+
+  context 'class with duplicate parameters' do
+    let(:msg) { 'found duplicate parameter \'duplicated\' in class \'file_resource\'' }
+    let(:code) do
+      <<-EOS
+        class file_resource(
+          $duplicated = { 'a' => 1 },
+          $duplicated = 'foo',
+          $not_unique = 'bar',
+          $not_unique = '2nd bar',
+          $unique = 'baz'
+        ) {
+
+          file { '/tmp/my-file':
+            mode => '0600',
+          }
+
+          $baz = 'xxzzy'
+        }
+      EOS
+    end
+
+    it 'should detect two problems' do
+      expect(problems).to have(2).problems
+    end
+
+    it 'should create a warning' do
+      expect(problems).to contain_warning(msg).on_line(3).in_column(11)
+    end
+
+    it 'should create two warnings' do
+      expect(problems).to contain_warning(msg).on_line(3).in_column(11)
+      expect(problems).to contain_warning(msg.sub('duplicated', 'not_unique')).on_line(5).in_column(11)
+    end
+
+  end
+end

data/spec/spec_helper.rb

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

metadata

@@ -0,0 +1,137 @@
+--- !ruby/object:Gem::Specification
+name: puppet-lint-duplicate_class_parameters-check
+version: !ruby/object:Gem::Version
+  version: 1.0.1
+platform: ruby
+authors:
+- Dean Wilson
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-01-29 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: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.36.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.36.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'
+description: |2
+      A puppet-lint extension that ensures class parameter names
+      are unique.
+email: dean.wilson@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- lib/puppet-lint/plugins/duplicate_class_parameters.rb
+- spec/puppet-lint/plugins/puppet-lint_duplicate_class_parameters_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/deanwilson/puppet-lint_duplicate_class_parameters-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 duplicate class parameters check
+test_files:
+- spec/spec_helper.rb
+- spec/puppet-lint/plugins/puppet-lint_duplicate_class_parameters_spec.rb
+has_rdoc: