bolt 3.16.1 → 3.17.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 71d383b473f9356ff41f574bb0abe4aea9a9f8c3ac5055a459acffe0da290af1
-  data.tar.gz: 00d10803d865a9d6f0cb6eb7162e4a17f619b88e6702b559e0153b3796d732d0
+  metadata.gz: '05192d9aa9b3da414b55a21bd75fe10238e8044eb49f75f92be7fac1d0576866'
+  data.tar.gz: 49302c6d080fda48080d5281c9480ce35a734caefa5be9f6f141aaea51f99b70
 SHA512:
-  metadata.gz: eaad9c12aab69e9d7c9f1d8b312623b8bcca4f26f983beb08b1d09c4568aafe0e430d639b88903df4e1a498a58c4c9d8add5d4b8b3930fe1dec3124bc15afad3
-  data.tar.gz: a05ec6c181fc6aa51c73ebfd928d73513d5506c1b0705bed4637bfa9490a6f1c010019c9209f7ed28c134f003a063ff6f4add490a55d658998f566d00c5ff017
+  metadata.gz: bd0966b7be3a7bba5a1bb0f040a2e8bd8c22708fa1a79492f04b8448037105ac66e12af74969787d3ab4efa69bfcd393c51168154c548d7d35f6f36fc6648c0c
+  data.tar.gz: e7f2741c6e7a2416ebbc61f7f008e1a550bde1897e906e53a8df0dc837cd4fcb0718c783f301cdbde1703ed95a65530cbad9e727ae5978a6c414988bc0206e23

data/lib/bolt/application.rb

@@ -2,6 +2,7 @@
 
 require 'benchmark'
 
+require 'bolt/plan_creator'
 require 'bolt/util'
 
 module Bolt
@@ -88,7 +89,7 @@ module Bolt
     # @param env_vars [Hash] Environment variables to set on the target.
     # @return [Bolt::ResultSet]
     #
-    def run_command(command, targets, env_vars: {})
+    def run_command(command, targets, env_vars: nil)
       targets = inventory.get_targets(targets)
 
       with_benchmark do
@@ -120,8 +121,7 @@ module Bolt
     # @return [Bolt::ResultSet]
     #
     def upload_file(source, destination, targets)
-      future  = executor.future&.fetch('file_paths', false)
-      source  = find_file(source, future)
+      source  = find_file(source)
       targets = inventory.get_targets(targets)
 
       Bolt::Util.validate_file('source file', source, true)
@@ -327,11 +327,26 @@ module Bolt
     #
     # @param name [String] The name of the new plan.
     # @param puppet [Boolean] Create a Puppet language plan.
+    # @param plan_script [String] Reference to the script to run in the new plan.
     # @return [Boolean]
     #
-    def new_plan(name, puppet: false)
-      Bolt::PlanCreator.validate_input(config.project, name)
-      Bolt::PlanCreator.create_plan(config.project.plans_path, name, puppet)
+    def new_plan(name, puppet: false, plan_script: nil)
+      Bolt::PlanCreator.validate_plan_name(config.project, name)
+
+      if plan_script && !config.future&.fetch('file_paths', false)
+        raise Bolt::CLIError,
+              "The --script flag can only be used if future.file_paths is " \
+              "configured in bolt-project.yaml."
+      end
+
+      if plan_script
+        Bolt::Util.validate_file('script', find_file(plan_script))
+      end
+
+      Bolt::PlanCreator.create_plan(config.project.plans_path,
+                                    name,
+                                    is_puppet: puppet,
+                                    script: plan_script)
     end
 
     # Run a plan.
@@ -433,9 +448,8 @@ module Bolt
     # @param env_vars [Hash] Environment variables to set on the target.
     # @return [Bolt::ResultSet]
     #
-    def run_script(script, targets, arguments: [], env_vars: {})
-      future = executor.future&.fetch('file_paths', false)
-      script = find_file(script, future)
+    def run_script(script, targets, arguments: [], env_vars: nil)
+      script = find_file(script)
 
       Bolt::Util.validate_file('script', script)
 
@@ -555,18 +569,18 @@ module Bolt
     # directory.
     #
     # @param path [String] The path to the file.
-    # @param future_file_paths [Boolean] Whether to use future file path behavior.
     #
-    private def find_file(path, future_file_paths)
+    private def find_file(path)
       return path if File.exist?(path) || Pathname.new(path).absolute?
       modulepath = Bolt::Config::Modulepath.new(config.modulepath)
       modules    = Bolt::Module.discover(modulepath.full_modulepath, config.project)
