bolt 2.19.0 → 2.24.0

data/lib/bolt/pal/yaml_plan/evaluator.rb

@@ -73,7 +73,7 @@ module Bolt
         end
 
         def upload_step(scope, step)
-          source = step['source']
+          source = step['upload'] || step['source']
           destination = step['destination']
           targets = step['targets'] || step['target']
           description = step['description']
@@ -83,6 +83,17 @@ module Bolt
           scope.call_function('upload_file', args)
         end
 
+        def download_step(scope, step)
+          source = step['download']
+          destination = step['destination']
+          targets = step['targets'] || step['target']
+          description = step['description']
+
+          args = [source, destination, targets]
+          args << description if description
+          scope.call_function('download_file', args)
+        end
+
         def eval_step(_scope, step)
           step['eval']
         end
@@ -97,6 +108,10 @@ module Bolt
           apply_manifest(scope, targets, manifest)
         end
 
+        def message_step(scope, step)
+          scope.call_function('out::message', [step['message']])
+        end
+
         def generate_manifest(resources)
           # inspect returns the Ruby representation of the resource hashes,
           # which happens to be the same as the Puppet representation
@@ -145,6 +160,12 @@ module Bolt
             Bolt::Logger.deprecation_warning("Using 'target' parameter for YAML plan steps, not 'targets'", msg)
           end
 
+          if plan.steps.any? { |step| step.body.key?('source') }
+            msg = "The 'source' parameter for YAML plan upload steps is deprecated and will be removed "\
+                  "in a future version of Bolt. Use the 'upload' parameter instead."
+            Bolt::Logger.deprecation_warning("Using 'source' parameter for YAML upload steps, not 'upload'", msg)
+          end
+
           plan_result = closure_scope.with_local_scope(args_hash) do |scope|
             plan.steps.each do |step|
               step_result = dispatch_step(scope, step)

data/lib/bolt/pal/yaml_plan/step.rb

@@ -12,7 +12,19 @@ module Bolt
           Set['name', 'description', 'target', 'targets']
         end
 
-        STEP_KEYS = %w[command script task plan source destination eval resources].freeze
+        STEP_KEYS = %w[
+          command
+          destination
+          download
+          eval
+          message
+          plan
+          resources
+          script
+          source
+          task
+          upload
+        ].freeze
 
         def self.create(step_body, step_number)
           type_keys = (STEP_KEYS & step_body.keys)
@@ -22,8 +34,10 @@ module Bolt
           when 1
             type = type_keys.first
           else
-            if type_keys.to_set == Set['source', 'destination']
+            if [Set['source', 'destination'], Set['upload', 'destination']].include?(type_keys.to_set)
               type = 'upload'
+            elsif type_keys.to_set == Set['download', 'destination']
+              type = 'download'
             else
               raise step_error("Multiple action keys detected: #{type_keys.inspect}", step_body['name'], step_number)
             end
@@ -89,6 +103,12 @@ module Bolt
             missing_keys -= ['targets']
           end
 
+          # Handle cases where upload step uses deprecated 'source' key instead of 'upload'
+          # TODO: Remove when 'source' is removed
+          if body.include?('source')
+            missing_keys -= ['upload']
+          end
+
           if missing_keys.any?
             error_message = "The #{step_type.inspect} step requires: #{missing_keys.to_a.inspect} key(s)"
             err = step_error(error_message, body['name'], step_number)
@@ -156,3 +176,5 @@ require 'bolt/pal/yaml_plan/step/resources'
 require 'bolt/pal/yaml_plan/step/script'
 require 'bolt/pal/yaml_plan/step/task'
 require 'bolt/pal/yaml_plan/step/upload'
+require 'bolt/pal/yaml_plan/step/download'
+require 'bolt/pal/yaml_plan/step/message'

