puppet-debugger 0.15.2 → 1.0.0

data/lib/plugins/puppet-debugger/input_responders/help.rb

@@ -1,12 +1,14 @@
+# frozen_string_literal: true
+
 require 'puppet-debugger/input_responder_plugin'
 module PuppetDebugger
   module InputResponders
     class Help < InputResponderPlugin
-      COMMAND_WORDS = %w(help)
+      COMMAND_WORDS = %w[help].freeze
       SUMMARY = 'Show the help screen with version information.'
       COMMAND_GROUP = :help
 
-      def run(args = [])
+      def run(_args = [])
         PuppetDebugger::Cli.print_repl_desc
       end
     end

data/lib/plugins/puppet-debugger/input_responders/krt.rb

@@ -1,12 +1,14 @@
+# frozen_string_literal: true
+
 require 'puppet-debugger/input_responder_plugin'
 module PuppetDebugger
   module InputResponders
     class Krt < InputResponderPlugin
-      COMMAND_WORDS = %w(krt)
+      COMMAND_WORDS = %w[krt].freeze
       SUMMARY = 'List all the known resource types.'
       COMMAND_GROUP = :scope
 
-      def run(args = [])
+      def run(_args = [])
         debugger.known_resource_types.ai(sort_keys: true, indent: -1)
       end
     end

data/lib/plugins/puppet-debugger/input_responders/play.rb

@@ -1,8 +1,10 @@
+# frozen_string_literal: true
+
 require 'puppet-debugger/input_responder_plugin'
 module PuppetDebugger
   module InputResponders
     class Play < InputResponderPlugin
-      COMMAND_WORDS = %w(play)
+      COMMAND_WORDS = %w[play].freeze
       SUMMARY = 'Playback a file or URL as input.'
       COMMAND_GROUP = :editing
 
@@ -20,7 +22,7 @@ module PuppetDebugger
           elsif File.exist? config[:play]
             play_back_string(File.read(config[:play]))
           else config[:play]
-          debugger.out_buffer.puts "puppet-debugger can't play #{config[:play]}'"
+               debugger.out_buffer.puts "puppet-debugger can't play #{config[:play]}'"
           end
         end
       end
@@ -29,29 +31,29 @@ module PuppetDebugger
         require 'uri'
         url_data = URI(url)
         case url_data.host
-          when /^gist\.github*/
-            url = url += '.txt' unless url_data.path =~ /raw/
-            url
-          when /^github.com/
-            url.gsub('blob', 'raw') if url_data.path =~ /blob/
-          when /^gist.github.com/
-            url = url += '.txt' unless url_data.path =~ /raw/
+        when /^gist\.github*/
+          url = url += '.txt' unless url_data.path =~ /raw/
+          url
+        when /^github.com/
+          url.gsub('blob', 'raw') if url_data.path =~ /blob/
+        when /^gist.github.com/
+          url = url += '.txt' unless url_data.path =~ /raw/
+          url
+        when /^gitlab.com/
+          if url_data.path =~ /snippets/
+            url += '/raw' unless url_data.path =~ /raw/
             url
-          when /^gitlab.com/
-            if url_data.path =~ /snippets/
-              url += '/raw' unless url_data.path =~ /raw/
-              url
-            else
-              url.gsub('blob', 'raw')
-            end
           else
-            url
+            url.gsub('blob', 'raw')
+          end
+        else
+          url
         end
       end
 
       # opens the url and reads the data
       def fetch_url_data(url)
-        open(url).read
+        URI.open(url).read # open(url).read
       end
 
       def play_back_url(url)
@@ -72,12 +74,8 @@ module PuppetDebugger
           begin
             full_buffer += buf
             # unless this is puppet code, otherwise skip repl keywords
-            if PuppetDebugger::InputResponders::Commands.command_list_regex.match(buf)
-              debugger.out_buffer.write('>> ')
-            else
-              debugger.parser.parse_string(full_buffer)
-              debugger.out_buffer.write('>> ')
-            end
+            debugger.parser.parse_string(full_buffer) unless PuppetDebugger::InputResponders::Commands.command_list_regex.match(buf)
+            debugger.out_buffer.write('>> ')
           rescue Puppet::ParseErrorWithIssue => e
             if debugger.multiline_input?(e)
               full_buffer += "\n"

data/lib/plugins/puppet-debugger/input_responders/reset.rb

@@ -1,19 +1,21 @@
+# frozen_string_literal: true
+
 require 'puppet-debugger/input_responder_plugin'
 module PuppetDebugger
   module InputResponders
     class Reset < InputResponderPlugin
-      COMMAND_WORDS = %w(reset)
+      COMMAND_WORDS = %w[reset].freeze
       SUMMARY = 'Reset the debugger to a clean state.'
       COMMAND_GROUP = :context
 
-      def run(args = [])
+      def run(_args = [])
         debugger.set_scope(nil)
         debugger.set_remote_node_name(nil)
         debugger.set_node(nil)
         debugger.set_facts(nil)
         debugger.set_environment(nil)
         debugger.set_compiler(nil)