-      mod, file = path.split(File::SEPARATOR, 2)
+      mod, file  = path.split(File::SEPARATOR, 2)
+      future     = executor.future&.fetch('file_paths', false)
 
       if modules[mod]
         logger.debug("Did not find file at #{File.expand_path(path)}, checking in module '#{mod}'")
-        found = Bolt::Util.find_file_in_module(modules[mod].path, file || "", future_file_paths)
-        path = found.nil? ? File.join(modules[mod].path, 'files', file) : found
+        found = Bolt::Util.find_file_in_module(modules[mod].path, file || "", future)
+        path  = found.nil? ? File.join(modules[mod].path, 'files', file) : found
       end
 
       path

data/lib/bolt/bolt_option_parser.rb

@@ -1042,6 +1042,21 @@ module Bolt
       define('--pp', 'Create a new Puppet language plan.') do |_|
         @options[:puppet] = true
       end
+      define('--script SCRIPT', 'Create a new plan that wraps a script.') do |path|
+        # If the path is a relative, absolute, or not a scripts path, raise an
+        # error. This flag is intended to be used to create shareable plans.
+        #
+        # This also limits valid mounts to files and scripts, which we may want
+        # to expand in the future.
+        if File.exist?(path) || Pathname.new(path).absolute? ||
+           !%w[scripts files].include?(path.split(File::SEPARATOR)[1])
+          raise Bolt::CLIError, "The script must be a detailed Puppet file reference, " \
+            "for example 'mymodule/scripts/myscript.sh'. See http://pup.pt/bolt-scripts for " \
+            "more information on detailed Puppet file references."
+        end
+
+        @options[:plan_script] = path
+      end
 
       separator "\n#{self.class.colorize(:cyan, 'Display options')}"
       define('--filter FILTER', 'Filter tasks and plans by a matching substring.') do |filter|

data/lib/bolt/cli.rb

@@ -20,7 +20,6 @@ require 'bolt/logger'
 require 'bolt/module_installer'
 require 'bolt/outputter'
 require 'bolt/pal'
-require 'bolt/plan_creator'
 require 'bolt/plugin'
 require 'bolt/project_manager'
 require 'bolt/puppetdb'
@@ -435,7 +434,7 @@ module Bolt
             config.project
           )
 
-          plugins = Bolt::Plugin.setup(config, pal, analytics)
+          plugins = Bolt::Plugin.new(config, pal, analytics)
 
           inventory = Bolt::Inventory.from_config(config, plugins)
 
@@ -611,7 +610,7 @@ module Bolt
           app.convert_plan(options[:object])
           SUCCESS
         when 'new'
-          result = app.new_plan(options[:object], **options.slice(:puppet))
+          result = app.new_plan(options[:object], **options.slice(:puppet, :plan_script))
           outputter.print_new_plan(**result)
           SUCCESS
         when 'run'

data/lib/bolt/inventory/inventory.rb

@@ -6,7 +6,7 @@ require 'bolt/inventory/target'
 module Bolt
   class Inventory
     class Inventory
-      attr_reader :config, :plugins, :source, :targets, :transport
+      attr_reader :plugins, :source, :targets, :transport
 
       class WildcardError < Bolt::Error
         def initialize(target)
@@ -14,25 +14,15 @@ module Bolt
         end
       end
 
-      # TODO: Pass transport config instead of config object
       def initialize(data, transport, transports, plugins, source = nil)
-        @logger       = Bolt::Logger.logger(self)
-        @data         = data || {}
-        @transport    = transport
-        @config       = transports
-        @plugins      = plugins
-        @groups       = Group.new(@data, plugins, all_group: true)
-        @group_lookup = {}
-        @targets      = {}
-        @source       = source
-
-        @groups.resolve_string_targets(@groups.target_aliases, @groups.all_targets)
-
-        collect_groups
-      end
-
-      def validate
-        @groups.validate
+        @logger          = Bolt::Logger.logger(self)
+        @data            = data || {}
+        @transport       = transport
+        @config          = transports
+        @config_resolved = transports.values.all?(&:resolved?)
+        @plugins         = plugins
+        @targets         = {}
+        @source          = source
       end
 
       def version
@@ -43,13 +33,52 @@ module Bolt
         Bolt::Target
       end
 
-      def collect_groups
-        # Provide a lookup map for finding a group by name
-        @group_lookup = @groups.collect_groups
+      # Load and resolve the groups in the inventory. Loading groups resolves
+      # all plugin references except for those for target data and config.
+      #
+      # @return [Bolt::Inventory::Group]
+      #
+      def groups
+        @groups ||= Group.new(@data, @plugins, all_group: true).tap do |groups|
+          groups.resolve_string_targets(groups.target_aliases, groups.all_targets)
+          groups.validate
+        end
       end
 
