bolt 1.49.0 → 2.0.0

data/lib/bolt/inventory/{inventory2.rb → inventory.rb}

@@ -1,25 +1,24 @@
 # frozen_string_literal: true
 
-require 'bolt/inventory/group2'
+require 'bolt/inventory/group'
 require 'bolt/inventory/target'
 
 module Bolt
   class Inventory
-    class Inventory2
+    class Inventory
       attr_reader :targets, :plugins, :config
-      # This uses "targets" in the message instead of "nodes"
       class WildcardError < Bolt::Error
         def initialize(target)
           super("Found 0 targets matching wildcard pattern #{target}", 'bolt.inventory/wildcard-error')
         end
       end
 
-      def initialize(data, config = nil, plugins: nil)
+      def initialize(data, config = nil, plugins:)
         @logger = Logging.logger[self]
         # Config is saved to add config options to targets
         @config = config || Bolt::Config.default
         @data = data || {}
-        @groups = Group2.new(@data.merge('name' => 'all'), plugins)
+        @groups = Group.new(@data.merge('name' => 'all'), plugins)
         @plugins = plugins
         @group_lookup = {}
         # The targets hash is the canonical source for all targets in inventory
@@ -37,7 +36,7 @@ module Bolt
       end
 
       def target_implementation_class
-        Bolt::Target2
+        Bolt::Target
       end
 
       def collect_groups
@@ -84,6 +83,20 @@ module Bolt
         }
       end
 
+      def self.localhost_defaults(data)
+        defaults = {
+          'config' => {
+            'transport' => 'local',
+            'local' => { 'interpreters' => { '.rb' => RbConfig.ruby } }
+          },
+          'features' => ['puppet-agent']
+        }
+        data = Bolt::Util.deep_merge(defaults, data)
+        # If features is an empty array deep_merge won't add the puppet-agent
+        data['features'] += ['puppet-agent'] if data['features'].empty?
+        data
+      end
+
       #### PRIVATE ####
       def group_data_for(target_name)
         @groups.group_collect(target_name)
@@ -115,7 +128,7 @@ module Bolt
       private :resolve_name
 
       def expand_targets(targets)
-        if targets.is_a? Bolt::Target2
+        if targets.is_a? Bolt::Target
           targets
         elsif targets.is_a? Array
           targets.map { |tish| expand_targets(tish) }
@@ -125,11 +138,11 @@ module Bolt
             ts = resolve_name(name)
             ts.map do |t|
               # If the target doesn't exist, evaluate it from the inventory.
-              # Then return a Bolt::Target2.
+              # Then return a Bolt::Target.
               unless @targets.key?(t)
                 @targets[t] = create_target_from_inventory(t)
               end
-              Bolt::Target2.new(t, self)
+              Bolt::Target.new(t, self)
             end
           end
         end
@@ -182,8 +195,8 @@ module Bolt
 
       # Add a brand new target, overriding any existing target with the same
       # name. This method does not honor target config from the inventory. This
-      # is used when Target.new is called from a plan.
-      def create_target_from_plan(data)
+      # is used when Target.new is called from a plan or with a data hash.
+      def create_target_from_hash(data)
         # 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)
@@ -257,9 +270,7 @@ module Bolt
 
       def add_facts(target, new_facts = {})
         @targets[target.name].add_facts(new_facts)
-        # rubocop:disable Style/GlobalVars
-        $future ? target : facts(target)
-        # rubocop:enable Style/GlobalVars
+        target
       end
 
       def facts(target)

data/lib/bolt/inventory/target.rb

@@ -207,7 +207,7 @@ module Bolt
 
           # This should be handled by `get_targets`
           if @name == 'localhost'
-            group_data = Bolt::Inventory.localhost_defaults(group_data)
+            group_data = Bolt::Inventory::Inventory.localhost_defaults(group_data)
           end
 
           @group_cache = group_data

data/lib/bolt/module.rb

@@ -8,10 +8,10 @@ module Bolt
     def self.discover(modulepath)
       modulepath.each_with_object({}) do |path, mods|
         next unless File.exist?(path) && File.directory?(path)
