puppet-lint-param-types 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 26acacc6412f383e06f34f5ccea0bbd06cb294ee
+  data.tar.gz: 4623def5816195954c9fff6989a6e007567236be
+SHA512:
+  metadata.gz: 62175cae22a41add32ca935a00aaeb14017fabbe724843523559642620d9c8c361a3a60cc31b5ee773bb2bc44dd1dfa2a8a4be812f58c90357d27f72be02477c
+  data.tar.gz: 7e789a73b47386476657605cae8e9d78da1bc5752f94b14986a4791b5f363a52cba36c2c149bf2fa5650920af8c3dfb44f735b14e0d9808d2571a0e36682ff6f

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2014 Tim Sharpe
+
+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,55 @@
+# puppet-lint-param-types
+
+This plugin validates that all class and defined type parameter are typed.
+
+## Installation
+
+To use this plugin, add the following line to the Gemfile in your Puppet code
+base and run `bundle install`.
+
+```ruby
+gem 'puppet-lint-param-types
+```
+
+Verify that plugin is installed correctly.
+
+```bash
+$ puppet-lint -h | grep parameter_types
+    --no-parameter_types-check   Skip the parameter_types check.
+```
+
+## Usage
+
+
+### parameter_types
+
+**--fix-support: No**
+
+Will raise a warning if a class parameter without data type specification is
+found.
+
+```
+WARNING: missing datatype for parameter mysql::service_ensure on line 5
+```
+
+What you did:
+
+```
+class foo (
+  $bar,
+  $baz,
+) { ... }
+```
+
+What you should have done:
+
+```
+class foo (
+  Integer $bar,
+  Array[String] $baz,
+) { ... }
+```
+
+## References
+
+https://puppet.com/docs/puppet/latest/lang_data_type.html

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

