bolt 2.44.0 → 3.4.0

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

@@ -5,31 +5,30 @@ module Bolt
     class YamlPlan
       class Step
         class Upload < Step
-          def self.allowed_keys
-            super + Set['source', 'destination', 'upload']
+          def self.option_keys
+            Set['catch_errors', 'run_as']
           end
 
           def self.required_keys
-            Set['upload', 'destination', 'targets']
+            Set['destination', 'targets', 'upload']
           end
 
-          def initialize(step_body)
-            super
-            @source = step_body['upload'] || step_body['source']
-            @destination = step_body['destination']
-          end
-
-          def transpile
-            code = String.new("  ")
-            code << "$#{@name} = " if @name
+          # Returns an array of arguments to pass to the step's function call
+          #
+          private def format_args(body)
+            opts = format_options(body)
 
-            fn = 'upload_file'
-            args = [@source, @destination, @targets]
-            args << @description if @description
+            args = [body['upload'], body['destination'], body['targets']]
+            args << body['description'] if body['description']
+            args << opts if opts.any?
 
-            code << function_call(fn, args)
+            args
+          end
 
-            code << "\n"
+          # Returns the function corresponding to the step
+          #
+          private def function
+            'upload_file'
           end
         end
       end

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

@@ -14,8 +14,8 @@ module Bolt
           end
         end
 
-        def transpile(relative_path)
-          @plan_path = File.expand_path(relative_path)
+        def transpile(plan_path)
+          @plan_path = plan_path
           @modulename = Bolt::Util.module_name(@plan_path)
           @filename = @plan_path.split(File::SEPARATOR)[-1]
           validate_path
@@ -29,7 +29,7 @@ module Bolt
 
           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 << "# WARNING: This is an autogenerated plan. It might not behave as expected.\n"
           plan_string << "# @private #{plan_object.private}\n" unless plan_object.private.nil?
           plan_string << "#{param_descriptions}\n" unless param_descriptions.empty?
 

data/lib/bolt/plan_creator.rb

@@ -22,7 +22,7 @@ module Bolt
           Invalid plan name '#{plan_name}'. Plan names are composed of one or more name segments
           separated by double colons '::'.
 
-          Each name segment must begin with a lowercase letter, and may only include lowercase
+          Each name segment must begin with a lowercase letter, and can only include lowercase
           letters, digits, and underscores.
 
           Examples of valid plan names:

data/lib/bolt/plugin/module.rb

@@ -30,10 +30,6 @@ module Bolt
         @module = mod
         @config = config
         @context = context
-
-        if @module.name == 'pkcs7'
-          @config = handle_deprecated_pkcs7_keys(@config)
-        end
       end
 
       # This method interacts with the module on disk so it's separate from initialize
@@ -160,10 +156,6 @@ module Bolt
         # out now.
         meta, params = opts.partition { |key, _val| key.start_with?('_') }.map(&:to_h)
 
-        if task.module_name == 'pkcs7'
-          params = handle_deprecated_pkcs7_keys(params)
-        end
-
         # Reject parameters from config that are not accepted by the task and
         # merge in parameter defaults
         params = if task.parameters
@@ -181,21 +173,6 @@ module Bolt
         [params, meta]
       end
 
-      # Raises a deprecation warning if the pkcs7 plugin is using deprecated keys and
-      # modifies the keys so they are the correct format
-      def handle_deprecated_pkcs7_keys(params)
-        if params.key?('private-key') || params.key?('public-key')
-          message = "pkcs7 keys 'private-key' and 'public-key' have been deprecated and will be "\
-                    "removed in a future version of Bolt; use 'private_key' and 'public_key' instead."
-          Bolt::Logger.deprecate("pkcs7_params", message)
-        end
-
-        params['private_key'] = params.delete('private-key') if params.key?('private-key')
-        params['public_key'] = params.delete('public-key') if params.key?('public-key')
-
-        params
-      end
-
       def extract_task_parameter_schema
         # Get the intersection of expected types (using Set)
         type_set = @hook_map.each_with_object({}) do |(_hook, task), acc|

data/lib/bolt/plugin/puppet_connect_data.rb

@@ -3,12 +3,45 @@
 module Bolt
   class Plugin
     class PuppetConnectData
+      INPUT_DATA_VAR = 'PUPPET_CONNECT_INPUT_DATA'
+
       def initialize(context:, **_opts)
