puppet-debugger 0.4.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e827c2ef8f176fac5a49ad37ca3aa17ce143595a
+  data.tar.gz: bf1db7841f1b6f1e42e49e84819d02482345cb92
+SHA512:
+  metadata.gz: 882a35ed85e35402cd10a39379e99168e2d973341910c0ebca62a8896176477c943f0e23e18cd2fd2daadae01ecae2b90ff1ddfaf4c4b10cd8971177603b6b9e
+  data.tar.gz: d43765702b3c5f8e3ce6cd1f58b09bc2c1c6e8da49e26ac20bd80f444edb100d709f0abe21dea0dca64b7818a6e810ff1f8671a80e3228ad94fae126fe8017c6

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/.gitignore

@@ -0,0 +1,54 @@
+# rcov generated
+.puppet_repl_input*
+local_test_results
+bundle
+bundler
+vendor
+coverage
+coverage.data
+
+# rdoc generated
+rdoc
+
+# yard generated
+doc
+.yardoc
+
+# bundler
+.bundle
+
+# jeweler generated
+pkg
+
+# Have editor/IDE/OS specific files you need to ignore? Consider using a global gitignore: 
+#
+# * Create a file at ~/.gitignore
+# * Include files you want ignored
+# * Run: git config --global core.excludesfile ~/.gitignore
+#
+# After doing this, these files will be ignored in all your git projects,
+# saving you from having to 'pollute' every project you touch with them
+#
+# Not sure what to needs to be ignored for particular editors/OSes? Here's some ideas to get you started. (Remember, remove the leading # of the line)
+#
+# For MacOS:
+#
+#.DS_Store
+
+# For TextMate
+#*.tmproj
+#tmtags
+
+# For emacs:
+#*~
+#\#*
+#.\#*
+
+# For vim:
+#*.swp
+
+# For redcar:
+#.redcar
+
+# For rubinius:
+#*.rbc

data/.gitlab-ci.yml

@@ -0,0 +1,129 @@
+stages:
+  - test
+  - deploy
+  - web_deploy
+
+.puppet_def: &puppet_job_def
+  stage: test
+  script:
+    - gem update --system > /dev/null
+    - gem install bundler > /dev/null
+    - bundle install --without development
+    - bundle exec puppet module install puppetlabs-stdlib
+    - bundle exec rake spec
+
+web_trigger_staging:
+  type: web_deploy
+  variables:
+    REF: staging
+  only:
+    - master
+  script:
+    - "curl -X POST -F token=$PREPL_BUILD_TRIGGER_TOKEN -F ref=$REF https://gitlab.com/api/v3/projects/1146764/trigger/builds"
+
+web_trigger_production:
+  type: web_deploy
+  variables:
+    REF: production
+  only:
+    - tags
+  script:
+    - "curl -X POST -F token=$PREPL_BUILD_TRIGGER_TOKEN -F ref=$REF https://gitlab.com/api/v3/projects/1146764/trigger/builds"
+
+.ruby_193: &ruby193
+  image: ruby:1.9.3
+
+.ruby_20: &ruby20
+  image: ruby:2.0
+
+.ruby_21: &ruby21
+  image: ruby:2.1
+
+.ruby_22: &ruby22
+  image: ruby:2.2
+
+.ruby_23: &ruby23
+  image: ruby:2.3
+
+gem_production:
+  image: ruby:2.1
+  before_script:
+    - gem install dpl
+  stage: deploy
+  script:
+    - dpl --provider=rubygems --api-key=$RUBYGEMS_API_KEY
+  only:
+    - tags
+
+puppet_38_ruby193:
+  variables:
+    PUPPET_GEM_VERSION: "~> 3.8"
+  <<: *puppet_job_def
+  <<: *ruby193
+
+puppet_38_ruby20:
+  variables:
+    PUPPET_GEM_VERSION: "~> 3.8"
+  <<: *puppet_job_def
+  <<: *ruby20
+
+puppet_38_ruby21:
+  variables:
+    PUPPET_GEM_VERSION: "~> 3.8"
+  <<: *puppet_job_def
+  <<: *ruby21
+
+puppet_43_ruby20:
+  variables:
+    PUPPET_GEM_VERSION: "~> 4.3"
+  <<: *puppet_job_def
+  <<: *ruby20
+
+puppet_43_ruby21:
+  variables:
+    PUPPET_GEM_VERSION: "~> 4.3"
+  <<: *puppet_job_def
+  <<: *ruby21
+
+puppet_43_ruby22:
+  variables:
+    PUPPET_GEM_VERSION: "~> 4.3"
+  <<: *puppet_job_def
+  <<: *ruby22
+
+puppet_44_ruby21:
+  variables:
+    PUPPET_GEM_VERSION: "~> 4.4"
+  <<: *puppet_job_def
+  <<: *ruby21
+
+puppet_44_ruby22:
+  variables:
+    PUPPET_GEM_VERSION: "~> 4.4"
+  <<: *puppet_job_def
+  <<: *ruby22
+
+puppet_45_ruby21:
+  variables:
+    PUPPET_GEM_VERSION: "~> 4.5"
+  <<: *puppet_job_def
+  <<: *ruby21
+
+puppet_46_ruby22:
+  variables:
+    PUPPET_GEM_VERSION: "~> 4.6"
+  <<: *puppet_job_def
+  <<: *ruby22
+
+puppet_47_ruby22:
+  variables:
+    PUPPET_GEM_VERSION: "~> 4.7"
+  <<: *puppet_job_def
+  <<: *ruby22
+
+puppet_48_ruby22:
+  variables:
+    PUPPET_GEM_VERSION: "~> 4.8"
+  <<: *puppet_job_def
+  <<: *ruby22
+

