puppet-repl 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b9496d20d14a3fca24bfc9bc6d052e05e63a653b
-  data.tar.gz: 1929ee4b440a14225194aff0078ab50b5b558840
+  metadata.gz: 395dca824498b20ef6c0c3fbcdbbd70f77e1b44f
+  data.tar.gz: a2695e31bf0cdb543fff05c8437af71505ca75a6
 SHA512:
-  metadata.gz: 78c385e129a628a5ab0944e857aafbf60b8874813c592fcedf212ad29d974b11b18b9504ff20e3f297a576d8865b3aa7a9e84b2cae28a11c2bb41781aab645e8
-  data.tar.gz: 21f956516bb34e08a76388cc7d1fb07ca0daa3e461054ae54113cdca4664a234d37edd0c7405589302ff06eb4e141bdd184bc196c34bba2ff844dc598dcf7b6b
+  metadata.gz: e69332b0167a1db4d32ad151eb6468e7463ec1ca8bb3deff7d1698226924b665169d52a0fc7add5ff2a38385f2f3dc2264e3a2099b3513d23949f3f05f174d49
+  data.tar.gz: 05259e58f876fdc50a83711adf9cf7e2c57f0941b41610130a2d89e2be247074a58ff5b33cd70c629caf565756a56b162c3c622a0efdf3eca7ce923be95fef2f

data/.rspec

@@ -1 +1,2 @@
 --color
+--format documentation

data/.travis.yml

@@ -2,11 +2,12 @@ language: ruby
 cache: bundler
 install: "bundle install --without development"
 before_script: "bundle exec puppet module install puppetlabs-stdlib"
-script: "bundle exec rake spec SPEC_OPTS='--format documentation'"
+script: "bundle exec rspec"
 rvm:
   - 1.9.3
   - 2.0.0
   - 2.2.1
+  - 2.1.3
 env:
   matrix:
     - PUPPET_GEM_VERSION="~> 3.8"
@@ -20,3 +21,9 @@ matrix:
   exclude:
     - rvm: 2.2.1
       env: PUPPET_GEM_VERSION="~> 3.8"
+    - rvm: 1.9.3
+      env: PUPPET_GEM_VERSION="~> 4.4"
+    - rvm: 1.9.3
+      env: PUPPET_GEM_VERSION="~> 4.3"
+    - rvm: 1.9.3
+      env: PUPPET_GEM_VERSION="~> 4.2"    

data/CHANGELOG.md

@@ -1,6 +1,22 @@
+## 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
+  * 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 formatted output using awesome print
   * adds verbose type output when creating resources
 ## 0.0.7
   * Added ability to list scope variables

data/Gemfile

@@ -1,18 +1,16 @@
 source "http://rubygems.org"
 gem 'puppet', ENV['PUPPET_GEM_VERSION'] || ">= 3.8"
-gem 'facterdb'
-gem 'awesome_print'
-
+gem 'facterdb', "~> 0.3"
+gem 'awesome_print', "~> 1.6"
 group :test do
   gem "rspec"
-  gem 'rspec-puppet'
   gem "bundler"
   gem "jeweler", "~> 2.0.1"
   gem "simplecov", ">= 0"
   gem 'rake'
+  gem 'pry'
 end
 
 group :development do
-  gem 'pry'
   gem "rdoc", "~> 3.12"
 end

data/Gemfile.lock

@@ -5,20 +5,19 @@ GEM
     addressable (2.4.0)
     awesome_print (1.6.1)
     builder (3.2.2)
-    coderay (1.1.0)
+    coderay (1.1.1)
     descendants_tracker (0.0.4)
       thread_safe (~> 0.3, >= 0.3.1)
     diff-lcs (1.2.5)
     docile (1.1.5)
     facter (2.4.6)
       CFPropertyList (~> 2.2.6)
-    facterdb (0.3.1)
+    facterdb (0.3.5)
       facter
       jgrep
-      json
     faraday (0.9.2)
       multipart-post (>= 1.2, < 3)
