puppet-debugger 0.6.1 → 0.7.0

data/spec/input_responder_plugin_spec.rb

@@ -0,0 +1,45 @@
+require 'spec_helper'
+require 'puppet-debugger/input_responder_plugin'
+
+describe :input_responder_plugin do
+  let(:output) do
+    StringIO.new
+  end
+
+  before(:each) do
+    allow(plugin).to receive(:run).and_return([])
+  end
+
+  let(:debugger) do
+    PuppetDebugger::Cli.new({ out_buffer: output }.merge(options))
+  end
+
+  let(:options) do
+    {}
+  end
+
+  let(:plugin) do
+    instance = PuppetDebugger::InputResponderPlugin.instance
+    instance.debugger = debugger
+    instance
+  end
+
+  it 'works' do
+    expect(plugin.run([])).to eq([])
+  end
+
+  {scope: Puppet::Parser::Scope, node: Puppet::Node, facts: Puppet::Node::Facts,
+   environment: Puppet::Node::Environment, function_map: Hash,
+  compiler: Puppet::Parser::Compiler, catalog: Puppet::Resource::Catalog}.each do |name, klass|
+    it "can access #{name}" do
+      expect(plugin.send(name).class).to be klass
+    end
+  end
+
+  [:add_hook, :handle_input, :delete_hook, :handle_input].each do |name|
+    it "responds to method #{name}" do
+      expect(plugin.respond_to?(name)).to eq(true)
+    end
+  end
+
+end

data/spec/input_responders/help_spec.rb

