puppet-debugger 0.15.2 → 1.0.0

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

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+# monkey patch in some color effects string methods
+class String
+  def red
+    "\033[31m#{self}\033[0m"
+  end
+
+  def bold
+    "\033[1m#{self}\033[22m"
+  end
+
+  def black
+    "\033[30m#{self}\033[0m"
+  end
+
+  def green
+    "\033[32m#{self}\033[0m"
+  end
+
+  def cyan
+    "\033[36m#{self}\033[0m"
+  end
+
+  def yellow
+    "\033[33m#{self}\033[0m"
+  end
+
+  def warning
+    yellow
+  end
+
+  def fatal
+    red
+  end
+
+  def info
+    green
+  end
+
+  def camel_case
+    return self if self !~ /_/ && self =~ /[A-Z]+.*/
+
+    split('_').map(&:capitalize).join
+  end
+end
+
+# Bolt plans utilize the PAL Script Compiler to compile the code and thus
+# don't store a catalog with the scope.  This is due to not needing the catalog
+# in the scope.  The debugger relies on the catalog being present in the scope
+# and thus uses all the methods to discover various data in the catalog
+# We monkey patch in a catalog here instead of changing our API for simplicity.
+class Puppet::Parser::ScriptCompiler
+  def catalog
+    @catalog ||= Puppet::Resource::Catalog.new(@node_name, @environment, 'bolt')
+  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,41 @@ 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
+
     # @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,
+      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, loaders: scope.compiler.loaders }, 'For puppet-debugger') do
-        # because the repl is not a module we leave the modname blank
+        # 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,7 +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.flatten
+        dirs << Puppet.settings[:vendormoduledir].split(File::PATH_SEPARATOR) if Puppet.settings[:vendormoduledir]
+        dirs << bolt_modules
+        dirs.flatten.compact.uniq
+      end
+
+      def bolt_modules
+        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
@@ -60,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

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

@@ -9,8 +9,6 @@ module PuppetDebugger
       end
     end
 
-
-
     class FatalError < Error
     end
 
@@ -22,9 +20,9 @@ module PuppetDebugger
 
     class ConnectError < Error
       def message
-        out = <<-EOF
-#{data[:message]}
-EOF
+        <<~OUT
+          #{data[:message]}
+        OUT
       end
     end
 
@@ -36,9 +34,9 @@ EOF
 
     class UndefinedNode < FatalError
       def message
-        out = <<-EOF
-Cannot find node with name: #{data[:name]} on remote server
-    EOF
+        <<~OUT
+          Cannot find node with name: #{data[:name]} on remote server
+        OUT
       end
     end
 
@@ -48,36 +46,36 @@ Cannot find node with name: #{data[:name]} on remote server
 
     class NoClassError < FatalError
       def message
-        out = <<-EOF
-#{data[:message]}
-You are missing puppet classes that are required for compilation.
-Please ensure these classes are installed on this machine in any of the following paths:
-#{data[:default_modules_paths]}
-EOF
+        <<~OUT
+          #{data[:message]}
+          You are missing puppet classes that are required for compilation.
+          Please ensure these classes are installed on this machine in any of the following paths:
+          #{data[:default_modules_paths]}
+        OUT
       end
     end
 
     class NodeDefinitionError < FatalError
       def message
-        out = <<-EOF
-You are missing a default node definition in your site.pp that is required for compilation.
-Please ensure you have at least the following default node definition
-  node default {
-    # include classes here
-  }
-in your #{data[:default_site_manifest]} file.
-EOF
+        out = <<~OUT
+          You are missing a default node definition in your site.pp that is required for compilation.
+          Please ensure you have at least the following default node definition
+            node default {
+              # include classes here
+            }
+          in your #{data[:default_site_manifest]} file.
+        OUT
         out.fatal
       end
     end
 
     class AuthError < FatalError
       def message
-        out = <<-EOF
-#{data[:message]}
-You will need to edit your auth.conf or conf.d/auth.conf (puppetserver) to allow node calls.
-EOF
-    end
+        <<~OUT
+          #{data[:message]}
+          You will need to edit your auth.conf or conf.d/auth.conf (puppetserver) to allow node calls.
+        OUT
+      end
     end
   end
 end

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

@@ -46,11 +46,11 @@ module PuppetDebugger
       def node_facts
         node_facts = FacterDB.get_facts(dynamic_facterdb_filter).first
         if node_facts.nil?
-          message = <<-EOS
-Using filter: #{dynamic_facterdb_filter}
-Bad FacterDB filter, please change the filter so it returns a result set.
-See https://github.com/camptocamp/facterdb/#with-a-string-filter
-          EOS
+          message = <<~OUT
+            Using filter: #{dynamic_facterdb_filter}
+            Bad FacterDB filter, please change the filter so it returns a result set.
+            See https://github.com/camptocamp/facterdb/#with-a-string-filter
+          OUT
           raise PuppetDebugger::Exception::BadFilter, message: message
         end
         # fix for when --show-legacy facts are not part of the facter 3 fact set

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

@@ -8,8 +8,6 @@ module PuppetDebugger
       # creates a node object using defaults or gets the remote node
       # object if the remote_node_name is defined
       def create_node
-        Puppet[:trusted_server_facts] = true if Puppet.version.to_f >= 4.1 && Puppet.version.to_f < 6.0
-
         if remote_node_name
           # refetch
           node_obj = set_node_from_name(remote_node_name)
@@ -34,6 +32,7 @@ module PuppetDebugger
           # Collect our facts.
           facts = Puppet::Node::Facts.indirection.find(Puppet[:node_name_value])
           raise "Could not find facts for #{Puppet[:node_name_value]}" unless facts
+
           Puppet[:node_name_value] = facts.values[Puppet[:node_name_fact]]
           facts.name = Puppet[:node_name_value]
         end
@@ -41,6 +40,7 @@ module PuppetDebugger
           # Find our Node
           node = Puppet::Node.indirection.find(Puppet[:node_name_value])
           raise "Could not find node #{Puppet[:node_name_value]}" unless node
+
           # Merge in the facts.
           node.merge(facts.values) if facts
         end
@@ -93,11 +93,8 @@ module PuppetDebugger
       def set_node_from_name(name)
         out_buffer.puts "Fetching node #{name}"
         remote_node = get_remote_node(name)
-        if remote_node && remote_node.parameters.empty?
-          remote_node_name = nil # clear out the remote name
-          raise PuppetDebugger::Exception::UndefinedNode, name: remote_node.name
-        end
-        remote_node_name = remote_node.name
+        raise PuppetDebugger::Exception::UndefinedNode, name: remote_node.name if remote_node&.parameters&.empty?
+
         node_object = convert_remote_node(remote_node)
         set_node(node_object)
       end