puppet-debugger 0.7.0 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6e41642281d06f230cba649f0ad0cca8845fc713
-  data.tar.gz: 5f51ef9afa5c431937be5fa750978b3bedcf1b70
+  metadata.gz: 06bfeaee11d72cc1f5e2a68a325bf5c892df207a
+  data.tar.gz: 3ddd0743cc4daa1079174a4477c4863a373c326b
 SHA512:
-  metadata.gz: 991540c9bb5dbd2e8995695818f0c05ce139c2832cfccd793ad01b3c062d242fd70026b4d4b2d19773b0268d0bc6d8d6709241dbe8bf030dd0663215ec43f1bf
-  data.tar.gz: bd44969d0b5b2c934de7f4705ed6fa9828363d9c5e8a4a8bbcd672da351885552ab3e54d2b8197a26b56d6729fab21a97aa7eb536f4c6da0e07c73e1959ee6d5
+  metadata.gz: 07523f3f0f261e283c35c2d74f4feceba1f0d8a5b5416aa6b5f1206870fc28948fa231758ce41988c02788fc94ea7c5d11fcc17c2d922ef811e733c4a1959a20
+  data.tar.gz: accdd33ea736b3948e5191f27384135aada416962e740eaecde54a4147ed2bc4e0276c620272a725c5b5c6fca6f21df0e71a9111c73f2662e8bd5a26a268b93b

data/.gitignore

@@ -10,6 +10,7 @@ bundler
 vendor
 coverage
 coverage.data
+.DS*
 
 # rdoc generated
 rdoc
@@ -24,7 +25,7 @@ doc
 # jeweler generated
 pkg
 
-# Have editor/IDE/OS specific files you need to ignore? Consider using a global gitignore: 
+# 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

data/.gitlab-ci.yml

@@ -171,3 +171,9 @@ puppet_410_ruby24:
     PUPPET_GEM_VERSION: "~> 4.10.0"
   <<: *puppet_job_def
   <<: *ruby24
+
+puppet_5_ruby24:
+  variables:
+    PUPPET_GEM_VERSION: "~> 5.0"
+  <<: *puppet_job_def
+  <<: *ruby24

data/CHANGELOG.md

@@ -1,5 +1,12 @@
 ## Unreleased
 
+## 0.8.0
+  * Fixes bug with playback of multiline input
+  * Updates pluginator Gem to 1.5.0
+  * Adds ability to provide command completion for plugins
+  * Fixes error with commands plugin where id didn't detect bad names
+  * Fixes #3 - Move old input responder test code to individual plugin tests
+  * Adds puppet 5 to testing matrix
 ## 0.7.0
   * Adds new commands command 
   * Adds new help command 

data/Gemfile

@@ -3,7 +3,8 @@ source 'http://rubygems.org'
 gem 'awesome_print', '~> 1.7'
 gem 'facterdb', '~> 0.3.8'
 gem 'puppet', ENV['PUPPET_GEM_VERSION'] || '~> 4.10.1'
-gem 'pluginator', '~> 1.4.1'
+gem 'pluginator', '~> 1.5.0'
+
 group :test, :development do
   # ruby versions prior to 2.0 cannot install json_pure 2.0.2+
   gem 'bundler'

data/Plugin_development.md

