bolt 3.0.0 → 3.5.0

data/lib/bolt/transport/lxd.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+require 'bolt/logger'
+require 'bolt/node/errors'
+require 'bolt/transport/simple'
+
+module Bolt
+  module Transport
+    class LXD < Simple
+      def provided_features
+        ['shell']
+      end
+
+      def with_connection(target, options = {})
+        Bolt::Logger.warn_once("lxd_experimental",
+                               "The LXD transport is experimental, and might "\
+                               "include breaking changes between minor versions.")
+        conn = Connection.new(target, options)
+        conn.connect
+        yield conn
+      end
+    end
+  end
+end
+
+require 'bolt/transport/lxd/connection'

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

@@ -0,0 +1,99 @@
+# frozen_string_literal: true
+
+require 'logging'
+require 'bolt/node/errors'
+
+module Bolt
+  module Transport
+    class LXD < Simple
+      class Connection
+        attr_reader :user, :target
+
+        def initialize(target, options)
+          raise Bolt::ValidationError, "Target #{target.safe_name} does not have a host" unless target.host
+
+          @target = target
+          @user = ENV['USER'] || Etc.getlogin
+          @options = options
+          @logger = Bolt::Logger.logger(target.safe_name)
+          @logger.trace("Initializing LXD connection to #{target.safe_name}")
+        end
+
+        def shell
+          Bolt::Shell::Bash.new(target, self)
+        end
+
+        def container_id
+          "#{@target.transport_config['remote']}:#{@target.host}"
+        end
+
+        def connect
+          out, err, status = execute_local_command(%W[list #{container_id} --format json])
+          unless status.exitstatus.zero?
+            raise "Error listing available containers: #{err}"
+          end
+          containers = JSON.parse(out)
+          if containers.empty?
+            raise "Could not find a container with name or ID matching '#{container_id}'"
+          end
+          @logger.trace("Opened session")
+          true
+        rescue StandardError => e
+          raise Bolt::Node::ConnectError.new(
+            "Failed to connect to #{container_id}: #{e.message}",
+            'CONNECT_ERROR'
+          )
+        end
+
+        def add_env_vars(env_vars)
+          @env_vars = env_vars.each_with_object([]) do |env_var, acc|
+            acc << "--env"
+            acc << "#{env_var[0]}=#{Shellwords.shellescape(env_var[1])}"
+          end
+        end
+
+        def execute(command)
+          lxc_command = %w[lxc exec]
+          lxc_command += @env_vars if @env_vars
+          lxc_command += %W[#{container_id} -- sh -c #{Shellwords.shellescape(command)}]
+
+          @logger.trace { "Executing: #{lxc_command.join(' ')}" }
+          Open3.popen3(lxc_command.join(' '))
+        end
+
+        private def execute_local_command(command)
+          Open3.capture3('lxc', *command, { binmode: true })
+        end
+
+        def upload_file(source, destination)
+          @logger.trace { "Uploading #{source} to #{destination}" }
+          args = %w[--create-dirs]
+          if File.directory?(source)
+            args << '--recursive'
+            # If we don't do this, LXD will upload to
+            # /tmp/d2020-11/d2020-11/dir instead of /tmp/d2020-11/dir
+            destination = Pathname.new(destination).dirname.to_s
+          end
+          cmd = %w[file push] + args + %W[#{source} #{container_id}#{destination}]
+          _out, err, stat = execute_local_command(cmd)
+          unless stat.exitstatus.zero?
+            raise "Error writing to #{container_id}: #{err}"
+          end
+        rescue StandardError => e
+          raise Bolt::Node::FileError.new(e.message, 'WRITE_ERROR')
+        end
+
+        def download_file(source, destination, _download)
+          @logger.trace { "Downloading #{source} to #{destination}" }
+          FileUtils.mkdir_p(destination)
+          _out, err, stat = execute_local_command(%W[file pull --recursive #{container_id}#{source} #{destination}])
+          unless stat.exitstatus.zero?
+            raise "Error downloading content from container #{container_id}: #{err}"
+          end
+        rescue StandardError => e
+          raise Bolt::Node::FileError.new(e.message, 'WRITE_ERROR')
+        end
+      end
+    end
+  end
+end

data/lib/bolt/transport/orch.rb

@@ -59,6 +59,18 @@ module Bolt
           # the result otherwise make sure an error is generated
           if state == 'finished' || (result && result['_error'])
             if result['_error']
+              unless result['_error'].is_a?(Hash)
+                result['_error'] = { 'kind' => 'puppetlabs.tasks/task-error',
+                                     'issue_code' => 'TASK_ERROR',
+                                     'msg' => result['_error'],
+                                     'details' => {} }
+              end
+
+              result['_error']['details'] ||= {}
+              unless result['_error']['details'].is_a?(Hash)
+                deets = result['_error']['details']
+                result['_error']['details'] = { 'msg' => deets }
+              end
               file_line = %w[file line].zip(position).to_h.compact
               result['_error']['details'].merge!(file_line) unless result['_error']['details']['file']
             end
@@ -252,11 +264,7 @@ module Bolt
 
         # If we get here, there's no error so we don't need the file or line
         # number
-        Bolt::Result.for_command(target,
-                                 result.value['stdout'],
-                                 result.value['stderr'],
-                                 result.value['exit_code'],
-                                 action, obj, [])
+        Bolt::Result.for_command(target, result.value, action, obj, [])
       end
     end
   end

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

@@ -230,7 +230,7 @@ module Bolt
           end
           [in_wr, out_rd, err_rd, th]
         rescue Errno::EMFILE => e
-          msg = "#{e.message}. This may be resolved by increasing your user limit "\
+          msg = "#{e.message}. This might be resolved by increasing your user limit "\
             "with 'ulimit -n 1024'. See https://puppet.com/docs/bolt/latest/bolt_known_issues.html for details."
           raise Bolt::Error.new(msg, 'bolt/too-many-files')
         end

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

@@ -130,7 +130,7 @@ module Bolt
 
           [inp, out_rd, err_rd, th]
         rescue Errno::EMFILE => e
-          msg = "#{e.message}. This may be resolved by increasing your user limit "\
+          msg = "#{e.message}. This might be resolved by increasing your user limit "\
             "with 'ulimit -n 1024'. See https://puppet.com/docs/bolt/latest/bolt_known_issues.html for details."
           raise Bolt::Error.new(msg, 'bolt/too-many-files')
         rescue StandardError

data/lib/bolt/util.rb

@@ -77,6 +77,14 @@ module Bolt
         File.exist?(path) ? read_yaml_hash(path, file_name) : {}
       end
 
+      def first_runs_free
+        Bolt::Config.user_path + '.first_runs_free'
+      end
+
+      def first_run?
+        Bolt::Config.user_path && !File.exist?(first_runs_free)
+      end
+
       # Accepts a path with either 'plans' or 'tasks' in it and determines
       # the name of the module
       def module_name(path)
@@ -324,6 +332,29 @@ 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
+
+      # 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.0.0'
+  VERSION = '3.5.0'
 end

data/lib/bolt_server/transport_app.rb

@@ -133,7 +133,14 @@ module BoltServer
       task_data = body['task']
       task = Bolt::Task::PuppetServer.new(task_data['name'], task_data['metadata'], task_data['files'], @file_cache)
       parameters = body['parameters'] || {}
-      [@executor.run_task(target, task, parameters), nil]
+      task_result = @executor.run_task(target, task, parameters)
+      task_result.each do |result|
+        value = result.value
+        next unless value.is_a?(Hash)
+        next unless value.key?('_sensitive')
+        value['_sensitive'] = value['_sensitive'].unwrap
+      end
+      [task_result, nil]
     end
 
     def run_command(target, body)
@@ -275,15 +282,19 @@ module BoltServer
       Bolt::Config.from_project(project, { log: { 'bolt-debug.log' => 'disable' } })
     end
 
+    def pal_from_project_bolt_config(bolt_config)
+      modulepath_object = Bolt::Config::Modulepath.new(
+        bolt_config.modulepath,
+        boltlib_path: [PE_BOLTLIB_PATH, Bolt::Config::Modulepath::BOLTLIB_PATH],
+        builtin_content_path: @config['builtin-content-dir']
+      )
+      Bolt::PAL.new(modulepath_object, nil, nil, nil, nil, nil, bolt_config.project)
+    end
+
     def in_bolt_project(versioned_project)
       @pal_mutex.synchronize do
         bolt_config = config_from_project(versioned_project)
-        modulepath_object = Bolt::Config::Modulepath.new(
-          bolt_config.modulepath,
-          boltlib_path: [PE_BOLTLIB_PATH, Bolt::Config::Modulepath::BOLTLIB_PATH],
-          builtin_content_path: @config['builtin-content-dir']
-        )
-        pal = Bolt::PAL.new(modulepath_object, nil, nil, nil, nil, nil, bolt_config.project)
+        pal = pal_from_project_bolt_config(bolt_config)
         context = {
           pal: pal,
           config: bolt_config
@@ -351,8 +362,8 @@ module BoltServer
       }
     end
 
-    def allowed_helper(metadata, allowlist)
-      allowed = allowlist.nil? || allowlist.include?(metadata['name'])
+    def allowed_helper(pal, metadata, allowlist)
+      allowed = !pal.filter_content([metadata['name']], allowlist).empty?
       metadata.merge({ 'allowed' => allowed })
     end
 
@@ -366,21 +377,27 @@ module BoltServer
       plans.map { |plan_name| { 'name' => plan_name } }
     end
 
-    def file_metadatas(pal, module_name, file)
-      pal.in_bolt_compiler do
-        mod = Puppet.lookup(:current_environment).module(module_name)
-        raise ArgumentError, "`module_name`: #{module_name} does not exist" unless mod
-        abs_file_path = mod.file(file)
-        raise ArgumentError, "`file`: #{file} does not exist inside the module's 'files' directory" unless abs_file_path
-        fileset = Puppet::FileServing::Fileset.new(abs_file_path, 'recurse' => 'yes')
-        Puppet::FileServing::Fileset.merge(fileset).collect do |relative_file_path, base_path|
-          metadata = Puppet::FileServing::Metadata.new(base_path, relative_path: relative_file_path)
-          metadata.checksum_type = 'sha256'
-          metadata.links = 'follow'
-          metadata.collect
-          metadata.to_data_hash
+    def file_metadatas(versioned_project, module_name, file)
+      abs_file_path = @pal_mutex.synchronize do
+        bolt_config = config_from_project(versioned_project)
+        pal = pal_from_project_bolt_config(bolt_config)
+        pal.in_bolt_compiler do
+          mod = Puppet.lookup(:current_environment).module(module_name)
+          raise ArgumentError, "`module_name`: #{module_name} does not exist" unless mod
+          mod.file(file)
         end
       end
+
+      raise ArgumentError, "`file`: #{file} does not exist inside the module's 'files' directory" unless abs_file_path
+
+      fileset = Puppet::FileServing::Fileset.new(abs_file_path, 'recurse' => 'yes')
+      Puppet::FileServing::Fileset.merge(fileset).collect do |relative_file_path, base_path|
+        metadata = Puppet::FileServing::Metadata.new(base_path, relative_path: relative_file_path)
+        metadata.checksum_type = 'sha256'
+        metadata.links = 'follow'
+        metadata.collect
+        metadata.to_data_hash
+      end
     end
 
     get '/' do
@@ -520,7 +537,7 @@ module BoltServer
       return MISSING_VERSIONED_PROJECT_RESPONSE if params['versioned_project'].nil?
       in_bolt_project(params['versioned_project']) do |context|
         plan_info = pe_plan_info(context[:pal], params[:module_name], params[:plan_name])
-        plan_info = allowed_helper(plan_info, context[:config].project.plans)
+        plan_info = allowed_helper(context[:pal], plan_info, context[:config].project.plans)
         [200, plan_info.to_json]
       end
     rescue Bolt::Error => e
@@ -550,7 +567,7 @@ module BoltServer
           'versioned_project' => params['versioned_project']
         }
         task_info = pe_task_info(context[:pal], params[:module_name], params[:task_name], ps_parameters)
-        task_info = allowed_helper(task_info, context[:config].project.tasks)
+        task_info = allowed_helper(context[:pal], task_info, context[:config].project.tasks)
         [200, task_info.to_json]
       end
     rescue Bolt::Error => e
@@ -590,7 +607,7 @@ module BoltServer
         plans_response = plan_list(context[:pal])
 
         # Dig in context for the allowlist of plans from project object
-        plans_response.map! { |metadata| allowed_helper(metadata, context[:config].project.plans) }
+        plans_response.map! { |metadata| allowed_helper(context[:pal], metadata, context[:config].project.plans) }
 
         # We structure this array of plans to be an array of hashes so that it matches the structure
         # returned by the puppetserver API that serves data like this. Structuring the output this way
@@ -626,7 +643,7 @@ module BoltServer
         tasks_response = task_list(context[:pal])
 
         # Dig in context for the allowlist of tasks from project object
-        tasks_response.map! { |metadata| allowed_helper(metadata, context[:config].project.tasks) }
+        tasks_response.map! { |metadata| allowed_helper(context[:pal], metadata, context[:config].project.tasks) }
 
         # We structure this array of tasks to be an array of hashes so that it matches the structure
         # returned by the puppetserver API that serves data like this. Structuring the output this way
@@ -642,12 +659,11 @@ module BoltServer
     #
     # @param versioned_project [String] the versioned_project to fetch the file metadatas from
     get '/project_file_metadatas/:module_name/*' do
-      return MISSING_VERSIONED_PROJECT_RESPONSE if params['versioned_project'].nil?
-      in_bolt_project(params['versioned_project']) do |context|
-        file = params[:splat].first
-        metadatas = file_metadatas(context[:pal], params[:module_name], file)
-        [200, metadatas.to_json]
-      end
+      versioned_project = params['versioned_project']
+      return MISSING_VERSIONED_PROJECT_RESPONSE if versioned_project.nil?
+      file = params[:splat].first
+      metadatas = file_metadatas(versioned_project, params[:module_name], file)
+      [200, metadatas.to_json]
     rescue Bolt::Error => e
       [400, e.to_json]
     rescue ArgumentError => e
@@ -674,11 +690,23 @@ module BoltServer
         Bolt::Util.validate_file('inventory file', context[:config].project.inventory_file)
 
         begin
+          # Set the default puppet_library plugin hook if it has not already been
+          # set
+          context[:config].data['plugin-hooks']['puppet_library'] ||= {
+            'plugin'     => 'task',
+            'task'       => 'puppet_agent::install',
+            'parameters' => {
+              'stop_service' => true
+            }
+          }
+
           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)
           inventory = Bolt::Inventory.from_config(context[:config], plugins)
-          target_list = inventory.get_targets('all').map { |targ| targ.to_h.merge({ 'transport' => targ.transport }) }
+          target_list = inventory.get_targets('all').map do |targ|
+            targ.to_h.merge({ 'transport' => targ.transport, 'plugin_hooks' => targ.plugin_hooks })
+          end
         rescue Bolt::Plugin::PluginError::LoadingDisabled => e
           msg = "Cannot load plugin #{e.details['plugin_name']}: plugin not supported"
           raise BoltServer::Plugin::PluginNotSupported.new(msg, e.details['plugin_name'])

data/lib/bolt_spec/bolt_context.rb

@@ -130,11 +130,16 @@ module BoltSpec
       @executor ||= BoltSpec::Plans::MockExecutor.new(modulepath)
     end
 
-    # Override in your tests
+    # Overrides inventory for tests.
     def inventory_data
       {}
     end
 
+    # Overrides configuration for tests.
+    def config_data
+      {}
+    end
+
     def inventory
       @inventory ||= Bolt::Inventory.create_version(inventory_data, config.transport, config.transports, plugins)
     end
@@ -142,7 +147,7 @@ module BoltSpec
     # Override in your tests
     def config
       @config ||= begin
-        conf = Bolt::Config.default
+        conf = Bolt::Config.new(Bolt::Project.default_project, config_data)
         conf.modulepath = [modulepath].flatten
         conf
       end
@@ -161,7 +166,7 @@ module BoltSpec
     BoltSpec::Plans::MOCKED_ACTIONS.each do |action|
       # Allowed action stubs can be called up to be_called_times number of times
       define_method :"allow_#{action}" do |object|
-        executor.send(:"stub_#{action}", object).add_stub
+        executor.send(:"stub_#{action}", object).add_stub(inventory)
       end
 
       # Expected action stubs must be called exactly the expected number of times
@@ -172,7 +177,7 @@ module BoltSpec
 
       # This stub will catch any action call if there are no stubs specifically for that task
       define_method :"allow_any_#{action}" do
-        executor.send(:"stub_#{action}", :default).add_stub
+        executor.send(:"stub_#{action}", :default).add_stub(inventory)
       end
     end
 

data/lib/bolt_spec/plans.rb

@@ -5,119 +5,11 @@ require 'bolt_spec/plans/mock_executor'
 require 'bolt/pal'
 
 # These helpers are intended to be used for plan unit testing without calling
-# out to target nodes. It uses the BoltContext helper to set up a mock executor
+# out to targets. It uses the BoltContext helper to set up a mock executor
 # which allows calls to run_* functions to be stubbed for testing. The context
 # helper also loads Bolt datatypes and plan functions to be used by the code
 # being tested.
 #
-# Stub matching
-#
-# Stubs match invocations of run_* functions by default matching any call but
-# with_targets and with_params helpers can further restrict the stub to match
-# more exact invocations. It's possible a call to run_* could match multiple
-# stubs. In this case the mock executor will first check for stubs specifically
-# matching the task being run after which it will use the last stub that
-# matched
-#
-#
-# allow vs expect
-#
-# Stubs have two general modes bases on whether the test is making assertions
-# on whether function was called. Allow stubs allow the run_* invocation  to
-# be called any number of times while expect stubs will fail if no run_*
-# invocation matches them. The be_called_times(n) stub method can be used to
-# ensure an allow stub is not called more than n times or that an expect stub
-# is called exactly n times.
-#
-# Configuration
-#
-#  To configure Puppet and Bolt at the beginning of tests, add the following
-#  line to your spec_helper.rb:
-#
-#  BoltSpec::Plans.init
-#
-#  By default the plan helpers use the modulepath set up for rspec-puppet and
-#  an otherwise empty bolt config and inventory. To create your own values for
-#  these override the modulepath, config, or inventory methods.
-#
-# Sub-plan Execution
-#
-#  When testing a plan, often times those plans call other plans in order to
-#  build complex workflows. To support this we offer running in two different
-#  modes:
-#    execute_any_plan (default) - This mode will execute any plan that is encountered
-#      without having to be stubbed/mocked. This default mode allows for plan control
-#      flow to behave as normal. If you choose to stub/mock out a sub-plan in this mode
-#      that will be honored and the sub-plan will not be executed. We will use the modifiers
-#      on the stub to check for the conditions specified (example: be_called_times(3))
-#
-#    execute_no_plan - This mode will not execute a plans that it encounters. Instead, when
-#      a plan is encountered it will throw an error unless the plan is mocked out. This
-#      mode is useful for ensuring that there are no plans called that you do not expect.
-#      This plan requires authors to mock out all sub-plans that may be invoked when running
-#      tests.
-#
-#  TODO:
-#  - Allow description based stub matching
-#  - Better testing of plan errors
-#  - Better error collection around call counts. Show what stubs exists and more than a single failure
-#  - Allow stubbing with a block(at the double level? As a matched stub?)
-#  - package code so that it can be used for testing modules outside of this repo
-#  - set subject from describe and provide matchers similar to rspec puppets function tests
-#  - Allow specific plans to be executed when running in execute_no_plan mode.
-#
-#  MAYBE TODO?:
-#  - validate call expectations at the end of the example instead of in run_plan
-#  - resultset matchers to help testing canary like plans?
-#  - inventory matchers to help testing plans that change inventory
-#
-# Flags:
-# - execute_any_plan: execute any plan that is encountered unless it is mocked (default)
-# - execute_no_plan: throw an error if a plan is encountered that is not stubbed
-#
-# Stubs:
-# - allow_command(cmd), expect_command(cmd): expect the exact command
-# - allow_plan(plan), expect_plan(plan): expect the named plan
-# - allow_script(script), expect_script(script): expect the script as <module>/path/to/file
-# - allow_task(task), expect_task(task): expect the named task
-# - allow_download(file), expect_download(file): expect the identified source file
-# - allow_upload(file), expect_upload(file): expect the identified source file
-# - allow_apply_prep: allows `apply_prep` to be invoked in the plan but does not allow modifiers
-# - allow_apply: allows `apply` to be invoked in the plan but does not allow modifiers
-# - allow_out_message, expect_out_message: expect a message to be passed to out::message (only modifiers are
-#   be_called_times(n), with_params(params), and not_be_called)
-#
-# Stub modifiers:
-# - be_called_times(n): if allowed, fail if the action is called more than 'n' times
-#                       if expected, fail unless the action is called 'n' times
-# - not_be_called: fail if the action is called
-# - with_targets(targets): target or list of targets that you expect to be passed to the action
-#                          plan: does not support this modifier
-# - with_params(params): list of params and metaparams (or options) that you expect to be passed to the action.
-#                        Corresponds to the action's last argument.
-# - with_destination(dest): for upload_file and download_file, the expected destination path
-# - always_return(value): return a Bolt::ResultSet of Bolt::Result objects with the specified value Hash
-#                         plan: returns a Bolt::PlanResult with the specified value with a status of 'success'
-#                         command and script: only accept 'stdout' and 'stderr' keys
-#                         upload: does not support this modifier
-#                         download: does not support this modifier
-# - return_for_targets(targets_to_values): return a Bolt::ResultSet of Bolt::Result objects from the Hash mapping
-#                                          targets to their value Hashes
-#                                          command and script: only accept 'stdout' and 'stderr' keys
-#                                          upload: does not support this modifier
-#                                          download: does not support this modifier
-#                                          plan: does not support this modifier
-# - return(&block): invoke the block to construct a Bolt::ResultSet. The blocks parameters differ based on action
-#                   command: `{ |targets:, command:, params:| ... }`
-#                   plan: `{ |plan:, params:| ... }`
-#                   script: `{ |targets:, script:, params:| ... }`
-#                   task: `{ |targets:, task:, params:| ... }`
-#                   upload: `{ |targets:, source:, destination:, params:| ... }`
-#                   download: `{ |targets:, source:, destination:, params:| ... }`
-# - error_with(err): return a failing Bolt::ResultSet, with Bolt::Result objects with the identified err hash
-#                    plans will throw a Bolt::PlanFailure that will be returned as the value of
-#                    the Bolt::PlanResult object with a status of 'failure'.
-#
 # Example:
 #   describe "my_plan" do
 #     it 'should return' do