bolt 0.18.0 → 0.18.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9b5850dae92768743f9faa35a5972efc6c3b83da
-  data.tar.gz: 80c524fd01e4b66c1d969e1c98fe29bbf836369d
+  metadata.gz: 0658ba25967cd7fac93e3b0c410793f2d389849f
+  data.tar.gz: f7a6cafb673449de219fb9bade1e672d4ff858eb
 SHA512:
-  metadata.gz: 50ee00db02f62fafeb43d1553186442728db8dfc8d69ec646fd284415b6595c78445a95435d90fd894071ce5c7c39ec3d0f06dbb52337be648e237ebebb97677
-  data.tar.gz: bc78146c6b867e02c70fb4ea612c498a6ac1260917c490a31c0435a4978a1777fc763f34013e31d65d88dedb537a647ed2656a6a92a7d3ede3af13191b48f256
+  metadata.gz: 3908b25652b38dd0a7e48656b3442fe6b5e85fd23942dbb2be207f4f4f39397b18d7b87706791075773b53c0d297d0b9ba8743a0070c5bcde8d8d7be11a71ce8
+  data.tar.gz: e837918752a7e2cc2ac2bff3aa72f480c4fcf7f498fca15cf355a9cb2b7bc24faa2e91b1684e7650ead33a06315961ceb6792148b70cff974bc0e960972454ca

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

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+require 'bolt/error'
+
+# Returns a hash of certname to facts objects for each matched Target.  This
+# functions accepts an array of certnames and returns a hash of target
+# certnames and their corresponding facts hash.
+#
+# * If a node is not found in PuppetDB, it's included in the returned hash with empty facts hash.
+# * Otherwise the node is included in the hash with a value that is a hash of it's facts.
+#
+Puppet::Functions.create_function(:puppetdb_fact) do
+  dispatch :puppetdb_fact do
+    param 'Array[String]', :targets
+  end
+
+  def puppetdb_fact(targets)
+    unless Puppet[:tasks]
+      raise Puppet::ParseErrorWithIssue.from_issue_and_stack(
+        Puppet::Pops::Issues::TASK_OPERATION_NOT_SUPPORTED_WHEN_COMPILING, operation: 'puppetdb_fact'
+      )
+    end
+
+    executor = Puppet.lookup(:bolt_executor) { nil }
+    executor.puppetdb_fact(targets)
+  end
+end

data/lib/bolt/cli.rb

@@ -116,20 +116,15 @@ Available options are:
         @options = options
 
         @nodes = define('-n', '--nodes NODES',
-                        'Node(s) to connect to in URI format [protocol://]host[:port] (Optional)',
-                        'Eg. --nodes bolt.puppet.com',
-                        'Eg. --nodes localhost,ssh://nix.com:2222,winrm://windows.puppet.com',
-                        # An empty line in a switch description causes the OptionParser#help
-                        # method to raise an exception. Specifying a line containing only a
-                        # newline is the closest one can get to the empty line without
-                        # triggering that exception.
-                        "\n",
-                        '* NODES can either be comma-separated, \'@<file>\' to read',
-                        '* nodes from a file, or \'-\' to read from stdin',
-                        '* Windows nodes must specify protocol with winrm://',
-                        '* protocol is `ssh` by default, may be `ssh` or `winrm`',
-                        '* port defaults to `22` for SSH',
-                        '* port defaults to `5985` or `5986` for WinRM, based on the --[no-]ssl setting') do |nodes|
+                        'Identifies the nodes to target.',
+                        'Enter a comma-separated list of node URIs or group names.',
+                        "Or read a node list from an input file '@<file>' or stdin '-'.",
+                        'Example: --nodes localhost,node_group,ssh://nix.com:2222,winrm://windows.puppet.com',
+                        'URI format is [protocol://]host[:port]',
+                        "SSH is the default protocol; may be #{TRANSPORTS.keys.join(', ')}",
+                        'For Windows nodes, specify the winrm:// protocol if it has not be configured',
+                        'For SSH, port defaults to `22`',
+                        'For WinRM, port defaults to `5985` or `5986` based on the --[no-]ssl setting') do |nodes|
           @options[:nodes] << get_arg_input(nodes)
         end.extend(SwitchHider)
         @query = define('-q', '--query QUERY',
@@ -137,11 +132,11 @@ Available options are:
           @options[:query] = query
         end.extend(SwitchHider)
         define('-u', '--user USER',
-               'User to authenticate as (Optional)') do |user|
+               'User to authenticate as') do |user|
           @options[:user] = user
         end
         define('-p', '--password [PASSWORD]',
-               'Password to authenticate with (Optional).',
+               'Password to authenticate with.',
                'Omit the value to prompt for the password.') do |password|
           if password.nil?
             STDOUT.print "Please enter your password: "
@@ -152,25 +147,25 @@ Available options are:
           end
         end
         define('--private-key KEY',
-               'Private ssh key to authenticate with (Optional)') do |key|
+               'Private ssh key to authenticate with') do |key|
           @options[:'private-key'] = key
         end
         define('--tmpdir DIR',
-               'The directory to upload and execute temporary files on the target (Optional)') do |tmpdir|
+               'The directory to upload and execute temporary files on the target') do |tmpdir|
           @options[:tmpdir] = tmpdir
         end
         define('-c', '--concurrency CONCURRENCY', Integer,
                'Maximum number of simultaneous connections ' \
-               '(Optional, defaults to 100)') do |concurrency|
+               '(defaults to 100)') do |concurrency|
           @options[:concurrency] = concurrency
         end
         define('--connect-timeout TIMEOUT', Integer,
-               'Connection timeout (Optional)') do |timeout|
+               'Connection timeout (defaults vary)') do |timeout|
           @options[:'connect-timeout'] = timeout
         end
         define('--modulepath MODULES',
                'List of directories containing modules, ' \
-               "separated by #{File::PATH_SEPARATOR}") do |modulepath|
+               "separated by '#{File::PATH_SEPARATOR}'") do |modulepath|
           @options[:modulepath] = modulepath.split(File::PATH_SEPARATOR)
         end
         define('--params PARAMETERS',

data/lib/bolt/error.rb

@@ -63,4 +63,14 @@ module Bolt
       @error_code = 2
     end
   end
+
+  class PuppetError < Error
+    def self.convert_puppet_errors(result)
+      Bolt::Util.walk_vals(result) { |v| v.is_a?(Puppet::DataTypes::Error) ? from_error(v) : v }
+    end
+
+    def self.from_error(err)
+      new(err.msg, err.kind, err.details, err.issue_code)
+    end
+  end
 end

data/lib/bolt/executor.rb

@@ -9,6 +9,7 @@ require 'bolt/result'
 require 'bolt/config'
 require 'bolt/notifier'
 require 'bolt/result_set'
+require 'bolt/puppetdb'
 
 module Bolt
   class Executor
@@ -154,5 +155,17 @@ module Bolt
       @notifier.shutdown
       results
     end
+
+    def puppetdb_client
+      return @puppetdb_client if @puppetdb_client
+      puppetdb_config = Bolt::PuppetDB::Config.new(nil, @config.puppetdb)
+      @puppetdb_client = Bolt::PuppetDB::Client.from_config(puppetdb_config)
+    end
+
+    def puppetdb_fact(certnames)
+      puppetdb_client.facts_for_node(certnames)
+    rescue StandardError => e
+      raise Bolt::CLIError, "Could not retrieve targets from PuppetDB: #{e}"
+    end
   end
 end

data/lib/bolt/inventory.rb

@@ -93,7 +93,7 @@ module Bolt
     end
 
     def vars(target)
-      @target_vars[target.name]
+      @target_vars[target.name] || {}
     end
 
     def add_facts(target, new_facts = {})
@@ -102,7 +102,7 @@ module Bolt
     end
 
     def facts(target)
-      @target_facts[target.name]
+      @target_facts[target.name] || {}
     end
 
     #### PRIVATE ####

data/lib/bolt/pal.rb

@@ -41,14 +41,6 @@ module Bolt
       # Now that puppet is loaded we can include puppet mixins in data types
       Bolt::ResultSet.include_iterable
 
-      # TODO: This is a hack for PUP-8441 remove it once that is fixed
-      require_relative '../../vendored/puppet/lib/puppet/datatypes/impl/error.rb'
-      Puppet::DataTypes::Error.class_eval do
-        def to_json(opts = nil)
-          _pcore_init_hash.to_json(opts)
-        end
-      end
-
       unless Puppet.settings.global_defaults_initialized?
         Puppet.initialize_settings
       end
@@ -99,7 +91,8 @@ module Bolt
         end
       end
 
-      if r.is_a? StandardError
+      # Plans may return PuppetError but nothing should be throwing them
+      if r.is_a?(StandardError) && !r.is_a?(Bolt::PuppetError)
         raise r
       end
       r
@@ -153,7 +146,7 @@ module Bolt
     def parse_params(type, object_name, params)
       in_bolt_compiler do |compiler|
         if type == 'task'
-          param_spec = compiler.task_signature(object_name)&.task_hash&.dig('parameters')
+          param_spec = compiler.task_signature(object_name)&.task_hash
         elsif type == 'plan'
           plan = compiler.plan_signature(object_name)
           param_spec = plan_hash(object_name, plan) if plan
@@ -161,7 +154,7 @@ module Bolt
         param_spec ||= {}
 
         params.each_with_object({}) do |(name, str), acc|
-          type = param_spec.dig(name, 'type')
+          type = param_spec.dig('parameters', name, 'type')
           begin
             parsed = JSON.parse(str, quirks_mode: true)
             # The type may not exist if the module is remote on orch or if a task
@@ -199,10 +192,11 @@ module Bolt
       end
     end
 
-    # This coverts a plan signature object into a format approximating
-    # the task_hash of a task_signature
+    # This converts a plan signature object into a format approximating the
+    # task_hash of a task_signature. Must be called from within bolt compiler
+    # to pickup type aliases used in the plan signature.
     def plan_hash(plan_name, plan)
-      elements = plan.params_type.elements || {}
+      elements = plan.params_type.elements || []
       parameters = elements.each_with_object({}) do |param, acc|
         acc[param.name] = { 'type' => param.value_type }
         acc[param.name]['default_value'] = nil if param.key_type.is_a?(Puppet::Pops::Types::POptionalType)
@@ -214,14 +208,15 @@ module Bolt
     end
 
     def get_plan_info(plan_name)
-      plan = in_bolt_compiler do |compiler|
-        compiler.plan_signature(plan_name)
+      plan_info = in_bolt_compiler do |compiler|
+        plan = compiler.plan_signature(plan_name)
+        plan_hash(plan_name, plan) if plan
       end
 
-      if plan.nil?
+      if plan_info.nil?
         raise Bolt::CLIError, Bolt::Error.unknown_plan(plan_name)
       end
-      plan_hash(plan_name, plan)
+      plan_info
     end
 
     def run_task(task_name, targets, params, executor, inventory, &eventblock)
@@ -232,7 +227,8 @@ module Bolt
 
     def run_plan(plan_name, params, executor = nil, inventory = nil)
       in_plan_compiler(executor, inventory) do |compiler|
-        compiler.call_function('run_plan', plan_name, params)
+        r = compiler.call_function('run_plan', plan_name, params)
+        Bolt::PuppetError.convert_puppet_errors(r)
       end
     end
   end

data/lib/bolt/puppetdb/client.rb

@@ -51,6 +51,33 @@ module Bolt
         end
       end
 
+      # This method expects an array of certnames to get facts for
+      def facts_for_node(certnames)
+        return {} if certnames.empty? || certnames.nil?
+
+        # This inits a hash of {certname1 => {}, certname2 => {}} etc.
+        output = Hash[certnames.product([{}])]
+
+        certnames.uniq!
+        name_query = certnames.map { |c| ["=", "certname", c] }
+        name_query.insert(0, "or")
+        body = JSON.generate(query: name_query)
+
+        response = http_client.post("#{@uri}/pdb/query/v4/facts", body: body, header: headers)
+        if response.code != 200
+          raise Bolt::PuppetDBError, "Failed to query PuppetDB: #{response.body}"
+        else
+          parsed = JSON.parse(response.body)
+        end
+
+        # Parse the data
+        parsed&.each do |f|
+          output[f['certname']][f['name']] = f['value']
+        end
+
+        output
+      end
+
       def http_client
         return @http if @http
         @http = HTTPClient.new

data/lib/bolt/transport/local.rb

@@ -32,8 +32,6 @@ module Bolt
             yield dir
           end
         end
-      rescue StandardError => e
-        raise Bolt::Node::FileError.new("Could not make tempdir: #{e.message}", 'TEMPDIR_ERROR')
       end
       private :in_tmpdir
 

data/lib/bolt/transport/local/shell.rb

@@ -9,7 +9,7 @@ module Bolt
       class Shell
         def execute(*command, options)
           if options[:env]
-            env = options[:env].each_with_object({}) { |(k, v), h| h["PT_#{k}"] = v }
+            env = options[:env].each_with_object({}) { |(k, v), h| h["PT_#{k}"] = v.to_s }
             command = [env] + command
           end
 

data/lib/bolt/util.rb

@@ -46,7 +46,7 @@ module Bolt
       end
 
       # Accepts a Data object and returns a copy with all hash keys
-      # modifed by block. use &:to_s to stringify keys or :to_sym to symbolize them
+      # modified by block. use &:to_s to stringify keys or &:to_sym to symbolize them
       def walk_keys(data, &block)
         if data.is_a? Hash
           data.each_with_object({}) do |(k, v), acc|
@@ -60,6 +60,20 @@ module Bolt
         end
       end
 
+      # Accepts a Data object and returns a copy with all hash and array values
+      # Arrays and hashes including the initial object are modified before
+      # their descendants are.
+      def walk_vals(data, &block)
+        data = yield(data)
+        if data.is_a? Hash
+          map_vals(data) { |v| walk_vals(v, &block) }
+        elsif data.is_a? Array
+          data.map { |v| walk_vals(v, &block) }
+        else
+          data
+        end
+      end
+
       # Performs a deep_clone, using an identical copy if the cloned structure contains multiple
       # references to the same object and prevents endless recursion.
       # Credit to Jan Molic via https://github.com/rubyworks/facets/blob/master/LICENSE.txt

data/lib/bolt/version.rb

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

data/lib/bolt_ext/puppetdb_inventory.rb

@@ -1,7 +1,7 @@
 #!/usr/bin/env ruby
 # frozen_string_literal: true
 
-require 'bolt/puppetdb/config'
+require 'bolt/puppetdb'
 require 'json'
 require 'httpclient'
 require 'optparse'

data/modules/puppetdb_fact/plans/init.pp

@@ -0,0 +1,10 @@
+plan puppetdb_fact(TargetSpec $nodes) {
+  $targets = get_targets($nodes)
+  $certnames = $targets.map |$target| { $target.host }
+  $pdb_facts = puppetdb_fact($certnames)
+  $targets.each |$target| {
+    add_facts($target, $pdb_facts[$target.host])
+  }
+
+  return $pdb_facts
+}

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bolt
 version: !ruby/object:Gem::Version
-  version: 0.18.0
+  version: 0.18.1
 platform: ruby
 authors:
 - Puppet
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-03-22 00:00:00.000000000 Z
+date: 2018-03-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: addressable
@@ -327,6 +327,7 @@ files:
 - bolt-modules/boltlib/lib/puppet/functions/fail_plan.rb
 - bolt-modules/boltlib/lib/puppet/functions/file_upload.rb
 - bolt-modules/boltlib/lib/puppet/functions/get_targets.rb
+- bolt-modules/boltlib/lib/puppet/functions/puppetdb_fact.rb
 - bolt-modules/boltlib/lib/puppet/functions/run_command.rb
 - bolt-modules/boltlib/lib/puppet/functions/run_plan.rb
 - bolt-modules/boltlib/lib/puppet/functions/run_script.rb
@@ -376,6 +377,7 @@ files:
 - modules/canary/lib/puppet/functions/canary/random_split.rb
 - modules/canary/lib/puppet/functions/canary/skip.rb
 - modules/canary/plans/init.pp
+- modules/puppetdb_fact/plans/init.pp
 - vendored/facter/lib/facter.rb
 - vendored/facter/lib/facter/Cfkey.rb
 - vendored/facter/lib/facter/application.rb