-        puppet_connect_data_yaml_path = File.join(context.boltdir, 'puppet_connect_data.yaml')
+        if ENV.key?(INPUT_DATA_VAR)
+          # The user provided input data that they will copy-paste into the Puppet Connect UI
+          # for inventory syncing. This environment variable will likely be set when invoking a
+          # general "test Puppet Connect input data" command. That command tests that parsing
+          # the inventory with the given input data results in connectable targets. Part of
+          # that requires validating that the input data contains all of the referenced keys,
+          # which is what this plugin will do in validate_resolve_reference.
+          @input_data_path = ENV[INPUT_DATA_VAR]
+          data_path = @input_data_path
+        else
+          # The user is using this plugin during a regular Bolt invocation, so fetch the (minimal)
+          # required data from the default location. This data should typically be non-autoloadable
+          # secrets like WinRM passwords.
+          #
+          # Note that any unspecified keys will be resolved to nil.
+          data_path = File.join(context.boltdir, 'puppet_connect_data.yaml')
+        end
+
         @data = Bolt::Util.read_optional_yaml_hash(
-          puppet_connect_data_yaml_path,
-          'puppet_connect_data.yaml'
+          data_path,
+          File.basename(data_path)
         )
+
+        if @input_data_path
+          # Validate that the data does not contain any plugin-reference
+          # values
+          @data.each do |key, toplevel_value|
+            # Use walk_vals to check for nested plugin references
+            Bolt::Util.walk_vals(toplevel_value) do |current_value|
+              if current_value.is_a?(Hash) && current_value.key?('_plugin')
+                raise invalid_input_data_err("the #{key} key's value contains a plugin reference")
+              end
+              current_value
+            end
+          end
+        end
       end
 
       def name
@@ -29,6 +62,15 @@ module Bolt
           raise Bolt::ValidationError,
                 "puppet_connect_data plugin requires that 'key' be specified"
         end
+        if @input_data_path && !@data.key?(opts['key'])
+          # Input data for Puppet Connect was provided and opts['key'] does not have a
+          # value specified. Raise an error for this case.
+          raise invalid_input_data_err("a value for the #{opts['key']} key is not specified")
+        end
+      end
+
+      def invalid_input_data_err(msg)
+        Bolt::ValidationError.new("invalid input data #{@input_data_path}: #{msg}")
       end
     end
   end

data/lib/bolt/project.rb

@@ -11,7 +11,7 @@ module Bolt
     BOLTDIR_NAME = 'Boltdir'
     CONFIG_NAME  = 'bolt-project.yaml'
 
-    attr_reader :path, :data, :config_file, :inventory_file, :hiera_config,
+    attr_reader :path, :data, :inventory_file, :hiera_config,
                 :puppetfile, :rerunfile, :type, :resource_types, :project_file,
                 :downloads, :plans_path, :modulepath, :managed_moduledir,
                 :backup_dir, :plugin_cache_file, :plan_cache_file
@@ -24,31 +24,21 @@ module Bolt
     end
 
     # Search recursively up the directory hierarchy for the Project. Look for a
-    # directory called Boltdir or a file called bolt.yaml (for a control repo
-    # type Project). Otherwise, repeat the check on each directory up the
+    # directory called Boltdir or a file called bolt-project.yaml (for a control
+    # repo type Project). Otherwise, repeat the check on each directory up the
     # hierarchy, falling back to the default if we reach the root.
     def self.find_boltdir(dir)
       dir = Pathname.new(dir)
 
       if (dir + BOLTDIR_NAME).directory?
         create_project(dir + BOLTDIR_NAME, 'embedded')
-      elsif (dir + 'bolt.yaml').file?
-        command = Bolt::Util.powershell? ? 'Update-BoltProject' : 'bolt project migrate'
-        Bolt::Logger.deprecate(
-          "bolt_yaml",
-          "Configuration file #{dir + 'bolt.yaml'} is deprecated and will be "\
-          "removed in Bolt 3.0.\nUpdate your Bolt project to the latest Bolt practices "\
-          "using #{command}."
-        )
-        create_project(dir, 'local')
       elsif (dir + CONFIG_NAME).file?
         create_project(dir, 'local')
       elsif dir.root?
         default_project
       else
         Bolt::Logger.debug(
-          "Did not detect Boltdir, bolt.yaml, or bolt-project.yaml at '#{dir}'. "\
-          "This directory won't be loaded as a project."
+          "Did not detect Boltdir or bolt-project.yaml at '#{dir}'. This directory won't be loaded as a project."
         )
         find_boltdir(dir.parent)
       end
