bolt 2.32.0 → 2.36.0

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

@@ -17,13 +17,20 @@ module Bolt
         end
 
         def initialize(opts, plan_context, logger)
+          require 'addressable/uri'
+
           @logger = logger
           @key = self.class.get_key(opts)
-          client_keys = %w[service-url token-file cacert job-poll-interval job-poll-timeout]
-          client_opts = client_keys.each_with_object({}) do |k, acc|
-            acc[k] = opts[k] if opts.include?(k)
+          client_opts = opts.slice('token-file', 'cacert', 'job-poll-interval', 'job-poll-timeout')
+
+          if opts['service-url']
+            uri = Addressable::URI.parse(opts['service-url'])
+            uri&.port ||= 8143
+            client_opts['service-url'] = uri.to_s
           end
+
           client_opts['User-Agent'] = "Bolt/#{VERSION}"
+
           %w[token-file cacert].each do |f|
             client_opts[f] = File.expand_path(client_opts[f]) if client_opts[f]
           end

data/lib/bolt/transport/remote.rb

@@ -26,14 +26,14 @@ module Bolt
       end
 
       # Cannot batch because arugments differ
-      def run_task(target, task, arguments, options = {})
+      def run_task(target, task, arguments, options = {}, position = [])
         proxy_target = get_proxy(target)
         transport = @executor.transport(proxy_target.transport)
-        arguments = arguments.merge('_target' => target.to_h.reject { |_, v| v.nil? })
+        arguments = arguments.merge('_target' => target.to_h.compact)
 
         remote_task = task.remote_instance
 
-        result = transport.run_task(proxy_target, remote_task, arguments, options)
+        result = transport.run_task(proxy_target, remote_task, arguments, options, position)
         Bolt::Result.new(target, value: result.value, action: 'task', object: task.name)
       end
     end

data/lib/bolt/transport/simple.rb

@@ -20,9 +20,9 @@ module Bolt
         false
       end
 
-      def run_command(target, command, options = {})
+      def run_command(target, command, options = {}, position = [])
         with_connection(target) do |conn|
-          conn.shell.run_command(command, options)
+          conn.shell.run_command(command, options, position)
         end
       end
 
@@ -38,15 +38,15 @@ module Bolt
         end
       end
 
-      def run_script(target, script, arguments, options = {})
+      def run_script(target, script, arguments, options = {}, position = [])
         with_connection(target) do |conn|
-          conn.shell.run_script(script, arguments, options)
+          conn.shell.run_script(script, arguments, options, position)
         end
       end
 
-      def run_task(target, task, arguments, options = {})
+      def run_task(target, task, arguments, options = {}, position = [])
         with_connection(target) do |conn|
-          conn.shell.run_task(task, arguments, options)
+          conn.shell.run_task(task, arguments, options, position)
         end
       end
     end

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

@@ -12,8 +12,12 @@ module Bolt
           raise Bolt::ValidationError, "Target #{target.safe_name} does not have a host" unless target.host
 
           @target = target
-          ssh_config = Net::SSH::Config.for(target.host)
-          @user = @target.user || ssh_config[:user] || Etc.getlogin
+          begin
+            ssh_config = Net::SSH::Config.for(target.host)
+            @user = @target.user || ssh_config[:user] || Etc.getlogin
+          rescue StandardError
+            @user = @target.user || Etc.getlogin
+          end
           @logger = Bolt::Logger.logger(self)
         end
 

data/lib/bolt/util.rb

@@ -29,19 +29,26 @@ module Bolt
         path = File.expand_path(path)
         content = File.open(path, "r:UTF-8") { |f| YAML.safe_load(f.read) } || {}
         unless content.is_a?(Hash)
-          msg = "Invalid content for #{file_name} file: #{path} should be a Hash or empty, not #{content.class}"
-          raise Bolt::FileError.new(msg, path)
+          raise Bolt::FileError.new(
+            "Invalid content for #{file_name} file at #{path}\nContent should be a Hash or empty, "\
+            "not #{content.class}",
+            path
+          )
         end
         logger.trace("Loaded #{file_name} from #{path}")
         content
       rescue Errno::ENOENT
-        raise Bolt::FileError.new("Could not read #{file_name} file: #{path}", path)
+        raise Bolt::FileError.new("Could not read #{file_name} file at #{path}", path)
+      rescue Psych::SyntaxError => e
+        raise Bolt::FileError.new("Could not parse #{file_name} file at #{path}, line #{e.line}, "\
+                                  "column #{e.column}\n#{e.problem}",
+                                  path)
       rescue Psych::Exception => e
