bolt 0.16.0 → 0.16.1

data/lib/bolt/util.rb

@@ -0,0 +1,54 @@
+module Bolt
+  module Util
+    # CODEREVIEW I hate mixing in random modules
+    class << self
+      def read_config_file(path, default_paths = nil, file_name = 'file')
+        logger = Logging.logger[self]
+        path_passed = path
+        if path.nil? && default_paths
+          found_default = default_paths.select { |p| File.exist?(p) }
+          if found_default.size > 1
+            logger.warn "Found #{file_name}s at #{found_default.join(', ')}, using the first"
+          end
+          # Use first found, fall back to first default and try to load even if it didn't exist
+          path = found_default.first || default_paths.first
+        end
+
+        path = File.expand_path(path)
+        # safe_load doesn't work with psych in ruby 2.0
+        # The user controls the configfile so this isn't a problem
+        # rubocop:disable YAMLLoad
+        File.open(path, "r:UTF-8") { |f| YAML.load(f.read) }
+      rescue Errno::ENOENT
+        if path_passed
+          raise Bolt::CLIError, "Could not read #{file_name} file: #{path}"
+        end
+      # In older releases of psych SyntaxError is not a subclass of Exception
+      rescue Psych::SyntaxError
+        raise Bolt::CLIError, "Could not parse #{file_name} file: #{path}"
+      rescue Psych::Exception
+        raise Bolt::CLIError, "Could not parse #{file_name} file: #{path}"
+      rescue IOError, SystemCallError
+        raise Bolt::CLIError, "Could not read #{file_name} file: #{path}"
+      end
+
+      def deep_merge(hash1, hash2)
+        recursive_merge = proc do |_key, h1, h2|
+          if h1.is_a?(Hash) && h2.is_a?(Hash)
+            h1.merge(h2, &recursive_merge)
+          else
+            h2
+          end
+        end
+        hash1.merge(hash2, &recursive_merge)
+      end
+
+      def symbolize_keys(hash)
+        hash.each_with_object({}) do |(k, v), acc|
+          k = k.to_sym
+          acc[k] = v.is_a?(Hash) ? symbolize_keys(v) : v
+        end
+      end
+    end
+  end
+end

data/lib/bolt/version.rb

@@ -1,3 +1,3 @@
 module Bolt
-  VERSION = '0.16.0'.freeze
+  VERSION = '0.16.1'.freeze
 end

data/modules/boltlib/lib/puppet/functions/fail_plan.rb

@@ -0,0 +1,27 @@
+# Raises a Bolt::PlanFailure exception to signal to callers that the plan failed
+#
+# Plan authors should call this function when their plan is not successful. The
+# error may then be caught by another plans run_plan function or in bolt itself
+
+require 'bolt/error'
+
+Puppet::Functions.create_function(:fail_plan, Puppet::Functions::InternalFunction) do
+  dispatch :from_args do
+    param 'String[1]', :msg
+    optional_param 'String[1]', :kind
+    optional_param 'Hash[String[1], Any]', :details
+    optional_param 'String[1]', :issue_code
+  end
+
+  dispatch :from_error do
+    param 'Error', :error
+  end
+
+  def from_args(msg, kind = nil, details = nil, issue_code = nil)
+    raise Bolt::PlanFailure.new(msg, kind || 'bolt/plan-failure', details, issue_code)
+  end
+
+  def from_error(e)
+    from_args(e.message, e.kind, e.details, e.issue_code)
+  end
+end

data/modules/boltlib/lib/puppet/functions/file_upload.rb

@@ -30,7 +30,8 @@ Puppet::Functions.create_function(:file_upload, Puppet::Functions::InternalFunct
     end
 
     executor = Puppet.lookup(:bolt_executor) { nil }
-    unless executor && Puppet.features.bolt?
+    inventory = Puppet.lookup(:bolt_inventory) { nil }
+    unless executor && inventory && Puppet.features.bolt?
       raise Puppet::ParseErrorWithIssue.from_issue_and_stack(
         Puppet::Pops::Issues::TASK_MISSING_BOLT, action: _('do file uploads')
       )
@@ -44,13 +45,12 @@ Puppet::Functions.create_function(:file_upload, Puppet::Functions::InternalFunct
     end
 
     # Ensure that that given targets are all Target instances
-    targets = [targets] unless targets.is_a?(Array)
-    targets = targets.flatten.map { |t| t.is_a?(String) ? Bolt::Target.from_uri(t) : t }
+    targets = inventory.get_targets(targets)
     if targets.empty?
       call_function('debug', "Simulating file upload of '#{found}' - no targets given - no action taken")
       r = Bolt::ResultSet.new([])
     else
-      r = executor.file_upload(targets, found, destination)
+      r = executor.file_upload(targets, found, destination, options.select { |k, _| k == '_run_as' })
     end
 
     if !r.ok && !options['_catch_errors']

data/modules/boltlib/lib/puppet/functions/run_command.rb

@@ -28,15 +28,15 @@ Puppet::Functions.create_function(:run_command) do
     end
 
     executor = Puppet.lookup(:bolt_executor) { nil }
-    unless executor && Puppet.features.bolt?
+    inventory = Puppet.lookup(:bolt_inventory) { nil }
+    unless executor && inventory && Puppet.features.bolt?
       raise Puppet::ParseErrorWithIssue.from_issue_and_stack(
         Puppet::Pops::Issues::TASK_MISSING_BOLT, action: _('run a command')
       )
     end
 
     # Ensure that that given targets are all Target instances
-    targets = [targets] unless targets.is_a?(Array)
-    targets = targets.flatten.map { |t| t.is_a?(String) ? Bolt::Target.from_uri(t) : t }
+    targets = inventory.get_targets(targets)
 
     if targets.empty?
       call_function('debug', "Simulating run_command('#{command}') - no targets given - no action taken")

data/modules/boltlib/lib/puppet/functions/run_plan.rb

@@ -8,6 +8,8 @@
 #   }
 #   run_plan('myplan', { x => 'testing' })
 #
+require 'bolt/error'
+
 Puppet::Functions.create_function(:run_plan, Puppet::Functions::InternalFunction) do
   dispatch :run_plan do
     scope_param
@@ -29,7 +31,7 @@ Puppet::Functions.create_function(:run_plan, Puppet::Functions::InternalFunction
       )
     end
 
-    use_args = named_args.reject { |k, _| k.start_with?('_') }
+    params = named_args.reject { |k, _| k.start_with?('_') }
 
     loaders = closure_scope.compiler.loaders
     # The perspective of the environment is wanted here (for now) to not have to
@@ -41,10 +43,22 @@ Puppet::Functions.create_function(:run_plan, Puppet::Functions::InternalFunction
         old_run_as = executor.run_as
         executor.run_as = run_as
       end
-      result = func.class.dispatcher.dispatchers[0].call_by_name_with_scope(scope, use_args, true)
-      if run_as
-        executor.run_as = old_run_as
+
+      begin
+        result = func.class.dispatcher.dispatchers[0].call_by_name_with_scope(scope, params, true)
+      rescue Puppet::PreformattedError => err
+        if named_args['_catch_errors'] &&
+           err.respond_to?(:cause) && err.cause && err.cause.is_a?(Bolt::Error)
+          result = err.cause.to_puppet_error
+        else
+          raise err
+        end
+      ensure
+        if run_as
+          executor.run_as = old_run_as
+        end
       end
+
       return result
     end
     # Could not find plan

data/modules/boltlib/lib/puppet/functions/run_script.rb

@@ -27,7 +27,8 @@ Puppet::Functions.create_function(:run_script, Puppet::Functions::InternalFuncti
     end
 
     executor = Puppet.lookup(:bolt_executor) { nil }
-    unless executor && Puppet.features.bolt?
+    inventory = Puppet.lookup(:bolt_inventory) { nil }
+    unless executor && inventory && Puppet.features.bolt?
       raise Puppet::ParseErrorWithIssue.from_issue_and_stack(
         Puppet::Pops::Issues::TASK_MISSING_BOLT, action: _('run a script')
       )
@@ -46,7 +47,9 @@ Puppet::Functions.create_function(:run_script, Puppet::Functions::InternalFuncti
     end
 
     # Ensure that that given targets are all Target instances)
-    targets = [targets].flatten.map { |t| t.is_a?(String) ? Bolt::Target.from_uri(t) : t }
+    targets = inventory.get_targets(targets)
+
+    #
     r = if targets.empty?
           Bolt::ResultSet.new([])
         else

data/modules/boltlib/lib/puppet/functions/run_task.rb

@@ -54,7 +54,8 @@ Puppet::Functions.create_function(:run_task) do
     end
 
     executor = Puppet.lookup(:bolt_executor) { nil }
-    unless executor && Puppet.features.bolt?
+    inventory = Puppet.lookup(:bolt_inventory) { nil }
+    unless executor && inventory && Puppet.features.bolt?
       raise Puppet::ParseErrorWithIssue.from_issue_and_stack(
         Puppet::Pops::Issues::TASK_MISSING_BOLT, action: _('run a task')
       )
@@ -81,8 +82,7 @@ Puppet::Functions.create_function(:run_task) do
     end
 
     # Ensure that that given targets are all Target instances
-    targets = [targets] unless targets.is_a?(Array)
-    targets = targets.flatten.map { |t| t.is_a?(String) ? Bolt::Target.from_uri(t) : t }
+    targets = inventory.get_targets(targets)
     if targets.empty?
       Bolt::ResultSet.new([])
     else

data/vendored/puppet/lib/puppet/datatypes/error.rb

@@ -5,11 +5,13 @@ Puppet::DataTypes.create_type('Error') do
       issue_code => Optional[Variant[String,Regexp,Type[Enum],Type[Pattern],Type[NotUndef],Type[Undef]]]
     },
     attributes => {
-      message => String[1],
+      msg => String[1],
       kind => { type => Optional[String[1]], value => undef },
-      issue_code => { type => Optional[String[1]], value => undef },
-      partial_result => { type => Data, value => undef },
       details => { type => Optional[Hash[String[1],Data]], value => undef },
+      issue_code => { type => Optional[String[1]], value => undef },
+    },
+    functions => {
+      message => Callable[[], String[1]]
     }
     PUPPET
 

data/vendored/puppet/lib/puppet/datatypes/impl/error.rb

@@ -1,39 +1,37 @@
 class Puppet::DataTypes::Error
-  attr_reader :message, :kind, :issue_code, :partial_result, :details
+  attr_reader :msg, :kind, :issue_code, :details
+  alias message msg
 
   def self.from_asserted_hash(hash)
-    new(hash['message'], hash['kind'], hash['issue_code'], hash['partial_result'], hash['details'])
+    new(hash['msg'], hash['kind'], hash['details'], hash['issue_code'])
   end
 
   def _pcore_init_hash
-    result = { 'message' => @message }
+    result = { 'msg' => @msg }
     result['kind'] = @kind unless @kind.nil?
-    result['issue_code'] = @issue_code unless @issue_code.nil?
-    result['partial_result'] = @partial_result unless @partial_result.nil?
     result['details'] = @details unless @details.nil?
+    result['issue_code'] = @issue_code unless @issue_code.nil?
     result
   end
 
-  def initialize(message, kind = nil, issue_code = nil, partial_result = nil, details = nil)
-    @message = message
+  def initialize(msg, kind = nil, details = nil, issue_code = nil)
+    @msg = msg
     @kind = kind
-    @issue_code = issue_code
-    @partial_result = partial_result
     @details = details
+    @issue_code = issue_code
   end
 
   def eql?(o)
     self.class.equal?(o.class) &&
-      @message == o.message &&
+      @msg == o.msg &&
       @kind == o.kind &&
       @issue_code == o.issue_code &&
-      @partial_result == o.partial_result &&
       @details == o.details
   end
   alias == eql?
 
   def hash
-    @message.hash ^ @kind.hash ^ @issue_code.hash
+    @msg.hash ^ @kind.hash ^ @issue_code.hash
   end
 
   def to_s

data/vendored/puppet/lib/puppet/defaults.rb

@@ -10,20 +10,26 @@ module Puppet
     end
   end
 
-  def self.default_digest_alg
-    if Puppet::Util::Platform.fips_enabled?
-      "sha256"
-    else
-      "md5"
-    end
+  def self.default_digest_algorithm
+    Puppet::Util::Platform.fips_enabled? ? 'sha256' : 'md5'
   end
 
-  def self.default_checksum_types 
-    if Puppet::Util::Platform.fips_enabled?
-      ['sha256', 'sha384', 'sha512', 'sha224']
-    else
-      ['md5', 'sha256', 'sha384', 'sha512', 'sha224']
-    end
+  def self.valid_digest_algorithms
+    Puppet::Util::Platform.fips_enabled? ?
+      %w[sha256 sha384 sha512 sha224] :
+      %w[md5 sha256 sha384 sha512 sha224]
+  end
+
+  def self.default_file_checksum_types
+    Puppet::Util::Platform.fips_enabled? ?
+      %w[sha256 sha384 sha512 sha224] :
+      %w[md5 sha256 sha384 sha512 sha224]
+  end
+
+  def self.valid_file_checksum_types
+    Puppet::Util::Platform.fips_enabled? ?
+      %w[sha256 sha256lite sha384 sha512 sha224 sha1 sha1lite mtime ctime] :
+      %w[md5 md5lite sha256 sha256lite sha384 sha512 sha224 sha1 sha1lite mtime ctime]
   end
 
   ############################################################################################
@@ -939,26 +945,28 @@ attempt to download the CRL.
 EOT
     },
     :digest_algorithm => {
-        :default  => lambda { default_digest_alg },
+        :default  => lambda { default_digest_algorithm },
         :type     => :enum,
-        :values => ["md5", "sha256", "sha384", "sha512", "sha224"],
-        :desc     => 'Which digest algorithm to use for file resources and the filebucket.
-                      Valid values are md5, sha256, sha384, sha512, sha224. Default is md5.',
+        :values   => valid_digest_algorithms,
+        :desc     => "Which digest algorithm to use for file resources and the filebucket.
+                      Valid values are #{valid_digest_algorithms.join(', ')}. Default is
+                      #{default_digest_algorithm}.",
     },
     :supported_checksum_types => {
-      :default => lambda { default_checksum_types },
+      :default => lambda { default_file_checksum_types },
       :type    => :array,
-      :desc    => 'Checksum types supported by this agent for use in file resources of a
-                   static catalog. Values must be comma-separated. Valid types are md5,
-                   md5lite, sha256, sha256lite, sha384, sha512, 
-		   sha1, sha1lite, sha224, mtime, ctime.',
+      :desc    => "Checksum types supported by this agent for use in file resources of a
+                   static catalog. Values must be comma-separated. Valid types are
+                   #{valid_file_checksum_types.join(', ')}. Default is
+                   #{default_file_checksum_types.join(', ')}.",
       :hook    => proc do |value|
         values = munge(value)
-        valid   = ['md5', 'md5lite', 'sha256', 'sha256lite', 'sha384', 'sha512', 'sha224', 'sha1', 'sha1lite', 'mtime', 'ctime']
-        invalid = values.reject {|alg| valid.include?(alg)}
+
+        invalid = values - Puppet.valid_file_checksum_types
         if not invalid.empty?
-          raise ArgumentError, _("Unrecognized checksum types %{invalid} are not supported.") % { invalid: invalid } +
-              ' ' + _("Valid values are %{values}.") % { values: valid }
+          raise ArgumentError, _("Invalid value '%{value}' for parameter %{name}. Allowed values are '%{allowed_values}'") % {
+            value: invalid.first, name: @name, allowed_values: Puppet.valid_file_checksum_types.join("', '")
+          }
         end
       end
     }

data/vendored/puppet/lib/puppet/etc.rb

@@ -109,7 +109,7 @@ module Puppet::Etc
     # Defines Puppet::Etc::Passwd struct class. Contains all of the original
     # member fields of Etc::Passwd, and additional "canonical_" versions of
     # these fields as well. API compatible with Etc::Passwd. Because Struct.new
-    # defines a new Class object, we memozie to avoid superfluous extra Class
+    # defines a new Class object, we memoize to avoid superfluous extra Class
     # instantiations.
     def puppet_etc_passwd_class
       @password_class ||= Struct.new(*Etc::Passwd.members, *Etc::Passwd.members.map { |member| "canonical_#{member}".to_sym })
@@ -133,7 +133,7 @@ module Puppet::Etc
     # @api private
     # @param [Etc::Passwd or Etc::Group struct]
     # @return [Puppet::Etc::Passwd or Puppet::Etc::Group struct] a new struct
-    #   object with the original struct values overidden to UTF-8, if valid. For
+    #   object with the original struct values overridden to UTF-8, if valid. For
     #   invalid values originating in UTF-8, invalid characters are replaced with
     #   '?'. For each member the struct also contains a corresponding
     #   :canonical_<member name> struct member.

data/vendored/puppet/lib/puppet/external/pson/pure/generator.rb

@@ -341,7 +341,7 @@ module PSON
             '"' << PSON.utf8_to_pson(self) << '"'
           end
 
-          # Module that holds the extinding methods if, the String module is
+          # Module that holds the extending methods if, the String module is
           # included.
           module Extend
             # Raw Strings are PSON Objects (the raw bytes are stored in an array for the

data/vendored/puppet/lib/puppet/external/pson/pure/parser.rb

@@ -44,7 +44,7 @@ module PSON
         /(?=\*/)      # single slash before this comment's end
         )*
         \*/               # the End of this comment
-        |[ \t\r\n]+       # whitespaces: space, horicontal tab, lf, cr
+        |[ \t\r\n]+       # whitespaces: space, horizontal tab, lf, cr
       )+
       )mx
 

data/vendored/puppet/lib/puppet/face/config.rb

@@ -129,4 +129,49 @@ https://puppet.com/docs/puppet/latest/configuration.html#environment
       nil
     end
   end
+
+  action(:delete) do
+    summary _("Delete a Puppet setting.")
+    arguments _("(<setting>")
+    #TRANSLATORS 'main' is a specific section name and should not be translated
+    description "Deletes a setting from the specified section. (The default is the section 'main')."
+    notes <<-'EOT'
+      By default, this action deletes the configuration setting from the 'main'
+      configuration domain. Use the '--section' flags to delete settings from other
+      configuration domains.
+    EOT
+    examples <<-'EOT'
+      Delete the setting 'setting_name' from the 'main' configuration domain:
+
+      $ puppet config delete setting_name
+
+      Delete the setting 'setting_name' from the 'master' configuration domain:
+
+      $ puppet config delete setting_name --section master
+    EOT
+
+    when_invoked do |name, options|
+      options[:section] = options[:section].to_s # If value was left as default - set to default string
+
+      path = Puppet::FileSystem.pathname(Puppet.settings.which_configuration_file)
+      if Puppet::FileSystem.exist?(path)
+        Puppet::FileSystem.open(path, nil, 'r+:UTF-8') do |file|
+          Puppet::Settings::IniFile.update(file) do |config|
+            setting_string = config.delete(options[:section], name)
+            if setting_string
+              puts(_("Deleted setting from '%{section_name}': '%{setting_string}'") %
+                       { section_name: options[:section], name: name, setting_string: setting_string.strip })
+            else
+              Puppet.warning(_("No setting found in configuration file for section '%{section_name}' setting name '%{name}'") %
+                                 { section_name: options[:section], name: name })
+            end
+          end
+        end
+      else
+        #TRANSLATORS the 'puppet.conf' is a specific file and should not be translated
+        Puppet.warning(_("The puppet.conf file does not exist %{puppet_conf}") % { puppet_conf: path })
+      end
+      nil
+    end
+  end
 end