data/lib/bolt/pal/yaml_plan/step/download.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+module Bolt
+  class PAL
+    class YamlPlan
+      class Step
+        class Download < Step
+          def self.allowed_keys
+            super + Set['download', 'destination']
+          end
+
+          def self.required_keys
+            Set['download', 'destination', 'targets']
+          end
+
+          def initialize(step_body)
+            super
+            @source = step_body['download']
+            @destination = step_body['destination']
+          end
+
+          def transpile
+            code = String.new("  ")
+            code << "$#{@name} = " if @name
+
+            fn = 'download_file'
+            args = [@source, @destination, @targets]
+            args << @description if @description
+
+            code << function_call(fn, args)
+
+            code << "\n"
+          end
+        end
+      end
+    end
+  end
+end

data/lib/bolt/pal/yaml_plan/step/message.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module Bolt
+  class PAL
+    class YamlPlan
+      class Step
+        class Message < Step
+          def self.allowed_keys
+            super + Set['message']
+          end
+
+          def self.required_keys
+            Set['message']
+          end
+
+          def initialize(step_body)
+            super
+            @message = step_body['message']
+          end
+
+          def transpile
+            code = String.new("  ")
+            code << function_call('out::message', [@message])
+            code << "\n"
+          end
+        end
+      end
+    end
+  end
+end

data/lib/bolt/pal/yaml_plan/step/upload.rb

@@ -6,16 +6,16 @@ module Bolt
       class Step
         class Upload < Step
           def self.allowed_keys
-            super + Set['source', 'destination']
+            super + Set['source', 'destination', 'upload']
           end
 
           def self.required_keys
-            Set['destination', 'source', 'targets']
+            Set['upload', 'destination', 'targets']
           end
 
           def initialize(step_body)
             super
-            @source = step_body['source']
+            @source = step_body['upload'] || step_body['source']
             @destination = step_body['destination']
           end
 

data/lib/bolt/pal/yaml_plan/transpiler.rb

@@ -21,10 +21,18 @@ module Bolt
           validate_path
 
           plan_object = parse_plan
+          param_descriptions = plan_object.parameters.map do |param|
+            str = String.new("# @param #{param.name}")
+            str << " #{param.description}" if param.description
+            str
+          end.join("\n")
 
-          plan_string = String.new("# WARNING: This is an autogenerated plan. " \
-                                   "It may not behave as expected.\n" \
-                                   "plan #{plan_object.name}(")
+          plan_string = String.new('')
+          plan_string << "# #{plan_object.description}\n" if plan_object.description
+          plan_string << "# WARNING: This is an autogenerated plan. It may not behave as expected.\n"
+          plan_string << "#{param_descriptions}\n" unless param_descriptions.empty?
+
+          plan_string << "plan #{plan_object.name}("
           # Parameters are Bolt::PAL::YamlPlan::Parameter
           plan_object.parameters&.each_with_index do |param, i|
             plan_string << param.transpile

data/lib/bolt/plugin/prompt.rb

@@ -18,9 +18,9 @@ module Bolt
       end
 
       def resolve_reference(opts)
-        STDERR.print("#{opts['message']}: ")
-        value = STDIN.noecho(&:gets).to_s.chomp
-        STDERR.puts
+        $stderr.print("#{opts['message']}: ")
+        value = $stdin.noecho(&:gets).to_s.chomp
+        $stderr.puts
 
         value
       end

data/lib/bolt/plugin/puppetdb.rb

@@ -85,7 +85,8 @@ module Bolt
 
       def resolve_facts(config, certname, target_data)
         Bolt::Util.walk_vals(config) do |value|
-          if value.is_a?(String)
+          case value
+          when String
             if value == 'certname'
               certname
             else
@@ -94,7 +95,7 @@ module Bolt
               # If there's no fact data this will be nil
               data&.fetch('value', nil)
             end
-          elsif value.is_a?(Array) || value.is_a?(Hash)
+          when Array, Hash
             value
           else
             raise FactLookupError.new(value, "fact lookups must be a string")

data/lib/bolt/project.rb

@@ -3,6 +3,7 @@
 require 'pathname'
 require 'bolt/config'
 require 'bolt/pal'
+require 'bolt/module'
 
 module Bolt
   class Project
