bolt 2.10.0 → 2.14.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4f0e265eb792ba38e627651fad94478a4acbcbf7576912b95f6eaa0b234e6957
-  data.tar.gz: ad28f917ac186069e61300142dad31373b4a09dd484a3d131962d383b803d43a
+  metadata.gz: fbe6053f1a3801adb0f1d0684f1e4616311c93bf0513a74cde2c54c82d5de503
+  data.tar.gz: b51e4068dcceb096d5e6cec4a79d692b84d1472abe57065de1a219d8ed84a4ad
 SHA512:
-  metadata.gz: 9b915748121d6081207a1afac60768008fc752f545ca722c403b58efbb96303417d3add08d8aaf1fd299770fd1202461f2759224b7bdf19592a9f6e5c277705c
-  data.tar.gz: 5c25c74ee7e7f7c39e1eb125e5b39fb0fcbefceb6ede50b8c364cacb19bf1eb20cd70dc80d24422e9590d8d8720b7fc25b3b98e147c4c4dee646ffc441d7154b
+  metadata.gz: ea53a6643459311d007ad7b8c2a60e5d0d4af6b0005b037295edff063a2e1f0236054d9cb5c14cec039ee8d0eb0ffa94e887b6a1ba64c3bb196f2a10cd90ce6d
+  data.tar.gz: 7bfde56e613103081c5ce73095c82b897f5db8b973365e6fbd28dfc7f57873fce518d37fe55bb76e36f36ab9dc802a12e545621bbff44f3a389ff071898bbc2c

data/Puppetfile

@@ -24,7 +24,7 @@ mod 'puppetlabs-zone_core', '1.0.3'
 # Useful additional modules
 mod 'puppetlabs-package', '1.1.0'
 mod 'puppetlabs-puppet_conf', '0.6.0'
-mod 'puppetlabs-python_task_helper', '0.4.0'
+mod 'puppetlabs-python_task_helper', '0.4.3'
 mod 'puppetlabs-reboot', '3.0.0'
 mod 'puppetlabs-ruby_task_helper', '0.5.1'
 mod 'puppetlabs-ruby_plugin_helper', '0.1.0'

data/bolt-modules/boltlib/lib/puppet/datatypes/applyresult.rb

@@ -17,5 +17,7 @@ Puppet::DataTypes.create_type('ApplyResult') do
 
   load_file('bolt/apply_result')
 
+  # Needed for Puppet to recognize Bolt::ApplyResult as a Puppet object when deserializing
+  Bolt::ApplyResult.include(Puppet::Pops::Types::PuppetObject)
   implementation_class Bolt::ApplyResult
 end

data/bolt-modules/boltlib/lib/puppet/datatypes/resourceinstance.rb

@@ -11,12 +11,13 @@ Puppet::DataTypes.create_type('ResourceInstance') do
       'events'        => Optional[Array[Hash[String[1], Data]]]
     },
     functions => {
-      add_event               => Callable[[Hash[String[1], Data]], [Hash[String[1], Data]]],
+      add_event               => Callable[[Hash[String[1], Data]], Array[Hash[String[1], Data]]],
       set_state               => Callable[[Hash[String[1], Data]], Hash[String[1], Data]],
       overwrite_state         => Callable[[Hash[String[1], Data]], Hash[String[1], Data]],
       set_desired_state       => Callable[[Hash[String[1], Data]], Hash[String[1], Data]],
       overwrite_desired_state => Callable[[Hash[String[1], Data]], Hash[String[1], Data]],
-      reference               => Callable[[], String]
+      reference               => Callable[[], String],
+      '[]'                    => Callable[[String[1]], Data]
     }
   PUPPET
 

data/bolt-modules/boltlib/lib/puppet/datatypes/result.rb

@@ -19,5 +19,7 @@ Puppet::DataTypes.create_type('Result') do
 
   load_file('bolt/result')
 
+  # Needed for Puppet to recognize Bolt::Result as a Puppet object when deserializing
+  Bolt::Result.include(Puppet::Pops::Types::PuppetObject)
   implementation_class Bolt::Result
 end

data/bolt-modules/boltlib/lib/puppet/datatypes/resultset.rb

@@ -25,5 +25,7 @@ Puppet::DataTypes.create_type('ResultSet') do
 
   load_file('bolt/result_set')
 
+  # Needed for Puppet to recognize Bolt::ResultSet as a Puppet object when deserializing
+  Bolt::ResultSet.include(Puppet::Pops::Types::PuppetObject)
   implementation_class Bolt::ResultSet
 end

data/bolt-modules/boltlib/lib/puppet/datatypes/target.rb

@@ -8,8 +8,6 @@ Puppet::DataTypes.create_type('Target') do
     target_implementation_class = Bolt::Target
   end
 
-  require 'bolt/target'
-
   interface <<-PUPPET
     attributes => {
       uri => { type => Optional[String[1]], kind => given_or_derived },
@@ -34,5 +32,7 @@ Puppet::DataTypes.create_type('Target') do
     }
   PUPPET
 
+  # Needed for Puppet to recognize targets as Puppet objects when deserializing
+  target_implementation_class.include(Puppet::Pops::Types::PuppetObject)
   implementation_class target_implementation_class
 end

data/bolt-modules/boltlib/lib/puppet/functions/apply_prep.rb

@@ -3,7 +3,7 @@
 require 'bolt/task'
 
 # Installs the `puppet-agent` package on targets if needed, then collects facts,
-# including any custom facts found in Bolt's modulepath. The package is
+# including any custom facts found in Bolt's module path. The package is
 # installed using either the configured plugin or the `task` plugin with the
 # `puppet_agent::install` task.
 #

data/bolt-modules/boltlib/lib/puppet/functions/get_resources.rb

@@ -2,7 +2,7 @@
 
 require 'bolt/task'
 
-# Query the state of resources on a list of targets using resource definitions in Bolt's modulepath.
+# Query the state of resources on a list of targets using resource definitions in Bolt's module path.
 # The results are returned as a list of hashes representing each resource.
 #
 # Requires the Puppet Agent be installed on the target, which can be accomplished with apply_prep

data/bolt-modules/boltlib/lib/puppet/functions/resource.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+# Lookup a resource in the target's data.
+#
+# For more information about resources see [the
+# documentation](https://puppet.com/docs/puppet/latest/lang_resources.html).
+#
+# > **Note:** The `ResourceInstance` data type is under active development and is subject to
+#   change. You can read more about the data type in the [experimental features
+#   documentation](experimental_features.md#resourceinstance-data-type).
+Puppet::Functions.create_function(:resource) do
+  # Lookup a resource in the target's data.
+  # @param target The Target object to add resources to. See {get_targets}.
+  # @param type The type of the resource
+  # @param title The title of the resource
+  # @return The ResourceInstance if found, or Undef
+  # @example Get the openssl package resource
+  #   $target.apply_prep
+  #   $resources = $target.get_resources(Package).first['resources']
+  #   $target.set_resources($resources)
+  #   $openssl = $target.resource('Package', 'openssl')
+  dispatch :resource do
+    param 'Target', :target
+    param 'Type[Resource]', :type
+    param 'String[1]', :title
+    return_type 'Optional[ResourceInstance]'
+  end
+
+  # Lookup a resource in the target's data, referring to resource as a string
+  # @param target The Target object to add resources to. See {get_targets}.
+  # @param type The type of the resource
+  # @param title The title of the resource
+  # @return The ResourceInstance if found, or Undef
+  dispatch :resource_from_string do
+    param 'Target', :target
+    param 'String[1]', :type
+    param 'String[1]', :title
+    return_type 'Optional[ResourceInstance]'
+  end
+
+  def resource(target, type, title)
+    inventory = Puppet.lookup(:bolt_inventory)
+    executor  = Puppet.lookup(:bolt_executor) { nil }
+    executor&.report_function_call(self.class.name)
+
+    inventory.resource(target, type, title)
+  end
+
+  def resource_from_string(target, type, title)
+    resource(target, type, title)
+  end
+end

data/bolt-modules/boltlib/lib/puppet/functions/run_plan.rb