data/.rspec

@@ -0,0 +1,3 @@
+--no-color
+--format documentation
+--tty

data/CHANGELOG.md

@@ -0,0 +1,61 @@
+## 0.4.0
+  * Rename to puppet-debugger
+## 0.3.4
+  * Fixes issue with temporary file not being unique
+## 0.3.3
+  * Adds ability to call breakpoints from within repl
+  * Adds newline for each multiline input
+## 0.3.2
+  * Fixes #31 - adds ability to show surrounding code
+## 0.3.1
+  * Fixes #28 - puppet 4.6 support
+  * Fixes #27 - repl should throw puppet error message instead of stacktrace
+  * adds support for customizing facterdb filter
+  * adds support for puppet 4.6
+  * Fixes #26 - allow configuration of facter version and facterdb filter
+
+## 0.3.0
+  * Fixes #23 - add quiet flag to suppress banner
+  * Fixes #11 - cannot declare and use a class or define
+## 0.2.3
+  * fixes #21 - type display causes error
+## 0.2.2
+  * adds better support for playing back puppet code
+    * this now allows playback of any manifest
+    * allows mixed puppet code and repl commands
+## 0.2.1
+  * Fixes #2 - adds support for multiline input
+
+## 0.2.0
+  * Fixes #19 - lock down dependency versions
+  * fixes #18 - add ability to filter out functions based on namespace
+  * fixes #15 - node classes return error
+  * fixes #16 - use auto complete on functions and variables
+  * Fixes #14 - add functionality to set node object from remote source
+  * adds support for server_facts
+  * fixes other minor bugs found along the way
+  * adds ability to list classification parameters from ENC
+
+## 0.1.1
+  * adds ability to load files or urls
+
+## 0.1.0
+  * ensure the title of classes contains quotes
+  * adds support to import a file or import from stdin
+  * added additional ap support for puppet::pops::types
+  * adds ability to print resources and classes
+  * adds the ability to pass in a scope
+
+## 0.0.8
+  * adds ability to list currently loaded classes
+  * adds formatted output using awesome print
+  * adds verbose type output when creating resources
+
+## 0.0.7
+  * Added ability to list scope variables
+
+## 0.0.6
+  * Bug fix for puppet 3.8   
+
+## 0.0.5
+  * Added ability to set puppet log level  

data/Gemfile

@@ -0,0 +1,18 @@
+source "http://rubygems.org"
+gem 'puppet', ENV['PUPPET_GEM_VERSION'] || ">= 3.8"
+gem 'facterdb', "~> 0.3"
+gem 'awesome_print', "~> 1.6"
+
+group :test do
+  # ruby versions prior to 2.0 cannot install json_pure 2.0.2+
+  gem 'json_pure', '<= 2.0.1'
+  gem "rdoc", "~> 3.12"
+  gem "rspec"
+  gem "bundler"
+  gem "simplecov", ">= 0"
+  gem 'rake'
+end
+
+group :development do
+  gem 'pry'
+end

data/Gemfile.lock

