bolt 2.38.0 → 3.0.0

data/lib/bolt/project_manager.rb

@@ -166,10 +166,11 @@ module Bolt
     # Migrates the project-level configuration file to the latest version.
     #
     private def migrate_config
-      migrator = ConfigMigrator.new(@outputter)
+      migrator   = ConfigMigrator.new(@outputter)
+      configfile = @config.project.path + 'bolt.yaml'
 
       migrator.migrate(
-        @config.project.config_file,
+        configfile,
         @config.project.project_file,
         @config.inventoryfile || @config.project.inventory_file,
         @config.project.backup_dir
@@ -194,7 +195,7 @@ module Bolt
 
       migrator.migrate(
         @config.project,
-        @config.modulepath
+        @config.modulepath[0...-1]
       )
     end
   end

data/lib/bolt/project_manager/module_migrator.rb

@@ -6,19 +6,20 @@ module Bolt
   class ProjectManager
     class ModuleMigrator < Migrator
       def migrate(project, configured_modulepath)
-        return true unless project.modules.nil?
+        return true if project.managed_moduledir.exist?
 
         @outputter.print_message "Migrating project modules\n\n"
 
         config            = project.project_file
         puppetfile        = project.puppetfile
         managed_moduledir = project.managed_moduledir
-        modulepath        = [(project.path + 'modules').to_s,
+        new_modulepath    = [(project.path + 'modules').to_s]
+        old_modulepath    = [(project.path + 'modules').to_s,
                              (project.path + 'site-modules').to_s,
                              (project.path + 'site').to_s]
 
         # Notify user to manually migrate modules if using non-default modulepath
-        if configured_modulepath != modulepath
+        if configured_modulepath != new_modulepath && configured_modulepath != old_modulepath
           @outputter.print_action_step(
             "Project has a non-default configured modulepath, unable to automatically "\
             "migrate project modules. To migrate project modules manually, see "\
@@ -27,10 +28,10 @@ module Bolt
           true
         # Migrate modules from Puppetfile
         elsif File.exist?(puppetfile)
-          migrate_modules_from_puppetfile(config, puppetfile, managed_moduledir, modulepath)
+          migrate_modules_from_puppetfile(config, puppetfile, managed_moduledir, old_modulepath)
         # Migrate modules to updated modulepath
         else
-          consolidate_modules(modulepath)
+          consolidate_modules(old_modulepath)
           update_project_config([], config)
         end
       end

data/lib/bolt/rerun.rb

@@ -49,7 +49,7 @@ module Bolt
         end
       end
     rescue StandardError => e
-      Bolt::Logger.warn_once('unwriteable_file', "Failed to save result to #{@path}: #{e.message}")
+      Bolt::Logger.warn_once("unwriteable_file", "Failed to save result to #{@path}: #{e.message}")
     end
   end
 end

data/lib/bolt/shell/bash.rb

@@ -299,7 +299,7 @@ module Bolt
           if target.options['cleanup']
             dir.delete
           else
-            @logger.warn("Skipping cleanup of tmpdir #{dir}")
+            Bolt::Logger.warn("skip_cleanup", "Skipping cleanup of tmpdir #{dir}")
           end
         end
       end

data/lib/bolt/shell/bash/tmpdir.rb

@@ -48,7 +48,10 @@ module Bolt
         def delete
           result = @shell.execute(['rm', '-rf', @path], sudoable: true, run_as: @owner)
           if result.exit_code != 0
-            @logger.warn("Failed to clean up tmpdir '#{@path}': #{result.stderr.string}")
+            Bolt::Logger.warn(
+              "fail_cleanup",
+              "Failed to clean up tmpdir '#{@path}': #{result.stderr.string}"
+            )
           end
           # For testing
           result.stderr.string

data/lib/bolt/shell/powershell.rb

@@ -23,11 +23,10 @@ module Bolt
           # This lets us know how many targets have Powershell 2, and lets the
           # user know how many targets they have with PS2
           msg = "Detected PowerShell 2 on one or more targets.\nPowerShell 2 "\
-            "is deprecated, and support will be removed in Bolt 3.0. See "\
-            "bolt-debug.log or run with '--log-level debug' to see the full "\
+            "is unsupported. See bolt-debug.log or run with '--log-level debug' to see the full "\
             "list of targets with PowerShell 2."
 
-          Bolt::Logger.deprecation_warning("PowerShell 2", msg)
+          Bolt::Logger.deprecate_once("powershell_2", msg)
           @logger.debug("Detected PowerShell 2 on #{target}.")
         end
       end
@@ -163,7 +162,7 @@ module Bolt
           if target.options['cleanup']
             rmdir(@tmpdir)
           else
-            @logger.warn("Skipping cleanup of tmpdir '#{@tmpdir}'")
+            Bolt::Logger.warn("Skipping cleanup of tmpdir '#{@tmpdir}'", "skip_cleanup")
           end
         end
       end

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

@@ -47,17 +47,18 @@ module Bolt
     # the value's type, the value is passed off to an individual
     # validation method for the value's type.
     #
-    private def validate_value(value, definition)
-      definition = @schema.dig(:definitions, definition[:_ref]) if definition[:_ref]
+    private def validate_value(value, definition, plugin_supported = false)
+      definition       = @schema.dig(:definitions, definition[:_ref]) if definition[:_ref]
+      plugin_supported = definition[:_plugin] if definition.key?(:_plugin)
 
-      return if plugin_reference?(value, definition)
+      return if plugin_reference?(value, plugin_supported)
       return unless valid_type?(value, definition)
 
       case value
       when Hash
-        validate_hash(value, definition)
+        validate_hash(value, definition, plugin_supported)
       when Array
-        validate_array(value, definition)
+        validate_array(value, definition, plugin_supported)
       when String
         validate_string(value, definition)
       when Numeric
@@ -69,7 +70,7 @@ module Bolt
     # This will enumerate each key-value pair in the hash and validate each
     # value individually.
     #
-    private def validate_hash(value, definition)
+    private def validate_hash(value, definition, plugin_supported)
       properties = definition[:properties] ? definition[:properties].keys : []
 
       if definition[:properties] && definition[:additionalProperties].nil?
@@ -86,9 +87,9 @@ module Bolt
 
         if properties.include?(key)
           check_deprecated(key, definition[:properties][key])
-          validate_value(val, definition[:properties][key])
-        elsif definition[:additionalProperties]
-          validate_value(val, definition[:additionalProperties])
+          validate_value(val, definition[:properties][key], plugin_supported)
+        elsif definition[:additionalProperties].is_a?(Hash)
+          validate_value(val, definition[:additionalProperties], plugin_supported)
         end
       ensure
         @path.pop
@@ -99,7 +100,7 @@ module Bolt
     # This will enumerate the items in the array and validate each item
     # individually.
     #
-    private def validate_array(value, definition)
+    private def validate_array(value, definition, plugin_supported)
       if definition[:uniqueItems] && value.size != value.uniq.size
         @errors << "Value at '#{path}' must not include duplicate elements"
         return
@@ -109,7 +110,7 @@ module Bolt
 
       value.each_with_index do |item, index|
         @path.push(index)
-        validate_value(item, definition[:items])
+        validate_value(item, definition[:items], plugin_supported)
       ensure
         @path.pop
       end
@@ -146,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
 
@@ -159,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
 
@@ -168,9 +169,9 @@ module Bolt
     # plugin reference but cannot be one according to the schema, then this will
     # log an error.
     #
-    private def plugin_reference?(value, definition)
+    private def plugin_reference?(value, plugin_supported)
       if value.is_a?(Hash) && value.key?('_plugin')
-        unless definition[:_plugin]
+        unless plugin_supported
           @errors << "Value at '#{path}' is a plugin reference, which is unsupported at "\
                       "this location"
         end