vagrant-bolt 0.1.0 → 0.3.0

data/lib/vagrant-bolt/config/global.rb

@@ -9,12 +9,24 @@ class VagrantBolt::Config::Global < Vagrant.plugin('2', :config)
   # @return [String] The bolt working directory. Defaults to `.`
   attr_accessor :boltdir
 
+  # @!attribute [rw] host_key_check
+  # @return [String] If the connection should check the host key on the remote host (linux)
+  attr_accessor :connect_timeout
+
   # @!attribute [rw] host_key_check
   # @return [Boolean] If the connection should check the host key on the remote host (linux)
   attr_accessor :host_key_check
 
+  # @!attribute [rw] machine_alias
+  # @return [String] The alias of the machine to set in the bolt inventory
+  attr_accessor :machine_alias
+
+  # @!attribute [rw] machine_name
+  # @return [String] The name of the machine to set in the bolt inventory
+  attr_accessor :machine_name
+
   # @!attribute [rw] modulepath
-  # @return [String] The path to the modules. Defaults to `modules`.
+  # @return [String] The path to the modules.
   attr_accessor :modulepath
 
   # @!attribute [rw] user
@@ -74,45 +86,60 @@ class VagrantBolt::Config::Global < Vagrant.plugin('2', :config)
   attr_accessor :features
 
   def initialize
-    @bolt_exe       = UNSET_VALUE
-    @boltdir        = UNSET_VALUE
-    @host_key_check = UNSET_VALUE
-    @modulepath     = UNSET_VALUE
-    @password       = UNSET_VALUE
-    @port           = UNSET_VALUE
-    @private_key    = UNSET_VALUE
-    @run_as         = UNSET_VALUE
-    @ssl            = UNSET_VALUE
-    @ssl_verify     = UNSET_VALUE
-    @sudo_password  = UNSET_VALUE
-    @tmpdir         = UNSET_VALUE
-    @user           = UNSET_VALUE
-    @verbose        = UNSET_VALUE
-    @debug          = UNSET_VALUE
-    @facts          = UNSET_VALUE
-    @vars           = UNSET_VALUE
-    @features       = UNSET_VALUE
+    @bolt_exe        = UNSET_VALUE
+    @boltdir         = UNSET_VALUE
+    @connect_timeout = UNSET_VALUE
+    @host_key_check  = UNSET_VALUE
+    @machine_alias   = UNSET_VALUE
+    @machine_name    = UNSET_VALUE
+    @modulepath      = UNSET_VALUE
+    @password        = UNSET_VALUE
+    @port            = UNSET_VALUE
+    @private_key     = UNSET_VALUE
+    @run_as          = UNSET_VALUE
+    @ssl             = UNSET_VALUE
+    @ssl_verify      = UNSET_VALUE
+    @sudo_password   = UNSET_VALUE
+    @tmpdir          = UNSET_VALUE
+    @user            = UNSET_VALUE
+    @verbose         = UNSET_VALUE
+    @debug           = UNSET_VALUE
+    @facts           = UNSET_VALUE
+    @vars            = UNSET_VALUE
+    @features        = UNSET_VALUE
   end
 
   def finalize!
