bolt 2.40.1 → 3.0.1

data/lib/bolt/shell/powershell/snippets.rb

@@ -70,12 +70,17 @@ module Bolt
           def ps_task(path, arguments)
             <<~PS
             $private:tempArgs = Get-ContentAsJson (
-              $utf8.GetString([System.Convert]::FromBase64String('#{Base64.encode64(JSON.dump(arguments))}'))
+              [System.Text.Encoding]::UTF8.GetString([System.Convert]::FromBase64String('#{Base64.encode64(JSON.dump(arguments))}'))
             )
             $allowedArgs = (Get-Command "#{path}").Parameters.Keys
             $private:taskArgs = @{}
             $private:tempArgs.Keys | ? { $allowedArgs -contains $_ } | % { $private:taskArgs[$_] = $private:tempArgs[$_] }
-            try { & "#{path}" @taskArgs } catch { Write-Error $_.Exception; exit 1 }
+            try {
+              & "#{path}" @taskArgs
+            } catch {
+              $Host.UI.WriteErrorLine("[$($_.FullyQualifiedErrorId)] Exception $($_.InvocationInfo.PositionMessage).`n$($_.Exception.Message)");
+              exit 1;
+            }
             PS
           end
 
@@ -102,151 +107,11 @@ module Bolt
             "${boltBaseDir}\\hiera\\lib;" +
             $ENV:RUBYLIB
 