@@ -0,0 +1,53 @@
+PuppetLint.new_check(:parameter_types) do
+  def check
+    (class_indexes + defined_type_indexes).each do |idx|
+      next if idx[:param_tokens].nil?
+      # https://github.com/puppetlabs/puppet-specifications/blob/master/language/catalog_expressions.md
+      # Each individual parameter in the parameter list must start with
+      # either a datatype or a variable name, so testing whether the parameter is typed
+      # is easy.
+      state = :ST_BEGIN
+      paren_stack = []
+      data_stack = []
+      idx[:param_tokens].each do |token|
+        next if [ :NEWLINE, :WHITESPACE, :INDENT, :COMMENT, :MLCOMMENT, :SLASH_COMMENT].include?(token.type)
+
+        case state
+        when :ST_BEGIN
+          paren_stack = []
+          data_stack = []
+          if (token.type == :TYPE) or (token.value =~ /^[A-Z]/)
+            state = :ST_SKIP_TYPE
+          elsif token.type == :VARIABLE
+            notify :warning, {
+              :message => "missing datatype for parameter #{idx[:name_token].value}::#{token.value}",
+              :line    => token.line,
+              :column  => token.column
+            }
+            state = :ST_SKIP
+          end
+        # skip over the parameter default which can contain complex data types with variable references
+        # so a simple comma check isn't enough, brackets must be counted.
+        when :ST_SKIP
+          if token.type == :LPAREN
+            paren_stack.push(true)
+          elsif token.type == :RPAREN
+            paren_stack.pop
+          elsif token.type == :LBRACE || token.type == :LBRACK
+            data_stack.push(true)
+          elsif token.type == :RBRACE || token.type == :RBRACK
+            data_stack.pop
+          elsif token.type == :COMMA && data_stack.empty? && paren_stack.empty?
+            state = :ST_BEGIN
+        end
+        # Datatypes cannot have variables so when a variable is found it must be
+        # end of the data type
+        when :ST_SKIP_TYPE
+          if token.type == :VARIABLE
+            state = :ST_SKIP
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,142 @@
+require 'spec_helper'
+
+describe 'parameter_types' do
+  let(:msg) { 'missing datatype for parameter spec::%s' }
+
+  [ 'class', 'define' ].each do | rt |
+    context "#{rt} without parameters" do
+      let(:code) { 'class spec() {}' }
+      it 'should not be a problem' do
+        expect(problems).to have(0).problem
+      end
+    end
+    context "simple #{rt} without type" do
+      let(:code) { 'class spec($foo) { }' }
+      it 'should be a problem' do
+        expect(problems).to have(1).problem
+        expect(problems).to contain_warning(msg % :foo).on_line(1)
+      end
+    end
+
+    context "#{rt} with many params without type" do
+      let(:code) do
+        <<-EOL
+class spec (
+  $attr1,
+  $attr2,
+  $attr3
+) { }
+        EOL
+      end
+      it 'should be a problem' do
+        expect(problems).to have(3).problem
+      end
+    end
+    context "#{rt} with many params without type on one line" do
+      let(:code) { 'class spec ($attr1, $attr2, $attr3 ) { }' }
+      it 'should be a problem' do
+        expect(problems).to have(3).problem
+      end
+    end
+    context "#{rt} with many params and defaults without type" do
+      let(:code) do
+        <<-EOL
+class spec (
+  $attr0,
+  $attr1 = 1,
+  $attr2 = $attr1,
+  $attr3 = [ 'array', 'with', 'entries'],
+  $attr4 = { 'key' => 'value' }
+  $attr5 = {
+    'key' => 'value',
+    'key2' => [
+      'val1',
+      'val2',
+    ],
+ },
+) { }
+        EOL
+      end
+      it 'should be a problem' do
+        expect(problems).to have(5).problem
+      end
+    end
+
+    context "#{rt} with some attributes typed" do
+      let(:code) do
+        <<-EOL
+class spec (
+  Integer $attr1,
+  String  $attr2 = 'foo',
+  $attr3 = undef,
+  $attr4 = { 'key' => 'value' }
+  Array[Struct[{
+    name       => String[1],
+    source_url => String[1],
+    delete     => Optional[Boolean],
+    exclude    => Optional[Variant[String,Array[String]]],
+    include    => Optional[Variant[String,Array[String]]],
+    sync_hour  => Optional[String],
+  }]]             $repos = [],
+  Hash $attr5 = {
+    'key' => 'value',
+    'key2' => [
+      'val1',
+      'val2',
+    ],
+ },
+) { }
+        EOL
+      end
+      it 'should be a problem' do
+        expect(problems).to have(2).problem
+      end
+    end
+    context "#{rt} with some attributes typed on one line" do
+      let(:code) { 'class spec(Integer $attr1, $attr2 = 5, Variant[String,Integer] $attr 3, $attr4 = [1,2]) { }' }
+      it 'should be a problem' do
+        expect(problems).to have(2).problem
+      end
+    end
+
+    context "#{rt} with all attributes typed" do
+      let(:code) do
+        <<-EOL
+class spec (
+  Integer $attr1,
+  String  $attr2 = 'foo',
+  Optional[String] $attr3 = undef,
+  Optional[Variant[Integer,Array[String] $attr4 = undef,
+  Stdlib::MyType $attr5 = undef,
+) { }
+        EOL
+      end
+      it 'should not be a problem' do
+        expect(problems).to have(0).problem
+      end
+    end
+    context "#{rt} with all attributes typed complex" do
+      let(:code) do
+        <<-EOL
+class spec (
+  Integer $attr1,
+  String  $attr2 = 'foo',
+  Optional[String] $attr3 = undef,
+  Optional[Variant[Integer,Array[String] $attr4,
+  Array[Struct[{
+    name       => String[1],
+    source_url => String[1],
+    delete     => Optional[Boolean],
+    exclude    => Optional[Variant[String,Array[String]]],
+    include    => Optional[Variant[String,Array[String]]],
+    sync_hour  => Optional[String],
+  }]]             $repos = [],
+) { }
+        EOL
+      end
+      it 'should not be a problem' do
+        expect(problems).to have(0).problem
+      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,127 @@
+--- !ruby/object:Gem::Specification
+name: puppet-lint-param-types
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Hostnet
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-03-05 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.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'
+description: |2
+      A new check for puppet-lint that validates that all parameters are typed.
+email: opensource@hostnet.nl
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- lib/puppet-lint/plugins/check_parameter_types.rb
+- spec/puppet-lint/plugins/check_parameter_types_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/hostnet/puppet-lint-param-types
+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.2.5
+signing_key: 
+specification_version: 4
+summary: puppet-lint check that validates that all parameters are typed
+test_files:
+- spec/puppet-lint/plugins/check_parameter_types_spec.rb
+- spec/spec_helper.rb