-        (Dir.entries(path) - %w[. ..])
-          .map { |dir| File.join(path, dir) }
-          .select { |dir| File.directory?(dir) }
-          .each do |dir|
+        Dir.children(path)
+           .map { |dir| File.join(path, dir) }
+           .select { |dir| File.directory?(dir) }
+           .each do |dir|
           module_name = File.basename(dir)
           if module_name =~ MODULE_NAME_REGEX
             # Puppet will load some objects from shadowed modules but this won't

data/lib/bolt/outputter/human.rb

@@ -346,18 +346,23 @@ module Bolt
       # @param [Bolt::PlanResult] plan_result A PlanResult object
       def print_plan_result(plan_result)
         value = plan_result.value
-        if value.nil?
+        case value
+        when nil
           @stream.puts("Plan completed successfully with no result")
-        elsif value.is_a? Bolt::ApplyFailure
-          @stream.puts(colorize(:red, value.message))
-        elsif value.is_a? Bolt::ResultSet
-          value.each { |result| print_result(result) }
-          print_summary(value)
+        when Bolt::ApplyFailure, Bolt::RunFailure
+          print_result_set(value.result_set)
+        when Bolt::ResultSet
+          print_result_set(value)
         else
           @stream.puts(::JSON.pretty_generate(plan_result, quirks_mode: true))
         end
       end
 
+      def print_result_set(result_set)
+        result_set.each { |result| print_result(result) }
+        print_summary(result_set)
+      end
+
       def print_puppetfile_result(success, puppetfile, moduledir)
         if success
           @stream.puts("Successfully synced modules from #{puppetfile} to #{moduledir}")

data/lib/bolt/outputter/json.rb

@@ -36,17 +36,9 @@ module Bolt
         @stream.puts "],\n"
         @preceding_item = false
         @items_open = false
-        # rubocop:disable Style/GlobalVars
-        if $future
-          @stream.puts format('"target_count": %<size>d, "elapsed_time": %<elapsed>d }',
-                              size: results.size,
-                              elapsed: elapsed_time)
-        else
-          @stream.puts format('"node_count": %<size>d, "elapsed_time": %<elapsed>d }',
-                              size: results.size,
-                              elapsed: elapsed_time)
-        end
-        # rubocop:enable Style/GlobalVars
+        @stream.puts format('"target_count": %<size>d, "elapsed_time": %<elapsed>d }',
+                            size: results.size,
+                            elapsed: elapsed_time)
       end
 
       def print_table(results)

data/lib/bolt/pal.rb

@@ -120,8 +120,7 @@ module Bolt
       static_loader = loaders.static_loader
       static_loader.runtime_3_init
       if File.directory?(@resource_types)
-        # Ruby 2.3 does not support Dir.children
-        (Dir.entries(@resource_types) - %w[. ..]).each do |resource_pp|
+        Dir.children(@resource_types).each do |resource_pp|
           type_name_from_file = File.basename(resource_pp, '.pp').capitalize
           typed_name = Puppet::Pops::Loader::TypedName.new(:type, type_name_from_file)
           resource_type = Puppet::Pops::Types::TypeFactory.resource(type_name_from_file)

data/lib/bolt/pal/yaml_plan/step/resources.rb

@@ -80,7 +80,7 @@ module Bolt
             declarations = @normalized_resources.map do |resource|
               type = resource['type'].is_a?(EvaluableString) ? resource['type'].value : resource['type']
               title = Bolt::Util.to_code(resource['title'])
-              parameters = Bolt::Util.map_vals(resource['parameters']) do |val|
+              parameters = resource['parameters'].transform_values do |val|
                 Bolt::Util.to_code(val)
               end
 

data/lib/bolt/plugin.rb

@@ -51,7 +51,7 @@ module Bolt
       private :serial_executor
 
       def empty_inventory
