puppet-lint-global_definition-check 0.4.1 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f5908dbc45cdfa0b23c1118581382b3b94b04d8e3698f97dfee048f88cc86afc
-  data.tar.gz: 126e6ae65e6ece7de91b78f6dcb231ed6d2afaa82ae92be496b58c7cb9e8cf68
+  metadata.gz: edfa4379a68cd98b941f2156587b388d2de7300e05355d012e3d98390195a2e8
+  data.tar.gz: 36b7d81094a0fea0762cc435de4b445e9917f051fae7cebc826d1f46dba4b0f6
 SHA512:
-  metadata.gz: 697fca75eb244e8e6e86d7320538069da3682aa0a5093a4ef39cb16dd7c6c13c410dd595bfb33d76f31f709c61ad69230451aa913ec293b932f7968702da6484
-  data.tar.gz: 3de93b7fc97a05f656e54388ad7fb13aa377071450ee94f7f5dd46ea7fd06959b4a8bd90ca50530d0a601fd7b9a23764c12836fa217417a824de0c31f49fd33e
+  metadata.gz: 2d5690c151f070e3b408149b24786b776a7b6d2162e97fedcba2b8f50b9084cda8928cea7cb6c397ea16afb20dce278b0c4a226dd3d5a2ff539487a3dbb64ef9
+  data.tar.gz: 719e6c2dab89070dbce14cf0acc03549f6004302af15e412a8baf0d6328e0e25f9821657c419299160d6be6c87508de882658c0113467988cced6aad5c26dc94

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

@@ -1,34 +1,78 @@
 module PuppetLintGlobalDefinionCheck
   private
 
-  def check_for_global_token(type, value = nil)
-    global_tokens.each_with_index do |token, i|
+  def check_for_global_token(type)
+    global_tokens.each do |token|
       next unless token.type == type
-      next unless value.nil? || token.value == value
 
-      message = value.nil? ? token.value : "#{token.value} #{token.next_code_token.value}"
+      message = yield(token)
+      next unless message
 
       notify :error,
-        message: "definition #{message} in global space",
+        message: "#{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 } }
+    @global_tokens ||= tokens.reject.with_index { |_, i| safe_ranges.any? { |s| s[0] < i && s[1] > i } }
   end
 
-  def secure_ranges
-    return @secure_ranges if @secure_ranges
+  def custom_functions_indexes
+    # Code adapted from https://github.com/puppetlabs/puppet-lint/blob/dcff4a1b8d3bf5c15762db826967dd03200626be/lib/puppet-lint/data.rb#L298
+    type = :FUNCTION
+    result = []
+    tokens.each_with_index do |token, i|
+      next unless token.type == type
+
+      brace_depth = 0
+      paren_depth = 0
+      in_params = false
+      return_type = nil
+      tokens[i + 1..-1].each_with_index do |definition_token, j|
+        case definition_token.type
+        when :LPAREN
+          in_params = true if paren_depth.zero? && brace_depth.zero?
+          paren_depth += 1
+        when :RPAREN
+          in_params = false if paren_depth == 1 && brace_depth.zero?
+          paren_depth -= 1
+        when :RSHIFT
+          return_type = definition_token.next_code_token unless definition_token.next_code_token.nil? || definition_token.next_code_token.type != :TYPE
+        when :LBRACE
+          brace_depth += 1
+        when :RBRACE
+          brace_depth -= 1
+          if brace_depth.zero? && !in_params && (token.next_code_token.type != :LBRACE)
+            result << {
+              start: i,
+              end: i + j + 1,
+              tokens: tokens[i..(i + j + 1)],
+              param_tokens: PuppetLint::Data.param_tokens(tokens[i..(i + j + 1)]),
+              type: type,
+              name_token: token.next_code_token,
+              return_type: return_type
+            }
+            break
+          end
+        end
+      end
+    end
+    result
+  end
 
-    @secure_ranges = []
+  def safe_ranges
+    return @safe_ranges if @safe_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]] }
+    @safe_ranges = []
 
