puppet-debugger 0.17.0 → 1.2.0

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

@@ -1,12 +1,14 @@
+# frozen_string_literal: true
+
 require 'puppet-debugger/input_responder_plugin'
 module PuppetDebugger
   module InputResponders
     class Exit < InputResponderPlugin
-      COMMAND_WORDS = %w(exit)
-      SUMMARY = 'Quit Puppet Debugger.'
+      COMMAND_WORDS = %w[exit].freeze
+      SUMMARY = 'Quit Puppet Debugger, or use control-d'
       COMMAND_GROUP = :help
 
-      def run(args = [])
+      def run(_args = [])
         exit 0
       end
     end

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

@@ -1,14 +1,16 @@
+# frozen_string_literal: true
+
 require 'puppet-debugger/input_responder_plugin'
 module PuppetDebugger
   module InputResponders
     class FacterdbFilter < InputResponderPlugin
-      COMMAND_WORDS = %w(facterdb_filter ff)
+      COMMAND_WORDS = %w[facterdb_filter ff].freeze
       SUMMARY = 'Set the facterdb filter'
       COMMAND_GROUP = :node
 
       # displays the facterdb filter
       # @param [Array] - args is not used
-      def run(args = [])
+      def run(_args = [])
         debugger.dynamic_facterdb_filter.ai
       end
     end

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

@@ -1,12 +1,14 @@
+# frozen_string_literal: true
+
 require 'puppet-debugger/input_responder_plugin'
 module PuppetDebugger
   module InputResponders
     class Facts < InputResponderPlugin
-      COMMAND_WORDS = %w(facts)
+      COMMAND_WORDS = %w[facts].freeze
       SUMMARY = 'List all the facts associated with the node.'
       COMMAND_GROUP = :node
 
-      def run(args = [])
+      def run(_args = [])
         variables = debugger.node.facts.values
         variables.ai(sort_keys: true, indent: -1)
       end

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

@@ -1,23 +1,25 @@
-require "puppet-debugger/input_responder_plugin"
-require "table_print"
+# frozen_string_literal: true
+
+require 'puppet-debugger/input_responder_plugin'
+require 'table_print'
 require 'fileutils'
 require 'bundler'
 
 module PuppetDebugger
   module InputResponders
     class Functions < InputResponderPlugin
-      COMMAND_WORDS = %w(functions)
-      SUMMARY = "List all the functions available in the environment."
+      COMMAND_WORDS = %w[functions].freeze
+      SUMMARY = 'List all the functions available in the environment.'
       COMMAND_GROUP = :environment
