bolt 3.1.0 → 3.3.0

data/lib/bolt/config/transport/lxd.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+require 'bolt/error'
+require 'bolt/config/transport/base'
+
+module Bolt
+  class Config
+    module Transport
+      class LXD < Base
+        OPTIONS = %w[
+          cleanup
+          tmpdir
+        ].freeze
+
+        DEFAULTS = {
+          'cleanup' => true
+        }.freeze
+      end
+    end
+  end
+end

data/lib/bolt/config/transport/options.rb

@@ -32,7 +32,7 @@ module Bolt
           "cleanup" => {
             type: [TrueClass, FalseClass],
             description: "Whether to clean up temporary files created on targets. When running commands on a target, "\
-                         "Bolt may create temporary files. After completing the command, these files are "\
+                         "Bolt might create temporary files. After completing the command, these files are "\
                          "automatically deleted. This value can be set to 'false' if you wish to leave these "\
                          "temporary files on the target.",
             _plugin: true,

data/lib/bolt/executor.rb

@@ -4,6 +4,7 @@
 require 'English'
 require 'json'
 require 'logging'
+require 'pathname'
 require 'set'
 require 'bolt/analytics'
 require 'bolt/result'
@@ -15,6 +16,7 @@ require 'bolt/transport/ssh'
 require 'bolt/transport/winrm'
 require 'bolt/transport/orch'
 require 'bolt/transport/local'
+require 'bolt/transport/lxd'
 require 'bolt/transport/docker'
 require 'bolt/transport/remote'
 require 'bolt/yarn'
@@ -25,6 +27,7 @@ module Bolt
     winrm: Bolt::Transport::WinRM,
     pcp: Bolt::Transport::Orch,
     local: Bolt::Transport::Local,
+    lxd: Bolt::Transport::LXD,
     docker: Bolt::Transport::Docker,
     remote: Bolt::Transport::Remote
   }.freeze
@@ -39,7 +42,6 @@ module Bolt
                    modified_concurrency = false)
       # lazy-load expensive gem code
       require 'concurrent'
-
       @analytics = analytics
       @logger = Bolt::Logger.logger(self)
 
@@ -121,8 +123,8 @@ module Bolt
     def queue_execute(targets)
       if @warn_concurrency && targets.length > @concurrency
         @warn_concurrency = false
-        msg = "The ulimit is low, which may cause file limit issues. Default concurrency has been set to "\
-              "'#{@concurrency}' to mitigate those issues, which may cause Bolt to run slow. "\
+        msg = "The ulimit is low, which might cause file limit issues. Default concurrency has been set to "\
+              "'#{@concurrency}' to mitigate those issues, which might cause Bolt to run slow. "\
               "Disable this warning by configuring ulimit using 'ulimit -n <limit>' in your shell "\
               "configuration, or by configuring Bolt's concurrency. "\
               "See https://puppet.com/docs/bolt/latest/bolt_known_issues.html for details."
@@ -231,6 +233,11 @@ module Bolt
       @analytics.report_bundled_content(mode, name)
     end
 
+    def report_file_source(plan_function, source)
+      label = Pathname.new(source).absolute? ? 'absolute' : 'module'
+      @analytics&.event('Plan', plan_function, label: label)
+    end
+
     def report_apply(statement_count, resource_counts)
       data = { statement_count: statement_count }
 

data/lib/bolt/logger.rb

@@ -91,6 +91,14 @@ module Bolt
       Logging.logger[:root].appenders.any?
     end
 
+    def self.stream
+      @stream
+    end
+
+    def self.stream=(stream)
+      @stream = stream
+    end
+
     # A helper to ensure the Logging library is always initialized with our
     # custom log levels before retrieving a Logger instance.
     def self.logger(name)

data/lib/bolt/module_installer.rb

@@ -45,7 +45,7 @@ module Bolt
       # specss. If that fails, fall back to resolving from project specs.
       # This prevents Bolt from modifying installed modules unless there is
       # a version conflict.
-      @outputter.print_action_step("Resolving module dependencies, this may take a moment")
+      @outputter.print_action_step("Resolving module dependencies, this might take a moment")
 
       @outputter.start_spin
       begin
@@ -156,7 +156,7 @@ module Bolt
         # If forcibly installing or if there is no Puppetfile, resolve
         # and write a Puppetfile.
         if force || !path.exist?
