puppet-debugger 0.19.0 → 1.0.0

data/CHANGELOG.md

@@ -1,4 +1,15 @@
-## Unreleased
+## 1.0
+Released: 8/3/2020
+
+This is a major revision with breaking changes, notibly the requirement of ruby 2.4 and puppet 5.5.
+
+- Bump required ruby version to 2.4
+- Bump required puppet version to puppet 5.5
+- Add stacktrace plugin
+- Add a pager for long output
+- Remove puppet4 and older work arounds
+- Use rubocop for better code quality
+- Fix issue when the debugger was not loading the manfiest properely
 
 ## 0.19.0
 - Search datatypes with filter 

data/Gemfile

@@ -1,23 +1,25 @@
 # frozen_string_literal: true
+
 source 'http://rubygems.org'
 gem 'awesome_print', '~> 1.7'
 gem 'facterdb', '>= 0.5.0'
-gem 'puppet', ENV['PUPPET_GEM_VERSION'] || '~> 4.10.1'
 gem 'pluginator', '~> 1.5.0'
+gem 'puppet', ENV['PUPPET_GEM_VERSION'] || '>= 5.5'
 gem 'rb-readline'
 gem 'table_print'
+gem 'tty-pager'
 group :test, :development do
   # ruby versions prior to 2.0 cannot install json_pure 2.0.2+
   gem 'bundler'
   gem 'CFPropertyList'
   gem 'pry'
   gem 'puppet-debugger', path: './'
-  gem 'rake', '= 12.3.3'
+  gem 'rake', '~> 13.0'
   gem 'rdoc', '~> 3.12'
   gem 'release_me'
   gem 'rspec', '~> 3.6'
+  gem 'rubocop'
+  gem 'rubocop-performance'
+  gem 'rubocop-rspec'
   gem 'simplecov', '>= 0'
-  gem 'rubocop', '= 0.48.0'
-
 end
-

data/README.md

@@ -35,7 +35,7 @@ A interactive command line tool for evaluating and debugging the puppet language
 Please visit https://docs.puppet-debugger.com for more info.
 
 ## Compatibility
-Requires Puppet 3.8+ and only uses the future parser.  Works with puppet 4-6.
+Requires Puppet 5.5+, ruby 2.4+
 
 ## Production usage
 The puppet debugger is a developer tool that should only be used when writing puppet code.  Although it might seem useful
@@ -64,8 +64,8 @@ and see what it would actual do when compiling a resource.
 Example Usage
 ```
 Ruby Version: 2.6.5
-Puppet Version: 6.14.0
-Puppet Debugger Version: 0.16.0
+Puppet Version: 6.17.0
+Puppet Debugger Version: 1.0.0
 Created by: NWOps <corey@nwops.io>
 Type "commands" for a list of debugger commands
 or "help" to show the help screen.
@@ -90,8 +90,7 @@ or "help" to show the help screen.
     "policy_version" => "29"
   }
 }
-2:>>
-
+2:>> 
 
 ```
 

data/Rakefile

@@ -1,4 +1,3 @@
-# encoding: utf-8
 # frozen_string_literal: true
 
 require 'rubygems'
@@ -9,8 +8,8 @@ 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'
+  warn e.message
+  warn 'Run `bundle install` to install missing gems'
   exit e.status_code
 end
 require 'rake'
@@ -34,13 +33,14 @@ end
 
 desc 'Creates generic input_responder spec files'
 task :make_input_responder_tests do
-  files =  Dir.glob("lib/plugins/**/*.rb")
-  new_files = files.collect do |pathname|
-    orig_file = File.basename(pathname, ".*")
+  files = Dir.glob('lib/plugins/**/*.rb')
+  files.collect do |pathname|
+    orig_file = File.basename(pathname, '.*')
     test_file = File.join('spec', 'input_responders', "#{orig_file}_spec.rb")