-        @empty_inventory ||= Bolt::Inventory::Inventory2.new({}, plugins: @plugins)
+        @empty_inventory ||= Bolt::Inventory.empty
       end
       private :empty_inventory
 

data/lib/bolt/plugin/module.rb

@@ -6,7 +6,7 @@ module Bolt
   class Plugin
     class Module
       class InvalidPluginData < Bolt::Plugin::PluginError
-        def initialize(plugin, msg)
+        def initialize(msg, plugin)
           msg = "Invalid Plugin Data for #{plugin}: #{msg}"
           super(msg, 'bolt/invalid-plugin-data')
         end
@@ -36,17 +36,17 @@ module Bolt
       def setup
         @data = load_data
         @hook_map = find_hooks(@data['hooks'] || {})
-        # If there is a config section in bolt_plugin.json, validate against that and send
-        # validated values nested under `_config` key. Otherwise validate againsts the intersection
-        # of all task schemas.
-        # TODO: remove @send_config when deprecated
-        schema = if @data['config']
-                   @send_config = true
-                   @data['config']
-                 else
-                   extract_task_parameter_schema
-                 end
-        @config_schema = process_schema(schema)
+
+        if @data['config']
+          msg = <<~MSG.chomp
+            Found unsupported key 'config' in bolt_plugin.json. Config for a plugin is inferred
+            from task parameters, with config values passed as parameters.
+          MSG
+          raise InvalidPluginData.new(msg, name)
+        end
+
+        # Validate againsts the intersection of all task schemas.
+        @config_schema = process_schema(extract_task_parameter_schema)
 
         validate_config(@config, @config_schema)
       end
@@ -59,10 +59,6 @@ module Bolt
         (@hook_map.keys + [:validate_resolve_reference]).uniq
       end
 
-      def config?
-        @data.include?('config') && !@data['config'].empty?
-      end
-
       def load_data
         JSON.parse(File.read(@module.plugin_data_file))
       rescue JSON::ParserError => e
@@ -159,18 +155,10 @@ module Bolt
         # handled previously. That may not always be the case so filter them
         # out now.
         meta, params = opts.partition { |key, _val| key.start_with?('_') }.map(&:to_h)
+        params = config.merge(params)
+        validate_params(task, params)
 
-        # Send config with `_config` when config is defined in bolt_plugin.json
-        # Otherwise, merge config with params
-        # TODO: remove @send_config when deprecated
-        if @send_config
-          validate_params(task, params)
-          params['_config'] = config if config?
-        else
-          params = @config ? config.merge(params) : params
-          validate_params(task, params)
-        end
-        params['_boltdir'] = @context.boltdir.to_s
+        meta['_boltdir'] = @context.boltdir.to_s
 
         [params, meta]
       end
@@ -232,15 +220,10 @@ module Bolt
       end
 
       def validate_resolve_reference(opts)
-        # Send config with `_config` when config is defined in bolt_plugin.json
-        # Otherwise, merge config with params
-        # TODO: remove @send_config when deprecated
-        if @send_config
-          params = opts.reject { |k, _v| k.start_with?('_') }
-        else
-          merged = @config.merge(opts)
-          params = merged.reject { |k, _v| k.start_with?('_') }
-        end
+        # Merge config with params
+        merged = @config.merge(opts)
+        params = merged.reject { |k, _v| k.start_with?('_') }
+
         sig = @hook_map[:resolve_reference]['task']
         if sig
           validate_params(sig, params)

data/lib/bolt/plugin/prompt.rb

@@ -18,11 +18,9 @@ module Bolt
       end
 
       def resolve_reference(opts)
-        # rubocop:disable Style/GlobalVars
-        $future ? STDERR.print("#{opts['message']}: ") : STDOUT.print("#{opts['message']}: ")
+        STDERR.print("#{opts['message']}: ")
         value = STDIN.noecho(&:gets).chomp
-        $future ? STDERR.puts : STDOUT.puts
-        # rubocop:enable Style/GlobalVars
+        STDERR.puts
 
         value
       end

data/lib/bolt/puppetdb/config.rb