-    @bolt_exe       = 'bolt' if @bolt_exe == UNSET_VALUE
-    @boltdir        = '.' if @boltdir == UNSET_VALUE
-    @host_key_check = nil if @host_key_check == UNSET_VALUE
-    @modulepath     = 'modules' if @modulepath == UNSET_VALUE
-    @port           = nil if @port == UNSET_VALUE
-    @password       = nil if @password == UNSET_VALUE
-    @private_key    = nil if @private_key == UNSET_VALUE
-    @run_as         = nil if @run_as == UNSET_VALUE
-    @ssl            = nil if @ssl == UNSET_VALUE
-    @ssl_verify     = nil if @ssl_verify == UNSET_VALUE
-    @sudo_password  = nil if @sudo_password == UNSET_VALUE
-    @tmpdir         = nil if @tmpdir == UNSET_VALUE
-    @user           = nil if @user == UNSET_VALUE
-    @verbose        = nil if @verbose == UNSET_VALUE
-    @debug          = nil if @debug == UNSET_VALUE
-    @facts          = nil if @facts == UNSET_VALUE
-    @features       = nil if @features == UNSET_VALUE
-    @vars           = nil if @vars == UNSET_VALUE
+    @bolt_exe        = bolt_exe_path if @bolt_exe == UNSET_VALUE
+    @boltdir         = '.' if @boltdir == UNSET_VALUE
+    @connect_timeout = nil if @connect_timeout == UNSET_VALUE
+    @host_key_check  = nil if @host_key_check == UNSET_VALUE
+    @machine_alias   = nil if @machine_alias == UNSET_VALUE
+    @machine_name    = nil if @machine_name == UNSET_VALUE
+    @modulepath      = nil if @modulepath == UNSET_VALUE
+    @port            = nil if @port == UNSET_VALUE
+    @password        = nil if @password == UNSET_VALUE
+    @private_key     = nil if @private_key == UNSET_VALUE
+    @run_as          = nil if @run_as == UNSET_VALUE
+    @ssl             = nil if @ssl == UNSET_VALUE
+    @ssl_verify      = nil if @ssl_verify == UNSET_VALUE
+    @sudo_password   = nil if @sudo_password == UNSET_VALUE
+    @tmpdir          = nil if @tmpdir == UNSET_VALUE
+    @user            = nil if @user == UNSET_VALUE
+    @verbose         = nil if @verbose == UNSET_VALUE
+    @debug           = nil if @debug == UNSET_VALUE
+    @facts           = nil if @facts == UNSET_VALUE
+    @features        = nil if @features == UNSET_VALUE
+    @vars            = nil if @vars == UNSET_VALUE
+  end
+
+  # Get the full path to the bolt executable
+  # @return [String] The path to the bolt exe
+  def bolt_exe_path
+    unless Vagrant::Util::Platform.windows?
+      return '/opt/puppetlabs/bin/bolt' if File.file?('/opt/puppetlabs/bin/bolt')
+    end
+    Vagrant::Util::Which.which('bolt') || 'bolt'
   end
 
   def validate(_machine)
@@ -127,10 +154,12 @@ class VagrantBolt::Config::Global < Vagrant.plugin('2', :config)
     group_objects = ['facts', 'features', 'vars']
     config = {}
     instance_variables_hash.each do |key, value|
-      next if value.nil?
+      next if value.nil? || (value == UNSET_VALUE)
 
       if group_objects.include?(key)
         config[key] = value
+      elsif %r{machine_\w+}.match?(key)
+        config[key.sub('machine_', '')] = value
       else
         setting_map.each do |transport, settings|
           next unless settings.include?(key)
@@ -154,6 +183,7 @@ class VagrantBolt::Config::Global < Vagrant.plugin('2', :config)
         'run_as',
         'port',
         'private_key',
+        'connect_timeout',
         'host_key_check',
         'sudo_password',
         'tmpdir',

data/lib/vagrant-bolt/config_builder/config.rb

@@ -20,12 +20,24 @@ class VagrantBolt::ConfigBuilder::Config < ConfigBuilder::Model::Base
   # @return [Boolean] Shows debug logging
   def_model_attribute :debug
 
+  # @!attribute [rw] connect_timeout
+  # @return [String] The timeout for the ssh connection (linux)
+  def_model_attribute :connect_timeout
+
   # @!attribute [rw] host_key_check
   # @return [Boolean] If the connection should check the host key on the remote host (linux)
   def_model_attribute :host_key_check
 
+  # @!attribute [rw] machine_alias
+  # @return [String] The alias of the machine to set in the bolt inventory
+  def_model_attribute :machine_alias
+
+  # @!attribute [rw] machine_name
+  # @return [String] The name of the machine to set in the bolt inventory
+  def_model_attribute :machine_name
+
   # @!attribute [rw] modulepath
-  # @return [String] The path to the modules. Defaults to `modules`.
+  # @return [String] The path to the modules.
   def_model_attribute :modulepath
 
   # @!attribute [rw] name
@@ -33,21 +45,23 @@ class VagrantBolt::ConfigBuilder::Config < ConfigBuilder::Model::Base
   def_model_attribute :name
 
   # @!attribute [rw] nodes