-    git (1.2.9.1)
+    git (1.3.0)
     github_api (0.13.1)
       addressable (~> 2.4.0)
       descendants_tracker (~> 0.0.4)
@@ -26,8 +25,8 @@ GEM
       hashie (>= 3.4)
       multi_json (>= 1.7.5, < 2.0)
       oauth2
-    hashie (3.4.3)
-    hiera (1.3.4)
+    hashie (3.4.4)
+    hiera (3.1.2)
       json_pure
     highline (1.7.8)
     jeweler (2.0.1)
@@ -39,14 +38,14 @@ GEM
       nokogiri (>= 1.5.10)
       rake
       rdoc
-    jgrep (1.4.0)
+    jgrep (1.4.1)
       json
     json (1.8.3)
     json_pure (1.8.3)
     jwt (1.5.1)
     method_source (0.8.2)
     mini_portile2 (2.0.0)
-    multi_json (1.11.2)
+    multi_json (1.12.0)
     multi_xml (0.5.5)
     multipart-post (2.0.0)
     nokogiri (1.6.7.2)
@@ -61,19 +60,20 @@ GEM
       coderay (~> 1.1.0)
       method_source (~> 0.8.1)
       slop (~> 3.4)
-    puppet (3.8.5)
-      facter (> 1.6, < 3)
-      hiera (~> 1.0)
+    puppet (4.4.2)
+      CFPropertyList (~> 2.2.6)
+      facter (> 2.0, < 4)
+      hiera (>= 2.0, < 4)
       json_pure
     rack (1.6.4)
-    rake (10.5.0)
+    rake (11.1.2)
     rdoc (3.12.2)
       json (~> 1.4)
     rspec (3.4.0)
       rspec-core (~> 3.4.0)
       rspec-expectations (~> 3.4.0)
       rspec-mocks (~> 3.4.0)
-    rspec-core (3.4.3)
+    rspec-core (3.4.4)
       rspec-support (~> 3.4.0)
     rspec-expectations (3.4.0)
       diff-lcs (>= 1.2.0, < 2.0)
@@ -81,8 +81,6 @@ GEM
     rspec-mocks (3.4.1)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.4.0)
-    rspec-puppet (2.4.0)
-      rspec
     rspec-support (3.4.1)
     simplecov (0.11.2)
       docile (~> 1.1.0)
@@ -96,17 +94,16 @@ PLATFORMS
   ruby
 
 DEPENDENCIES
-  awesome_print
+  awesome_print (~> 1.6)
   bundler
-  facterdb
+  facterdb (~> 0.3)
   jeweler (~> 2.0.1)
   pry
   puppet (>= 3.8)
   rake
   rdoc (~> 3.12)
   rspec
-  rspec-puppet
   simplecov
 
 BUNDLED WITH
-   1.11.2
+   1.12.3

data/README.md

