bolt 3.4.0 → 3.7.1

data/lib/bolt/transport/ssh/connection.rb

@@ -39,8 +39,6 @@ module Bolt
           end
         end
 
-        PAGEANT_NAME = "Pageant\0".encode(Encoding::UTF_16LE)
-
         def connect
           options = {
             logger: @transport_logger,
@@ -115,10 +113,9 @@ module Bolt
                 options[:use_agent] = false
               end
             elsif Bolt::Util.windows?
-              require 'Win32API' # case matters in this require!
-              # https://docs.microsoft.com/en-us/windows/desktop/api/winuser/nf-winuser-findwindoww
-              @find_window ||= Win32API.new('user32', 'FindWindowW', %w[P P], 'L')
-              if @find_window.call(nil, PAGEANT_NAME).to_i == 0
+              pageant = Net::SSH::Authentication::Pageant::Win.FindWindow("Pageant", "Pageant")
+              # If pageant is not running
+              if pageant.to_i == 0
                 @logger.debug { "Disabling use_agent in net-ssh: pageant process not running" }
                 options[:use_agent] = false
               end

data/lib/bolt/util.rb

@@ -332,6 +332,40 @@ module Bolt
         end
       end
 
+      # Executes a Docker CLI command. This is useful for running commands as
+      # part of this class without having to go through the `execute`
+      # function and manage pipes.
+      #
+      # @param cmd [String] The docker command and arguments to run
+      #   e.g. 'cp <src> <dest>' for `docker cp <src> <dest>`
+      # @return [String, String, Process::Status] The output of the command: STDOUT, STDERR, Process Status
+      def exec_docker(cmd, env = {})
+        Open3.capture3(env, 'docker', *cmd, { binmode: true })
+      end
+
+      # Executes a Podman CLI command. This is useful for running commands as
+      # part of this class without having to go through the `execute`
+      # function and manage pipes.
+      #
+      # @param cmd [String] The podman command and arguments to run
+      #   e.g. 'cp <src> <dest>' for `podman cp <src> <dest>`
+      # @return [String, String, Process::Status] The output of the command: STDOUT, STDERR, Process Status
+      def exec_podman(cmd, env = {})
+        Open3.capture3(env, 'podman', *cmd, { binmode: true })
+      end
+
+      # Formats a map of environment variables to be passed to a command that
+      # accepts repeated `--env` flags
+      #
+      # @param env_vars [Hash] A map of environment variables keys and their values
+      # @return [String]
+      def format_env_vars_for_cli(env_vars)
+        @env_vars = env_vars.each_with_object([]) do |(key, value), acc|
+          acc << "--env"
+          acc << "#{key}=#{value}"
+        end
+      end
+
       def unix_basename(path)
         raise Bolt::ValidationError, "path must be a String, received #{path.class} #{path}" unless path.is_a?(String)
         path.split('/').last

data/lib/bolt/version.rb

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

data/lib/bolt_server/transport_app.rb

@@ -703,6 +703,9 @@ module BoltServer
           connect_plugin = BoltServer::Plugin::PuppetConnectData.new(body['puppet_connect_data'])
           plugins = Bolt::Plugin.setup(context[:config], context[:pal], load_plugins: false)
           plugins.add_plugin(connect_plugin)
+          %w[aws_inventory azure_inventory gcloud_inventory].each do |plugin_name|
+            plugins.add_module_plugin(plugin_name) if plugins.known_plugin?(plugin_name)
+          end
           inventory = Bolt::Inventory.from_config(context[:config], plugins)
           target_list = inventory.get_targets('all').map do |targ|
             targ.to_h.merge({ 'transport' => targ.transport, 'plugin_hooks' => targ.plugin_hooks })

data/lib/bolt_spec/plans/mock_executor.rb

@@ -17,13 +17,14 @@ module BoltSpec
 
     # Nothing on the executor is 'public'
     class MockExecutor
-      attr_reader :noop, :error_message, :in_parallel
+      attr_reader :noop, :error_message, :in_parallel, :transports, :future
       attr_accessor :run_as, :transport_features, :execute_any_plan
 
       def initialize(modulepath)
         @noop = false
         @run_as = nil
         @in_parallel = false
+        @future = {}
         @error_message = nil
         @allow_apply = false
         @modulepath = [modulepath].flatten.map { |path| File.absolute_path(path) }
@@ -91,6 +92,14 @@ module BoltSpec
         result
       end
 
+      def run_task_with(target_mapping, task, options = {}, _position = [])
+        resultsets = target_mapping.map do |target, arguments|
+          run_task([target], task, arguments, options)
+        end.compact
+
+        Bolt::ResultSet.new(resultsets.map(&:results).flatten)
+      end
+
       def download_file(targets, source, destination, options = {}, _position = [])
         result = nil
         if (doub = @download_doubles[source] || @download_doubles[:default])
@@ -210,16 +219,6 @@ module BoltSpec
         yield
       end
 
-      def report_function_call(_function); end
-
-      def report_bundled_content(_mode, _name); end
-
-      def report_file_source(_plan_function, _source); end
-
-      def report_apply(_statements, _resources); end
-
-      def report_yaml_plan(_plan); end
-
       def publish_event(event)
         if event[:type] == :message
           unless @stub_out_message
@@ -257,6 +256,87 @@ module BoltSpec
         end.new(transport_features)
       end
       # End apply_prep mocking
+
+      # Evaluates a `parallelize()` block and returns the result. Normally,
+      # Bolt's executor wraps this in a Yarn for each object passed to the
+      # `parallelize()` function, and then executes them in parallel before
+      # returning the result from the block. However, in BoltSpec the block is
+      # executed for each object sequentially, and this function returns the
+      # result itself.
+      #
+      def create_yarn(scope, block, object, _index)
+        # Create the new scope
+        newscope = Puppet::Parser::Scope.new(scope.compiler)
+        local = Puppet::Parser::Scope::LocalScope.new
+
+        # Compress the current scopes into a single vars hash to add to the new scope
+        current_scope = scope.effective_symtable(true)
+        until current_scope.nil?
+          current_scope.instance_variable_get(:@symbols)&.each_pair { |k, v| local[k] = v }
+          current_scope = current_scope.parent
+        end
+        newscope.push_ephemerals([local])
+
+        begin
+          result = catch(:return) do
+            args = { block.parameters[0][1].to_s => object }
+            block.closure.call_by_name_with_scope(newscope, args, true)
+          end
+
+          # If we got a return from the block, get it's value
+          # Otherwise the result is the last line from the block
+          result = result.value if result.is_a?(Puppet::Pops::Evaluator::Return)
+
+          # Validate the result is a PlanResult
+          unless Puppet::Pops::Types::TypeParser.singleton.parse('Boltlib::PlanResult').instance?(result)
+            raise Bolt::InvalidParallelResult.new(result.to_s, *Puppet::Pops::PuppetStack.top_of_stack)
+          end
+
+          result
+        rescue Puppet::PreformattedError => e
+          if e.cause.is_a?(Bolt::Error)
+            e.cause
+          else
+            raise e
+          end
+        end
+      end
+
+      # BoltSpec already evaluated the `parallelize()` block for each object
+      # passed to the function, so these results can be returned as-is.
+      #
+      def round_robin(results)
+        results
+      end
+
+      # Public methods on Bolt::Executor that need to be mocked so there aren't
+      # "undefined method" errors.
+
+      def batch_execute(_targets); end
+
+      def finish_plan(_plan_result); end
+
+      def handle_event(_event); end
+
+      def prompt(_prompt, _options); end
+
+      def report_function_call(_function); end
+
+      def report_bundled_content(_mode, _name); end
+
+      def report_file_source(_plan_function, _source); end
+
+      def report_apply(_statements, _resources); end
+
+      def report_yaml_plan(_plan); end
+
+      def shutdown; end
+
+      def start_plan(_plan_context); end
+
+      def subscribe(_subscriber, _types = nil); end
+
+      def unsubscribe(_subscriber, _types = nil); end
     end
   end
 end

data/modules/puppet_connect/plans/test_input_data.pp

@@ -13,6 +13,19 @@
 #
 plan puppet_connect::test_input_data(TargetSpec $targets = 'all') {
   $targs = get_targets($targets)
+  $unique_plugins = $targs.group_by |$t| {$t.plugin_hooks['puppet_library']}
+  if ($unique_plugins.keys.length > 1) {
+    out::message('Multiple puppet_library plugin hooks detected')
+    $unique_plugins.each |$plug, $target_list| {
+      $target_message = if ($target_list.length > 10) {
+                          "${target_list.length} targets"
+                        } else {
+                          $target_list.join(', ')
+                        }
+      out::message("Plugin hook ${plug} configured for ${target_message}")
+    }
+    fail_plan("The puppet_library plugin config must be the same across all targets")
+  }
   $targs.each |$target| {
     case $target.transport {
       'ssh': {
@@ -59,6 +72,15 @@ plan puppet_connect::test_input_data(TargetSpec $targets = 'all') {
         fail_plan("Inventory contains target ${target} with unsupported transport, must be ssh or winrm")
       }
     }
+
+    # Bolt defaults to using the "module" based form of the puppet_agent plugin. Connect defaults
+    # to using the "task" based form as *only* the task based form in supported in Connect. This check
+    # ensures that if the default is not being used, only task based plugins are allowed.
+    $plugin = $target.plugin_hooks["puppet_library"]
+    $user_configured_plugin = $plugin != { "plugin"=> "puppet_agent", "stop_service"=> true }
+    if ($user_configured_plugin and $plugin["plugin"] != "task"){
+      fail_plan("Only task plugins are acceptable for puppet_library hook")
+    }
   }
   # The SSH/WinRM transports will report an 'unknown host' error for targets where
   # 'host' is unknown so run_command's implementation will take care of raising that

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bolt
 version: !ruby/object:Gem::Version
-  version: 3.4.0
+  version: 3.7.1
 platform: ruby
 authors:
 - Puppet
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-03-23 00:00:00.000000000 Z
+date: 2021-04-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: addressable
@@ -398,6 +398,7 @@ extra_rdoc_files: []
 files:
 - Puppetfile
 - bolt-modules/boltlib/lib/puppet/datatypes/applyresult.rb
+- bolt-modules/boltlib/lib/puppet/datatypes/containerresult.rb
 - bolt-modules/boltlib/lib/puppet/datatypes/resourceinstance.rb
 - bolt-modules/boltlib/lib/puppet/datatypes/result.rb
 - bolt-modules/boltlib/lib/puppet/datatypes/resultset.rb
@@ -413,12 +414,14 @@ files:
 - bolt-modules/boltlib/lib/puppet/functions/get_target.rb
 - bolt-modules/boltlib/lib/puppet/functions/get_targets.rb
 - bolt-modules/boltlib/lib/puppet/functions/parallelize.rb
+- bolt-modules/boltlib/lib/puppet/functions/puppetdb_command.rb
 - bolt-modules/boltlib/lib/puppet/functions/puppetdb_fact.rb
 - bolt-modules/boltlib/lib/puppet/functions/puppetdb_query.rb
 - bolt-modules/boltlib/lib/puppet/functions/remove_from_group.rb
 - bolt-modules/boltlib/lib/puppet/functions/resolve_references.rb
 - bolt-modules/boltlib/lib/puppet/functions/resource.rb
 - bolt-modules/boltlib/lib/puppet/functions/run_command.rb
+- bolt-modules/boltlib/lib/puppet/functions/run_container.rb
 - bolt-modules/boltlib/lib/puppet/functions/run_plan.rb
 - bolt-modules/boltlib/lib/puppet/functions/run_script.rb
 - bolt-modules/boltlib/lib/puppet/functions/run_task.rb
@@ -447,11 +450,15 @@ files:
 - bolt-modules/prompt/lib/puppet/functions/prompt/menu.rb
 - bolt-modules/system/lib/puppet/functions/system/env.rb
 - exe/bolt
+- guides/guide.txt
 - guides/inventory.txt
+- guides/links.txt
 - guides/logging.txt
 - guides/module.txt
 - guides/modulepath.txt
 - guides/project.txt
+- guides/targets.txt
+- guides/transports.txt
 - lib/bolt.rb
 - lib/bolt/analytics.rb
 - lib/bolt/applicator.rb
@@ -471,9 +478,11 @@ files:
 - lib/bolt/config/transport/lxd.rb
 - lib/bolt/config/transport/options.rb
 - lib/bolt/config/transport/orch.rb
+- lib/bolt/config/transport/podman.rb
 - lib/bolt/config/transport/remote.rb
 - lib/bolt/config/transport/ssh.rb
 - lib/bolt/config/transport/winrm.rb
+- lib/bolt/container_result.rb
 - lib/bolt/error.rb
 - lib/bolt/executor.rb
 - lib/bolt/inventory.rb
@@ -561,6 +570,8 @@ files:
 - lib/bolt/transport/lxd/connection.rb
 - lib/bolt/transport/orch.rb
 - lib/bolt/transport/orch/connection.rb
+- lib/bolt/transport/podman.rb
+- lib/bolt/transport/podman/connection.rb
 - lib/bolt/transport/remote.rb
 - lib/bolt/transport/simple.rb
 - lib/bolt/transport/ssh.rb