@@ -85,9 +75,8 @@ module Bolt
       project_file = File.join(fullpath, CONFIG_NAME)
       data         = Bolt::Util.read_optional_yaml_hash(File.expand_path(project_file), 'project')
       default      = type =~ /user|system/ ? 'default ' : ''
-      exist        = File.exist?(File.expand_path(project_file))
 
-      if exist
+      if File.exist?(File.expand_path(project_file))
         Bolt::Logger.info("Loaded #{default}project from '#{fullpath}'")
       end
 
@@ -105,67 +94,37 @@ module Bolt
     def self.schema
       {
         type:        Hash,
-        properties:  Bolt::Config::BOLT_PROJECT_OPTIONS.map { |opt| [opt, _ref: opt] }.to_h,
+        properties:  Bolt::Config::PROJECT_OPTIONS.map { |opt| [opt, _ref: opt] }.to_h,
         definitions: Bolt::Config::OPTIONS
       }
     end
 
-    def initialize(raw_data, path, type = 'option')
-      @path         = Pathname.new(path).expand_path
-      @project_file = @path + CONFIG_NAME
-
-      if (@path + 'bolt.yaml').file? && project_file?
-        Bolt::Logger.deprecate(
-          "bolt_yaml",
-          "Project-level configuration in bolt.yaml is deprecated if using bolt-project.yaml. "\
-          "Transport config should be set in inventory.yaml, all other config should be set in "\
-          "bolt-project.yaml."
-        )
-      end
-
+    def initialize(data, path, type = 'option')
+      @type              = type
+      @path              = Pathname.new(path).expand_path
+      @project_file      = @path + CONFIG_NAME
       @inventory_file    = @path + 'inventory.yaml'
       @hiera_config      = @path + 'hiera.yaml'
       @puppetfile        = @path + 'Puppetfile'
       @rerunfile         = @path + '.rerun.json'
       @resource_types    = @path + '.resource_types'
-      @type              = type
       @downloads         = @path + 'downloads'
       @plans_path        = @path + 'plans'
       @managed_moduledir = @path + '.modules'
       @backup_dir        = @path + '.bolt-bak'
       @plugin_cache_file = @path + '.plugin_cache.json'
       @plan_cache_file   = @path + '.plan_cache.json'
+      @modulepath        = [(@path + 'modules').to_s]
 
-      if (tc = Bolt::Config::INVENTORY_OPTIONS.keys & raw_data.keys).any?
+      if (tc = Bolt::Config::INVENTORY_OPTIONS.keys & data.keys).any?
         Bolt::Logger.warn(
           "project_transport_config",
           "Transport configuration isn't supported in bolt-project.yaml. Ignoring keys #{tc}."
         )
       end
 
-      @data = raw_data.reject { |k, _| Bolt::Config::INVENTORY_OPTIONS.include?(k) }
-
-      # If the 'modules' key is present in the project configuration file,
-      # use the new, shorter modulepath.
-      @modulepath = if @data.key?('modules')
-                      [(@path + 'modules').to_s]
-                    else
-                      [(@path + 'modules').to_s, (@path + 'site-modules').to_s, (@path + 'site').to_s]
-                    end
-
-      # Once bolt.yaml deprecation is removed, this attribute should be removed
-      # and replaced with .project_file in lib/bolt/config.rb
-      @config_file = if (Bolt::Config::BOLT_OPTIONS & @data.keys).any?
-                       if (@path + 'bolt.yaml').file?
-                         Bolt::Logger.warn(
-                           "project_config_conflict",
-                           "bolt-project.yaml contains valid config keys, bolt.yaml will be ignored"
-                         )
-                       end
-                       @project_file
-                     else
-                       @path + 'bolt.yaml'
-                     end
+      @data = data.slice(*Bolt::Config::PROJECT_OPTIONS)
+
       validate if project_file?
     end
 
@@ -219,7 +178,8 @@ module Bolt
     end
 
     def modules
-      @modules ||= @data['modules']&.map do |mod|
+      mod_data = @data['modules'] || []
+      @modules ||= mod_data.map do |mod|
         if mod.is_a?(String)
           { 'name' => mod }
         else

data/lib/bolt/project_manager.rb

@@ -143,7 +143,7 @@ module Bolt
       @outputter.print_message("Migrating project #{@config.project.path}\n\n")
 
       @outputter.print_action_step(
-        "Migrating a Bolt project may make irreversible changes to the project's "\
+        "Migrating a Bolt project might make irreversible changes to the project's "\
         "configuration and inventory files. Before continuing, make sure the "\
         "project has a backup or uses a version control system."
       )
