puppet-debugger 0.16.0 → 0.17.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9873e0a4a8f2dc1ebfaafafa8675e2e942a8e6c4591dfde9aa6400c494c1adce
-  data.tar.gz: 310d779ee5bbb993e16ac74d4856ab73a8c29a4bef12205df90dae79b450d099
+  metadata.gz: 064ab5d1d98f5c578ba1b5e44264f46f58758e002962a15a952cef3727f8293b
+  data.tar.gz: 0b277145b7b8e1331335c4426eef7fcb4da178c237003d0a52e885994834f515
 SHA512:
-  metadata.gz: 9f2c1739d8e4a05c5b4b001819476fc8af16c7ee30d05d6616ade4602ea95755f8ef6bf1a1869f50e89ae61789325d23ab2be2984c7ab8167247e57acffb25ad
-  data.tar.gz: 151294ae8d704da59e87180288b8e2da87ad8564fe155676653f9c3594f5883fa7f3da541f9b7ab617f87483fc3d31d12ac756ef346f2a343b0921e56c90b050
+  metadata.gz: 9dab8038472346e1ef354edf6de7cf5c004be3f98781a0b466304cb9d26643f2175fa3cef12d07967b9b2c507a5866754f8bcd0e7ff82e3909c0ce86b77ebde7
+  data.tar.gz: e734bf29bd64c5a62f78e6fc968f86b7694f046a5d98b26abf3f4e69416f8e31616de85e3ae6c503b5be523e2a5023fdebadb87d171a0efdb86db81f0703452c

data/.ruby-version

@@ -1 +1 @@
-2.4.5
+2.6.5

data/CHANGELOG.md

@@ -1,5 +1,11 @@
 ## Unreleased
 
+## 0.17.0
+- Fix bolt issue when the catalog is referenced
+- Fix bolt issue when scriptcompiler scope is used
+  and the debugger tries to expand the resources
+  in the catalog.
+
 ## 0.16.0
 - Load bolt puppet modules if bolt exists
 - Fix bolt datatype rendering issues

data/README.md

@@ -31,8 +31,11 @@
 
 A interactive command line tool for evaluating and debugging the puppet language.
 
+## Documentation
+Please visit https://docs.puppet-debugger.com for more info.
+
 ## Compatibility
-Requires Puppet 3.8+ and only uses the future parser.
+Requires Puppet 3.8+ and only uses the future parser.  Works with puppet 4-6.
 
 ## Production usage
 The puppet debugger is a developer tool that should only be used when writing puppet code.  Although it might seem useful
@@ -41,18 +44,6 @@ to install on your production puppet master. Please do not install because of th
 ## Installation
 `gem install puppet-debugger`
 
