puppet-debugger 0.12.0 → 0.12.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e3a943d793cc70f63e92cffc0843d0f4e9dfee03
-  data.tar.gz: 892a71554b9c5e156de87363341c3ef04bc8cc7a
+  metadata.gz: 1d8a6792ac8befb2af4d9769af6b2ef803ae018c
+  data.tar.gz: d23e13a008ddf75f72883db3e79bab7e6cfb8ef8
 SHA512:
-  metadata.gz: 35605789439801670e2899f17de1e10ef8109d6cb998ca6766993ba403dee1ab990a02faf0e43ae619f58c2d6ee2c83fa1b240d9eb9b88d51d2fce9011a8064e
-  data.tar.gz: bb774bc6493905d0fc280c09862e33462e4ea363c081d523b2ac2958f0f03e98a06d46f3593ad26b87e24380bed1131c9b7d233250890f1337069d94fd52613d
+  metadata.gz: cd3c1d7e97f909563ea3d1fa6f08ff836e8fc16732fd151b6f1ab80fce6fd96c1a9199bcc936cb58302340b40c2dd991aa97b60ff06c0729c0a76067bd00dd94
+  data.tar.gz: 1006a7f6453775c5d6b8ed307224fad0236c389bd404c475a9d24b4404153652676504d5c315132306888032f3b98ad138b50e3da296c040fd11c4dfb663501b

data/CHANGELOG.md

@@ -1,5 +1,10 @@
 ## Unreleased
 
+## 0.12.1
+
+- Fixes issue with command completion
+- Fixes unqualified runtime error
+
 ## 0.12.0
 
 - Adds ability to list resource parameters as they were evaluated

data/lib/puppet-debugger/cli.rb

@@ -1,12 +1,14 @@
 # frozen_string_literal: true
 
-require 'puppet'
-require 'readline'
-require 'json'
-require 'puppet-debugger/support'
-require 'pluginator'
-require 'puppet-debugger/hooks'
-require 'forwardable'
+require "puppet"
+require "readline"
+require "json"
+require "puppet-debugger/support"
+require "pluginator"
+require "puppet-debugger/hooks"
+require "forwardable"
+require "plugins/puppet-debugger/input_responders/functions"
+require "plugins/puppet-debugger/input_responders/datatypes"
 
 module PuppetDebugger
   class Cli
@@ -23,19 +25,19 @@ module PuppetDebugger
       Puppet[:static_catalogs] = false unless Puppet.settings[:static_catalogs].nil?
       set_remote_node_name(options[:node_name])
       initialize_from_scope(options[:scope])
-      @log_level = 'notice'
+      @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
-      Readline.completion_append_character = ''
-      Readline.basic_word_break_characters = ' '
+      Readline.completion_append_character = ""
+      Readline.basic_word_break_characters = " "
       Readline.completion_proc = command_completion
       AwesomePrint.defaults = {
         html: @html_mode,
         sort_keys: true,
-        indent: 2
+        indent: 2,
       }
     end
 