+  # DEPRECATED. Use `targets` instead.
   # Note: The `node_list` will override this setting.
   # @return [Array<String, Symbol>, "ALL"] The nodes to run the task or plan on.
   # Valid values are an array of machine names or the string "ALL".
   def_model_attribute :nodes
 
   # @!attribute [rw] excludes
-  # Note: The `node_list` will override this setting.
-  # Note: This will be merged with `nodes`, with `excludes` taking precidence.
-  # @return [Array<String, Symbol>] The nodes to exclude from running this task or plan on.
+  # Note: The `target_list` will override this setting.
+  # Note: This will be merged with `targets`, with `excludes` taking precidence.
+  # @return [Array<String, Symbol>] The targets to exclude from running this task or plan on.
   # Valid values are an array of machine names.
   def_model_attribute :excludes
 
   # @!attribute [rw] node_list
+  # DEPRECATED. Use `target_list` instead.
   # This setting overrides `nodes` and needs to be in the `protocol://ipaddress:port` URI format
-  # @return [String] The bolt node list. This defaults to the currnet node.
+  # @return [String] The bolt node list. This defaults to the current node.
   def_model_attribute :node_list
 
   # @!attribute [rw] noop
@@ -94,6 +108,17 @@ class VagrantBolt::ConfigBuilder::Config < ConfigBuilder::Model::Base
   # @return [Boolean] If the connection should verify SSL on with WinRM (Windows)
   def_model_attribute :ssl_verify
 
+  # @!attribute [rw] targets
+  # Note: The `target_list` will override this setting.
+  # @return [Array<String, Symbol>, "ALL"] The targets to run the task or plan on.
+  # Valid values are an array of machine names or the string "ALL".
+  def_model_attribute :targets
+
+  # @!attribute [rw] target_list
+  # This setting overrides `targets` and needs to be in the `protocol://ipaddress:port` URI format
+  # @return [String] The bolt target list. This defaults to the current target.
+  def_model_attribute :target_list
+
   # @!attribute [rw] tmpdir
   # @return [String] The directory to upload and execute temporary files on the target
   def_model_attribute :tmpdir
@@ -118,32 +143,37 @@ class VagrantBolt::ConfigBuilder::Config < ConfigBuilder::Model::Base
   def to_proc
     proc do |config|
       bolt = config.bolt