@@ -109,6 +109,15 @@ Puppet::Functions.create_function(:run_plan, Puppet::Functions::InternalFunction
       end
     end
 
+    # Wrap Sensitive parameters for plans that are run from the CLI, as it's impossible to pass
+    # a Sensitive value that way. We don't do this for plans run from the run_plan function, as
+    # it can receive Sensitive values as arguments.
+    # This should only happen after expanding target params, otherwise things will blow up if
+    # the targets are wrapped as Sensitive. Hopefully nobody does that, though...
+    if options[:bolt_api_call]
+      params = wrap_sensitive_parameters(params, closure.parameters)
+    end
+
     # wrap plan execution in logging messages
     executor.log_plan(plan_name) do
       result = nil
@@ -169,6 +178,62 @@ Puppet::Functions.create_function(:run_plan, Puppet::Functions::InternalFunction
     end
   end
 
+  # Wrap any Sensitive parameters in the Sensitive wrapper type, unless they are already
+  # wrapped as Sensitive. This will also raise a helpful warning if the type expression
+  # is a complex data type using Sensitive, as we don't handle those cases.
+  def wrap_sensitive_parameters(params, param_models)
+    models = param_models.each_with_object({}) { |param, acc| acc[param.name] = param }
+
+    params.each_with_object({}) do |(name, value), acc|
+      model = models[name]
+
+      # Parameters passed to a plan that the plan is not expecting don't have a model,
+      # so keep the parameter as-is.
+      if model.nil?
+        acc[name] = value
+      elsif sensitive_type?(model.type_expr)
+        acc[name] = Puppet::Pops::Types::PSensitiveType::Sensitive.new(value)
+      else
+        if model.type_expr.to_s.include?('Sensitive')
+          # Include the location for regular plans. YAML plans don't have this info, so
+          # the location will be suppressed.
+          file = defined?(model.file) ? model.file : :default
+          line = defined?(model.line) ? model.line : :default
+
+          Puppet.warn_once(
+            'unsupported_sensitive_type',
+            name,
+            "Parameter '#{name}' is a complex type using Sensitive, unable to automatically wrap as Sensitive",
+            file,
+            line
+          )
+        end
+
+        acc[name] = value
+      end
+    end
+  end
+
+  # Whether the type is a supported Sensitive type. We only support wrapping parameterized
+  # and non-parameterized Sensitive types (e.g. Sensitive, Sensitive[String])
+  def sensitive_type?(type_expr)
+    # Parameterized Sensitive type (e.g. Sensitive[String])
+    # left_expr is defined whenever the type is parameterized. If this is a parameterized
+    # Sensitive type, then we check the cased_value, which is the stringified version of
+    # the left expression's type.
+    (defined?(type_expr.left_expr) && type_expr.left_expr.cased_value == 'Sensitive') ||
+      # Non-parameterized Sensitive type (Sensitive)
+      # cased_value is defined whenever the type is non-parameterized. If the type expression
+      # defines cased_value, then this is a simple type and we just need to check that it's
+      # Sensitive.
+      (defined?(type_expr.cased_value) && type_expr.cased_value == 'Sensitive') ||
+      # Sensitive type from YAML plans
+      # Type expressions from YAML plans are a different class than those from regular plans.
+      # As long as the type expression is PSensitiveType we can be sure that the type is
+      # either a parameterized or non-parameterized Sensitive type.
+      type_expr.instance_of?(Puppet::Pops::Types::PSensitiveType)
+  end
+
   def targets_to_param(targets, params, param_types)
     nodes_param = param_types.include?('nodes')
     targets_param = param_types['targets']&.any? { |p| p.match?(/TargetSpec/) }

data/bolt-modules/boltlib/lib/puppet/functions/run_task.rb

@@ -88,8 +88,10 @@ Puppet::Functions.create_function(:run_task) do
 
       task = Bolt::Task.from_task_signature(task_signature)
 
-      # Set the default value for any params that have one and were not provided
-      params = task.parameter_defaults.merge(params)
+      # Set the default value for any params that have one and were not provided or are undef
+      params = task.parameter_defaults.merge(params) do |_, default, passed|
+        passed.nil? ? default : passed
+      end
 
       task_signature.runnable_with?(params) do |mismatch_message|
         raise with_stack(:TYPE_MISMATCH, mismatch_message)

data/bolt-modules/boltlib/lib/puppet/functions/run_task_with.rb

@@ -124,7 +124,10 @@ Puppet::Functions.create_function(:run_task_with) do
       # If parameters are mismatched, create a failing result for the target that will later
       # be added to the ResultSet.
       unless pcp_only
-        params = task.parameter_defaults.merge(params)
+        # Set the default value for any params that have one and were not provided or are undef
+        params = task.parameter_defaults.merge(params) do |_, default, passed|
+          passed.nil? ? default : passed
+        end
 
         type_match = task_signature.runnable_with?(params) do |mismatch_message|
           exception = with_stack(:TYPE_MISMATCH, mismatch_message)
@@ -157,7 +160,10 @@ Puppet::Functions.create_function(:run_task_with) do
         end
       end
 
-      mapping[target] = task.parameter_defaults.merge(params)
+      # Set the default value for any params that have one and were not provided or are undef
+      mapping[target] = task.parameter_defaults.merge(params) do |_, default, passed|
+        passed.nil? ? default : passed
+      end
     end
 
     # Add a noop parameter if the function was called with the noop metaparameter.

data/bolt-modules/boltlib/lib/puppet/functions/set_resources.rb

@@ -14,26 +14,61 @@ require 'bolt/error'
 #
 # > **Note:** Not available in apply block
 Puppet::Functions.create_function(:set_resources) do
-  # Set multiple resources
-  # @param target The `Target` object to add resources to. See {get_targets}.
-  # @param resources The resources to set on the target.
-  # @return The added `ResourceInstance` objects.
-  # @example Add multiple resources to a target with an array of `ResourceInstance` objects.
-  #   $resource1 = ResourceInstance.new(
+  # Set a single resource from a data hash.
+  # @param target The `Target` object to add a resource to. See {get_targets}.
+  # @param resource The resource data hash used to set a resource on the target.
+  # @return An array with the added `ResourceInstance` object.
+  # @example Add a resource to a target from a data hash.
+  #   $resource_hash = {
+  #     'type'  => File,
+  #     'title' => '/etc/puppetlabs',
+  #     'state' => { 'ensure' => 'present' }
+  #   }
+  #
+  #   $target.set_resources($resource_hash)
+  dispatch :set_single_resource_from_hash do
+    param 'Target', :target
+    param 'Hash', :resource
+    return_type 'Array[ResourceInstance]'
+  end
+
+  # Set a single resource from a `ResourceInstance` object
+  # @param target The `Target` object to add a resource to. See {get_targets}.
+  # @param resource The `ResourceInstance` object to set on the target.
+  # @return An array with the added `ResourceInstance` object.
+  # @example Add a resource to a target from a `ResourceInstance` object.
+  #   $resource_instance = ResourceInstance.new(
   #     'target' => $target,
-  #     'type'   => 'file',
+  #     'type'   => File,
   #     'title'  => '/etc/puppetlabs',
   #     'state'  => { 'ensure' => 'present' }
   #   )
-  #   $resource2 = ResourceInstance.new(
-  #     'target' => $target,
-  #     'type'   => 'package',
-  #     'title'  => 'openssl',
-  #     'state'  => { 'ensure' => 'installed' }
-  #   )
-  #   $target.set_resources([$resource1, $resource2])
+  #
+  #   $target.set_resources($resource_instance)
+  dispatch :set_single_resource_from_object do
+    param 'Target', :target
+    param 'ResourceInstance', :resource
+    return_type 'Array[ResourceInstance]'
+  end
+
+  # Set multiple resources from an array of data hashes and `ResourceInstance` objects.
+  # @param target The `Target` object to add resources to. See {get_targets}.
+  # @param resources The resource data hashes and `ResourceInstance` objects to set on the target.
+  # @return An array of the added `ResourceInstance` objects.
+  # @example Add resources from resource data hashes returned from an apply block.
+  #   $apply_results = apply($targets) {
+  #     File { '/etc/puppetlabs':
+  #       ensure => present
+  #     }
+  #     Package { 'openssl':
+  #       ensure => installed
+  #     }
+  #   }
+  #
+  #   $apply_results.each |$result| {
+  #     $result.target.set_resources($result.report['resource_statuses'].values)
+  #   }
   # @example Add resources retrieved with [`get_resources`](#get_resources) to a target.
-  #   $target.apply_prep
   #   $resources = $target.get_resources(Package).first['resources']
   #   $target.set_resources($resources)
   dispatch :set_resources do
@@ -42,21 +77,12 @@ Puppet::Functions.create_function(:set_resources) do
     return_type 'Array[ResourceInstance]'
   end
 
-  # Set a single resource
-  # @param target The `Target` object to add resources to. See {get_targets}.
-  # @param resource The resource to set on the target.
-  # @return The added `ResourceInstance` object.
-  # @example Add a single resource to a target with a resource data hash.
-  #   $resource = {
-  #     'type'  => 'file',
-  #     'title' => '/etc/puppetlabs',
-  #     'state' => { 'ensure' => 'present' }
-  #   }
-  #   $target.set_resources($resource)
-  dispatch :set_resource do
-    param 'Target', :target
-    param 'Variant[Hash, ResourceInstance]', :resource
-    return_type 'Array[ResourceInstance]'
+  def set_single_resource_from_hash(target, resource)
+    set_resources(target, [resource])
+  end
+
+  def set_single_resource_from_object(target, resource)
+    set_resources(target, [resource])
   end
 
   def set_resources(target, resources)
@@ -68,11 +94,8 @@ Puppet::Functions.create_function(:set_resources) do
         )
     end
 
+    Puppet.lookup(:bolt_executor).report_function_call(self.class.name)
     inventory = Puppet.lookup(:bolt_inventory)
-    executor  = Puppet.lookup(:bolt_executor)
-    executor.report_function_call(self.class.name)
-
-    inventory_target = inventory.get_target(target)
 
     resources.uniq.map do |resource|
       if resource.is_a?(Hash)
@@ -81,15 +104,18 @@ Puppet::Functions.create_function(:set_resources) do
         resource_target = if resource.key?('target')
                             inventory.get_target(resource['target'])
                           else
-                            inventory_target
+                            target
                           end
 
         # Observed state from get_resources() is under the 'parameters' key
         resource_state = resource['state'] || resource['parameters']
 
+        # Type from apply results is under the 'resource_type' key
+        resource_type = resource['type'] || resource['resource_type']
+
         init_hash = {
           'target'        => resource_target,
-          'type'          => resource['type'],
+          'type'          => resource_type,
           'title'         => resource['title'],
           'state'         => resource_state,
           'desired_state' => resource['desired_state'],
@@ -105,18 +131,14 @@ Puppet::Functions.create_function(:set_resources) do
         resource = call_function('new', type, init_hash)
       end
 
-      unless resource.target == inventory_target
+      unless resource.target == target
         file, line = Puppet::Pops::PuppetStack.top_of_stack
         raise Bolt::ValidationError, "Cannot set resource #{resource.reference} for target "\
-                                     "#{resource.target} on target #{inventory_target}. "\
+                                     "#{resource.target} on target #{target}. "\
                                      "#{Puppet::Util::Errors.error_location(file, line)}"
       end
 
-      inventory_target.set_resource(resource)
+      target.set_resource(resource)
     end
   end
-
-  def set_resource(target, resource)
-    set_resources(target, [resource])
-  end
 end

data/lib/bolt/analytics.rb

@@ -29,7 +29,7 @@ module Bolt
     def self.build_client
       logger = Logging.logger[self]
       begin
-        config_file = File.expand_path('~/.puppetlabs/bolt/analytics.yaml')
+        config_file = config_path(logger)
         config = load_config(config_file, logger)
       rescue ArgumentError
         config = { 'disabled' => true }
@@ -51,6 +51,25 @@ module Bolt
       NoopClient.new
     end
 
+    def self.config_path(logger)
+      path     = File.expand_path(File.join('~', '.puppetlabs', 'etc', 'bolt', 'analytics.yaml'))
+      old_path = File.expand_path(File.join('~', '.puppetlabs', 'bolt', 'analytics.yaml'))
+
+      if File.exist?(path)
+        if File.exist?(old_path)
+          message = "Detected analytics configuration files at '#{old_path}' and '#{path}'. Loading "\
+                    "analytics configuration from '#{path}'."
+          logger.warn(message)
+        end
+
+        path
+      elsif File.exist?(old_path)
+        old_path
+      else
+        path
+      end
+    end
+
     def self.load_config(filename, logger)
       if File.exist?(filename)
         YAML.load_file(filename)
@@ -59,7 +78,7 @@ module Bolt
           logger.warn <<~ANALYTICS
             Bolt collects data about how you use it. You can opt out of providing this data.
 
-            To disable analytics data collection, add this line to ~/.puppetlabs/bolt/analytics.yaml :
+            To disable analytics data collection, add this line to ~/.puppetlabs/etc/bolt/analytics.yaml :
               disabled: true
 
             Read more about what data Bolt collects and why here: