puppet-debugger 0.4.1 → 0.4.2

data/.ruby-version

@@ -0,0 +1 @@
+2.3.1

data/Gemfile

@@ -11,6 +11,11 @@ group :test do
   gem "bundler"
   gem "simplecov", ">= 0"
   gem 'rake'
+  gem 'release_me'
+end
+
+group :validate do
+  gem 'rubocop'
 end
 
 group :development do

data/Gemfile.lock

@@ -2,6 +2,7 @@ GEM
   remote: http://rubygems.org/
   specs:
     CFPropertyList (2.2.8)
+    ast (2.3.0)
     awesome_print (1.7.0)
     coderay (1.1.1)
     diff-lcs (1.2.5)
@@ -17,6 +18,9 @@ GEM
     json (1.8.3)
     json_pure (1.8.3)
     method_source (0.8.2)
+    parser (2.3.2.0)
+      ast (~> 2.2)
+    powerpack (0.1.1)
     pry (0.10.4)
       coderay (~> 1.1.0)
       method_source (~> 0.8.1)
@@ -25,9 +29,11 @@ GEM
       facter (> 2.0, < 4)
       hiera (>= 2.0, < 4)
       json_pure (~> 1.8)
+    rainbow (2.1.0)
     rake (11.2.2)
     rdoc (3.12.2)
       json (~> 1.4)
+    release_me (0.1.1)
     rspec (3.5.0)
       rspec-core (~> 3.5.0)
       rspec-expectations (~> 3.5.0)
@@ -41,12 +47,20 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.5.0)
     rspec-support (3.5.0)