@@ -166,10 +166,11 @@ module Bolt
     # Migrates the project-level configuration file to the latest version.
     #
     private def migrate_config
-      migrator = ConfigMigrator.new(@outputter)
+      migrator   = ConfigMigrator.new(@outputter)
+      configfile = @config.project.path + 'bolt.yaml'
 
       migrator.migrate(
-        @config.project.config_file,
+        configfile,
         @config.project.project_file,
         @config.inventoryfile || @config.project.inventory_file,
         @config.project.backup_dir
@@ -194,7 +195,7 @@ module Bolt
 
       migrator.migrate(
         @config.project,
-        @config.modulepath
+        @config.modulepath[0...-1]
       )
     end
   end

data/lib/bolt/project_manager/module_migrator.rb

@@ -6,19 +6,20 @@ module Bolt
   class ProjectManager
     class ModuleMigrator < Migrator
       def migrate(project, configured_modulepath)
-        return true unless project.modules.nil?
+        return true if project.managed_moduledir.exist?
 
         @outputter.print_message "Migrating project modules\n\n"
 
         config            = project.project_file
         puppetfile        = project.puppetfile
         managed_moduledir = project.managed_moduledir
-        modulepath        = [(project.path + 'modules').to_s,
+        new_modulepath    = [(project.path + 'modules').to_s]
+        old_modulepath    = [(project.path + 'modules').to_s,
                              (project.path + 'site-modules').to_s,
                              (project.path + 'site').to_s]
 
         # Notify user to manually migrate modules if using non-default modulepath
-        if configured_modulepath != modulepath
+        if configured_modulepath != new_modulepath && configured_modulepath != old_modulepath
           @outputter.print_action_step(
             "Project has a non-default configured modulepath, unable to automatically "\
             "migrate project modules. To migrate project modules manually, see "\
@@ -27,10 +28,10 @@ module Bolt
           true
         # Migrate modules from Puppetfile
         elsif File.exist?(puppetfile)
-          migrate_modules_from_puppetfile(config, puppetfile, managed_moduledir, modulepath)
+          migrate_modules_from_puppetfile(config, puppetfile, managed_moduledir, old_modulepath)
         # Migrate modules to updated modulepath
         else
-          consolidate_modules(modulepath)
+          consolidate_modules(old_modulepath)
           update_project_config([], config)
         end
       end
@@ -65,7 +66,7 @@ module Bolt
         # Attempt to resolve dependencies
         begin
           @outputter.print_message('')
-          @outputter.print_action_step("Resolving module dependencies, this may take a moment")
+          @outputter.print_action_step("Resolving module dependencies, this might take a moment")
           puppetfile = Bolt::ModuleInstaller::Resolver.new.resolve(specs)
         rescue Bolt::Error => e
           @outputter.print_action_error("#{e.message}\nSkipping module migration.")

data/lib/bolt/result.rb

@@ -28,20 +28,14 @@ module Bolt
       %w[file line].zip(position).to_h.compact
     end
 
-    def self.for_command(target, stdout, stderr, exit_code, action, command, position)
-      value = {
-        'stdout' => stdout,
-        'stderr' => stderr,
-        'exit_code' => exit_code
-      }
-
+    def self.for_command(target, value, action, command, position)
       details = create_details(position)
-      unless exit_code == 0
-        details['exit_code'] = exit_code
+      unless value['exit_code'] == 0
+        details['exit_code'] = value['exit_code']
         value['_error'] = {
           'kind' => 'puppetlabs.tasks/command-error',
           'issue_code' => 'COMMAND_ERROR',
-          'msg' => "The command failed with exit code #{exit_code}",
+          'msg' => "The command failed with exit code #{value['exit_code']}",
           'details' => details
         }
       end
@@ -203,12 +197,17 @@ module Bolt
     end
 
     def to_data
+      serialized_value = safe_value
+      if serialized_value.key?('_sensitive') &&
+         serialized_value['_sensitive'].is_a?(Puppet::Pops::Types::PSensitiveType::Sensitive)
+        serialized_value['_sensitive'] = serialized_value['_sensitive'].to_s
+      end
       {
         "target" => @target.name,
         "action" => action,
         "object" => object,
         "status" => status,
-        "value" => safe_value
+        "value" => serialized_value
       }
     end