@@ -4,21 +4,30 @@
 
 - [puppet-repl](#puppet-repl)
   - [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)
-  - [Forward](#forward)
   - [Copyright](#copyright)
 
 <!-- END doctoc generated TOC please keep comment here to allow auto update -->
-
-[![Build Status](https://travis-ci.org/nwops/puppet-repl.png)](https://travis-ci.org/nwops/puppet-repl)[![Gem Version](https://badge.fury.io/rb/puppet-repl.svg)](https://badge.fury.io/rb/puppet-repl)
+[![BuildStatus](https://travis-ci.org/nwops/puppet-repl.svg?branch=master)](https://travis-ci.org/nwops/puppet-repl?branch=master)[![Gem Version](https://badge.fury.io/rb/puppet-repl.svg)](https://badge.fury.io/rb/puppet-repl)
 # puppet-repl
 
 A interactive command line tool for evaluating the puppet language.
@@ -42,10 +51,14 @@ 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-repl.  This was originally intended when giving a demo of the repl, but also seems
-useful for other people. 
+useful for other people.
 
 https://github.com/nwops/puppet-repl-demo
 
+## Web demo
+There is a web version of the [puppet-repl](https://www.puppet-repl.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-repl 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.
@@ -112,36 +125,16 @@ Type "exit", "functions", "vars", "krt", "facts", "reset", "help" for more infor
 ### Listing variables
 To see the current variables in the scope use the  `vars` keyword.
 
-```
->> $var1 = 'value'
-=> value
->> $var2 = {'key1' => 'value1'}
-=> {"key1"=>"value1"}
->> vars
-"Facts were removed for easier viewing"
-{
-"datacenter"  => "datacenter1",
-"facts"       => "removed by the puppet-repl",
-"module_name" => "",
-"name"        => "main",
-"title"       => "main",
-"trusted"     => {
-      "authenticated" => "local",
-      "certname"      => nil,
-      "domain"        => nil,
-      "extensions"    => {},
-      "hostname"      => nil
-      },
-"var1"        => "value",
-"var2"        => {
-  "key1" => "value1"
-  }
-}
+![variables](resources/variables.png)
+
+## Listing functions
+Knowing what functions are available and where they come from is extremely helpful especially in a repl 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.
+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','/')
@@ -166,22 +159,80 @@ If you want to see what puppet is doing behind the scenes you can set the log le
 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('value')
- => foo
->> :set loglevel debug
-loglevel debug is set
->> hiera('value')
-Debug: hiera(): Looking up value in YAML backend
-Debug: hiera(): Looking for data source nodes/foo.example.com
-Debug: hiera(): Found value in nodes/foo.example.com
- => foo
-```
+![hiera](resources/hiera.png)
+
+## Remote nodes
+This is new for 0.2.0.  The puppet-repl 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 repl 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-repl/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-repl 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-repl-demo/modules:/Users/cosman/Downloads/pe_modules
+    hiera_config = /Users/cosman/github/puppet-repl-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 repl session.
+
+#### Command line:
+`prepl -n node_name`
+
+![command line](resources/command_line_node.png)
+
+#### From repl 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-repl uses readline internally.  So any variable or function is also available for auto completion.
+Press the tab key to engage the auto complete functionality.
+
+## Playback support
+Puppet-repl now supports playing back files or urls and loading the content into the repl session.  This means if you want to start a repl session from an existing file or url you can play the content back in the repl.  Support for this functionality is extremely limited due to #2.  However, if you list things on a single line
+you "could" overcome this limitation.
+
+`play https://gist.githubusercontent.com/logicminds/f9b1ac65a3a440d562b0/raw`
+
+or
+
+`prepl -p https://gist.githubusercontent.com/logicminds/f9b1ac65a3a440d562b0/raw`
+
 ## Troubleshooting
+Please file an issue so we can track bugs.
 
-## Forward
-I was just playing around and created this simple tool.  Its beta quality,
-and a ton of features need to be added. Please create a issue if you see a bug or feature that should be added.
 
 Pull requests welcomed.
 

data/VERSION

@@ -1 +1 @@
-0.1.1
+0.2.0

data/lib/awesome_print/ext/awesome_puppet.rb

@@ -9,11 +9,12 @@ module AwesomePrint
     # about printing different puppet objects
     def cast_with_puppet_resource(object, type)
       cast = cast_without_puppet_resource(object, type)
-      if (defined?(::Puppet::Type)) && (object.is_a?(::Puppet::Type))
+      # check the object to see if it has an acestor (< ) of the specified type
+      if (defined?(::Puppet::Type)) && (object.class < ::Puppet::Type)
         cast = :puppet_type
-      elsif (defined?(::Puppet::Pops::Types)) && (object.is_a?(::Puppet::Pops::Types))
-        cast = :puppet_type  
-      elsif (defined?(::Puppet::Parser::Resource)) && (object.is_a?(::Puppet::Parser::Resource))
+      elsif (defined?(::Puppet::Pops::Types)) && (object.class < ::Puppet::Pops::Types)
+        cast = :puppet_type
+      elsif (defined?(::Puppet::Parser::Resource)) && (object.class < ::Puppet::Parser::Resource)
         cast = :puppet_resource
       end
       cast

data/lib/puppet-repl/cli.rb

@@ -7,33 +7,68 @@ module PuppetRepl
   class Cli
     include PuppetRepl::Support
 
-    attr_accessor :settings, :log_level
+    attr_accessor :settings, :log_level, :in_buffer, :out_buffer, :html_mode
 
-    def initialize
+    def initialize(options={})
       @log_level = 'notice'
+      @out_buffer = options[:out_buffer] || $stdout
+      @html_mode = options[:html_mode] || false
+      @in_buffer = options[:in_buffer] || $stdin
+      comp = Proc.new do |s|
+        key_words.grep(/^#{Regexp.escape(s)}/)
+      end
+      Readline.completion_append_character = ""
+      Readline.basic_word_break_characters = " "
+
+      Readline.completion_proc = comp
+      AwesomePrint.defaults = {
+        :html => @html_mode,
+        :sort_keys => true,
+        :indent => 2
+      }
+      do_initialize
     end
 
-    def ap_formatter
-      unless @ap_formatter
-        inspector = AwesomePrint::Inspector.new({:sort_keys => true, :indent => 2})
-        @ap_formatter = AwesomePrint::Formatter.new(inspector)
-      end
-      @ap_formatter
+    # returns a cached list of key words
+    def key_words
+      # because dollar signs don't work we can't display a $ sign in the keyword
+      # list so its not explicitly clear what the keyword
+      variables = scope.to_hash.keys
+      # prepend a :: to topscope variables
+      scoped_vars = variables.map { |k,v| scope.compiler.topscope.exist?(k) ? "$::#{k}" : "$#{k}" }
+      # append a () to functions so we know they are functions
+      funcs = function_map.keys.map { |k| "#{k.split('::').last}()"}
+      (scoped_vars + funcs + static_responder_list).uniq.sort
     end
 
     def puppet_eval(input)
       parser.evaluate_string(scope, input)
     end
 
+    # looks up the type in the catalog by using the type and title
+    # and returns the resource in ral format
     def to_resource_declaration(type)
-      res = scope.catalog.resource(type.type_name, type.title)
-      res.to_ral
+      if type.respond_to?(:type_name) and type.respond_to?(:title)
+        title = type.title
+        type_name = type.type_name
+      else
+        # not all types have a type_name and title so we
+        # output to a string and parse the results
+        type_result = /(\w+)\['?(\w+)'?\]/.match(type.to_s)
+        title = type_result[2]
+        type_name = type_result[1]
+      end
+      res = scope.catalog.resource(type_name, title)
+      if res
+        return res.to_ral
+      end
+      # don't return anything or returns nil if item is not in the catalog
     end
 
     # ruturns a formatted array
     def expand_resource_type(types)
       output = [types].flatten.map do |t|
-        if t.class.to_s == 'Puppet::Pops::Types::PResourceType'
+        if t.class.to_s =~ /Puppet::Pops::Types/
           to_resource_declaration(t)
         else
           t
@@ -49,82 +84,77 @@ module PuppetRepl
           return output.first
         end
         return output
-      elsif result.instance_of?(Puppet::Pops::Types::PResourceType)
+      elsif result.class.to_s =~ /Puppet::Pops::Types/
         return to_resource_declaration(result)
       end
       result
     end
 
-    def set_log_level(level)
-      Puppet::Util::Log.level = level.to_sym
-      Puppet::Util::Log.newdestination(:console)
-    end
-
-    def handle_set(input)
-      args = input.split(' ')
-      args.shift # throw away the set
-      case args.shift
-      when /loglevel/
-        if level = args.shift
-          @log_level = level
-          set_log_level(level)
-          puts "loglevel #{Puppet::Util::Log.level} is set"
-        end
-      end
-    end
-
-    def handle_input(input)
-      case input
-      when /^play|^facts|^vars|^functions|^classes|^resources|^krt|^environment|^reset|^help/
-        args = input.split(' ')
-        command = args.shift.to_sym
-        if self.respond_to?(command)
-          self.send(command, args)
-        end
-      when /exit/
-        exit 0
-      when /^:set/
-        handle_set(input)
-      when '_'
-        puts(" => #{@last_item}")
-      else
+    def handle_input(input_text)
+      input_text.split("\n").each do |input|
         begin
-          result = puppet_eval(input)
-          @last_item = result
-          print " => "
-          output = normalize_output(result)
-          if output.nil?
-            puts ""
+          output = ''
+          case input
+          when /^play|^classification|^facts|^vars|^functions|^classes|^resources|^krt|^environment|^reset|^help/
+            args = input.split(' ')
+            command = args.shift.to_sym
+            if self.respond_to?(command)
+              output = self.send(command, args)
+            end
+            return out_buffer.puts output
+          when /exit/
+            exit 0
+          when /^:set/
+            output = handle_set(input)
+          when '_'
+            output = " => #{@last_item}"
           else
-            ap(output)
+            result = puppet_eval(input)
+            @last_item = result
+            output = normalize_output(result)
+            if output.nil?
+              output = ""
+            else
+              output = output.ai
+            end
           end
+        rescue LoadError => e
+          output = e.message.fatal
+        rescue Errno::ETIMEDOUT => e
+          output = e.message.fatal
         rescue ArgumentError => e
-          print " => "
-          puts e.message.fatal
+          output = e.message.fatal
         rescue Puppet::ResourceError => e
-          print " => "
-          puts e.message.fatal
+          output = e.message.fatal
         rescue Puppet::ParseErrorWithIssue => e
-          print " => "
-          puts e.message.fatal
-        rescue Exception => e
-          puts e.message.fatal
+          output = e.message.fatal
+        rescue PuppetRepl::Exception::FatalError => e
+          output = e.message.fatal
+          out_buffer.puts output
+          exit 1
+        rescue PuppetRepl::Exception::Error => e
+          output = e.message.fatal
         end
+        out_buffer.print " => "
+        out_buffer.puts output
       end
     end
 
     def self.print_repl_desc
-      puts(<<-EOT)
+      output = <<-EOT
 Ruby Version: #{RUBY_VERSION}
 Puppet Version: #{Puppet.version}
 Puppet Repl Version: #{PuppetRepl::VERSION}
 Created by: NWOps <corey@nwops.io>
 Type "exit", "functions", "vars", "krt", "facts", "resources", "classes",
-     "play","reset", or "help" for more information.
+     "play", "classification", "reset", or "help" for more information.
 
       EOT
+      output
     end
 
+    # reads input from stdin, since readline requires a tty
+    # we cannot read from other sources as readline requires a file object
     def read_loop
       while buf = Readline.readline(">> ", true)
         handle_input(buf)
@@ -138,11 +168,13 @@ Type "exit", "functions", "vars", "krt", "facts", "resources", "classes",
     def self.start(options={:scope => nil})
       opts = Trollop::options do
         opt :play, "Url or file to load from", :required => false, :type => String
-        opt :run_once, "Evaulate and quit", :required => false, :default => false
+        opt :run_once, "Evaluate and quit", :required => false, :default => false
+        opt :node_name, "Remote Node to grab facts from", :required => false, :type => String
       end
       options = opts.merge(options)
-      print_repl_desc
+      puts print_repl_desc
       repl_obj = new
+      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)

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

@@ -4,15 +4,15 @@ module PuppetRepl
       # creates a puppet environment given a module path and environment name
       # this is cached
       def puppet_environment
-        unless @puppet_environment
-          do_initialize
-          @puppet_environment = Puppet::Node::Environment.create(
+        @puppet_environment ||= create_environment
+      end
+
+      def create_environment
+        @puppet_environment = Puppet::Node::Environment.create(
           default_puppet_env_name,
           default_modules_paths,
           default_manifests_dir
-          )
-        end
-        @puppet_environment
+        )
       end
 
       def set_environment(value)