@@ -48,7 +50,7 @@ module PuppetDebugger
         next key_words.grep(/^#{Regexp.escape(input)}/) if words.empty?
         first_word = words.shift
         plugins = PuppetDebugger::InputResponders::Commands.plugins.find_all do |p|
-          p::COMMAND_WORDS.find { |word| word.start_with?(first_word)}
+          p::COMMAND_WORDS.find { |word| word.start_with?(first_word) }
         end
         if plugins.count == 1 and /\A#{first_word}\s/.match(Readline.line_buffer)
           plugins.first.command_completion(words)
@@ -69,6 +71,7 @@ module PuppetDebugger
       variables = scope.to_hash.keys
       # prepend a :: to topscope variables
       scoped_vars = variables.map { |k, _v| scope.compiler.topscope.exist?(k) ? "$::#{k}" : "$#{k}" }
+      PuppetDebugger::InputResponders::Functions.instance.debugger = self
       funcs = PuppetDebugger::InputResponders::Functions.instance.func_list
       PuppetDebugger::InputResponders::Datatypes.instance.debugger = self
       (scoped_vars + funcs + static_responder_list + PuppetDebugger::InputResponders::Datatypes.instance.all_data_types).uniq.sort
@@ -93,7 +96,7 @@ module PuppetDebugger
       # don't return anything or returns nil if item is not in the catalog
     end
 
-    # 
+    #
     # @return [Array] - returns a formatted array
     # @param types [Array] - an array or string
     def expand_resource_type(types)
@@ -101,7 +104,7 @@ module PuppetDebugger
     end
 
     def contains_resources?(result)
-      ! Array(result).flatten.find {|r| r.class.to_s =~ /Puppet::Pops::Types/ }.nil?
+      !Array(result).flatten.find { |r| r.class.to_s =~ /Puppet::Pops::Types/ }.nil?
     end
 
     def normalize_output(result)
@@ -125,21 +128,21 @@ module PuppetDebugger
     def handle_input(input)
       raise ArgumentError unless input.instance_of?(String)
       begin
-        output = ''
+        output = ""
         case input.strip
         when PuppetDebugger::InputResponders::Commands.command_list_regex
-          args = input.split(' ')
+          args = input.split(" ")
           command = args.shift
           plugin = PuppetDebugger::InputResponders::Commands.plugin_from_command(command)
           output = plugin.execute(args, self)
           return out_buffer.puts output
-        when '_'
+        when "_"
           output = " => #{@last_item}"
         else
           result = puppet_eval(input)
           @last_item = result
           output = normalize_output(result)
-          output = output.nil? ? '' : output.ai
+          output = output.nil? ? "" : output.ai
         end
       rescue PuppetDebugger::Exception::InvalidCommand => e
         output = e.message.fatal
@@ -161,13 +164,13 @@ module PuppetDebugger
         exit 1 # this can sometimes causes tests to fail
       rescue PuppetDebugger::Exception::Error => e
         output = e.message.fatal
-      rescue RuntimeException => e
+      rescue ::RuntimeError => e
         output = e.message.fatal
         out_buffer.puts output
         exit 1
       end
       unless output.empty?
-        out_buffer.print ' => '
+        out_buffer.print " => "
         out_buffer.puts output unless output.empty?
         exec_hook :after_output, out_buffer, self, self
       end
@@ -206,7 +209,7 @@ or "help" to show the help screen.
     # input
     def read_loop
       line_number = 1
-      full_buffer = ''
+      full_buffer = ""
       while buf = Readline.readline("#{line_number}:#{extra_prompt}>> ", true)
         begin
           full_buffer += buf
@@ -217,14 +220,14 @@ or "help" to show the help screen.
               parser.parse_string(full_buffer)
             rescue Puppet::ParseErrorWithIssue => e
               if multiline_input?(e)
-                out_buffer.print '  '
+                out_buffer.print "  "
                 full_buffer += "\n"
                 next
               end
             end
           end
           handle_input(full_buffer)
-          full_buffer = ''
+          full_buffer = ""
         end
       end
     end
@@ -239,7 +242,7 @@ or "help" to show the help screen.
       repl_obj = PuppetDebugger::Cli.new(options)
       options[:play] = options[:play].path if options[:play].respond_to?(:path)
       # 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("whereami") if options[:source_file] && options[:source_line]
       repl_obj.handle_input("play #{options[:play]}") if options[:play]
       repl_obj.read_loop unless options[:run_once]
     end
@@ -250,10 +253,10 @@ or "help" to show the help screen.
     # @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
+        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]
@@ -261,11 +264,11 @@ or "help" to show the help screen.
       repl_obj = PuppetDebugger::Cli.new(options)
       if options[:play]
         repl_obj.handle_input("play #{options[:play]}")