-          @outputter.print_action_step("Resolving module dependencies, this may take a moment")
+          @outputter.print_action_step("Resolving module dependencies, this might take a moment")
 
           # This doesn't use the block as it's more testable to just mock *_spin
           @outputter.start_spin

data/lib/bolt/module_installer/puppetfile.rb

@@ -36,7 +36,7 @@ module Bolt
           raise Bolt::ValidationError, <<~MSG
             Unable to parse Puppetfile #{path}:
             #{parsed.validation_errors.join("\n\n")}.
-            This may not be a Puppetfile managed by Bolt.
+            This Puppetfile might not be managed by Bolt.
           MSG
         end
 
@@ -106,7 +106,7 @@ module Bolt
 
           #{unsatisfied_specs.map(&:to_hash).to_yaml.lines.drop(1).join.chomp}
           
-          This may not be a Puppetfile managed by Bolt. To forcibly overwrite the
+          This Puppetfile might not be managed by Bolt. To forcibly overwrite the
           Puppetfile, run '#{command}'.
         MESSAGE
 

data/lib/bolt/module_installer/specs/forge_spec.rb

@@ -39,8 +39,8 @@ module Bolt
           unless (match = name.match(NAME_REGEX))
             raise Bolt::ValidationError,
                   "Invalid name for Forge module specification: #{name}. Name must match "\
-                  "'owner/name'. Owner segment may only include letters or digits. Name "\
-                  "segment must start with a lowercase letter and may only include lowercase "\
+                  "'owner/name'. Owner segment can only include letters or digits. Name "\
+                  "segment must start with a lowercase letter and can only include lowercase "\
                   "letters, digits, and underscores."
           end
 

data/lib/bolt/module_installer/specs/git_spec.rb

@@ -49,8 +49,8 @@ module Bolt
           unless (match = name.match(NAME_REGEX))
             raise Bolt::ValidationError,
                   "Invalid name for Git module specification: #{name}. Name must match "\
-                  "'name' or 'owner/name'. Owner segment may only include letters or digits. "\
-                  "Name segment must start with a lowercase letter and may only include "\
+                  "'name' or 'owner/name'. Owner segment can only include letters or digits. "\
+                  "Name segment must start with a lowercase letter and can only include "\
                   "lowercase letters, digits, and underscores."
           end
 

data/lib/bolt/outputter/human.rb

@@ -53,10 +53,21 @@ module Bolt
         string.sub(/\s\z/, '')
       end
 
+      # Wraps a string to the specified width. Lines only wrap
+      # at whitespace.
+      #
       def wrap(string, width = 80)