@@ -20,6 +20,7 @@
   - [Calling other plugins](#calling-other-plugins)
     - [Indirectly](#indirectly)
     - [Directly](#directly)
+  - [Command Completion](#command-completion)
   - [Testing your plugin code](#testing-your-plugin-code)
   - [Examples](#examples)
 
@@ -199,6 +200,8 @@ Objects exposed that you might want access to:
 * compiler     (The puppet compiler object)    
 * catalog      (The puppet catalog)
 * function_map (Current map of functions)
+* add_hook, delete_hook
+* handle_input (use instead of debugger.handle_input)
 
 While you do have access to the `debugger` object itself and everything inside this object.  I would recommend not using the debugger
 object directly since the debugger code base is changing rapidly.  Usage can result in a broken plugin.  If you are using
@@ -267,12 +270,51 @@ play_plugin = PuppetDebugger::InputResponders::Commands.plugin_from_command('pla
 # execute the plugin  
 args = ['https://gists.github.com/sdalfsdfadsfds.txt']
 # pass an instance of the debugger (always do this)
-output = plugin.execute(args, debugger)
+output = play_plugin.execute(args, debugger)
 
 ```
 
 If the command used to find the plugin is incorrect a `PuppetDebugger::Exception::InvalidCommand` error will be raised.
 
+## Command Completion
+If your plugin takes extra arguments you may want to incorporate command completion to help the user.  This can be done 
+by overriding the `self.command_completion` function in your plugin. The return value of this method must return an 
+array of possible words.
+
+```ruby
+# @param buffer_words [Array[String]] a array of words the user has typed in
+# @return Array[String] - an array of words that will help the user with word completion
+# By default this returns an empty array, your plugin can chose to override this method in order to
+# provide the user with a list of key words based on the user's input
+def self.command_completion(buffer_words)
+  ['one', 'two', 'three']
+end
+```
+
+A real example of this can be found in the set plugin
+
+```ruby
+KEYWORDS = %w(node loglevel)
+LOGLEVELS = %w(debug info)
+
+def self.command_completion(buffer_words)
+next_word = buffer_words.shift
+    case next_word
+      when 'loglevel'
+        if buffer_words.count > 0
+          LOGLEVELS.grep(/^#{Regexp.escape(buffer_words.first)}/)
+        else
+          LOGLEVELS
+        end
+      when 'debug', 'info','node'
+        []
+      when nil
+        %w(node loglevel)
+      else
+        KEYWORDS.grep(/^#{Regexp.escape(next_word)}/)
+    end
+end
+```
 ## Testing your plugin code
 1. Create a new rspec test file as `spec/input_responders/plugin_name_spec.rb`
 

data/README.md

@@ -42,7 +42,7 @@ to install on your production puppet master. Please do not install because of th
 `gem install puppet-debugger`
 
 ## Load path
-puppet-debugger will load all functions from your basemodulepath and environmentpath.
+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.
@@ -267,6 +267,18 @@ 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)
  

data/Rakefile

@@ -31,3 +31,27 @@ Rake::RDocTask.new do |rdoc|
   rdoc.rdoc_files.include('README*')
   rdoc.rdoc_files.include('lib/**/*.rb')
 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, ".*")
+    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
+        require 'spec_helper'
+        require 'puppet-debugger'
+        require 'puppet-debugger/plugin_test_helper'
+
+        describe :#{orig_file} do
+        include_examples 'plugin_tests'
+        let(:args) { [] }
+
+        end
+      EOS
+      File.write(test_file, contents)
+    end
+  end
+end

data/lib/plugins/puppet-debugger/input_responders/commands.rb

@@ -68,28 +68,10 @@ module PuppetDebugger
       # @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 #{command}") unless p
+        raise PuppetDebugger::Exception::InvalidCommand.new(message: "invalid command #{name}") unless p
         p
       end
 
     end
   end
-end
-
-module Pluginator
-  # a helper for handling name / file / class conversions
-  module NameConverter
-    private
-    # full_name => class
-    def name2class(name)
-      klass = Kernel
-      name.to_s.split(%r{/}).each do |part|
-        klass = klass.const_get(
-            part.capitalize.gsub(/[_-](.)/) { |match| match[1].upcase }
-        )
-      end
-      klass
-    end
-
-  end
-end
+end

data/lib/plugins/puppet-debugger/input_responders/play.rb

@@ -79,7 +79,7 @@ module PuppetDebugger
               debugger.out_buffer.write('>> ')
             end
           rescue Puppet::ParseErrorWithIssue => e
-            if multiline_input?(e)
+            if debugger.multiline_input?(e)
               full_buffer += "\n"
               next
             end

data/lib/plugins/puppet-debugger/input_responders/set.rb

@@ -5,6 +5,26 @@ module PuppetDebugger
       COMMAND_WORDS = %w(set :set)
       SUMMARY = 'Set the a puppet debugger config'
       COMMAND_GROUP = :scope
+      KEYWORDS = %w(node loglevel)
+      LOGLEVELS = %w(debug info)
+
+      def self.command_completion(buffer_words)
+        next_word = buffer_words.shift
+        case next_word
+          when 'loglevel'
+            if buffer_words.count > 0
+              LOGLEVELS.grep(/^#{Regexp.escape(buffer_words.first)}/)
+            else
+              LOGLEVELS
+            end
+          when 'debug', 'info','node'
+            []
+          when nil
+            %w(node loglevel)
+          else
+            KEYWORDS.grep(/^#{Regexp.escape(next_word)}/)
+        end
+      end
 
       def run(args = [])
         handle_set(args)

data/lib/puppet-debugger/cli.rb

@@ -29,12 +29,9 @@ module PuppetDebugger
       @source_file = options[:source_file] || nil
       @source_line_num = options[:source_line] || nil
       @in_buffer = options[:in_buffer] || $stdin
-      comp = proc do |s|
-        key_words.grep(/^#{Regexp.escape(s)}/)
-      end
       Readline.completion_append_character = ''
       Readline.basic_word_break_characters = ' '
-      Readline.completion_proc = comp
+      Readline.completion_proc = command_completion
       AwesomePrint.defaults = {
         html: @html_mode,
         sort_keys: true,
@@ -42,6 +39,24 @@ module PuppetDebugger
       }
     end
 
+    # @return [Proc] the proc used in the command completion for readline
+    # if a plugin keyword is found lets return keywords using the plugin's command completion
+    # otherwise return the default set of keywords and filter out based on input
+    def command_completion
+      proc do |input|
+        words = Readline.line_buffer.split(Readline.basic_word_break_characters)
+        first_word = words.shift
+        plugins = PuppetDebugger::InputResponders::Commands.plugins.find_all do |p|
+          p::COMMAND_WORDS.find { |word| word.start_with?(first_word)}
+        end
+        if plugins.count == 1 and /\A#{first_word}\s/.match(Readline.line_buffer)
+          plugins.first.command_completion(words)
+        else
+          key_words.grep(/^#{Regexp.escape(input)}/)
+        end
+      end
+    end
+
     def hooks
       @hooks ||= PuppetDebugger::Hooks.new
     end

data/lib/puppet-debugger/input_responder_plugin.rb

@@ -12,22 +12,34 @@ module PuppetDebugger
       def_delegators :scope, :compiler, :catalog
       def_delegators :node, :facts
 
+      # @return [Array[String]] an array of words the user can call the command with
       def self.command_words
         self::COMMAND_WORDS
       end
 
+      # @return [String] a summary of the plugin
       def self.summary
         self::SUMMARY
       end
 
+      # @return [String] the name of the command group the plugin is in
       def self.command_group
         self::COMMAND_GROUP
       end
 
+      # @return [Hash] a has of all the details of the plugin
       def self.details
         { words: command_words, summary: summary, group: command_group }
       end
 
+      # @param buffer_words [Array[String]] a array of words the user has typed in
+      # @return Array[String] - an array of words that will help the user with word completion
+      # By default this returns an empty array, your plugin can chose to override this method in order to
+      # provide the user with a list of key words based on the user's input
+      def self.command_completion(buffer_words)
+        []
+      end
+
       # @param args [Array[String]] - an array of arguments to pass to the plugin command
       # @param debugger PuppetDebugger::Cli  - an instance of the PuppetDebugger::Cli object
       # @return the output of the plugin command

data/lib/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module PuppetDebugger
-  VERSION = '0.7.0'
+  VERSION = '0.8.0'
 end

data/puppet-debugger.gemspec

@@ -32,7 +32,7 @@ Gem::Specification.new do |s|
   s.licenses = ["MIT"]
   s.rubygems_version = "2.4.5.1"
   s.summary = "A repl based debugger for the puppet language"
-  s.add_runtime_dependency(%q<pluginator>, ["~> 1.4.1"])
+  s.add_runtime_dependency(%q<pluginator>, ["~> 1.5.0"])
   s.add_runtime_dependency(%q<puppet>, [">= 3.8"])
   s.add_runtime_dependency(%q<facterdb>, ["~> 0.3.1"])
   s.add_runtime_dependency(%q<awesome_print>, ["~> 1.7"])

data/spec/input_responders/benchmark_spec.rb

@@ -0,0 +1,32 @@
+require 'spec_helper'
+require 'puppet-debugger'
+require 'puppet-debugger/plugin_test_helper'
+
+describe :benchmark do
+  include_examples 'plugin_tests'
+  let(:args) { ["benchmark", "md5('12345')" ] }
+
+  describe 'mode' do
+    before(:each) do
+      debugger.handle_input('benchmark') # enable
+    end
+    it 'enable' do
+      debugger.handle_input("md5('12345')")
+      expect(output.string).to match(/Benchmark\ Mode\ On/)
+      expect(output.string).to match(/Time\ elapsed/)
+    end
+    it 'disable' do
+      debugger.handle_input('benchmark') # disable
+      expect(output.string).to match(/Benchmark\ Mode\ Off/)
+    end
+  end
+
+  describe 'onetime' do
+    it 'run' do
+      debugger.handle_input("benchmark md5('12345')")
+      expect(output.string).to_not match(/Benchmark\ Mode\ On/)
+      expect(output.string).to_not match(/Benchmark\ Mode\ Off/)
+      expect(output.string).to match(/Time\ elapsed/)
+    end
+  end
+end

data/spec/input_responders/classes_spec.rb

@@ -0,0 +1,22 @@
+require 'spec_helper'
+require 'puppet-debugger'
+require 'puppet-debugger/plugin_test_helper'
+
+describe :classes do
+  include_examples 'plugin_tests'
+  let(:args) { [] }
+
+    let(:input) do
+      'classes'
+    end
+
+    it 'should be able to print classes' do
+      expect(plugin.run(args)).to match(/settings/)
+    end
+
+    it 'should be able to print classes with handle input' do
+      debugger_output = /settings/
+      debugger.handle_input(input)
+      expect(output.string).to match(debugger_output)
+    end
+end

data/spec/input_responders/classification_spec.rb

@@ -0,0 +1,17 @@
+require 'spec_helper'
+require 'puppet-debugger'
+require 'puppet-debugger/plugin_test_helper'
+
+describe :classification do
+  include_examples 'plugin_tests'
+  let(:args) { [] }
+
+  it 'can process a file' do
+    expect(plugin.run(args)).to eq("[]")
+  end
+
+  it 'can process a file from handle input' do
+    debugger.handle_input('classification')
+    expect(output.string).to eq("[]\n")
+  end
+end

data/spec/input_responders/commands_spec.rb

@@ -0,0 +1,22 @@
+require 'spec_helper'
+require 'puppet-debugger'
+require 'puppet-debugger/plugin_test_helper'
+
+describe :commands do
+  include_examples 'plugin_tests'
+  let(:args) { [] }
+
+  it do
+    expect(plugin.run(args)).to match(/environment/)
+  end
+
+  it 'run a plugin command' do
+    debugger.handle_input('help')
+    expect(output.string).to match(/Type "commands" for a list of debugger commands/)
+  end
+
+  it 'show error when command does not exist' do
+    debugger.handle_input('helpp')
+    expect(output.string).to match(/invalid command helpp/)
+  end
+end

data/spec/input_responders/datatypes_spec.rb

@@ -0,0 +1,17 @@
+require 'spec_helper'
+require 'puppet-debugger'
+require 'puppet-debugger/plugin_test_helper'
+
+describe :datatypes do
+  include_examples 'plugin_tests'
+  let(:args) { [] }
+
+  it 'handle datatypes' do
+    output = plugin.run(args)
+    if Gem::Version.new(Puppet.version) < Gem::Version.new('4.5.0')
+      expect(output).to eq("[]")
+    else
+      expect(output).to match(/.*Array.*/)
+    end
+  end
+end

data/spec/input_responders/environment_spec.rb

@@ -0,0 +1,13 @@
+require 'spec_helper'
+require 'puppet-debugger'
+require 'puppet-debugger/plugin_test_helper'
+
+describe :environment do
+  include_examples 'plugin_tests'
+  let(:args) { [''] }
+
+  it 'can display itself' do
+    output = plugin.run(args)
+    expect(output).to eq("Puppet Environment: #{debugger.puppet_env_name}")
+  end
+end

data/spec/input_responders/exit_spec.rb

@@ -0,0 +1,51 @@
+require 'spec_helper'
+require 'puppet-debugger'
+
+describe :exit do
+  let(:args) { [] }
+
+  xit 'exits' do
+    expect{plugin.run(args)}.to eq('')
+  end
+
+  let(:plugin) do
+    instance = PuppetDebugger::InputResponders::Commands.plugin_from_command(subject.to_s).instance
+    instance.debugger = debugger
+    instance
+  end
+
+  let(:output) do
+    StringIO.new
+  end
+
+  let(:debugger) do
+    PuppetDebugger::Cli.new({ out_buffer: output }.merge(options))
+  end
+
+  let(:options) do
+    {}
+  end
+
+  it "commands contant is an array" do
+    expect(plugin.class::COMMAND_WORDS).to be_a(Array)
+  end
+
+  it "commands must contain at least one word" do
+    expect(plugin.class::COMMAND_WORDS.count).to  be > 0
+  end
+
+  it "summary must be a string" do
+    expect(plugin.class::SUMMARY).to be_a(String)
+  end
+
+  it 'implements run' do
+    expect{plugin.run([])}.not_to raise_error(NotImplementedError)
+  end
+
+  it 'be looked up via any command words' do
+    plugin.class::COMMAND_WORDS.each do |word|
+      actual = PuppetDebugger::InputResponders::Commands.plugin_from_command(word.to_s).instance.class
+      expect(actual).to eq(plugin.class)
+    end
+  end
+end

data/spec/input_responders/facterdb_filter_spec.rb

@@ -0,0 +1,12 @@
+require 'spec_helper'
+require 'puppet-debugger'
+require 'puppet-debugger/plugin_test_helper'
+
+describe :facterdb_filter do
+  include_examples 'plugin_tests'
+  let(:args) { [] }
+
+  it 'outputs filter' do
+    expect(plugin.run(args)).to match(/facterversion/)
+  end
+end

data/spec/input_responders/facts_spec.rb

@@ -0,0 +1,20 @@
+require 'spec_helper'
+require 'puppet-debugger'
+require 'puppet-debugger/plugin_test_helper'
+
+describe :facts do
+  include_examples 'plugin_tests'
+  let(:args) { ['$::fqdn', 'facts'] }
+
+  it 'should be able to resolve fqdn' do
+    debugger_output = /foo\.example\.com/
+    output = plugin.run(args[0])
+    expect(output).to match(debugger_output)
+  end
+
+  it 'should be able to print facts' do
+    debugger_output = /kernel/
+    plugin.run(args[1])
+    expect(plugin.run(args[1])).to match(debugger_output)
+  end
+end

data/spec/input_responders/functions_spec.rb

@@ -0,0 +1,20 @@
+require 'spec_helper'
+require 'puppet-debugger'
+require 'puppet-debugger/plugin_test_helper'
+
+describe :functions do
+  include_examples 'plugin_tests'
+  let(:input) do
+    "md5('hello')"
+  end
+  it 'execute md5' do
+    debugger_output = /5d41402abc4b2a76b9719d911017c592/
+    debugger.handle_input(input)
+    expect(output.string).to match(debugger_output)
+  end
+  it 'execute swapcase' do
+    debugger_output = /HELLO/
+    debugger.handle_input("swapcase('hello')")
+    expect(output.string).to match(debugger_output)
+  end
+end

data/spec/input_responders/krt_spec.rb

@@ -8,5 +8,4 @@ describe :krt do
   it 'works' do
     expect(plugin.run(args)).to match(/hostclasses/)
   end
-
-end
+end

data/spec/input_responders/play_spec.rb

@@ -131,6 +131,20 @@ describe :play do
         expect(output.string).to include('"test"')
       end
     end
+    describe 'multiple lines puppet code' do
+      let(:input) do
+        <<-EOF
+if $osfamily {
+  $var = '3'
+}
+$var
+        EOF
+      end
+      xit do
+        plugin.play_back_string(input)
+        expect(output.string).to include('"3"')
+      end
+    end
   end
 
   describe 'play' do

data/spec/input_responders/reset_spec.rb

@@ -0,0 +1,27 @@
+require 'spec_helper'
+require 'puppet-debugger'
+require 'puppet-debugger/plugin_test_helper'
+
+describe :reset do
+  include_examples 'plugin_tests'
+  let(:args) { [] }
+
+  it 'can process a file' do
+    debugger_output = /Puppet::Type::File/
+    debugger.handle_input("file{'/tmp/reset': ensure => present}")
+    expect(output.string).to match(debugger_output)
+    debugger.handle_input('reset')
+    expect(output.string).to match(debugger_output)
+  end
+
+  describe 'loglevel' do
+    it 'has not changed' do
+      debugger.handle_input(':set loglevel debug')
+      expect(Puppet::Util::Log.level).to eq(:debug)
+      expect(Puppet::Util::Log.destinations[:buffer].name).to eq(:buffer)
+      plugin.run('reset')
+      expect(Puppet::Util::Log.level).to eq(:debug)
+      expect(Puppet::Util::Log.destinations[:buffer].name).to eq(:buffer)
+    end
+  end
+end

data/spec/input_responders/resources_spec.rb

@@ -0,0 +1,13 @@
+require 'spec_helper'
+require 'puppet-debugger'
+require 'puppet-debugger/plugin_test_helper'
+
+describe :resources do
+  include_examples 'plugin_tests'
+  let(:args) { ["resources"] }
+
+  it 'should be able to print resources' do
+    debugger_output = /main/
+    expect(plugin.run(args)).to match(debugger_output)
+  end
+end

data/spec/input_responders/set_spec.rb

@@ -0,0 +1,18 @@
+require 'spec_helper'
+require 'puppet-debugger'
+require 'puppet-debugger/plugin_test_helper'
+
+describe 'set' do
+  include_examples 'plugin_tests'
+  let(:input) do
+    ':set loglevel debug'
+  end
+  
+  it 'should set the loglevel' do
+    debugger_output = /loglevel debug is set/
+    debugger.handle_input(input)
+    expect(output.string).to match(debugger_output)
+    expect(Puppet::Util::Log.level).to eq(:debug)
+    expect(Puppet::Util::Log.destinations[:buffer].name).to eq(:buffer)
+  end
+end

data/spec/input_responders/types_spec.rb

@@ -0,0 +1,22 @@
+require 'spec_helper'
+require 'puppet-debugger'
+require 'puppet-debugger/plugin_test_helper'
+
+describe :types do
+  include_examples 'plugin_tests'
+  let(:args) { [] }
+
+  it 'runs' do
+    expect(plugin.run(args)).to match(/service/)
+  end
+
+  describe 'types' do
+    let(:input) do
+      'types'
+    end
+    it 'runs' do
+      debugger.handle_input(input)
+      expect(output.string).to match(/service/)
+    end
+  end
+end

data/spec/input_responders/vars_spec.rb

@@ -0,0 +1,27 @@
+require 'spec_helper'
+require 'puppet-debugger'
+require 'puppet-debugger/plugin_test_helper'
+require 'pluginator'
+
+describe :vars do
+  include_examples 'plugin_tests'
+  let(:args) { [] }
+
+  it 'display facts variable' do
+    debugger_output = /facts/
+    output = plugin.run(args)
+    expect(output).to match(debugger_output)
+  end
+  it 'display server facts variable' do
+    debugger_output = /server_facts/
+    expect(plugin.run(args)).to match(debugger_output) if Puppet.version.to_f >= 4.1
+  end
+  it 'display serverversion variable' do
+    debugger_output = /serverversion/
+    expect(plugin.run(args)).to match(debugger_output) if Puppet.version.to_f >= 4.1
+  end
+  it 'display local variable' do
+    debugger.handle_input("$var1 = 'value1'")
+    expect(plugin.run(args)).to match(/value1/)
+  end
+end

data/spec/input_responders/whereami_spec.rb

@@ -0,0 +1,28 @@
+require 'spec_helper'
+require 'puppet-debugger'
+require 'puppet-debugger/plugin_test_helper'
+
+describe :whereami do
+  include_examples 'plugin_tests'
+  let(:input) do
+    File.expand_path File.join(fixtures_dir, 'sample_start_debugger.pp')
+  end
+  let(:options) do
+    {
+      source_file: input,
+      source_line: 10
+    }
+  end
+
+  before(:each) do
+    debugger.handle_input('whereami')
+  end
+
+  it 'runs' do
+    expect(output.string).to match(/\s+5/)
+  end
+
+  it 'contains marker' do
+    expect(output.string).to match(/\s+=>\s10/)
+  end
+end

data/spec/puppet_debugger_spec.rb

@@ -113,28 +113,7 @@ describe 'PuppetDebugger' do
     end
   end
 
-  describe 'types' do
-    describe 'string' do
-      let(:input) do
-        'String'
-      end
-      it 'shows type' do
-        debugger.handle_input(input)
-        expect(output.string).to eq("\n => String\n")
-      end
-    end
-    describe 'Array', type_function: true do
-      let(:input) do
-        'type([1,2,3,4])'
-      end
-      it 'shows type' do
-        if Gem::Version.new(Puppet.version) > Gem::Version.new('4.4')
-          debugger.handle_input(input)
-          expect(output.string).to eq("\n => Tuple[Integer[1, 1], Integer[2, 2], Integer[3, 3], Integer[4, 4]]\n") if supports_type_function?
-        end
-      end
-    end
-  end
+
 
 
 
@@ -144,40 +123,7 @@ describe 'PuppetDebugger' do
     end
   end
 
-  # describe 'commands' do
-  #   let(:input) do
-  #     'commands'
-  #   end
-  #
-  #   it 'shows a list of groups of available commands' do
-  #     command_groups = {
-  #       'Important' => { 'help' => 'Get help.' },
-  #
-  #       'Misc' => {
-  #         'do_something' => 'Do something good.',
-  #         'do_something_else' => 'Do something really good.'
-  #       }
-  #     }
-  #
-  #     stub_const('PuppetDebugger::Support::InputResponders::COMMAND_GROUPS', command_groups)
-  #
-  #     debugger.handle_input(input)
-  #
-  #     command_groups.each do |command_group|
-  #       group_name = command_group[0]
-  #       group_commands = command_group[1]
-  #
-  #       expect(output.string).to match(group_name)
-  #
-  #       group_commands.each do |command|
-  #         command_name = command[0]
-  #         command_description = command[1]
-  #         expect(output.string).to match(command_name)
-  #         expect(output.string).to match(command_description)
-  #       end
-  #     end
-  #   end
-  # end
+
 
   describe 'empty' do
     let(:input) do
@@ -232,43 +178,6 @@ describe 'PuppetDebugger' do
     end
   end
 
-  describe 'classification' do
-    let(:input) do
-      'classification'
-    end
-
-    it 'can process a file' do
-      debugger.handle_input(input)
-      expect(output.string).to eq("\n[]\n")
-    end
-  end
-
-  describe 'reset' do
-    let(:input) do
-      "file{'/tmp/reset': ensure => present}"
-    end
-
-    it 'can process a file' do
-      debugger_output = /Puppet::Type::File/
-      debugger.handle_input(input)
-      expect(output.string).to match(debugger_output)
-      debugger.handle_input('reset')
-      debugger.handle_input(input)
-      expect(output.string).to match(debugger_output)
-    end
-
-    describe 'loglevel' do
-      it 'has not changed' do
-        debugger.handle_input(':set loglevel debug')
-        expect(Puppet::Util::Log.level).to eq(:debug)
-        expect(Puppet::Util::Log.destinations[:buffer].name).to eq(:buffer)
-        debugger.handle_input('reset')
-        expect(Puppet::Util::Log.level).to eq(:debug)
-        expect(Puppet::Util::Log.destinations[:buffer].name).to eq(:buffer)
-      end
-    end
-  end
-
   describe 'map block' do
     let(:input) do
       "['/tmp/test3', '/tmp/test4'].map |String $path| { file{$path: ensure => present} }"
@@ -291,165 +200,27 @@ describe 'PuppetDebugger' do
     end
   end
 
-  describe 'facts' do
-    let(:input) do
-      '$::fqdn'
-    end
-    it 'should be able to resolve fqdn' do
-      debugger_output = /foo\.example\.com/
-      debugger.handle_input(input)
-      expect(output.string).to match(debugger_output)
-    end
-  end
-
-  describe 'print facts' do
+  describe 'string' do
     let(:input) do
-      'facts'
+      'String'
     end
-    it 'should be able to print facts' do
-      debugger_output = /kernel/
+    it 'shows type' do
       debugger.handle_input(input)
-      expect(output.string).to match(debugger_output)
+      expect(output.string).to eq("\n => String\n")
     end
   end
-
-  describe 'print resources' do
+  describe 'Array', type_function: true do
     let(:input) do
-      'resources'
-    end
-    it 'should be able to print resources' do
-      debugger_output = /main/
-      debugger.handle_input(input)
-      expect(output.string).to match(debugger_output)
+      'type([1,2,3,4])'
     end
-  end
-
-  describe 'print class' do
-    let(:input) do
-      "Class['settings']"
-    end
-    it 'should be able to print classes' do
-      debugger_output = /Settings/
-      debugger.handle_input(input)
-      expect(output.string).to match(debugger_output)
-    end
-  end
-
-  describe 'print classes' do
-    let(:input) do
-      'resources'
-    end
-    it 'should be able to print classes' do
-      debugger_output = /Settings/
-      debugger.handle_input(input)
-      expect(output.string).to match(debugger_output)
-    end
-  end
-
-  describe 'set' do
-    let(:input) do
-      ':set loglevel debug'
-    end
-    it 'should set the loglevel' do
-      debugger_output = /loglevel debug is set/
-      debugger.handle_input(input)
-      expect(output.string).to match(debugger_output)
-      expect(Puppet::Util::Log.level).to eq(:debug)
-      expect(Puppet::Util::Log.destinations[:buffer].name).to eq(:buffer)
-    end
-  end
-
-  describe 'vars' do
-    let(:input) do
-      'vars'
-    end
-    it 'display facts variable' do
-      debugger_output = /facts/
-      debugger.handle_input(input)
-      expect(output.string).to match(debugger_output)
-    end
-    it 'display server facts variable' do
-      debugger_output = /server_facts/
-      debugger.handle_input(input)
-      expect(output.string).to match(debugger_output) if Puppet.version.to_f >= 4.1
-    end
-    it 'display serverversion variable' do
-      debugger_output = /serverversion/
-      debugger.handle_input(input)
-      expect(output.string).to match(debugger_output) if Puppet.version.to_f >= 4.1
-    end
-    it 'display local variable' do
-      debugger.handle_input("$var1 = 'value1'")
-      expect(output.string).to match(/value1/)
-      debugger.handle_input('$var1')
-      expect(output.string).to match(/value1/)
-    end
-  end
-
-  describe 'execute functions' do
-    let(:input) do
-      "md5('hello')"
-    end
-    it 'execute md5' do
-      debugger_output = /5d41402abc4b2a76b9719d911017c592/
-      debugger.handle_input(input)
-      expect(output.string).to match(debugger_output)
-    end
-    it 'execute swapcase' do
-      debugger_output = /HELLO/
-      debugger.handle_input("swapcase('hello')")
-      expect(output.string).to match(debugger_output)
-    end
-  end
-
-  describe 'datatypes' do
-    let(:input) do
-      'datatypes'
-    end
-    it 'handle datatypes' do
-      debugger.handle_input(input)
-      if Gem::Version.new(Puppet.version) < Gem::Version.new('4.5.0')
-        expect(output.string).to eq("\n[]\n")
-      else
-        expect(output.string).to match(/.*Array.*/)
+    it 'shows type' do
+      if Gem::Version.new(Puppet.version) > Gem::Version.new('4.4')
+        debugger.handle_input(input)
+        expect(output.string).to eq("\n => Tuple[Integer[1, 1], Integer[2, 2], Integer[3, 3], Integer[4, 4]]\n") if supports_type_function?
       end
     end
   end
 
-  describe 'whereami' do
-    let(:input) do
-      File.expand_path File.join(fixtures_dir, 'sample_start_debugger.pp')
-    end
-    let(:options) do
-      {
-        source_file: input,
-        source_line: 10
-      }
-    end
-
-    before(:each) do
-      debugger.handle_input('whereami')
-    end
-
-    it 'runs' do
-      expect(output.string).to match(/\s+5/)
-    end
-
-    it 'contains marker' do
-      expect(output.string).to match(/\s+=>\s10/)
-    end
-  end
-
-  describe 'types' do
-    let(:input) do
-      'types'
-    end
-    it 'runs' do
-      debugger.handle_input(input)
-      expect(output.string).to match(/service/)
-    end
-  end
-
   describe 'error message' do
     let(:input) do
       "file{'/tmp/test': ensure => present, contact => 'blah'}"
@@ -468,33 +239,4 @@ describe 'PuppetDebugger' do
       end
     end
   end
-
-  describe 'benchmark' do
-    let(:input) do
-      "benchmark md5('12345')"
-    end
-    describe 'mode' do
-      before(:each) do
-        debugger.handle_input('benchmark') # enable
-      end
-      it 'enable' do
-        debugger.handle_input("md5('12345')")
-        expect(output.string).to match(/Benchmark\ Mode\ On/)
-        expect(output.string).to match(/Time\ elapsed/)
-      end
-      it 'disable' do
-        debugger.handle_input('benchmark') # disable
-        expect(output.string).to match(/Benchmark\ Mode\ Off/)
-      end
-    end
-
-    describe 'onetime' do
-      it 'run' do
-        debugger.handle_input("benchmark md5('12345')")
-        expect(output.string).to_not match(/Benchmark\ Mode\ On/)
-        expect(output.string).to_not match(/Benchmark\ Mode\ Off/)
-        expect(output.string).to match(/Time\ elapsed/)
-      end
-    end
-  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: puppet-debugger
 version: !ruby/object:Gem::Version
-  version: 0.7.0
+  version: 0.8.0
 platform: ruby
 authors:
 - Corey Osman
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-06-11 00:00:00.000000000 Z
+date: 2017-07-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pluginator
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.4.1
+        version: 1.5.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.4.1
+        version: 1.5.0
 - !ruby/object:Gem::Dependency
   name: puppet
   requirement: !ruby/object:Gem::Requirement
@@ -174,9 +174,25 @@ files:
 - spec/fixtures/sample_start_debugger.pp
 - spec/hooks_spec.rb
 - spec/input_responder_plugin_spec.rb
+- spec/input_responders/benchmark_spec.rb
+- spec/input_responders/classes_spec.rb
+- spec/input_responders/classification_spec.rb
+- spec/input_responders/commands_spec.rb
+- spec/input_responders/datatypes_spec.rb
+- spec/input_responders/environment_spec.rb
+- spec/input_responders/exit_spec.rb
+- spec/input_responders/facterdb_filter_spec.rb
+- spec/input_responders/facts_spec.rb
+- spec/input_responders/functions_spec.rb
 - spec/input_responders/help_spec.rb
 - spec/input_responders/krt_spec.rb
 - spec/input_responders/play_spec.rb
+- spec/input_responders/reset_spec.rb
+- spec/input_responders/resources_spec.rb
+- spec/input_responders/set_spec.rb
+- spec/input_responders/types_spec.rb
+- spec/input_responders/vars_spec.rb
+- spec/input_responders/whereami_spec.rb
 - spec/pdb_spec.rb
 - spec/puppet/application/debugger_spec.rb
 - spec/puppet_debugger_spec.rb