-        #debugger.handle_input(":set loglevel #{debugger.log_level}")
+        # debugger.handle_input(":set loglevel #{debugger.log_level}")
         nil
       end
     end

data/lib/plugins/puppet-debugger/input_responders/resources.rb

@@ -1,20 +1,29 @@
+# frozen_string_literal: true
+
 require 'puppet-debugger/input_responder_plugin'
 module PuppetDebugger
   module InputResponders
     class Resources < InputResponderPlugin
-      COMMAND_WORDS = %w(resources)
+      COMMAND_WORDS = %w[resources].freeze
       SUMMARY = 'List all the resources current in the catalog.'
       COMMAND_GROUP = :scope
 
       def run(args = [])
-        res = debugger.scope.compiler.catalog.resources.map do |res|
+        filter = args
+        resources = find_resources(debugger.catalog.resources, filter)
+        modified = resources.map do |res|
           res.to_s.gsub(/\[/, "['").gsub(/\]/, "']") # ensure the title has quotes
         end
-        if !args.first.nil?
-          res[args.first.to_i].ai
-        else
-          output = "Resources not shown in any specific order\n".warning
-          output += res.ai
+        output = "Resources not shown in any specific order\n".warning
+        output + modified.ai
+      end
+
+      def find_resources(resources, filter = [])
+        return resources if filter.nil? || filter.empty?
+
+        filter_string = filter.join(' ').downcase
+        resources.find_all do |resource|
+          resource.name.to_s.downcase.include?(filter_string) || resource.type.to_s.downcase.include?(filter_string)
         end
       end
     end

data/lib/plugins/puppet-debugger/input_responders/set.rb

@@ -1,28 +1,30 @@
+# frozen_string_literal: true
+
 require 'puppet-debugger/input_responder_plugin'
 module PuppetDebugger
   module InputResponders
     class Set < InputResponderPlugin
-      COMMAND_WORDS = %w(set :set)
+      COMMAND_WORDS = %w[set :set].freeze
       SUMMARY = 'Set the a puppet debugger config'
       COMMAND_GROUP = :scope
-      KEYWORDS = %w(node loglevel)
-      LOGLEVELS = %w(debug info)
+      KEYWORDS = %w[node loglevel].freeze
+      LOGLEVELS = %w[debug info].freeze
 
       def self.command_completion(buffer_words)
         next_word = buffer_words.shift
         case next_word