-    @secure_ranges
+    class_indexes.each { |c| @safe_ranges << [c[:start], c[:end]] }
+    defined_type_indexes.each { |d| @safe_ranges << [d[:start], d[:end]] }
+    node_indexes.each { |n| @safe_ranges << [n[:start], n[:end]] }
+    custom_functions_indexes.each { |cf| @safe_ranges << [cf[:start], cf[:end]] }
+
+    @safe_ranges
   end
 end
 
@@ -37,12 +81,14 @@ PuppetLint.new_check(:global_resource) do
 
   def check
     check_for_global_resources
-    check_for_global_token(:NAME, "include")
+    check_for_global_token(:NAME) do |token|
+      "#{token.value} #{token.next_code_token.value}" if token.value == "include"
+    end
   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] }
+      next if safe_ranges.any? { |s| s[0] < r[:start] && s[1] > r[:end] }
 
       notify :error,
         message: "resource #{r[:type].value} in global space",
@@ -56,6 +102,8 @@ PuppetLint.new_check(:global_function) do
   include PuppetLintGlobalDefinionCheck
 
   def check
-    check_for_global_token(:FUNCTION_NAME)
+    check_for_global_token(:FUNCTION_NAME) do |token|
+      "function call #{token.value}(...)"
+    end
   end
 end

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

@@ -11,7 +11,7 @@ describe "global_function" do
     end
 
     it "should not detect any problems" do
-      expect(problems).to have(0).problems
+      expect(problems.size).to eq(0)
     end
   end
 
@@ -27,7 +27,21 @@ describe "global_function" do
     end
 
     it "should detect a problem" do
-      expect(problems).to have(1).problems
+      expect(problems.size).to eq(1)
+    end
+  end
+
+  context "custom function definition with function call" do
+    let(:code) do
+      <<-EOS
+      function test_module::test_function() >> Any {
+        function_call()
+      }
+      EOS
+    end
+
+    it "should not detect any problems" do
+      expect(problems.size).to eq(0)
     end
   end
 end

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

@@ -5,7 +5,7 @@ describe "global_resource" do
     let(:code) { "class test { file { 'file': } }" }
 
     it "should not detect any problems" do
-      expect(problems).to have(0).problems
+      expect(problems.size).to eq(0)
     end
   end
 
@@ -13,7 +13,7 @@ describe "global_resource" do
     let(:code) { "define test ($param = undef) { file { 'file': } }" }
 
     it "should not detect any problems" do
-      expect(problems).to have(0).problems
+      expect(problems.size).to eq(0)
     end
   end
 
@@ -21,7 +21,7 @@ describe "global_resource" do
     let(:code) { "node 'test' { file { 'file': } }" }
 
     it "should not detect any problems" do
-      expect(problems).to have(0).problems
+      expect(problems.size).to eq(0)
     end
   end
 
@@ -31,7 +31,7 @@ describe "global_resource" do
     end
 
     it "should detect a problem" do
-      expect(problems).to have(1).problems
+      expect(problems.size).to eq(1)
     end
   end
 
@@ -39,7 +39,7 @@ describe "global_resource" do
     let(:code) { "class test { file { 'file': } } \ninclude testclass" }
 
     it "should detect a problem" do
-      expect(problems).to have(1).problems
+      expect(problems.size).to eq(1)
     end
   end
 
@@ -53,7 +53,7 @@ describe "global_resource" do
     end
 
     it "should not detect any problems" do
-      expect(problems).to have(0).problems
+      expect(problems.size).to eq(0)
     end
   end
 end

metadata

@@ -1,29 +1,35 @@
 --- !ruby/object:Gem::Specification
 name: puppet-lint-global_definition-check
 version: !ruby/object:Gem::Version
-  version: 0.4.1
+  version: 0.5.0
 platform: ruby
 authors:
 - Nine Internet Solutions AG
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-10-05 00:00:00.000000000 Z
+date: 2023-10-23 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.2'
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '2.1'
+        version: '5'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.2'
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '2.1'
+        version: '5'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement