bolt 2.0.1 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 30a51dcd7670a136af567ff1778431fd36801d05c8c45345093df6602e877385
-  data.tar.gz: 98a234f0f9f47c860d59d0a34de317d9f9e9b20935ace99ef97ec239dcbea8f6
+  metadata.gz: 5d912a5ba19a113e4e5a57aed09f04f1a72a659b05fdb7cc09164146b59fc0cc
+  data.tar.gz: 9344eaf150b512c769e8b6fd7ac91fef7ece7de62cb39bede4f22ebd15f52cd3
 SHA512:
-  metadata.gz: 6a32a48d4b957a811290e44f63ef6c2e1f3f672bf18ec51637c92601286652b5363222ebd747913e4e9a6e4936ace14e2f0a6aeea44d46923ba90a78d11d4b12
-  data.tar.gz: 28e5168898c9e49c694b82511ee68e89b1d409f116367fbd7200a87697259a0ab4f45c2fc1e59663de72920195d27523ddffafd6550037d6556cfbdafdcaf807
+  metadata.gz: 69040995cbcff577cfa377f50a80dc76825ba3aa0fd107788f146c26e5d562131ec089ce79f69c052b47b2fa9b2d7af3c9feb587829e6a4b9297ee9df2b9d9bd
+  data.tar.gz: ef5b45003158f3f4801877e2c19768b990fa4c09d84fcce40888f4236bf025e0244ac5e5e4b5edc5397c3a49691390e650b0724a8450c3e10382fdee44b80f73

data/Puppetfile

@@ -25,7 +25,7 @@ mod 'puppetlabs-zone_core', '1.0.3'
 mod 'puppetlabs-package', '0.7.0'
 mod 'puppetlabs-puppet_conf', '0.4.0'
 mod 'puppetlabs-python_task_helper', '0.3.0'
-mod 'puppetlabs-reboot', '2.2.0'
+mod 'puppetlabs-reboot', '3.0.0'
 mod 'puppetlabs-ruby_task_helper', '0.4.0'
 mod 'puppetlabs-ruby_plugin_helper', '0.1.0'
 

data/bolt-modules/boltlib/lib/puppet/functions/write_file.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+require 'tempfile'
+
+# Write contents to a file on the given set of targets.
+#
+# > **Note:** Not available in apply block
+Puppet::Functions.create_function(:write_file) do
+  # @param targets A pattern identifying zero or more targets. See {get_targets} for accepted patterns.
+  # @param content File content to write.
+  # @param destination An absolute path on the target(s).
+  # @option options [Boolean] _catch_errors Whether to catch raised errors.
+  # @option options [String] _run_as User to run as using privilege escalation.
+  # @return A list of results, one entry per target.
+  # @example Write a file to a target
+  #   $content = 'Hello, world!'
+  #   write_file($targets, $content, '/Users/me/hello.txt')
+  dispatch :write_file do
+    required_param 'String', :content
+    required_param 'String[1]', :destination
+    required_param 'Boltlib::TargetSpec', :targets
+    optional_param 'Hash[String[1], Any]', :options
+    return_type 'ResultSet'
+  end
+
+  def write_file(content, destination, target_spec, options = {})
+    unless Puppet[:tasks]
+      raise Puppet::ParseErrorWithIssue
+        .from_issue_and_stack(Bolt::PAL::Issues::PLAN_OPERATION_NOT_SUPPORTED_WHEN_COMPILING,
+                              action: 'write_file')
+    end
+
+    executor = Puppet.lookup(:bolt_executor)
+    executor.report_function_call(self.class.name)
+
+    inventory = Puppet.lookup(:bolt_inventory)
+    targets = inventory.get_targets(target_spec)
+
+    executor.log_action("write file #{destination}", targets) do
+      executor.without_default_logging do
+        Tempfile.create do |tmp|
+          call_function('file::write', tmp.path, content)
+          call_function('upload_file', tmp.path, destination, targets, options)
+        end
+      end
+    end
+  end
+end

data/lib/bolt/bolt_option_parser.rb

@@ -88,7 +88,7 @@ module Bolt
       when 'puppetfile'
         case action
         when 'install'
-          { flags: OPTIONS[:global] + OPTIONS[:global_config_setters],
+          { flags: OPTIONS[:global] + OPTIONS[:global_config_setters] + %w[puppetfile],
             banner: PUPPETFILE_INSTALL_HELP }
         when 'show-modules'
           { flags: OPTIONS[:global] + OPTIONS[:global_config_setters],
@@ -706,7 +706,7 @@ module Bolt
         @options[:boltdir] = path
       end
       define('--configfile FILEPATH',
-             'Specify where to load config from (default: ~/.puppetlabs/bolt/bolt.yaml). ' \
+             'Specify where to load config from (default: ~/.puppetlabs/bolt/bolt.yaml).',
              'Directory containing bolt.yaml will be used as the Boltdir.') do |path|
         @options[:configfile] = path
       end
@@ -715,7 +715,12 @@ module Bolt
         if ENV.include?(Bolt::Inventory::ENVIRONMENT_VAR)
           raise Bolt::CLIError, "Cannot pass inventory file when #{Bolt::Inventory::ENVIRONMENT_VAR} is set"
         end
-        @options[:inventoryfile] = File.expand_path(path)
+        @options[:inventoryfile] = Pathname.new(File.expand_path(path))
+      end
+      define('--puppetfile FILEPATH',
+             'Specify a Puppetfile to use when installing modules. (default: ~/.puppetlabs/bolt/Puppetfile)',
+             'Modules are installed in the current Boltdir.') do |path|
+        @options[:puppetfile] = Pathname.new(File.expand_path(path))
       end
       define('--[no-]save-rerun', 'Whether to update the rerun file after this command.') do |save|
         @options[:'save-rerun'] = save

data/lib/bolt/config.rb

@@ -223,12 +223,6 @@ module Bolt
       Bolt::Util.deep_clone(self)
     end
 
-    def normalize_interpreters(interpreters)
-      Bolt::Util.walk_keys(interpreters) do |key|
-        key.chars[0] == '.' ? key : '.' + key
-      end
-    end
-
     def normalize_log(target)
       return target if target == 'console'
       target = target[5..-1] if target.start_with?('file:')
@@ -308,6 +302,8 @@ module Bolt
         send("#{key}=", options[key]) if options.key?(key)
       end
 
+      @puppetfile = options[:puppetfile] if options.key?(:puppetfile)
+
       @save_rerun = options[:'save-rerun'] if options.key?(:'save-rerun')
 
       if options[:debug]
@@ -345,6 +341,11 @@ module Bolt
     end
 
     def update_transports(data)
+      self.class.update_transport_hash(@boltdir.path, @transports, data)
+      @transport = data['transport'] if data.key?('transport')
+    end
+
+    def self.update_transport_hash(boltdir, existing, data)
       TRANSPORTS.each do |key, impl|
         if data[key.to_s]
           selected = impl.filter_options(data[key.to_s])
@@ -352,17 +353,21 @@ module Bolt
           # Expand file paths relative to the Boltdir
           to_expand = %w[private-key cacert token-file] & selected.keys
           to_expand.each do |opt|
-            selected[opt] = File.expand_path(selected[opt], @boltdir.path) if selected[opt].is_a?(String)
+            selected[opt] = File.expand_path(selected[opt], boltdir) if selected[opt].is_a?(String)
           end
 
-          @transports[key] = Bolt::Util.deep_merge(@transports[key], selected)
+          existing[key] = Bolt::Util.deep_merge(existing[key], selected)
         end
-        if @transports[key]['interpreters']
-          @transports[key]['interpreters'] = normalize_interpreters(@transports[key]['interpreters'])
+        if existing[key]['interpreters']
+          existing[key]['interpreters'] = normalize_interpreters(existing[key]['interpreters'])
         end
       end
+    end
 
-      @transport = data['transport'] if data.key?('transport')
+    def self.normalize_interpreters(interpreters)
+      Bolt::Util.walk_keys(interpreters) do |key|
+        key.chars[0] == '.' ? key : '.' + key
+      end
     end
 
     def transport_conf
@@ -383,7 +388,7 @@ module Bolt
     end
 
     def puppetfile
-      @boltdir.puppetfile
+      @puppetfile || @boltdir.puppetfile
     end
 
     def modulepath

data/lib/bolt/inventory/group.rb

@@ -116,7 +116,7 @@ module Bolt
           raise ValidationError.new("Target name must be ASCII characters: #{target}", @name)
         end
 
-        if local_targets.include?(t_name)
+        if contains_target?(t_name)
           @logger.warn("Ignoring duplicate target in #{@name}: #{target}")
           return
         end
@@ -189,9 +189,6 @@ module Bolt
       end
 
       def resolve_string_targets(aliases, known_targets)
-        # Use a single copy of this because recomputing it for every target is
-        # prohibitively expensive for large groups
-        cached_local_targets = local_targets
         @string_targets.each do |string_target|
           # If this is the name of a target defined elsewhere, then insert the
           # target into this group as just a name. Otherwise, add a new target
@@ -200,19 +197,17 @@ module Bolt
             @unresolved_targets[string_target] = { 'name' => string_target }
           # If this is an alias for an existing target, then add it to this group
           elsif (canonical_name = aliases[string_target])
-            if cached_local_targets.include?(canonical_name)
+            if contains_target?(canonical_name)
               @logger.warn("Ignoring duplicate target in #{@name}: #{canonical_name}")
             else
               @unresolved_targets[canonical_name] = { 'name' => canonical_name }
-              cached_local_targets << canonical_name
             end
           # If it's not the name or alias of an existing target, then make a
           # new target using the string as the URI
-          elsif cached_local_targets.include?(string_target)
+          elsif contains_target?(string_target)
             @logger.warn("Ignoring duplicate target in #{@name}: #{string_target}")
           else
             @unresolved_targets[string_target] = { 'uri' => string_target }
-            cached_local_targets << string_target
           end
         end
         @groups.each { |g| g.resolve_string_targets(aliases, known_targets) }
@@ -364,6 +359,10 @@ module Bolt
         Set.new(@unresolved_targets.keys) + Set.new(@resolved_targets.keys)
       end
 
+      def contains_target?(target_name)
+        @unresolved_targets.key?(target_name) || @resolved_targets.key?(target_name)
+      end
+
       # Returns all targets contained within the group, which includes targets from subgroups.
       def all_targets
         @groups.inject(local_targets) do |acc, g|
@@ -404,7 +403,7 @@ module Bolt
 
         # If this group has the target or one of the child groups has the
         # target, return the data, otherwise return nil
-        if child_result || local_targets.include?(target_name)
+        if child_result || contains_target?(target_name)
           # Children override the parent
           data_merge(group_data, child_result)
         end

data/lib/bolt/inventory/inventory.rb

@@ -168,7 +168,6 @@ module Bolt
       def add_target(current_group, target, desired_group)
         if current_group.name == desired_group
           current_group.add_target(target)
-          @groups.validate
           target.invalidate_group_cache!
           return true
         end
@@ -200,6 +199,8 @@ module Bolt
         # If target already exists, delete old and replace with new, otherwise add to new to all group
         new_target = Bolt::Inventory::Target.new(data, self)
         existing_target = @targets.key?(new_target.name)
+
+        validate_target_from_hash(new_target)
         @targets[new_target.name] = new_target
 
         if existing_target
@@ -208,17 +209,43 @@ module Bolt
           add_to_group([new_target], 'all')
         end
 
-        if (aliases = new_target.target_alias)
-          aliases = [aliases] if aliases.is_a?(String)
-          unless aliases.is_a?(Array)
+        if 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
+
+        # Make sure there are no group name conflicts
+        if groups.include?(target.name)
+          raise ValidationError.new("Target name #{target.name} conflicts with group of the same name", nil)
+        end
+
+        # Validate any aliases
+        if (aliases = target.target_alias)
+          unless aliases.is_a?(Array) || aliases.is_a?(String)
             msg = "Alias entry on #{t_name} must be a String or Array, not #{aliases.class}"
             raise ValidationError.new(msg, @name)
           end
-
-          @groups.insert_alia(new_target.name, aliases)
         end
 
-        new_target
+        # Make sure there are no conflicts with the new target aliases
+        used_aliases = @groups.target_aliases
+        Array(target.target_alias).each do |alia|
+          if groups.include?(alia)
+            raise ValidationError.new("Alias #{alia} conflicts with group of the same name", nil)
+          elsif 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(
+              "Alias #{alia} refers to multiple targets: #{used_aliases[alia]} and #{target.name}", nil
+            )
+          end
+        end
       end
 
       def clear_alia_from_group(group, target_name)
@@ -249,9 +276,6 @@ module Bolt
       def add_to_group(targets, desired_group)
         if group_names.include?(desired_group)
           targets.each do |target|
-            if group_names.include?(target.name)
-              raise ValidationError.new("Group #{target.name} conflicts with target of the same name", target.name)
-            end
             # Add the inventory copy of the target
             add_target(@groups, @targets[target.name], desired_group)
           end

data/lib/bolt/inventory/target.rb

@@ -109,14 +109,16 @@ module Bolt
       def transport_config_cache
         if @transport_config_cache.nil?
           merged_config = Bolt::Util.deep_merge(group_cache['config'], @config)
-          # Use the base config to ensure we handle the config validation and
-          # munging correctly
-          config = @inventory.config.deep_clone
-          config.update_from_inventory(merged_config)
-          config.validate
+          base_config = @inventory.config
+          transport_data = Bolt::Util.deep_clone(base_config.transports)
+          Bolt::Config.update_transport_hash(base_config.boltdir.path, transport_data, merged_config)
+          transport = merged_config['transport'] || base_config.transport
+          Bolt::TRANSPORTS.each do |name, impl|
+            impl.validate(transport_data[name])
+          end
           @transport_config_cache = {
-            'transport' => config.transport_conf[:transport],
-            'transports' => config.transport_conf[:transports]
+            'transport' => transport,
+            'transports' => transport_data
           }
         end
 

data/lib/bolt/pal.rb

@@ -336,11 +336,16 @@ module Bolt
                       end
 
         defaults = plan.parameters.reject { |_, value| value.nil? }.to_h
+        signature_params = Set.new(plan.parameters.map(&:first))
         parameters = plan.tags(:param).each_with_object({}) do |param, params|
           name = param.name
-          params[name] = { 'type' => param.types.first }
-          params[name]['default_value'] = defaults[name] if defaults.key?(name)
-          params[name]['description'] = param.text unless param.text.empty?
+          if signature_params.include?(name)
+            params[name] = { 'type' => param.types.first }
+            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")
+          end
         end
 
         {

data/lib/bolt/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bolt
 version: !ruby/object:Gem::Version
-  version: 2.0.1
+  version: 2.1.0
 platform: ruby
 authors:
 - Puppet
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-02-25 00:00:00.000000000 Z
+date: 2020-03-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: addressable
@@ -375,6 +375,7 @@ files:
 - bolt-modules/boltlib/lib/puppet/functions/vars.rb
 - bolt-modules/boltlib/lib/puppet/functions/wait_until_available.rb
 - bolt-modules/boltlib/lib/puppet/functions/without_default_logging.rb
+- bolt-modules/boltlib/lib/puppet/functions/write_file.rb
 - bolt-modules/boltlib/types/planresult.pp
 - bolt-modules/boltlib/types/targetspec.pp
 - bolt-modules/ctrl/lib/puppet/functions/ctrl/do_until.rb