puppet-debugger 0.17.0 → 1.2.0

data/.vscode/launch.json

@@ -0,0 +1,15 @@
+{
+    // Use IntelliSense to learn about possible attributes.
+    // Hover to view descriptions of existing attributes.
+    // For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
+    "version": "0.2.0",
+    "configurations": [
+        {
+            "type": "chrome",
+            "request": "launch",
+            "name": "Launch Chrome against localhost",
+            "url": "http://localhost:8080",
+            "webRoot": "${workspaceFolder}"
+        }
+    ]
+}

data/CHANGELOG.md

@@ -1,4 +1,33 @@
+# Puppet Debugger Changelog
+
 ## Unreleased
+## 1.2
+- Fix puppetdb_query errors when bolt_pdb_client was not loaded
+## 1.1
+- Catch signals and allow control-d for quitting. 
+## 1.0
+Released: 8/3/2020
+
+This is a major revision with breaking changes, notably 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 manifest properly
+
+## 0.19.0
+- Search datatypes with filter 
+- Fix #8 - trusted_server_facts' as a setting is deprecated
+
+## 0.18.0
+- Add bundler as a dependency
+- Add ability to filter out classes
+- Add ability to filter out resources
+- Add ability to supply a catalog
+- Add vendormoduledir to module paths
 
 ## 0.17.0
 - Fix bolt issue when the catalog is referenced

data/Gemfile

@@ -1,23 +1,26 @@
 # 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'
+#gem 'bolt' if Gem::Version(ENV['PUPPET_GEM_VERSION'])
+
 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
@@ -63,22 +63,35 @@ and see what it would actual do when compiling a resource.
 
 Example Usage
 ```
-MacBook-Pro-2/tmp % puppet debugger
-Ruby Version: 2.0.0
-Puppet Version: 4.8.1
-Puppet Debugger Version: 0.4.3
+Ruby Version: 2.6.5
+Puppet Version: 6.17.0
+Puppet Debugger Version: 1.0.0
 Created by: NWOps <corey@nwops.io>
-Type "exit", "functions", "vars", "krt", "whereami", "facts", "resources", "classes",
-     "play", "classification", "reset", or "help" for more information.
-
-1:>> ['/tmp/test3', '/tmp/test4'].each |String $path| { file{$path: ensure => present} }
- => [
-  [0] "/tmp/test3",
-  [1] "/tmp/test4"
-]
+Type "commands" for a list of debugger commands
+or "help" to show the help screen.
+
+
+1:>> $os
+ => {
+  "architecture" => "x86_64",
+        "family" => "RedHat",
+      "hardware" => "x86_64",
+          "name" => "Fedora",
+       "release" => {
+     "full" => "23",
+    "major" => "23"
+  },
+       "selinux" => {
+       "config_mode" => "permissive",
+     "config_policy" => "targeted",
+      "current_mode" => "permissive",
+           "enabled" => true,
+          "enforced" => false,
+    "policy_version" => "29"
+  }
+}
 2:>> 
 
-
 ```
 
 ## Copyright

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,15 +1,27 @@
+# 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
 
       def run(args = [])
-        debugger.scope.compiler.catalog.classes.ai
+        filter = args
+        classes = find_classes(debugger.catalog.classes, filter)
+        classes.ai
       end
 
+      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)
+        end
+      end
     end
   end
 end

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,13 +1,26 @@
+# 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
 
       def run(args = [])
-        all_data_types.sort.ai
+        filter = args
+        datatypes = find_datatypes(all_data_types.sort, filter)
+        datatypes.ai
+      end
+
+      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)
+        end
       end
 
       # @return [Array[String]] - returns a list of all the custom data types found in all the modules in the environment
@@ -17,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
@@ -36,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