bolt 2.13.0 → 2.18.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0fd39267ed3b68619b0e9f40f8415446d0061ebe5367650d50e6e5ab3229d8b9
-  data.tar.gz: b4d88aee228eeccb8c9ed8ebcb6221960c3197f1ac43d4a195e5c3d4a8833a9d
+  metadata.gz: 87eb513700afc2d9fefa9f2497e8718f0e14e511ea2004c59eecfcb19e41bdbc
+  data.tar.gz: 499d4c8a1a3c0d4b883d83f6478019467a44999beba83712ce49a30ee2ff1fc8
 SHA512:
-  metadata.gz: 0a225b8e5e695da5268aa9b748c57c06944046ebc4865d76ec8d0f446ec37d0584f2fca2d19ee9910cd5ed5555f8cc15910693a66e813b0b0e6aab48dd9e8789
-  data.tar.gz: 6d2853adea34d7b0006ac0d643f1af8cda862903618fde138cf64079d9b9c433815537c7f70c483fcbb00287462f4762285d5e8e5147b6327c7c5c71346412b4
+  metadata.gz: 6046f666fe9bccc4df2a70b191582b14b834063caf31987c1131e7e7c57ac9280e0bf76d719f9b82f27f5de7205b744a2dd3d485f53e9aa867661b824a5b0945
+  data.tar.gz: fc77aa2acd93b4aab739f468a2aa6a6a2da2c9c10bbc4927005f60aeb20148ecb29884d6f2c6cf86bf84d76af276a55f1a8588734157444ab5844c0b9d9878c9

data/Puppetfile

@@ -33,7 +33,7 @@ mod 'puppetlabs-ruby_plugin_helper', '0.1.0'
 mod 'puppetlabs-aws_inventory', '0.5.0'
 mod 'puppetlabs-azure_inventory', '0.3.0'
 mod 'puppetlabs-gcloud_inventory', '0.1.1'
-mod 'puppetlabs-pkcs7', '0.1.0'
+mod 'puppetlabs-pkcs7', '0.1.1'
 mod 'puppetlabs-terraform', '0.5.0'
 mod 'puppetlabs-vault', '0.3.0'
 mod 'puppetlabs-yaml', '0.2.0'

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

@@ -25,6 +25,7 @@ Puppet::Functions.create_function(:add_facts) do
 
     inventory = Puppet.lookup(:bolt_inventory)
     executor = Puppet.lookup(:bolt_executor)
+    # Send Analytics Report
     executor.report_function_call(self.class.name)
 
     inventory.add_facts(target, facts)

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

@@ -29,6 +29,7 @@ Puppet::Functions.create_function(:add_to_group) do
 
     inventory = Puppet.lookup(:bolt_inventory)
     executor = Puppet.lookup(:bolt_executor)
+    # Send Analytics Report
     executor.report_function_call(self.class.name)
 
     inventory.add_to_group(inventory.get_targets(targets), group)

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

@@ -13,10 +13,13 @@ require 'bolt/task'
 # > **Note:** Not available in apply block
 Puppet::Functions.create_function(:apply_prep) do
   # @param targets A pattern or array of patterns identifying a set of targets.
+  # @param options Options hash.
+  # @option options [Array] _required_modules An array of modules to sync to the target.
   # @example Prepare targets by name.
   #   apply_prep('target1,target2')
   dispatch :apply_prep do
     param 'Boltlib::TargetSpec', :targets
+    optional_param 'Hash[String, Data]', :options
   end
 
   def script_compiler
@@ -60,18 +63,34 @@ Puppet::Functions.create_function(:apply_prep) do
     @executor ||= Puppet.lookup(:bolt_executor)
   end
 
-  def apply_prep(target_spec)
+  def apply_prep(target_spec, options = {})
     unless Puppet[:tasks]
       raise Puppet::ParseErrorWithIssue
         .from_issue_and_stack(Bolt::PAL::Issues::PLAN_OPERATION_NOT_SUPPORTED_WHEN_COMPILING, action: 'apply_prep')
     end
 
+    options = options.transform_keys { |k| k.sub(/^_/, '').to_sym }
+
     applicator = Puppet.lookup(:apply_executor)
 
     executor.report_function_call(self.class.name)
 
     targets = inventory.get_targets(target_spec)
 
+    required_modules = options[:required_modules].nil? ? nil : Array(options[:required_modules])
+    if required_modules&.any?
+      Puppet.debug("Syncing only required modules: #{required_modules.join(',')}.")
+    end
+
+    # Gather facts, including custom facts
+    plugins = applicator.build_plugin_tarball do |mod|
+      next unless required_modules.nil? || required_modules.include?(mod.name)
+      search_dirs = []
+      search_dirs << mod.plugins if mod.plugins?
+      search_dirs << mod.pluginfacts if mod.pluginfacts?
+      search_dirs
+    end
+
     executor.log_action('install puppet and gather facts', targets) do
       executor.without_default_logging do
         # Skip targets that include the puppet-agent feature, as we know an agent will be available.