-        raise Bolt::FileError.new("Could not parse #{file_name} file: #{path}\n"\
-                                  "Error at line #{e.line} column #{e.column}", path)
+        raise Bolt::FileError.new("Could not parse #{file_name} file at #{path}\n#{e.message}",
+                                  path)
       rescue IOError, SystemCallError => e
-        raise Bolt::FileError.new("Could not read #{file_name} file: #{path}\n"\
-                                  "error: #{e}", path)
+        raise Bolt::FileError.new("Could not read #{file_name} file at #{path}\n#{e.message}",
+                                  path)
       end
 
       def read_optional_yaml_hash(path, file_name)
@@ -273,6 +280,11 @@ module Bolt
         !!File::ALT_SEPARATOR
       end
 
+      # Returns true if running in PowerShell.
+      def powershell?
+        !!ENV['PSModulePath']
+      end
+
       # Accept hash and return hash with top level keys of type "String" converted to symbols.
       def symbolize_top_level_keys(hsh)
         hsh.each_with_object({}) { |(k, v), h| k.is_a?(String) ? h[k.to_sym] = v : h[k] = v }

data/lib/bolt/version.rb

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

data/lib/bolt/yarn.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+require 'fiber'
+
+module Bolt
+  class Yarn
+    attr_reader :fiber, :value, :index
+
+    def initialize(fiber, index)
+      @fiber = fiber
+      @index = index
+      @value = nil
+    end
+
+    def alive?
+      fiber.alive?
+    end
+
+    def resume
+      @value = fiber.resume
+    end
+  end
+end

data/lib/bolt_server/base_config.rb

@@ -7,7 +7,9 @@ module BoltServer
   class BaseConfig
     def config_keys
       %w[host port ssl-cert ssl-key ssl-ca-cert
-         ssl-cipher-suites loglevel logfile allowlist projects-dir]
+         ssl-cipher-suites loglevel logfile allowlist
+         projects-dir environments-codedir
+         environmentpath basemodulepath]
     end
 
     def env_keys

data/lib/bolt_server/config.rb

@@ -7,7 +7,9 @@ require 'bolt/error'
 module BoltServer
   class Config < BoltServer::BaseConfig
     def config_keys
-      super + %w[concurrency cache-dir file-server-conn-timeout file-server-uri projects-dir]
+      super + %w[concurrency cache-dir file-server-conn-timeout
+                 file-server-uri projects-dir environments-codedir
+                 environmentpath basemodulepath]
     end
 
     def env_keys

data/lib/bolt_server/file_cache.rb

@@ -63,6 +63,7 @@ module BoltServer
     end
 
     def client
+      # rubocop:disable Naming/VariableNumber
       @client ||= begin
         uri = URI(@config['file-server-uri'])
         https = Net::HTTP.new(uri.host, uri.port)
@@ -75,6 +76,7 @@ module BoltServer
         https.open_timeout = @config['file-server-conn-timeout']
         https
       end
+      # rubocop:enable Naming/VariableNumber
     end
 
     def request_file(path, params, file)

data/lib/bolt_server/schemas/partials/task.json

@@ -64,7 +64,7 @@
                     "description": "Environment the task is in",
                     "type": "string"
                   },
-                  "project": {
+                  "versioned_project": {
                     "description": "Project the task is in",
                     "type": "string"
                   }
@@ -77,7 +77,7 @@
                   },
                   {
                     "required": [
-                      "project"
+                      "versioned_project"
                     ]
                   }
                 ],              

data/lib/bolt_server/transport_app.rb

@@ -48,6 +48,10 @@ module BoltServer
     # See the `orchestrator.bolt.codedir` tk config setting.
     DEFAULT_BOLT_CODEDIR = '/opt/puppetlabs/server/data/orchestration-services/code'
 
