puppet-debugger 0.17.0 → 1.2.0

data/lib/puppet-debugger/code/code_range.rb

@@ -47,13 +47,15 @@ class DebuggerCode
 
     # @return [Integer]
     def find_start_index(lines)
-      return start_line if start_line < 0
+      return start_line if start_line.negative?
+
       lines.index { |loc| loc.lineno >= start_line } || lines.length
     end
 
     # @return [Integer]
     def find_end_index(lines)
-      return end_line if end_line < 0
+      return end_line if end_line.negative?
+
       (lines.index { |loc| loc.lineno > end_line } || 0) - 1
     end
 
@@ -66,4 +68,4 @@ class DebuggerCode
       @start_line = start_line.first
     end
   end
-  end
+end

data/lib/puppet-debugger/code/loc.rb

@@ -76,4 +76,4 @@ class DebuggerCode
       tuple[0] = "#{' ' * distance}#{line}"
     end
   end
-  end
+end

data/lib/puppet-debugger/debugger_code.rb

@@ -164,6 +164,7 @@ class DebuggerCode
   # @return [Code]
   def grep(pattern)
     return self unless pattern
+
     pattern = Regexp.new(pattern)
 
     select do |loc|
@@ -238,6 +239,7 @@ class DebuggerCode
 
   def add_file_reference
     return "From inline code: \n" unless filename
+
     "From file: #{File.basename(filename)}\n"
   end
 

data/lib/puppet-debugger/hooks.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'puppet-debugger/support/errors'
 
 module PuppetDebugger
@@ -18,7 +20,7 @@ module PuppetDebugger
     end
 
     # Ensure that duplicates have their @hooks object.
-    def initialize_copy(orig)
+    def initialize_copy(_orig)
       hooks_dup = @hooks.dup
       @hooks.each do |k, v|
         hooks_dup[k] = v.dup
@@ -37,8 +39,9 @@ module PuppetDebugger
     # @return [PuppetDebugger::Hooks] The receiver.
     # @see {#merge}
     def merge!(other)
-      @hooks.merge!(other.dup.hooks) do |key, array, other_array|
-        temp_hash, output = {}, []
+      @hooks.merge!(other.dup.hooks) do |_key, array, other_array|
+        temp_hash = {}
+        output = []
 
         (array + other_array).reverse_each do |pair|
           temp_hash[pair.first] ||= output.unshift(pair)
@@ -57,7 +60,7 @@ module PuppetDebugger
     # @return [PuppetDebugger::Hooks] a new `PuppetDebugger::Hooks` instance containing a merge of the
     #   contents of two `PuppetDebugger::Hooks` instances.
     def merge(other)
-      self.dup.tap do |v|
+      dup.tap do |v|
         v.merge!(other)
       end
     end
@@ -68,7 +71,7 @@ module PuppetDebugger
     # @param [#call] callable The callable.
     # @yield The block to use as the callable (if no `callable` provided).
     # @return [PuppetDebugger::Hooks] The receiver.
-    def add_hook(event_name, hook_name, callable=nil, &block)
+    def add_hook(event_name, hook_name, callable = nil, &block)
       event_name = event_name.to_s
 
       # do not allow duplicates, but allow multiple `nil` hooks
@@ -77,12 +80,10 @@ module PuppetDebugger
         raise ArgumentError, "Hook with name '#{hook_name}' already defined!"
       end
 
-      if !block && !callable
-        raise ArgumentError, "Must provide a block or callable."
-      end
+      raise ArgumentError, 'Must provide a block or callable.' if !block && !callable
 
       # ensure we only have one anonymous hook
-      @hooks[event_name].delete_if { |h, k| h.nil? } if hook_name.nil?
+      @hooks[event_name].delete_if { |h, _k| h.nil? } if hook_name.nil?
 
       if block
         @hooks[event_name] << [hook_name, block]
@@ -98,7 +99,7 @@ module PuppetDebugger
     # @param [Array] args The arguments to pass to each hook function.
     # @return [Object] The return value of the last executed hook.
     def exec_hook(event_name, *args, &block)
-      @hooks[event_name.to_s].map do |hook_name, callable|
+      @hooks[event_name.to_s].map do |_hook_name, callable|
         begin
           callable.call(*args, &block)
         rescue PuppetDebugger::Exception::Error, ::RuntimeError => e