-          when 'loglevel'
-            if buffer_words.count > 0
-              LOGLEVELS.grep(/^#{Regexp.escape(buffer_words.first)}/)
-            else
-              LOGLEVELS
-            end
-          when 'debug', 'info','node'
-            []
-          when nil
-            %w(node loglevel)
+        when 'loglevel'
+          if buffer_words.count.positive?
+            LOGLEVELS.grep(/^#{Regexp.escape(buffer_words.first)}/)
           else
-            KEYWORDS.grep(/^#{Regexp.escape(next_word)}/)
+            LOGLEVELS
+          end
+        when 'debug', 'info', 'node'
+          []
+        when nil
+          %w[node loglevel]
+        else
+          KEYWORDS.grep(/^#{Regexp.escape(next_word)}/)
         end
       end
 
@@ -37,24 +39,24 @@ module PuppetDebugger
         # args = input.split(' ')
         # args.shift # throw away the set
         case input.shift
-          when /node/
-            if name = input.shift
-              output = "Resetting to use node #{name}"
-              debugger.set_scope(nil)
-              debugger.set_node(nil)
-              debugger.set_facts(nil)
-              debugger.set_environment(nil)
-              debugger.set_compiler(nil)
-              set_log_level(debugger.log_level)
-              debugger.set_remote_node_name(name)
-            else
-              debugger.out_buffer.puts 'Must supply a valid node name'
-            end
-          when /loglevel/
-            if level = input.shift
-              set_log_level(level)
-              output = "loglevel #{Puppet::Util::Log.level} is set"
-            end
+        when /node/
+          if name = input.shift
+            output = "Resetting to use node #{name}"
+            debugger.set_scope(nil)
+            debugger.set_node(nil)
+            debugger.set_facts(nil)
+            debugger.set_environment(nil)
+            debugger.set_compiler(nil)
+            set_log_level(debugger.log_level)
+            debugger.set_remote_node_name(name)
+          else
+            debugger.out_buffer.puts 'Must supply a valid node name'
+          end
+        when /loglevel/
+          if level = input.shift
+            set_log_level(level)
+            output = "loglevel #{Puppet::Util::Log.level} is set"
+          end
         end
         output
       end

data/lib/plugins/puppet-debugger/input_responders/stacktrace.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+require 'puppet-debugger/input_responder_plugin'
+module PuppetDebugger
+  module InputResponders
+    class Stacktrace < InputResponderPlugin
+      COMMAND_WORDS = %w[stacktrace].freeze
+      SUMMARY = 'Show the stacktrace for how we got here'
+      COMMAND_GROUP = :tools
+
+      # @return [Array]- returns a array of pp files that are involved in the stacktrace
+      def run(_args = [])
+        s = stacktrace
+        s.empty? ? 'stacktrace not available'.warning : s.ai
+      end
+
+      # @return [Array] - an array of files
+      def stacktrace
+        Puppet::Pops::PuppetStack.stacktrace.find_all { |line| !line.include?('unknown') }
+      end
+    end
+  end
+end

data/lib/plugins/puppet-debugger/input_responders/types.rb

@@ -1,14 +1,16 @@
+# frozen_string_literal: true
+
 require 'puppet-debugger/input_responder_plugin'
 module PuppetDebugger
   module InputResponders
     class Types < InputResponderPlugin
-      COMMAND_WORDS = %w(types)
+      COMMAND_WORDS = %w[types].freeze
       SUMMARY = 'List all the types available in the environment.'
       COMMAND_GROUP = :environment
 
       # @return - returns a list of types available to the environment
       # if a error occurs we we run the types function again
-      def run(args = [])
+      def run(_args = [])
         types
       end
 
@@ -19,6 +21,7 @@ module PuppetDebugger
           Puppet::Type.loadall
           Puppet::Type.eachtype do |t|
             next if t.name == :component
+
             loaded_types << t.name.to_s
           end
           loaded_types.ai
@@ -27,6 +30,7 @@ module PuppetDebugger
           Puppet.info(e.message)
           # prevent more than two calls and recursive loop
           return if caller_locations(1, 10).find_all { |f| f.label == 'types' }.count > 2
+
           types
         end
       end

data/lib/plugins/puppet-debugger/input_responders/vars.rb

@@ -1,26 +1,28 @@
+# frozen_string_literal: true
+
 require 'puppet-debugger/input_responder_plugin'
 module PuppetDebugger
   module InputResponders
     class Vars < InputResponderPlugin
-      COMMAND_WORDS = %w(vars ls)
+      COMMAND_WORDS = %w[vars ls].freeze
       SUMMARY = 'List all the variables in the current scopes.'
       COMMAND_GROUP = :scope
 
       def run(args = [])
         filter = args
         unless filter.empty?
-          parameters = resource_parameters(debugger.scope.catalog.resources, filter)
+          parameters = resource_parameters(debugger.catalog.resources, filter)
           return parameters.ai(sort_keys: true, indent: -1)
         end
         # remove duplicate variables that are also in the facts hash
         variables = debugger.scope.to_hash.delete_if { |key, _value| debugger.node.facts.values.key?(key) }
         variables['facts'] = 'removed by the puppet-debugger' if variables.key?('facts')
         output = 'Facts were removed for easier viewing'.ai + "\n"
-        output += variables.ai(sort_keys: true, indent: -1)
+        output + variables.ai(sort_keys: true, indent: -1)
       end
 
       def resource_parameters(resources, filter = [])
-        find_resources(resources, filter).each_with_object({}) do | resource, acc|
+        find_resources(resources, filter).each_with_object({}) do |resource, acc|
           name = "#{resource.type}[#{resource.name}]"
           acc[name] = parameters_to_h(resource)
           acc
@@ -28,9 +30,9 @@ module PuppetDebugger
       end
 
       def parameters_to_h(resource)
-        resource.parameters.each_with_object({}) do | param, params |
+        resource.parameters.each_with_object({}) do |param, params|
           name = param.first.to_s
-          params[name] = param.last.value
+          params[name] = param.last.respond_to?(:value) ? param.last.value : param.last
           params
         end
       end
@@ -41,7 +43,6 @@ module PuppetDebugger
           resource.name.to_s.downcase.include?(filter_string) || resource.type.to_s.downcase.include?(filter_string)
         end
       end
-
     end
   end
 end

data/lib/plugins/puppet-debugger/input_responders/whereami.rb

@@ -1,8 +1,10 @@
+# frozen_string_literal: true
+
 require 'puppet-debugger/input_responder_plugin'
 module PuppetDebugger
   module InputResponders
     class Whereami < InputResponderPlugin
-      COMMAND_WORDS = %w(whereami)
+      COMMAND_WORDS = %w[whereami].freeze
       SUMMARY = 'Show code surrounding the current context.'
       COMMAND_GROUP = :context
 
@@ -21,8 +23,8 @@ module PuppetDebugger
           else
             code = DebuggerCode.from_file(file, :puppet)
           end
-          return code.with_marker(line_num).around(line_num, num_lines)
-                     .with_line_numbers.with_indentation(5).with_file_reference.to_s
+          code.with_marker(line_num).around(line_num, num_lines)
+              .with_line_numbers.with_indentation(5).with_file_reference.to_s
         end
       end
 

data/lib/puppet-debugger.rb

@@ -9,51 +9,7 @@ require 'puppet/util/log'
 require 'puppet-debugger/debugger_code'
 require 'puppet-debugger/support/errors'
 require 'plugins/puppet-debugger/input_responders/commands'
-
-
-# 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
+require 'puppet-debugger/monkey_patches'
 
 Puppet::Util::Log.newdesttype :buffer do
   require 'puppet/util/colors'