-      with_attr(:args)           { |val| bolt.args           = val }
-      with_attr(:bolt_exe)       { |val| bolt.bolt_exe       = val }
-      with_attr(:command)        { |val| bolt.command        = val }
-      with_attr(:boltdir)        { |val| bolt.boltdir        = val }
-      with_attr(:debug)          { |val| bolt.debug          = val }
-      with_attr(:host_key_check) { |val| bolt.host_key_check = val }
-      with_attr(:modulepath)     { |val| bolt.modulepath     = val }
-      with_attr(:name)           { |val| bolt.name           = val }
-      with_attr(:nodes)          { |val| bolt.nodes          = val }
-      with_attr(:noop)           { |val| bolt.noop           = val }
-      with_attr(:excludes)       { |val| bolt.excludes       = val }
-      with_attr(:node_list)      { |val| bolt.node_list      = val }
-      with_attr(:params)         { |val| bolt.params         = val }
-      with_attr(:user)           { |val| bolt.user           = val }
-      with_attr(:password)       { |val| bolt.password       = val }
-      with_attr(:port)           { |val| bolt.port           = val }
-      with_attr(:private_key)    { |val| bolt.private_key    = val }
-      with_attr(:run_as)         { |val| bolt.run_as         = val }
-      with_attr(:sudo_password)  { |val| bolt.sudo_password  = val }
-      with_attr(:ssl)            { |val| bolt.ssl            = val }
-      with_attr(:ssl_verify)     { |val| bolt.ssl_verify     = val }
-      with_attr(:tmpdir)         { |val| bolt.tmpdir         = val }
-      with_attr(:verbose)        { |val| bolt.verbose        = val }
-      with_attr(:facts)          { |val| bolt.facts          = val }
-      with_attr(:features)       { |val| bolt.features       = val }
-      with_attr(:vars)           { |val| bolt.vars           = val }
+      with_attr(:args)            { |val| bolt.args            = val }
+      with_attr(:bolt_exe)        { |val| bolt.bolt_exe        = val }
+      with_attr(:command)         { |val| bolt.command         = val }
+      with_attr(:boltdir)         { |val| bolt.boltdir         = val }
+      with_attr(:debug)           { |val| bolt.debug           = val }
+      with_attr(:connect_timeout) { |val| bolt.connect_timeout = val }
+      with_attr(:host_key_check)  { |val| bolt.host_key_check  = val }
+      with_attr(:machine_alias)   { |val| bolt.machine_alias   = val }
+      with_attr(:machine_name)    { |val| bolt.machine_name    = val }
+      with_attr(:modulepath)      { |val| bolt.modulepath      = val }
+      with_attr(:name)            { |val| bolt.name            = val }
+      with_attr(:nodes)           { |val| bolt.nodes           = val }
+      with_attr(:noop)            { |val| bolt.noop            = val }
+      with_attr(:excludes)        { |val| bolt.excludes        = val }
+      with_attr(:node_list)       { |val| bolt.node_list       = val }
+      with_attr(:params)          { |val| bolt.params          = val }
+      with_attr(:user)            { |val| bolt.user            = val }
+      with_attr(:password)        { |val| bolt.password        = val }
+      with_attr(:port)            { |val| bolt.port            = val }
+      with_attr(:private_key)     { |val| bolt.private_key     = val }
+      with_attr(:run_as)          { |val| bolt.run_as          = val }
+      with_attr(:sudo_password)   { |val| bolt.sudo_password   = val }
+      with_attr(:ssl)             { |val| bolt.ssl             = val }
+      with_attr(:ssl_verify)      { |val| bolt.ssl_verify      = val }
+      with_attr(:targets)         { |val| bolt.targets         = val }
+      with_attr(:target_list)     { |val| bolt.target_list     = val }
+      with_attr(:tmpdir)          { |val| bolt.tmpdir          = val }
+      with_attr(:verbose)         { |val| bolt.verbose         = val }
+      with_attr(:facts)           { |val| bolt.facts           = val }
+      with_attr(:features)        { |val| bolt.features        = val }
+      with_attr(:vars)            { |val| bolt.vars            = val }
     end
   end
   # rubocop:enable Metrics/BlockLength

data/lib/vagrant-bolt/config_builder/monkey_patches.rb

@@ -29,7 +29,7 @@ module VagrantBolt::ConfigBuilder::MonkeyPatches
 
   def eval_bolt_triggers_root(vm_root_config)
     # Configure the vm bolt object if the options exist
-    triggers = attr(:bolt_triggers) || [] # rubocop:disable Style/Attr
+    triggers = attr(:bolt_triggers) || []
     triggers.each do |config|
       f = VagrantBolt::ConfigBuilder::Triggers.new_from_hash(config)
       f.call(vm_root_config)

data/lib/vagrant-bolt/config_builder/provisioner.rb

@@ -20,12 +20,24 @@ class VagrantBolt::ConfigBuilder::Provisioner < ConfigBuilder::Model::Provisione
   # @return [Boolean] Shows debug logging
   def_model_attribute :debug
 
+  # @!attribute [rw] connect_timeout
+  # @return [String] The ssh connection timeout (linux)
+  def_model_attribute :connect_timeout
+
   # @!attribute [rw] host_key_check
   # @return [Boolean] If the connection should check the host key on the remote host (linux)
   def_model_attribute :host_key_check
 
+  # @!attribute [rw] machine_alias
+  # @return [String] The alias of the machine to set in the bolt inventory
+  def_model_attribute :machine_alias
+
+  # @!attribute [rw] machine_name
+  # @return [String] The name of the machine to set in the bolt inventory
+  def_model_attribute :machine_name
+
   # @!attribute [rw] modulepath
-  # @return [String] The path to the modules. Defaults to `modules`.
+  # @return [String] The path to the modules.
   def_model_attribute :modulepath
 
   # @!attribute [rw] name
@@ -33,6 +45,7 @@ class VagrantBolt::ConfigBuilder::Provisioner < ConfigBuilder::Model::Provisione
   def_model_attribute :name
 
   # @!attribute [rw] nodes
+  # DEPRECATED. Use `targets` instead.
   # Note: The `node_list` will override this setting.
   # @return [Array<String, Symbol>, "ALL"] The nodes to run the task or plan on.
   # Valid values are an array of machine names or the string "ALL".