@@ -109,14 +128,6 @@ Puppet::Functions.create_function(:apply_prep) do
           need_install_targets.each { |target| set_agent_feature(target) }
         end
 
-        # Gather facts, including custom facts
-        plugins = applicator.build_plugin_tarball do |mod|
-          search_dirs = []
-          search_dirs << mod.plugins if mod.plugins?
-          search_dirs << mod.pluginfacts if mod.pluginfacts?
-          search_dirs
-        end
-
         task = applicator.custom_facts_task
         arguments = { 'plugins' => Puppet::Pops::Types::PSensitiveType::Sensitive.new(plugins) }
         results = executor.run_task(targets, task, arguments)

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

@@ -37,6 +37,7 @@ Puppet::Functions.create_function(:catch_errors) do
     end
 
     executor = Puppet.lookup(:bolt_executor)
+    # Send Analytics Report
     executor.report_function_call(self.class.name)
 
     begin

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

@@ -17,6 +17,7 @@ Puppet::Functions.create_function(:facts) do
     inventory = Puppet.lookup(:bolt_inventory)
     # Bolt executor not expected when invoked from apply block
     executor = Puppet.lookup(:bolt_executor) { nil }
+    # Send Analytics Report
     executor&.report_function_call(self.class.name)
 
     inventory.facts(target)

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

@@ -40,6 +40,7 @@ Puppet::Functions.create_function(:fail_plan) do
     end
 
     executor = Puppet.lookup(:bolt_executor)
+    # Send Analytics Report
     executor.report_function_call(self.class.name)
 
     raise Bolt::PlanFailure.new(msg, kind || 'bolt/plan-failure', details, issue_code)

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

@@ -58,6 +58,7 @@ Puppet::Functions.create_function(:get_resources) do
       end
     end
 
+    # Send Analytics Report
     executor.report_function_call(self.class.name)
 
     targets = inventory.get_targets(target_spec)

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

@@ -21,6 +21,7 @@ Puppet::Functions.create_function(:get_target) do
     inventory = Puppet.lookup(:bolt_inventory)
     # Bolt executor not expected when invoked from apply block
     executor = Puppet.lookup(:bolt_executor) { nil }
+    # Send Analytics Report
     executor&.report_function_call(self.class.name)
 
     unless inventory.version > 1

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

@@ -27,6 +27,7 @@ Puppet::Functions.create_function(:get_targets) do
     inventory = Puppet.lookup(:bolt_inventory)
     # Bolt executor not expected when invoked from apply block
     executor = Puppet.lookup(:bolt_executor) { nil }
+    # Send Analytics Report
     executor&.report_function_call(self.class.name)
 
     inventory.get_targets(names)

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

@@ -20,6 +20,7 @@ Puppet::Functions.create_function(:puppetdb_fact) do
     puppetdb_client = Puppet.lookup(:bolt_pdb_client)
     # Bolt executor not expected when invoked from apply block
     executor = Puppet.lookup(:bolt_executor) { nil }
+    # Send Analytics Report
     executor&.report_function_call(self.class.name)
 
     puppetdb_client.facts_for_node(certnames)

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

@@ -22,6 +22,7 @@ Puppet::Functions.create_function(:puppetdb_query) do
     puppetdb_client = Puppet.lookup(:bolt_pdb_client)
     # Bolt executor not expected when invoked from apply block
     executor = Puppet.lookup(:bolt_executor) { nil }
+    # Send Analytics Report
     executor&.report_function_call(self.class.name)
 
     puppetdb_client.make_query(query)

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

@@ -31,6 +31,7 @@ Puppet::Functions.create_function(:remove_from_group) do
 
     inventory = Puppet.lookup(:bolt_inventory)
     executor = Puppet.lookup(:bolt_executor)
+    # Send Analytics Report
     executor.report_function_call(self.class.name)
 
     inventory.remove_from_group(inventory.get_targets(target), group)

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

@@ -33,6 +33,7 @@ Puppet::Functions.create_function(:resolve_references) do
     end
 
     executor = Puppet.lookup(:bolt_executor)
+    # Send Analytics Report
     executor.report_function_call(self.class.name)
 
     plugins = Puppet.lookup(:bolt_inventory).plugins

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

@@ -0,0 +1,53 @@
+# 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 }
+    # Send Analytics Report
+    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_command.rb

