puppet-ghostbuster 0.9.0 → 1.2.0

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

@@ -8,7 +8,7 @@ class PuppetLint::Checks
       PuppetLint::Data.manifest_lines = content.split("\n", -1)
       PuppetLint::Data.tokens = lexer.tokenise(content)
       PuppetLint::Data.parse_control_comments
-    rescue
+    rescue StandardError
       PuppetLint::Data.tokens = []
     end
   end
@@ -27,9 +27,9 @@ PuppetLint.new_check(:ghostbuster_classes) do
       return if puppetdb.classes.include? title
 
       notify :warning, {
-        :message => "Class #{title} seems unused",
-        :line    => title_token.line,
-        :column  => title_token.column,
+        message: "Class #{title} seems unused",
+        line: title_token.line,
+        column: title_token.column,
       }
     end
   end

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

@@ -8,7 +8,7 @@ class PuppetLint::Checks
       PuppetLint::Data.manifest_lines = content.split("\n", -1)
       PuppetLint::Data.tokens = lexer.tokenise(content)
       PuppetLint::Data.parse_control_comments
-    rescue
+    rescue StandardError
       PuppetLint::Data.tokens = []
     end
   end
@@ -27,11 +27,10 @@ PuppetLint.new_check(:ghostbuster_defines) do
       return if puppetdb.resources.include? type
 
       notify :warning, {
-        :message => "Define #{type} seems unused",
-        :line    => title_token.line,
-        :column  => title_token.column,
+        message: "Define #{type} seems unused",
+        line: title_token.line,
+        column: title_token.column,
       }
     end
   end
 end
-

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

@@ -1,3 +1,5 @@
+require 'puppet-ghostbuster/util'
+
 class PuppetLint::Checks
   def load_data(path, content)
     lexer = PuppetLint::Lexer.new
@@ -6,7 +8,7 @@ class PuppetLint::Checks
       PuppetLint::Data.manifest_lines = content.split("\n", -1)
       PuppetLint::Data.tokens = lexer.tokenise(content)
       PuppetLint::Data.parse_control_comments
-    rescue
+    rescue StandardError
       PuppetLint::Data.tokens = []
     end
   end
@@ -18,37 +20,37 @@ PuppetLint.new_check(:ghostbuster_facts) do
   end
 
   def templates
-    Dir.glob('./**/templates/**/*').select{ |f| File.file? f }
+    Dir.glob('./**/templates/**/*').select { |f| File.file? f }
   end
 
   def check
     m = path.match(%r{.*/([^/]+)/lib/facter/(.+)$})
     return if m.nil?
 
-    File.readlines(path).grep(%r{Facter.add\(["']([^"']+)["']\)}).each do |line|
-      fact_name = line.match(%r{Facter.add\(["']([^"']+)["']\)}).captures[0]
+    File.foreach(path) do |line|
+      if line =~ /Facter.add\(["':](?<fact>[^"'\)]+)["']?\)/
+        fact_name = Regexp.last_match(:fact)
 
-      found = false
+        found = false
 
-      manifests.each do |manifest|
-        found = true if File.readlines(manifest).grep(%r{\$\{?::#{fact_name}\}?}).size > 0
-        found = true if File.readlines(manifest).grep(%r{@#{fact_name}}).size > 0
-        break if found
-      end
+        manifests.each do |manifest|
+          found = true unless PuppetGhostbuster::Util.search_file(manifest, /(\$\{?::#{fact_name}\}?|@#{fact_name})/).nil?
+          break if found
+        end
 
-      templates.each do |template|
-        found = true if File.readlines(template).grep(%r{@#{fact_name}}).size > 0
-        break if found
-      end
+        templates.each do |template|
+          found = true unless PuppetGhostbuster::Util.search_file(template, /@#{fact_name}/).nil?
+          break if found
+        end
+
+        next if found
 
-      unless found
         notify :warning, {
-          :message => "Fact #{fact_name} seems unused",
-          :line    => 1,
-          :column  => 1,
+          message: "Fact #{fact_name} seems unused",
+          line: 1,
+          column: 1,
         }
       end
     end
-
   end
 end

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

@@ -1,4 +1,5 @@
 require 'puppet-ghostbuster/puppetdb'
+require 'puppet-ghostbuster/util'
 
 class PuppetLint::Checks
   def load_data(path, content)
@@ -8,7 +9,7 @@ class PuppetLint::Checks
       PuppetLint::Data.manifest_lines = content.split("\n", -1)
       PuppetLint::Data.tokens = lexer.tokenise(content)
       PuppetLint::Data.parse_control_comments
-    rescue
+    rescue StandardError
       PuppetLint::Data.tokens = []
     end
   end
@@ -30,29 +31,29 @@ PuppetLint.new_check(:ghostbuster_files) do
     return if puppetdb.client.request('', query).data.size > 0
 
     dir_name = File.dirname(file_name)
-    while dir_name != '.' do
+    while dir_name != '.'
       query = "resources[title] {
         (parameters.source = 'puppet:///modules/#{module_name}/#{dir_name}'
          or parameters.source = 'puppet:///modules/#{module_name}/#{dir_name}/')
         and parameters.recurse = true
         and nodes { deactivated is null } }"
       return if puppetdb.client.request('', query).data.size > 0
+
       dir_name = File.dirname(dir_name)
     end
 
     manifests.each do |manifest|
-      return if File.readlines(manifest).grep(%r{["']#{module_name}/#{file_name}["']}).size > 0
-      if match = manifest.match(%r{.*/([^/]+)/manifests/.+$})
-        if match.captures[0] == module_name
-          return if File.readlines(manifest).grep(/["']\$\{module_name\}\/#{file_name}["']/).size > 0
-        end
+      return if PuppetGhostbuster::Util.search_file(manifest, %r{["']#{module_name}/#{file_name}["']})
+
+      if (match = manifest.match(%r{.*/([^/]+)/manifests/.+$})) && (match.captures[0] == module_name) && PuppetGhostbuster::Util.search_file(manifest, %r{["']\$\{module_name\}/#{file_name}["']})
+        return
       end
     end
 
     notify :warning, {
-      :message => "File #{module_name}/#{file_name} seems unused",
-      :line    => 1,
-      :column  => 1,
+      message: "File #{module_name}/#{file_name} seems unused",
+      line: 1,
+      column: 1,
     }
   end
 end

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

@@ -1,3 +1,5 @@
+require 'puppet-ghostbuster/util'
+
 class PuppetLint::Checks
   def load_data(path, content)
     lexer = PuppetLint::Lexer.new
@@ -6,7 +8,7 @@ class PuppetLint::Checks
       PuppetLint::Data.manifest_lines = content.split("\n", -1)
       PuppetLint::Data.tokens = lexer.tokenise(content)
       PuppetLint::Data.parse_control_comments
-    rescue
+    rescue StandardError
       PuppetLint::Data.tokens = []
     end
   end
@@ -18,7 +20,7 @@ PuppetLint.new_check(:ghostbuster_functions) do
   end
 
   def templates
-    Dir.glob('./**/templates/**/*').select{ |f| File.file? f }
+    Dir.glob('./**/templates/**/*').select { |f| File.file? f }
   end
 
   def check
@@ -28,18 +30,17 @@ PuppetLint.new_check(:ghostbuster_functions) do
     function_name = m.captures[0]
 
     manifests.each do |manifest|
-      return if File.readlines(manifest).grep(%r{#{function_name}\(}).size > 0
+      return if PuppetGhostbuster::Util.search_file(manifest, "#{function_name}(")
     end
 
     templates.each do |template|
-      return if File.readlines(template).grep(%r{scope.function_#{function_name}\(}).size > 0
-      return if File.readlines(template).grep(%r{Puppet::Parser::Functions.function\(:#{function_name}}).size > 0
+      return if PuppetGhostbuster::Util.search_file(template, /(Puppet::Parser::Functions\.function\(:|scope\.function_)#{function_name}/)
     end
 
     notify :warning, {
-      :message => "Function #{function_name} seems unused",
-      :line    => 1,
-      :column  => 1,
+      message: "Function #{function_name} seems unused",
+      line: 1,
+      column: 1,
     }
   end
 end

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

@@ -6,72 +6,84 @@ class PuppetLint::Checks
       PuppetLint::Data.manifest_lines = content.split("\n", -1)
       PuppetLint::Data.tokens = lexer.tokenise(content)
       PuppetLint::Data.parse_control_comments
-    rescue
+    rescue StandardError
       PuppetLint::Data.tokens = []
     end
   end
 end
 
 PuppetLint.new_check(:ghostbuster_hiera_files) do
+  def hiera
+    @hiera ||= YAML.load_file(ENV['HIERA_YAML_PATH'] || '/etc/puppetlabs/code/hiera.yaml')
+  end
+
+  def default_datadir
+    hiera.dig('defaults', 'datadir') || 'hieradata'
+  end
+
+  def path_in_datadirs?(path)
+    @data_dirs ||= hiera['hierarchy'].map { |h| (h['datadir'] || default_datadir).chomp('/') }.uniq
+    path.match?(%(./#{Regexp.union(@data_dirs)}/))
+  end
 
   def regexprs
-    hiera_yaml_file = ENV['HIERA_YAML_PATH'] || '/etc/puppetlabs/code/hiera.yaml'
-    hiera = YAML.load_file(hiera_yaml_file)
     regs = {}
-    hiera[:hierarchy].each do |hierarchy|
-      regex = hierarchy.gsub(/%\{(::)?(trusted|server_facts|facts)\.[^\}]+\}/, "(.+)").gsub(/%\{[^\}]+\}/, ".+")
-      facts = hierarchy.match(regex).captures.map { |f| f[/%{(::)?(trusted|server_facts|facts)\.(.+)}/, 3] }
-      regs[regex] = facts
+    hiera['hierarchy'].each do |hierarchy|
+      path_datadir = Regexp.escape((hierarchy['datadir'] || default_datadir).chomp('/'))
+      ([*hierarchy['path']] + [*hierarchy['paths']]).each do |level|
+        level = File.join(path_datadir, level)
+        regex = Regexp.new(level.gsub(/%\{(::)?(trusted|server_facts|facts)\.[^\}]+\}/, '(.+)').gsub(/%\{[^\}]+\}/, '.+'))
+        facts = level.match(regex).captures.map { |f| f[/%{(::)?(trusted|server_facts|facts)\.(.+)}/, 3] }
+        regs[regex] = facts
+      end
     end
     regs
   end
 
   def check
-    return if path.match(%r{./hieradata/.*\.yaml}).nil?
+    return unless path_in_datadirs? path
 
     puppetdb = PuppetGhostbuster::PuppetDB.new
-    _path = path.gsub("./hieradata/", "")
 
     regexprs.each do |k, v|
-      m = _path.match(Regexp.new "#{k}\.yaml")
+      m = path.match(k)
       next if m.nil?
+
       return if m.captures.size == 0
 
       if m.captures.size > 1
         i = 0
-        query = [:'and']
+        query = [:and]
         m.captures.map do |value|
-          if v[i] == 'certname'
-            query << [:'=', v[i], value]
-          else
-            query << [:'=', ['fact', v[i]], value]
-          end
+          query << if v[i] == 'certname'
+                     [:'=', v[i], value]
+                   else
+                     [:'=', ['fact', v[i]], value]
+                   end
           i += 1
         end
+      elsif v[0] == 'certname'
+        query = [:'=', 'certname', m.captures[0]]
       else
-        if v[0] == 'certname'
-          query = [:'=', 'certname', m.captures[0]]
-        else
-          value = if m.captures[0] == 'true'
-                    true
-                  elsif m.captures[0] == 'false'
-                    false
-                  else
-                    m.captures[0]
-                  end
-          query = [:'=', ['fact', v[0]], value]
-        end
+        value = if m.captures[0] == 'true'
+                  true
+                elsif m.captures[0] == 'false'
+                  false
+                else
+                  m.captures[0]
+                end
+        query = [:'=', ['fact', v[0]], value]
       end
 
-      query = [:'and', query, [:'=', 'deactivated', nil]]
+      query = [:and, query, [:'=', 'deactivated', nil]]
 
-      return if puppetdb.client.request('nodes', query ).data.size > 0
+      return if puppetdb.client.request('nodes', query).data.size > 0
     end
 
     notify :warning, {
-      :message => "Hiera File #{_path} seems unused",
-      :line    => 1,
-      :column  => 1,
+      message: "Hiera File #{path} seems unused",
+      line: 1,
+      column: 1,
     }
   end
 end

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

@@ -1,3 +1,5 @@
+require 'puppet-ghostbuster/util'
+
 class PuppetLint::Checks
   def load_data(path, content)
     lexer = PuppetLint::Lexer.new
@@ -6,7 +8,7 @@ class PuppetLint::Checks
       PuppetLint::Data.manifest_lines = content.split("\n", -1)
       PuppetLint::Data.tokens = lexer.tokenise(content)
       PuppetLint::Data.parse_control_comments
-    rescue
+    rescue StandardError
       PuppetLint::Data.tokens = []
     end
   end
@@ -18,7 +20,7 @@ PuppetLint.new_check(:ghostbuster_templates) do
   end
 
   def templates
-    Dir.glob('./**/templates/**/*').select{ |f| File.file? f }
+    Dir.glob('./**/templates/**/*').select { |f| File.file? f }
   end
 
   def check
@@ -28,22 +30,23 @@ PuppetLint.new_check(:ghostbuster_templates) do
     module_name, template_name = m.captures
 
     manifests.each do |manifest|
-      return if File.readlines(manifest).grep(%r{["']#{module_name}/#{template_name}["']}).size > 0
-      if match = manifest.match(%r{.*/([^/]+)/manifests/.+$})
-        if match.captures[0] == module_name
-          return if File.readlines(manifest).grep(/["']\$\{module_name\}\/#{template_name}["']/).size > 0
-        end
+      return if PuppetGhostbuster::Util.search_file(manifest, %r{["']#{module_name}/#{template_name}["']})
+
+      next unless match = manifest.match(%r{.*/([^/]+)/manifests/.+$})
+
+      if match.captures[0] == module_name && PuppetGhostbuster::Util.search_file(manifest, %r{["']\$\{module_name\}/#{template_name}["']})
+        return
       end
     end
 
     templates.each do |template|
-      return if File.readlines(template).grep(%r{scope.function_template\(\['#{module_name}/#{template_name}'\]\)}).size > 0
+      return if PuppetGhostbuster::Util.search_file(template, "scope.function_template(['#{module_name}/#{template_name}'])")
     end
 
     notify :warning, {
-      :message => "Template #{module_name}/#{template_name} seems unused",
-      :line    => 1,
-      :column  => 1,
+      message: "Template #{module_name}/#{template_name} seems unused",
+      line: 1,
+      column: 1,
     }
   end
 end

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

@@ -8,7 +8,7 @@ class PuppetLint::Checks
       PuppetLint::Data.manifest_lines = content.split("\n", -1)
       PuppetLint::Data.tokens = lexer.tokenise(content)
       PuppetLint::Data.parse_control_comments
-    rescue
+    rescue StandardError
       PuppetLint::Data.tokens = []
     end
   end
@@ -29,9 +29,9 @@ PuppetLint.new_check(:ghostbuster_types) do
     return if puppetdb.resources.include? type_name.capitalize
 
     notify :warning, {
-      :message => "Type #{type_name.capitalize} seems unused",
-      :line    => 1,
-      :column  => 1,
+      message: "Type #{type_name.capitalize} seems unused",
+      line: 1,
+      column: 1,
     }
   end
 end

data/puppet-ghostbuster.gemspec

@@ -1,29 +1,31 @@
-# -*- encoding: utf-8 -*-
-$LOAD_PATH.unshift File.expand_path("../lib", __FILE__)
-require "puppet-ghostbuster/version"
+# frozen_string_literal: true
+
+$LOAD_PATH.unshift File.expand_path('lib', __dir__)
+require 'puppet-ghostbuster/version'
 
 Gem::Specification.new do |s|
-  s.name        = "puppet-ghostbuster"
+  s.name        = 'puppet-ghostbuster'
   s.version     = PuppetGhostbuster::VERSION
-  s.authors     = ["Camptocamp"]
-  s.homepage    = "http://github.com/camptocamp/puppet-ghostbuster"
-  s.summary     = "Dead code detector for Puppet"
-  s.description = "Try and find dead code in Puppet receipts"
+  s.authors     = ['Camptocamp', 'Vox Pupuli']
+  s.homepage    = 'http://github.com/voxpupuli/puppet-ghostbuster'
+  s.summary     = 'Dead code detector for Puppet'
+  s.description = 'Try and find dead code in Puppet receipts'
   s.licenses    = 'Apache-2.0'
 
+  s.required_ruby_version = '>= 2.7'
+
   s.files       = `git ls-files`.split("\n")
-  s.test_files  = `git ls-files -- {test,spec,features}/*`.split("\n")
-  s.executables = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.executables = `git ls-files -- bin/*`.split("\n").map { |f| File.basename(f) }
 
-  s.add_development_dependency 'coveralls'
-  s.add_development_dependency 'rake'
+  s.add_development_dependency 'coveralls', '>= 0.8', '< 0.9'
+  s.add_development_dependency 'jgrep', '>= 1.0.0', '< 2.0.0'
+  s.add_development_dependency 'rake', '>= 13.0.0', '< 14.0.0'
   s.add_development_dependency 'rspec', '~> 3.0'
-  s.add_development_dependency 'rspec-its', '~> 1.0'
   s.add_development_dependency 'rspec-collection_matchers', '~> 1.0'
-  s.add_development_dependency 'github_changelog_generator'
-  s.add_development_dependency 'jgrep'
-  s.add_runtime_dependency 'json'
-  s.add_runtime_dependency 'puppet'
-  s.add_dependency         'puppet-lint', '>= 1.0', '< 3.0'
-  s.add_runtime_dependency 'puppetdb-ruby', '>= 1.1.1'
+  s.add_development_dependency 'rspec-its', '~> 1.0'
+  s.add_development_dependency 'voxpupuli-rubocop', '~> 2.4.0'
+  s.add_runtime_dependency 'json', '>= 2.0', '< 3.0'
+  s.add_runtime_dependency 'puppet', '>= 6.0', '< 9.0'
+  s.add_dependency         'puppet-lint', '>= 1.0', '< 5.0'
+  s.add_runtime_dependency 'puppetdb-ruby', '~> 1.1', '>= 1.1.1'
 end

data/spec/fixtures/hiera.yaml

@@ -1,13 +1,18 @@
 ---
-:backends: yaml
-:yaml:
-  :datadir: "/etc/puppetlabs/code/environments/%{environment}/hieradata"
-:hierarchy:
-  - "nodes/%{::trusted.certname}"
-  - "environment/%{server_facts.environment}"
-  - "virtual/%{facts.is_virtual}"
-  - "domain/%{::domain}"
-  - "common"
-:logger: console
-:merge_behavior: native
-:deep_merge_options: {}
+version: 5
+defaults:
+  datadir: data
+hierarchy:
+  - name: "Some other location"
+    datadir: private/
+    path: "nodes/%{trusted.certname}.eyaml"
+
+  - name: "Per-node data (yaml version)"
+    path: "nodes/%{trusted.certname}.yaml"
+
+  - name: "Other YAML hierarchy levels"
+    paths:
+      - "environment/%{server_facts.environment}.yaml"
+      - "virtual/%{facts.is_virtual}.yaml"
+      - "domain/%{domain}.yaml"
+      - "common.yaml"

data/spec/fixtures/modules/foo/lib/facter/asym.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+# Fact is a symbol
+Facter.add(:asym) do
+  setcode do
+    'asym'
+  end
+end

data/spec/fixtures/modules/foo/lib/facter/bar.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # Fact used in manifest
 Facter.add('bar') do
   setcode do

data/spec/fixtures/modules/foo/lib/facter/baz.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # Fact used in template
 Facter.add('baz') do
   setcode do

data/spec/fixtures/modules/foo/lib/facter/foo.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # Fact used in a string
 Facter.add('foo') do
   setcode do

data/spec/fixtures/modules/foo/lib/facter/multi.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # Unused facts
 Facter.add('multi1') do
   setcode do

data/spec/fixtures/modules/foo/lib/facter/quux.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # Fact used in inline_template
 Facter.add('quux') do
   setcode do

data/spec/fixtures/modules/foo/lib/puppet/parser/functions/bar.rb

@@ -1,4 +1,10 @@
-module Puppet::Parser::Functions
-  newfunction(:bar, :type => :rvalue) do |arguments|
+# frozen_string_literal: true
+
+module Puppet
+  module Parser
+    module Functions
+      newfunction(:bar, type: :rvalue) do |arguments|
+      end
+    end
   end
 end

data/spec/fixtures/modules/foo/lib/puppet/parser/functions/baz.rb

@@ -1,4 +1,10 @@
-module Puppet::Parser::Functions
-  newfunction(:baz, :type => :rvalue) do |arguments|
+# frozen_string_literal: true
+
+module Puppet
+  module Parser
+    module Functions
+      newfunction(:baz, type: :rvalue) do |arguments|
+      end
+    end
   end
 end

data/spec/fixtures/modules/foo/lib/puppet/parser/functions/foo.rb

@@ -1,4 +1,10 @@
-module Puppet::Parser::Functions
-  newfunction(:foo, :type => :rvalue) do |arguments|
+# frozen_string_literal: true
+
+module Puppet
+  module Parser
+    module Functions
+      newfunction(:foo, type: :rvalue) do |arguments|
+      end
+    end
   end
 end

data/spec/fixtures/modules/foo/lib/puppet/parser/functions/quux.rb

@@ -1,4 +1,10 @@
-module Puppet::Parser::Functions
-  newfunction(:quux, :type => :rvalue) do |arguments|
+# frozen_string_literal: true
+
+module Puppet
+  module Parser
+    module Functions
+      newfunction(:quux, type: :rvalue) do |arguments|
+      end
+    end
   end
 end

data/spec/fixtures/modules/foo/lib/puppet/type/bar.rb

@@ -1,2 +1,4 @@
+# frozen_string_literal: true
+
 Puppet::Type.newtype(:bar) do
 end

data/spec/fixtures/modules/foo/lib/puppet/type/foo.rb

@@ -1,2 +1,4 @@
+# frozen_string_literal: true
+
 Puppet::Type.newtype(:foo) do
 end

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

@@ -1,26 +1,27 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 
 describe 'ghostbuster_classes' do
-  let(:path) { "./modules/foo/manifests/init.pp" }
+  let(:path) { './modules/foo/manifests/init.pp' }
 
   context 'with fix disabled' do
-
     context 'when class is used' do
-      let(:code) { "class foo {}" }
+      let(:code) { 'class foo {}' }
 
-      it 'should not detect any problem' do
-        expect(problems).to have(0).problems
+      it 'does not detect any problem' do
+        expect(problems.size).to eq(0)
       end
     end
 
     context 'when class is not used' do
-      let(:code) { "class bar {}" }
+      let(:code) { 'class bar {}' }
 
-      it 'should detect one problem' do
-        expect(problems).to have(1).problems
+      it 'detects one problem' do
+        expect(problems.size).to eq(1)
       end
 
-      it 'should create a warning' do
+      it 'creates a warning' do
         expect(problems).to contain_warning('Class Bar seems unused')
       end
     end