@@ -43,9 +56,9 @@ class VagrantBolt::ConfigBuilder::Provisioner < ConfigBuilder::Model::Provisione
   def_model_attribute :noop
 
   # @!attribute [rw] excludes
-  # Note: The `node_list` will override this setting.
-  # Note: This will be merged with `nodes`, with `excludes` taking precidence.
-  # @return [Array<String, Symbol>] The nodes to exclude from running this task or plan on.
+  # Note: The `target_list` will override this setting.
+  # Note: This will be merged with `targets`, with `excludes` taking precidence.
+  # @return [Array<String, Symbol>] The targets to exclude from running this task or plan on.
   # Valid values are an array of machine names.
   def_model_attribute :excludes
 
@@ -94,6 +107,17 @@ class VagrantBolt::ConfigBuilder::Provisioner < ConfigBuilder::Model::Provisione
   # @return [Boolean] If the connection should verify SSL on with WinRM (Windows)
   def_model_attribute :ssl_verify
 
+  # @!attribute [rw] targets
+  # Note: The `target_list` will override this setting.
+  # @return [Array<String, Symbol>, "ALL"] The targets to run the task or plan on.
+  # Valid values are an array of machine names or the string "ALL".
+  def_model_attribute :targets
+
+  # @!attribute [rw] target_list
+  # This setting overrides `targets` and needs to be in the `protocol://ipaddress:port` URI format
+  # @return [String] The bolt target list. This defaults to the current target.
+  def_model_attribute :target_list
+
   # @!attribute [rw] tmpdir
   # @return [String] The directory to upload and execute temporary files on the target
   def_model_attribute :tmpdir

data/lib/vagrant-bolt/runner.rb

@@ -16,12 +16,12 @@ class VagrantBolt::Runner
   # @param [Symbol, String] command The command of bolt to run; task or plan
   # @param [String] name The name of the bolt task or plan to run
   # @param [Hash] args A optional hash of bolt config overrides. No merging will be done with the overrides
-  # @example run('task', 'facts', {node_list: "machinename"})
+  # @example run('task', 'facts', {targets: ["machinename"]})
   def run(command, name, **args)
     @boltconfig = setup_overrides(command, name, **args)
-    # Don't run anything if there are nodes to run it on
-    # TODO: Gate this in a more efficient manner. It is possible to run plans without a node list.
-    return if @boltconfig.node_list.nil?
+    # Don't run anything if there are targets to run it on
+    # TODO: Gate this in a more efficient manner. It is possible to run plans without a target list.
+    return if @boltconfig.target_list.nil?
 
     @inventory_path = VagrantBolt::Util::Bolt.update_inventory_file(@env)
     validate
@@ -44,14 +44,14 @@ class VagrantBolt::Runner
     config = VagrantBolt::Util::Config.merge_config(config, @env.vagrantfile.config.bolt)
     # Add any additional arguments to the config object
     config.set_options(args) unless args.nil?
-    # Configure the node_list based on the config
-    config.node_list ||= [config.nodes - config.excludes].flatten.join(',') unless config.nodes.empty? || config.nodes.to_s.casecmp("all").zero?
-    config.node_list ||= [VagrantBolt::Util::Machine.nodes_in_environment(@env).map(&:name) - config.excludes].flatten.join(',') if config.nodes.to_s.casecmp("all").zero?
-    config.node_list ||= @machine.name.to_s unless config.excludes.include?(@machine.name.to_s)
+    # Configure the target_list based on the config
+    config.target_list ||= [config.targets - config.excludes].flatten.join(',') unless config.targets.empty? || config.targets.to_s.casecmp("all").zero?
+    config.target_list ||= [VagrantBolt::Util::Machine.machines_in_environment(@env).map(&:name) - config.excludes].flatten.join(',') if config.targets.to_s.casecmp("all").zero?
+    config.target_list ||= @machine.name.to_s unless config.excludes.include?(@machine.name.to_s)
 
     # Ensure these are absolute paths to allow for running vagrant commands outside of the root dir