-      elsif ARGF.filename != '-'
+      elsif ARGF.filename != "-"
         # when the user supplied a file name without using the args (stdin)
         path = File.expand_path(ARGF.filename)
         repl_obj.handle_input("play #{path}")
-      elsif (ARGF.filename == '-') && (!STDIN.tty? && !STDIN.closed?)
+      elsif (ARGF.filename == "-") && (!STDIN.tty? && !STDIN.closed?)
         # when the user supplied a file content using stdin, aka. cat,pipe,echo or redirection
         input = ARGF.read
         repl_obj.handle_input(input)

data/lib/puppet-debugger/input_responder_plugin.rb

@@ -8,7 +8,7 @@ module PuppetDebugger
       extend Forwardable
       attr_accessor :debugger
       def_delegators :debugger, :scope, :node, :environment, :loaders, :puppet_environment,
-                     :add_hook, :handle_input, :delete_hook, :puppet_lib_dir, :modules_paths
+                     :add_hook, :handle_input, :delete_hook, :puppet_lib_dir
       def_delegators :scope, :compiler, :catalog
       def_delegators :node, :facts
 
@@ -17,6 +17,10 @@ module PuppetDebugger
         self::COMMAND_WORDS
       end
 
+      def modules_paths
+        debugger.puppet_environment.full_modulepath
+      end
+
       # @return [String] a summary of the plugin
       def self.summary
         self::SUMMARY

data/lib/puppet-debugger/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module PuppetDebugger
-  VERSION = '0.12.0'
+  VERSION = "0.12.1"
 end

data/spec/puppet_debugger_spec.rb

@@ -1,14 +1,14 @@
 # frozen_string_literal: true
 
-require 'spec_helper'
-require 'stringio'
-describe 'PuppetDebugger' do
+require "spec_helper"
+require "stringio"
+describe "PuppetDebugger" do
   let(:resource) do
     "service{'httpd': ensure => running}"
   end
 
   before(:each) do
-    debugger.handle_input('reset')
+    debugger.handle_input("reset")
   end
 
   let(:output) do
@@ -31,10 +31,10 @@ describe 'PuppetDebugger' do
     debugger.parser.evaluate_string(debugger.scope, input)
   end
 
-  describe 'native classes' do
-    describe 'create' do
+  describe "native classes" do
+    describe "create" do
       let(:input) do
-        'class testfoo {}'
+        "class testfoo {}"
       end
       let(:debugger_output) do
         "\n => Puppet::Type::Component {\n  loglevel\e[0;37m => \e[0m\e[0;36mnotice\e[0m,\n      name\e[0;37m => \e[0m\e[0;33m\"Testfoo\"\e[0m,\n     title\e[0;37m => \e[0m\e[0;33m\"Class[Testfoo]\"\e[0m\n}\n"
@@ -42,45 +42,45 @@ describe 'PuppetDebugger' do
       it do
         debugger.handle_input(input)
         expect(output.string).to eq("\n")
-        expect(debugger.known_resource_types[:hostclasses]).to include('testfoo')
+        expect(debugger.known_resource_types[:hostclasses]).to include("testfoo")
       end
       it do
         debugger.handle_input(input)
-        debugger.handle_input('include testfoo')
-        expect(debugger.scope.compiler.catalog.classes).to include('testfoo')
+        debugger.handle_input("include testfoo")
+        expect(debugger.scope.compiler.catalog.classes).to include("testfoo")
       end
       it do
         debugger.handle_input(input)
-        debugger.handle_input('include testfoo')
-        expect(debugger.scope.compiler.catalog.resources.map(&:name)).to include('Testfoo')
+        debugger.handle_input("include testfoo")
+        expect(debugger.scope.compiler.catalog.resources.map(&:name)).to include("Testfoo")
       end
     end
   end
 
-  describe 'native definitions' do
-    describe 'create' do
+  describe "native definitions" do
+    describe "create" do
       let(:input) do