@@ -0,0 +1,67 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    CFPropertyList (2.2.8)
+    awesome_print (1.7.0)
+    coderay (1.1.1)
+    diff-lcs (1.2.5)
+    docile (1.1.5)
+    facter (2.4.6)
+      CFPropertyList (~> 2.2.6)
+    facterdb (0.3.6)
+      facter
+      jgrep
+    hiera (3.2.1)
+    jgrep (1.4.1)
+      json
+    json (1.8.3)
+    json_pure (1.8.3)
+    method_source (0.8.2)
+    pry (0.10.4)
+      coderay (~> 1.1.0)
+      method_source (~> 0.8.1)
+      slop (~> 3.4)
+    puppet (4.7.0)
+      facter (> 2.0, < 4)
+      hiera (>= 2.0, < 4)
+      json_pure (~> 1.8)
+    rake (11.2.2)
+    rdoc (3.12.2)
+      json (~> 1.4)
+    rspec (3.5.0)
+      rspec-core (~> 3.5.0)
+      rspec-expectations (~> 3.5.0)
+      rspec-mocks (~> 3.5.0)
+    rspec-core (3.5.2)
+      rspec-support (~> 3.5.0)
+    rspec-expectations (3.5.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.5.0)
+    rspec-mocks (3.5.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.5.0)
+    rspec-support (3.5.0)
+    simplecov (0.12.0)
+      docile (~> 1.1.0)
+      json (>= 1.8, < 3)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.0)
+    slop (3.6.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  awesome_print (~> 1.6)
+  bundler
+  facterdb (~> 0.3)
+  json_pure (<= 2.0.1)
+  pry
+  puppet (~> 4.3)
+  rake
+  rdoc (~> 3.12)
+  rspec
+  simplecov
+
+BUNDLED WITH
+   1.13.6

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2016 Corey Osman
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,276 @@
+<!-- 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)*
+
+- [puppet-debugger](#puppet-debugger)
+  - [Compatibility](#compatibility)
+  - [Production usage](#production-usage)
+  - [Installation](#installation)
+  - [Load path](#load-path)
+  - [Interactive demo](#interactive-demo)
+  - [Web demo](#web-demo)
+  - [Usage](#usage)
+  - [Using Variables](#using-variables)
+    - [Listing variables](#listing-variables)
+  - [Listing functions](#listing-functions)
+  - [Using functions](#using-functions)
+  - [Duplicate resource error](#duplicate-resource-error)
+  - [Setting the puppet log level](#setting-the-puppet-log-level)
+  - [Remote nodes](#remote-nodes)
+    - [Setup](#setup)
+    - [Usage](#usage-1)
+      - [Command line:](#command-line)
+      - [From repl session:](#from-repl-session)
+  - [Auto Complete](#auto-complete)
+  - [Playback support](#playback-support)
+  - [Troubleshooting](#troubleshooting)
+  - [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
+
+A interactive command line tool for evaluating and debugging the puppet language.
+
+## Compatibility
+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
+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
+`gem install puppet-debugger`
+
+## Load path
+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.
+
+## 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://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.
+
+## Usage
+puppet-debugger will only parse and evaulate your code.  It will not build a catalog
+and try to enforce the catalog. This has a few side affects.
+
+1. Type and provider code will not get run.
+2. Nothing is created or destroyed on your system.
+
+`pdb`
+
+Example Usage
+```
+MacBook-Pro-2/tmp % pdb
+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.
+
+>> ['/tmp/test3', '/tmp/test4'].each |String $path| { file{$path: ensure => present} }
+  => [
+     [0] "/tmp/test3",
+     [1] "/tmp/test4"
+ ]
+ >>
+
+```
+
+## Using Variables
+
+```
+MacBook-Pro-2/tmp % pdb
+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:
+`pdb -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.
+
+* `REPL_FACTERDB_FILTER`  Sets the entire filter
+* `REPL_FACTER_OS_VERSION` Sets the OS version (only works with RHEL clones and Fedora)
+* `REPL_FACTER_OS_NAME` Sets the OS name (only works with RHEL clones and Fedora)
+* `REPL_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.
+
+## 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
+
+`pdb -p https://gist.githubusercontent.com/logicminds/f9b1ac65a3a440d562b0/raw`
+
+or just use STDIN  `pdb <some_file>` or `echo "abs(-3)" | pdb`
+
+### 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.
+
+## Troubleshooting
+Please file an issue so we can track bugs.
+
+
+Pull requests welcomed.
+
+## Copyright
+
+Copyright (c) 2016 Corey Osman. See LICENSE.txt for
+further details.

data/Rakefile

@@ -0,0 +1,32 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'bundler'
+require "bundler/gem_tasks"
+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"
+  exit e.status_code
+end
+require 'rake'
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb']
+end
+
+task :default => :spec
+
+require 'rdoc/task'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "puppet-debugger #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/bin/pdb

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+require_relative '../lib/puppet-debugger'
+
+PuppetDebugger::Cli.start