puppet-lint-topscope-variable-check 1.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: e0ad23632093e2963ab543f0e674b202023a5c6f959138af1c1f5f9391457f5a
+  data.tar.gz: f1aa73f43b44e3cf0cfbe3ab5751e4ce4b036c95bfb4c12830c3e3fae4572320
+SHA512:
+  metadata.gz: 729764ccad0c21ff5ac08c93d892bf60b9e158c7639f307eaa3eaff6e1d30f21de26a4fdd47b0c2940c451ccbd998f9c6d63c69804c8fdce368bc8bf707079b6
+  data.tar.gz: ebd1ab0074b7c9056c6a66b38160a7b6d9cda7323be9e188343aaf0ac719a48e5fed838a511e8c743b94c4e438b8b633abfe64d1ed42c78d75b9de3fd07bbd75

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2018 Sixt GmbH & Co. Autovermietung KG
+
+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,105 @@
+puppet-lint-topscope-variable-check
+========================
+[![Build Status](https://api.travis-ci.org/sixt/puppet-lint-topscope-variable-check.svg)](https://travis-ci.org/sixt/puppet-lint-topscope-variable-check)
+
+
+A puppet-lint plugin to check that topscope variables in a class do not begin with $::
+
+## Installation
+
+### From the command line
+```shell
+$ gem install puppet-lint-topscope-variable-check
+```
+
+### In a Gemfile
+```ruby
+gem 'puppet-lint-topscope-variable-check', require: false
+```
+
+## Checks
+
+#### What you have done
+
+```puppet
+class foo::blub {
+  notify { 'foo':
+    message => $::foo::bar,
+  }
+}
+```
+
+or
+```puppet
+class foo::blub(
+  String $foo = $::foo::params::foo
+) {
+  # ...
+}
+```
+
+#### What you should have done
+
+```puppet
+class foo::blub {
+  notify { 'foo'
+    message => $foo::bar,
+  }
+}
+```
+
+and
+
+```puppet
+class foo::blub(
+  String $foo = $foo::params::foo
+) {
+  # ...
+}
+```
+
+#### Disabling the check
+
+To disable this check, you can add `--no-topscope_variable-check` to your puppet-lint command line:
+```shell
+$ puppet-lint --no-topscope_variable-checks
+```
+
+Alternatively, if you are calling puppet-lint via the Rake task, you should insert the following line into your `Rakefile`:
+
+```ruby
+PuppetLint.configuration.send('disable_topscope_variable')
+```
+## Limitations
+
+The fix function of this plugin does not work when the variable is used in a string.
+For example:
+
+``` puppet
+$foo = "/etc/$::foobar::path/test"
+```
+
+## License
+```
+MIT License
+
+Copyright (c) 2018 Sixt GmbH & Co. Autovermietung KG
+
+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/lib/puppet-lint/plugins/topscope_variable.rb

@@ -0,0 +1,23 @@
+PuppetLint.new_check(:topscope_variable) do
+  def check
+    class_list = (class_indexes + defined_type_indexes)
+    # do not check if the code is not part of a class
+    return if class_list.first.nil?
+    class_name = class_list.first[:name_token].value.split('::').first
+    tokens.select { |x| x.type == :VARIABLE }.each do |token|
+      next if token.value !~ /^::#{class_name}::/
+      fixed = token.value.sub(/^::/, '')
+      notify(
+        :warning,
+        message: "use $#{fixed} instead of $#{token.value}",
+        line: token.line,
+        column: token.column,
+        token: token
+      )
+    end
+  end
+
+  def fix(problem)
+    problem[:token].value.sub!(/^::/, '')
+  end
+end

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

@@ -0,0 +1,183 @@
+require 'spec_helper'
+
+describe 'topscope_variable' do
+  let(:msg) { 'use $foo::bar instead of $::foo::bar' }
+  context 'with fix disabled' do
+    context 'with correct topscope' do
+      let(:code) do
+        <<-PUP.strip_heredoc
+          class foo::blub {
+            notify { 'foo':
+              message => $foo::bar
+            }
+          }
+        PUP
+      end
+
+      it 'should not detect any problems' do
+        expect(problems).to have(0).problem
+      end
+    end
+
+    context 'with incorrect topscope' do
+      let(:code) do
+        <<-PUP.strip_heredoc
+          class foo::blub {
+            notify { 'foo':
+              message => $::foo::bar
+            }
+          }
+        PUP
+      end
+
+      it 'should detect one problem' do
+        expect(problems).to have(1).problem
+      end
+    end
+
+    context 'with correct topscope in params' do
+      let(:code) do
+        <<-PUP.strip_heredoc
+          class foo::blub(
+            String $foo = $params::foo
+          ) {
+            # ...
+          }
+        PUP
+      end
+
+      it 'should not detect any problems' do
+        expect(problems).to have(0).problem
+      end
+    end
+
+    context 'with incorrect topscope in params' do
+      let(:code) do
+        <<-PUP.strip_heredoc
+          class foo::blub(
+            String $foo = $::foo::params::foo
+          ) {
+            # ...
+          }
+        PUP
+      end
+
+      it 'should detect one problem' do
+        expect(problems).to have(1).problem
+      end
+    end
+
+    context 'with a fact that has been used improperly' do
+      let(:code) do
+        <<-PUP.strip_heredoc
+          class foo::blub {
+            notify { 'foo':
+              message => $blub::bar
+            }
+          }
+        PUP
+      end
+
+      it 'should not detect any problems' do
+        expect(problems).to have(0).problem
+      end
+    end
+  end
+
+  context 'with fix enabled' do
+    before do
+      PuppetLint.configuration.fix = true
+    end
+
+    after do
+      PuppetLint.configuration.fix = false
+    end
+
+    context 'with correct topscope' do
+      let(:code) do
+        <<-PUP.strip_heredoc
+          class foo::blub {
+            notify { 'foo':
+              message => $foo::bar
+            }
+          }
+        PUP
+      end
+
+      it 'should not detect any problems' do
+        expect(problems).to have(0).problem
+      end
+    end
+
+    context 'with incorrect topscope' do
+      let(:code) do
+        <<-PUP.strip_heredoc
+          class foo::blub {
+            notify { 'foo':
+              message => $::foo::bar
+            }
+          }
+        PUP
+      end
+
+      it 'should detect one problem' do
+        expect(problems).to have(1).problem
+      end
+
+      it 'should fix the problem' do
+        expect(problems).to contain_fixed(msg).on_line(3).in_column(16)
+      end
+
+      it 'should remove :: after the $' do
+        expect(manifest).to eq <<-PUP.strip_heredoc
+          class foo::blub {
+            notify { 'foo':
+              message => $foo::bar
+            }
+          }
+        PUP
+      end
+    end
+
+    context 'with incorrect topscope in quoted variable' do
+      let(:code) do
+        <<-PUP.strip_heredoc
+          class foo::blub {
+            notify { 'foo':
+              message => ">${::foo::bar}<"
+            }
+          }
+        PUP
+      end
+
+      it 'should detect one problem' do
+        expect(problems).to have(1).problem
+      end
+
+      it 'should fix the problem' do
+        expect(problems).to contain_fixed(msg).on_line(3).in_column(19)
+      end
+
+      # it 'should remove :: after the $' do
+      #   expect(manifest).to eq <<-PUP.strip_heredoc
+      #     class foo::blub {
+      #       notify { 'foo':
+      #         message => ">${foo::bar}<"
+      #       }
+      #     }
+      #   PUP
+      # end
+    end
+  end
+
+  context 'without a class scope' do
+    let(:code) do
+      <<-PUP.strip_heredoc
+        include ::foo
+      PUP
+    end
+    it 'should not detect any problems' do
+      expect(problems).to have(0).problem
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,13 @@
+require 'coveralls'
+Coveralls.wear!
+
+require 'puppet-lint'
+PuppetLint::Plugins.load_spec_helper
+
+# strip left spaces from heredoc
+# this emulates the behaviour of the ~ heredoc from ruby 2.3
+class String
+  def strip_heredoc
+    gsub(/^#{scan(/^\s*/).min_by(&:length)}/, '')
+  end
+end

metadata

@@ -0,0 +1,149 @@
+--- !ruby/object:Gem::Specification
+name: puppet-lint-topscope-variable-check
+version: !ruby/object:Gem::Version
+  version: 1.0.1
+platform: ruby
+authors:
+- Martin Merfort
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-04-12 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: coveralls
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.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: '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.58'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.58'
+description: "    A puppet-lint plugin to check that topscope variable names don't
+  start with ::.\n"
+email: platformengineering@sixt.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- lib/puppet-lint/plugins/topscope_variable.rb
+- spec/puppet-lint/plugins/topscope_variable_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/Sixt/puppet-lint-topscope-variable-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.7.8
+signing_key: 
+specification_version: 4
+summary: A puppet-lint plugin to check topscope variables.
+test_files:
+- spec/spec_helper.rb
+- spec/puppet-lint/plugins/topscope_variable_spec.rb