bolt 0.21.0 → 0.21.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 563c0acfed40d50d62d19a1c3d8acc4ea7ff04ed
-  data.tar.gz: 2233c30b95d4cf03e68a131cfe4e83ea527f720f
+  metadata.gz: 7cfabedc8ddc7e9d4f1345d676f959e08d6bf5f8
+  data.tar.gz: d05d6c279ff68b287402b6ea1439bec634b7caed
 SHA512:
-  metadata.gz: 94354f851af225ecd5ecc5123fee0aca0844d947685596d605e33f81543a8c5b071e30b2bcf4e872ab188e194dbec13b69dc8850de3761b02604ef2c1f49b997
-  data.tar.gz: 3d9e1463227a2c4ac4d0e80d6c1475e65b299f16d6371bef210f2dcbd090054a78d1590f54358fea416fdf812a7889890fb37b02ad835da81cc6d67b76046de4
+  metadata.gz: 959a5345daf5570d015c8a4d1decde76e963840104467c56d7cc86b1322d7a06b59cecb3d2b38c3dd8acaef59950bfce8be8f2b92b752f491646e4738b3d22e0
+  data.tar.gz: 3d772b7542b144c6916d04ead84a310ff3484df651a11c9332b2548b177423b634dd371263002365a8ce6d93581b01ec7b116b72678499da1fb7989e1ed19710

data/bolt-modules/boltlib/lib/puppet/functions/add_facts.rb

@@ -5,7 +5,7 @@ require 'bolt/error'
 # Deep merges a hash of facts with the existing facts on a target.
 Puppet::Functions.create_function(:add_facts) do
   # @param target A target.
-  # @param facts A hash of fact names to values that my include structured facts.
+  # @param facts A hash of fact names to values that may include structured facts.
   # @return The target's new facts.
   # @example Adding facts to a target
   #   add_facts($target, { 'os' => { 'family' => 'windows', 'name' => 'windows' } })

data/bolt-modules/boltlib/lib/puppet/functions/fail_plan.rb

@@ -2,7 +2,7 @@
 
 require 'bolt/error'
 
-# Raises a Bolt::PlanFailure exception to signal to callers that the plan failed
+# Raises a Bolt::PlanFailure exception to signal to callers that the plan failed.
 #
 # Plan authors should call this function when their plan is not successful. The
 # error may then be caught by another plans run_plan function or in bolt itself

data/bolt-modules/boltlib/lib/puppet/functions/run_plan.rb

@@ -2,7 +2,7 @@
 
 require 'bolt/error'
 
-# Runs the `plan` referenced by its name. A plan is autoloaded from <moduleroot>/plans.
+# Runs the `plan` referenced by its name. A plan is autoloaded from `<moduleroot>/plans`.
 Puppet::Functions.create_function(:run_plan, Puppet::Functions::InternalFunction) do
   # @param plan_name The plan to run.
   # @param named_args Arguments to the plan. Can also include additional options: '_catch_errors', '_run_as'.

data/bolt-modules/boltlib/lib/puppet/functions/set_feature.rb

@@ -2,8 +2,10 @@
 
 require 'bolt/error'
 
-# Sets a particular feature to present on a target. Features are used to determine what implementation
-# of a task should be run. Currently supported features are
+# Sets a particular feature to present on a target.
+#
+# Features are used to determine what implementation of a task should be run.
+# Currently supported features are
 # - powershell
 # - shell
 # - puppet-agent

data/bolt-modules/boltlib/lib/puppet/functions/vars.rb

@@ -2,9 +2,9 @@
 
 require 'bolt/error'
 
-# Returns a hash of the 'vars' (variables) assigned to a target through the
-# inventory file or `set_var` function.
+# Returns a hash of the 'vars' (variables) assigned to a target.
 #
+# Vars can be assigned through the inventory file or `set_var` function.
 # Plan authors can call this function on a target to get the variable hash
 # for that target.
 Puppet::Functions.create_function(:vars) do

data/bolt-modules/boltlib/lib/puppet/functions/without_default_logging.rb

@@ -1,8 +1,10 @@
 # frozen_string_literal: true
 