+      # Return a list of all group names in the inventory.
+      #
+      # @return [Array[String]]
+      #
       def group_names
-        @group_lookup.keys
+        group_lookup.keys
+      end
+
+      # Return a map of all groups in the inventory.
+      #
+      # @return [Hash[String, Bolt::Inventory::Group]]
+      #
+      def group_lookup
+        @group_lookup ||= groups.collect_groups
+      end
+
+      # Return a map of transport configuration for the inventory. Any
+      # unresolved plugin references are resolved.
+      #
+      # @return [Hash[String, Bolt::Config::Transport]]
+      #
+      def config
+        if @config_resolved
+          @config
+        else
+          @config_resolved = true
+          @config.transform_values! { |t| t.resolved? ? t : t.resolve(@plugins) }
+        end
+      end
+
+      # Validates the inventory.
+      #
+      def validate
+        groups.validate
       end
 
       def group_names_for(target_name)
@@ -57,7 +86,7 @@ module Bolt
       end
 
       def target_names
-        @groups.all_targets
+        groups.all_targets
       end
       # alias for analytics
       alias node_names target_names
@@ -81,7 +110,7 @@ module Bolt
 
       #### PRIVATE ####
       def group_data_for(target_name)
-        @groups.group_collect(target_name)
+        groups.group_collect(target_name)
       end
 
       # If target is a group name, expand it to the members of that group.
@@ -89,15 +118,15 @@ module Bolt
       # If a wildcard string, error if no matches are found.
       # Else fall back to [target] if no matches are found.
       def resolve_name(target)
-        if (group = @group_lookup[target])
+        if (group = group_lookup[target])
           group.all_targets
         else
           # Try to wildcard match targets in inventory
           # Ignore case because hostnames are generally case-insensitive
           regexp = Regexp.new("^#{Regexp.escape(target).gsub('\*', '.*?')}$", Regexp::IGNORECASE)
 
-          targets = @groups.all_targets.select { |targ| targ =~ regexp }
-          targets += @groups.target_aliases.select { |target_alias, _target| target_alias =~ regexp }.values
+          targets = groups.all_targets.select { |targ| targ =~ regexp }
+          targets += groups.target_aliases.select { |target_alias, _target| target_alias =~ regexp }.values
 
           if targets.empty?
             raise(WildcardError, target) if target.include?('*')
@@ -165,7 +194,7 @@ module Bolt
       # associated references. This is used when a target is resolved by
       # get_targets.
       def create_target_from_inventory(target_name)
-        target_data = @groups.target_collect(target_name) || { 'uri' => target_name }
+        target_data = groups.target_collect(target_name) || { 'uri' => target_name }
 
         target = Bolt::Inventory::Target.new(target_data, self)
         @targets[target.name] = target
@@ -187,24 +216,24 @@ module Bolt
         @targets[new_target.name] = new_target
 
         if existing_target
-          clear_alia_from_group(@groups, new_target.name)
+          clear_alia_from_group(groups, new_target.name)
         else
           add_to_group([new_target], 'all')
         end
 
         if new_target.target_alias
-          @groups.insert_alia(new_target.name, Array(new_target.target_alias))
+          groups.insert_alia(new_target.name, Array(new_target.target_alias))
         end
 
         new_target
       end
 
       def validate_target_from_hash(target)
-        groups = Set.new(group_names)
-        targets = target_names
+        used_groups  = Set.new(group_names)
+        used_targets = target_names
 
         # Make sure there are no group name conflicts
-        if groups.include?(target.name)
+        if used_groups.include?(target.name)
           raise ValidationError.new("Target name #{target.name} conflicts with group of the same name", nil)
         end
 
@@ -217,11 +246,11 @@ module Bolt
         end
 
         # Make sure there are no conflicts with the new target aliases
-        used_aliases = @groups.target_aliases
+        used_aliases = groups.target_aliases
         Array(target.target_alias).each do |alia|
-          if groups.include?(alia)
+          if used_groups.include?(alia)
             raise ValidationError.new("Alias #{alia} conflicts with group of the same name", nil)