+    MISSING_PROJECT_REF_RESPONSE = [
+      400, Bolt::ValidationError.new('`project_ref` is a required argument').to_json
+    ].freeze
+
     def initialize(config)
       @config = config
       @schemas = Hash[REQUEST_SCHEMAS.map do |basename|
@@ -231,9 +235,9 @@ module BoltServer
     #
     # WARNING: THIS FUNCTION SHOULD ONLY BE CALLED INSIDE A SYNCHRONIZED PAL MUTEX
     def modulepath_from_environment(environment_name)
-      codedir = DEFAULT_BOLT_CODEDIR
-      environmentpath = "#{codedir}/environments"
-      basemodulepath = "#{codedir}/modules:/opt/puppetlabs/puppet/modules"
+      codedir = @config['environments-codedir'] || DEFAULT_BOLT_CODEDIR
+      environmentpath = @config['environmentpath'] || "#{codedir}/environments"
+      basemodulepath = @config['basemodulepath'] || "#{codedir}/modules:/opt/puppetlabs/puppet/modules"
       modulepath_dirs = nil
       with_pe_pal_init_settings(codedir, environmentpath, basemodulepath) do
         environment = Puppet.lookup(:environments).get!(environment_name)
@@ -261,13 +265,16 @@ module BoltServer
       end
     end
 
-    def in_bolt_project(bolt_project)
-      return [400, '`project_ref` is a required argument'] if bolt_project.nil?
-      project_dir = File.join(@config['projects-dir'], bolt_project)
-      return [400, "`project_ref`: #{project_dir} does not exist"] unless Dir.exist?(project_dir)
+    def config_from_project(project_ref)
+      project_dir = File.join(@config['projects-dir'], project_ref)
+      raise Bolt::ValidationError, "`project_ref`: #{project_dir} does not exist" unless Dir.exist?(project_dir)
+      project = Bolt::Project.create_project(project_dir)
+      Bolt::Config.from_project(project, { log: { 'bolt-debug.log' => 'disable' } })
+    end
+
+    def in_bolt_project(project_ref)
       @pal_mutex.synchronize do
-        project = Bolt::Project.create_project(project_dir)
-        bolt_config = Bolt::Config.from_project(project, { log: { 'bolt-debug.log' => 'disable' } })
+        bolt_config = config_from_project(project_ref)
         modulepath_object = Bolt::Config::Modulepath.new(
           bolt_config.modulepath,
           boltlib_path: [PE_BOLTLIB_PATH, Bolt::Config::Modulepath::BOLTLIB_PATH]
@@ -508,6 +515,7 @@ module BoltServer
     #
     # @param project_ref [String] the project to fetch the plan from
     get '/project_plans/:module_name/:plan_name' do
+      return MISSING_PROJECT_REF_RESPONSE if params['project_ref'].nil?
       in_bolt_project(params['project_ref']) 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)
@@ -532,9 +540,10 @@ module BoltServer
     #
     # @param bolt_project_ref [String] the reference to the bolt-project directory to load task metadata from
     get '/project_tasks/:module_name/:task_name' do
+      return MISSING_PROJECT_REF_RESPONSE if params['project_ref'].nil?
       in_bolt_project(params['project_ref']) do |context|
         ps_parameters = {
-          'project' => params['project_ref']
+          'versioned_project' => params['project_ref']
         }
         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)
@@ -570,6 +579,7 @@ module BoltServer
     #
     # @param project_ref [String] the project to fetch the list of plans from
     get '/project_plans' do
+      return MISSING_PROJECT_REF_RESPONSE if params['project_ref'].nil?
       in_bolt_project(params['project_ref']) do |context|
         plans_response = plan_list(context[:pal])
 
@@ -603,6 +613,7 @@ module BoltServer
     #
     # @param project_ref [String] the project to fetch the list of tasks from
     get '/project_tasks' do
+      return MISSING_PROJECT_REF_RESPONSE if params['project_ref'].nil?
       in_bolt_project(params['project_ref']) do |context|
         tasks_response = task_list(context[:pal])
 
@@ -621,6 +632,7 @@ module BoltServer
     #
     # @param project_ref [String] the project_ref to fetch the file metadatas from
     get '/project_file_metadatas/:module_name/*' do
+      return MISSING_PROJECT_REF_RESPONSE if params['project_ref'].nil?
       in_bolt_project(params['project_ref']) do |context|
         file = params[:splat].first
         metadatas = file_metadatas(context[:pal], params[:module_name], file)
@@ -630,13 +642,32 @@ module BoltServer
       [400, e.message]
     end
 
+    # Returns a list of targets parsed from a Project inventory
+    #
+    # @param project_ref [String] the project_ref to compute the inventory from
+    post '/project_inventory_targets' do
+      return MISSING_PROJECT_REF_RESPONSE if params['project_ref'].nil?
+      bolt_config = config_from_project(params['project_ref'])
+      if bolt_config.inventoryfile && bolt_config.project.inventory_file.to_s != bolt_config.inventoryfile
+        raise Bolt::ValidationError, "Project inventory must be defined in the " \
+          "inventory.yaml file at the root of the project directory"
+      end
+      plugins = Bolt::Plugin.setup(bolt_config, nil)
+      inventory = Bolt::Inventory.from_config(bolt_config, plugins)
+      target_list = inventory.get_targets('all').map { |targ| targ.to_h.merge({ 'transport' => targ.transport }) }
+
+      [200, target_list.to_json]
+    rescue Bolt::Error => e
+      [500, e.to_json]
+    end
+
     error 404 do
       err = Bolt::Error.new("Could not find route #{request.path}",
                             'boltserver/not-found')
       [404, err.to_json]
     end
 
