bolt 2.12.0 → 2.13.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c36dc3edc9637ac83eab0734e6143961ff7c97f4cbc0866ce8e1b5a0b5d318c2
-  data.tar.gz: c52ea03e1354361836c6d76c108735e2f8525aa5e8132f87cf895b5a0f2d802d
+  metadata.gz: 0fd39267ed3b68619b0e9f40f8415446d0061ebe5367650d50e6e5ab3229d8b9
+  data.tar.gz: b4d88aee228eeccb8c9ed8ebcb6221960c3197f1ac43d4a195e5c3d4a8833a9d
 SHA512:
-  metadata.gz: ded5edab2a28a3a50d2eb9c9d2a1ccad43eae0272b09a609b219a78516bd32f8bff0e35751a95629d4d918cf3a22883d47a90c5c0f402c5aeedaffaab5dfc546
-  data.tar.gz: acde1204c706c49926a33b074da9b5262d1e6d11d27137bec55d7ea80a3ec7e009a1defc309e1f9a7fe824db9c0d4ce92963ddc6d3ae3d2619550fc5c4164ed3
+  metadata.gz: 0a225b8e5e695da5268aa9b748c57c06944046ebc4865d76ec8d0f446ec37d0584f2fca2d19ee9910cd5ed5555f8cc15910693a66e813b0b0e6aab48dd9e8789
+  data.tar.gz: 6d2853adea34d7b0006ac0d643f1af8cda862903618fde138cf64079d9b9c433815537c7f70c483fcbb00287462f4762285d5e8e5147b6327c7c5c71346412b4

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

@@ -14,7 +14,8 @@ require 'open3'
 
 module Bolt
   class Applicator
-    def initialize(inventory, executor, modulepath, plugin_dirs, pdb_client, hiera_config, max_compiles, apply_settings)
+    def initialize(inventory, executor, modulepath, plugin_dirs, project,
+                   pdb_client, hiera_config, max_compiles, apply_settings)
       # lazy-load expensive gem code
       require 'concurrent'
 
@@ -22,6 +23,7 @@ module Bolt
       @executor = executor
       @modulepath = modulepath
       @plugin_dirs = plugin_dirs
+      @project = project
       @pdb_client = pdb_client
       @hiera_config = hiera_config ? validate_hiera_config(hiera_config) : nil
       @apply_settings = apply_settings || {}
@@ -188,6 +190,7 @@ module Bolt
       scope = {
         code_ast: ast,
         modulepath: @modulepath,
+        project: @project.to_h,
         pdb_config: @pdb_client.config.to_hash,
         hiera_config: @hiera_config,
         plan_vars: plan_vars,

data/lib/bolt/catalog.rb

@@ -58,6 +58,8 @@ module Bolt
       target = request['target']
       pdb_client = Bolt::PuppetDB::Client.new(Bolt::PuppetDB::Config.new(request['pdb_config']))
       options = request['puppet_config'] || {}
+      project = request['project'] || {}
+      bolt_project = Struct.new(:name, :path).new(project['name'], project['path']) unless project.empty?
       with_puppet_settings(request['hiera_config']) do
         Puppet[:rich_data] = true
         Puppet[:node_name_value] = target['name']
@@ -67,7 +69,8 @@ module Bolt
         Puppet::Pal.in_tmp_environment('bolt_catalog', env_conf) do |pal|
           inv = Bolt::ApplyInventory.new(request['config'])
           Puppet.override(bolt_pdb_client: pdb_client,
-                          bolt_inventory: inv) do
+                          bolt_inventory: inv,
+                          bolt_project: bolt_project) do
             Puppet.lookup(:pal_current_node).trusted_data = target['trusted']
             pal.with_catalog_compiler do |compiler|
               # Deserializing needs to happen inside the catalog compiler so

data/lib/bolt/config.rb

@@ -47,9 +47,7 @@ module Bolt
                                     "targets on the command line and from plans.",
       "log"                      => "The configuration of the logfile output. Configuration can be set for "\
                                     "`console` and the path to a log file, such as `~/.puppetlabs/bolt/debug.log`.",
-      "modulepath"               => "The module path for loading tasks and plan code. This is either an array "\
-                                    "of directories or a string containing a list of directories separated by the "\
-                                    "OS-specific PATH separator.",
+      "modulepath"               => "An array of directories that Bolt loads content (e.g. plans and tasks) from.",
       "plugin_hooks"             => "Which plugins a specific hook should use.",
       "plugins"                  => "A map of plugins and their configuration data.",
       "puppetdb"                 => "A map containing options for configuring the Bolt PuppetDB client.",

data/lib/bolt/pal.rb

@@ -190,6 +190,7 @@ module Bolt
           # versions of "core" types, which are already present on the agent,
           # but may cause issues on Puppet 5 agents.
           @original_modulepath,
+          @project,
           pdb_client,
           @hiera_config,
           @max_compiles,

data/lib/bolt/resource_instance.rb

@@ -30,8 +30,7 @@ module Bolt
       @target        = resource_hash['target']
       @type          = resource_hash['type'].to_s.capitalize
       @title         = resource_hash['title']
-      # get_resources() returns observed state under the 'parameters' key
-      @state         = resource_hash['state'] || resource_hash['parameters'] || {}
+      @state         = resource_hash['state'] || {}
       @desired_state = resource_hash['desired_state'] || {}
       @events        = resource_hash['events'] || []
     end
@@ -89,6 +88,10 @@ module Bolt
     end
     alias to_s reference
 
+    def [](attribute)
+      @state[attribute]
+    end
+
     def add_event(event)
       @events << event
     end

data/lib/bolt/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bolt
 version: !ruby/object:Gem::Version
-  version: 2.12.0
+  version: 2.13.0
 platform: ruby
 authors:
 - Puppet
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-06-01 00:00:00.000000000 Z
+date: 2020-06-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: addressable