-    unless File.exist?(test_file)
-      new_file = File.new(test_file, "w")
-      contents = <<-EOS
+    next if File.exist?(test_file)
+
+    # new_file = File.new(test_file, "w")
+    contents = <<-OUT
         require 'spec_helper'
         require 'puppet-debugger'
         require 'puppet-debugger/plugin_test_helper'
@@ -50,8 +50,7 @@ task :make_input_responder_tests do
         let(:args) { [] }
 
         end
-      EOS
-      File.write(test_file, contents)
-    end
+    OUT
+    File.write(test_file, contents)
   end
 end

data/bin/pdb

@@ -3,5 +3,5 @@
 
 require 'puppet-debugger'
 
-puts "The debugger pdb command will be removed in a future release please use puppet-debugger or puppet debugger instead".warning
+puts 'The debugger pdb command will be removed in a future release please use puppet-debugger or puppet debugger instead'.warning
 PuppetDebugger::Cli.start

data/lib/awesome_print/ext/awesome_puppet.rb

@@ -52,6 +52,7 @@ module AwesomePrint
 
     def awesome_puppet_resource(object)
       return '' if object.nil?
+
       resource_object = object.to_ral
       awesome_puppet_type(resource_object)
     end
@@ -59,16 +60,17 @@ module AwesomePrint
     def awesome_puppet_type(object)
       return '' if object.nil?
       return object.to_s unless object.respond_to?(:name) && object.respond_to?(:title) && object.respond_to?(:to_hash)
-      if Array.new.respond_to?(:to_h)
-        # to_h is only supported in ruby 2.1+
-        h = object.to_hash.merge(name: object.name, title: object.title).sort.to_h
-      else
-        h = object.to_hash.merge(name: object.name, title: object.title)
-      end
-      res_str = awesome_hash(JSON.parse(h.to_json)) #converting to json removes symbols
+
+      h = if [].respond_to?(:to_h)
+            # to_h is only supported in ruby 2.1+
+            object.to_hash.merge(name: object.name, title: object.title).sort.to_h
+          else
+            object.to_hash.merge(name: object.name, title: object.title)
+          end
+      res_str = awesome_hash(JSON.parse(h.to_json)) # converting to json removes symbols
       "#{object.class} #{res_str}"
     end
   end
 end
 
-AwesomePrint::Formatter.send(:include, AwesomePrint::Puppet)
+AwesomePrint::Formatter.include AwesomePrint::Puppet

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

@@ -1,14 +1,16 @@
+# frozen_string_literal: true
+
 require 'benchmark'
 require 'puppet-debugger/input_responder_plugin'
 module PuppetDebugger
   module InputResponders
     class Benchmark < InputResponderPlugin
-      COMMAND_WORDS = %w(benchmark bm)
+      COMMAND_WORDS = %w[benchmark bm].freeze
       SUMMARY = 'Benchmark your Puppet code.'
       COMMAND_GROUP = :tools
 
       def run(args = [])
-        if args.count > 0
+        if args.count.positive?
           enable(false)
           out = debugger.handle_input(args.first)
           disable
@@ -34,7 +36,6 @@ module PuppetDebugger
           'On'
         end
       end
-
     end
   end
-end
+end

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

@@ -1,8 +1,10 @@
+# frozen_string_literal: true
+
 require 'puppet-debugger/input_responder_plugin'
 module PuppetDebugger
   module InputResponders
     class Classes < InputResponderPlugin
-      COMMAND_WORDS = %w(classes)
+      COMMAND_WORDS = %w[classes].freeze
       SUMMARY = 'List all the classes current in the catalog.'
       COMMAND_GROUP = :scope
 
@@ -14,6 +16,7 @@ module PuppetDebugger
 
       def find_classes(classes, filter = [])
         return classes if filter.nil? || filter.empty?
+
         filter_string = filter.join(' ').downcase
         classes.find_all do |klass|
           klass.downcase.include?(filter_string)

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

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

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

@@ -1,12 +1,14 @@
+# frozen_string_literal: true
+
 require 'puppet-debugger/input_responder_plugin'
 module PuppetDebugger
   module InputResponders
     class Commands < InputResponderPlugin
-      COMMAND_WORDS = %w(commands)
+      COMMAND_WORDS = %w[commands].freeze
       SUMMARY = 'List all available commands, aka. this screen'
       COMMAND_GROUP = :help
 
-      def run(args = [])
+      def run(_args = [])
         commands_list
       end
 
@@ -31,9 +33,9 @@ module PuppetDebugger
       def command_groups
         unless @command_groups
           @command_groups = {}
-          self.class.command_output.each do | item|
+          self.class.command_output.each do |item|
             if @command_groups[item[:group]]
-              @command_groups[item[:group]].merge!({ item[:words].first => item[:summary] })
+              @command_groups[item[:group]].merge!(item[:words].first => item[:summary])
             else
               @command_groups[item[:group]] = { item[:words].first => item[:summary] }
             end
@@ -43,12 +45,12 @@ module PuppetDebugger
       end
 
       def self.command_list_regex
-        out = command_list.map {|n| "^#{n}"}.join('|')
-        %r(#{out})
+        out = command_list.map { |n| "^#{n}" }.join('|')
+        /#{out}/
       end
 
       def self.command_list
-        command_output.map{|f| f[:words] }.flatten
+        command_output.map { |f| f[:words] }.flatten
       end
 
       def self.command_output
@@ -56,22 +58,20 @@ module PuppetDebugger
       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
+        debug_plugins = Pluginator.find('puppet-debugger')
+        debug_plugins['input_responders']
+      rescue NoMethodError
+        raise PuppetDebugger::Exception::InvalidCommand.new(message: 'Unsupported gem version.  Please update with: gem update --system')
       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 #{name}") unless p
-        p
-      end
+        plug = plugins.find { |p| p::COMMAND_WORDS.include?(name) }
+        raise PuppetDebugger::Exception::InvalidCommand.new(message: "invalid command #{name}") unless plug
 
+        plug
+      end
     end
   end
-end
+end

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

@@ -1,8 +1,10 @@
+# frozen_string_literal: true
+
 require 'puppet-debugger/input_responder_plugin'
 module PuppetDebugger
   module InputResponders
     class Datatypes < InputResponderPlugin
-      COMMAND_WORDS = %w(datatypes)
+      COMMAND_WORDS = %w[datatypes].freeze
       SUMMARY = 'List all the datatypes available in the environment.'
       COMMAND_GROUP = :environment
 
@@ -14,6 +16,7 @@ module PuppetDebugger
 
       def find_datatypes(datatypes, filter = [])
         return datatypes if filter.nil? || filter.empty?
+
         filter_string = filter.join(' ').downcase
         datatypes.find_all do |datatype|
           datatype.downcase.include?(filter_string)
@@ -27,15 +30,19 @@ module PuppetDebugger
         files.map do |f|
           m = File.read(f).match(/type\s([a-z\d\:_]+)/i)
           next if m =~ /type|alias/ # can't figure out the best way to filter type and alias out
+
           m[1] if m && m[1] =~ /::/
         end.uniq.compact
       end
 
+      # loaders.instance_variable_get(:@loaders_by_name)['boltlib']
+      # [:func_4x, :func_4xpp, :func_3x, :datatype, :type_pp,
+      # :resource_type_pp, :plan, :task]
       # @return [Array[String]] - a list of core data types
       def core_datatypes
-        loaders.implementation_registry
-            .instance_variable_get(:'@implementations_per_type_name')
-            .keys.find_all { |t| t !~ /::/ }
+        loaders.implementation_registry.instance_variable_get(:@parent)
+               .instance_variable_get(:@implementations_per_type_name)
+               .keys.find_all { |t| t !~ /::/ }
       end
 
       # @return [Array[String]] - combined list of core data types and environment data types
@@ -46,7 +53,6 @@ module PuppetDebugger
         end
         core_datatypes + environment_data_types
       end
-
     end
   end
 end

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

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

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)
+      COMMAND_WORDS = %w[exit].freeze
       SUMMARY = 'Quit Puppet Debugger.'
       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