-## Load path
-puppet-debugger will load all puppet functions from your basemodulepath and environmentpath.
-
-This means if you run `puppet module install puppetlabs-stdlib` and they will be available
-in the debugger.
-
-## Interactive demo
-I have put together a repo with a few setup instructions that will assist you in setting up a "mock" environment
-for usage with the puppet-debugger.  This was originally intended when giving a demo of the repl, but also seems
-useful for other people.
-
-https://github.com/nwops/puppet-debugger-demo
 
 ## Web demo
 There is a web version of the [puppet-debugger](https://demo.puppet-debugger.com) online but is somewhat
@@ -90,242 +81,6 @@ Type "exit", "functions", "vars", "krt", "whereami", "facts", "resources", "clas
 
 ```
 
-## Using Variables
-
-```
-MacBook-Pro-2/tmp % puppet debugger
-Ruby Version: 2.0.0
-Puppet Version: 3.8.5
-Puppet Debugger Version: 0.0.7
-Created by: NWOps <corey@nwops.io>
-Type "exit", "functions", "vars", "krt", "facts", "reset", "help" for more information.
-
->>
-
->> $config_file = '/etc/httpd/httpd.conf'
- => "/etc/httpd/httpd.conf"
- >> file{$config_file: ensure => present, content => 'hello'}
-  => Puppet::Type::File {
-                        path => "/etc/httpd/httpd.conf",
-                    provider => posix,
-                      ensure => present,
-                     content => "{md5}5d41402abc4b2a76b9719d911017c592",
-                    checksum => nil,
-                      backup => "puppet",
-                     replace => true,
-                       links => manage,
-                       purge => false,
-                sourceselect => first,
-                   show_diff => true,
-        validate_replacement => "%",
-          source_permissions => use,
-     selinux_ignore_defaults => false,
-                    loglevel => notice,
-                        name => "/etc/httpd/httpd.conf",
-                       title => "/etc/httpd/httpd.conf"
- }
- >>
-```
-### Listing variables
-To see the current variables in the scope use the  `vars` keyword.
-
-![variables](resources/variables.png)
-
-## Listing functions
-Knowing what functions are available and where they come from is extremely helpful especially in a debugger session.  Run the `functions` keyword to get a name spaced list of functions.  You can further filter out functions by passing in a filter argument. `functions stdlib`
-
-![functions](resources/functions.png)
-
-## Using functions
-Functions will run and produce the desired output.  If you type the word `functions`
-a list of available functions will be displayed on the screen along with a namespace to help you identify where they came from.
-
-```
->> split('hello/there/one/two/three','/')
- => ["hello", "there", "one", "two", "three"]
-
-```
-
-So you can imagine how much fun this can be trying out different types of functions.
-
-## Duplicate resource error
-Just like normal puppet code you cannot create duplicate resources.
-
-```
->> file{'/tmp/failure2.txt': ensure => present}
- => Evaluation Error: Error while evaluating a Resource Statement, Duplicate declaration: File[/tmp/failure2.txt] is already declared in file :1; cannot redeclare at line 1 at line 1:1
-
-```
-You can reset the parser by running `reset` within the debugger without having to exit.
-
-## Setting the puppet log level
-If you want to see what puppet is doing behind the scenes you can set the log level
-via `:set loglevel debug`.  Valid log levels are `debug`, `info`, `warning` and other
-levels defined in puppet [config reference](https://docs.puppetlabs.com/puppet/4.4/reference/configuration.html#loglevel) .
-
-![hiera](resources/hiera.png)
-
-## Remote nodes
-This is new for 0.2.0.  The puppet-debugger now has the ability to pull in remote node information. Instead of mocking facts you can pull in real information!  Get real facts and real node classification from the puppet master and then play with the info in the debugger session. This is made possible by using the puppet node indirector interface.
-
-ie.  `puppet node find hostname --terminus rest --render-as yaml`
-
-In order to use this feature you will need to setup a few things.
-
-### Setup
-1. Allow node rest calls to your workstation on the puppet master(s)
-See https://github.com/nwops/puppet-debugger/issues/17 for more info on allowing this rule.  
-
-2. Ensure you have the same code that your puppet master does.  Since this pulls in classification you will need to have all the puppet modules defined in your
-environmentpath or basemodulepath.   The simple thing to do is to point your basemodulepath to your fixtures directory if using rspec-puppet or some other high level modules directory.   For PE users you will want to ensure you have all the
-pe specific modules in your development environment.  Not doing this step will result in class not found errors.
-
-3. Set the server config in your local puppet.conf. (on your development machine)
-
-    a. Find your puppet config file `puppet config print config`
-
-    b. edit the config file with an editor
-
-    c. add `server = <hostname>` to your main block
-
-4. If using hiera you also need to set the path to your hiera config file since
-   the puppet-debugger will be compiling puppet code which could in turn call hiera
-   functions.  Additionally, make sure your hiera config points to the correct
-   data location.
-
-  ```
-  [main]
-    server = pe-puppet.localdomain
-    basemodulepath = /Users/cosman/github/puppet-debugger-demo/modules:/Users/cosman/Downloads/pe_modules
-    hiera_config = /Users/cosman/github/puppet-debugger-demo/hieradata/hiera.yaml
-
-
-  ```
-
-### Usage
-There are two ways of using the remote node feature.  You can either
-pass in the node name from the command line or set the node name from the debugger session.
-
-#### Command line:
-`puppet debugger -n node_name`
-
-![command line](resources/command_line_node.png)
-
-#### From debugger session:
-`:set node node_name`
-
-![command line](resources/set_node.png)
-
-
-This is also extremely useful to check classification rules and variables by your ENC. So instead of running your ENC script manually we get the puppet master to run this indirectly and return the results to you.
-
-## Auto Complete
-The puppet-debugger uses readline internally.  So any variable or function is also available for auto completion.
-Press the tab key to engage the auto complete functionality.
-
-Currently native functions are not available in auto complete. See #24
-
-## FacterDB and using different fact sets
-The puppet-debugger internally leverages the [facterdb](https://github.com/camptocamp/facterdb/) gem to load pre-cached facts into the debugger session.  At some point you
-may need to override the debugger's default fact set with something of your own choosing.  You can do this by setting one of the environment variables below.
-
-* `DEBUGGER_FACTERDB_FILTER`  Sets the entire filter
-* `DEBUGGER_FACTER_OS_VERSION` Sets the OS version (only works with RHEL clones and Fedora)
-* `DEBUGGER_FACTER_OS_NAME` Sets the OS name (only works with RHEL clones and Fedora)
-* `DEBUGGER_FACTER_VERSION` Sets the facter version to use in the debugger session (uses facter 3.1 for puppet 4.4+ and facter 2.4 for 3.8-4.4)
-
-By default it looks something like `operatingsystem=Fedora and operatingsystemrelease=23 and architecture=x86_64 and facterversion=/^3\\.1/`
-depending on the puppet version currently running.
-
-You can display the current facterdb filter by running `facterdb_filter` from the debugger session.
-
-Why do facter versions matter? While facter and puppet work independently just fine, newer forge modules utilize certain data structures found only in newer versions of facter. 
-So its really up to the puppet code you use. With facter 3, almost every fact is now a data structure.  So if you are having issues with facts not existing in the debugger you may need to change the facter version `REPL_FACTER_VERSION` to something different.
-
-## Custom FacterDB Facts
-As of FacterDB 0.4.0 we can now supply custom [external fact sets](https://github.com/camptocamp/facterdb#supplying-custom-external-facts) to facterDB..  This is a huge deal because you can take the facts from any system and play around with the fact data in the debugger.  This makes the debugger appear as it was run on that system.  Moreover, you can create shareable fact sets for your entire team. To use an external fact set you first need to grab the facts from the system you wish to "mock".  This can be done with `puppet facts` or even puppetdb queries and then create a file with the values hash.
-
-
-Take the values from the values hash only and place inside a new file.
-```
-{
-  "name": "macbook-pro-10.domain",
-  "values": {
-    "custom_datacenter_fact": "iceland",
-    "puppetversion": "5.3.2",
-    "architecture": "x86_64",
-    "kernel": "Darwin",
-    "domain": "domain"
-  }
-}
-
-```
-
-This can be easily done if you have `jq` installed. 
-
-`puppet facts | jq '.values' > /tmp/custom_facts/datacenter_a/2.4/os_x.facts`
-
-Once you have created a directory with one or more fact files you just need to set an environment variable to tell facterDB about the custom fact sets.
-
-`export FACTERDB_SEARCH_PATHS="/tmp/custom_facts/"`
-
-Now everytime you start the puppet debugger, facterDB will use these custom fact files
-as part of the facterDB database.  However, you will still need to provide a search filter that references your custom fact because there are over a thousand facterDB fact sets.  
-
-`puppet debugger --facterdb-filter 'custom_datacenter_fact=iceland'`
-
-
-Alternatively you can bypass the internal facterDB database by setting `export FACTERDB_SKIP_DEFAULTDB=true` and force your custom facts to be the only facts facterDB uses.
-
-*Note: when exporting facterDB environment variables you will also change the behavior for rspec_puppet_facts and other gems that also rely on facterDB.  So please remember to unset the variables if not needed*
-
-## Playback support
-puppet-debugger now supports playing back files or urls and loading the content into the debugger session.  This means if you want to start a debugger session from an existing file or url you can play the content back in the debugger.
-You can also playback a file that contains puppet code and debugger commands.
-
-`play https://gist.githubusercontent.com/logicminds/f9b1ac65a3a440d562b0/raw`
-
-or
-
-`puppet debugger -p https://gist.githubusercontent.com/logicminds/f9b1ac65a3a440d562b0/raw`
-
-or just use STDIN  `puppet debugger <some_file>` or `echo "abs(-3)" | puppet debugger`
-
-### Web based playback support
-If using the [web based debugger](https://www.puppet-debugger.com) you can playback a shared url
-which would start a debugger session and then load the content from the url or parameter.
-
-Example:
-https://puppet-debugger.com/play?url=https://gist.github.com/logicminds/64f0fe9f64339f18f097a9f42acd6276
-
-or for single commands
-
-https://www.puppet-debugger.com/play?content=vars
-
-Please note the web based debugger only contains a minimal amount of puppet modules.  So its likely
-that your code may not work if using third party modules.  This may change in the future though.
-
-## Plugins
-The puppet debugger has a plugin system that allows anyone to create new functionality
-for the puppet debugger.  By default the puppet debugger ships with serveral core
-plugins that provide basic usage.  Any non core plugin can be installed as a separate
-gem.  The following is a list of plugins we wrote or know about.
-
-
-| Name        | Project Url           | Type  | Description |
-| ------------- |:-------------:| -----:| -------------:|
-| playbooks      | [playbooks](https://gitlab.com/puppet-debugger/puppet-debugger-playbooks) | editing | Allows group playback of scripted puppet commands |
-
-
-## Development
- * [Plugin Development Guide](Plugin_development.md)
- 
-## Troubleshooting
-Please file an issue so we can track bugs.
-
-
-Pull requests welcomed.
-
 ## Copyright
 
 Copyright (c) 2018 NWOPS, LLC. See LICENSE.txt for

data/lib/puppet-debugger.rb

@@ -9,51 +9,7 @@ require 'puppet/util/log'
 require 'puppet-debugger/debugger_code'
 require 'puppet-debugger/support/errors'
 require 'plugins/puppet-debugger/input_responders/commands'
-
-
-# monkey patch in some color effects string methods
-class String
-  def red
-    "\033[31m#{self}\033[0m"
-  end
-
-  def bold
-    "\033[1m#{self}\033[22m"
-  end
-
-  def black
-    "\033[30m#{self}\033[0m"
-  end
-
-  def green
-    "\033[32m#{self}\033[0m"
-  end
-
-  def cyan
-    "\033[36m#{self}\033[0m"
-  end
-
-  def yellow
-    "\033[33m#{self}\033[0m"
-  end
-
-  def warning
-    yellow
-  end
-
-  def fatal
-    red
-  end
-
-  def info
-    green
-  end
-
-  def camel_case
-    return self if self !~ /_/ && self =~ /[A-Z]+.*/
-    split('_').map(&:capitalize).join
-  end
-end
+require 'puppet-debugger/monkey_patches'
 
 Puppet::Util::Log.newdesttype :buffer do
   require 'puppet/util/colors'

data/lib/puppet-debugger/cli.rb

@@ -106,7 +106,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::PResourceType/ }.nil?
     end
 
     def normalize_output(result)

data/lib/puppet-debugger/monkey_patches.rb

@@ -0,0 +1,54 @@
+# monkey patch in some color effects string methods
+class String
+  def red
+    "\033[31m#{self}\033[0m"
+  end
+
+  def bold
+    "\033[1m#{self}\033[22m"
+  end
+
+  def black
+    "\033[30m#{self}\033[0m"
+  end
+
+  def green
+    "\033[32m#{self}\033[0m"
+  end
+
+  def cyan
+    "\033[36m#{self}\033[0m"
+  end
+
+  def yellow
+    "\033[33m#{self}\033[0m"
+  end
+
+  def warning
+    yellow
+  end
+
+  def fatal
+    red
+  end
+
+  def info
+    green
+  end
+
+  def camel_case
+    return self if self !~ /_/ && self =~ /[A-Z]+.*/
+    split('_').map(&:capitalize).join
+  end
+end
+
+# Bolt plans utilize the PAL Script Compiler to compile the code and thus
+# don't store a catalog with the scope.  This is due to not needing the catalog
+# in the scope.  The debugger relies on the catalog being present in the scope
+# and thus uses all the methods to discover various data in the catalog
+# We monkey patch in a catalog here instead of changing our API for simplicity.
+class Puppet::Parser::ScriptCompiler
+  def catalog
+    @catalog ||= Puppet::Resource::Catalog.new(@node_name, @environment, 'bolt')
+  end
+end

data/lib/puppet-debugger/version.rb

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

data/spec/puppet_debugger_spec.rb

@@ -218,8 +218,9 @@ describe "PuppetDebugger" do
     end
     it "shows type" do
       if Gem::Version.new(Puppet.version) > Gem::Version.new("4.4")
+        out = "\n => Tuple[Integer[1, 1], Integer[2, 2], Integer[3, 3], Integer[4, 4]]\n"
         debugger.handle_input(input)
-        expect(output.string.strip.split("\n").count).to eq(6)
+        expect(output.string).to eq(out)
       end
     end
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: puppet-debugger
 version: !ruby/object:Gem::Version
-  version: 0.16.0
+  version: 0.17.0
 platform: ruby
 authors:
 - Corey Osman
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-04-08 00:00:00.000000000 Z
+date: 2020-04-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: table_print
@@ -180,6 +180,7 @@ files:
 - lib/puppet-debugger/debugger_code.rb
 - lib/puppet-debugger/hooks.rb
 - lib/puppet-debugger/input_responder_plugin.rb
+- lib/puppet-debugger/monkey_patches.rb
 - lib/puppet-debugger/plugin_test_helper.rb
 - lib/puppet-debugger/support.rb
 - lib/puppet-debugger/support/compiler.rb
@@ -288,7 +289,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: A repl based debugger for the puppet language