@@ -118,10 +119,10 @@ module PuppetDebugger
     # @param [Symbol] hook_name The name of the hook
     # @return [#call] a specific hook for a given event.
     def get_hook(event_name, hook_name)
-      hook = @hooks[event_name.to_s].find do |current_hook_name, callable|
+      hook = @hooks[event_name.to_s].find do |current_hook_name, _callable|
         current_hook_name == hook_name
       end
-      hook.last if hook
+      hook&.last
     end
 
     # @param [Symbol] event_name The name of the event.
@@ -167,8 +168,6 @@ module PuppetDebugger
 
     protected
 
-    def hooks
-      @hooks
-    end
+    attr_reader :hooks
   end
-end
+end

data/lib/puppet-debugger/input_responder_plugin.rb

@@ -1,68 +1,70 @@
+# frozen_string_literal: true
+
 require 'singleton'
 require 'puppet-debugger/support/errors'
 require 'forwardable'
 
 module PuppetDebugger
-    class InputResponderPlugin
-      include Singleton
-      extend Forwardable
-      attr_accessor :debugger
-      def_delegators :debugger, :scope, :node, :environment, :loaders, :puppet_environment,
-                     :add_hook, :handle_input, :delete_hook, :puppet_lib_dir
-      def_delegators :scope, :compiler, :catalog
-      def_delegators :node, :facts
+  class InputResponderPlugin
+    include Singleton
+    extend Forwardable
+    attr_accessor :debugger
+    def_delegators :debugger, :scope, :node, :environment, :loaders, :puppet_environment,
+                   :add_hook, :handle_input, :delete_hook, :puppet_lib_dir
+    def_delegators :scope, :compiler, :catalog
+    def_delegators :node, :facts
 
-      # @return [Array[String]] an array of words the user can call the command with
-      def self.command_words
-        self::COMMAND_WORDS
-      end
+    # @return [Array[String]] an array of words the user can call the command with
+    def self.command_words
+      self::COMMAND_WORDS
+    end
 
-      def modules_paths
-        debugger.puppet_environment.full_modulepath
-      end
+    def modules_paths
+      debugger.puppet_environment.full_modulepath
+    end
 
-      # @return [String] a summary of the plugin
-      def self.summary
-        self::SUMMARY
-      end
+    # @return [String] a summary of the plugin
+    def self.summary
+      self::SUMMARY
+    end
 
-      # @return [String] the name of the command group the plugin is in
-      def self.command_group
-        self::COMMAND_GROUP
-      end
+    # @return [String] the name of the command group the plugin is in
+    def self.command_group
+      self::COMMAND_GROUP
+    end
 
-      # @return [Hash] a has of all the details of the plugin
-      def self.details
-        { words: command_words, summary: summary, group: command_group }
-      end
+    # @return [Hash] a has of all the details of the plugin
+    def self.details
+      { words: command_words, summary: summary, group: command_group }
+    end
 
-      # @param buffer_words [Array[String]] a array of words the user has typed in
-      # @return Array[String] - an array of words that will help the user with word completion
-      # By default this returns an empty array, your plugin can chose to override this method in order to
-      # provide the user with a list of key words based on the user's input
-      def self.command_completion(buffer_words)
-        []
-      end
+    # @param buffer_words [Array[String]] a array of words the user has typed in
+    # @return Array[String] - an array of words that will help the user with word completion
+    # By default this returns an empty array, your plugin can chose to override this method in order to
+    # provide the user with a list of key words based on the user's input
+    def self.command_completion(_buffer_words)
+      []
+    end
 
-      # @param args [Array[String]] - an array of arguments to pass to the plugin command
-      # @param debugger PuppetDebugger::Cli  - an instance of the PuppetDebugger::Cli object
-      # @return the output of the plugin command
-      def self.execute(args = [], debugger)
-        instance.debugger = debugger
-        instance.run(args)
-      end
+    # @param args [Array[String]] - an array of arguments to pass to the plugin command
+    # @param debugger PuppetDebugger::Cli  - an instance of the PuppetDebugger::Cli object
+    # @return the output of the plugin command
+    def self.execute(args = [], debugger)
+      instance.debugger = debugger
+      instance.run(args)
+    end
 
-      # @param args [Array[String]] - an array of arguments to pass to the plugin command
-      # @return the output of the plugin command
-      def run(args = [])
-        raise NotImplementedError
-      end
+    # @param args [Array[String]] - an array of arguments to pass to the plugin command
+    # @return the output of the plugin command
+    def run(args = [])
+      raise NotImplementedError
+    end
 