@@ -17,7 +18,7 @@ module Bolt
 
     attr_reader :path, :data, :config_file, :inventory_file, :modulepath, :hiera_config,
                 :puppetfile, :rerunfile, :type, :resource_types, :warnings, :project_file,
-                :deprecations
+                :deprecations, :downloads, :plans_path
 
     def self.default_project
       create_project(File.expand_path(File.join('~', '.puppetlabs', 'bolt')), 'user')
@@ -81,6 +82,8 @@ module Bolt
       @rerunfile = @path + '.rerun.json'
       @resource_types = @path + '.resource_types'
       @type = type
+      @downloads = @path + 'downloads'
+      @plans_path = @path + 'plans'
 
       tc = Bolt::Config::INVENTORY_OPTIONS.keys & raw_data.keys
       if tc.any?
@@ -137,10 +140,10 @@ module Bolt
 
     def validate
       if name
-        name_regex = /^[a-z][a-z0-9_]*$/
-        if name !~ name_regex
+        if name !~ Bolt::Module::MODULE_NAME_REGEX
           raise Bolt::ValidationError, <<~ERROR_STRING
-          Invalid project name '#{name}' in bolt-project.yaml; project name must match #{name_regex.inspect}
+          Invalid project name '#{name}' in bolt-project.yaml; project name must begin with a lowercase letter
+          and can include lowercase letters, numbers, and underscores.
           ERROR_STRING
         elsif Dir.children(Bolt::PAL::BOLTLIB_PATH).include?(name)
           raise Bolt::ValidationError, "The project '#{name}' will not be loaded. The project name conflicts "\

data/lib/bolt/project_migrate.rb

