bolt 2.40.1 → 3.0.1

data/lib/bolt/outputter/rainbow.rb

@@ -63,12 +63,12 @@ module Bolt
       end
 
       def start_spin
-        return unless @spin
-        @spin = true
+        return unless @spin && @stream.isatty && !@spinning
+        @spinning = true
         @spin_thread = Thread.new do
           loop do
-            @stream.print(colorize(:rainbow, @pinwheel.rotate!.first + "\b"))
             sleep(0.1)
+            @stream.print(colorize(:rainbow, @pinwheel.rotate!.first + "\b"))
           end
         end
       end

data/lib/bolt/pal.rb

@@ -153,8 +153,10 @@ module Bolt
         Dir.children(path).select { |name| Puppet::Module.is_module_directory?(name, path) }
       end
       if modules.include?(project.name)
-        Bolt::Logger.warn_once("project shadows module",
-                               "The project '#{project.name}' shadows an existing module of the same name")
+        Bolt::Logger.warn_once(
+          "project_shadows_module",
+          "The project '#{project.name}' shadows an existing module of the same name"
+        )
       end
     end
 
@@ -357,19 +359,52 @@ module Bolt
       Bolt::Task.from_task_signature(task)
     end
 
+    def list_plans_with_cache(filter_content: false)
+      # Don't filter content yet, so that if users update their plan filters
+      # we don't need to refresh the cache
+      plan_names = list_plans(filter_content: false).map(&:first)
+      plan_cache = if @project
+                     Bolt::Util.read_optional_json_file(@project.plan_cache_file, 'Plan cache file')
+                   else
+                     {}
+                   end
+      updated = false
+
+      plan_list = plan_names.each_with_object([]) do |plan_name, list|
+        info = plan_cache[plan_name] || get_plan_info(plan_name, with_mtime: true)
+
+        # If the plan is a 'local' plan (in the project itself, or the
+        # modules/ directory) then verify it hasn't been updated since we
+        # cached it. If it has been updated, refresh the cache and use the
+        # new data.
+        if info['file'] &&
+           (File.mtime(info.dig('file', 'path')) <=> info.dig('file', 'mtime')) != 0
+          info = get_plan_info(plan_name, with_mtime: true)
+          updated = true
+          plan_cache[plan_name] = info
+        end
+
+        list << [plan_name] unless info['private']
+      end
+
+      File.write(@project.plan_cache_file, plan_cache.to_json) if updated
+
+      filter_content ? filter_content(plan_list, @project&.plans) : plan_list
+    end
+
     def list_plans(filter_content: false)
       in_bolt_compiler do |compiler|
         errors = []
         plans = compiler.list_plans(nil, errors).map { |plan| [plan.name] }.sort
         errors.each do |error|
-          @logger.warn(error.details['original_error'])
+          Bolt::Logger.warn("plan_load_error", error.details['original_error'])
         end
 
         filter_content ? filter_content(plans, @project&.plans) : plans
       end
     end
 
-    def get_plan_info(plan_name)
+    def get_plan_info(plan_name, with_mtime: false)
       plan_sig = in_bolt_compiler do |compiler|
         compiler.plan_signature(plan_name)
       end
@@ -412,16 +447,28 @@ module Bolt
             params[name]['default_value'] = defaults[name] if defaults.key?(name)
             params[name]['description'] = param.text unless param.text.empty?
           else
-            @logger.warn("The documented parameter '#{name}' does not exist in plan signature")
+            Bolt::Logger.warn(
+              "missing_plan_parameter",
+              "The documented parameter '#{name}' does not exist in signature for plan '#{plan.name}'"
+            )
           end
         end
 
