bolt 2.42.0 → 3.3.0

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

@@ -6,35 +6,50 @@ module Bolt
       class Step
         class Script < Step
           def self.allowed_keys
-            super + Set['script', 'parameters', 'arguments']
+            super + Set['arguments', 'pwsh_params']
+          end
+
+          def self.option_keys
+            Set['catch_errors', 'env_vars', 'run_as']
           end
 
           def self.required_keys
-            Set['targets']
+            Set['script', 'targets']
           end
 
-          def initialize(step_body)
+          def self.validate_step_keys(body, number)
             super
-            @script = step_body['script']
-            @parameters = step_body.fetch('parameters', {})
-            @arguments = step_body.fetch('arguments', [])
+
+            if body.key?('arguments') && !body['arguments'].nil? && !body['arguments'].is_a?(Array)
+              raise StepError.new('arguments key must be an array', body['name'], number)
+            end
+
+            if body.key?('pwsh_params') && !body['pwsh_params'].nil? && !body['pwsh_params'].is_a?(Hash)
+              raise StepError.new('pwsh_params key must be a hash', body['name'], number)
+            end
           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)
+            args        = body['arguments'] || []
+            pwsh_params = body['pwsh_params'] || {}
 
-            options = @parameters.dup
-            options['arguments'] = @arguments unless @arguments.empty?
+            opts = format_options(body)
+            opts = opts.merge('arguments' => args) if args.any?
+            opts = opts.merge('pwsh_params' => pwsh_params) if pwsh_params.any?
 
-            fn = 'run_script'
-            args = [@script, @targets]
-            args << @description if @description
-            args << options unless options.empty?
+            args = [body['script'], 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
+            'run_script'
           end
         end
       end

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

@@ -6,31 +6,34 @@ module Bolt
       class Step
         class Task < Step
           def self.allowed_keys
-            super + Set['task', 'parameters']
+            super + Set['parameters']
           end
 
-          def self.required_keys
-            Set['targets']
+          def self.option_keys
+            Set['catch_errors', 'noop', 'run_as']
           end
 
-          def initialize(step_body)
-            super
-            @task = step_body['task']
-            @parameters = step_body.fetch('parameters', {})
+          def self.required_keys
+            Set['targets', 'task']
           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)
+            params = (body['parameters'] || {}).merge(opts)
 
-            fn = 'run_task'
-            args = [@task, @targets]
-            args << @description if @description
-            args << @parameters unless @parameters.empty?
+            args = [body['task'], body['targets']]
+            args << body['description'] if body['description']
+            args << params if params.any?
 
-            code << function_call(fn, args)
+            args
+          end
 
-            code << "\n"
+          # Returns the function corresponding to the step
+          #
+          private def function
+            'run_task'
           end
         end
       end

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

@@ -29,7 +29,8 @@ 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?
 
           plan_string << "plan #{plan_object.name}("

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.rb

@@ -139,7 +139,7 @@ module Bolt
       plugins
     end
 
-    RUBY_PLUGINS = %w[task prompt env_var puppetdb].freeze
+    RUBY_PLUGINS = %w[task prompt env_var puppetdb puppet_connect_data].freeze
     BUILTIN_PLUGINS = %w[task terraform pkcs7 prompt vault aws_inventory puppetdb azure_inventory
                          yaml env_var gcloud_inventory].freeze
     DEFAULT_PLUGIN_HOOKS = { 'puppet_library' => { 'plugin' => 'puppet_agent', 'stop_service' => true } }.freeze
@@ -297,7 +297,7 @@ module Bolt
     def resolve_single_reference(reference)
       plugin_cache = if cache?(reference)
                        cache = Bolt::Plugin::Cache.new(reference,
-                                                       @config.project.cache_file,
+                                                       @config.project.plugin_cache_file,
                                                        @config.plugin_cache)
                        entry = cache.read_and_clean_cache
                        return entry unless entry.nil?

data/lib/bolt/plugin/cache.rb

@@ -7,11 +7,11 @@ require 'bolt/util'
 module Bolt
   class Plugin
     class Cache
-      attr_reader :reference, :cache_file, :default_config, :id
+      attr_reader :reference, :plugin_cache_file, :default_config, :id
 