@@ -0,0 +1,138 @@
+# frozen_string_literal: true
+
+module Bolt
+  class ProjectMigrate
+    attr_reader :path, :project_file, :backup_dir, :outputter, :inventory_file, :config_file
+
+    # This init mostly makes testing easier
+    def initialize(path, outputter, configured_inventory = nil)
+      @path = Pathname.new(path).expand_path
+      @project_file = @path + 'bolt-project.yaml'
+      @config_file = @path + 'bolt.yaml'
+      @backup_dir = @path + '.bolt-bak'
+      @inventory_file = configured_inventory || @path + 'inventory.yaml'
+      @outputter = outputter
+    end
+
+    def migrate_project
+      inv_ok = inventory_1_to_2(inventory_file, outputter) if inventory_file.file?
+      config_ok = bolt_yaml_to_bolt_project(inventory_file, outputter)
+      inv_ok && config_ok ? 0 : 1
+    end
+
+    # This could be made public and used elsewhere if the need arises
+    private def backup_file(origin_path)
+      unless File.exist?(origin_path)
+        outputter.print_message "Could not find file #{origin_path}, skipping backup."
+        return
+      end
+
+      date = Time.new.strftime("%Y%m%d_%H%M%S%L")
+      FileUtils.mkdir_p(backup_dir)
+
+      filename = File.basename(origin_path)
+      backup_path = File.join(backup_dir, "#{filename}.#{date}.bak")
+
+      outputter.print_message "Backing up #{filename} from #{origin_path} to #{backup_path}"
+
+      begin
+        FileUtils.cp(origin_path, backup_path)
+      rescue StandardError => e
+        raise Bolt::FileError.new("#{e.message}; unable to create backup of #{filename}.", origin_path)
+      end
+    end
+
+    private def bolt_yaml_to_bolt_project(inventory_file, outputter)
+      # If bolt-project.yaml already exists
+      if project_file.file?
+        outputter.print_message "bolt-project.yaml already exists in Bolt "\
+          "project at #{path}. Skipping project file update."
+
+      # If bolt.yaml doesn't exist
+      elsif !config_file.file?
+        outputter.print_message "Could not find bolt.yaml in project at "\
+          "#{path}. Skipping project file update."
+
+      else
+        config_data = Bolt::Util.read_optional_yaml_hash(config_file, 'config')
+        transport_data, project_data = config_data.partition do |k, _|
+          Bolt::Config::INVENTORY_OPTIONS.keys.include?(k)
+        end.map(&:to_h)
+
+        if transport_data.any?
+          if File.exist?(inventory_file)
+            inventory_data = Bolt::Util.read_yaml_hash(inventory_file, 'inventory')
+            merged = Bolt::Util.deep_merge(transport_data, inventory_data['config'] || {})
+            inventory_data['config'] = merged
+            backup_file(inventory_file)
+          else
+            FileUtils.touch(inventory_file)
+            inventory_data = { 'config' => transport_data }
+          end
+
+          backup_file(config_file)
+
+          begin
+            outputter.print_message "Moving transportation configuration options "\
+              "'#{transport_data.keys.join(', ')}' from bolt.yaml to inventory.yaml"
+            File.write(inventory_file, inventory_data.to_yaml)
+            File.write(config_file, project_data.to_yaml)
+          rescue StandardError => e
+            raise Bolt::FileError.new("#{e.message}; unable to write inventory.", inventory_file)
+          end
+        end
+
+        outputter.print_message "Renaming bolt.yaml to bolt-project.yaml"
+        FileUtils.mv(config_file, project_file)
+        outputter.print_message "Successfully updated project. Please add a "\
+          "'name' key to bolt-project.yaml to use project-level tasks and plans. "\
+          "Learn more about projects by running 'bolt guide project'."
+        # If nothing errored, this succeeded
+        true
+      end
+    end
+
+    private def inventory_1_to_2(inventory_file, outputter)
+      data = Bolt::Util.read_yaml_hash(inventory_file, 'inventory')
+      data.delete('version') if data['version'] != 2
+      migrated = migrate_group(data)
+
+      ok = if migrated
+             backup_file(inventory_file)
+             File.write(inventory_file, data.to_yaml)
+           end
+
+      result = if migrated && ok
+                 "Successfully migrated Bolt inventory to the latest version."
+               elsif !migrated
+                 "Bolt inventory is already on the latest version. Skipping inventory update."
+               else
+                 "Could not migrate Bolt inventory to the latest version. See "\
+                 "https://puppet.com/docs/bolt/latest/inventory_file_v2.html to manually update."
+               end
+      outputter.print_message(result)
+      ok
+    end
+
+    # Walks an inventory hash and replaces all 'nodes' keys with 'targets' keys
+    # and all 'name' keys nested in a 'targets' hash with 'uri' keys. Data is
+    # modified in place.
+    private def migrate_group(group)
+      migrated = false
+      if group.key?('nodes')
+        migrated = true
+        targets = group['nodes'].map do |target|
+          target['uri'] = target.delete('name') if target.is_a?(Hash)
+          target
+        end
+        group.delete('nodes')
+        group['targets'] = targets
+      end
+      (group['groups'] || []).each do |subgroup|
+        migrated_group = migrate_group(subgroup)
+        migrated ||= migrated_group
+      end
+      migrated
+    end
+  end
+end

data/lib/bolt/puppetdb/client.rb

@@ -96,6 +96,8 @@ module Bolt
         @http = HTTPClient.new
         @http.ssl_config.set_client_cert_file(@config.cert, @config.key) if @config.cert
         @http.ssl_config.add_trust_ca(@config.cacert)
+        @http.connect_timeout = @config.connect_timeout if @config.connect_timeout
+        @http.receive_timeout = @config.read_timeout if @config.read_timeout
 
         @http
       end

data/lib/bolt/puppetdb/config.rb

@@ -132,6 +132,22 @@ module Bolt
         end
       end
 
+      def connect_timeout
+        validate_timeout('connect_timeout')
+        @settings['connect_timeout']
+      end
+
+      def read_timeout
+        validate_timeout('read_timeout')
+        @settings['read_timeout']
+      end
+
+      def validate_timeout(timeout)
+        unless @settings[timeout].nil? || (@settings[timeout].is_a?(Integer) && @settings[timeout] > 0)
+          raise Bolt::PuppetDBError, "#{timeout} must be a positive integer, received #{@settings[timeout]}"
+        end
+      end
+
       def to_hash
         @settings.dup
       end