-          elsif targets.include?(alia)
+          elsif used_targets.include?(alia)
             raise ValidationError.new("Alias #{alia} conflicts with target of the same name", nil)
           elsif used_aliases[alia] && used_aliases[alia] != target.name
             raise ValidationError.new(
@@ -250,7 +279,7 @@ module Bolt
         end
 
         if group_names.include?(desired_group)
-          remove_target(@groups, @targets[target.first.name], desired_group)
+          remove_target(groups, @targets[target.first.name], desired_group)
         else
           raise ValidationError.new("Group #{desired_group} does not exist in inventory", nil)
         end
@@ -260,7 +289,7 @@ module Bolt
         if group_names.include?(desired_group)
           targets.each do |target|
             # Add the inventory copy of the target
-            add_target(@groups, @targets[target.name], desired_group)
+            add_target(groups, @targets[target.name], desired_group)
           end
         else
           raise ValidationError.new("Group #{desired_group} does not exist in inventory", nil)

data/lib/bolt/inventory.rb

@@ -91,19 +91,12 @@ module Bolt
         end
       end
 
-      # Resolve plugin references from transport config
-      config.transports.each_value do |t|
-        t.resolve(plugins) unless t.resolved?
-      end
-
       Bolt::Validator.new.tap do |validator|
         validator.validate(data, schema, source)
         validator.warnings.each { |warning| Bolt::Logger.warn(warning[:id], warning[:msg]) }
       end
 
-      inventory = create_version(data, config.transport, config.transports, plugins, source)
-      inventory.validate
-      inventory
+      create_version(data, config.transport, config.transports, plugins, source)
     end
 
     def self.create_version(data, transport, transports, plugins, source = nil)
@@ -119,7 +112,7 @@ module Bolt
 
     def self.empty
       config  = Bolt::Config.default
-      plugins = Bolt::Plugin.setup(config, nil)
+      plugins = Bolt::Plugin.new(config, nil)
 
       create_version({}, config.transport, config.transports, plugins, nil)
     end

data/lib/bolt/plan_creator.rb

@@ -7,7 +7,7 @@ require 'bolt/util'
 
 module Bolt
   module PlanCreator
-    def self.validate_input(project, plan_name)
+    def self.validate_plan_name(project, plan_name)
       if project.name.nil?
         raise Bolt::Error.new(
           "Project directory '#{project.path}' is not a named project. Unable to create "\
@@ -51,7 +51,15 @@ module Bolt
       end
     end
 
-    def self.create_plan(plans_path, plan_name, is_puppet)
+    # Create a new plan from the plan templates based on which language the
+    # user configured, and whether the plan wraps a script.
+    #
+    # @param plans_path [string] The path to the new plan
+    # @param plan_name [string] The name of the new plan
+    # @param is_puppet [boolean] Whether to create a Puppet language plan
+    # @param script [string] A reference to a script for the new plan to run
+    #
+    def self.create_plan(plans_path, plan_name, is_puppet: false, script: nil)
       _, name_segments, basename = segment_plan_name(plan_name)
       dir_path = plans_path.join(*name_segments)
 
@@ -66,8 +74,15 @@ module Bolt
 
       type = is_puppet ? 'pp' : 'yaml'
       plan_path = dir_path + "#{basename}.#{type}"
-      plan_template = is_puppet ? puppet_plan(plan_name) : yaml_plan(plan_name)
-
+      plan_template = if is_puppet && script
+                        puppet_script_plan(plan_name, script)
+                      elsif is_puppet
+                        puppet_plan(plan_name)
+                      elsif script
+                        yaml_script_plan(script)
+                      else
+                        yaml_plan(plan_name)
+                      end
       begin
         File.write(plan_path, plan_template)
       rescue Errno::EACCES => e
@@ -90,7 +105,11 @@ module Bolt
       [prefix, name_segments, basename]
     end
 
-    def self.yaml_plan(plan_name)
+    # Template for a new simple YAML plan.
+    #
+    # @param plan_name [string] The name of the new plan
+    #
+    private_class_method def self.yaml_plan(plan_name)
       <<~YAML
         # This is the structure of a simple plan. To learn more about writing
         # YAML plans, see the documentation: http://pup.pt/bolt-yaml-plans
@@ -119,7 +138,42 @@ module Bolt
       YAML
     end
 
-    def self.puppet_plan(plan_name)
+    # Template for a new YAML plan that runs a script.
+    #
+    # @param script [string] A reference to the script to run.
+    #
+    private_class_method def self.yaml_script_plan(script)
+      <<~YAML
+        # This is the structure of a simple plan. To learn more about writing
+        # YAML plans, see the documentation: http://pup.pt/bolt-yaml-plans
+        
+        # The description sets the description of the plan that will appear
+        # in 'bolt plan show' output.
+        description: A plan created with bolt plan new
+
+        # The parameters key defines the parameters that can be passed to
+        # the plan.
+        parameters:
+          targets:
+            type: TargetSpec
+            description: A list of targets to run actions on
+
+        # The steps key defines the actions the plan will take in order.
+        steps:
+          - name: run_script
+            script: #{script}
+            targets: $targets
+
+        # The return key sets the return value of the plan.
+        return: $run_script
+      YAML
+    end
+
+    # Template for a new simple Puppet plan.
+    #
+    # @param plan_name [string] The name of the new plan
+    #
+    private_class_method def self.puppet_plan(plan_name)
       <<~PUPPET
         # This is the structure of a simple plan. To learn more about writing
         # Puppet plans, see the documentation: http://pup.pt/bolt-puppet-plans
@@ -138,5 +192,28 @@ module Bolt
         }
       PUPPET
     end
+
+    # Template for a new Puppet plan that only runs a script.
+    #
+    # @param plan_name [string] The name of the new plan
+    # @param script [string] A reference to the script to run
+    #
+    private_class_method def self.puppet_script_plan(plan_name, script)
+      <<~PUPPET
+        # This is the structure of a simple plan. To learn more about writing
+        # Puppet plans, see the documentation: http://pup.pt/bolt-puppet-plans
+
+        # The summary sets the description of the plan that will appear
+        # in 'bolt plan show' output. Bolt uses puppet-strings to parse the
+        # summary and parameters from the plan.
+        # @summary A plan created with bolt plan new.
+        # @param targets The targets to run on.
+        plan #{plan_name} (
+          TargetSpec $targets
+        ) {
+          return run_script('#{script}', $targets)
+        }
+      PUPPET
+    end
   end
 end

