puppet-debugger 0.12.3 → 0.13.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 20cbcc8c5acb05414acfad52a570d33b0654df74
-  data.tar.gz: 578632af5013919bed036a870edc5adb39e45fb3
+SHA256:
+  metadata.gz: 4beafaf71c6a05b596dc06a3c684dea8cfc91bff8a840d28938bf3e0e7229307
+  data.tar.gz: 01cd85bee83b96d48a3631c87478458afeb2821a8bf2592fecc5226261719329
 SHA512:
-  metadata.gz: dc539c9ad25bc62a4dfdd84ed3f8eea856dea32d48e17d84636cee74bf65e8fb0b44777b9ddae604a1357d700f4c4930eb10f315251c442f436580aa520fee7e
-  data.tar.gz: 9cbb54bd720de3cba4bb9fcee94a9444bbeaa910ffd08fb7f84bc679c0d64be5d39f26b12971e7c227f1fae4f93530da8d46d0cb112c4484612cacc48fa4c031
+  metadata.gz: 5a7dd471bdccd178422b141cc01f537004b401b3c31c26dd6559d5d6d9f7b49220205c381e8c2e1dcef1e4b3c1d71a1a2d7baaddc5a4ecde59c9112e02493b17
+  data.tar.gz: 0adf4abdef26c817c780ddcb9e9acd9add6f02b616736daf0cd6238d49eafef240f5d28a741f35babb01c7e6c0c852855da8b9090528c11f6999c8e5e55b8ac4

data/CHANGELOG.md

@@ -1,5 +1,12 @@
 ## Unreleased
 
+## 0.13.0
+
+- Fixes gh-66 - colon symbol vanishing from variable output
+- Adds ability to send content as an option at start
+- Fixes issue where stack traces where not being shown
+- Ensure output goes to proper buffer
+
 ## 0.12.3
 
 - Fixes incorrect puppet namespace when list functions again

data/lib/awesome_print/ext/awesome_puppet.rb

@@ -53,8 +53,8 @@ module AwesomePrint
       else
         h = object.to_hash.merge(name: object.name, title: object.title)
       end
-      res_str = awesome_hash(h)
-      "#{object.class} #{res_str.delete(':')}"
+      res_str = awesome_hash(JSON.parse(h.to_json)) #converting to json removes symbols
+      "#{object.class} #{res_str}"
     end
   end
 end

data/lib/puppet/application/debugger.rb

@@ -1,44 +1,44 @@
 # frozen_string_literal: true
 
-require 'puppet/application'
-require 'optparse'
-require 'puppet/util/command_line'
+require "puppet/application"
+require "optparse"
+require "puppet/util/command_line"
 
 class Puppet::Application::Debugger < Puppet::Application
   attr_reader :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|
     options[:use_facterdb] = true unless options[:node_name]