@@ -71,13 +71,11 @@ module Bolt
       def expand_paths
         %w[cacert cert key token].each do |file|
           next unless @settings[file]
-          # rubocop:disable Style/GlobalVars
-          @settings[file] = if $future && @boltdir_path
+          @settings[file] = if @boltdir_path
                               File.expand_path(@settings[file], @boltdir_path)
                             else
                               File.expand_path(@settings[file])
                             end
-          # rubocop:enable Style/GlobalVars
         end
       end
 

data/lib/bolt/result.rb

@@ -111,16 +111,13 @@ module Bolt
     end
 
     def status_hash
-      # DEPRECATION: node in status hashes is deprecated and should be removed in 2.0
-      base = {
+      {
         target: @target.name,
         action: action,
         object: object,
-        status: status
+        status: status,
+        value: @value
       }
-      # rubocop:disable Style/GlobalVars
-      $future ? base.merge(value: @value) : base.merge(result: @value, node: @target.name)
-      # rubocop:enable Style/GlobalVars
     end
 
     def generic_value

data/lib/bolt/secret/base.rb

@@ -34,12 +34,6 @@ module Bolt
       alias resolve_reference secret_decrypt
 
       def validate_resolve_reference(opts)
-        # TODO: Remove deprecation warning
-        if opts.include?('encrypted-value')
-          msg = "Parsing error: The 'encrypted-value' key is deprecated and can no longer be used. " \
-                "In your Bolt config files, please use 'encrypted_value' instead."
-          raise Bolt::ValidationError, msg
-        end
         decode(opts['encrypted_value'])
       end
     end

data/lib/bolt/target.rb

@@ -4,14 +4,19 @@ require 'bolt/error'
 require 'bolt/util'
 
 module Bolt
-  class Target2
+  class Target
     attr_accessor :inventory
 
+    # Target.new from a data hash
+    def self.from_hash(hash, inventory)
+      target = inventory.create_target_from_hash(hash)
+      new(target.name, inventory)
+    end
+
     # Target.new from a plan initialized with a hash
     def self.from_asserted_hash(hash)
       inventory = Puppet.lookup(:bolt_inventory)
-      target = inventory.create_target_from_plan(hash)
-      new(target.name, inventory)
+      from_hash(hash, inventory)
     end
 
     # TODO: Disallow any positional argument other than URI.
@@ -146,220 +151,4 @@ module Bolt
     end
     alias == eql?
   end
-
-  class Target
-    attr_reader :options
-    # CODEREVIEW: this feels wrong. The altertative is threading inventory through the
-    # executor to the RemoteTransport
-    attr_accessor :uri, :inventory
-
-    PRINT_OPTS ||= %w[host user port protocol].freeze
-
-    # Satisfies the Puppet datatypes API
-    def self.from_asserted_hash(hash)
-      if hash['uri'] && hash['options']
-        logger = Logging.logger[self]
-        msg = <<~MSG
-          #{Puppet::Pops::PuppetStack.top_of_stack.join(':')}
-            Deprecation Warning: Starting with Bolt 2.0, using 'Target.new' with an 'options' hash key will no
-            will no longer be supported. Use 'Target.new(<config>)', where 'config' is a hash with the same
-            structure used to define targets in the inventory V2 file. For more information see
-            https://puppet.com/docs/bolt/latest/writing_plans.html#creating-target-objects
-        MSG
-        logger.warn(msg)
-      end
-
-      new(hash['uri'], hash['options'])
-    end
-
-    def self.from_asserted_args(uri, options = nil)
-      if options
-        logger = Logging.logger[self]
-        msg = <<~MSG
-          #{Puppet::Pops::PuppetStack.top_of_stack.join(':')}
-            Deprecation Warning: Starting with Bolt 2.0, 'Target.new(<uri>, <options>)' will no
-            longer be supported. Use 'Target.new(<config>)', where 'config' is a hash with the same
-            structure used to define targets in the inventory V2 file. For more information see
-            https://puppet.com/docs/bolt/latest/writing_plans.html#creating-target-objects
-        MSG
-        logger.warn(msg)
-      end
-
-      new(uri, options)
-    end
-
-    # URI can be passes as nil
-    def initialize(uri, options = nil)
-      # lazy-load expensive gem code
-      require 'addressable/uri'
-
-      @uri = uri
-      @uri_obj = parse(uri)
-      @options = options || {}
-      @options.freeze
-
-      if @options['user']
-        @user = @options['user']
-      end
-
-      if @options['password']
-        @password = @options['password']
-      end
-
-      if @options['port']
-        @port = @options['port']
-      end
-
-      if @options['protocol']
-        @protocol = @options['protocol']
-      end
-
-      if @options['host']
-        @host = @options['host']
-      end
-
-      # WARNING: name should never be updated
-      @name = @options['name'] || @uri
-    end
-
-    def update_conf(conf)
-      @protocol = conf[:transport]
-
-      t_conf = conf[:transports][transport.to_sym] || {}
-      # Override url methods
-      @user = t_conf['user']
-      @password = t_conf['password']
-      @port = t_conf['port']
-      @host = t_conf['host']
-
-      # Preserve everything in options so we can easily create copies of a Target.
-      @options = t_conf.merge(@options)
-
-      self
-    end
-
-    def parse(string)
-      if string.nil?
-        nil
-      elsif string =~ %r{^[^:]+://}
-        Addressable::URI.parse(string)
-      else
-        # Initialize with an empty scheme to ensure we parse the hostname correctly
-        Addressable::URI.parse("//#{string}")
-      end
-    rescue Addressable::URI::InvalidURIError => e
-      raise Bolt::ParseError, "Could not parse target URI: #{e.message}"
-    end
-    private :parse
-
-    def features
-      if @inventory
-        @inventory.features(self)
-      else
-        Set.new
-      end
-    end
-    alias feature_set features
-
-    def plugin_hooks
-      if @inventory
-        @inventory.plugin_hooks(self)
-      else
-        {}
-      end
-    end
-
-    def vars
-      @inventory.vars(self)
-    end
-
-    def facts
-      @inventory.facts(self)
-    end
-
-    def target_alias
-      @inventory.target_alias(self)
-    end
-
-    # TODO: WHAT does equality mean here?
-    # should we just compare names? is there something else that is meaninful?
-    def eql?(other)
-      if self.class.equal?(other.class)
-        @uri ? @uri == other.uri : @name == other.name
-      else
-        false
-      end
-    end
-    alias == eql?
-
-    def hash
-      @uri.hash ^ @options.hash
-    end
-
-    def to_s
-      opts = @options.select { |k, _| PRINT_OPTS.include? k }
-      "Target('#{@uri}', #{opts})"
-    end
-
-    def to_h
-      options.merge(
-        'name' => name,
-        'uri' => uri,
-        'protocol' => protocol,
-        'user' => user,
-        'password' => password,
-        'host' => host,
-        'port' => port
-      )
-    end
-
-    def detail
-      {
-        'name' => name,
-        'alias' => target_alias,
-        'config' => {
-          'transport' => transport,
-          transport => options
-        },
-        'vars' => vars,
-        'facts' => facts,
-        'features' => features.to_a,
-        'plugin_hooks' => plugin_hooks
-      }
-    end
-
-    def host
-      @uri_obj&.hostname || @host
-    end
-    alias safe_name host
-
-    def name
-      @name || @uri
-    end
-
-    def remote?
-      @uri_obj&.scheme == 'remote' || @protocol == 'remote'
-    end
-
-    def port
-      @uri_obj&.port || @port
-    end
-
-    # transport is separate from protocol for remote targets.
-    def transport
-      remote? ? 'remote' : protocol
-    end
-
-    def protocol
-      @uri_obj&.scheme || @protocol
-    end
-
-    def user
-      Addressable::URI.unencode_component(@uri_obj&.user) || @user
-    end
-
-    def password
-      Addressable::URI.unencode_component(@uri_obj&.password) || @password
-    end
-  end
 end