data/lib/bolt/plugin.rb

@@ -127,29 +127,15 @@ module Bolt
       end
     end
 
-    def self.setup(config, pal, analytics = Bolt::Analytics::NoopClient.new, **opts)
-      plugins = new(config, pal, analytics, **opts)
-
-      config.plugins.each_key do |plugin|
-        plugins.by_name(plugin)
-      end
-
-      plugins.plugin_hooks.merge!(plugins.resolve_references(config.plugin_hooks))
-
-      plugins
-    end
-
     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
 
     attr_reader :pal, :plugin_context
-    attr_accessor :plugin_hooks
+    attr_writer :plugin_hooks
 
-    private_class_method :new
-
-    def initialize(config, pal, analytics, load_plugins: true)
+    def initialize(config, pal, analytics = Bolt::Analytics::NoopClient.new, load_plugins: true)
       @config = config
       @analytics = analytics
       @plugin_context = PluginContext.new(config, pal, self)
@@ -166,7 +152,15 @@ module Bolt
         raise Bolt::Error.new(msg, 'bolt/plugin-error')
       end
       @unresolved_plugin_configs['puppetdb'] = config.puppetdb if config.puppetdb
-      @plugin_hooks = DEFAULT_PLUGIN_HOOKS.dup
+    end
+
+    # Returns a map of configured plugin hooks. Any unresolved plugin references
+    # are resolved.
+    #
+    # @return [Hash[String, Hash]]
+    #
+    def plugin_hooks
+      @plugin_hooks ||= DEFAULT_PLUGIN_HOOKS.merge(resolve_references(@config.plugin_hooks))
     end
 
     def modules

data/lib/bolt/version.rb

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

data/lib/bolt_server/transport_app.rb

@@ -832,7 +832,7 @@ module BoltServer
           }
 
           connect_plugin = BoltServer::Plugin::PuppetConnectData.new(body['puppet_connect_data'])
-          plugins = Bolt::Plugin.setup(context[:config], context[:pal], load_plugins: false)
+          plugins = Bolt::Plugin.new(context[:config], context[:pal], load_plugins: false)
           plugins.add_plugin(connect_plugin)
           %w[aws_inventory azure_inventory gcloud_inventory].each do |plugin_name|
             plugins.add_module_plugin(plugin_name) if plugins.known_plugin?(plugin_name)

data/lib/bolt_spec/bolt_context.rb

@@ -154,7 +154,7 @@ module BoltSpec
     end
 
     def plugins
-      @plugins ||= Bolt::Plugin.setup(config, pal)
+      @plugins ||= Bolt::Plugin.new(config, pal)
     end
 
     def pal

data/lib/bolt_spec/run.rb

@@ -171,7 +171,7 @@ module BoltSpec
       end
 
       def plugins
-        @plugins ||= Bolt::Plugin.setup(config, pal)
+        @plugins ||= Bolt::Plugin.new(config, pal)
       end
 
       def puppetdb_client

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bolt
 version: !ruby/object:Gem::Version
-  version: 3.16.1
+  version: 3.17.0
 platform: ruby
 authors:
 - Puppet
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-08-16 00:00:00.000000000 Z
+date: 2021-08-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: addressable