puppet-debugger 0.6.1 → 0.7.0

data/spec/spec_helper.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 require 'simplecov'
 require_relative '../lib/puppet-debugger'
 require 'yaml'
@@ -57,6 +58,12 @@ def supports_type_function?
   Gem::Version.new(Puppet.version) >= Gem::Version.new('4.0')
 end
 
+def supports_datatypes?
+  Gem::Version.new(Puppet.version) >= Gem::Version.new('4.5')
+end
+
+
 RSpec.configure do |config|
   config.filter_run_excluding native_functions: !supports_native_functions?
+  RSpec::Expectations.configuration.on_potential_false_positives = :nothing
 end

data/spec/support_spec.rb

@@ -1,10 +1,11 @@
 # frozen_string_literal: true
+
 require 'spec_helper'
 require 'tempfile'
 
 describe 'support' do
   let(:output) do
-    StringIO.new('', 'w')
+    StringIO.new
   end
 
   let(:debugger) do
@@ -15,31 +16,8 @@ describe 'support' do
     debugger.scope
   end
 
-  describe 'play' do
-    before(:each) do
-      allow(debugger).to receive(:fetch_url_data).with(file_url + '.txt').and_return(File.read(fixtures_file))
-    end
-
-    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
-
-    it do
-      debugger.handle_input(input)
-      expect(output.string).to match(/test/)
-      expect(output.string).to match(/Puppet::Type::File/)
-    end
-  end
-
   let(:puppet_version) do
-    debugger.mod_finder.match(debugger.puppet_lib_dir)[1]
+    debugger.puppet_lib_dir.scan(debugger.mod_finder).flatten.last
   end
 
   let(:manifest_file) do
@@ -71,7 +49,7 @@ describe 'support' do
   end
 
   it 'should return a puppet version' do
-    expect(puppet_version).to match(/puppet-\d\.\d.\d/)
+    expect(puppet_version).to match(/puppet-\d\.\d+.\d/)
   end
 
   it 'should return lib dirs' do
@@ -92,94 +70,5 @@ describe 'support' do
     expect(debugger.node.facts.values['fqdn']).to eq('foo.example.com')
   end
 
-  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(debugger.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(debugger.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(debugger.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(debugger.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(debugger.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(debugger.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(debugger.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(debugger.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(debugger.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(debugger.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(debugger.convert_to_text(url)).to eq(converted)
-        end
-      end
-    end
-  end
+
 end

data/test_matrix.rb

@@ -1,6 +1,8 @@
 # frozen_string_literal: true
+
 require 'yaml'
 require 'fileutils'
+require 'English'
 @threads = {}
 
 def run_container(image, puppet_version)

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: puppet-debugger
 version: !ruby/object:Gem::Version
-  version: 0.6.1
+  version: 0.7.0
 platform: ruby
 authors:
 - Corey Osman
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-04-24 00:00:00.000000000 Z
+date: 2017-06-11 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: pluginator
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.4.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.4.1
 - !ruby/object:Gem::Dependency
   name: puppet
   requirement: !ruby/object:Gem::Requirement
@@ -28,30 +42,30 @@ dependencies:
   name: facterdb
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.3.8
+        version: 0.3.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.3.8
+        version: 0.3.1
 - !ruby/object:Gem::Dependency
   name: awesome_print
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.6'
+        version: '1.7'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.6'
+        version: '1.7'
 - !ruby/object:Gem::Dependency
   name: rdoc
   requirement: !ruby/object:Gem::Requirement
@@ -66,6 +80,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.12'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.6'
 description: A interactive command line tool for evaluating and debugging the puppet
   language
 email: corey@nwops.io
@@ -89,28 +117,48 @@ files:
 - CHANGELOG.md
 - DEVELOPMENT.md
 - Gemfile
-- Gemfile.lock
 - LICENSE.txt
+- Plugin_development.md
 - README.md
 - Rakefile
 - bin/pdb
 - lib/awesome_print/ext/awesome_puppet.rb
+- lib/plugins/puppet-debugger/input_responders/benchmark.rb
+- lib/plugins/puppet-debugger/input_responders/classes.rb
+- lib/plugins/puppet-debugger/input_responders/classification.rb
+- lib/plugins/puppet-debugger/input_responders/commands.rb
+- lib/plugins/puppet-debugger/input_responders/datatypes.rb
+- lib/plugins/puppet-debugger/input_responders/environment.rb
+- lib/plugins/puppet-debugger/input_responders/exit.rb
+- lib/plugins/puppet-debugger/input_responders/facterdb_filter.rb
+- lib/plugins/puppet-debugger/input_responders/facts.rb
+- lib/plugins/puppet-debugger/input_responders/functions.rb
+- lib/plugins/puppet-debugger/input_responders/help.rb
+- lib/plugins/puppet-debugger/input_responders/krt.rb
+- lib/plugins/puppet-debugger/input_responders/play.rb
+- lib/plugins/puppet-debugger/input_responders/reset.rb
+- lib/plugins/puppet-debugger/input_responders/resources.rb
+- lib/plugins/puppet-debugger/input_responders/set.rb
+- lib/plugins/puppet-debugger/input_responders/types.rb
+- lib/plugins/puppet-debugger/input_responders/vars.rb
+- lib/plugins/puppet-debugger/input_responders/whereami.rb
 - lib/puppet-debugger.rb
 - lib/puppet-debugger/cli.rb
 - lib/puppet-debugger/code/code_file.rb
 - lib/puppet-debugger/code/code_range.rb
 - lib/puppet-debugger/code/loc.rb
 - lib/puppet-debugger/debugger_code.rb
+- lib/puppet-debugger/hooks.rb
+- lib/puppet-debugger/input_responder_plugin.rb
+- lib/puppet-debugger/plugin_test_helper.rb
 - lib/puppet-debugger/support.rb
 - lib/puppet-debugger/support/compiler.rb
 - lib/puppet-debugger/support/environment.rb
 - lib/puppet-debugger/support/errors.rb
 - lib/puppet-debugger/support/facts.rb
 - lib/puppet-debugger/support/functions.rb
-- lib/puppet-debugger/support/input_responders.rb
 - lib/puppet-debugger/support/loader.rb
 - lib/puppet-debugger/support/node.rb
-- lib/puppet-debugger/support/play.rb
 - lib/puppet-debugger/support/scope.rb
 - lib/puppet/application/debugger.rb
 - lib/trollop.rb
@@ -124,6 +172,11 @@ files:
 - spec/fixtures/node_obj.yaml
 - spec/fixtures/sample_manifest.pp
 - spec/fixtures/sample_start_debugger.pp
+- spec/hooks_spec.rb
+- spec/input_responder_plugin_spec.rb
+- spec/input_responders/help_spec.rb
+- spec/input_responders/krt_spec.rb
+- spec/input_responders/play_spec.rb
 - spec/pdb_spec.rb
 - spec/puppet/application/debugger_spec.rb
 - spec/puppet_debugger_spec.rb
@@ -152,7 +205,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.11
+rubygems_version: 2.6.12
 signing_key: 
 specification_version: 4
 summary: A repl based debugger for the puppet language

data/Gemfile.lock

@@ -1,95 +0,0 @@
-GEM
-  remote: http://rubygems.org/
-  specs:
-    CFPropertyList (2.2.8)
-    ast (2.3.0)
-    awesome_print (1.7.0)
-    coderay (1.1.1)
-    diff-lcs (1.3)
-    docile (1.1.5)
-    facter (2.4.6)
-      CFPropertyList (~> 2.2.6)
-    facterdb (0.3.10)
-      facter
-      jgrep
-    fast_gettext (1.1.0)
-    gettext (3.2.2)
-      locale (>= 2.0.5)
-      text (>= 1.3.0)
-    gettext-setup (0.16)
-      fast_gettext (~> 1.1.0)
-      gettext (>= 3.0.2)
-      locale
-    hiera (3.3.1)
-    jgrep (1.4.1)
-      json
-    json (1.8.6)
-    json_pure (1.8.6)
-    locale (2.1.2)
-    method_source (0.8.2)
-    parser (2.4.0.0)
-      ast (~> 2.2)
-    powerpack (0.1.1)
-    pry (0.10.4)
-      coderay (~> 1.1.0)
-      method_source (~> 0.8.1)
-      slop (~> 3.4)
-    puppet (4.9.4)
-      facter (> 2.0, < 4)
-      gettext-setup (>= 0.10, < 1)
-      hiera (>= 2.0, < 4)
-      json_pure (~> 1.8)
-      locale (~> 2.1)
-    rainbow (2.2.1)
-    rake (12.0.0)
-    rdoc (3.12.2)
-      json (~> 1.4)
-    release_me (0.1.4)
-    rspec (3.5.0)
-      rspec-core (~> 3.5.0)
-      rspec-expectations (~> 3.5.0)
-      rspec-mocks (~> 3.5.0)
-    rspec-core (3.5.4)
-      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)
-    rubocop (0.47.1)
-      parser (>= 2.3.3.1, < 3.0)
-      powerpack (~> 0.1)
-      rainbow (>= 1.99.1, < 3.0)
-      ruby-progressbar (~> 1.7)
-      unicode-display_width (~> 1.0, >= 1.0.1)
-    ruby-progressbar (1.8.1)
-    simplecov (0.14.1)
-      docile (~> 1.1.0)
-      json (>= 1.8, < 3)
-      simplecov-html (~> 0.10.0)
-    simplecov-html (0.10.0)
-    slop (3.6.0)
-    text (1.3.1)
-    unicode-display_width (1.1.3)
-
-PLATFORMS
-  ruby
-
-DEPENDENCIES
-  awesome_print (~> 1.6)
-  bundler
-  facterdb (>= 0.3.8)
-  json_pure (<= 2.0.1)
-  pry
-  puppet (~> 4.9.0)
-  rake
-  rdoc (~> 3.12)
-  release_me
-  rspec
-  rubocop
-  simplecov
-
-BUNDLED WITH
-   1.14.6

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

@@ -1,191 +0,0 @@
-# frozen_string_literal: true
-module PuppetDebugger
-  module Support
-    module InputResponders
-      def static_responder_list
-        %w(exit functions classification vars facterdb_filter krt facts types
-           resources classes whereami datatypes play reset help)
-      end
-
-      def disable_benchmark
-        $benchmark = false
-        $extra_prompt = ''
-        'Off'
-      end
-
-      def enable_benchmark(show_status = false)
-        require 'benchmark'
-        $benchmark = true
-        if show_status
-          $extra_prompt = 'BM'
-          'On'
-        end
-      end
-
-      def benchmark(args = [])
-        if args.count > 0
-          enable_benchmark(false)
-          out = handle_input(args.first)
-          disable_benchmark
-          out
-        else
-          status = $benchmark ?  disable_benchmark : enable_benchmark(true)
-          "Benchmark Mode #{status}"
-        end
-      end
-
-      def datatypes(_args = [])
-        types = all_data_types
-        return types.sort.ai if types.instance_of?(Array)
-        types
-      end
-
-      # @source_file and @source_line_num instance variables must be set for this
-      # method to show the surrounding code
-      # @return [String] - string output of the code surrounded by the breakpoint or nil if file
-      # or line_num do not exist
-      def whereami(_command = nil, _args = nil)
-        file = @source_file
-        line_num = @source_line_num
-        if file && line_num
-          if file == :code
-            source_code = Puppet[:code]
-            code = DebuggerCode.from_string(source_code, :puppet)
-          else
-            code = DebuggerCode.from_file(file, :puppet)
-          end
-          return code.with_marker(line_num).around(line_num, 5)
-                     .with_line_numbers.with_indentation(5).with_file_reference.to_s
-        end
-      end
-
-      # @return - returns a list of types available to the environment
-      # if a error occurs we we run the types function again
-      def types(_args = [])
-        loaded_types = []
-        begin
-          # this loads all the types, if already loaded the file is skipped
-          Puppet::Type.loadall
-          Puppet::Type.eachtype do |t|
-            next if t.name == :component
-            loaded_types << t.name.to_s
-          end
-          loaded_types.ai
-        rescue Puppet::Error => e
-          puts e.message.red
-          Puppet.info(e.message)
-          # prevent more than two calls and recursive loop
-          return if caller_locations(1,10).find_all{|f| f.label == 'types' }.count > 2
-          types
-        end
-      end
-
-      # displays the facterdb filter
-      # @param [Array] - args is not used
-      def facterdb_filter(_args = [])
-        dynamic_facterdb_filter.ai
-      end
-
-      def help(_args = [])
-        PuppetDebugger::Cli.print_repl_desc
-      end
-
-      def handle_set(input)
-        output = ''
-        args = input.split(' ')
-        args.shift # throw away the set
-        case args.shift
-        when /node/
-          if name = args.shift
-            output = "Resetting to use node #{name}"
-            reset
-            set_remote_node_name(name)
-          else
-            out_buffer.puts 'Must supply a valid node name'
-          end
-        when /loglevel/
-          if level = args.shift
-            @log_level = level
-            set_log_level(level)
-            output = "loglevel #{Puppet::Util::Log.level} is set"
-          end
-        end
-        output
-      end
-
-      def facts(_args = [])
-        variables = node.facts.values
-        variables.ai(sort_keys: true, indent: -1)
-      end
-
-      def functions(args = [])
-        filter = args.first || ''
-        function_map.keys.sort.grep(/^#{Regexp.escape(filter)}/)
-      end
-
-      def vars(_args = [])
-        # remove duplicate variables that are also in the facts hash
-        variables = scope.to_hash.delete_if { |key, _value| node.facts.values.key?(key) }
-        variables['facts'] = 'removed by the puppet-debugger' if variables.key?('facts')
-        output = 'Facts were removed for easier viewing'.ai + "\n"
-        output += variables.ai(sort_keys: true, indent: -1)
-      end
-
-      def environment(_args = [])
-        "Puppet Environment: #{puppet_env_name}"
-      end
-
-      def reset(_args = [])
-        set_scope(nil)
-        set_remote_node_name(nil)
-        set_node(nil)
-        set_facts(nil)
-        set_environment(nil)
-        set_compiler(nil)
-        set_log_level(log_level)
-      end
-
-      def set_log_level(level)
-        Puppet::Util::Log.level = level.to_sym
-        buffer_log = Puppet::Util::Log.newdestination(:buffer)
-        if buffer_log
-          # if this is already set the buffer_log is nil
-          buffer_log.out_buffer = out_buffer
-          buffer_log.err_buffer = out_buffer
-        end
-        nil
-      end
-
-      def krt(_args = [])
-        known_resource_types.ai(sort_keys: true, indent: -1)
-      end
-
-      def play(args = [])
-        config = {}
-        config[:play] = args.first
-        play_back(config)
-        nil # we don't want to return anything
-      end
-
-      def classification(_args = [])
-        node.classes.ai
-      end
-
-      def resources(args = [])
-        res = scope.compiler.catalog.resources.map do |res|
-          res.to_s.gsub(/\[/, "['").gsub(/\]/, "']") # ensure the title has quotes
-        end
-        if !args.first.nil?
-          res[args.first.to_i].ai
-        else
-          output = "Resources not shown in any specific order\n".warning
-          output += res.ai
-        end
-      end
-
-      def classes(_args = [])
-        scope.compiler.catalog.classes.ai
-      end
-    end
-  end
-end