-      FUNC_NATIVE_NAME_REGEX = %r{\Afunction\s([\w\:]+)}
-      FUNC_V4_NAME_REGEX = %r{Puppet\:\:Functions.create_function\s?\(?\:?\'?([\w\:]+)}
+      FUNC_NATIVE_NAME_REGEX = /\Afunction\s([\w\:]+)/.freeze
+      FUNC_V4_NAME_REGEX = /Puppet\:\:Functions.create_function\s?\(?\:?\'?([\w\:]+)/.freeze
 
       def run(args = [])
-        filter = args.first || ""
-        TablePrint::Printer.table_print(sorted_list(filter), [:full_name, :mod_name])
+        filter = args.first || ''
+        TablePrint::Printer.table_print(sorted_list(filter), %i[full_name mod_name])
       end
 
-      def sorted_list(filter = "")
+      def sorted_list(filter = '')
         search = /#{Regexp.escape(filter)}/
         function_map.values.find_all do |v|
           "#{v[:mod_name]}_#{v[:full_name]}" =~ search
@@ -27,7 +29,7 @@ module PuppetDebugger
       # append a () to functions so we know they are functions
       def func_list
         # ideally we should get a list of function names via the puppet loader
-        function_map.map { |name, metadata| "#{metadata[:full_name]}()" }
+        function_map.map { |_name, metadata| "#{metadata[:full_name]}()" }
       end
 
       # @return [Hash] - a map of all the functions
@@ -45,8 +47,8 @@ module PuppetDebugger
       def current_module_dir
         @current_module_dir ||= begin
           File.dirname(::Bundler.default_gemfile)
-        rescue ::Bundler::GemfileNotFound
-          Dir.pwd
+                                rescue ::Bundler::GemfileNotFound
+                                  Dir.pwd
         end
       end
 
@@ -62,26 +64,26 @@ module PuppetDebugger
         namespace = nil
         name = nil
         if file =~ /\.pp/
-          File.readlines(file, :encoding => "UTF-8").find do |line|
+          File.readlines(file, encoding: 'UTF-8').find do |line|
             # TODO: not getting namespace for functio
-            if line.match(FUNC_NATIVE_NAME_REGEX)
-              namespace, name = $1.split("::", 2)
-              name = namespace if name.nil?
-              namespace = "" if namespace == name
-            end
+            next unless line.match(FUNC_NATIVE_NAME_REGEX)
+
+            namespace, name = Regexp.last_match(1).split('::', 2)
+            name = namespace if name.nil?
+            namespace = '' if namespace == name
           end
-        elsif file.include?("lib/puppet/functions")
-          File.readlines(file, :encoding => "UTF-8").find do |line|
-            if line.match(FUNC_V4_NAME_REGEX)
-              namespace, name = $1.split("::", 2)
-              name = namespace if name.nil?
-              namespace = "" if namespace == name
-            end
+        elsif file.include?('lib/puppet/functions')
+          File.readlines(file, encoding: 'UTF-8').find do |line|
+            next unless line.match(FUNC_V4_NAME_REGEX)
+
+            namespace, name = Regexp.last_match(1).split('::', 2)
+            name = namespace if name.nil?
+            namespace = '' if namespace == name
           end
         end
         name ||= File.basename(file, File.extname(file))
         match = file.match('\/(?<mod>[\w\-\.]+)\/(lib|functions|manifests)')
-        summary_match = File.read(file, :encoding => "UTF-8").match(/@summary\s(.*)/)
+        summary_match = File.read(file, encoding: 'UTF-8').match(/@summary\s(.*)/)
         summary = summary_match[1] if summary_match
         # fetch the puppet version if this is a function from puppet gem
         captures = file.match(/(puppet-[\d\.]+)/)
@@ -106,15 +108,15 @@ module PuppetDebugger
       # in the future we may want to utilize the puppet loaders to find these things
       def function_files
         search_dirs = lib_dirs.map do |lib_dir|
-          [File.join(lib_dir, "puppet", "functions", "**", "*.rb"),
-           File.join(lib_dir, "functions", "**", "*.rb"),
-           File.join(File.dirname(lib_dir), "functions", "**", "*.pp"),
-           File.join(lib_dir, "puppet", "parser", "functions", "*.rb")]
+          [File.join(lib_dir, 'puppet', 'functions', '**', '*.rb'),
+           File.join(lib_dir, 'functions', '**', '*.rb'),
+           File.join(File.dirname(lib_dir), 'functions', '**', '*.pp'),
+           File.join(lib_dir, 'puppet', 'parser', 'functions', '*.rb')]
         end
 
         # add puppet lib directories
-        search_dirs << [File.join(puppet_lib_dir, "puppet", "functions", "**", "*.rb"),
-                        File.join(puppet_lib_dir, "puppet", "parser", "functions", "*.rb")]
+        search_dirs << [File.join(puppet_lib_dir, 'puppet', 'functions', '**', '*.rb'),
+                        File.join(puppet_lib_dir, 'puppet', 'parser', 'functions', '*.rb')]
         Dir.glob(search_dirs.flatten)
       end
     end

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,31 @@
+# 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 with line numbers
+      # @example
+      # [
+      #   "/nwops/puppetlabs-peadm/spec/fixtures/modules/peadm/plans/status.pp:23",
+      #   "/nwops/puppetlabs-peadm/spec/fixtures/modules/peadm/plans/status.pp:20"
+      # ]
+      def stacktrace
+        stack = Puppet::Pops::PuppetStack.stacktrace.find_all { |line| !line.include?('unknown') }
+        stack.each_with_object([]) do |item, acc|
+          acc << item.join(':')
+        end
+      end
+    end
+  end
+end