-        'define testfoodefine {}'
+        "define testfoodefine {}"
       end
       let(:debugger_output) do
         "\n => Puppet::Type::Component {\n  loglevel\e[0;37m => \e[0m\e[0;36mnotice\e[0m,\n      name\e[0;37m => \e[0m\e[0;33m\"some_name\"\e[0m,\n     title\e[0;37m => \e[0m\e[0;33m\"Testfoo[some_name]\"\e[0m\n}\n"
       end
       it do
         debugger.handle_input(input)
-        expect(debugger.scope.environment.known_resource_types.definitions.keys).to include('testfoodefine')
+        expect(debugger.scope.environment.known_resource_types.definitions.keys).to include("testfoodefine")
         expect(output.string).to eq("\n")
       end
       it do
         debugger.handle_input(input)
         debugger.handle_input("testfoodefine{'some_name':}")
-        expect(debugger.scope.compiler.resources.collect(&:name)).to include('some_name')
-        expect(debugger.scope.compiler.resources.collect(&:type)).to include('Testfoodefine')
+        expect(debugger.scope.compiler.resources.collect(&:name)).to include("some_name")
+        expect(debugger.scope.compiler.resources.collect(&:type)).to include("Testfoodefine")
         expect(output.string).to include("\n => Puppet::Type::Component")
       end
     end
   end
 
-  describe 'key_words' do
+  describe "key_words" do
     it do
       expect(debugger.key_words.count).to be >= 30 if supports_datatypes?
     end
@@ -90,7 +90,7 @@ describe 'PuppetDebugger' do
     end
   end
 