-    config.modulepath = VagrantBolt::Util::Config.full_path(config.modulepath, @env.root_path)
-    config.boltdir = VagrantBolt::Util::Config.full_path(config.boltdir, @env.root_path)
+    config.modulepath = VagrantBolt::Util::Config.relative_path(config.modulepath, @env.root_path)
+    config.boltdir = VagrantBolt::Util::Config.relative_path(config.boltdir, @env.root_path)
 
     config
   end

data/lib/vagrant-bolt/util/bolt.rb

@@ -36,7 +36,7 @@ module VagrantBolt::Util
       end
 
       command << "--inventoryfile \'#{inventory_path}\'" unless inventory_path.nil?
-      command << "--nodes \'#{config.node_list}\'" unless config.node_list.nil?
+      command << "--targets \'#{config.target_list}\'" unless config.target_list.nil?
       command << config.args unless config.args.nil?
       command.flatten.join(" ")
     end
@@ -45,12 +45,12 @@ module VagrantBolt::Util
     # @param env [Object] The env object
     # @return [Hash] The hash of config options for the inventory.yaml
     def self.generate_inventory_hash(env)
-      inventory = { 'nodes' => [] }
+      inventory = { 'version' => 2, 'targets' => [] }
       inventory.merge!(env.vagrantfile.config.bolt.inventory_config.compact)
-      VagrantBolt::Util::Machine.nodes_in_environment(env).each do |vm|
+      VagrantBolt::Util::Machine.machines_in_environment(env).each do |vm|
         next unless VagrantBolt::Util::Machine.running?(vm)
 
-        inventory['nodes'] << generate_node_hash(vm)
+        inventory['targets'] << generate_node_hash(vm)
       end
       inventory.compact
     end
@@ -64,18 +64,19 @@ module VagrantBolt::Util
       ssh_info = machine.ssh_info
       return node_hash if ssh_info.nil?
 
-      node_hash['alias'] = machine.name.to_s
       machine_config = machine.config.bolt.inventory_config
       node_hash['config'] = {}
       transport = VagrantBolt::Util::Machine.windows?(machine) ? 'winrm' : 'ssh'
       node_hash['config'][transport] = machine_transport_hash(machine, machine_config, ssh_info).compact
       node_hash['config']['transport'] = transport
-      node_hash['name'] = "#{transport}://#{ssh_info[:host]}:#{node_hash['config'][transport]['port']}"
+      node_hash['uri'] = "#{transport}://#{ssh_info[:host]}:#{node_hash['config'][transport]['port']}"
       machine_config.each do |key, value|
         next if key == 'config' || value.nil? || value.empty?
 
         node_hash[key] = value
       end
+      node_hash['name'] ||= machine.name.to_s
+      node_hash['alias'] = machine.name.to_s if node_hash['alias'].nil? && node_hash['name'] != machine.name.to_s
       node_hash.compact
     end
 
@@ -108,7 +109,7 @@ module VagrantBolt::Util
     # @param env [Object] The environment
     # @return [String] The path to the inventory file
     def self.inventory_file(env)
-      File.join(env.local_data_path, 'bolt_inventory.yaml')
+      VagrantBolt::Util::Config.relative_path('bolt_inventory.yaml', env.local_data_path)
     end
 
     # Update and write the inventory file for the current running machines

data/lib/vagrant-bolt/util/config.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require 'pathname'
+
 module VagrantBolt::Util
   module Config
     # Config Utility Functions
@@ -30,14 +32,25 @@ module VagrantBolt::Util
       result
     end
 
-    # Convert a path to the absolute path of the inventory if it is relative
+    # Convert a path to the absolute path if it is relative
     # @param path [String] The path to convert
     # @param root_path [Object] The root path to append
     # @return [String] The absolute path or nil if path is nil
     def self.full_path(path, root_path)
       return path if path.nil? || root_path.nil?
 
-      %r{^/.*}.match?(path) ? path : "#{root_path}/#{path}"
+      (Pathname.new path).absolute? ? path : File.expand_path(path, root_path)
+    end
+
+    # Convert a path to the relative path from the current directory
+    # @param path [String] The path to convert
+    # @param root_path [Object] The root path to append
+    # @return [String] The relative path or nil if path is nil
+    def self.relative_path(path, root_path)
+      return path if path.nil?
+
+      absolute_path = Pathname.new full_path(path, root_path)
+      absolute_path.relative_path_from(Pathname.getwd).to_s
     end
   end
 end