-      # this is the lib directory of this gem
-      # in order to load any puppet functions from this gem we need to add the lib path
-      # of this gem
-      def puppet_debugger_lib_dir
-        File.expand_path(File.join(File.dirname(File.dirname(File.dirname(__FILE__))), 'lib'))
-      end
+    # this is the lib directory of this gem
+    # in order to load any puppet functions from this gem we need to add the lib path
+    # of this gem
+    def puppet_debugger_lib_dir
+      File.expand_path(File.join(File.dirname(File.dirname(File.dirname(__FILE__))), 'lib'))
     end
+  end
 end

data/lib/puppet-debugger/monkey_patches.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # monkey patch in some color effects string methods
 class String
   def red
@@ -38,6 +40,7 @@ class String
 
   def camel_case
     return self if self !~ /_/ && self =~ /[A-Z]+.*/
+
     split('_').map(&:capitalize).join
   end
 end
@@ -51,4 +54,4 @@ class Puppet::Parser::ScriptCompiler
   def catalog
     @catalog ||= Puppet::Resource::Catalog.new(@node_name, @environment, 'bolt')
   end
-end
+end

data/lib/puppet-debugger/plugin_test_helper.rb

@@ -1,5 +1,7 @@
+# frozen_string_literal: true
+
 # https://relishapp.com/rspec/rspec-core/v/3-6/docs/example-groups/shared-examples
-RSpec.shared_examples "plugin_tests" do |parameter|
+RSpec.shared_examples 'plugin_tests' do |_parameter|
   let(:plugin) do
     instance = PuppetDebugger::InputResponders::Commands.plugin_from_command(subject.to_s).instance
     instance.debugger = debugger
@@ -18,20 +20,20 @@ RSpec.shared_examples "plugin_tests" do |parameter|
     {}
   end
 
-  it "commands contant is an array" do
+  it 'commands contant is an array' do
     expect(plugin.class::COMMAND_WORDS).to be_a(Array)
   end
 
-  it "commands must contain at least one word" do
-    expect(plugin.class::COMMAND_WORDS.count).to  be > 0
+  it 'commands must contain at least one word' do
+    expect(plugin.class::COMMAND_WORDS.count).to be > 0
   end
 
-  it "summary must be a string" do
+  it 'summary must be a string' do
     expect(plugin.class::SUMMARY).to be_a(String)
   end
 
   it 'implements run' do
-    expect{plugin.run([])}.not_to raise_error(NotImplementedError)
+    expect { plugin.run([]) }.not_to raise_error
   end
 
   it 'be looked up via any command words' do
@@ -40,5 +42,4 @@ RSpec.shared_examples "plugin_tests" do |parameter|
       expect(actual).to eq(plugin.class)
     end
   end
-
-end
+end

data/lib/puppet-debugger/support.rb

@@ -83,14 +83,14 @@ module PuppetDebugger
         nodes: scope.environment.known_resource_types.nodes.keys
       }
       if sites = scope.environment.known_resource_types.instance_variable_get(:@sites)
-        res[:sites] = scope.environment.known_resource_types.instance_variable_get(:@sites).first
+        res[:sites] = sites
       end
-      if scope.environment.known_resource_types.respond_to?(:applications)
-        res[:applications] = scope.environment.known_resource_types.applications.keys
+      if apps = scope.environment.known_resource_types.respond_to?(:applications)
+        res[:applications] = apps
       end
       # some versions of puppet do not support capabilities
-      if scope.environment.known_resource_types.respond_to?(:capability_mappings)
-        res[:capability_mappings] = scope.environment.known_resource_types.capability_mappings.keys
+      if maps = scope.environment.known_resource_types.respond_to?(:capability_mappings)
+        res[:capability_mappings] = maps
       end
       res
     end
@@ -100,8 +100,8 @@ module PuppetDebugger
       Puppet.initialize_settings
       Puppet[:parser] = 'future' # this is required in order to work with puppet 3.8
       Puppet[:trusted_node_data] = true
-    rescue ArgumentError => e
-    rescue Puppet::DevError => e
+    rescue ArgumentError
+    rescue Puppet::DevError
       # do nothing otherwise calling init twice raises an error
     end
 
@@ -131,31 +131,57 @@ module PuppetDebugger
       ::Puppet::Parser::AST::Hostclass.new('', code: ast_code)
     end
 