-            Add-Type -AssemblyName System.ServiceModel.Web, System.Runtime.Serialization
-            $utf8 = [System.Text.Encoding]::UTF8
-
-            function Write-Stream {
-            PARAM(
-              [Parameter(Position=0)] $stream,
-              [Parameter(ValueFromPipeline=$true)] $string
-            )
-            PROCESS {
-              $bytes = $utf8.GetBytes($string)
-              $stream.Write( $bytes, 0, $bytes.Length )
-            }
-            }
-
-            function Convert-JsonToXml {
-            PARAM([Parameter(ValueFromPipeline=$true)] [string[]] $json)
-            BEGIN {
-              $mStream = New-Object System.IO.MemoryStream
-            }
-            PROCESS {
-              $json | Write-Stream -Stream $mStream
-            }
-            END {
-              $mStream.Position = 0
-              try {
-                $jsonReader = [System.Runtime.Serialization.Json.JsonReaderWriterFactory]::CreateJsonReader($mStream,[System.Xml.XmlDictionaryReaderQuotas]::Max)
-                $xml = New-Object Xml.XmlDocument
-                $xml.Load($jsonReader)
-                $xml
-              } finally {
-                $jsonReader.Close()
-                $mStream.Dispose()
-              }
-            }
-            }
-
-            Function ConvertFrom-Xml {
-            [CmdletBinding(DefaultParameterSetName="AutoType")]
-            PARAM(
-              [Parameter(ValueFromPipeline=$true,Mandatory=$true,Position=1)] [Xml.XmlNode] $xml,
-              [Parameter(Mandatory=$true,ParameterSetName="ManualType")] [Type] $Type,
-              [Switch] $ForceType
-            )
-            PROCESS{
-              if (Get-Member -InputObject $xml -Name root) {
-                return $xml.root.Objects | ConvertFrom-Xml
-              } elseif (Get-Member -InputObject $xml -Name Objects) {
-                return $xml.Objects | ConvertFrom-Xml
-              }
-              $propbag = @{}
-              foreach ($name in Get-Member -InputObject $xml -MemberType Properties | Where-Object{$_.Name -notmatch "^(__.*|type)$"} | Select-Object -ExpandProperty name) {
-                Write-Debug "$Name Type: $($xml.$Name.type)" -Debug:$false
-                $propbag."$Name" = Convert-Properties $xml."$name"
-              }
-              if (!$Type -and $xml.HasAttribute("__type")) { $Type = $xml.__Type }
-              if ($ForceType -and $Type) {
-                try {
-                  $output = New-Object $Type -Property $propbag
-                } catch {
-                  $output = New-Object PSObject -Property $propbag
-                  $output.PsTypeNames.Insert(0, $xml.__type)
-                }
-              } elseif ($propbag.Count -ne 0) {
-                $output = New-Object PSObject -Property $propbag
-                if ($Type) {
-                  $output.PsTypeNames.Insert(0, $Type)
-                }
-              }
-              return $output
-            }
-            }
-
-            Function Convert-Properties {
-            PARAM($InputObject)
-            switch ($InputObject.type) {
-              "object" {
-                return (ConvertFrom-Xml -Xml $InputObject)
-              }
-              "string" {
-                $MightBeADate = $InputObject.get_InnerText() -as [DateTime]
-                ## Strings that are actually dates (*grumble* JSON is crap)
-                if ($MightBeADate -and $propbag."$Name" -eq $MightBeADate.ToString("G")) {
-                  return $MightBeADate
-                } else {
-                  return $InputObject.get_InnerText()
-                }
-              }
-              "number" {
-                $number = $InputObject.get_InnerText()
-                if ($number -eq ($number -as [int])) {
-                  return $number -as [int]
-                } elseif ($number -eq ($number -as [double])) {
-                  return $number -as [double]
-                } else {
-                  return $number -as [decimal]
-                }
-              }
-              "boolean" {
-                return [bool]::parse($InputObject.get_InnerText())
-              }
-              "null" {
-                return $null
-              }
-              "array" {
-                [object[]]$Items = $(foreach( $item in $InputObject.GetEnumerator() ) {
-                  Convert-Properties $item
-                })
-                return $Items
-              }
-              default {
-                return $InputObject
-              }
-            }
-            }
-
-            Function ConvertFrom-Json2 {
-            [CmdletBinding()]
-            PARAM(
-              [Parameter(ValueFromPipeline=$true,Mandatory=$true,Position=1)] [string] $InputObject,
-              [Parameter(Mandatory=$true)] [Type] $Type,
-              [Switch] $ForceType
-            )
-            PROCESS {
-              $null = $PSBoundParameters.Remove("InputObject")
-              [Xml.XmlElement]$xml = (Convert-JsonToXml $InputObject).Root
-              if ($xml) {
-                if ($xml.Objects) {
-                  $xml.Objects.Item.GetEnumerator() | ConvertFrom-Xml @PSBoundParameters
-                } elseif ($xml.Item -and $xml.Item -isnot [System.Management.Automation.PSParameterizedProperty]) {
-                  $xml.Item | ConvertFrom-Xml @PSBoundParameters
-                } else {
-                  $xml | ConvertFrom-Xml @PSBoundParameters
-                }
-              } else {
-                Write-Error "Failed to parse JSON with JsonReader" -Debug:$false
-              }
-            }
-            }
-
             function ConvertFrom-PSCustomObject
             {
             PARAM([Parameter(ValueFromPipeline = $true)] $InputObject)
             PROCESS {
               if ($null -eq $InputObject) { return $null }
-
               if ($InputObject -is [System.Collections.IEnumerable] -and $InputObject -isnot [string]) {
                 $collection = @(
                   foreach ($object in $InputObject) { ConvertFrom-PSCustomObject $object }
@@ -273,13 +138,8 @@ module Bolt
               [Parameter(Mandatory = $true)] $Text,
               [Parameter(Mandatory = $false)] [Text.Encoding] $Encoding = [Text.Encoding]::UTF8
             )
-
-            # using polyfill cmdlet on PS2, so pass type info
-            if ($PSVersionTable.PSVersion -lt [Version]'3.0') {
-              $Text | ConvertFrom-Json2 -Type PSObject | ConvertFrom-PSCustomObject
-            } else {
-              $Text | ConvertFrom-Json | ConvertFrom-PSCustomObject
-            }
+          
+            $Text | ConvertFrom-Json | ConvertFrom-PSCustomObject
             }
             PS
           end

data/lib/bolt/task.rb

@@ -149,7 +149,7 @@ module Bolt
       if unknown_keys.any?
         msg = "Metadata for task '#{@name}' contains unknown keys: #{unknown_keys.join(', ')}."
         msg += " This could be a typo in the task metadata or may result in incorrect behavior."
-        @logger.warn(msg)
+        Bolt::Logger.warn("unknown_task_metadata_keys", msg)
       end
     end
   end

data/lib/bolt/transport/docker/connection.rb

@@ -140,10 +140,10 @@ module Bolt
             if @target.options['cleanup']
               _, stderr, exitcode = execute('rm', '-rf', dir, {})
               if exitcode != 0
-                @logger.warn("Failed to clean up tmpdir '#{dir}': #{stderr}")
+                Bolt::Logger.warn("fail_cleanup", "Failed to clean up tmpdir '#{dir}': #{stderr}")
               end
             else
-              @logger.warn("Skipping cleanup of tmpdir '#{dir}'")
+              Bolt::Logger.warn("skip_cleanup", "Skipping cleanup of tmpdir '#{dir}'")
             end
           end
         end

data/lib/bolt/transport/local.rb

@@ -11,18 +11,10 @@ module Bolt
       end
 
       def with_connection(target)
-        if target.transport_config['bundled-ruby'] || target.name == 'localhost'
+        if target.transport_config['bundled-ruby']
           target.set_local_defaults
         end
 
-        if target.name != 'localhost' &&
-           !target.transport_config.key?('bundled-ruby')
-          msg = "The local transport will default to using Bolt's Ruby interpreter and "\
-            "setting the 'puppet-agent' feature in Bolt 3.0. Enable or disable these "\
-            "defaults by setting 'bundled-ruby' in the local transport config."
-          Bolt::Logger.warn_once('local default config', msg)
-        end
-
         yield Connection.new(target)
       end
     end

data/lib/bolt/transport/orch/connection.rb

@@ -21,7 +21,7 @@ module Bolt
 
           @logger = logger
           @key = self.class.get_key(opts)
-          client_opts = opts.slice('token-file', 'cacert', 'job-poll-interval', 'job-poll-timeout')
+          client_opts = opts.slice('token-file', 'cacert', 'job-poll-interval', 'job-poll-timeout', 'read-timeout')
 
           if opts['service-url']
             uri = Addressable::URI.parse(opts['service-url'])

data/lib/bolt/transport/ssh.rb

@@ -23,8 +23,7 @@ module Bolt
 
       def with_connection(target)
         if target.transport_config['ssh-command'] && !target.transport_config['native-ssh']
-          Bolt::Logger.warn_once("ssh-command and native-ssh conflict",
-                                 "native-ssh must be true to use ssh-command")
+          Bolt::Logger.warn_once("native_ssh_disabled", "native-ssh must be true to use ssh-command")
         end
 
         conn = if target.transport_config['native-ssh']

data/lib/bolt/transport/ssh/connection.rb

@@ -34,7 +34,7 @@ module Bolt
             begin
               Bolt::Util.validate_file('ssh key', target.options['private-key'])
             rescue Bolt::FileError => e
-              @logger.warn(e.msg)
+              Bolt::Logger.warn("invalid_ssh_key", e.msg)
             end
           end
         end

data/lib/bolt/validator.rb

@@ -147,7 +147,7 @@ module Bolt
         message += " at '#{path}'" if @path.any?
         message += " at #{@location}" if @location
         message += "."
-        @warnings << message
+        @warnings << { id: 'unknown_option', msg: message }
       end
     end
 
@@ -160,7 +160,7 @@ module Bolt
         message  = "Option '#{path}' "
         message += "at #{@location} " if @location
         message += "is deprecated. #{definition[:_deprecation]}"
-        @deprecations << { option: key, message: message }
+        @deprecations << { id: "#{key}_option", msg: message }
       end
     end
 

data/lib/bolt/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Bolt
-  VERSION = '2.40.1'
+  VERSION = '3.0.1'
 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.40.1
+  version: 3.0.1
 platform: ruby
 authors:
 - Puppet
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-12-18 00:00:00.000000000 Z
+date: 2021-02-16 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:
@@ -626,7 +635,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.0.8
 signing_key: 
 specification_version: 4
 summary: Execute commands remotely over SSH and WinRM