bolt 2.8.0 → 2.12.0

data/lib/bolt/config/transport/winrm.rb

@@ -7,6 +7,8 @@ module Bolt
   class Config
     module Transport
       class WinRM < Base
+        # NOTE: All transport configuration options should have a corresponding schema definition
+        #       in schemas/bolt-transport-definitions.json
         OPTIONS = {
           "basic-auth-only" => { type: TrueClass,
                                  desc: "Force basic authentication. This option is only available when using SSL." },

data/lib/bolt/inventory.rb

@@ -15,6 +15,7 @@ module Bolt
 
     class ValidationError < Bolt::Error
       attr_accessor :path
+
       def initialize(message, offending_group)
         super(message, 'bolt.inventory/validation-error')
         @_message = message
@@ -83,7 +84,7 @@ module Bolt
 
     def self.empty
       config  = Bolt::Config.default
-      plugins = Bolt::Plugin.setup(config, nil, nil, Bolt::Analytics::NoopClient)
+      plugins = Bolt::Plugin.setup(config, nil)
 
       create_version({}, config.transport, config.transports, plugins)
     end

data/lib/bolt/inventory/group.rb

@@ -12,6 +12,7 @@ module Bolt
       # Regex used to validate group names and target aliases.
       NAME_REGEX = /\A[a-z0-9_][a-z0-9_-]*\Z/.freeze
 
+      # NOTE: All keys should have a corresponding schema property in schemas/bolt-inventory.schema.json
       DATA_KEYS = %w[config facts vars features plugin_hooks].freeze
       TARGET_KEYS = DATA_KEYS + %w[name alias uri]
       GROUP_KEYS = DATA_KEYS + %w[name groups targets]

data/lib/bolt/inventory/inventory.rb

@@ -7,6 +7,7 @@ module Bolt
   class Inventory
     class Inventory
       attr_reader :targets, :plugins, :config, :transport
+
       class WildcardError < Bolt::Error
         def initialize(target)
           super("Found 0 targets matching wildcard pattern #{target}", 'bolt.inventory/wildcard-error')
@@ -318,6 +319,10 @@ module Bolt
       def target_config(target)
         @targets[target.name].config
       end
+
+      def resources(target)
+        @targets[target.name].resources
+      end
     end
   end
 end

data/lib/bolt/inventory/target.rb

@@ -1,10 +1,12 @@
 # frozen_string_literal: true
 
+require 'bolt/resource_instance'
+
 module Bolt
   class Inventory
     # This class represents the active state of a target within the inventory.
     class Target
-      attr_reader :name, :uri, :safe_name, :target_alias
+      attr_reader :name, :uri, :safe_name, :target_alias, :resources
 
       def initialize(target_data, inventory)
         unless target_data['name'] || target_data['uri']
@@ -36,12 +38,26 @@ module Bolt
         # When alias is specified in a plan, the key will be `target_alias`, when
         # alias is specified in inventory the key will be `alias`.
         @target_alias = target_data['target_alias'] || target_data['alias'] || []
+        @resources = {}
 
         @inventory = inventory
 
         validate
       end
 
+      # rubocop:disable Naming/AccessorMethodName
+      def set_resource(resource)
+        if (existing_resource = resources[resource.reference])
+          existing_resource.overwrite_state(resource.state)
+          existing_resource.overwrite_desired_state(resource.desired_state)
+          existing_resource.events = existing_resource.events + resource.events
+          existing_resource
+        else
+          @resources[resource.reference] = resource
+        end
+      end
+      # rubocop:enable Naming/AccessorMethodName
+
       def vars
         group_cache['vars'].merge(@vars)
       end

data/lib/bolt/node/output.rb

@@ -12,7 +12,7 @@ module Bolt
       def initialize
         @stdout = StringIO.new
         @stderr = StringIO.new
-        @exit_code = 'unkown'
+        @exit_code = 'unknown'
       end
     end
   end

data/lib/bolt/outputter/human.rb

@@ -107,13 +107,14 @@ module Bolt
 
           # Use special handling if the result looks like a command or script result
           if result.generic_value.keys == %w[stdout stderr exit_code]
-            unless result['stdout'].strip.empty?
+            safe_value = result.safe_value
+            unless safe_value['stdout'].strip.empty?
               @stream.puts(indent(2, "STDOUT:"))
-              @stream.puts(indent(4, result['stdout']))
+              @stream.puts(indent(4, safe_value['stdout']))
             end
-            unless result['stderr'].strip.empty?
+            unless safe_value['stderr'].strip.empty?
               @stream.puts(indent(2, "STDERR:"))
-              @stream.puts(indent(4, result['stderr']))
+              @stream.puts(indent(4, safe_value['stderr']))
             end
           elsif result.generic_value.any?
             @stream.puts(indent(2, ::JSON.pretty_generate(result.generic_value)))

data/lib/bolt/outputter/json.rb

@@ -28,7 +28,7 @@ module Bolt
 
       def print_result(result)
         @stream.puts ',' if @preceding_item
-        @stream.puts result.status_hash.to_json
+        @stream.puts result.to_json
         @preceding_item = true
       end
 

data/lib/bolt/pal.rb

@@ -329,7 +329,8 @@ module Bolt
         raise Bolt::Error.unknown_plan(plan_name)
       end
 
-      mod = plan_sig.instance_variable_get(:@plan_func).loader.parent.path
+      # path may be a Pathname object, so make sure to stringify it
+      mod = plan_sig.instance_variable_get(:@plan_func).loader.parent.path.to_s
 
       # If it's a Puppet language plan, use strings to extract data. The only
       # way to tell is to check which filename exists in the module.
@@ -358,6 +359,7 @@ module Bolt
           name = param.name
           if signature_params.include?(name)
             params[name] = { 'type' => param.types.first }
+            params[name]['sensitive'] = param.types.first =~ /\ASensitive(\[.*\])?\z/ ? true : false
             params[name]['default_value'] = defaults[name] if defaults.key?(name)
             params[name]['description'] = param.text unless param.text.empty?
           else
@@ -389,6 +391,7 @@ module Bolt
                        param.type_expr
                      end
           params[name] = { 'type' => type_str }
+          params[name]['sensitive'] = param.type_expr.instance_of?(Puppet::Pops::Types::PSensitiveType)
           params[name]['default_value'] = param.value
           params[name]['description'] = param.description if param.description
         end

data/lib/bolt/pal/yaml_plan.rb

@@ -99,6 +99,7 @@ module Bolt
       # logic.
       class EvaluableString
         attr_reader :value
+
         def initialize(value)
           @value = value
         end

data/lib/bolt/plugin.rb

@@ -119,13 +119,9 @@ module Bolt
       end
     end
 
-    def self.setup(config, pal, pdb_client, analytics)
+    def self.setup(config, pal, analytics = Bolt::Analytics::NoopClient.new)
       plugins = new(config, pal, analytics)
 
-      # PDB is special because it needs the PDB client. Since it has no config,
-      # we can just add it first.
-      plugins.add_plugin(Bolt::Plugin::Puppetdb.new(pdb_client))
-
       # Initialize any plugins referenced in plugin config. This will also indirectly
       # initialize any plugins they depend on.
       if plugins.reference?(config.plugins)
@@ -142,7 +138,7 @@ module Bolt
       plugins
     end
 
-    RUBY_PLUGINS = %w[task prompt env_var].freeze
+    RUBY_PLUGINS = %w[task prompt env_var puppetdb].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
@@ -161,6 +157,13 @@ module Bolt
       @unknown = Set.new
       @resolution_stack = []
       @unresolved_plugin_configs = config.plugins.dup
+      # The puppetdb plugin config comes from the puppetdb section, not from
+      # the plugins section
+      if @unresolved_plugin_configs.key?('puppetdb')
+        msg = "Configuration for the PuppetDB plugin must be in the 'puppetdb' config section, not 'plugins'"
+        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
 
@@ -168,7 +171,6 @@ module Bolt
       @modules ||= Bolt::Module.discover(@pal.modulepath)
     end
 
-    # Generally this is private. Puppetdb is special though
     def add_plugin(plugin)
       @plugins[plugin.name] = plugin
     end
@@ -235,6 +237,10 @@ module Bolt
       end
     end
 
+    def puppetdb_client
+      by_name('puppetdb').puppetdb_client
+    end
+
     # Evaluate all _plugin references in a data structure. Leaves are
     # evaluated and then their parents are evaluated with references replaced
     # by their values. If the result of a reference contains more references,

data/lib/bolt/plugin/puppetdb.rb

@@ -14,8 +14,11 @@ module Bolt
       TEMPLATE_OPTS = %w[alias config facts features name uri vars].freeze
       PLUGIN_OPTS = %w[_plugin query target_mapping].freeze
 
-      def initialize(pdb_client)
-        @puppetdb_client = pdb_client
+      attr_reader :puppetdb_client
+
+      def initialize(config:, context:)
+        pdb_config = Bolt::PuppetDB::Config.load_config(config, context.boltdir)
+        @puppetdb_client = Bolt::PuppetDB::Client.new(pdb_config)
         @logger = Logging.logger[self]
       end
 

data/lib/bolt/project.rb

@@ -16,7 +16,18 @@ module Bolt
                 :puppetfile, :rerunfile, :type, :resource_types
 
     def self.default_project
-      Project.new(File.join('~', '.puppetlabs', 'bolt'), 'user')
+      Project.new(File.expand_path(File.join('~', '.puppetlabs', 'bolt')), 'user')
+    # If homedir isn't defined use the system config path
+    rescue ArgumentError
+      Project.new(system_path, 'system')
+    end
+
+    def self.system_path
+      if Bolt::Util.windows?
+        File.join(Dir::COMMON_APPDATA, 'PuppetLabs', 'bolt', 'etc')
+      else
+        File.join('/etc', 'puppetlabs', 'bolt')
+      end
     end
 
     # Search recursively up the directory hierarchy for the Project. Look for a
@@ -27,7 +38,7 @@ module Bolt
       dir = Pathname.new(dir)
       if (dir + BOLTDIR_NAME).directory?
         new(dir + BOLTDIR_NAME, 'embedded')
-      elsif (dir + 'bolt.yaml').file?
+      elsif (dir + 'bolt.yaml').file? || (dir + 'bolt-project.yaml').file?
         new(dir, 'local')
       elsif dir.root?
         default_project
@@ -47,7 +58,7 @@ module Bolt
       @resource_types = @path + '.resource_types'
       @type = type
 
-      @project_file = @path + 'project.yaml'
+      @project_file = @path + 'bolt-project.yaml'
       @data = Bolt::Util.read_optional_yaml_hash(File.expand_path(@project_file), 'project') || {}
       validate if load_as_module?
     end
@@ -72,7 +83,7 @@ module Bolt
     end
 
     def name
-      # If the project is in mymod/Boltdir/project.yaml, use mymod as the project name
+      # If the project is in mymod/Boltdir/bolt-project.yaml, use mymod as the project name
       dirname = @path.basename.to_s == 'Boltdir' ? @path.parent.basename.to_s : @path.basename.to_s
       pname = @data['name'] || dirname
       pname.include?('-') ? pname.split('-', 2)[1] : pname
@@ -100,7 +111,7 @@ module Bolt
       n = @data['name']
       if n && !project_directory_name?(n) && !project_namespaced_name?(n)
         raise Bolt::ValidationError, <<~ERROR_STRING
-        Invalid project name '#{n}' in project.yaml; project names must match either:
+        Invalid project name '#{n}' in bolt-project.yaml; project names must match either:
         An installed project name (ex. projectname) matching the expression /^[a-z][a-z0-9_]*$/ -or-
         A namespaced project name (ex. author-projectname) matching the expression /^[a-zA-Z0-9]+[-][a-z][a-z0-9_]*$/
         ERROR_STRING
@@ -110,7 +121,7 @@ module Bolt
         A project name (ex. projectname) matching the expression /^[a-z][a-z0-9_]*$/ -or-
         A namespaced project name (ex. author-projectname) matching the expression /^[a-zA-Z0-9]+[-][a-z][a-z0-9_]*$/
 
-        Configure project name in <project_dir>/project.yaml
+        Configure project name in <project_dir>/bolt-project.yaml
         ERROR_STRING
       # If the project name is the same as one of the built-in modules raise a warning
       elsif Dir.children(Bolt::PAL::BOLTLIB_PATH).include?(name)
@@ -120,9 +131,16 @@ module Bolt
 
       %w[tasks plans].each do |conf|
         unless @data.fetch(conf, []).is_a?(Array)
-          raise Bolt::ValidationError, "'#{conf}' in project.yaml must be an array"
+          raise Bolt::ValidationError, "'#{conf}' in bolt-project.yaml must be an array"
         end
       end
     end
+
+    def check_deprecated_file
+      if (@path + 'project.yaml').file?
+        logger = Logging.logger[self]
+        logger.warn "Project configuration file 'project.yaml' is deprecated; use 'bolt-project.yaml' instead."
+      end
+    end
   end
 end

data/lib/bolt/puppetdb/config.rb

@@ -22,27 +22,20 @@ module Bolt
         File.expand_path(File.join(Dir::COMMON_APPDATA, 'PuppetLabs/client-tools/puppetdb.conf'))
       end
 
-      def self.load_config(filename, options, project_path = nil)
+      def self.load_config(options, project_path = nil)
         config = {}
         global_path = Bolt::Util.windows? ? default_windows_config : DEFAULT_CONFIG[:global]
-        if filename
-          if File.exist?(filename)
-            config = JSON.parse(File.read(filename))
-          else
-            raise Bolt::PuppetDBError, "config file #{filename} does not exist"
-          end
-        else
-          if File.exist?(DEFAULT_CONFIG[:user])
-            filepath = DEFAULT_CONFIG[:user]
-          elsif File.exist?(global_path)
-            filepath = global_path
-          end
 
-          begin
-            config = JSON.parse(File.read(filepath)) if filepath
-          rescue StandardError => e
-            Logging.logger[self].error("Could not load puppetdb.conf from #{filepath}: #{e.message}")
-          end
+        if File.exist?(DEFAULT_CONFIG[:user])
+          filepath = DEFAULT_CONFIG[:user]
+        elsif File.exist?(global_path)
+          filepath = global_path
+        end
+
+        begin
+          config = JSON.parse(File.read(filepath)) if filepath
+        rescue StandardError => e
+          Logging.logger[self].error("Could not load puppetdb.conf from #{filepath}: #{e.message}")
         end
 
         config = config.fetch('puppetdb', {})
@@ -51,8 +44,7 @@ module Bolt
 
       def initialize(settings, project_path = nil)
         @settings = settings
-        @project_path = project_path
-        expand_paths
+        expand_paths(project_path)
       end
 
       def token
@@ -68,14 +60,10 @@ module Bolt
         @token = @token.strip if @token
       end
 
-      def expand_paths
+      def expand_paths(project_path)
         %w[cacert cert key token].each do |file|
           next unless @settings[file]
-          @settings[file] = if @project_path
-                              File.expand_path(@settings[file], @project_path)
-                            else
-                              File.expand_path(@settings[file])
-                            end
+          @settings[file] = File.expand_path(@settings[file], project_path)
         end
       end
 

data/lib/bolt/rerun.rb

@@ -45,7 +45,7 @@ module Bolt
         end
 
         if result_set.is_a?(Bolt::ResultSet)
-          data = result_set.map { |res| res.status_hash.select { |k, _| %i[target status].include? k } }
+          data = result_set.map { |res| { target: res.target.name, status: res.status } }
           FileUtils.mkdir_p(File.dirname(@path))
           File.write(@path, data.to_json)
         elsif File.exist?(@path)

data/lib/bolt/resource_instance.rb

@@ -0,0 +1,126 @@
+# frozen_string_literal: true
+
+require 'json'
+
+module Bolt
+  class ResourceInstance
+    attr_reader :target, :type, :title, :state, :desired_state
+    attr_accessor :events
+
+    # Needed by Puppet to recognize Bolt::ResourceInstance as a Puppet object when deserializing
+    def self._pcore_type
+      ResourceInstance
+    end
+
+    # Needed by Puppet to serialize with _pcore_init_hash instead of the object's attributes
+    def self._pcore_init_from_hash(_init_hash)
+      raise "ResourceInstance shouldn't be instantiated from a pcore_init class method. "\
+            "How did this get called?"
+    end
+
+    def _pcore_init_from_hash(init_hash)
+      initialize(init_hash)
+    end
+
+    # Parameters will already be validated when calling ResourceInstance.new or
+    # set_resources() from a plan. We don't perform any validation in the class
+    # itself since Puppet will pass an empty hash to the initializer as part of
+    # the deserialization process before passing the _pcore_init_hash.
+    def initialize(resource_hash)
+      @target        = resource_hash['target']
+      @type          = resource_hash['type'].to_s.capitalize
+      @title         = resource_hash['title']
+      # get_resources() returns observed state under the 'parameters' key
+      @state         = resource_hash['state'] || resource_hash['parameters'] || {}
+      @desired_state = resource_hash['desired_state'] || {}
+      @events        = resource_hash['events'] || []
+    end
+
+    # Creates a ResourceInstance from a data hash in a plan when calling
+    # ResourceInstance.new($resource_hash) or $target.set_resources($resource_hash)
+    def self.from_asserted_hash(resource_hash)
+      new(resource_hash)
+    end
+
+    # Creates a ResourceInstance from positional arguments in a plan when
+    # calling ResourceInstance.new(target, type, title, ...)
+    def self.from_asserted_args(target,
+                                type,
+                                title,
+                                state         = nil,
+                                desired_state = nil,
+                                events        = nil)
+      new(
+        'target'        => target,
+        'type'          => type,
+        'title'         => title,
+        'state'         => state,
+        'desired_state' => desired_state,
+        'events'        => events
+      )
+    end
+
+    def eql?(other)
+      self.class.equal?(other.class) &&
+        target == other.target &&
+        type   == other.type &&
+        title  == other.title
+    end
+    alias == eql?
+
+    def to_hash
+      {
+        'target'        => target,
+        'type'          => type,
+        'title'         => title,
+        'state'         => state,
+        'desired_state' => desired_state,
+        'events'        => events
+      }
+    end
+    alias _pcore_init_hash to_hash
+
+    def to_json(opts = nil)
+      to_hash.to_json(opts)
+    end
+
+    def reference
+      "#{type}[#{title}]"
+    end
+    alias to_s reference
+
+    def add_event(event)
+      @events << event
+    end
+
+    # rubocop:disable Naming/AccessorMethodName
+    def set_state(state)
+      assert_hash('state', state)
+      @state.merge!(state)
+    end
+    # rubocop:enable Naming/AccessorMethodName
+
+    def overwrite_state(state)
+      assert_hash('state', state)
+      @state = state
+    end
+
+    # rubocop:disable Naming/AccessorMethodName
+    def set_desired_state(desired_state)
+      assert_hash('desired_state', desired_state)
+      @desired_state.merge!(desired_state)
+    end
+    # rubocop:enable Naming/AccessorMethodName
+
+    def overwrite_desired_state(desired_state)
+      assert_hash('desired_state', desired_state)
+      @desired_state = desired_state
+    end
+
+    def assert_hash(loc, value)
+      unless value.is_a?(Hash)
+        raise Bolt::ValidationError, "#{loc} must be of type Hash; got #{value.class}"
+      end
+    end
+  end
+end