bolt 2.38.0 → 3.0.0

data/lib/bolt/version.rb

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

data/lib/bolt_server/config.rb

@@ -9,7 +9,7 @@ module BoltServer
     def config_keys
       super + %w[concurrency cache-dir file-server-conn-timeout
                  file-server-uri projects-dir environments-codedir
-                 environmentpath basemodulepath]
+                 environmentpath basemodulepath builtin-content-dir]
     end
 
     def env_keys

data/lib/bolt_server/schemas/partials/task.json

@@ -37,7 +37,7 @@
         },
         "input_method": {
           "type": "string",
-          "enum": ["stdin", "environment", "powershell"],
+          "enum": ["stdin", "environment", "powershell", "both"],
           "description": "What input method should be used to pass params to the task"
         }
       }

data/lib/bolt_server/transport_app.rb

@@ -280,7 +280,8 @@ module BoltServer
         bolt_config = config_from_project(versioned_project)
         modulepath_object = Bolt::Config::Modulepath.new(
           bolt_config.modulepath,
-          boltlib_path: [PE_BOLTLIB_PATH, Bolt::Config::Modulepath::BOLTLIB_PATH]
+          boltlib_path: [PE_BOLTLIB_PATH, Bolt::Config::Modulepath::BOLTLIB_PATH],
+          builtin_content_path: @config['builtin-content-dir']
         )
         pal = Bolt::PAL.new(modulepath_object, nil, nil, nil, nil, nil, bolt_config.project)
         context = {
@@ -351,7 +352,7 @@ module BoltServer
     end
 
     def allowed_helper(metadata, allowlist)
-      allowed = allowlist.nil? || allowlist.include?(metadata['name']) ? true : false
+      allowed = allowlist.nil? || allowlist.include?(metadata['name'])
       metadata.merge({ 'allowed' => allowed })
     end
 

data/libexec/bolt_catalog

@@ -56,7 +56,7 @@ when "compile"
               else
                 e.message
               end
-    puts({ message: message }.to_json)
+    puts({ message: message, backtrace: e.backtrace }.to_json)
     exit 1
   rescue StandardError => e
     puts({ message: e.message }.to_json)

data/modules/aggregate/plans/count.pp

@@ -1,3 +1,24 @@
+# @summary
+#   Run a task, command, or script on targets and aggregate the results as
+#   a count of targets for each value of a key.
+#
+# This plan accepts an action and a list of targets. The action can be the name
+# of a task, a script, or a command to run. It will run the action on the
+# targets and aggregate the key/value pairs in each Result into a hash, mapping
+# the keys to a hash of each distinct value and how many targets returned that
+# value for the key.
+#
+# @param command
+#   The command to run. Mutually exclusive with script and task.
+# @param script
+#   The path to the script to run. Mutually exclusive with command and task.
+# @param task
+#   The name of the task to run. Mutually exclusive with command and script.
+# @param targets
+#   The list of targets to run the action on.
+# @param params
+#   A hash of parameters and options to pass to the `run_*` function
+#   associated with the action (e.g. run_task).
 plan aggregate::count(
   Optional[String[0]] $task = undef,
   Optional[String[0]] $command = undef,

data/modules/aggregate/plans/targets.pp

@@ -1,3 +1,24 @@
+# @summary
+#   Run a task, command, or script on targets and aggregate the results as
+#   the list of targets for each value of a key in the results.
+#
+# This plan accepts an action and a list of targets. The action can be the name
+# of a task, a script, or a command to run. It will run the action on the
+# targets and aggregate the key/value pairs in each Result into a hash, mapping
+# the keys to a hash of each distinct value and a list of targets returning that
+# value.
+#
+# @param command
+#   The command to run. Mutually exclusive with script and task.
+# @param script
+#   The path to the script to run. Mutually exclusive with command and task.
+# @param task
+#   The name of the task to run. Mutually exclusive with command and script.
+# @param targets
+#   The list of targets to run the action on.
+# @param params
+#   A hash of parameters and options to pass to the `run_*` function
+#   associated with the action (e.g. run_task).
 plan aggregate::targets(
   Optional[String[0]] $task = undef,
   Optional[String[0]] $command = undef,

data/modules/puppet_connect/plans/test_input_data.pp

@@ -0,0 +1,31 @@
+# @summary
+#   Tests that the provided Puppet Connect input data is complete, meaning that all consuming inventory targets are connectable.
+#
+# This plan should only be used as part of the copy-pastable "test input data"
+# workflow specified in the Puppet Connect docs.
+#
+# @param targets
+#   The set of targets to test. Usually this should be 'all', the default.
+#
+# @return ResultSet the result of invoking the 'is connectable?' query on all
+# the targets. Note that this query currently consists of running the 'echo'
+# command.
+#
+plan puppet_connect::test_input_data(TargetSpec $targets = 'all') {
+  $targs = get_targets($targets)
+  $targs.each |$target| {
+    if $target.transport != 'ssh' and $target.transport != 'winrm' {
+      fail_plan("Inventory contains target ${target} with unsupported transport, must be ssh or winrm")
+    }
+    if $target.transport == 'ssh' {
+      # Disable SSH autoloading to prevent false positive results
+      # (input data is wrong but target is still connectable due
+      # to autoloaded config)
+      set_config($target, ['ssh', 'load-config'], false)
+    }
+  }
+  # The SSH/WinRM transports will report an 'unknown host' error for targets where
+  # 'host' is unknown so run_command's implementation will take care of raising that
+  # error for us.
+  return run_command('echo Connected', $targs)
+}

data/modules/puppetdb_fact/plans/init.pp

@@ -1,3 +1,13 @@
+# @summary
+#   Collect facts for the specified targets from PuppetDB and store them
+#   on the Targets.
+#
+# This plan accepts a list of targets to collect facts for from the configured
+# PuppetDB connection. After collecting facts, they are stored on each target's
+# Target object. The updated facts can then be accessed using `$target.facts`.
+#
+# @param targets
+#   The targets to collect facts for.
 plan puppetdb_fact(TargetSpec $targets) {
   $targs = get_targets($targets)
   $certnames = $targs.map |$target| { $target.host }

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bolt
 version: !ruby/object:Gem::Version
-  version: 2.38.0
+  version: 3.0.0
 platform: ruby
 authors:
 - Puppet
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-12-14 00:00:00.000000000 Z
+date: 2021-02-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: addressable
@@ -66,6 +66,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: ffi
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 1.14.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 1.14.0
 - !ruby/object:Gem::Dependency
   name: hiera-eyaml
   requirement: !ruby/object:Gem::Requirement
@@ -170,14 +184,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.4'
+        version: '0.5'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.4'
+        version: '0.5'
 - !ruby/object:Gem::Dependency
   name: puppet
   requirement: !ruby/object:Gem::Requirement
@@ -198,14 +212,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.4'
+        version: '0.5'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.4'
+        version: '0.5'
 - !ruby/object:Gem::Dependency
   name: puppet-resource_api
   requirement: !ruby/object:Gem::Requirement
@@ -311,9 +325,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '1.14'
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: 2.2.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -321,9 +332,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '1.14'
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: 2.2.0
 - !ruby/object:Gem::Dependency
   name: octokit
   requirement: !ruby/object:Gem::Requirement
@@ -342,16 +350,16 @@ dependencies:
   name: puppetlabs_spec_helper
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - "<="
       - !ruby/object:Gem::Version
-        version: '2.7'
+        version: 2.15.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - "<="
       - !ruby/object:Gem::Version
-        version: '2.7'
+        version: 2.15.0
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -515,6 +523,7 @@ files:
 - lib/bolt/plugin/env_var.rb
 - lib/bolt/plugin/module.rb
 - lib/bolt/plugin/prompt.rb
+- lib/bolt/plugin/puppet_connect_data.rb
 - lib/bolt/plugin/puppetdb.rb
 - lib/bolt/plugin/task.rb
 - lib/bolt/project.rb
@@ -600,12 +609,12 @@ files:
 - modules/aggregate/lib/puppet/functions/aggregate/nodes.rb
 - modules/aggregate/lib/puppet/functions/aggregate/targets.rb
 - modules/aggregate/plans/count.pp
-- modules/aggregate/plans/nodes.pp
 - modules/aggregate/plans/targets.pp
 - modules/canary/lib/puppet/functions/canary/merge.rb
 - modules/canary/lib/puppet/functions/canary/random_split.rb
 - modules/canary/lib/puppet/functions/canary/skip.rb
 - modules/canary/plans/init.pp
+- modules/puppet_connect/plans/test_input_data.pp
 - modules/puppetdb_fact/plans/init.pp
 homepage: https://github.com/puppetlabs/bolt
 licenses:

data/modules/aggregate/plans/nodes.pp

@@ -1,36 +0,0 @@
-plan aggregate::nodes(
-  Optional[String[0]] $task = undef,
-  Optional[String[0]] $command = undef,
-  Optional[String[0]] $script = undef,
-  TargetSpec $nodes,
-  Hash[String, Data] $params = {}
-) {
-
-  # Validation
-  $type_count = [$task, $command, $script].reduce(0) |$acc, $v| {
-    if ($v) {
-      $acc + 1
-    } else {
-      $acc
-    }
-  }
-
-  if ($type_count == 0) {
-    fail_plan("Must specify a command, script, or task to run", 'aggregate/invalid-params')
-  }
-
-  if ($type_count > 1) {
-    fail_plan("Must specify only one command, script, or task to run", 'aggregate/invalid-params')
-  }
-
-  $res = if ($task) {
-    run_task($task, $nodes, $params)
-  } elsif ($command) {
-    run_command($command, $nodes, $params)
-  } elsif ($script) {
-    run_script($script, $nodes, $params)
-  }
-
-  return aggregate::nodes($res)
-}
-