bolt 1.20.0 → 1.21.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 12222d708d8694206992e7cb2e89271c4b94ee9a56c40800f723d4f88899ba2f
-  data.tar.gz: 8206b12db4fdd4fc2503252b1671f97f34e4870533baa244accf8b8bb94214e6
+  metadata.gz: e5ccf0b9b2f554bd10a8f4b25eedf4049c6b2820925d614be61a20b29ce64f5e
+  data.tar.gz: 814f77cef6785b3c5978c5b1336f0e8eb6cced7e3e1eb8917c2cbc7c96955deb
 SHA512:
-  metadata.gz: eb78a8b55b5490ca241c513a4be0be6b1ab062109c1895fcdcd11bf802c9540da4cfee2625b8b080821e20d8902795e3845244669cf2b9efe2e15be102bd8662
-  data.tar.gz: ad3321dc6ab500619ddb65083e0af52ff73949fea3e0330da15d0f7c3641d08a0a7a8fd44fca7705063952a654f2ed32893520b3cdcff7bc73dcecc3e07c5d6c
+  metadata.gz: '058a15c710a702ea63e4f989b0f96efa3c2c54a074650e0609dd1157f4fe6818fcaa8f2aaadbf145dbf588411cecf0d686e07821d9ad66994cab59de7ec5a9b5'
+  data.tar.gz: 5292df40ecd9c3db055603aa279db60b2b80ce8ac416756d0c3b5e4fef7f072b7b766e78dd236f2630f00c71d3b27fc59b97681546eb680057e34df18da7dd36

data/bolt-modules/boltlib/lib/puppet/datatypes/resultset.rb

@@ -9,6 +9,7 @@ Puppet::DataTypes.create_type('ResultSet') do
       count => Callable[[], Integer],
       empty => Callable[[], Boolean],
       error_set => Callable[[], ResultSet],
+      filter_set => Callable[[Callable], ResultSet],
       find => Callable[[String[1]], Optional[Variant[Result, ApplyResult]]],
       first => Callable[[], Optional[Variant[Result, ApplyResult]]],
       names => Callable[[], Array[String[1]]],

data/bolt-modules/file/lib/puppet/functions/file/exists.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+# check if a file exists
+Puppet::Functions.create_function(:'file::exists', Puppet::Functions::InternalFunction) do
+  # @param filename Absolute path or Puppet file path.
+  # @example Check a file on disk
+  #   file::exists('/tmp/i_dumped_this_here')
+  # @example check a file from the modulepath
+  #   file::exists('example/files/VERSION')
+  dispatch :exists do
+    scope_param
+    required_param 'String', :filename
+    return_type 'Boolean'
+  end
+
+  def exists(scope, filename)
+    found = Puppet::Parser::Files.find_file(filename, scope.compiler.environment)
+    found && Puppet::FileSystem.exist?(found)
+  end
+end

data/bolt-modules/file/lib/puppet/functions/file/readable.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+# check if a file is readable
+Puppet::Functions.create_function(:'file::readable', Puppet::Functions::InternalFunction) do
+  # @param filename Absolute path or Puppet file path.
+  # @example Check a file on disk
+  #   file::readable('/tmp/i_dumped_this_here')
+  # @example check a file from the modulepath
+  #   file::readable('example/files/VERSION')
+  dispatch :readable do
+    scope_param
+    required_param 'String', :filename
+    return_type 'Boolean'
+  end
+
+  def readable(scope, filename)
+    found = Puppet::Parser::Files.find_file(filename, scope.compiler.environment)
+    found && File.readable?(found)
+  end
+end

data/bolt-modules/out/lib/puppet/functions/out/message.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+# Output a message for the user.
+#
+# This will print a message to stdout when using the human output format.
+#
+# **NOTE:** Not available in apply block
+Puppet::Functions.create_function(:'out::message') do
+  # Output a message.
+  # @param message The message to output.
+  # @example Print a message
+  #   out::message('Something went wrong')
+  dispatch :output_message do
+    param 'String', :message
+    return_type 'Undef'
+  end
+
+  def output_message(message)
+    unless Puppet[:tasks]
+      raise Puppet::ParseErrorWithIssue
+        .from_issue_and_stack(Bolt::PAL::Issues::PLAN_OPERATION_NOT_SUPPORTED_WHEN_COMPILING, action: 'out::message')
+    end
+
+    executor = Puppet.lookup(:bolt_executor)
+    executor.publish_event(type: :message, message: message)
+
+    nil
+  end
+end

data/lib/bolt/cli.rb

@@ -491,25 +491,7 @@ module Bolt
         raise Bolt::CLIError, "A #{type} must be specified"
       end
 
-      stat = file_stat(path)
-
-      if !stat.readable?
-        raise Bolt::FileError.new("The #{type} '#{path}' is unreadable", path)
-      elsif !stat.file? && (!allow_dir || !stat.directory?)
-        expected = allow_dir ? 'file or directory' : 'file'
-        raise Bolt::FileError.new("The #{type} '#{path}' is not a #{expected}", path)
-      elsif stat.directory?
-        Dir.foreach(path) do |file|
-          next if %w[. ..].include?(file)
-          validate_file(type, File.join(path, file), allow_dir)
-        end
-      end
-    rescue Errno::ENOENT
-      raise Bolt::FileError.new("The #{type} '#{path}' does not exist", path)
-    end
-
-    def file_stat(path)
-      File.stat(path)
+      Bolt::Util.validate_file(type, path, allow_dir)
     end
 
     def rerun

data/lib/bolt/outputter/human.rb

@@ -56,6 +56,8 @@ module Bolt
           @disable_depth -= 1
         when :disable_default_output
           @disable_depth += 1
+        when :message
+          print_message_event(event)
         end
       end
 
@@ -334,6 +336,10 @@ module Bolt
         end
       end
 
+      def print_message_event(event)
+        print_message(event[:message])
+      end
+
       def fatal_error(err)
         @stream.puts(colorize(:red, err.message))
         if err.is_a? Bolt::RunFailure
@@ -346,10 +352,10 @@ module Bolt
           end
         end
       end
-    end
 
-    def print_message(message)
-      @stream.puts(message)
+      def print_message(message)
+        @stream.puts(message)
+      end
     end
   end
 end

data/lib/bolt/plugin/puppetdb.rb

@@ -3,8 +3,19 @@
 module Bolt
   class Plugin
     class Puppetdb
+      class FactLookupError < Bolt::Error
+        def initialize(fact, err = nil)
+          m = String.new("Fact lookup '#{fact}' contains an invalid factname")
+          m << ": #{err}" unless err.nil?
+          super(m, 'bolt.plugin/fact-lookup-error')
+        end
+      end
+
+      TARGET_OPTS = %w[uri name config].freeze
+
       def initialize(pdb_client)
         @puppetdb_client = pdb_client
+        @logger = Logging.logger[self]
       end
 
       def name
@@ -15,9 +26,61 @@ module Bolt
         ['lookup_targets']
       end
 
+      def warn_missing_fact(certname, fact)
+        @logger.warn("Could not find fact #{fact} for node #{certname}")
+      end
+
+      def fact_path(raw_fact)
+        fact_path = raw_fact.split(".")
+        if fact_path[0] == 'facts'
+          fact_path.drop(1)
+        elsif fact_path == ['certname']
+          fact_path
+        else
+          raise FactLookupError.new(raw_fact, "fact lookups must start with 'facts.'")
+        end
+      end
+
       def lookup_targets(opts)
-        nodes = @puppetdb_client.query_certnames(opts['query'])
-        nodes.map { |certname| { 'uri' => certname } }
+        targets = @puppetdb_client.query_certnames(opts['query'])
+        facts = []
+
+        target_opts = opts.select { |k, _| TARGET_OPTS.include?(k) }
+        Bolt::Util.walk_vals(target_opts) do |value|
+          # This is done in parts instead of in place so that we only need to
+          # make one puppetDB query
+          if value.is_a?(String)
+            facts << fact_path(value)
+          end
+          value
+        end
+
+        facts.uniq!
+        # Returns {'mycertname' => [{'path' => ['nested', 'fact'], 'value' => val'}], ... }
+        fact_values = @puppetdb_client.fact_values(targets, facts)
+
+        targets.map do |certname|
+          target_data = fact_values[certname]
+          target = resolve_facts(target_opts, certname, target_data) || {}
+          target['uri'] = certname unless target['uri'] || target['name']
+
+          target
+        end
+      end
+
+      def resolve_facts(config, certname, target_data)
+        Bolt::Util.walk_vals(config) do |value|
+          if value.is_a?(String)
+            data = target_data&.detect { |d| d['path'] == fact_path(value) }
+            warn_missing_fact(certname, value) if data.nil?
+            # If there's no fact data this will be nil
+            data&.fetch('value', nil)
+          elsif value.is_a?(Array) || value.is_a?(Hash)
+            value
+          else
+            raise FactLookupError.new(value, "fact lookups must be a string")
+          end
+        end
       end
     end
   end

data/lib/bolt/puppetdb/client.rb

@@ -42,6 +42,22 @@ module Bolt
         end
       end
 
+      def fact_values(certnames = [], facts = [])
+        return {} if certnames.empty? || facts.empty?
+
+        certnames.uniq!
+        name_query = certnames.map { |c| ["=", "certname", c] }
+        name_query.insert(0, "or")
+
+        facts_query = facts.map { |f| ["=", "path", f] }
+        facts_query.insert(0, "or")
+
+        query = ['and', name_query, facts_query]
+        result = make_query(query, 'fact-contents')
+        result.map! { |h| h.delete_if { |k, _v| %w[environment name].include?(k) } }
+        result.group_by { |c| c['certname'] }
+      end
+
       def make_query(query, path = nil)
         body = JSON.generate(query: query)
         url = "#{uri}/pdb/query/v4"

data/lib/bolt/result_set.rb

@@ -30,6 +30,11 @@ module Bolt
       self
     end
 
+    def filter_set
+      filtered = @results.select { |r| yield r }
+      self.class.new(filtered)
+    end
+
     def result_hash
       @result_hash ||= @results.each_with_object({}) do |result, acc|
         acc[result.target.name] = result

data/lib/bolt/transport/docker.rb

@@ -8,7 +8,7 @@ module Bolt
   module Transport
     class Docker < Base
       def self.options
-        %w[host service-url service-options tmpdir interpreters]
+        %w[host service-url service-options tmpdir interpreters shell-command tty]
       end
 
       def provided_features
@@ -56,9 +56,17 @@ module Bolt
         end
       end
 
-      def run_command(target, command, _options = {})
+      def run_command(target, command, options = {})
+        if target.options['tty']
+          options[:Tty] = true
+        end
+        if target.options['shell-command'] && !target.options['shell-command'].empty?
+          # escape any double quotes in command
+          command = command.gsub('"', '\"')
+          command = "#{target.options['shell-command']} \" #{command}\""
+        end
         with_connection(target) do |conn|
-          stdout, stderr, exitcode = conn.execute(*Shellwords.split(command), {})
+          stdout, stderr, exitcode = conn.execute(*Shellwords.split(command), options)
           Bolt::Result.for_command(target, stdout, stderr, exitcode, 'command', command)
         end
       end

data/lib/bolt/transport/ssh/connection.rb

@@ -30,6 +30,14 @@ module Bolt
 
           @logger = Logging.logger[@target.host]
           @transport_logger = transport_logger
+
+          if target.options['private-key']&.instance_of?(String)
+            begin
+              Bolt::Util.validate_file('ssh key', target.options['private-key'])
+            rescue Bolt::FileError => e
+              @logger.warn(e.msg)
+            end
+          end
         end
 
         PAGEANT_NAME = "Pageant\0".encode(Encoding::UTF_16LE)

data/lib/bolt/util.rb

@@ -179,6 +179,29 @@ module Bolt
         end
       end
 
+      # This is stubbed for testing validate_file
+      def file_stat(path)
+        File.stat(File.expand_path(path))
+      end
+
+      def validate_file(type, path, allow_dir = false)
+        stat = file_stat(path)
+
+        if !stat.readable?
+          raise Bolt::FileError.new("The #{type} '#{path}' is unreadable", path)
+        elsif !stat.file? && (!allow_dir || !stat.directory?)
+          expected = allow_dir ? 'file or directory' : 'file'
+          raise Bolt::FileError.new("The #{type} '#{path}' is not a #{expected}", path)
+        elsif stat.directory?
+          Dir.foreach(path) do |file|
+            next if %w[. ..].include?(file)
+            validate_file(type, File.join(path, file), allow_dir)
+          end
+        end
+      rescue Errno::ENOENT
+        raise Bolt::FileError.new("The #{type} '#{path}' does not exist", path)
+      end
+
       # Returns true if windows false if not.
       def windows?
         !!File::ALT_SEPARATOR

data/lib/bolt/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bolt
 version: !ruby/object:Gem::Version
-  version: 1.20.0
+  version: 1.21.0
 platform: ruby
 authors:
 - Puppet
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-05-16 00:00:00.000000000 Z
+date: 2019-05-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: addressable
@@ -346,8 +346,11 @@ files:
 - bolt-modules/boltlib/types/targetspec.pp
 - bolt-modules/ctrl/lib/puppet/functions/ctrl/do_until.rb
 - bolt-modules/ctrl/lib/puppet/functions/ctrl/sleep.rb
+- bolt-modules/file/lib/puppet/functions/file/exists.rb
 - bolt-modules/file/lib/puppet/functions/file/read.rb
+- bolt-modules/file/lib/puppet/functions/file/readable.rb
 - bolt-modules/file/lib/puppet/functions/file/write.rb
+- bolt-modules/out/lib/puppet/functions/out/message.rb
 - bolt-modules/system/lib/puppet/functions/system/env.rb
 - exe/bolt
 - exe/bolt-inventory-pdb