+    # @return [String] the path to the manifest file
+    # @param input [String] the manfiest content
+    # @summary creates a manifest file unless one already exist
+    def manifest_file(input)
+      file = Tempfile.new(['puppet_debugger_input', '.pp'])
+      File.open(file, 'w') do |f|
+        f.write(input)
+      end
+      file
+    end
+
+    # @return [Bolt::PuppetDB::Client] 
+    def bolt_pdb_client
+      @bolt_pdb_client ||=
+        begin
+          require 'bolt/logger'
+          require 'bolt/puppetdb'
+          require 'bolt/puppetdb/client'
+          require 'bolt/puppetdb/config'
+          config = Bolt::PuppetDB::Config.load_config({})
+          Bolt::PuppetDB::Client.new(config)
+        rescue LoadError
+          # not puppet 6+
+          nil
+        end
+    end
+
     # @param String - any valid puppet language code
     # @return Object - returns either a string of the result or object from puppet evaulation
-    def puppet_eval(input)
+    def puppet_eval(input, file: nil)
       # in order to add functions to the scope the loaders must be created
       # in order to call native functions we need to set the global_scope
-      ast = generate_ast(input)
       # record the input for puppet to retrieve and reference later
-      file = Tempfile.new(['puppet_debugger_input', '.pp'])
-      File.open(file, 'w') do |f|
-        f.write(input)
-      end
-      Puppet.override({ current_environment: puppet_environment, code: input,
-                        global_scope: scope, loaders: scope.compiler.loaders }, 'For puppet-debugger') do
-        # because the repl is not a module we leave the modname blank
+      manifest_file = file || manifest_file(input)
+      manfifest_content = input || File.read(manifest_file)
+      ast = generate_ast(manfifest_content)
+      Puppet.override({ current_environment: puppet_environment, manifest: manifest_file,
+                        global_scope: scope, bolt_pdb_client: bolt_pdb_client,
+                        loaders: scope.compiler.loaders }, 'For puppet-debugger') do
+        # because the debugger is not a module we leave the modname blank
         scope.environment.known_resource_types.import_ast(ast, '')
 
         exec_hook :before_eval, '', self, self
         if bench
           result = nil
           time = Benchmark.realtime do
-            result = parser.evaluate_string(scope, input, File.expand_path(file))
+            result = parser.evaluate_string(scope, manfifest_content, File.expand_path(manifest_file))
           end
           out = [result, "Time elapsed #{(time * 1000).round(2)} ms"]
         else
-          out = parser.evaluate_string(scope, input, File.expand_path(file))
+          out = parser.evaluate_string(scope, manfifest_content, File.expand_path(manifest_file))
         end
         exec_hook :after_eval, out, self, self
         out

data/lib/puppet-debugger/support/environment.rb

@@ -8,7 +8,7 @@ module PuppetDebugger
       def puppet_environment
         @puppet_environment ||= create_environment
       end
-      alias :environment :puppet_environment
+      alias environment puppet_environment
 
       # returns an array of module directories, generally this is the only place
       # to look for puppet code by default.  This is read from the puppet configuration
@@ -17,13 +17,14 @@ module PuppetDebugger
         # add the puppet-debugger directory so we can load any defined functions
         dirs << File.join(Puppet[:environmentpath], default_puppet_env_name, 'modules') unless Puppet[:environmentpath].empty?
         dirs << Puppet.settings[:basemodulepath].split(File::PATH_SEPARATOR)
+        dirs << Puppet.settings[:vendormoduledir].split(File::PATH_SEPARATOR) if Puppet.settings[:vendormoduledir]
         dirs << bolt_modules
-        dirs.flatten.compact
+        dirs.flatten.compact.uniq
       end
 
       def bolt_modules
-        spec = Gem::Specification.latest_specs.find { |spec| spec.name.eql?('bolt') }
-        bolt_modules = File.join(spec.full_gem_path, 'bolt-modules') if spec
+        spec = Gem::Specification.latest_specs.find { |s| s.name.eql?('bolt') }
+        File.join(spec.full_gem_path, 'bolt-modules') if spec
       end
 
       # returns all the modules paths defined in the environment
@@ -66,7 +67,7 @@ module PuppetDebugger
 
       # currently this is not being used
       def environment_loaders
-        name = compiler.loaders.public_environment_loader.loader_name
+        compiler.loaders.public_environment_loader.loader_name
       end
     end
   end