puppet-debugger 0.6.1 → 0.7.0

data/README.md

@@ -23,16 +23,10 @@
   - [Setting the puppet log level](#setting-the-puppet-log-level)
   - [Remote nodes](#remote-nodes)
     - [Setup](#setup)
-    - [Usage](#usage-1)
-      - [Command line:](#command-line)
-      - [From repl session:](#from-repl-session)
-  - [Auto Complete](#auto-complete)
-  - [Playback support](#playback-support)
-  - [Troubleshooting](#troubleshooting)
-  - [Copyright](#copyright)
 
 <!-- END doctoc generated TOC please keep comment here to allow auto update -->
 [![Gem Version](https://badge.fury.io/rb/puppet-debugger.svg)](https://badge.fury.io/rb/puppet-debugger)
+
 # puppet-debugger
 
 A interactive command line tool for evaluating and debugging the puppet language.
@@ -273,6 +267,9 @@ https://www.puppet-debugger.com/play?content=vars
 Please note the web based debugger only contains a minimal amount of puppet modules.  So its likely
 that your code may not work if using third party modules.  This may change in the future though.
 
+## Development
+ * [Plugin Development Guide](Plugin_development.md)
+ 
 ## Troubleshooting
 Please file an issue so we can track bugs.
 

data/Rakefile

@@ -1,15 +1,16 @@
 # encoding: utf-8
+# frozen_string_literal: true
 
 require 'rubygems'
 require 'bundler'
-require "bundler/gem_tasks"
-require "rake/testtask"
+require 'bundler/gem_tasks'
+require 'rake/testtask'
 
 begin
   Bundler.setup(:default, :development, :test)
 rescue Bundler::BundlerError => e
   $stderr.puts e.message
-  $stderr.puts "Run `bundle install` to install missing gems"
+  $stderr.puts 'Run `bundle install` to install missing gems'
   exit e.status_code
 end
 require 'rake'
@@ -20,11 +21,11 @@ RSpec::Core::RakeTask.new(:spec) do |spec|
   spec.pattern = FileList['spec/**/*_spec.rb']
 end
 
-task :default => :spec
+task default: :spec
 
 require 'rdoc/task'
 Rake::RDocTask.new do |rdoc|
-  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+  version = File.exist?('VERSION') ? File.read('VERSION') : ''
   rdoc.rdoc_dir = 'rdoc'
   rdoc.title = "puppet-debugger #{version}"
   rdoc.rdoc_files.include('README*')

data/bin/pdb

@@ -1,5 +1,6 @@
 #!/usr/bin/env ruby
 # frozen_string_literal: true
+
 require_relative '../lib/puppet-debugger'
 
 PuppetDebugger::Cli.start

data/lib/awesome_print/ext/awesome_puppet.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 module AwesomePrint
   module Puppet
     def self.included(base)

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

@@ -0,0 +1,40 @@
+require 'benchmark'
+require 'puppet-debugger/input_responder_plugin'
+module PuppetDebugger
+  module InputResponders
+    class Benchmark < InputResponderPlugin
+      COMMAND_WORDS = %w(benchmark bm)
+      SUMMARY = 'Benchmark your Puppet code.'
+      COMMAND_GROUP = :tools
+
+      def run(args = [])
+        if args.count > 0
+          enable(false)
+          out = debugger.handle_input(args.first)
+          disable
+          out
+        else
+          status = debugger.bench ? disable : enable(true)
+          "Benchmark Mode #{status}"
+        end
+      end
+
+      private
+
+      def disable
+        debugger.bench = false
+        debugger.extra_prompt = ''
+        'Off'
+      end
+
+      def enable(show_status = false)
+        debugger.bench = true
+        if show_status
+          debugger.extra_prompt = 'BM'
+          'On'
+        end
+      end
+
+    end
+  end
+end

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

@@ -0,0 +1,15 @@
+require 'puppet-debugger/input_responder_plugin'
+module PuppetDebugger
+  module InputResponders
+    class Classes < InputResponderPlugin
+      COMMAND_WORDS = %w(classes)
+      SUMMARY = 'List all the classes current in the catalog.'
+      COMMAND_GROUP = :scope
+
+      def run(args = [])
+        debugger.scope.compiler.catalog.classes.ai
+      end
+
+    end
+  end
+end

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

@@ -0,0 +1,14 @@
+require 'puppet-debugger/input_responder_plugin'
+module PuppetDebugger
+  module InputResponders
+    class Classification < InputResponderPlugin
+      COMMAND_WORDS = %w(classification)
+      SUMMARY = 'Show the classification details of the node.'
+      COMMAND_GROUP = :node
+
+      def run(args = [])
+        debugger.node.classes.ai
+      end
+    end
+  end
+end

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

@@ -0,0 +1,95 @@
+require 'puppet-debugger/input_responder_plugin'
+module PuppetDebugger
+  module InputResponders
+    class Commands < InputResponderPlugin
+      COMMAND_WORDS = %w(commands)
+      SUMMARY = 'List all available commands, aka. this screen'
+      COMMAND_GROUP = :help
+
+      def run(args = [])
+        commands_list
+      end
+
+      def commands_list
+        unless @commands_list
+          @commands_list = ''
+          command_groups.sort.each do |command_group|
+            group_name = command_group[0].to_s.capitalize.bold
+            commands = command_group[1]
+            @commands_list += ' ' + group_name + "\n"
+            commands.sort.each do |command|
+              command_name = command[0]
+              command_description = command[1]
+              @commands_list += format("   %-20s %s\n", command_name, command_description)
+            end
+            @commands_list += "\n"
+          end
+        end
+        @commands_list
+      end
+
+      def command_groups
+        unless @command_groups
+          @command_groups = {}
+          self.class.command_output.each do | item|
+            if @command_groups[item[:group]]
+              @command_groups[item[:group]].merge!({ item[:words].first => item[:summary] })
+            else
+              @command_groups[item[:group]] = { item[:words].first => item[:summary] }
+            end
+          end
+        end
+        @command_groups
+      end
+
+      def self.command_list_regex
+        out = command_list.map {|n| "^#{n}"}.join('|')
+        %r(#{out})
+      end
+
+      def self.command_list
+        command_output.map{|f| f[:words] }.flatten
+      end
+
+      def self.command_output
+        plugins.map(&:details)
+      end
+
+      def self.plugins
+        begin
+          debug_plugins = Pluginator.find('puppet-debugger')
+          debug_plugins["input_responders"]
+        rescue NoMethodError => e
+          raise PuppetDebugger::Exception::InvalidCommand.new(message: "Unsupported gem version.  Please update with: gem update --system")
+        end
+      end
+
+      # @param name [String] - the name of the command that is associated with a plugin
+      # @return [PuppetDebugger::InputResponders::InputResponderPlugin]
+      def self.plugin_from_command(name)
+        p = plugins.find {|p| p::COMMAND_WORDS.include?(name)}
+        raise PuppetDebugger::Exception::InvalidCommand.new(message: "invalid command #{command}") unless p
+        p
+      end
+
+    end
+  end
+end
+
+module Pluginator
+  # a helper for handling name / file / class conversions
+  module NameConverter
+    private
+    # full_name => class
+    def name2class(name)
+      klass = Kernel
+      name.to_s.split(%r{/}).each do |part|
+        klass = klass.const_get(
+            part.capitalize.gsub(/[_-](.)/) { |match| match[1].upcase }
+        )
+      end
+      klass
+    end
+
+  end
+end

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

@@ -0,0 +1,17 @@
+require 'puppet-debugger/input_responder_plugin'
+module PuppetDebugger
+  module InputResponders
+    class Datatypes < InputResponderPlugin
+      COMMAND_WORDS = %w(datatypes)
+      SUMMARY = 'List all the datatypes available in the environment.'
+      COMMAND_GROUP = :environment
+
+      def run(args = [])
+        types = debugger.all_data_types
+        return types.sort.ai if types.instance_of?(Array)
+        types
+      end
+
+    end
+  end
+end

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

@@ -0,0 +1,14 @@
+require 'puppet-debugger/input_responder_plugin'
+module PuppetDebugger
+  module InputResponders
+    class Environment < InputResponderPlugin
+      COMMAND_WORDS = %w(environment)
+      SUMMARY = 'Show the current environment name'
+      COMMAND_GROUP = :context
+
+      def run(args = [])
+        "Puppet Environment: #{debugger.puppet_env_name}"
+      end
+    end
+  end
+end

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

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

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

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

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

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

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

@@ -0,0 +1,15 @@
+require 'puppet-debugger/input_responder_plugin'
+module PuppetDebugger
+  module InputResponders
+    class Functions < InputResponderPlugin
+      COMMAND_WORDS = %w(functions)
+      SUMMARY = 'List all the functions available in the environment.'
+      COMMAND_GROUP = :environment
+
+      def run(args = [])
+        filter = args.first || ''
+        function_map.keys.sort.grep(/^#{Regexp.escape(filter)}/)
+      end
+    end
+  end
+end

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

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

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

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

data/lib/{puppet-debugger/support → plugins/puppet-debugger/input_responders}/play.rb

@@ -1,7 +1,18 @@
-# frozen_string_literal: true
+require 'puppet-debugger/input_responder_plugin'
 module PuppetDebugger
-  module Support
-    module Play
+  module InputResponders
+    class Play < InputResponderPlugin
+      COMMAND_WORDS = %w(play)
+      SUMMARY = 'Playback a file or URL as input.'
+      COMMAND_GROUP = :editing
+
+      def run(args = [])
+        config = {}
+        config[:play] = args.first
+        play_back(config)
+        nil # we don't want to return anything
+      end
+
       def play_back(config = {})
         if config[:play]
           if config[:play] =~ /^http/
@@ -9,7 +20,7 @@ module PuppetDebugger
           elsif File.exist? config[:play]
             play_back_string(File.read(config[:play]))
           else config[:play]
-               out_buffer.puts "puppet-debugger can't play #{config[:play]}'"
+          debugger.out_buffer.puts "puppet-debugger can't play #{config[:play]}'"
           end
         end
       end
@@ -18,23 +29,23 @@ 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/
-          url
-        when /^gitlab.com/
-          if url_data.path =~ /snippets/
-            url += '/raw' 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
+            else
+              url.gsub('blob', 'raw')
+            end
           else
-            url.gsub('blob', 'raw')
-          end
-        else
-          url
+            url
         end
       end
 
@@ -54,18 +65,18 @@ module PuppetDebugger
       end
 
       # plays back the string to the output stream
-      # puts the input to the output as well as the produced output
+      # echos the input and the produced output
       def play_back_string(str)
         full_buffer = ''
         str.split("\n").each do |buf|
           begin
             full_buffer += buf
             # unless this is puppet code, otherwise skip repl keywords
-            if keyword_expression.match(buf)
-              out_buffer.write('>> ')
+            if PuppetDebugger::InputResponders::Commands.command_list_regex.match(buf)
+              debugger.out_buffer.write('>> ')
             else
-              parser.parse_string(full_buffer)
-              out_buffer.write('>> ')
+              debugger.parser.parse_string(full_buffer)
+              debugger.out_buffer.write('>> ')
             end
           rescue Puppet::ParseErrorWithIssue => e
             if multiline_input?(e)
@@ -73,8 +84,8 @@ module PuppetDebugger
               next
             end
           end
-          out_buffer.puts(full_buffer)
-          handle_input(full_buffer)
+          debugger.out_buffer.puts(full_buffer)
+          debugger.handle_input(full_buffer)
           full_buffer = ''
         end
       end