puppet-lint-global_definition-check 0.4.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 83f49eb058c88589fba6ae40663949eedb9d23c76b4b0611b10b138569ad6a91
+  data.tar.gz: 41b8e536eb95df3fdc0d3755dae5195f15bd906dfdd54bb4409cbed17809ec6b
+SHA512:
+  metadata.gz: 16bc7ad6b276ad7491dbc5200929c6bb58e9a13f7af17cb1b6f84782c947e0d61c051a1d4fb9ef603b90c3f91853a5b3427b7da9f59d523b9d0ab3d295c5f234
+  data.tar.gz: a955faeb4f1cef540723ab8f11c37e8c1fe96c3a52566a3c1e8809fe8026dab940b13c9a16b2bd2dc2b4debbc6499bc69e275b8cd052b7e8db0fa6b5b7bcfdec

data/README.md

@@ -0,0 +1,39 @@
+# puppet-lint global definition check
+
+[![rspec](https://github.com/ninech/puppet-lint-global_definition-check/actions/workflows/rspec.yml/badge.svg)](https://github.com/ninech/puppet-lint-global_definition-check/actions/workflows/rspec.yml)
+[![Gem Version](https://badge.fury.io/rb/puppet-lint-global_definition-check.svg)](https://badge.fury.io/rb/puppet-lint-global_definition-check)
+
+## Installation
+
+To use this plugin, add the following like to the Gemfile in your Puppet code
+base and run `bundle install`.
+
+```ruby
+gem "puppet-lint-global_definition-check"
+```
+
+## Usage
+
+This plugin provides a new check to `puppet-lint`.
+
+### global_resource
+
+**--fix support: No**
+
+This check will raise a error for any global resource.
+
+```
+ERROR: resource file in global space on line 19
+```
+
+### global_function
+
+**--fix support: No**
+
+This check will raise a error for any global function.
+
+```
+ERROR: token ensure_resouce in global space on line 19
+```
+
+

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

@@ -0,0 +1,61 @@
+module PuppetLintGlobalDefinionCheck
+  private
+
+  def check_for_global_token(type, value = nil)
+    global_tokens.each_with_index do |token, i|
+      next unless token.type == type
+      next unless value.nil? || token.value == value
+
+      message = value.nil? ? token.value : "#{token.value} #{token.next_code_token.value}"
+
+      notify :error,
+        message: "definition #{message} in global space",
+        line: token.line,
+        column: token.column
+    end
+  end
+
+  def global_tokens
+    @global_tokens ||= tokens.reject.with_index { |_, i| secure_ranges.any? { |s| s[0] < i && s[1] > i } }
+  end
+
+  def secure_ranges
+    return @secure_ranges if @secure_ranges
+
+    @secure_ranges = []
+
+    class_indexes.each { |c| @secure_ranges << [c[:start], c[:end]] }
+    defined_type_indexes.each { |d| @secure_ranges << [d[:start], d[:end]] }
+    node_indexes.each { |n| @secure_ranges << [n[:start], n[:end]] }
+
+    @secure_ranges
+  end
+end
+
+PuppetLint.new_check(:global_resource) do
+  include PuppetLintGlobalDefinionCheck
+
+  def check
+    check_for_global_resources
+    check_for_global_token(:NAME, "include")
+  end
+
+  def check_for_global_resources
+    resource_indexes.each do |r|
+      next if secure_ranges.any? { |s| s[0] < r[:start] && s[1] > r[:end] }
+
+      notify :error,
+        message: "resource #{r[:type].value} in global space",
+        line: r[:type].line,
+        column: r[:type].column
+    end
+  end
+end
+
+PuppetLint.new_check(:global_function) do
+  include PuppetLintGlobalDefinionCheck
+
+  def check
+    check_for_global_token(:FUNCTION_NAME)
+  end
+end

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

@@ -0,0 +1,59 @@
+require "spec_helper"
+
+describe "global_resource" do
+  context "just a class" do
+    let(:code) { "class test { file { 'file': } }" }
+
+    it "should not detect any problems" do
+      expect(problems).to have(0).problems
+    end
+  end
+
+  context "just a define" do
+    let(:code) { "define test ($param = undef) { file { 'file': } }" }
+
+    it "should not detect any problems" do
+      expect(problems).to have(0).problems
+    end
+  end
+
+  context "allow node resources" do
+    let(:code) { "node 'test' { file { 'file': } }" }
+
+    it "should not detect any problems" do
+      expect(problems).to have(0).problems
+    end
+  end
+
+  context "global file" do
+    let(:code) do
+      "file { 'file': } define test ($param = undef) { file { 'file': } }"
+    end
+
+    it "should detect a problem" do
+      expect(problems).to have(1).problems
+    end
+  end
+
+  context "global includes" do
+    let(:code) { "class test { file { 'file': } } \ninclude testclass" }
+
+    it "should detect a problem" do
+      expect(problems).to have(1).problems
+    end
+  end
+
+  context "global defaults" do
+    let(:code) do
+      <<-EOS
+      Exec {
+        path => '/usr/bin:/usr/sbin/:/bin:/sbin',
+      }
+      EOS
+    end
+
+    it "should not detect any problems" do
+      expect(problems).to have(0).problems
+    end
+  end
+end

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

@@ -0,0 +1,33 @@
+require "spec_helper"
+
+describe "global_function" do
+  context "just a function" do
+    let(:code) do
+      <<-EOS
+      class test {
+        ensure_packages(['wordpress']);
+      }
+      EOS
+    end
+
+    it "should not detect any problems" do
+      expect(problems).to have(0).problems
+    end
+  end
+
+  context "global functions" do
+    let(:code) do
+      <<-EOS
+      class test {
+        ensure_packages(['wordpress']);
+      }
+
+      ensure_packages(['wordpress']);
+      EOS
+    end
+
+    it "should detect a problem" do
+      expect(problems).to have(1).problems
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,12 @@
+require "puppet-lint"
+require "simplecov"
+require "simplecov-console"
+
+PuppetLint::Plugins.load_spec_helper
+
+SimpleCov.formatter = SimpleCov::Formatter::Console
+SimpleCov.start do
+  add_filter "/spec"
+  add_filter ".bundle"
+  add_filter "/vendor"
+end

metadata

@@ -0,0 +1,160 @@
+--- !ruby/object:Gem::Specification
+name: puppet-lint-global_definition-check
+version: !ruby/object:Gem::Version
+  version: 0.4.0
+platform: ruby
+authors:
+- Nine Internet Solutions AG
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2023-09-27 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.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+- !ruby/object:Gem::Dependency
+  name: rspec-its
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rspec-collection_matchers
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+- !ruby/object:Gem::Dependency
+  name: rspec-json_expectations
+  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: 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: standardrb
+  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-console
+  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: "    Extends puppet-lint to ensure that your manifests have no global
+  resources.\n"
+email: support@nine.ch
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- lib/puppet-lint/plugins/check_global_definition.rb
+- spec/puppet-lint/plugins/check_global_function_spec.rb
+- spec/puppet-lint/plugins/check_global_resource_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/ninech/puppet-lint-global_definition-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.4.10
+signing_key: 
+specification_version: 4
+summary: puppet-lint checks for global definions
+test_files: []