puppet-debugger 0.5.1 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: bf5bf556d8e8b1810aff75dc4ca595b8d52d1f2e
-  data.tar.gz: 57513b64926b0107ecff995c4ce81985dce6ea6c
+  metadata.gz: 857afe5c153e6dbdce56459291318d984689a28f
+  data.tar.gz: c8c80c82ef553716ac98bf59c6a3175f8a11235a
 SHA512:
-  metadata.gz: a8de0ef4a70b41de5ed03f119f1332e16222ba9fd3a8405ae31526004be2c69ab2cbf6abf56c02862113eca6e60d90fe69711519de30667155b1763922275247
-  data.tar.gz: a1bd4e25633ee39854aad9a4ff74489eb22773c03012c23b4b8926e57583f4922f8f5c9da0ec9007b12f9b0f832923daa48666fea503514c18a605d8f718e81a
+  metadata.gz: 0fd7ebb96bef948c27045478ff96f872e22bcd98b2bcf4c8c2b44087eb7d75efaa1760327c9becdc8be2eb6b62ba1e6cf6bc5f147b00d98db1135410e0af27ed
+  data.tar.gz: d2440f621ba7b0fe0111fa7735fd7cd8a53f1e6832cf7c1eba073149ebb8bd8c7d1bd15d6d5559766f1a2303194155be35d2edbdfd40d23201ac1ba50fb478d0

data/.gitlab-ci.yml

@@ -13,6 +13,8 @@ stages:
     - bundle install --without development validate
     - bundle exec puppet module install puppetlabs-stdlib
     - bundle exec rake spec
+  tags:
+    - ruby
 
 web_trigger_staging:
   type: web_deploy
@@ -45,14 +47,16 @@ bump_and_tag:
     - gem install release_me 
     - bump_and_tag
 
-web_trigger_production:
-  type: web_deploy
-  variables:
-    REF: production
-  only:
-    - tags
-  script:
-    - "curl -X POST -F token=$PREPL_BUILD_TRIGGER_TOKEN -F ref=$REF https://gitlab.com/api/v3/projects/1146764/trigger/builds"
+#web_trigger_production:
+#  type: web_deploy
+#  variables:
+#    REF: production
+#  only:
+#    - tags
+#  tags:
+#    - ruby
+#  script:
+#    - "curl -X POST -F token=$PREPL_BUILD_TRIGGER_TOKEN -F ref=$REF https://gitlab.com/api/v3/projects/1146764/trigger/builds"
 
 .ruby_193: &ruby193
   image: ruby:1.9.3

data/CHANGELOG.md

@@ -1,5 +1,8 @@
-## Unreleased
-
+## 0.6.0
+  * Adds ability to list puppet types
+  * Adds ability to list puppet datatypes
+## 0.5.1
+  * accidently bump 
 ## 0.5.0
   * Fixes #gh-49 - puppet 4 functions don't seem to work
   * Disables trying to set trusted_node_data for puppet versions that do not support it

data/lib/puppet-debugger/cli.rb

@@ -45,7 +45,7 @@ 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).uniq.sort
+      (scoped_vars + funcs + static_responder_list + all_data_types).uniq.sort
     end
 
     # looks up the type in the catalog by using the type and title
@@ -97,7 +97,7 @@ module PuppetDebugger
       begin
         output = ''
         case input
-        when /^play|^classification|^whereami|^facterdb_filter|^facts|^vars|^functions|^classes|^resources|^krt|^environment|^reset|^help/
+        when /^play|^classification|^whereami|^facterdb_filter|^facts|^datatypes|^types|^vars|^functions|^classes|^resources|^krt|^environment|^reset|^help/
           args = input.split(' ')
           command = args.shift.to_sym
           output = send(command, args) if respond_to?(command)
@@ -150,7 +150,7 @@ Puppet Version: #{Puppet.version}
 Puppet Debugger Version: #{PuppetDebugger::VERSION}
 Created by: NWOps <corey@nwops.io>
 Type "exit", "functions", "vars", "krt", "whereami", "facts", "resources", "classes",
-     "play", "classification", "reset", or "help" for more information.
+     "play", "classification", "types", "datatypes", "reset", or "help" for more information.
 
       EOT
       output

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

@@ -34,8 +34,8 @@ module PuppetDebugger
       # returns the environment
       def create_environment
         Puppet::Node::Environment.create(Puppet[:environment],
-                                                   default_modules_paths,
-                                                   default_manifests_dir)
+                                         default_modules_paths,
+                                         default_manifests_dir)
       end
 
       def create_node_environment(manifest = nil)

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

@@ -17,6 +17,18 @@ module PuppetDebugger
         Dir.glob(search_dirs.flatten)
       end
 
+      def data_type_files
+        search_dirs = lib_dirs.map do |lib_dir|
+          [File.join(lib_dir, 'puppet', 'functions', '**', '*.rb'),
+           File.join(lib_dir, 'functions', '**', '*.rb'),
+           File.join(lib_dir, 'puppet', 'parser', 'functions', '*.rb')]
+        end
+        # add puppet lib directories
+        search_dirs << [File.join(puppet_lib_dir, 'puppet', 'functions', '**', '*.rb'),
+                        File.join(puppet_lib_dir, 'puppet', 'parser', 'functions', '*.rb')]
+        Dir.glob(search_dirs.flatten)
+      end
+
       # returns either the module name or puppet version
       def mod_finder
         @mod_finder ||= Regexp.new('\/([\w\-\.]+)\/lib')

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

@@ -3,13 +3,20 @@ module PuppetDebugger
   module Support
     module InputResponders
       def static_responder_list
-        %w(exit functions classification vars facterdb_filter krt facts
-           resources classes whereami play reset help)
+        %w(exit functions classification vars facterdb_filter krt facts types
+           resources classes whereami datatypes play reset help)
+      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
+      # @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
@@ -20,7 +27,29 @@ module PuppetDebugger
           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
+          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
 

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

@@ -1,15 +1,35 @@
+# frozen_string_literal: true
 module PuppetDebugger
   module Support
     module Loader
-
       def create_loader(environment)
         Puppet::Pops::Loaders.new(environment)
       end
 
-      def data_types
-        loader.implementation_registry.
-            instance_variable_get(:'@implementations_per_type_name').
-            keys.find_all { |t| t !~ /::/ }
+      # @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
@@ -19,16 +39,23 @@ module PuppetDebugger
       # returns an array of module loaders that we may need to use in the future
       # in order to parse all types of code (ie. functions)  For now this is not
       # being used.
-      def resolve_paths(loaders)
-        mod_resolver = loaders.instance_variable_get(:@module_resolver)
-        all_mods = mod_resolver.instance_variable_get(:@all_module_loaders)
-      end
+      # def resolve_paths(loaders)
+      #   mod_resolver = loaders.instance_variable_get(:@module_resolver)
+      #   all_mods = mod_resolver.instance_variable_get(:@all_module_loaders)
+      #   all_mods.last.get_contents
+      # end
 
       # def functions
       #   @functions = []
       #   @functions << compiler.loaders.static_loader.loaded.keys.find_all {|l| l.type == :function}
+      # returns all the type names, athough we cannot determine the difference between datatype and resource type
+      # loaders.static_loader.loaded.map { |item| item.first.name}
+      # loaders.implementation_registry.
+      #     instance_variable_get(:'@implementations_per_type_name').
+      #     keys.find_all { |t| t !~ /::/ }
+      # Puppet::Pops::Types::TypeFactory.type_map.keys.map(&:capatilize)
       # end
-
+      # Puppet::Pops::Adapters::LoaderAdapter.loader_for_model_object(generate_ast(''))
     end
   end
 end

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

@@ -31,17 +31,15 @@ module PuppetDebugger
         node = nil
         unless Puppet[:node_name_fact].empty?
           # Collect our facts.
-          unless facts = Puppet::Node::Facts.indirection.find(Puppet[:node_name_value])
-            raise "Could not find facts for #{Puppet[:node_name_value]}"
-          end
+          facts = Puppet::Node::Facts.indirection.find(Puppet[:node_name_value])
+          raise "Could not find facts for #{Puppet[:node_name_value]}" unless facts
           Puppet[:node_name_value] = facts.values[Puppet[:node_name_fact]]
           facts.name = Puppet[:node_name_value]
         end
         Puppet.override({ current_environment: environment }, 'For puppet debugger') do
           # Find our Node
-          unless node = Puppet::Node.indirection.find(Puppet[:node_name_value])
-            raise "Could not find node #{Puppet[:node_name_value]}"
-          end
+          node = Puppet::Node.indirection.find(Puppet[:node_name_value])
+          raise "Could not find node #{Puppet[:node_name_value]}" unless node
           # Merge in the facts.
           node.merge(facts.values) if facts
         end

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

@@ -2,7 +2,6 @@
 module PuppetDebugger
   module Support
     module Scope
-
       # @param [Puppet::Pops::Scope] - Scope object or nil
       def set_scope(value)
         @scope = value

data/lib/version.rb

@@ -1,4 +1,4 @@
 # frozen_string_literal: true
 module PuppetDebugger
-  VERSION = '0.5.1'
+  VERSION = '0.6.0'
 end

data/spec/puppet/application/debugger_spec.rb

@@ -78,7 +78,6 @@ $var1
         EOF
       end
 
-
       it 'assign variable' do
         allow(debugger).to receive(:options).and_return(code: input, quiet: true, run_once: true, use_facterdb: true)
         expect { debugger.run_command }.to output(/\"111111\"/).to_stdout
@@ -109,13 +108,10 @@ $var1
         EOF
       end
 
-
       it 'assign variable' do
         allow(debugger).to receive(:options).and_return(code: input, quiet: true, run_once: true, use_facterdb: false)
         expect { debugger.run_command }.to output(/\"111111\"/).to_stdout
       end
     end
   end
-
-
 end

data/spec/puppet_debugger_spec.rb

@@ -180,7 +180,7 @@ describe 'PuppetDebugger' 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\", \"reset\", or \"help\" for more information.\n\n/
+      expected_debugger_output = /Type \"exit\", \"functions\", \"vars\", \"krt\", \"whereami\", \"facts\", \"resources\", \"classes\",\n     \"play\", \"classification\", \"types\", \"datatypes\", \"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/)
@@ -446,6 +446,20 @@ describe 'PuppetDebugger' do
     end
   end
 
+  describe 'datatypes' do
+    let(:input) do
+      'datatypes'
+    end
+    it 'handle datatypes' do
+      debugger.handle_input(input)
+      if Puppet.version < '4.3.0'
+        expect(output.string).to eq("\n[]\n")
+      else
+        expect(output.string).to match(/.*Array.*/)
+      end
+    end
+  end
+
   describe 'whereami' do
     let(:input) do
       File.expand_path File.join(fixtures_dir, 'sample_start_debugger.pp')
@@ -465,6 +479,16 @@ describe 'PuppetDebugger' do
     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'}"

metadata

@@ -1,69 +1,69 @@
 --- !ruby/object:Gem::Specification
 name: puppet-debugger
 version: !ruby/object:Gem::Version
-  version: 0.5.1
+  version: 0.6.0
 platform: ruby
 authors:
 - Corey Osman
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-03-25 00:00:00.000000000 Z
+date: 2017-04-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: puppet
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '3.8'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '3.8'
 - !ruby/object:Gem::Dependency
   name: facterdb
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: 0.3.8
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: 0.3.8
 - !ruby/object:Gem::Dependency
   name: awesome_print
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '1.6'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '1.6'
 - !ruby/object:Gem::Dependency
   name: rdoc
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '3.12'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '3.12'
 description: A interactive command line tool for evaluating and debugging the puppet
@@ -77,15 +77,15 @@ extra_rdoc_files:
 - LICENSE.txt
 - README.md
 files:
-- ".dockerignore"
-- ".document"
-- ".gitignore"
-- ".gitlab-ci.yml"
-- ".release_me.yaml"
-- ".rspec"
-- ".rubocop.yml"
-- ".rubocop_todo.yml"
-- ".ruby-version"
+- .dockerignore
+- .document
+- .gitignore
+- .gitlab-ci.yml
+- .release_me.yaml
+- .rspec
+- .rubocop.yml
+- .rubocop_todo.yml
+- .ruby-version
 - CHANGELOG.md
 - DEVELOPMENT.md
 - Gemfile
@@ -142,17 +142,17 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.11
+rubygems_version: 2.0.14.1
 signing_key: 
 specification_version: 4
 summary: A repl based debugger for the puppet language