-      def initialize(reference, cache_file, default_config)
+      def initialize(reference, plugin_cache_file, default_config)
         @reference = reference
-        @cache_file = cache_file
+        @plugin_cache_file = plugin_cache_file
         @default_config = default_config
       end
 
@@ -32,21 +32,21 @@ module Bolt
           unmodified = false if expired
           expired
         end
-        File.write(cache_file, cache.to_json) unless cache.empty? || unmodified
+        File.write(plugin_cache_file, cache.to_json) unless cache.empty? || unmodified
 
         cache.dig(id, 'result')
       end
 
       private def cache
-        @cache ||= Bolt::Util.read_optional_json_file(@cache_file, 'cache')
+        @cache ||= Bolt::Util.read_optional_json_file(@plugin_cache_file, 'cache')
       end
 
       def write_cache(result)
         cache.merge!({ id => { 'result' => result,
                                'mtime' => Time.now,
                                'ttl' => ttl } })
-        FileUtils.touch(cache_file)
-        File.write(cache_file, cache.to_json)
+        FileUtils.touch(plugin_cache_file)
+        File.write(plugin_cache_file, cache.to_json)
       end
 
       def validate

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.deprecation_warning('PKCS7 keys using hyphens, not underscores', 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

@@ -0,0 +1,77 @@
+# frozen_string_literal: true
+
+module Bolt
+  class Plugin
+    class PuppetConnectData
+      INPUT_DATA_VAR = 'PUPPET_CONNECT_INPUT_DATA'
+
+      def initialize(context:, **_opts)
+        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(
+          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
+        'puppet_connect_data'
+      end
+
+      def hooks
+        %i[resolve_reference validate_resolve_reference]
+      end
+
+      def resolve_reference(opts)
+        key = opts['key']
+        @data[key]
+      end
+
+      def validate_resolve_reference(opts)
+        unless opts['key']
+          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
+end

data/lib/bolt/plugin/puppetdb.rb

@@ -31,7 +31,7 @@ module Bolt
       end
 
       def warn_missing_fact(certname, fact)
-        @logger.warn("Could not find fact #{fact} for node #{certname}")
+        Bolt::Logger.warn("puppetdb_missing_fact", "Could not find fact #{fact} for node #{certname}")
       end
 
       def fact_path(raw_fact)

data/lib/bolt/project.rb

@@ -11,47 +11,40 @@ module Bolt
     BOLTDIR_NAME = 'Boltdir'
     CONFIG_NAME  = 'bolt-project.yaml'
 
-    attr_reader :path, :data, :config_file, :inventory_file, :hiera_config,
-                :puppetfile, :rerunfile, :type, :resource_types, :logs, :project_file,
-                :deprecations, :downloads, :plans_path, :modulepath, :managed_moduledir,
-                :backup_dir, :cache_file
+    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
 
-    def self.default_project(logs = [])
-      create_project(File.expand_path(File.join('~', '.puppetlabs', 'bolt')), 'user', logs)
+    def self.default_project
+      create_project(File.expand_path(File.join('~', '.puppetlabs', 'bolt')), 'user')
     # If homedir isn't defined use the system config path
     rescue ArgumentError
-      create_project(Bolt::Config.system_path, 'system', logs)
+      create_project(Bolt::Config.system_path, 'system')
     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, logs = [], deprecations = [])
+    def self.find_boltdir(dir)
       dir = Pathname.new(dir)
 
       if (dir + BOLTDIR_NAME).directory?
-        create_project(dir + BOLTDIR_NAME, 'embedded', logs)
-      elsif (dir + 'bolt.yaml').file?
-        command = Bolt::Util.powershell? ? 'Update-BoltProject' : 'bolt project migrate'
-        msg = "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}"
-        deprecations << { type: "Project level bolt.yaml",
-                          msg: msg }
-        create_project(dir, 'local', logs, deprecations)
+        create_project(dir + BOLTDIR_NAME, 'embedded')
       elsif (dir + CONFIG_NAME).file?
-        create_project(dir, 'local', logs)
+        create_project(dir, 'local')
       elsif dir.root?
-        default_project(logs)
+        default_project
       else
-        logs << { debug: "Did not detect Boltdir, bolt.yaml, or bolt-project.yaml at '#{dir}'. "\
-                  "This directory won't be loaded as a project." }
-        find_boltdir(dir.parent, logs, deprecations)
+        Bolt::Logger.debug(
+          "Did not detect Boltdir or bolt-project.yaml at '#{dir}'. This directory won't be loaded as a project."
+        )
+        find_boltdir(dir.parent)
       end
     end
 
-    def self.create_project(path, type = 'option', logs = [], deprecations = [])
+    def self.create_project(path, type = 'option')
       fullpath = Pathname.new(path).expand_path
 
       if type == 'user'
@@ -59,8 +52,11 @@ module Bolt
           # This is already expanded if the type is user
           FileUtils.mkdir_p(path)
         rescue StandardError
-          logs << { warn: "Could not create default project at #{path}. Continuing without a writeable project. "\
-                    "Log and rerun files will not be written." }
+          Bolt::Logger.warn(
+            "non_writeable_project",
+            "Could not create default project at #{path}. Continuing without a writeable project. "\
+            "Log and rerun files will not be written."
+          )
         end
       end
 
@@ -79,21 +75,18 @@ 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))
 
-      logs << { info: "Loaded #{default}project from '#{fullpath}'" } if exist
+      if File.exist?(File.expand_path(project_file))
+        Bolt::Logger.info("Loaded #{default}project from '#{fullpath}'")
+      end
 
       Bolt::Validator.new.tap do |validator|
         validator.validate(data, schema, project_file)
-
-        validator.warnings.each { |warning| logs << { warn: warning } }
-
-        validator.deprecations.each do |dep|
-          deprecations << { type: "#{CONFIG_NAME} #{dep[:option]}", msg: dep[:message] }
-        end
+        validator.warnings.each { |warning| Bolt::Logger.warn(warning[:id], warning[:msg]) }
+        validator.deprecations.each { |dep| Bolt::Logger.deprecate(dep[:id], dep[:msg]) }
       end
 
-      new(data, path, type, logs, deprecations)
+      new(data, path, type)
     end
 
     # Builds the schema for bolt-project.yaml used by the validator.
@@ -101,63 +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', logs = [], deprecations = [])
-      @path         = Pathname.new(path).expand_path
-      @project_file = @path + CONFIG_NAME
-      @logs         = logs
-      @deprecations = deprecations
-
-      if (@path + 'bolt.yaml').file? && project_file?
-        msg = "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."
-        @deprecations << { type: 'Using bolt.yaml for project configuration', msg: msg }
-      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'
-      @cache_file        = @path + '.plugin_cache.json'
-
-      tc = Bolt::Config::INVENTORY_OPTIONS.keys & raw_data.keys
-      if tc.any?
-        msg = "Transport configuration isn't supported in bolt-project.yaml. Ignoring keys #{tc}"
-        @logs << { warn: msg }
+      @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 & 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?
-                         msg = "bolt-project.yaml contains valid config keys, bolt.yaml will be ignored"
-                         @logs << { warn: msg }
-                       end
-                       @project_file
-                     else
-                       @path + 'bolt.yaml'
-                     end
+      @data = data.slice(*Bolt::Config::PROJECT_OPTIONS)
+
       validate if project_file?
     end
 
@@ -206,8 +173,13 @@ module Bolt
       @data['module-install']
     end
 
+    def disable_warnings
+      @data['disable-warnings'] || []
+    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
@@ -232,14 +204,15 @@ module Bolt
             File.directory?(@path + 'tasks') ||
             File.directory?(@path + 'files'))
         message = "No project name is specified in bolt-project.yaml. Project-level content will not be available."
-        @logs << { warn: message }
+
+        Bolt::Logger.warn("missing_project_name", message)
       end
     end
 
     def check_deprecated_file
       if (@path + 'project.yaml').file?
         msg = "Project configuration file 'project.yaml' is deprecated; use 'bolt-project.yaml' instead."
-        Bolt::Logger.deprecation_warning('Using project.yaml instead of bolt-project.yaml', msg)
+        Bolt::Logger.warn("project_yaml", msg)
       end
     end
   end