+    rubocop (0.45.0)
+      parser (>= 2.3.1.1, < 3.0)
+      powerpack (~> 0.1)
+      rainbow (>= 1.99.1, < 3.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (~> 1.0, >= 1.0.1)
+    ruby-progressbar (1.8.1)
     simplecov (0.12.0)
       docile (~> 1.1.0)
       json (>= 1.8, < 3)
       simplecov-html (~> 0.10.0)
     simplecov-html (0.10.0)
     slop (3.6.0)
+    unicode-display_width (1.1.1)
 
 PLATFORMS
   ruby
@@ -57,10 +71,12 @@ DEPENDENCIES
   facterdb (~> 0.3)
   json_pure (<= 2.0.1)
   pry
-  puppet (~> 4.3)
+  puppet (>= 3.8)
   rake
   rdoc (~> 3.12)
+  release_me
   rspec
+  rubocop
   simplecov
 
 BUNDLED WITH

data/bin/pdb

@@ -1,4 +1,5 @@
 #!/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,3 +1,4 @@
+# frozen_string_literal: true
 module AwesomePrint
   module Puppet
     def self.included(base)
@@ -10,11 +11,11 @@ module AwesomePrint
     def cast_with_puppet_resource(object, type)
       cast = cast_without_puppet_resource(object, type)
       # check the object to see if it has an acestor (< ) of the specified type
-      if (defined?(::Puppet::Type)) && (object.class < ::Puppet::Type)
+      if defined?(::Puppet::Type) && (object.class < ::Puppet::Type)
         cast = :puppet_type
-      elsif (defined?(::Puppet::Pops::Types)) && (object.class < ::Puppet::Pops::Types)
+      elsif defined?(::Puppet::Pops::Types) && (object.class < ::Puppet::Pops::Types)
         cast = :puppet_type
-      elsif (defined?(::Puppet::Parser::Resource)) && (object.class < ::Puppet::Parser::Resource)
+      elsif defined?(::Puppet::Parser::Resource) && (object.class < ::Puppet::Parser::Resource)
         cast = :puppet_resource
       elsif /Puppet::Pops::Types/.match(object.class.to_s)
         cast = :puppet_type
@@ -30,9 +31,9 @@ module AwesomePrint
     def awesome_puppet_type(object)
       return '' if object.nil?
       return object.to_s unless object.respond_to?(:name) && object.respond_to?(:title)
-      h = object.to_hash.merge(:name => object.name, :title => object.title)
+      h = object.to_hash.merge(name: object.name, title: object.title)
       res_str = awesome_hash(h)
-      "#{object.class} #{res_str.gsub(':', '')}"
+      "#{object.class} #{res_str.delete(':')}"
     end
   end
 end

data/lib/puppet/application/debugger.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'puppet/application'
 require 'optparse'
 require 'puppet/util/command_line'
@@ -5,38 +6,38 @@ require 'puppet/util/command_line'
 class Puppet::Application::Debugger < Puppet::Application
   attr_reader :use_facterdb, :use_stdin
 
-  option("--execute EXECUTE","-e") do |arg|
+  option('--execute EXECUTE', '-e') do |arg|
     options[:code] = arg
   end
 
-  option("--facterdb-filter FILTER") do |arg|
+  option('--facterdb-filter FILTER') do |arg|
     @use_facterdb = true unless options[:node_name]
     ENV['DEBUGGER_FACTERDB_FILTER'] = arg if arg
   end
 
-  option("--test") do |_arg|
+  option('--test') do |_arg|
     options[:quiet] = true
     options[:run_once] = true
     @use_stdin = true
   end
 
-  option("--no-facterdb") { |_arg| @use_facterdb = false }
+  option('--no-facterdb') { |_arg| @use_facterdb = false }
 
-  option("--log-level LEVEL","-l") do |arg|
+  option('--log-level LEVEL', '-l') do |arg|
     Puppet::Util::Log.level = arg.to_sym
   end
 
-  option("--quiet", "-q") { |_arg| options[:quiet] = true }
+  option('--quiet', '-q') { |_arg| options[:quiet] = true }
 
-  option("--play URL", "-p") do |arg|
+  option('--play URL', '-p') do |arg|
     options[:play] = arg
   end
 
-  option("--stdin", "-s") { |_arg| @use_stdin = true }
+  option('--stdin', '-s') { |_arg| @use_stdin = true }
 
-  option("--run-once", '-r') { |_arg| options[:run_once] = true }
+  option('--run-once', '-r') { |_arg| options[:run_once] = true }
 
-  option("--node-name CERTNAME", '-n') do |arg|
+  option('--node-name CERTNAME', '-n') do |arg|
     @use_facterdb = false
     options[:node_name] = arg
   end
@@ -173,7 +174,7 @@ Copyright (c) 2016 NWOps
 
   def app_defaults
     Puppet::Settings.app_defaults_for_run_mode(self.class.run_mode).merge(
-        :name => name
+      name: name
     )
   end
 
@@ -208,26 +209,26 @@ Copyright (c) 2016 NWOps
         f.write(code_input)
       end
       options[:play] = file
-    elsif command_line.args.length == 0 and use_stdin
+    elsif command_line.args.empty? && use_stdin
       code_input = STDIN.read
       file = Tempfile.new(['puppet_repl_input', '.pp'])
       File.open(file, 'w') do |f|
         f.write(code_input)
       end
       options[:play] = file
-    elsif command_line.args.length > 0
+    elsif !command_line.args.empty?
       manifest = command_line.args.shift
       raise "Could not find file #{manifest}" unless Puppet::FileSystem.exist?(manifest)
-      Puppet.warning("Only one file can be used per run.  Skipping #{command_line.args.join(', ')}") if command_line.args.size > 0
+      Puppet.warning("Only one file can be used per run.  Skipping #{command_line.args.join(', ')}") unless command_line.args.empty?
       options[:play] = file
     end
-    if ! use_facterdb and options[:node_name].nil?
+    if !use_facterdb && options[:node_name].nil?
       debug_environment = create_environment(nil)
       Puppet.notice('Gathering node facts...')
       node = create_node(debug_environment)
       scope = create_scope(node)
       # start_debugger(scope)
-      options.merge!({:scope => scope})
+      options[:scope] = scope
     end
     ::PuppetDebugger::Cli.start_without_stdin(options)
   end
@@ -235,7 +236,7 @@ Copyright (c) 2016 NWOps
   def create_environment(manifest)
     configured_environment = Puppet.lookup(:current_environment)
     manifest ?
-        configured_environment.override_with(:manifest => manifest) :
+        configured_environment.override_with(manifest: manifest) :
         configured_environment
   end
 
@@ -250,7 +251,7 @@ Copyright (c) 2016 NWOps
       facts.name = Puppet[:node_name_value]
     end
 
-    Puppet.override({:current_environment => environment}, "For puppet debugger") do
+    Puppet.override({ current_environment: environment }, 'For puppet debugger') do
       # Find our Node
       unless node = Puppet::Node.indirection.find(Puppet[:node_name_value])
         raise "Could not find node #{Puppet[:node_name_value]}"
@@ -275,10 +276,10 @@ Copyright (c) 2016 NWOps
 
   def start_debugger(scope, options = {})
     if $stdout.isatty
-      options = options.merge({:scope => scope})
+      options = options.merge(scope: scope)
       # required in order to use convert puppet hash into ruby hash with symbols
-      options = options.inject({}){|data,(k,v)| data[k.to_sym] = v; data}
-      #options[:source_file], options[:source_line] = stacktrace.last
+      options = options.each_with_object({}) { |(k, v), data| data[k.to_sym] = v; data }
+      # options[:source_file], options[:source_line] = stacktrace.last
       ::PuppetRepl::Cli.start(options)
     else
       Puppet.info 'puppet debug: refusing to start the debugger without a tty'
@@ -292,15 +293,14 @@ Copyright (c) 2016 NWOps
   # for compatibility with older puppet versions
   # The basics behind this are to find the `.pp` file in the list of loaded code
   def stacktrace
-    result = caller().reduce([]) do |memo, loc|
+    result = caller.each_with_object([]) do |loc, memo|
       if loc =~ /\A(.*\.pp)?:([0-9]+):in\s(.*)/
         # if the file is not found we set to code
         # and read from Puppet[:code]
         # $3 is reserved for the stacktrace type
-        memo << [$1.nil? ? :code : $1, $2.to_i]
+        memo << [Regexp.last_match(1).nil? ? :code : Regexp.last_match(1), Regexp.last_match(2).to_i]
       end
       memo
     end.reverse
   end
-
 end

data/lib/puppet-debugger/cli.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'puppet'
 require 'readline'
 require 'json'
@@ -9,23 +10,23 @@ module PuppetDebugger
 
     attr_accessor :settings, :log_level, :in_buffer, :out_buffer, :html_mode
 
-    def initialize(options={})
+    def initialize(options = {})
       @log_level = 'notice'
       @out_buffer = options[:out_buffer] || $stdout
       @html_mode = options[:html_mode] || false
       @source_file = options[:source_file] || nil
       @source_line_num = options[:source_line] || nil
       @in_buffer = options[:in_buffer] || $stdin
-      comp = Proc.new do |s|
+      comp = proc do |s|
         key_words.grep(/^#{Regexp.escape(s)}/)
       end
-      Readline.completion_append_character = ""
-      Readline.basic_word_break_characters = " "
+      Readline.completion_append_character = ''
+      Readline.basic_word_break_characters = ' '
       Readline.completion_proc = comp
       AwesomePrint.defaults = {
-        :html => @html_mode,
-        :sort_keys => true,
-        :indent => 2
+        html: @html_mode,
+        sort_keys: true,
+        indent: 2
       }
       do_initialize
     end
@@ -36,16 +37,16 @@ module PuppetDebugger
       # list so its not explicitly clear what the keyword
       variables = scope.to_hash.keys
       # prepend a :: to topscope variables
-      scoped_vars = variables.map { |k,v| scope.compiler.topscope.exist?(k) ? "$::#{k}" : "$#{k}" }
+      scoped_vars = variables.map { |k, _v| scope.compiler.topscope.exist?(k) ? "$::#{k}" : "$#{k}" }
       # append a () to functions so we know they are functions
-      funcs = function_map.keys.map { |k| "#{k.split('::').last}()"}
+      funcs = function_map.keys.map { |k| "#{k.split('::').last}()" }
       (scoped_vars + funcs + static_responder_list).uniq.sort
     end
 
     # looks up the type in the catalog by using the type and title
     # and returns the resource in ral format
     def to_resource_declaration(type)
-      if type.respond_to?(:type_name) and type.respond_to?(:title)
+      if type.respond_to?(:type_name) && type.respond_to?(:title)
         title = type.title
         type_name = type.type_name
       elsif type_result = /(\w+)\['?(\w+)'?\]/.match(type.to_s)
@@ -57,13 +58,11 @@ module PuppetDebugger
         return type
       end
       res = scope.catalog.resource(type_name, title)
-      if res
-        return res.to_ral
-      end
+      return res.to_ral if res
       # don't return anything or returns nil if item is not in the catalog
     end
 
-    # ruturns a formatted array
+    # returns a formatted array
     def expand_resource_type(types)
       output = [types].flatten.map do |t|
         if t.class.to_s =~ /Puppet::Pops::Types/
@@ -78,9 +77,7 @@ module PuppetDebugger
     def normalize_output(result)
       if result.instance_of?(Array)
         output = expand_resource_type(result)
-        if output.count == 1
-          return output.first
-        end
+        return output.first if output.count == 1
         return output
       elsif result.class.to_s =~ /Puppet::Pops::Types/
         return to_resource_declaration(result)
@@ -91,56 +88,54 @@ module PuppetDebugger
     # this method handles all input and expects a string of text.
     #
     def handle_input(input)
-        raise ArgumentError unless input.instance_of?(String)
-        begin
-          output = ''
-          case input
-          when /^play|^classification|^whereami|^facterdb_filter|^facts|^vars|^functions|^classes|^resources|^krt|^environment|^reset|^help/
-            args = input.split(' ')
-            command = args.shift.to_sym
-            if self.respond_to?(command)
-              output = self.send(command, args)
-            end
-            return out_buffer.puts output
-          when /exit/
-            exit 0
-          when /^:set/
-            output = handle_set(input)
-          when '_'
-            output = " => #{@last_item}"
-          else
-            result = puppet_eval(input)
-            @last_item = result
-            output = normalize_output(result)
-            if output.nil?
-              output = ""
-            else
-              output = output.ai
-            end
-          end
-        rescue LoadError => e
-          output = e.message.fatal
-        rescue Errno::ETIMEDOUT => e
-          output = e.message.fatal
-        rescue ArgumentError => e
-          output = e.message.fatal
-        rescue Puppet::ResourceError => e
-          output = e.message.fatal
-        rescue Puppet::Error => e
-          output = e.message.fatal
-        rescue Puppet::ParseErrorWithIssue => e
-          output = e.message.fatal
-        rescue PuppetDebugger::Exception::FatalError => e
-          output = e.message.fatal
-          out_buffer.puts output
-          exit 1 # this can sometimes causes tests to fail
-        rescue PuppetDebugger::Exception::Error => e
-          output = e.message.fatal
-        end
-        unless output.empty?
-          out_buffer.print " => "
-          out_buffer.puts output unless output.empty?
+      raise ArgumentError unless input.instance_of?(String)
+      begin
+        output = ''
+        case input
+        when /^play|^classification|^whereami|^facterdb_filter|^facts|^vars|^functions|^classes|^resources|^krt|^environment|^reset|^help/
+          args = input.split(' ')
+          command = args.shift.to_sym
+          output = send(command, args) if respond_to?(command)
+          return out_buffer.puts output
+        when /exit/
+          exit 0
+        when /^:set/
+          output = handle_set(input)
+        when '_'
+          output = " => #{@last_item}"
+        else
+          result = puppet_eval(input)
+          @last_item = result
+          output = normalize_output(result)
+          output = if output.nil?
+                     ''
+                   else
+                     output.ai
+                   end
         end
+      rescue LoadError => e
+        output = e.message.fatal
+      rescue Errno::ETIMEDOUT => e
+        output = e.message.fatal
+      rescue ArgumentError => e
+        output = e.message.fatal
+      rescue Puppet::ResourceError => e
+        output = e.message.fatal
+      rescue Puppet::Error => e
+        output = e.message.fatal
+      rescue Puppet::ParseErrorWithIssue => e
+        output = e.message.fatal
+      rescue PuppetDebugger::Exception::FatalError => e
+        output = e.message.fatal
+        out_buffer.puts output
+        exit 1 # this can sometimes causes tests to fail
+      rescue PuppetDebugger::Exception::Error => e
+        output = e.message.fatal
+      end
+      unless output.empty?
+        out_buffer.print ' => '
+        out_buffer.puts output unless output.empty?
+      end
     end
 
     def self.print_repl_desc
@@ -195,15 +190,17 @@ Type "exit", "functions", "vars", "krt", "whereami", "facts", "resources", "clas
       end
     end
 
-    # used to start a repl without attempting to read from stdin
+    # used to start a debugger session without attempting to read from stdin
     # or
+    # this is primarily used by the debug::break() module function and the puppet debugger face
     # @param [Hash] must contain at least the puppet scope object
-    def self.start_without_stdin(options={:scope => nil})
+    def self.start_without_stdin(options = { scope: nil })
       puts print_repl_desc unless options[:quiet]
       repl_obj = PuppetDebugger::Cli.new(options)
       repl_obj.remote_node_name = options[:node_name] if options[:node_name]
       repl_obj.initialize_from_scope(options[:scope])
-      puts repl_obj.whereami if options[:source_file] and options[:source_line]
+      # TODO: make the output optional so we can have different output destinations
+      puts repl_obj.whereami if options[:source_file] && options[:source_line]
       repl_obj.play_back(options) if options[:play]
       repl_obj.read_loop unless options[:run_once]
     end
@@ -212,12 +209,12 @@ Type "exit", "functions", "vars", "krt", "whereami", "facts", "resources", "clas
     # if from stdin, the repl will process the input and exit
     # if from a file, the repl will process the file and continue to prompt
     # @param [Hash] puppet scope object
-    def self.start(options={:scope => nil})
-      opts = Trollop::options do
-        opt :play, "Url or file to load from", :required => false, :type => String
-        opt :run_once, "Evaluate and quit", :required => false, :default => false
-        opt :node_name, "Remote Node to grab facts from", :required => false, :type => String
-        opt :quiet, "Do not display banner", :required => false, :default => false
+    def self.start(options = { scope: nil })
+      opts = Trollop.options do
+        opt :play, 'Url or file to load from', required: false, type: String
+        opt :run_once, 'Evaluate and quit', required: false, default: false
+        opt :node_name, 'Remote Node to grab facts from', required: false, type: String
+        opt :quiet, 'Do not display banner', required: false, default: false
       end
       options = opts.merge(options)
       puts print_repl_desc unless options[:quiet]
@@ -227,18 +224,16 @@ Type "exit", "functions", "vars", "krt", "whereami", "facts", "resources", "clas
       if options[:play]
         repl_obj.play_back(opts)
       # when the user supplied a file name without using the args (stdin)
-      elsif ARGF.filename != "-"
+      elsif ARGF.filename != '-'
         path = File.expand_path(ARGF.filename)
-        repl_obj.play_back(:play => path)
+        repl_obj.play_back(play: path)
       # when the user supplied a file content using stdin, aka. cat,pipe,echo or redirection
-      elsif ARGF.filename == "-" and (not STDIN.tty? and not STDIN.closed?)
+      elsif (ARGF.filename == '-') && (!STDIN.tty? && !STDIN.closed?)
         input = ARGF.read
         repl_obj.handle_input(input)
       end
       # helper code to make tests exit the loop
-      unless options[:run_once]
-        repl_obj.read_loop
-      end
+      repl_obj.read_loop unless options[:run_once]
     end
   end
 end