-  describe 'native functions', native_functions: true do
+  describe "native functions", native_functions: true do
     let(:func) do
       <<-EOF
       function debugger::bool2http($arg) {
@@ -105,12 +105,12 @@ describe 'PuppetDebugger' do
     before(:each) do
       debugger.handle_input(func)
     end
-    describe 'create' do
-      it 'shows function' do
+    describe "create" do
+      it "shows function" do
         expect(output.string).to eq("\n")
       end
     end
-    describe 'run' do
+    describe "run" do
       let(:input) do
         <<-EOF
         debugger::bool2http(false)
@@ -118,37 +118,31 @@ describe 'PuppetDebugger' do
       end
       it do
         debugger.handle_input(input)
-        expect(output.string).to include('Off')
+        expect(output.string).to include("Off")
       end
     end
   end
 
-
-
-
-
-  describe 'returns a array of resource_types' do
-    it 'returns resource type' do
-      expect(resource_types.first.class.to_s).to eq('Puppet::Pops::Types::PResourceType')
+  describe "returns a array of resource_types" do
+    it "returns resource type" do
+      expect(resource_types.first.class.to_s).to eq("Puppet::Pops::Types::PResourceType")
     end
   end
 
-
-
-  describe 'empty' do
+  describe "empty" do
     let(:input) do
-      ''
+      ""
     end
-    it 'can run' do
+    it "can run" do
       debugger_output = "\n"
       debugger.handle_input(input)
       expect(output.string).to eq(debugger_output)
     end
-    describe 'space' do
+    describe "space" do
       let(:input) do
-        ' '
+        " "
       end
-      it 'can run' do
+      it "can run" do
         debugger_output = "\n"
         debugger.handle_input(input)
         expect(output.string).to eq(debugger_output)
@@ -156,111 +150,114 @@ describe 'PuppetDebugger' do
     end
   end
 
-  describe 'variables' do
+  describe "variables" do
     let(:input) do
       "$file_path = '/tmp/test2.txt'"
     end
-    it 'can process a variable' do
+    it "can process a variable" do
       debugger.handle_input(input)
       expect(output.string).to match(/\/tmp\/test2.txt/)
     end
   end
 
-  describe 'resource' do
+  describe "resource" do
     let(:input) do
       "file{'/tmp/test2.txt': ensure => present, mode => '0755'}"
     end
-    it 'can process a resource' do
+    it "can process a resource" do
       debugger_output = /Puppet::Type::File/
       debugger.handle_input(input)
       expect(output.string).to match(debugger_output)
     end
   end
 
-  describe 'bad input' do
+  describe "bad input" do
     let(:input) do
-      'Service{'
+      "Service{"
     end
-    it 'can process' do
+    it "can process" do
       debugger.handle_input(input)
       expect(output.string).to match(%r(Syntax error at end of))
     end
   end
 
-  describe 'map block' do
+  describe "map block" do
     let(:input) do
       "['/tmp/test3', '/tmp/test4'].map |String $path| { file{$path: ensure => present} }"
     end
-    it 'can process a each block' do
+    it "can process a each block" do
       debugger_output = /Puppet::Type::File/
       debugger.handle_input(input)
       expect(output.string).to match(debugger_output)
     end
   end
 
-  describe 'each block' do
+  describe "each block" do
     let(:input) do
       "['/tmp/test3', '/tmp/test4'].each |String $path| { file{$path: ensure => present} }"
     end
-    it 'can process a each block' do
+    it "can process a each block" do
       debugger.handle_input(input)
       expect(output.string).to match(/\/tmp\/test3/)
       expect(output.string).to match(/\/tmp\/test4/)
     end
   end
 
-  describe 'string' do
+  describe "string" do
     let(:input) do
-      'String'
+      "String"
     end
-    it 'shows type' do
+    it "shows type" do
       debugger.handle_input(input)
       expect(output.string).to eq("\n => String\n")
     end
   end
-  describe 'Array', type_function: true do
+  describe "Array", type_function: true do
     let(:input) do
-      'type([1,2,3,4])'
+      "type([1,2,3,4])"
     end
-    it 'shows type' do
-      if Gem::Version.new(Puppet.version) > Gem::Version.new('4.4')
+    it "shows type" do
+      if Gem::Version.new(Puppet.version) > Gem::Version.new("4.4")
         debugger.handle_input(input)
         expect(output.string.strip.split("\n").count).to eq(6)
       end
     end
   end
 
-  describe 'multi diemension array' do
+  describe "multi diemension array" do
     let(:input) do
-      '[[1, [23,4], [22], [1,[2232]]]]'
+      "[[1, [23,4], [22], [1,[2232]]]]"
     end
-   
-    it 'handles multi array' do
+
+    it "handles multi array" do
       debugger.handle_input(input)
-      expect(output.string.count('[')).to eq(17)
+      expect(output.string.count("[")).to be >= 17
     end
-    
   end
 
-  describe 'command_completion' do
-    it 'should complete on tabs' do
+  describe "command_completion" do
+    it "should complete on tabs" do
       allow(Readline).to receive(:line_buffer).and_return("\n")
       expect(debugger.command_completion.call("").count).to be >= 200
     end
+
+    it "#key_words" do
+      expect(debugger.key_words.count).to be >= 100
+    end
   end
 
-  describe 'error message' do
+  describe "error message" do
     let(:input) do
       "file{'/tmp/test': ensure => present, contact => 'blah'}"
     end
-    if Gem::Version.new(Puppet.version) >= Gem::Version.new('4.0')
-      it 'show error message' do
+    if Gem::Version.new(Puppet.version) >= Gem::Version.new("4.0")
+      it "show error message" do
         debugger_output = /no\ parameter\ named\ 'contact'/
         debugger.handle_input(input)
         expect(output.string).to match(debugger_output)
       end
     else
-      it 'show error message' do
+      it "show error message" do
         debugger_output = /Invalid\ parameter\ contact/
         debugger.handle_input(input)
         expect(output.string).to match(debugger_output)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: puppet-debugger
 version: !ruby/object:Gem::Version
-  version: 0.12.0
+  version: 0.12.1
 platform: ruby
 authors:
 - Corey Osman
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-05-20 00:00:00.000000000 Z
+date: 2019-05-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: table_print