puppet-debugger 0.4.4 → 0.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 105152a505637bcde7438d1a2ba964e998148a9d
-  data.tar.gz: d427ad2728e18736d85fa587b927a0a629cac26f
+  metadata.gz: bf5bf556d8e8b1810aff75dc4ca595b8d52d1f2e
+  data.tar.gz: 57513b64926b0107ecff995c4ce81985dce6ea6c
 SHA512:
-  metadata.gz: 87b64225065ac3ad3cfb1642e3339730381ebabf44ff038f58a62138bb6d0be9d0749cba4ae74ecfcedff19c8b3a7fc39157c5badf308e7b95ba2fabc0065653
-  data.tar.gz: 31a94b04b47e67eb857d9c4923513ae6c4eb4e6274af046738d3459763b3e230db947cdc0acbbf9bc123db08eaa86b67a83ec4795fea7b03131679a767c5fdb8
+  metadata.gz: a8de0ef4a70b41de5ed03f119f1332e16222ba9fd3a8405ae31526004be2c69ab2cbf6abf56c02862113eca6e60d90fe69711519de30667155b1763922275247
+  data.tar.gz: a1bd4e25633ee39854aad9a4ff74489eb22773c03012c23b4b8926e57583f4922f8f5c9da0ec9007b12f9b0f832923daa48666fea503514c18a605d8f718e81a

data/.dockerignore

@@ -0,0 +1,5 @@
+.bundle/
+.gem/
+.gems/
+coverage/
+vendor

data/.gitignore

@@ -1,4 +1,7 @@
 # rcov generated
+.bash_history
+.gems
+.gem
 .puppet_repl_input*
 local_test_results
 bundle

data/.rubocop_todo.yml

@@ -66,7 +66,7 @@ Metrics/AbcSize:
 # Offense count: 3
 # Configuration parameters: CountComments.
 Metrics/BlockLength:
-  Max: 31
+  Max: 442
 
 # Offense count: 3
 Metrics/BlockNesting:

data/CHANGELOG.md

@@ -1,3 +1,15 @@
+## Unreleased
+
+## 0.5.0
+  * Fixes #gh-49 - puppet 4 functions don't seem to work
+  * Disables trying to set trusted_node_data for puppet versions that do not support it
+## 0.4.4
+  * Refactor to upcoming puppet 5.0  (minor fix, requires a few more changes)
+  * Fixes issue with frozen string literal under ruby 2.3.x
+## 0.4.3
+  * Fixes issue with older facterdb filter not working
+## 0.4.2
+  * Fixes #44 - error when running under puppet apply
 ## 0.4.1
   * Adds a puppet application face
   * Fixes #41 - add file reference when showing code during code break

data/Gemfile

@@ -1,5 +1,5 @@
 source "http://rubygems.org"
-gem 'puppet', ENV['PUPPET_GEM_VERSION'] || ">= 3.8"
+gem 'puppet', ENV['PUPPET_GEM_VERSION'] || "~> 4.9.0"
 gem 'facterdb', ">= 0.3.8"
 gem 'awesome_print', "~> 1.6"
 
@@ -12,12 +12,10 @@ group :test do
   gem "simplecov", ">= 0"
   gem 'rake'
   gem 'release_me'
+  gem 'pry'
 end
 
 group :validate do
   gem 'rubocop'
 end
 
-group :development do
-  gem 'pry'
-end

data/Gemfile.lock

@@ -5,36 +5,46 @@ GEM
     ast (2.3.0)
     awesome_print (1.7.0)
     coderay (1.1.1)
-    diff-lcs (1.2.5)
+    diff-lcs (1.3)
     docile (1.1.5)
     facter (2.4.6)
       CFPropertyList (~> 2.2.6)
-    facterdb (0.3.8)
+    facterdb (0.3.10)
       facter
       jgrep
-    hiera (3.2.2)
+    fast_gettext (1.1.0)
+    gettext (3.2.2)
+      locale (>= 2.0.5)
+      text (>= 1.3.0)
+    gettext-setup (0.16)
+      fast_gettext (~> 1.1.0)
+      gettext (>= 3.0.2)
+      locale
+    hiera (3.3.1)
     jgrep (1.4.1)
       json
-    json (1.8.3)
-    json_pure (1.8.3)
+    json (1.8.6)
+    json_pure (1.8.6)
+    locale (2.1.2)
     method_source (0.8.2)
-    parser (2.3.3.1)
+    parser (2.4.0.0)
       ast (~> 2.2)
     powerpack (0.1.1)
     pry (0.10.4)
       coderay (~> 1.1.0)
       method_source (~> 0.8.1)
       slop (~> 3.4)