+        return string unless string.is_a?(String)
         string.gsub(/(.{1,#{width}})(\s+|\Z)/, "\\1\n")
       end
 
+      # Trims a string to a specified width, adding an ellipsis if it's longer.
+      #
+      def truncate(string, width = 80)
+        return string unless string.is_a?(String) && string.length > width
+        string.lines.first[0...width].gsub(/\s\w+\s*$/, '...')
+      end
+
       def handle_event(event)
         case event[:type]
         when :enable_default_output
@@ -218,11 +229,11 @@ module Bolt
         @stream.puts total_msg
       end
 
-      def print_table(results, padding_left = 0, padding_right = 3)
+      def format_table(results, padding_left = 0, padding_right = 3)
         # lazy-load expensive gem code
         require 'terminal-table'
 
-        @stream.puts Terminal::Table.new(
+        Terminal::Table.new(
           rows: results,
           style: {
             border_x: '',
@@ -238,10 +249,22 @@ module Bolt
 
       def print_tasks(tasks, modulepath)
         command = Bolt::Util.powershell? ? 'Get-BoltTask -Task <TASK NAME>' : 'bolt task show <TASK NAME>'
-        tasks.any? ? print_table(tasks) : print_message('No available tasks')
-        print_message("\nMODULEPATH:\n#{modulepath.join(File::PATH_SEPARATOR)}\n"\
-                        "\nUse '#{command}' to view "\
-                        "details and parameters for a specific task.")
+
+        tasks = tasks.map do |name, description|
+          description = truncate(description, 72)
+          [name, description]
+        end
+
+        @stream.puts colorize(:cyan, 'Tasks')
+        @stream.puts tasks.any? ? format_table(tasks, 2) : indent(2, 'No available tasks')
+        @stream.puts
+
+        @stream.puts colorize(:cyan, 'Modulepath')
+        @stream.puts indent(2, modulepath.join(File::PATH_SEPARATOR))
+        @stream.puts
+
+        @stream.puts colorize(:cyan, 'Additional information')
+        @stream.puts indent(2, "Use '#{command}' to view details and parameters for a specific task.")
       end
 
       # @param [Hash] task A hash representing the task
@@ -322,10 +345,22 @@ module Bolt
 
       def print_plans(plans, modulepath)
         command = Bolt::Util.powershell? ? 'Get-BoltPlan -Name <PLAN NAME>' : 'bolt plan show <PLAN NAME>'
-        plans.any? ? print_table(plans) : print_message('No available plans')
-        print_message("\nMODULEPATH:\n#{modulepath.join(File::PATH_SEPARATOR)}\n"\
-                        "\nUse '#{command}' to view "\
-                        "details and parameters for a specific plan.")
+
+        plans = plans.map do |name, description|
+          description = truncate(description, 72)
+          [name, description]
+        end
+
+        @stream.puts colorize(:cyan, 'Plans')
+        @stream.puts plans.any? ? format_table(plans, 2) : indent(2, 'No available plans')
+        @stream.puts
+
+        @stream.puts colorize(:cyan, 'Modulepath')
+        @stream.puts indent(2, modulepath.join(File::PATH_SEPARATOR))
+        @stream.puts
+
+        @stream.puts colorize(:cyan, 'Additional information')
+        @stream.puts indent(2, "Use '#{command}' to view details and parameters for a specific plan.")
       end
 
       def print_topics(topics)
@@ -359,7 +394,7 @@ module Bolt
               [m[:name], version]
             end
 
-            print_table(module_info, 2, 1)
+            @stream.puts format_table(module_info, 2, 1)
           end
 
           @stream.write("\n")
@@ -374,7 +409,7 @@ module Bolt
         targets += target_list[:adhoc].map { |target| [target.name, adhoc] }
 
         if targets.any?
-          print_table(targets, 0, 2)
+          @stream.puts format_table(targets, 0, 2)
           @stream.puts
         end
 

data/lib/bolt/pal.rb

@@ -385,7 +385,7 @@ module Bolt
           plan_cache[plan_name] = info
         end
 
-        list << [plan_name] unless info['private']
+        list << [plan_name, info['description']] unless info['private']
       end
 
       File.write(@project.plan_cache_file, plan_cache.to_json) if updated
@@ -446,7 +446,7 @@ module Bolt
             params[name] = { 'type' => param.types.first }
             params[name]['sensitive'] = param.types.first =~ /\ASensitive(\[.*\])?\z/ ? true : false
             params[name]['default_value'] = defaults[name] if defaults.key?(name)
-            params[name]['description'] = param.text unless param.text.empty?
+            params[name]['description'] = param.text if param.text && !param.text.empty?
           else
             Bolt::Logger.warn(
               "missing_plan_parameter",

data/lib/bolt/pal/yaml_plan.rb

@@ -73,8 +73,7 @@ module Bolt
       def duplicate_check(used_names, name, step_number)
         if used_names.include?(name)
           error_message = "Duplicate step name or parameter detected: #{name.inspect}"
-          err = Step.step_error(error_message, name, step_number)
-          raise Bolt::Error.new(err, "bolt/invalid-plan")
+          raise Step::StepError.new(error_message, name, step_number)
         end
       end
 

data/lib/bolt/pal/yaml_plan/evaluator.rb

@@ -12,153 +12,15 @@ module Bolt
           @evaluator = Puppet::Pops::Parser::EvaluatingParser.new
         end
 
-        def dispatch_step(scope, step)
-          step_body = evaluate_code_blocks(scope, step.body)
-
-          # Dispatch based on the step class name
-          step_type = step.class.name.split('::').last.downcase
-          method = "#{step_type}_step"
-
-          send(method, scope, step_body)
-        end
-
-        def task_step(scope, step)
-          task = step['task']
-          targets = step['targets']
-          description = step['description']
-          params = step['parameters'] || {}
-
-          args = if description
-                   [task, targets, description, params]
-                 else
-                   [task, targets, params]
-                 end
-
-          scope.call_function('run_task', args)
-        end
-
-        def plan_step(scope, step)
-          plan = step['plan']
-          parameters = step['parameters'] || {}
-
-          args = [plan, parameters]
-
-          scope.call_function('run_plan', args)
-        end
-
-        def script_step(scope, step)
-          script = step['script']
-          targets = step['targets']
-          description = step['description']
-          arguments = step['arguments'] || []
-
-          options = { 'arguments' => arguments }
-          args = if description
-                   [script, targets, description, options]
-                 else
-                   [script, targets, options]
-                 end
-
-          scope.call_function('run_script', args)
-        end
-
-        def command_step(scope, step)
-          command = step['command']
-          targets = step['targets']
-          description = step['description']
-
-          args = [command, targets]
-          args << description if description
-          scope.call_function('run_command', args)
-        end
-
-        def upload_step(scope, step)
-          source = step['upload']
-          destination = step['destination']
-          targets = step['targets']
-          description = step['description']
-
-          args = [source, destination, targets]
-          args << description if description
-          scope.call_function('upload_file', args)
-        end
-
-        def download_step(scope, step)
-          source = step['download']
-          destination = step['destination']
-          targets = step['targets']
-          description = step['description']
-
-          args = [source, destination, targets]
-          args << description if description
-          scope.call_function('download_file', args)
-        end
-
-        def eval_step(_scope, step)
-          step['eval']
-        end
-
-        def resources_step(scope, step)
-          targets = step['targets']
-
-          # TODO: Only call apply_prep when needed
-          scope.call_function('apply_prep', targets)
-          manifest = generate_manifest(step['resources'])
-
-          apply_manifest(scope, targets, manifest)
-        end
-
-        def message_step(scope, step)
-          scope.call_function('out::message', [step['message']])
-        end
-
-        def generate_manifest(resources)
-          # inspect returns the Ruby representation of the resource hashes,
-          # which happens to be the same as the Puppet representation
-          puppet_resources = resources.inspect
-
-          # Because the :tasks setting globally controls which mode the parser
-          # is in, we need to make this snippet of non-tasks manifest code
-          # parseable in tasks mode. The way to do that is by putting it in an
-          # apply statement and taking the body.
-          <<~MANIFEST
-          apply('placeholder') {
-            $resources = #{puppet_resources}
-            $resources.each |$res| {
-              Resource[$res['type']] { $res['title']:
-                * => $res['parameters'],
-              }
-            }
-
-            # Add relationships if there is more than one resource
-            if $resources.length > 1 {
-              ($resources.length - 1).each |$index| {
-                $lhs = $resources[$index]
-                $rhs = $resources[$index+1]
-                $lhs_resource = Resource[$lhs['type'] , $lhs['title']]
-                $rhs_resource = Resource[$rhs['type'] , $rhs['title']]
-                $lhs_resource -> $rhs_resource
-              }
-            }
-          }
-          MANIFEST
-        end
-
-        def apply_manifest(scope, targets, manifest)
-          ast = @evaluator.parse_string(manifest)
-          apply_block = ast.body.body
-          applicator = Puppet.lookup(:apply_executor)
-          applicator.apply([targets], apply_block, scope)
-        end
-
         # This is the method that Puppet calls to evaluate the plan. The name
         # makes more sense for .pp plans.
+        #
         def evaluate_block_with_bindings(closure_scope, args_hash, plan)
           plan_result = closure_scope.with_local_scope(args_hash) do |scope|
             plan.steps.each do |step|
-              step_result = dispatch_step(scope, step)
+              step_result = step.evaluate(scope, self)
 
-              scope.setvar(step.name, step_result) if step.name
+              scope.setvar(step.body['name'], step_result) if step.body['name']
             end
 
             evaluate_code_blocks(scope, plan.return)
@@ -168,6 +30,7 @@ module Bolt
         end
 
         # Recursively evaluate any EvaluableString instances in the object.
+        #
         def evaluate_code_blocks(scope, value)
           # XXX We should establish a local scope here probably
           case value
@@ -192,6 +55,7 @@ module Bolt
         # Occasionally the Closure will ask us to evaluate what it assumes are
         # AST objects. Because we've sidestepped the AST, they aren't, so just
         # return the values as already evaluated.
+        #
         def evaluate(value, _scope)
           value
         end