-    ENV['DEBUGGER_FACTERDB_FILTER'] = arg if arg
+    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| options[:use_facterdb] = false }
+  option("--no-facterdb") { |_arg| options[: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|
     options[:use_facterdb] = false
     options[:node_name] = arg
   end
@@ -178,9 +178,9 @@ Copyright (c) 2019 NWOps
     @options = { use_facterdb: true, play: nil, run_once: false, node_name: nil, quiet: false, help: false, scope: nil }
     @use_stdin = false
     begin
-      require 'puppet-debugger'
+      require "puppet-debugger"
     rescue LoadError => e
-      Puppet.err('You must install the puppet-debugger: gem install puppet-debugger')
+      Puppet.err("You must install the puppet-debugger: gem install puppet-debugger")
     end
   end
 
@@ -191,40 +191,45 @@ Copyright (c) 2019 NWOps
 
     if options[:code]
       code_input = options.delete(:code)
-      file = Tempfile.new(['puppet_repl_input', '.pp'])
-      File.open(file, 'w') do |f|
+      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.empty? && use_stdin
       code_input = STDIN.read
-      file = Tempfile.new(['puppet_repl_input', '.pp'])
-      File.open(file, 'w') do |f|
+      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.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(', ')}") unless command_line.args.empty?
+      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 !options[: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[:scope] = scope
+    begin
+      if !options[: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[:scope] = scope
+      end
+      ::PuppetDebugger::Cli.start_without_stdin(options)
+    rescue Exception => e
+      puts e
+      exit 1
     end
-    ::PuppetDebugger::Cli.start_without_stdin(options)
   end
 
   def create_environment(manifest)
     configured_environment = Puppet.lookup(:current_environment)
     manifest ?
-        configured_environment.override_with(manifest: manifest) :
-        configured_environment
+      configured_environment.override_with(manifest: manifest) :
+      configured_environment
   end
 
   def create_node(environment)
@@ -237,7 +242,7 @@ Copyright (c) 2019 NWOps
       Puppet[:node_name_value] = facts.values[Puppet[:node_name_fact]]
       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]}"
@@ -268,7 +273,7 @@ Copyright (c) 2019 NWOps
       # 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'
+      Puppet.info "puppet debug: refusing to start the debugger without a tty"
     end
   end
 

data/lib/puppet-debugger/cli.rb

@@ -31,6 +31,8 @@ module PuppetDebugger
       @source_file = options[:source_file] || nil
       @source_line_num = options[:source_line] || nil
       @in_buffer = options[:in_buffer] || $stdin
+      Readline.input = @in_buffer
+      Readline.output = @out_buffer
       Readline.completion_append_character = ""
       Readline.basic_word_break_characters = " "
       Readline.completion_proc = command_completion
@@ -236,11 +238,18 @@ or "help" to show the help screen.
     # 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
-    # @option play - must be a path string
+    # @option play [String] - must be a path to a file
+    # @option content [String] - play back the string content passed in
+    # @option source_file [String] - the file from which the breakpoint was used
+    # @option source_line [Integer] - the line in the sourcefile from which the breakpoint was used
+    # @option in_buffer [IO] - the input buffer to read from
+    # @option out_buffer [IO] - the output buffer to write to
+    # @option scope [Scope] - the puppet scope
     def self.start_without_stdin(options = { scope: nil })
-      puts print_repl_desc unless options[:quiet]
-      repl_obj = PuppetDebugger::Cli.new(options)
       options[:play] = options[:play].path if options[:play].respond_to?(:path)
+      repl_obj = PuppetDebugger::Cli.new(options)
+      repl_obj.out_buffer.puts print_repl_desc unless options[:quiet]
+      repl_obj.handle_input(options[:content]) if options[:content]
       # TODO: make the output optional so we can have different output destinations
       repl_obj.handle_input("whereami") if options[:source_file] && options[:source_line]
       repl_obj.handle_input("play #{options[:play]}") if options[:play]
@@ -259,9 +268,9 @@ or "help" to show the help screen.
         opt :quiet, "Do not display banner", required: false, default: false
       end
       options = opts.merge(options)
-      puts print_repl_desc unless options[:quiet]
       options[:play] = options[:play].path if options[:play].respond_to?(:path)
       repl_obj = PuppetDebugger::Cli.new(options)
+      repl_obj.out_buffer.puts print_repl_desc unless options[:quiet]
       if options[:play]
         repl_obj.handle_input("play #{options[:play]}")
       elsif ARGF.filename != "-"

data/lib/puppet-debugger/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module PuppetDebugger
-  VERSION = "0.12.3"
+  VERSION = "0.13.0"
 end

data/spec/awesome_print/ext/awesome_puppet_spec.rb

@@ -0,0 +1,37 @@
+require 'spec_helper'
+require 'awesome_print'
+require "awesome_print/ext/awesome_puppet"
+
+RSpec.describe do
+    let(:output) do
+        StringIO.new
+      end
+    
+      let(:debugger) do
+        PuppetDebugger::Cli.new(options)
+      end
+    
+      let(:options) do
+        {
+            out_buffer: output
+        }
+      end
+    
+      let(:input) do
+        "notify{'ff:gg': }"
+      end
+    
+      let(:resource_type) do
+        debugger.parser.evaluate_string(debugger.scope, input).first
+      end
+
+      let(:ral_type) do
+        debugger.scope.catalog.resource(resource_type.type_name, resource_type.title).to_ral
+      end
+
+      it 'outputs awesomely' do
+        expect(ral_type.ai).to include('ff:gg')
+      end
+
+
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: puppet-debugger
 version: !ruby/object:Gem::Version
-  version: 0.12.3
+  version: 0.13.0
 platform: ruby
 authors:
 - Corey Osman
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-05-30 00:00:00.000000000 Z
+date: 2019-08-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: table_print
@@ -193,6 +193,7 @@ files:
 - lib/puppet/application/debugger.rb
 - puppet-debugger.gemspec
 - run_container_test.sh
+- spec/awesome_print/ext/awesome_puppet_spec.rb
 - spec/environment_spec.rb
 - spec/facts_spec.rb
 - spec/fixtures/environments/production/manifests/site.pp
@@ -286,8 +287,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.14.3
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: A repl based debugger for the puppet language