-    puppet (4.8.1)
-      CFPropertyList (~> 2.2.6)
+    puppet (4.9.4)
       facter (> 2.0, < 4)
+      gettext-setup (>= 0.10, < 1)
       hiera (>= 2.0, < 4)
       json_pure (~> 1.8)
+      locale (~> 2.1)
     rainbow (2.2.1)
     rake (12.0.0)
     rdoc (3.12.2)
       json (~> 1.4)
-    release_me (0.1.3)
+    release_me (0.1.4)
     rspec (3.5.0)
       rspec-core (~> 3.5.0)
       rspec-expectations (~> 3.5.0)
@@ -48,20 +58,21 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.5.0)
     rspec-support (3.5.0)
-    rubocop (0.46.0)
-      parser (>= 2.3.1.1, < 3.0)
+    rubocop (0.47.1)
+      parser (>= 2.3.3.1, < 3.0)
       powerpack (~> 0.1)
       rainbow (>= 1.99.1, < 3.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (~> 1.0, >= 1.0.1)
     ruby-progressbar (1.8.1)
-    simplecov (0.12.0)
+    simplecov (0.14.1)
       docile (~> 1.1.0)
       json (>= 1.8, < 3)
       simplecov-html (~> 0.10.0)
     simplecov-html (0.10.0)
     slop (3.6.0)
-    unicode-display_width (1.1.2)
+    text (1.3.1)
+    unicode-display_width (1.1.3)
 
 PLATFORMS
   ruby
@@ -72,7 +83,7 @@ DEPENDENCIES
   facterdb (>= 0.3.8)
   json_pure (<= 2.0.1)
   pry
-  puppet (>= 3.8)
+  puppet (~> 4.9.0)
   rake
   rdoc (~> 3.12)
   release_me
@@ -81,4 +92,4 @@ DEPENDENCIES
   simplecov
 
 BUNDLED WITH
-   1.13.6
+   1.14.6

data/README.md

@@ -1,3 +1,8 @@
+![demo](resources/puppet_debugger_long_white.png)
+
+![demo](resources/animated-debugger-demo.gif)
+
+
 <!-- START doctoc generated TOC please keep comment here to allow auto update -->
 <!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
 **Table of Contents**  *generated with [DocToc](https://github.com/thlorenz/doctoc)*
@@ -27,7 +32,6 @@
   - [Copyright](#copyright)
 
 <!-- END doctoc generated TOC please keep comment here to allow auto update -->
-![Build Status](https://gitlab.com/nwops/puppet-debugger/badges/master/build.svg)
 [![Gem Version](https://badge.fury.io/rb/puppet-debugger.svg)](https://badge.fury.io/rb/puppet-debugger)
 # puppet-debugger
 
@@ -37,7 +41,7 @@ A interactive command line tool for evaluating and debugging the puppet language
 Requires Puppet 3.8+ and only uses the future parser.
 
 ## Production usage
-The puppet repl is a developer tool that should only be used when writing puppet code.  Although it might seem useful
+The puppet debugger is a developer tool that should only be used when writing puppet code.  Although it might seem useful
 to install on your production puppet master. Please do not install because of the puppet-debugger gem dependencies that might conflict with your existing environment.
 
 ## Installation
@@ -47,7 +51,7 @@ to install on your production puppet master. Please do not install because of th
 puppet-debugger will load all functions from your basemodulepath and environmentpath.
 
 This means if you run `puppet module install puppetlabs-stdlib` and they will be available
-in the repl.
+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
@@ -58,41 +62,44 @@ https://github.com/nwops/puppet-debugger-demo
 
 ## Web demo
 There is a web version of the [puppet-debugger](https://www.puppet-debugger.com) online but is somewhat
-limited at this time. In the future we will be adding lots of awesome features to the web repl.
+limited at this time. In the future we will be adding lots of awesome features to the web debugger.
 
 ## Usage
-puppet-debugger will only parse and evaluate your code.  It will not build a catalog
-and try to enforce the catalog. This has a few side affects.
+The puppet debugger is a puppet application so once you install the gem, just fire it up using `puppet debugger`.  
+If you have used `puppet apply` to evaulate puppet code, this replaces all of that with a simple debugger REPL console.
+The debugger will only parse and evaluate your code.  It will not build a catalog
+and try to enforce the catalog. This has a few side affects.  This means you can type any puppet code in the debugger
+and see what it would actual do when compiling a resource.
 
 1. Type and provider code will not get run.
 2. Nothing is created or destroyed on your system.
 
-`pdb`
+`puppet debugger`
 
 Example Usage
 ```
-MacBook-Pro-2/tmp % pdb
+MacBook-Pro-2/tmp % puppet debugger
 Ruby Version: 2.0.0
-Puppet Version: 3.8.5
-Puppet Debugger Version: 0.0.7
+Puppet Version: 4.8.1
+Puppet Debugger Version: 0.4.3
 Created by: NWOps <corey@nwops.io>
-Type "exit", "functions", "vars", "krt", "facts", "reset", "help" for more information.
+Type "exit", "functions", "vars", "krt", "whereami", "facts", "resources", "classes",
+     "play", "classification", "reset", or "help" for more information.
 
->> ['/tmp/test3', '/tmp/test4'].each |String $path| { file{$path: ensure => present} }
-  => [
-     [0] "/tmp/test3",
-     [1] "/tmp/test4"
- ]
- >>
+1:>> ['/tmp/test3', '/tmp/test4'].each |String $path| { file{$path: ensure => present} }
+ => [
+  [0] "/tmp/test3",
+  [1] "/tmp/test4"
+]
+2:>> 
 
-```
 
-You can also use the debugger from the puppet command via `puppet debugger`
+```
 
 ## Using Variables
 
 ```
-MacBook-Pro-2/tmp % pdb
+MacBook-Pro-2/tmp % puppet debugger
 Ruby Version: 2.0.0
 Puppet Version: 3.8.5
 Puppet Debugger Version: 0.0.7
@@ -206,7 +213,7 @@ 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:
-`pdb -n node_name`
+`puppet debugger -n node_name`
 
 ![command line](resources/command_line_node.png)
 
@@ -248,9 +255,9 @@ You can also playback a file that contains puppet code and debugger commands.
 
 or
 
-`pdb -p https://gist.githubusercontent.com/logicminds/f9b1ac65a3a440d562b0/raw`
+`puppet debugger -p https://gist.githubusercontent.com/logicminds/f9b1ac65a3a440d562b0/raw`
 
-or just use STDIN  `pdb <some_file>` or `echo "abs(-3)" | pdb`
+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
@@ -274,5 +281,5 @@ Pull requests welcomed.
 
 ## Copyright
 
-Copyright (c) 2016 Corey Osman. See LICENSE.txt for
+Copyright (c) 2017 Corey Osman. See LICENSE.txt for
 further details.

data/lib/puppet-debugger/cli.rb

@@ -11,6 +11,12 @@ module PuppetDebugger
     attr_accessor :settings, :log_level, :in_buffer, :out_buffer, :html_mode
 
     def initialize(options = {})
+      do_initialize if Puppet[:codedir].nil?
+      Puppet.settings[:name] = :debugger
+      Puppet.settings[:trusted_server_facts] = true unless Puppet.settings[:trusted_server_facts].nil?
+      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'
       @out_buffer = options[:out_buffer] || $stdout
       @html_mode = options[:html_mode] || false
@@ -28,7 +34,6 @@ module PuppetDebugger
         sort_keys: true,
         indent: 2
       }
-      do_initialize
     end
 
     # returns a cached list of key words
@@ -197,8 +202,6 @@ Type "exit", "functions", "vars", "krt", "whereami", "facts", "resources", "clas
     def self.start_without_stdin(options = { scope: nil })
       puts print_repl_desc unless options[:quiet]
       repl_obj = PuppetDebugger::Cli.new(options)
-      repl_obj.remote_node_name = options[:node_name] if options[:node_name]
-      repl_obj.initialize_from_scope(options[:scope])
       # TODO: make the output optional so we can have different output destinations
       puts repl_obj.whereami if options[:source_file] && options[:source_line]
       repl_obj.play_back(options) if options[:play]
@@ -219,8 +222,6 @@ Type "exit", "functions", "vars", "krt", "whereami", "facts", "resources", "clas
       options = opts.merge(options)
       puts print_repl_desc unless options[:quiet]
       repl_obj = PuppetDebugger::Cli.new(options)
-      repl_obj.remote_node_name = opts[:node_name] if opts[:node_name]
-      repl_obj.initialize_from_scope(options[:scope])
       if options[:play]
         repl_obj.play_back(opts)
       # when the user supplied a file name without using the args (stdin)

data/lib/puppet-debugger/support.rb

@@ -16,6 +16,7 @@ module PuppetDebugger
     include PuppetDebugger::Support::Scope
     include PuppetDebugger::Support::Functions
     include PuppetDebugger::Support::Node
+    include PuppetDebugger::Support::Loader
     include PuppetDebugger::Support::InputResponders
     include PuppetDebugger::Support::Play
 
@@ -44,17 +45,6 @@ module PuppetDebugger
       end
     end
 
-    # returns an array of module directories, generally this is the only place
-    # to look for puppet code by default.  This is read from the puppet configuration
-    def default_modules_paths
-      dirs = []
-      do_initialize if Puppet[:codedir].nil?
-      # add the puppet-debugger directory so we can load any defined functions
-      dirs << File.join(Puppet[:environmentpath], default_puppet_env_name, 'modules') unless Puppet[:environmentpath].empty?
-      dirs << Puppet.settings[:basemodulepath].split(':')
-      dirs.flatten
-    end
-
     # this is the lib directory of this gem
     # in order to load any puppet functions from this gem we need to add the lib path
     # of this gem
@@ -62,14 +52,9 @@ module PuppetDebugger
       File.expand_path(File.join(File.dirname(File.dirname(File.dirname(__FILE__))), 'lib'))
     end
 
-    # returns all the modules paths defined in the environment
-    def modules_paths
-      puppet_environment.full_modulepath
-    end
-
     def initialize_from_scope(value)
       set_scope(value)
-      unless value.nil?
+      if value
         set_environment(value.environment)
         set_node(value.compiler.node)
         set_compiler(value.compiler)
@@ -105,7 +90,6 @@ module PuppetDebugger
       Puppet[:parser] = 'future' # this is required in order to work with puppet 3.8
       Puppet[:trusted_node_data] = true
     rescue ArgumentError => e
-
     rescue Puppet::DevError => e
       # do nothing otherwise calling init twice raises an error
     end
@@ -147,7 +131,8 @@ module PuppetDebugger
       File.open(file, 'w') do |f|
         f.write(input)
       end
-      Puppet.override({ code: input, global_scope: scope, loaders: scope.compiler.loaders }, 'For puppet-debugger') do
+      Puppet.override({ current_environment: puppet_environment, code: input,
+                        global_scope: scope, loaders: scope.compiler.loaders }, 'For puppet-debugger') do
         # because the repl is not a module we leave the modname blank
         scope.environment.known_resource_types.import_ast(ast, '')
         parser.evaluate_string(scope, input, File.expand_path(file))
@@ -164,13 +149,5 @@ module PuppetDebugger
     def parser
       @parser ||= ::Puppet::Pops::Parser::EvaluatingParser.new
     end
-
-    def default_manifests_dir
-      File.join(Puppet[:environmentpath], default_puppet_env_name, 'manifests')
-    end
-
-    def default_site_manifest
-      File.join(default_manifests_dir, 'site.pp')
-    end
   end
 end

data/lib/puppet-debugger/support/compiler.rb

@@ -9,7 +9,7 @@ module PuppetDebugger
       end
 
       def compiler
-        @compiler
+        @compiler ||= create_compiler(node)
       end
 
       def set_compiler(value)

data/lib/puppet-debugger/support/environment.rb

@@ -8,12 +8,39 @@ module PuppetDebugger
         @puppet_environment ||= create_environment
       end
 
+      # returns an array of module directories, generally this is the only place
+      # to look for puppet code by default.  This is read from the puppet configuration
+      def default_modules_paths
+        dirs = []
+        # add the puppet-debugger directory so we can load any defined functions
+        dirs << File.join(Puppet[:environmentpath], default_puppet_env_name, 'modules') unless Puppet[:environmentpath].empty?
+        dirs << Puppet.settings[:basemodulepath].split(File::PATH_SEPARATOR)
+        dirs.flatten
+      end
+
+      # returns all the modules paths defined in the environment
+      def modules_paths
+        puppet_environment.full_modulepath
+      end
+
+      def default_manifests_dir
+        File.join(Puppet[:environmentpath], Puppet[:environment], 'manifests')
+      end
+
+      def default_site_manifest
+        File.join(default_manifests_dir, 'site.pp')
+      end
+
+      # returns the environment
       def create_environment
-        @puppet_environment = Puppet::Node::Environment.create(
-          default_puppet_env_name,
-          default_modules_paths,
-          default_manifests_dir
-        )
+        Puppet::Node::Environment.create(Puppet[:environment],
+                                                   default_modules_paths,
+                                                   default_manifests_dir)
+      end
+
+      def create_node_environment(manifest = nil)
+        env = Puppet.lookup(:current_environment)
+        manifest ? env.override_with(manifest: manifest) : env
       end
 
       def set_environment(value)