puppet-lint-parameter_type-check 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: c360e6d8629127de13221f4cbc3fe6264b2df207ef68cc953b086803a5dd3ad0
+  data.tar.gz: '098c69bf5e1c8df87c168fe94a722339fbf60c68ced023e97d1bec018d20610a'
+SHA512:
+  metadata.gz: 3cee50c627f81dc7f3ab1e17d5312bee64ed075b5c5c0d502c28fbcdbfe79fed78b780aa6350f2f5c9bb035da7f7119ce579b9173df5a58c933be7b6520a2846
+  data.tar.gz: 301ed3047d433c0e91151c54b40a42fb23097f158a48febd247458c5e30c77a846570edad9125ce233d6b5623c42376db117dd84c4849ede175204d0d5da4069

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2020 Iacob Nicolaev
+
+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-parameter_type-check
+puppet-lint plugin to check if all parameters are declared with a specific type
+
+# Installation
+To install add the following to your Gemfile and run `bundle install`
+`gem puppet-lint-parameter_type-check, :require => false`
+
+or
+
+`gem install puppet-lint-parameter_type-check`
+
+# Usage 
+The plugin provides new check through `puppet-lint` 
+
+## parameter_type-check
+
+### --fix support: No
+
+To disable this check use `--no-parameter_type-check`
+
+This check will tell you if your parameters are not defined with a specific data type
+
+
+```
+define foo( 
+    $foo, 
+    $bar,
+) { }
+``` 
+will result in a warning with the fallowing message:
+
+`WARNING: expected a parameter with type declared`
+
+Define examle that will pass this check: 
+
+```
+define foo( 
+  String $foo, 
+  Integer $bar,
+) { }
+```
+
+# References 
+https://puppet.com/docs/puppet/latest/style_guide.html#type-signatures

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

@@ -0,0 +1,22 @@
+PuppetLint.new_check(:parameter_type) do
+  def check
+    pass_checks_types = Set.new([:TYPE, :RBRACK, :EQUALS, :DQPRE, :DQMID])
+    msg = "expected a parameter with type declared"
+    (class_indexes + defined_type_indexes).each do |class_idx|
+      next if class_idx[:param_tokens].nil?
+
+      class_idx[:param_tokens].each_with_index do |token, i|
+        if token.type == :VARIABLE
+          next if pass_checks_types.include? token.prev_code_token.type
+
+          notify(
+            :warning,
+            :message => msg,
+            :line    => token.line,
+            :column  => token.column
+          )
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,73 @@
+require 'spec_helper'
+
+describe 'parameter_type' do
+  let(:msg) { 'expected a parameter with type declared' }
+
+  %w[define class].each do |type|
+    context "#{type} parameter without data type" do
+      let(:code) { "#{type} foo( $foo ) { }" }
+
+      it 'should detect a single problem' do
+        expect(problems).to have(1).problem
+      end
+      col = (type == 'class' ? 12 : 13)
+      it 'should create a warning' do
+        expect(problems).to contain_warning(msg).on_line(1).in_column(col)
+      end
+    end
+
+    context "#{type} parameter without data type and valua with unenc variable" do
+      let(:code) { "#{type} foo($foo = \"text=${unenc} text=${unenc}\" ) { }" }
+
+      it 'should detect a problem' do
+        expect(problems).to have(1).problems
+      end
+      col = (type == 'class' ? 11 : 12)
+      it 'should create a warning' do
+        expect(problems).to contain_warning(msg).on_line(1).in_column(col)
+      end
+    end
+
+    context "#{type} parameter without data type" do
+      let(:code) { "#{type} foo( $foo, $bar ) { }" }
+
+      it 'should detect two problem' do
+        expect(problems).to have(2).problem
+      end
+    end
+
+    context "#{type} parameter with data type" do
+      let(:code) { "#{type} foo( Hash $foo ) { }" }
+
+      it 'should not detect any problems' do
+        expect(problems).to have(0).problems
+      end
+    end
+
+    context "#{type} multiple parameter with data type" do
+      let(:code) { "#{type} foo(Hash $foo, String $foo,) { }" }
+
+      it 'should not detect any problems' do
+        expect(problems).to have(0).problems
+      end
+    end
+
+    context "#{type} Optional parameter with data type" do
+      let(:code) { "#{type} foo(Optionl[String] $foo) { }" }
+
+      it 'should not detect any problems' do
+        expect(problems).to have(0).problems
+      end
+    end
+
+    context "#{type} parameter with data type and valua with unenc variable" do
+      let(:code) { "#{type} foo(String $foo = \"text=${unenc} text=${unenc}\") { }" }
+
+      it 'should not detect any problems' do
+        expect(problems).to have(0).problems
+      end
+    end
+
+  end
+
+end

data/spec/spec_helper.rb

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

metadata

@@ -0,0 +1,135 @@
+--- !ruby/object:Gem::Specification
+name: puppet-lint-parameter_type-check
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Iacob Nicolaev
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2020-01-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: puppet-lint
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.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-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: simplecov
+  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: "      A puppet-lint plugin to check if parameters in Classes and Defines
+  has types declared.\n"
+email: nicolaev.iacob@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- lib/puppet-lint/plugins/check_parameter_type.rb
+- spec/puppet-lint/plugins/check_parameter_type_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/iasha102/puppet-lint-parameter_type-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: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: A puppet-lint plugin to check if parameters in Classes and Defines has types
+  declared.
+test_files:
+- spec/puppet-lint/plugins/check_parameter_type_spec.rb
+- spec/spec_helper.rb