-    error 500 do
+    error StandardError do
       e = env['sinatra.error']
       err = Bolt::Error.new("500: Unknown error: #{e.message}",
                             'boltserver/server-error')

data/lib/bolt_spec/plans/action_stubs/command_stub.rb

@@ -29,7 +29,7 @@ module BoltSpec
       end
 
       def result_for(target, stdout: '', stderr: '')
-        Bolt::Result.for_command(target, stdout, stderr, 0, 'command', '')
+        Bolt::Result.for_command(target, stdout, stderr, 0, 'command', '', [])
       end
 
       # Public methods

data/lib/bolt_spec/plans/action_stubs/script_stub.rb

@@ -35,7 +35,7 @@ module BoltSpec
       end
 
       def result_for(target, stdout: '', stderr: '')
-        Bolt::Result.for_command(target, stdout, stderr, 0, 'script', '')
+        Bolt::Result.for_command(target, stdout, stderr, 0, 'script', '', [])
       end
 
       # Public methods

data/lib/bolt_spec/plans/mock_executor.rb

@@ -17,12 +17,13 @@ module BoltSpec
 
     # Nothing on the executor is 'public'
     class MockExecutor
-      attr_reader :noop, :error_message
+      attr_reader :noop, :error_message, :in_parallel
       attr_accessor :run_as, :transport_features, :execute_any_plan
 
       def initialize(modulepath)
         @noop = false
         @run_as = nil
+        @in_parallel = false
         @error_message = nil
         @allow_apply = false
         @modulepath = [modulepath].flatten.map { |path| File.absolute_path(path) }
@@ -48,7 +49,7 @@ module BoltSpec
         ([segments[0]] + segments[2..-1]).join('/')
       end
 
-      def run_command(targets, command, options = {})
+      def run_command(targets, command, options = {}, _position = [])
         result = nil
         if (doub = @command_doubles[command] || @command_doubles[:default])
           result = doub.process(targets, command, options)
@@ -61,7 +62,7 @@ module BoltSpec
         result
       end
 
-      def run_script(targets, script_path, arguments, options = {})
+      def run_script(targets, script_path, arguments, options = {}, _position = [])
         script = module_file_id(script_path)
         result = nil
         if (doub = @script_doubles[script] || @script_doubles[:default])
@@ -76,7 +77,7 @@ module BoltSpec
         result
       end
 
-      def run_task(targets, task, arguments, options = {})
+      def run_task(targets, task, arguments, options = {}, _position = [])
         result = nil
         if (doub = @task_doubles[task.name] || @task_doubles[:default])
           result = doub.process(targets, task.name, arguments, options)
@@ -90,7 +91,7 @@ module BoltSpec
         result
       end
 
-      def download_file(targets, source, destination, options = {})
+      def download_file(targets, source, destination, options = {}, _position = [])
         result = nil
         if (doub = @download_doubles[source] || @download_doubles[:default])
           result = doub.process(targets, source, destination, options)
@@ -103,7 +104,7 @@ module BoltSpec
         result
       end
 
-      def upload_file(targets, source_path, destination, options = {})
+      def upload_file(targets, source_path, destination, options = {}, _position = [])
         source = module_file_id(source_path)
         result = nil
         if (doub = @upload_doubles[source] || @upload_doubles[:default])
@@ -133,6 +134,7 @@ module BoltSpec
         # through to another conditional statement
         doub = @plan_doubles[plan_name] || @plan_doubles[:default]
 
+        # rubocop:disable Lint/DuplicateBranch
         # High level:
         #  - If we've explicitly allowed execution of the plan (normally the main plan
         #    passed into BoltSpec::Plan::run_plan()), then execute it
@@ -165,6 +167,7 @@ module BoltSpec
           @error_message = "Unexpected call to 'run_plan(#{plan_name}, #{params_str})'"
           raise UnexpectedInvocation, @error_message
         end
+        # rubocop:enable Lint/DuplicateBranch
         result
       end
 

data/libexec/apply_catalog.rb

@@ -74,7 +74,7 @@ begin
     Puppet::ResourceApi::Transport.inject_device(type, transport)
 
     Puppet[:facts_terminus] = :network_device
-    Puppet[:certname] = conn_info['uri']
+    Puppet[:certname] = conn_info['name']
   end
 
   # Ensure custom facts are available for provider suitability tests