-# Define a block where default logging is suppressed. Messages for actions within this block
-# will be logged at `info` level instead of `notice`, so they will not be seen normally but
-# will still be present when `verbose` logging is requested.
+# Define a block where default logging is suppressed.
+#
+# Messages for actions within this block will be logged at `info` level instead
+# of `notice`, so they will not be seen normally but # will still be present
+# when `verbose` logging is requested.
 Puppet::Functions.create_function(:without_default_logging) do
   # @param block The block where action logging is suppressed.
   # @return [Undef]

data/exe/bolt_catalog

@@ -0,0 +1,34 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bolt'
+require 'bolt/catalog'
+require 'json'
+
+# This accepts a catalog request on stdin:
+# { "code_ast": "JSON serialized Puppet AST",
+#   "code_string": "String of code, ignored if AST is provided,
+#   "modulepath": "Array of directories to use as the modulepath for catalog compilation.
+#   "target": {
+#   "name": "the name of the node usually fqdn fro url",
+#   "facts": "Hash of facts to use for the node",
+#   "variables": "Hash of variables to use for compilation"
+#   }
+# }
+
+command = ARGV[0]
+if command == "parse"
+  code = File.open(ARGV[1], &:read)
+  puts JSON.pretty_generate(Bolt::Catalog.new.generate_ast(code))
+elsif command == "compile"
+  request = if ARGV[1]
+              File.open(ARGV[1]) { |fh| JSON.parse(fh.read) }
+            else
+              JSON.parse(STDIN.read)
+            end
+  catalog = Bolt::Catalog.new.compile_catalog(request)
+  puts JSON.pretty_generate(catalog)
+else
+  puts "USAGE: run 'bolt_catalog compile' with a request on STDIN " \
+       "or 'bolt_catalog parse manifest.pp' to generate JSON AST"
+end

data/lib/bolt/bolt_option_parser.rb

@@ -234,6 +234,9 @@ Available options are:
       define('--debug', 'Display debug logging') do |_|
         @options[:debug] = true
       end
+      define('--trace', 'Display error stack traces') do |_|
+        @options[:trace] = true
+      end
       define('--version', 'Display the version') do |_|
         puts Bolt::VERSION
         raise Bolt::CLIExit

data/lib/bolt/catalog.rb

@@ -0,0 +1,123 @@
+# frozen_string_literal: true
+
+require 'bolt/pal'
+
+Bolt::PAL.load_puppet
+
+# This class exists to override evaluate_main and let us inject
+# AST instead of looking for the main manifest. A better option may be to set up the
+# node environment so our AST is in the '' hostclass instead of doing it here.
+module Puppet
+  module Parser
+    class BoltCompiler < Puppet::Parser::Compiler
+      def internal_evaluator
+        @internal_evaluator ||= Puppet::Pops::Parser::EvaluatingParser.new
+      end
+
+      def dump_ast(ast)
+        Puppet::Pops::Serialization::ToDataConverter.convert(ast, rich_data: true, symbol_to_string: true)
+      end
+
+      def load_ast(ast_data)
+        Puppet::Pops::Serialization::FromDataConverter.convert(ast_data)
+      end
+
+      def parse_string(string, file = '')
+        internal_evaluator.parse_string(string, file)
+      end
+
+      def evaluate_main
+        main = Puppet.lookup(:pal_main)
+        ast = if main.is_a?(String)
+                parse_string(main)
+              else
+                load_ast(main)
+              end
+
+        bridge = Puppet::Parser::AST::PopsBridge::Program.new(ast)
+
+        # This is more or less copypaste from the super but we don't use the
+        # original host_class.
+        krt = environment.known_resource_types
+        @main = krt.add(Puppet::Resource::Type.new(:hostclass, '', code: bridge))
+        @topscope.source = @main
+        @main_resource = Puppet::Parser::Resource.new('class', :main, scope: @topscope, source: @main)
+        @topscope.resource = @main_resource
+        add_resource(@topscope, @main_resource)
+
+        @main_resource.evaluate
+      end
+    end
+  end
+end
+
+module Bolt
+  class Catalog
+    def in_env
+      Puppet::Pal.in_tmp_environment('bolt_apply', modulepath: ['~/bolt/modules/'], facts: @scope['facts']) do |pal|
+        yield pal
+      end
+    end
+
+    def with_puppet_settings
+      Dir.mktmpdir('bolt') do |dir|
+        cli = []
+        Puppet::Settings::REQUIRED_APP_SETTINGS.each do |setting|
+          cli << "--#{setting}" << dir
+        end
+        Puppet.settings.send(:clear_everything_for_tests)
+        Puppet.initialize_settings(cli)
+        # self.class.configure_logging
+        yield
+      end
+    end
+
+    def setup_node(node)
+      facts = Puppet.lookup(:pal_facts)
+      node_facts = Puppet::Node::Facts.new(Puppet[:node_name_value], facts)
+      node.fact_merge(node_facts)
+
+      node.parameters = node.parameters.merge(Puppet.lookup(:pal_variables))
+      # TODO: setup server_facts
+      # TODO: setup trusted in params
+      # TODO: setup serverversion/clientversion in params
+    end
+
+    def compile_node(node)
+      compiler = Puppet::Parser::BoltCompiler.new(node)
+      compiler.compile(&:to_resource)
+    end
+
+    def generate_ast(code)
+      with_puppet_settings do
+        Puppet::Pal.in_tmp_environment("bolt_parse") do |_pal|
+          node = Puppet.lookup(:pal_current_node)
+          compiler = Puppet::Parser::BoltCompiler.new(node)
+          compiler.dump_ast(compiler.parse_string(code))
+        end
+      end
+    end
+
+    def compile_catalog(request)
+      pal_main = request['code_ast'] || request['code_string']
+      target = request['target']
+      with_puppet_settings do
+        Puppet[:code] = ''
+        Puppet[:node_name_value] = target['name']
+        Puppet::Pal.in_tmp_environment(
+          'bolt_catalog',
+          modulepath: request["modulepath"] || [],
+          facts: target["facts"] || {},
+          variables: target["variables"] || {}
+        ) do |_pal|
+          node = Puppet.lookup(:pal_current_node)
+          setup_node(node)
+
+          Puppet.override(pal_main: pal_main) do
+            compile_node(node)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/bolt/cli.rb

@@ -351,7 +351,7 @@ module Bolt
     end
 
     def outputter
-      @outputter ||= Bolt::Outputter.for_format(config[:format], config[:color])
+      @outputter ||= Bolt::Outputter.for_format(config[:format], config[:color], config[:trace])
     end
   end
 end

data/lib/bolt/config.rb

@@ -26,6 +26,7 @@ module Bolt
   Config = Struct.new(
     :concurrency,
     :format,
+    :trace,
     :inventoryfile,
     :log,
     :modulepath,
@@ -197,7 +198,7 @@ module Bolt
     end
 
     def update_from_cli(options)
-      %i[concurrency transport format modulepath inventoryfile color].each do |key|
+      %i[concurrency transport format trace modulepath inventoryfile color].each do |key|
         self[key] = options[key] if options.key?(key)
       end
 

data/lib/bolt/inventory.rb

@@ -138,7 +138,9 @@ module Bolt
 
       unless data
         data = {}
-        data['config'] = { 'transport' => 'local' } if target.name == 'localhost'
+        unless Bolt::Util.windows?
+          data['config'] = { 'transport' => 'local' } if target.name == 'localhost'
+        end
       end
 
       unless data['config']
@@ -150,6 +152,7 @@ module Bolt
       # been instantiated
       set_vars_from_hash(target.name, data['vars']) unless @target_vars[target.name]
       set_facts(target.name, data['facts']) unless @target_facts[target.name]
+      data['features']&.each { |feature| set_feature(target, feature) } unless @target_features[target.name]
 
       # Use Config object to ensure config section is treated consistently with config file
       conf = @config.deep_clone

data/lib/bolt/inventory/group.rb

@@ -23,6 +23,7 @@ module Bolt
 
         @vars = data['vars'] || {}
         @facts = data['facts'] || {}
+        @features = data['features'] || []
         @config = data['config'] || {}
         @groups = if data['groups']
                     data['groups'].map { |g| Group.new(g) }
@@ -89,7 +90,7 @@ module Bolt
       end
 
       # The data functions below expect and return nil or a hash of the schema
-      # { 'config' => Hash , 'vars' => Hash, 'facts' => Hash, groups => Array }
+      # { 'config' => Hash , 'vars' => Hash, 'facts' => Hash, 'features' => Array, groups => Array }
       def data_for(node_name)
         data_merge(group_collect(node_name), node_collect(node_name))
       end
@@ -99,23 +100,26 @@ module Bolt
           { 'config' => data['config'] || {},
             'vars' => data['vars'] || {},
             'facts' => data['facts'] || {},
+            'features' => data['features'] || [],
             # groups come from group_data
             'groups' => [] }
         end
       end
 
       def group_data
-        { 'config' => @config,
-          'vars'   => @vars,
-          'facts'  => @facts,
-          'groups' => [@name] }
+        { 'config'   => @config,
+          'vars'     => @vars,
+          'facts'    => @facts,
+          'features' => @features,
+          'groups'   => [@name] }
       end
 
       def empty_data
-        { 'config' => {},
-          'vars'   => {},
-          'facts'  => {},
-          'groups' => [] }
+        { 'config'   => {},
+          'vars'     => {},
+          'facts'    => {},
+          'features' => [],
+          'groups'   => [] }
       end
 
       def data_merge(data1, data2)
@@ -130,6 +134,7 @@ module Bolt
           # with the value meant to replace it
           'vars'   => data1['vars'].merge(data2['vars']),
           'facts'  => Bolt::Util.deep_merge(data1['facts'], data2['facts']),
+          'features' => data1['features'] | data2['features'],
           'groups' => data2['groups'] + data1['groups']
         }
       end

data/lib/bolt/outputter.rb

@@ -2,19 +2,20 @@
 
 module Bolt
   class Outputter
-    def self.for_format(format, color)
+    def self.for_format(format, color, trace)
       case format
       when 'human'
-        Bolt::Outputter::Human.new(color)
+        Bolt::Outputter::Human.new(color, trace)
       when 'json'
-        Bolt::Outputter::JSON.new(color)
+        Bolt::Outputter::JSON.new(color, trace)
       when nil
         raise "Cannot use outputter before parsing."
       end
     end
 
-    def initialize(color, stream = $stdout)
+    def initialize(color, trace, stream = $stdout)
       @color = color
+      @trace = trace
       @stream = stream
     end
 

data/lib/bolt/outputter/human.rb

@@ -175,6 +175,12 @@ module Bolt
         if err.is_a? Bolt::RunFailure
           @stream.puts ::JSON.pretty_generate(err.result_set)
         end
+
+        if @trace && err.backtrace
+          err.backtrace.each do |line|
+            @stream.puts(colorize(:red, "\t#{line}"))
+          end
+        end
       end
     end
 

data/lib/bolt/outputter/json.rb

@@ -3,11 +3,11 @@
 module Bolt
   class Outputter
     class JSON < Bolt::Outputter
-      def initialize(color, stream = $stdout)
+      def initialize(color, trace, stream = $stdout)
         @items_open = false
         @object_open = false
         @preceding_item = false
-        super(color, stream)
+        super(color, trace, stream)
       end
 
       def print_head
@@ -60,7 +60,12 @@ module Bolt
       def fatal_error(err)
         @stream.puts "],\n" if @items_open
         @stream.puts '"_error": ' if @object_open
-        @stream.puts err.to_json
+        err_obj = err.to_h
+        if @trace && err.backtrace
+          err_obj[:details] ||= {}
+          err_obj[:details][:backtrace] = err.backtrace
+        end
+        @stream.puts err_obj.to_json
         @stream.puts '}' if @object_open
       end
 

data/lib/bolt/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Bolt
-  VERSION = '0.21.0'
+  VERSION = '0.21.1'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bolt
 version: !ruby/object:Gem::Version
-  version: 0.21.0
+  version: 0.21.1
 platform: ruby
 authors:
 - Puppet
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-06-19 00:00:00.000000000 Z
+date: 2018-06-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: addressable
@@ -324,6 +324,7 @@ email:
 executables:
 - bolt
 - bolt-inventory-pdb
+- bolt_catalog
 extensions: []
 extra_rdoc_files: []
 files:
@@ -349,9 +350,11 @@ files:
 - bolt-modules/boltlib/types/targetspec.pp
 - exe/bolt
 - exe/bolt-inventory-pdb
+- exe/bolt_catalog
 - lib/bolt.rb
 - lib/bolt/analytics.rb
 - lib/bolt/bolt_option_parser.rb
+- lib/bolt/catalog.rb
 - lib/bolt/cli.rb
 - lib/bolt/config.rb
 - lib/bolt/error.rb