-        {
-          'name' => plan_name,
+        privie = plan.tag(:private)&.text
+        unless privie.nil? || %w[true false].include?(privie.downcase)
+          msg = "Plan #{plan_name} key 'private' must be a boolean, received: #{privie}"
+          raise Bolt::Error.new(msg, 'bolt/invalid-plan')
+        end
+
+        pp_info = {
+          'name'        => plan_name,
           'description' => description,
-          'parameters' => parameters,
-          'module' => mod
+          'parameters'  => parameters,
+          'module'      => mod
         }
+        pp_info.merge!({ 'private' => privie&.downcase == 'true' }) unless privie.nil?
+        pp_info.merge!(get_plan_mtime(plan.file)) if with_mtime
+        pp_info
 
       # If it's a YAML plan, fall back to limited data
       else
@@ -444,12 +491,32 @@ module Bolt
           params[name]['default_value'] = param.value unless param.value.nil?
           params[name]['description'] = param.description if param.description
         end
-        {
-          'name' => plan_name,
+
+        yaml_info = {
+          'name'        => plan_name,
           'description' => plan.description,
-          'parameters' => parameters,
-          'module' => mod
+          'parameters'  => parameters,
+          'module'      => mod
         }
+        yaml_info.merge!({ 'private' => plan.private }) unless plan.private.nil?
+        yaml_info.merge!(get_plan_mtime(yaml_path)) if with_mtime
+        yaml_info
+      end
+    end
+
+    def get_plan_mtime(path)
+      # If the plan is from the project modules/ directory, or is in the
+      # project itself, include the last mtime of the file so we can compare
+      # if the plan has been updated since it was cached.
+      if @project &&
+         File.exist?(path) &&
+         (path.include?(File.join(@project.path, 'modules')) ||
+          path.include?(@project.plans_path.to_s))
+
+        { 'file' => { 'mtime' => File.mtime(path),
+                      'path' => path } }
+      else
+        {}
       end
     end
 
@@ -490,16 +557,28 @@ module Bolt
       end
     end
 
-    def generate_types
+    def generate_types(cache: false)
       require 'puppet/face/generate'
       in_bolt_compiler do
         generator = Puppet::Generate::Type
         inputs = generator.find_inputs(:pcore)
         FileUtils.mkdir_p(@resource_types)
+        cache_plan_info if @project && cache
         generator.generate(inputs, @resource_types, true)
       end
     end
 
+    def cache_plan_info
+      # plan_name is an array here
+      plans_info = list_plans(filter_content: false).map do |plan_name,|
+        data = get_plan_info(plan_name, with_mtime: true)
+        { plan_name => data }
+      end.reduce({}, :merge)
+
+      FileUtils.touch(@project.plan_cache_file)
+      File.write(@project.plan_cache_file, plans_info.to_json)
+    end
+
     def run_task(task_name, targets, params, executor, inventory, description = nil)
       in_task_compiler(executor, inventory) do |compiler|
         params = params.merge('_bolt_api_call' => true, '_catch_errors' => true)

data/lib/bolt/pal/yaml_plan.rb

@@ -6,10 +6,10 @@ require 'bolt/pal/yaml_plan/step'
 module Bolt
   class PAL
     class YamlPlan
-      PLAN_KEYS = Set['parameters', 'steps', 'return', 'version', 'description']
+      PLAN_KEYS = Set['parameters', 'private', 'steps', 'return', 'version', 'description']
       VAR_NAME_PATTERN = /\A[a-z_][a-z0-9_]*\z/.freeze
 
-      attr_reader :name, :parameters, :steps, :return, :description
+      attr_reader :name, :parameters, :private, :steps, :return, :description
 
       def initialize(name, plan)
         # Top-level plan keys aren't allowed to be Puppet code, so force them
@@ -30,6 +30,12 @@ module Bolt
           Parameter.new(param, definition)
         end.freeze
 
+        @private = plan['private']
+        unless @private.nil? || @private.is_a?(TrueClass) || @private.is_a?(FalseClass)
+          msg = "Plan #{@name} key 'private' must be a boolean, received: #{@private.inspect}"
+          raise Bolt::Error.new(msg, "bolt/invalid-plan")
+        end
+
         # Validate top level plan keys
         top_level_keys = plan.keys.to_set
         unless PLAN_KEYS.superset?(top_level_keys)

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

@@ -24,7 +24,7 @@ module Bolt
 
         def task_step(scope, step)
           task = step['task']
-          targets = step['targets'] || step['target']
+          targets = step['targets']
           description = step['description']
           params = step['parameters'] || {}
 
@@ -48,7 +48,7 @@ module Bolt
 
         def script_step(scope, step)
           script = step['script']
-          targets = step['targets'] || step['target']
+          targets = step['targets']
           description = step['description']
           arguments = step['arguments'] || []
 
@@ -64,7 +64,7 @@ module Bolt
 
         def command_step(scope, step)
           command = step['command']
-          targets = step['targets'] || step['target']
+          targets = step['targets']
           description = step['description']
 
           args = [command, targets]
@@ -73,9 +73,9 @@ module Bolt
         end
 
         def upload_step(scope, step)
-          source = step['upload'] || step['source']
+          source = step['upload']
           destination = step['destination']
-          targets = step['targets'] || step['target']
+          targets = step['targets']
           description = step['description']
 
           args = [source, destination, targets]
@@ -86,7 +86,7 @@ module Bolt
         def download_step(scope, step)
           source = step['download']
           destination = step['destination']
-          targets = step['targets'] || step['target']
+          targets = step['targets']
           description = step['description']
 
           args = [source, destination, targets]
@@ -99,7 +99,7 @@ module Bolt
         end
 
         def resources_step(scope, step)
-          targets = step['targets'] || step['target']
+          targets = step['targets']
 
           # TODO: Only call apply_prep when needed
           scope.call_function('apply_prep', targets)
@@ -154,18 +154,6 @@ module Bolt
         # 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)
-          if plan.steps.any? { |step| step.body.key?('target') }
-            msg = "The 'target' parameter for YAML plan steps is deprecated and will be removed "\
-                  "in a future version of Bolt. Use the 'targets' parameter instead."
-            Bolt::Logger.deprecation_warning("Using 'target' parameter for YAML plan steps, not 'targets'", msg)
-          end
-
-          if plan.steps.any? { |step| step.body.key?('source') }
-            msg = "The 'source' parameter for YAML plan upload steps is deprecated and will be removed "\
-                  "in a future version of Bolt. Use the 'upload' parameter instead."
-            Bolt::Logger.deprecation_warning("Using 'source' parameter for YAML upload steps, not 'upload'", msg)
-          end
-
           plan_result = closure_scope.with_local_scope(args_hash) do |scope|
             plan.steps.each do |step|
               step_result = dispatch_step(scope, step)

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

@@ -9,19 +9,17 @@ module Bolt
         attr_reader :name, :type, :body, :targets
 
         def self.allowed_keys
-          Set['name', 'description', 'target', 'targets']
+          Set['name', 'description', 'targets']
         end
 
         STEP_KEYS = %w[
           command
-          destination
           download
           eval
           message
           plan
           resources
           script
-          source
           task
           upload
         ].freeze
@@ -34,13 +32,7 @@ module Bolt
           when 1
             type = type_keys.first
           else
-            if [Set['source', 'destination'], Set['upload', 'destination']].include?(type_keys.to_set)
-              type = 'upload'
-            elsif type_keys.to_set == Set['download', 'destination']
-              type = 'download'
-            else
-              raise step_error("Multiple action keys detected: #{type_keys.inspect}", step_body['name'], step_number)
-            end
+            raise step_error("Multiple action keys detected: #{type_keys.inspect}", step_body['name'], step_number)
           end
 
           step_class = const_get("Bolt::PAL::YamlPlan::Step::#{type.capitalize}")
@@ -51,7 +43,7 @@ module Bolt
         def initialize(step_body)
           @name = step_body['name']
           @description = step_body['description']
-          @targets = step_body['targets'] || step_body['target']
+          @targets = step_body['targets']
           @body = step_body
         end
 
@@ -96,19 +88,6 @@ module Bolt
           # Ensure all required keys are present
           missing_keys = required_keys - body.keys
 
-          # Handle cases where steps with a required 'targets' key are using the deprecated
-          # 'target' key instead.
-          # TODO: Remove this when 'target' is removed
-          if body.include?('target')
-            missing_keys -= ['targets']
-          end
-
-          # Handle cases where upload step uses deprecated 'source' key instead of 'upload'
-          # TODO: Remove when 'source' is removed
-          if body.include?('source')
-            missing_keys -= ['upload']
-          end
-
           if missing_keys.any?
             error_message = "The #{step_type.inspect} step requires: #{missing_keys.to_a.inspect} key(s)"
             err = step_error(error_message, body['name'], step_number)

data/lib/bolt/pal/yaml_plan/step/upload.rb

@@ -6,7 +6,7 @@ module Bolt
       class Step
         class Upload < Step
           def self.allowed_keys
-            super + Set['source', 'destination', 'upload']
+            super + Set['destination', 'upload']
           end
 
           def self.required_keys
@@ -15,7 +15,7 @@ module Bolt
 
           def initialize(step_body)
             super
-            @source = step_body['upload'] || step_body['source']
+            @source = step_body['upload']
             @destination = step_body['destination']
           end
 

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

@@ -30,6 +30,7 @@ module Bolt
           plan_string = String.new('')
           plan_string << "# #{plan_object.description}\n" if plan_object.description
           plan_string << "# WARNING: This is an autogenerated plan. It may not behave as expected.\n"
+          plan_string << "# @private #{plan_object.private}\n" unless plan_object.private.nil?
           plan_string << "#{param_descriptions}\n" unless param_descriptions.empty?
 
           plan_string << "plan #{plan_object.name}("
@@ -64,7 +65,11 @@ module Bolt
             raise Bolt::FileError.new(msg, @plan_path)
           end
 
-          Bolt::PAL::YamlPlan::Loader.from_string(@modulename, file_contents, @plan_path)
+          begin
+            Bolt::PAL::YamlPlan::Loader.from_string(@modulename, file_contents, @plan_path)
+          rescue Puppet::PreformattedError, StandardError => e
+            raise PALError.from_preformatted_error(e)
+          end
         end
 
         def validate_path

data/lib/bolt/plugin.rb

@@ -139,7 +139,7 @@ module Bolt
       plugins
     end
 
-    RUBY_PLUGINS = %w[task prompt env_var puppetdb].freeze
+    RUBY_PLUGINS = %w[task prompt env_var puppetdb puppet_connect_data].freeze
     BUILTIN_PLUGINS = %w[task terraform pkcs7 prompt vault aws_inventory puppetdb azure_inventory
                          yaml env_var gcloud_inventory].freeze
     DEFAULT_PLUGIN_HOOKS = { 'puppet_library' => { 'plugin' => 'puppet_agent', 'stop_service' => true } }.freeze
@@ -170,7 +170,7 @@ module Bolt
     end
 
     def modules
-      @modules ||= Bolt::Module.discover(@pal.full_modulepath)
+      @modules ||= Bolt::Module.discover(@pal.full_modulepath, @config.project)
     end
 
     def add_plugin(plugin)
@@ -297,7 +297,7 @@ module Bolt
     def resolve_single_reference(reference)
       plugin_cache = if cache?(reference)
                        cache = Bolt::Plugin::Cache.new(reference,
-                                                       @config.project.cache_file,
+                                                       @config.project.plugin_cache_file,
                                                        @config.plugin_cache)
                        entry = cache.read_and_clean_cache
                        return entry unless entry.nil?

data/lib/bolt/plugin/cache.rb

@@ -7,11 +7,11 @@ require 'bolt/util'
 module Bolt
   class Plugin
     class Cache
-      attr_reader :reference, :cache_file, :default_config, :id
+      attr_reader :reference, :plugin_cache_file, :default_config, :id
 
-      def initialize(reference, cache_file, default_config)
+      def initialize(reference, plugin_cache_file, default_config)
         @reference = reference
-        @cache_file = cache_file
+        @plugin_cache_file = plugin_cache_file
         @default_config = default_config
       end
 
@@ -32,21 +32,21 @@ module Bolt
           unmodified = false if expired
           expired
         end
-        File.write(cache_file, cache.to_json) unless cache.empty? || unmodified
+        File.write(plugin_cache_file, cache.to_json) unless cache.empty? || unmodified
 
         cache.dig(id, 'result')
       end
 
       private def cache
-        @cache ||= Bolt::Util.read_optional_json_file(@cache_file, 'cache')
+        @cache ||= Bolt::Util.read_optional_json_file(@plugin_cache_file, 'cache')
       end
 
       def write_cache(result)
         cache.merge!({ id => { 'result' => result,
                                'mtime' => Time.now,
                                'ttl' => ttl } })
-        FileUtils.touch(cache_file)
-        File.write(cache_file, cache.to_json)
+        FileUtils.touch(plugin_cache_file)
+        File.write(plugin_cache_file, cache.to_json)
       end
 
       def validate