puppet-lint-module_reference-check 0.1.0 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 165ae50c695f4525d85426dea4ec555b9d4f44b7321f642d86783277319787fb
-  data.tar.gz: 952b6da27bc82a66b29a23df6bae49ecd16e742750a94cb75f0ce0d4646af1f8
+  metadata.gz: 12922e4a40ec5041a4fdbd2859cbacb179d2ad3242a6c536a0396e14eeb21f53
+  data.tar.gz: 11cafcbe2535f7a2275825a53ff3c590e6ebd28c1ae9239775537a139eb6b061
 SHA512:
-  metadata.gz: 96cdff2aed65b20e028d2093dc27668a7b32c8479ad3f552bc9bbdc59f655a6858d3ee2a36713367b949242978cd048854e0cb2c0a2b6cabd6d8c78caf476587
-  data.tar.gz: 124c80e7b55984c5a06d2fc5ecf70e192625d8984003d2f9277fbce6d4130e08028c4ce6140d4ae1105d44e6d155e6d9eee7ec7ef704212a6424204841c3f3ad
+  metadata.gz: 558649a232611019dfec62b41f410086855a19d8014e01e42f742d8007b40253a652d913434624d026055fa287d6716cf10344da0ec26756384c2ec43c357ac2
+  data.tar.gz: 55e2eb095791d72415cd9b09ec4b8adcbe0722f8e6679349ed36bfbf1fe2164087a972ec2794565cba91484265f86a2fb74466451f4591c206a7208e062f98b3

data/README.md

@@ -20,6 +20,9 @@ This checks whether used modules are properly referenced in the comments by thes
   - internal modules
   - modules referenced by features
 
+**Note**: This check can only detect component module usage with the `class` and `include` keywords, but supports
+reference comments to undetectable components modules as well.
+
 ## Usage
 
 To use the plugin, add the following line to the Gemfile:

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

@@ -130,7 +130,7 @@ PuppetLint.new_check(:module_reference) do
       return return_object if captures['name'].match?(%r(https?://))
 
       reference = @workflow.references.select { |ref| ref[:name] == captures['name'] }
-      return warn("Can't find referenced module #{captures['name']}") if reference.empty?
+      return return_object if reference.empty?
 
       return_object[:type] = reference.first[:type]
     else
@@ -146,6 +146,9 @@ PuppetLint.new_check(:module_reference) do
           break
         end
       end
+      comments[index + 1]&.match(/^@note (?<name>.+)$/) do |matchdata|
+        return_object[:name] = matchdata['name']
+      end
     end
     return_object
   end

data/lib/puppet-lint-module_reference-check/reference.rb

@@ -53,7 +53,7 @@ class Reference
     feature_includes = []
     tokens.reject { |token| %i[WHITESPACE NEWLINE INDENT].include? token.type }.each do |token|
       @current_token = token
-      @workflow.got_include if token.value == 'include'
+      @workflow.got_include if token.type == :NAME && token.value == 'include' && token.next_code_token&.type == :NAME
       @workflow.got_class if token.value == 'class'
       @workflow.got_features_start if token.value == 'role::include_features'
       @workflow.got_feature if token.type == :LBRACK && @workflow.current == :awaiting_feature

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

@@ -34,6 +34,67 @@ describe 'module_reference' do
     end
   end
 
+  context 'valid code with reference to unused module' do
+    let(:code) do
+      <<~CODE
+        # @ref apache
+        # @note puppetlabs-apache
+        # @see https://forge.puppet.com/modules/puppetlabs/apache
+        #
+        # @see profile::test
+        #
+        # @see profile::testfeature - Feature "test"
+        class test () {
+          include profile::test
+          class {
+            'apache':
+          }
+          include apache
+        }
+      CODE
+    end
+
+    it 'should detect detect any problems' do
+      expect(problems).to have(0).problems
+    end
+  end
+
+  context 'valid code with correctly sorted reference to undetectable component module' do
+    let(:code) do
+      <<~CODE
+        # @ref foo
+        # @note undetected-a
+        # @see https://forge.puppet.com/modules/undetected/a
+        # @ref bar
+        # @note undetected-b
+        # @see https://forge.puppet.com/modules/undetected/b
+        class test () {
+        }
+      CODE
+    end
+
+    it 'should detect detect any problems' do
+      expect(problems).to have(0).problems
+    end
+  end
+
+  context 'valid code with using include in a different context' do
+    let(:code) do
+      <<~CODE
+        class test () {
+          $a = {
+            include => 'something'
+          }
+          $a.reduce({})
+        }
+      CODE
+    end
+
+    it 'should detect detect any problems' do
+      expect(problems).to have(0).problems
+    end
+  end
+
   context 'code with missing internal link' do
     let(:code) do
       <<~CODE
@@ -165,35 +226,6 @@ describe 'module_reference' do
     end
   end
 
-  context 'code with reference to unused module' do
-    let(:code) do
-      <<~CODE
-        # @ref apache
-        # @note puppetlabs-apache
-        # @see https://forge.puppet.com/modules/puppetlabs/apache
-        #
-        # @see profile::test
-        #
-        # @see profile::testfeature - Feature "test"
-        class test () {
-          include profile::test
-          class {
-            'apache':
-          }
-          include apache
-        }
-      CODE
-    end
-
-    it 'should detect exactly one problem' do
-      expect(problems).to have(1).problems
-    end
-
-    it 'should create a warning' do
-      expect(problems).to contain_warning('Can\'t find referenced module profile::testfeature').on_line(1).in_column(1)
-    end
-  end
-
   context 'code with unsorted component references' do
     let(:code) do
       <<~CODE

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: puppet-lint-module_reference-check
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.3
 platform: ruby
 authors:
 - Dennis Ploeger