@@ -0,0 +1,17 @@
+require 'spec_helper'
+require 'puppet-debugger/plugin_test_helper'
+
+describe :help do
+  include_examples "plugin_tests"
+  let(:args) { [] }
+
+  it 'can show the help screen' do
+    output = plugin.run(args)
+    expected_debugger_output = /Type \"commands\" for a list of debugger commands\nor \"help\" to show the help screen.\n\n/
+    expect(output).to match(/Ruby Version: #{RUBY_VERSION}\n/)
+    expect(output).to match(/Puppet Version: \d.\d\d?.\d\n/)
+    expect(output).to match(/Puppet Debugger Version: \d.\d.\d\n/)
+    expect(output).to match(/Created by: NWOps <corey@nwops.io>\n/)
+    expect(output).to match(expected_debugger_output)
+  end
+end

data/spec/input_responders/krt_spec.rb

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

data/spec/input_responders/play_spec.rb

@@ -0,0 +1,160 @@
+require 'spec_helper'
+require 'puppet-debugger/plugin_test_helper'
+describe :play do
+  include_examples "plugin_tests"
+
+  describe 'convert  url' do
+    describe 'unsupported' do
+      let(:url) { 'https://bitbuck.com/master/lib/log_helper.rb' }
+      let(:converted) { 'https://bitbuck.com/master/lib/log_helper.rb' }
+      it do
+        expect(plugin.convert_to_text(url)).to eq(converted)
+      end
+    end
+    describe 'gitlab' do
+      describe 'blob' do
+        let(:url) { 'https://gitlab.com/nwops/pdebugger-web/blob/master/lib/log_helper.rb' }
+        let(:converted) { 'https://gitlab.com/nwops/pdebugger-web/raw/master/lib/log_helper.rb' }
+        it do
+          expect(plugin.convert_to_text(url)).to eq(converted)
+        end
+      end
+
+      describe 'raw' do
+        let(:url) { 'https://gitlab.com/nwops/pdebugger-web/raw/master/lib/log_helper.rb' }
+        let(:converted) { 'https://gitlab.com/nwops/pdebugger-web/raw/master/lib/log_helper.rb' }
+        it do
+          expect(plugin.convert_to_text(url)).to eq(converted)
+        end
+      end
+
+      describe 'snippet' do
+        describe 'not raw' do
+          let(:url) { 'https://gitlab.com/snippets/19471' }
+          let(:converted) { 'https://gitlab.com/snippets/19471/raw' }
+          it do
+            expect(plugin.convert_to_text(url)).to eq(converted)
+          end
+        end
+
+        describe 'raw' do
+          let(:url) { 'https://gitlab.com/snippets/19471/raw' }
+          let(:converted) { 'https://gitlab.com/snippets/19471/raw' }
+          it do
+            expect(plugin.convert_to_text(url)).to eq(converted)
+          end
+        end
+      end
+    end
+    describe 'github' do
+      describe 'raw' do
+        let(:url) { 'https://gist.githubusercontent.com/logicminds/f9b1ac65a3a440d562b0/raw' }
+        let(:converted) { 'https://gist.githubusercontent.com/logicminds/f9b1ac65a3a440d562b0/raw' }
+        it do
+          expect(plugin.convert_to_text(url)).to eq(converted)
+        end
+      end
+      describe 'raw' do
+        let(:url) { 'https://gist.githubusercontent.com/logicminds/f9b1ac65a3a440d562b0' }
+        let(:converted) { 'https://gist.githubusercontent.com/logicminds/f9b1ac65a3a440d562b0.txt' }
+        it do
+          expect(plugin.convert_to_text(url)).to eq(converted)
+        end
+      end
+      describe 'raw gist' do
+        let(:url) { 'https://gist.githubusercontent.com/logicminds/f9b1ac65a3a440d562b0/raw/c8f6be52da5b2b0eeaabb9aa75832b75793d35d1/controls.pp' }
+        let(:converted) { 'https://gist.githubusercontent.com/logicminds/f9b1ac65a3a440d562b0/raw/c8f6be52da5b2b0eeaabb9aa75832b75793d35d1/controls.pp' }
+        it do
+          expect(plugin.convert_to_text(url)).to eq(converted)
+        end
+      end
+      describe 'raw non gist' do
+        let(:url) { 'https://raw.githubusercontent.com/nwops/puppet-debugger/master/lib/puppet-debugger.rb' }
+        let(:converted) { 'https://raw.githubusercontent.com/nwops/puppet-debugger/master/lib/puppet-debugger.rb' }
+        it do
+          expect(plugin.convert_to_text(url)).to eq(converted)
+        end
+      end
+
+      describe 'blob' do
+        let(:url) { 'https://github.com/nwops/puppet-debugger/blob/master/lib/puppet-debugger.rb' }
+        let(:converted) { 'https://github.com/nwops/puppet-debugger/raw/master/lib/puppet-debugger.rb' }
+        it do
+          expect(plugin.convert_to_text(url)).to eq(converted)
+        end
+      end
+
+      describe 'gist' do
+        let(:url) { 'https://gist.github.com/logicminds/f9b1ac65a3a440d562b0' }
+        let(:converted) { 'https://gist.github.com/logicminds/f9b1ac65a3a440d562b0.txt' }
+        it do
+          expect(plugin.convert_to_text(url)).to eq(converted)
+        end
+      end
+    end
+  end
+
+  describe 'multiple lines of input' do
+    before(:each) do
+
+    end
+    describe '3 lines' do
+      let(:input) do
+        "$var1 = 'test'\nfile{\"/tmp/${var1}.txt\": ensure => present, mode => '0755'}\nvars"
+      end
+      it do
+        plugin.play_back_string(input)
+        expect(output.string).to match(/server_facts/) if Gem::Version.new(Puppet.version) >= Gem::Version.new(4.1)
+        expect(output.string).to match(/test/)
+        expect(output.string).to match(/Puppet::Type::File/)
+      end
+    end
+    describe '2 lines' do
+      let(:input) do
+        "$var1 = 'test'\n $var2 = 'test2'"
+      end
+      it do
+        plugin.play_back_string(input)
+        expect(output.string).to include("$var1 = 'test'")
+        expect(output.string).to include('"test"')
+        expect(output.string).to include("$var2 = 'test2'")
+        expect(output.string).to include('"test2"')
+      end
+    end
+    describe '1 lines' do
+      let(:input) do
+        "$var1 = 'test'"
+      end
+      it do
+        plugin.play_back_string(input)
+        expect(output.string).to include("$var1 = 'test'")
+        expect(output.string).to include('"test"')
+      end
+    end
+  end
+
+  describe 'play' do
+    let(:fixtures_file) do
+      File.join(fixtures_dir, 'sample_manifest.pp')
+    end
+
+    let(:file_url) do
+      'https://gist.github.com/logicminds/f9b1ac65a3a440d562b0'
+    end
+    let(:input) do
+      "play #{file_url}"
+    end
+    # requires internet and stops testing
+    xit 'url' do
+      allow(debugger).to receive(:fetch_url_data).with(file_url + '.txt').and_return(File.read(fixtures_file))
+      debugger.handle_input(input)
+      expect(output.string).to match(/test/)
+      expect(output.string).to match(/Puppet::Type::File/)
+    end
+
+    it 'file' do
+      debugger.handle_input("play #{fixtures_file}")
+      expect(output.string).to match(/Puppet::Type::File/)
+    end
+  end
+end

data/spec/pdb_spec.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 require 'spec_helper'
 
 describe 'pdb' do

data/spec/puppet/application/debugger_spec.rb

@@ -1,7 +1,6 @@
-#! /usr/bin/env ruby
 # frozen_string_literal: true
-require 'spec_helper'
 
+require 'spec_helper'
 require 'puppet/application/debugger'
 
 describe Puppet::Application::Debugger do

data/spec/puppet_debugger_spec.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 require 'spec_helper'
 require 'stringio'
 describe 'PuppetDebugger' do
@@ -11,7 +12,7 @@ describe 'PuppetDebugger' do
   end
 
   let(:output) do
-    StringIO.new('', 'w')
+    StringIO.new
   end
 
   let(:debugger) do
@@ -127,47 +128,15 @@ describe 'PuppetDebugger' do
         'type([1,2,3,4])'
       end
       it 'shows type' do
-        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?
+        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
 
-  describe 'multiple lines of input' do
-    describe '3 lines' do
-      let(:input) do
-        "$var1 = 'test'\nfile{\"/tmp/${var1}.txt\": ensure => present, mode => '0755'}\nvars"
-      end
-      it do
-        debugger.play_back_string(input)
-        expect(output.string).to match(/server_facts/) if Puppet.version.to_f >= 4.1
-        expect(output.string).to match(/test/)
-        expect(output.string).to match(/Puppet::Type::File/)
-      end
-    end
-    describe '2 lines' do
-      let(:input) do
-        "$var1 = 'test'\n $var2 = 'test2'"
-      end
-      it do
-        debugger.play_back_string(input)
-        expect(output.string).to include("$var1 = 'test'")
-        expect(output.string).to include('"test"')
-        expect(output.string).to include("$var2 = 'test2'")
-        expect(output.string).to include('"test2"')
-      end
-    end
-    describe '1 lines' do
-      let(:input) do
-        "$var1 = 'test'"
-      end
-      it do
-        debugger.play_back_string(input)
-        expect(output.string).to include("$var1 = 'test'")
-        expect(output.string).to include('"test"')
-      end
-    end
-  end
+
 
   describe 'returns a array of resource_types' do
     it 'returns resource type' do
@@ -175,20 +144,40 @@ describe 'PuppetDebugger' do
     end
   end
 
-  describe 'help' do
-    let(:input) do
-      'help'
-    end
-    it 'can show the help screen' do
-      expected_debugger_output = /Type \"exit\", \"functions\", \"vars\", \"krt\", \"whereami\", \"facts\", \"resources\", \"classes\",\n     \"play\", \"classification\", \"types\", \"datatypes\", \"benchmark\",\n     \"reset\", or \"help\" for more information.\n\n/
-      debugger.handle_input(input)
-      expect(output.string).to match(/Ruby Version: #{RUBY_VERSION}\n/)
-      expect(output.string).to match(/Puppet Version: \d.\d.\d\n/)
-      expect(output.string).to match(/Puppet Debugger Version: \d.\d.\d\n/)
-      expect(output.string).to match(/Created by: NWOps <corey@nwops.io>\n/)
-      expect(output.string).to match(expected_debugger_output)
-    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
@@ -211,39 +200,6 @@ describe 'PuppetDebugger' do
     end
   end
 
-  describe 'krt' do
-    let(:input) do
-      'krt'
-    end
-    it 'can run' do
-      debugger_output = /hostclasses/
-      debugger.handle_input(input)
-      expect(output.string).to match(debugger_output)
-    end
-  end
-
-  describe 'play' do
-    let(:fixtures_file) do
-      File.join(fixtures_dir, 'sample_manifest.pp')
-    end
-
-    before(:each) do
-      allow(debugger).to receive(:fetch_url_data).with(file_url + '.txt').and_return(File.read(fixtures_file))
-    end
-
-    let(:file_url) do
-      'https://gist.githubusercontent.com/logicminds/f9b1ac65a3a440d562b0'
-    end
-    it 'file' do
-      debugger.handle_input("play #{fixtures_file}")
-      expect(output.string).to match(/Puppet::Type::File/)
-    end
-    it 'url' do
-      debugger.handle_input("play #{file_url}")
-      expect(output.string).to match(/Puppet::Type::File/)
-    end
-  end
-
   describe 'variables' do
     let(:input) do
       "$file_path = '/tmp/test2.txt'"
@@ -452,7 +408,7 @@ describe 'PuppetDebugger' do
     end
     it 'handle datatypes' do
       debugger.handle_input(input)
-      if Puppet.version < '4.3.0'
+      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.*/)
@@ -471,11 +427,16 @@ describe 'PuppetDebugger' do
       }
     end
 
+    before(:each) do
+      debugger.handle_input('whereami')
+    end
+
     it 'runs' do
-      expect(debugger.whereami).to match(/\s+5/)
+      expect(output.string).to match(/\s+5/)
     end
+
     it 'contains marker' do
-      expect(debugger.whereami).to match(/\s+=>\s10/)
+      expect(output.string).to match(/\s+=>\s10/)
     end
   end
 

data/spec/remote_node_spec.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 require 'spec_helper'
 require 'stringio'
 describe 'PuppetDebugger' do
@@ -11,7 +12,7 @@ describe 'PuppetDebugger' do
   end
 
   let(:output) do
-    StringIO.new('', 'w')
+    StringIO.new
   end
 
   let(:debugger) do
@@ -40,7 +41,7 @@ describe 'PuppetDebugger' do
 
     describe 'set' do
       it 'sends message about resetting' do
-        expect(output.string).to eq("\n => Resetting to use node puppetdev.localdomain\n")
+        expect(output.string).to eq("\nResetting to use node puppetdev.localdomain\n")
       end
 
       it 'return node name' do