@@ -13,6 +13,7 @@ Puppet::Functions.create_function(:run_command) do
   # @param options A hash of additional options.
   # @option options [Boolean] _catch_errors Whether to catch raised errors.
   # @option options [String] _run_as User to run as using privilege escalation.
+  # @option options [Hash] _env_vars Map of environment variables to set
   # @return A list of results, one entry per target.
   # @example Run a command on targets
   #   run_command('hostname', $targets, '_catch_errors' => true)
@@ -30,6 +31,7 @@ Puppet::Functions.create_function(:run_command) do
   # @param options A hash of additional options.
   # @option options [Boolean] _catch_errors Whether to catch raised errors.
   # @option options [String] _run_as User to run as using privilege escalation.
+  # @option options [Hash] _env_vars Map of environment variables to set
   # @return A list of results, one entry per target.
   # @example Run a command on targets
   #   run_command('hostname', $targets, 'Get hostname')
@@ -57,6 +59,7 @@ Puppet::Functions.create_function(:run_command) do
     executor = Puppet.lookup(:bolt_executor)
     inventory = Puppet.lookup(:bolt_inventory)
 
+    # Send Analytics Report
     executor.report_function_call(self.class.name)
 
     # Ensure that given targets are all Target instances

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

@@ -64,10 +64,11 @@ Puppet::Functions.create_function(:run_plan, Puppet::Functions::InternalFunction
     # Bolt calls this function internally to trigger plans from the CLI. We
     # don't want to count those invocations.
     unless options[:bolt_api_call]
+      # Send Analytics Report
       executor.report_function_call(self.class.name)
     end
 
-    # Report bundled content, this should capture plans run from both CLI and Plans
+    # Send Analytics Report for bundled content, this should capture plans run from both CLI and Plans
     executor.report_bundled_content('Plan', plan_name)
 
     loaders = closure_scope.compiler.loaders
@@ -187,7 +188,11 @@ Puppet::Functions.create_function(:run_plan, Puppet::Functions::InternalFunction
     params.each_with_object({}) do |(name, value), acc|
       model = models[name]
 
-      if sensitive_type?(model.type_expr)
+      # 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')

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

@@ -11,8 +11,9 @@ Puppet::Functions.create_function(:run_script, Puppet::Functions::InternalFuncti
   # @param targets A pattern identifying zero or more targets. See {get_targets} for accepted patterns.
   # @param options A hash of additional options.
   # @option options [Array[String]] arguments An array of arguments to be passed to the script.
-  # @option args [Boolean] _catch_errors Whether to catch raised errors.
-  # @option args [String] _run_as User to run as using privilege escalation.
+  # @option options [Boolean] _catch_errors Whether to catch raised errors.
+  # @option options [String] _run_as User to run as using privilege escalation.
+  # @option options [Hash] _env_vars Map of environment variables to set
   # @return A list of results, one entry per target.
   # @example Run a local script on Linux targets as 'root'
   #   run_script('/var/tmp/myscript', $targets, '_run_as' => 'root')
@@ -33,8 +34,9 @@ Puppet::Functions.create_function(:run_script, Puppet::Functions::InternalFuncti
   # @param description A description to be output when calling this function.
   # @param options A hash of additional options.
   # @option options [Array[String]] arguments An array of arguments to be passed to the script.
-  # @option args [Boolean] _catch_errors Whether to catch raised errors.
-  # @option args [String] _run_as User to run as using privilege escalation.
+  # @option options [Boolean] _catch_errors Whether to catch raised errors.
+  # @option options [String] _run_as User to run as using privilege escalation.
+  # @option options [Hash] _env_vars Map of environment variables to set
   # @return A list of results, one entry per target.
   # @example Run a script
   #   run_script('/var/tmp/myscript', $targets, 'Downloading my application')
@@ -64,6 +66,7 @@ Puppet::Functions.create_function(:run_script, Puppet::Functions::InternalFuncti
     executor = Puppet.lookup(:bolt_executor)
     inventory = Puppet.lookup(:bolt_inventory)
 
+    # Send Analytics Report
     executor.report_function_call(self.class.name)
 
     found = Puppet::Parser::Files.find_file(script, scope.compiler.environment)

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

@@ -64,10 +64,11 @@ Puppet::Functions.create_function(:run_task) do
     # Bolt calls this function internally to trigger tasks from the CLI. We
     # don't want to count those invocations.
     unless options[:bolt_api_call]
+      # Send Analytics Report
       executor.report_function_call(self.class.name)
     end
 
-    # Report bundled content, this should capture tasks run from both CLI and Plans
+    # Report Analytics for bundled content, this should capture tasks run from both CLI and Plans
     executor.report_bundled_content('Task', task_name)
 
     # Ensure that given targets are all Target instances

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

@@ -33,6 +33,7 @@ Puppet::Functions.create_function(:set_config) do
 
     inventory = Puppet.lookup(:bolt_inventory)
     executor = Puppet.lookup(:bolt_executor)
+    # Send Analytics Report
     executor.report_function_call(self.class.name)
 
     unless inventory.version > 1

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

@@ -33,6 +33,7 @@ Puppet::Functions.create_function(:set_feature) do
 
     inventory = Puppet.lookup(:bolt_inventory)
     executor = Puppet.lookup(:bolt_executor)
+    # Send Analytics Report
     executor.report_function_call(self.class.name)
 
     inventory.set_feature(target, feature, value)

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

@@ -94,6 +94,7 @@ Puppet::Functions.create_function(:set_resources) do
         )
     end
 
+    # Send Analytics Report
     Puppet.lookup(:bolt_executor).report_function_call(self.class.name)
     inventory = Puppet.lookup(:bolt_inventory)
 

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

@@ -27,6 +27,7 @@ Puppet::Functions.create_function(:set_var) do
 
     inventory = Puppet.lookup(:bolt_inventory)
     executor = Puppet.lookup(:bolt_executor)
+    # Send Analytics Report
     executor.report_function_call(self.class.name)
 
     var_hash = { key => value }

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

@@ -67,6 +67,7 @@ Puppet::Functions.create_function(:upload_file, Puppet::Functions::InternalFunct
     executor = Puppet.lookup(:bolt_executor)
     inventory = Puppet.lookup(:bolt_inventory)
 
+    # Send Analytics Report
     executor.report_function_call(self.class.name)
 
     found = Puppet::Parser::Files.find_file(source, scope.compiler.environment)

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

@@ -21,6 +21,7 @@ Puppet::Functions.create_function(:vars) do
     inventory = Puppet.lookup(:bolt_inventory)
     # Bolt executor not expected when invoked from apply block
     executor = Puppet.lookup(:bolt_executor) { nil }
+    # Send Analytics Report
     executor&.report_function_call(self.class.name)
 
     inventory.vars(target)

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

@@ -33,6 +33,7 @@ Puppet::Functions.create_function(:wait_until_available) do
     executor = Puppet.lookup(:bolt_executor)
     inventory = Puppet.lookup(:bolt_inventory)
 
+    # Send Analytics Report
     executor.report_function_call(self.class.name)
 
     # Ensure that given targets are all Target instances

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

@@ -29,6 +29,7 @@ Puppet::Functions.create_function(:without_default_logging) do
     end
 
     executor = Puppet.lookup(:bolt_executor)
+    # Send Analytics Report
     executor.report_function_call(self.class.name)
 
     executor.without_default_logging do

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

@@ -31,6 +31,7 @@ Puppet::Functions.create_function(:write_file) do
     end
 
     executor = Puppet.lookup(:bolt_executor)
+    # Send Analytics Report
     executor.report_function_call(self.class.name)
 
     inventory = Puppet.lookup(:bolt_inventory)

data/bolt-modules/ctrl/lib/puppet/functions/ctrl/do_until.rb

@@ -20,7 +20,9 @@ Puppet::Functions.create_function(:'ctrl::do_until') do
   end
 
   def do_until(options = { 'limit' => 0 })
+    # Send Analytics Report
     Puppet.lookup(:bolt_executor) {}&.report_function_call(self.class.name)
+
     limit = options['limit']
     i = 0
     until (x = yield)

data/bolt-modules/ctrl/lib/puppet/functions/ctrl/sleep.rb

@@ -11,7 +11,9 @@ Puppet::Functions.create_function(:'ctrl::sleep') do
   end
 
   def sleeper(period)
+    # Send Analytics Report
     Puppet.lookup(:bolt_executor) {}&.report_function_call(self.class.name)
+
     sleep(period)
     nil
   end

data/bolt-modules/file/lib/puppet/functions/file/exists.rb

@@ -9,7 +9,7 @@ Puppet::Functions.create_function(:'file::exists', Puppet::Functions::InternalFu
   # @example Check a file on disk
   #   file::exists('/tmp/i_dumped_this_here')
   # @example check a file from the modulepath
-  #   file::exists('example/files/VERSION')
+  #   file::exists('example/VERSION')
   dispatch :exists do
     scope_param
     required_param 'String', :filename
@@ -17,6 +17,7 @@ Puppet::Functions.create_function(:'file::exists', Puppet::Functions::InternalFu
   end
 
   def exists(scope, filename)
+    # Send Analytics Report
     Puppet.lookup(:bolt_executor) {}&.report_function_call(self.class.name)
     found = Puppet::Parser::Files.find_file(filename, scope.compiler.environment)
     found ? Puppet::FileSystem.exist?(found) : false