puppet-debugger 0.8.1 → 0.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b7649431296d68631a37a5c0d65dcc9f9b83e8f3
-  data.tar.gz: 3d6b70fed0bea5b1d4190df2fa6bfdd26635c6a7
+  metadata.gz: 51ec604fd150c721a41a3d42ce21d69d3f9fed03
+  data.tar.gz: b75d1fd7d668e3264748315e724a139575a2cb38
 SHA512:
-  metadata.gz: 7d8b304f2aa1f107975741c58a90cc1fb5524f00760a3470fcd82beee80d6a12da4f9d4968121c767a5fe5473396bc8fa539822674326294d77d9e66bb390ecc
-  data.tar.gz: fefe9b07906cfe977fcba927bfd05776e069f903565b2922205786bd68109c8bdcd6a3d7fd736d4749ae70f117dcbc64ddd4608500a1ce5d7d60322f9d9ece9e
+  metadata.gz: a294ae4f12955ff934f4c17ae4bd7b936647edae7f6972109d5a48a7715ca479daf61fabaa7f6369b44bfae010fec64f8393dab4c00d8ecc57f7bf36a7c40c2e
+  data.tar.gz: 5ee9828762a15965f4e61060fb9ce234c36da925b25277b8fa4030d4b2dc88730dffd7490b948d5b8adee4c7b1aa233eee653874d4e52cf3b9df7b82030ceafa

data/.gitlab-ci.yml

@@ -154,26 +154,32 @@ puppet_47_ruby22:
   <<: *puppet_job_def
   <<: *ruby22
 
-puppet_48_ruby22:
+puppet_410_ruby24:
   variables:
-    PUPPET_GEM_VERSION: "~> 4.8.0"
+    PUPPET_GEM_VERSION: "~> 4.10.0"
   <<: *puppet_job_def
-  <<: *ruby22
+  <<: *ruby24
 
-puppet_49_ruby23:
+puppet_50_ruby24:
   variables:
-    PUPPET_GEM_VERSION: "~> 4.9.0"
+    PUPPET_GEM_VERSION: "~> 5.0"
   <<: *puppet_job_def
-  <<: *ruby23
+  <<: *ruby24
 
-puppet_410_ruby24:
+puppet_51_ruby24:
   variables:
-    PUPPET_GEM_VERSION: "~> 4.10.0"
+    PUPPET_GEM_VERSION: "~> 5.1"
   <<: *puppet_job_def
   <<: *ruby24
 
-puppet_5_ruby24:
+puppet_52_ruby24:
   variables:
-    PUPPET_GEM_VERSION: "~> 5.0"
+    PUPPET_GEM_VERSION: "~> 5.2"
+  <<: *puppet_job_def
+  <<: *ruby24
+
+puppet_53_ruby24:
+  variables:
+    PUPPET_GEM_VERSION: "~> 5.3"
   <<: *puppet_job_def
   <<: *ruby24

data/CHANGELOG.md

@@ -1,5 +1,11 @@
 ## Unreleased
 
+## 0.9.0
+Released October 24, 2017
+ * Adds FacterDB as 0.4.0 dependency for external facts support
+ * Fixes #59 - Unhandled puppet type with awesome_print
+ * Fixes loading of multiple data types
+ * Add Puppet 5.1, 5.2, 5.3 to test matrix
 ## 0.8.1
  * Fixes bug with command completion and blank inputs
 ## 0.8.0

data/Gemfile

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 source 'http://rubygems.org'
 gem 'awesome_print', '~> 1.7'
-gem 'facterdb', '~> 0.3.8'
+gem 'facterdb', '~> 0.4.0'
 gem 'puppet', ENV['PUPPET_GEM_VERSION'] || '~> 4.10.1'
 gem 'pluginator', '~> 1.5.0'
 

data/Plugin_development.md

@@ -200,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)
+* loaders      ( The puppet loaders )
+* puppet_environment
 * add_hook, delete_hook
 * handle_input (use instead of debugger.handle_input)
 

data/README.md

@@ -55,7 +55,7 @@ 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
+There is a web version of the [puppet-debugger](https://demo.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 debugger.
 
 ## Usage
@@ -239,7 +239,45 @@ 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.
+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.
+
+## Custom FacterDB Facts
+As of FacterDB 0.4.0 we can now supply custom [external fact sets](https://github.com/camptocamp/facterdb#supplying-custom-external-facts) to facterDB..  This is a huge deal because you can take the facts from any system and play around with the fact data in the debugger.  This makes the debugger appear as it was run on that system.  Moreover, you can create shareable fact sets for your entire team. To use an external fact set you first need to grab the facts from the system you wish to "mock".  This can be done with `puppet facts` or even puppetdb queries and then create a file with the values hash.
+
+
+Take the values from the values hash only and place inside a new file.
+```
+{
+  "name": "macbook-pro-10.domain",
+  "values": {
+    "custom_datacenter_fact": "iceland",
+    "puppetversion": "5.3.2",
+    "architecture": "x86_64",
+    "kernel": "Darwin",
+    "domain": "domain"
+  }
+}
+
+```
+
+This can be easily done if you have `jq` installed. 
+
+`puppet facts | jq '.values' > /tmp/custom_facts/datacenter_a/2.4/os_x.facts`
+
+Once you have created a directory with one or more fact files you just need to set an environment variable to tell facterDB about the custom fact sets.
+
+`export FACTERDB_SEARCH_PATHS="/tmp/custom_facts/"`
+
+Now everytime you start the puppet debugger, facterDB will use these custom fact files
+as part of the facterDB database.  However, you will still need to provide a search filter that references your custom fact because there are over a thousand facterDB fact sets.  
+
+`puppet debugger --facterdb-filter 'custom_datacenter_fact=iceland'`
+
+
+Alternatively you can bypass the internal facterDB database by setting `export FACTERDB_SKIP_DEFAULTDB=true` and force your custom facts to be the only facts facterDB uses.
+
+*Note: when exporting facterDB environment variables you will also change the behavior for rspec_puppet_facts and other gems that also rely on facterDB.  So please remember to unset the variables if not needed*
 
 ## 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.

data/lib/awesome_print/ext/awesome_puppet.rb

@@ -1,5 +1,19 @@
 # frozen_string_literal: true
 
+module Kernel
+  class Hash
+    def to_h
+      hash = extra_hash_attributes.dup
+
+      self.class.hash_attribute_names.each do |name|
+        hash[name] = __send__(name)
+      end
+
+      hash
+    end
+  end
+end
+
 module AwesomePrint
   module Puppet
     def self.included(base)
@@ -26,13 +40,19 @@ module AwesomePrint
 
     def awesome_puppet_resource(object)
       return '' if object.nil?
-      awesome_puppet_type(object.to_ral)
+      resource_object = object.to_ral
+      awesome_puppet_type(resource_object)
     end
 
     def awesome_puppet_type(object)
       return '' if object.nil?
-      return object.to_s unless object.respond_to?(:name) && object.respond_to?(:title)
-      h = object.to_hash.merge(name: object.name, title: object.title)
+      return object.to_s unless object.respond_to?(:name) && object.respond_to?(:title) && object.respond_to?(:to_hash)
+      if Array.new.respond_to?(:to_h)
+        # to_h is only supported in ruby 2.1+
+        h = object.to_hash.merge(name: object.name, title: object.title).sort.to_h
+      else
+        h = object.to_hash.merge(name: object.name, title: object.title)
+      end
       res_str = awesome_hash(h)
       "#{object.class} #{res_str.delete(':')}"
     end

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

@@ -7,9 +7,34 @@ module PuppetDebugger
       COMMAND_GROUP = :environment
 
       def run(args = [])
-        types = debugger.all_data_types
-        return types.sort.ai if types.instance_of?(Array)
-        types
+        all_data_types.sort.ai
+      end
+
+      # @return [Array[String]] - returns a list of all the custom data types found in all the modules in the environment
+      def environment_data_types
+        globs = debugger.puppet_environment.instance_variable_get(:@modulepath).map { |m| File.join(m, '**', 'types', '**', '*.pp') }
+        files = globs.map { |g| Dir.glob(g) }.flatten
+        files.map do |f|
+          m = File.read(f).match(/type\s([a-z\d\:_]+)/i)
+          next if m =~ /type|alias/ # can't figure out the best way to filter type and alias out
+          m[1] if m && m[1] =~ /::/
+        end.uniq.compact
+      end
+
+      # @return [Array[String]] - a list of core data types
+      def core_datatypes
+        loaders.implementation_registry
+            .instance_variable_get(:'@implementations_per_type_name')
+            .keys.find_all { |t| t !~ /::/ }
+      end
+
+      # @return [Array[String]] - combined list of core data types and environment data types
+      def all_data_types
+        unless loaders.respond_to?(:implementation_registry)
+          Puppet.info("Data Types Not Available in Puppet: #{Puppet.version}")
+          return []
+        end
+        core_datatypes + environment_data_types
       end
 
     end

data/lib/puppet-debugger/cli.rb

@@ -71,7 +71,8 @@ module PuppetDebugger
       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 + all_data_types).uniq.sort
+      PuppetDebugger::InputResponders::Datatypes.instance.debugger = self
+      (scoped_vars + funcs + static_responder_list + PuppetDebugger::InputResponders::Datatypes.instance.all_data_types).uniq.sort
     end
 
     # looks up the type in the catalog by using the type and title

data/lib/puppet-debugger/input_responder_plugin.rb

@@ -7,7 +7,7 @@ module PuppetDebugger
       include Singleton
       extend Forwardable
       attr_accessor :debugger
-      def_delegators :debugger, :scope, :node, :environment,
+      def_delegators :debugger, :scope, :node, :environment, :loaders, :puppet_environment,
                      :add_hook, :handle_input, :delete_hook, :function_map
       def_delegators :scope, :compiler, :catalog
       def_delegators :node, :facts

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

@@ -8,32 +8,6 @@ module PuppetDebugger
         Puppet::Pops::Loaders.new(environment)
       end
 
-      # @return [Array[String]] - returns a list of all the custom data types found in all the modules in the environment
-      def environment_data_types
-        files = Dir.glob(puppet_environment.modulepath.map { |m| File.join(m, '**', 'types', '**', '*.pp') })
-        files.map do |f|
-          m = File.read(f).match(/type\s([a-z\d\:_]+)/i)
-          next if m =~ /type|alias/ # can't figure out the best way to filter type and alias out
-          m[1] if m && m[1] =~ /::/
-        end.uniq.compact
-      end
-
-      # @return [Array[String]] - a list of core data types
-      def core_datatypes
-        loaders.implementation_registry
-               .instance_variable_get(:'@implementations_per_type_name')
-               .keys.find_all { |t| t !~ /::/ }
-      end
-
-      # @return [Array[String]] - combined list of core data types and environment data types
-      def all_data_types
-        unless loaders.respond_to?(:implementation_registry)
-          Puppet.info("Data Types Not Available in Puppet: #{Puppet.version}")
-          return []
-        end
-        core_datatypes + environment_data_types
-      end
-
       def loaders
         @loaders ||= create_loader(puppet_environment)
       end

data/lib/version.rb

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

data/puppet-debugger.gemspec

@@ -34,7 +34,7 @@ Gem::Specification.new do |s|
   s.summary = "A repl based debugger for the puppet language"
   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<facterdb>, ["~> 0.4.0"])
   s.add_runtime_dependency(%q<awesome_print>, ["~> 1.7"])
   s.add_development_dependency(%q<rdoc>, ["~> 3.12"])
   s.add_development_dependency(%q<rspec>, ["~> 3.6"])

data/spec/input_responders/datatypes_spec.rb

@@ -14,4 +14,12 @@ describe :datatypes do
       expect(output).to match(/.*Array.*/)
     end
   end
+
+  it 'returns core datatypes' do
+    expect(plugin.all_data_types.count).to be >= 30 if supports_datatypes?
+  end
+
+  it 'returns environment datatypes' do
+    expect(plugin.environment_data_types.count).to be >= 0
+  end
 end

data/spec/input_responders/vars_spec.rb

@@ -24,4 +24,15 @@ describe :vars do
     debugger.handle_input("$var1 = 'value1'")
     expect(plugin.run(args)).to match(/value1/)
   end
+
+  describe 'resource' do
+    let(:input) do
+      "$service_require = Package['httpd']"
+    end
+    it 'can process a resource' do
+      debugger_output = /Facts/
+      debugger.handle_input(input)
+      expect(plugin.run(args)).to match(debugger_output)
+    end
+  end
 end

data/spec/puppet_debugger_spec.rb

@@ -80,6 +80,16 @@ describe 'PuppetDebugger' do
     end
   end
 
+  describe 'key_words' do
+    it do
+      expect(debugger.key_words.count).to be >= 30 if supports_datatypes?
+    end
+
+    it do
+      expect(debugger.key_words.count).to be >= 0 unless supports_datatypes?
+    end
+  end
+
   describe 'native functions', native_functions: true do
     let(:func) do
       <<-EOF

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: puppet-debugger
 version: !ruby/object:Gem::Version
-  version: 0.8.1
+  version: 0.9.0
 platform: ruby
 authors:
 - Corey Osman
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-07-09 00:00:00.000000000 Z
+date: 2017-10-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pluginator
@@ -44,14 +44,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.3.1
+        version: 0.4.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.3.1
+        version: 0.4.0
 - !ruby/object:Gem::Dependency
   name: awesome_print
   requirement: !ruby/object:Gem::Requirement