vagrant-bolt 0.1.1 → 0.4.0

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.relative_path(config.modulepath, @env.root_path)
-    config.boltdir = VagrantBolt::Util::Config.relative_path(config.boltdir, @env.root_path)
+    config.project = VagrantBolt::Util::Config.relative_path(config.project, @env.root_path)
 
     config
   end
@@ -63,7 +63,7 @@ class VagrantBolt::Runner
     errors.merge!(@boltconfig.validate(@machine))
     errors.merge!(validate_config)
 
-    errors.keys.each do |key|
+    errors.each_key do |key|
       errors.delete(key) if errors[key].empty?
     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 = { '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
 

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

@@ -18,10 +18,11 @@ module VagrantBolt::Util
       [other, local].each do |obj|
         obj.instance_variables.each do |key|
           value = obj.instance_variable_get(key)
-          if value.is_a? Array
+          case value
+          when Array
             res_value = result.instance_variable_get(key)
             value = (value + res_value).uniq if res_value.is_a? Array
-          elsif value.is_a? Hash
+          when Hash
             res_value = result.instance_variable_get(key)
             value = res_value.merge(value) if res_value.is_a? Hash
           end

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

@@ -21,9 +21,10 @@ module VagrantBolt::Util
         notify: [:stdout, :stderr],
         env: { PATH: ENV["VAGRANT_OLD_ENV_PATH"] },
       ) do |io_name, data|
-        if io_name == :stdout
+        case io_name
+        when :stdout
           localui.info data
-        elsif io_name == :stderr
+        when :stderr
           localui.warn data
         end
       end
@@ -32,7 +33,7 @@ module VagrantBolt::Util
     # Generate a list of active machines in the environment
     # @param env [Object] The Environment
     # @return [Array<Object>]
-    def self.nodes_in_environment(env)
+    def self.machines_in_environment(env)
       env.active_machines.map { |vm|
         begin
           env.machine(*vm)

data/lib/vagrant-bolt/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module VagrantBolt
-  VERSION = '0.1.1'
+  VERSION = '0.4.0'
 end

data/spec/unit/config/bolt_spec.rb

@@ -72,6 +72,7 @@ describe VagrantBolt::Config::Bolt do
   context "defaults" do
     expected_values = {
       nodes: [],
+      targets: [],
       excludes: [],
     }
     expected_values.each do |val, expected|
@@ -86,6 +87,7 @@ describe VagrantBolt::Config::Bolt do
       "command",
       "params",
       "node_list",
+      "target_list",
       "user",
       "password",
       "port",
@@ -99,9 +101,12 @@ describe VagrantBolt::Config::Bolt do
       "verbose",
       "debug",
       "host_key_check",
+      "machine_alias",
+      "machine_name",
       "modulepath",
       "bolt_exe",
       "boltdir",
+      "project",
       "noop",
     ]
     expected_nil.each do |val|
@@ -120,12 +125,13 @@ describe VagrantBolt::Config::Bolt do
             "password" => "foo",
             "port" => "22",
             "run-as" => "root",
+            "user" => "Admin",
             "host-key-check" => false,
           },
           "winrm" => {
             "password" => "foo",
             "port" => "22",
-            "run-as" => "root",
+            "user" => "Admin",
             "ssl" => false,
           },
         },
@@ -134,6 +140,7 @@ describe VagrantBolt::Config::Bolt do
     before(:each) do
       subject.password = 'foo'
       subject.run_as = 'root'
+      subject.user = 'Admin'
       subject.port = '22'
       subject.ssl = false
       subject.host_key_check = false

data/spec/unit/config/global_spec.rb

@@ -20,9 +20,13 @@ describe VagrantBolt::Config::Global do
   end
 
   context "defaults" do
+    before(:each) do
+      allow(File).to receive(:file?).with('/opt/puppetlabs/bin/bolt').and_return(true)
+    end
+
     expected_values = {
-      bolt_exe: "bolt",
-      boltdir: ".",
+      bolt_exe: "/opt/puppetlabs/bin/bolt",
+      project: ".",
     }
     expected_values.each do |val, expected|
       it "defaults #{val} to #{expected}" do
@@ -66,12 +70,13 @@ describe VagrantBolt::Config::Global do
             "password" => "foo",
             "port" => "22",
             "run-as" => "root",
+            "user" => "Admin",
             "host-key-check" => false,
           },
           "winrm" => {
             "password" => "foo",
             "port" => "22",
-            "run-as" => "root",
+            "user" => "Admin",
             "ssl" => false,
           },
         },
@@ -80,6 +85,7 @@ describe VagrantBolt::Config::Global do
     before(:each) do
       subject.password = 'foo'
       subject.run_as = 'root'
+      subject.user = 'Admin'
       subject.port = '22'
       subject.ssl = false
       subject.host_key_check = false

data/spec/unit/runner/runner_spec.rb

@@ -46,7 +46,7 @@ describe VagrantBolt::Runner do
 
   context 'setup_overrides' do
     before(:each) do
-      allow(VagrantBolt::Util::Machine).to receive(:nodes_in_environment).with(iso_env).and_return([machine, machine2])
+      allow(VagrantBolt::Util::Machine).to receive(:machines_in_environment).with(iso_env).and_return([machine, machine2])
     end
     it 'adds the command and name to the config' do
       result = subject.send(:setup_overrides, 'task', 'foo')
@@ -54,31 +54,47 @@ describe VagrantBolt::Runner do
       expect(result.name).to eq('foo')
     end
 
-    it 'uses the server name for the nodes' do
+    it 'uses the server name for the targets' do
       result = subject.send(:setup_overrides, 'task', 'foo')
-      expect(result.node_list).to eq('server')
+      expect(result.target_list).to eq('server')
     end
 
-    it 'allows for using multiple nodes' do
+    it 'allows for using multiple targets' do
+      config.targets = ['server', 'server2']
+      config.finalize!
+      result = subject.send(:setup_overrides, 'task', 'foo')
+      expect(result.target_list).to eq('server,server2')
+    end
+
+    it 'allows for using nodes parameter' do
       config.nodes = ['server', 'server2']
       config.finalize!
       result = subject.send(:setup_overrides, 'task', 'foo')
-      expect(result.node_list).to eq('server,server2')
+      expect(result.target_list).to eq('server,server2')
     end
 
-    it 'adds all nodes when "all" is specified' do
-      config.nodes = 'all'
+    it 'adds all targets when "all" is specified' do
+      config.targets = 'all'
       config.finalize!
       result = subject.send(:setup_overrides, 'task', 'foo')
-      expect(result.node_list).to eq('server,server2')
+      expect(result.target_list).to eq('server,server2')
     end
 
     it 'does not override specified ssh settings' do
+      config.target_list = 'ssh://test:22'
+      config.user = 'root'
+      config.finalize!
+      result = subject.send(:setup_overrides, 'task', 'foo')
+      expect(result.target_list).to eq('ssh://test:22')
+      expect(result.user).to eq('root')
+    end
+
+    it 'target_list defaults to node_list' do
       config.node_list = 'ssh://test:22'
       config.user = 'root'
       config.finalize!
       result = subject.send(:setup_overrides, 'task', 'foo')
-      expect(result.node_list).to eq('ssh://test:22')
+      expect(result.target_list).to eq('ssh://test:22')
       expect(result.user).to eq('root')
     end
 
@@ -109,11 +125,21 @@ describe VagrantBolt::Runner do
     end
 
     it 'creates a shell execution' do
+      config.bolt_exe = 'bolt'
+      config.project = '.'
+      config.target_list = 'ssh://test:22'
+      config.finalize!
+      command = "bolt task run 'foo' --project '.' --inventoryfile '#{inventory_path}' --targets 'ssh://test:22'"
+      expect(Vagrant::Util::Subprocess).to receive(:execute).with('bash', '-c', command, options).and_return(subprocess_result)
+      subject.run('task', 'foo')
+    end
+
+    it 'creates a shell execution with a project' do
       config.bolt_exe = 'bolt'
       config.boltdir = '.'
-      config.node_list = 'ssh://test:22'
+      config.target_list = 'ssh://test:22'
       config.finalize!
-      command = "bolt task run 'foo' --boltdir '.' --inventoryfile '#{inventory_path}' --nodes 'ssh://test:22'"
+      command = "bolt task run 'foo' --project '.' --inventoryfile '#{inventory_path}' --targets 'ssh://test:22'"
       expect(Vagrant::Util::Subprocess).to receive(:execute).with('bash', '-c', command, options).and_return(subprocess_result)
       subject.run('task', 'foo')
     end

data/spec/unit/util/bolt_spec.rb

@@ -26,7 +26,6 @@ describe VagrantBolt::Util::Bolt do
     end
     let(:machine_hash) do
       {
-        "alias" => "machine",
         "config" => {
           "ssh" => {
             "connect-timeout" => "30",
@@ -39,8 +38,10 @@ describe VagrantBolt::Util::Bolt do
           },
           "transport" => "ssh",
         },
-        "name" => "ssh://machine:22",
+        "uri" => "ssh://machine:22",
         "facts" => { 'a' => 'b' },
+        "alias" => 'machine',
+        "name" => 'somename',
         "vars" => { 'foo' => 'bar' },
         "features" => ['foo'],
       }
@@ -48,7 +49,7 @@ describe VagrantBolt::Util::Bolt do
     let(:config_hash) { { 'config' => { 'a' => 'b' } } }
     let(:node_hash) do
       {
-        'nodes' => [machine_hash],
+        'targets' => [machine_hash],
         'config' => config_hash['config'],
       }
     end
@@ -63,6 +64,7 @@ describe VagrantBolt::Util::Bolt do
       config.facts = { 'a' => 'b' }
       config.features = ['foo']
       config.vars = { 'foo' => 'bar' }
+      config.machine_name = 'somename'
       config.finalize!
       allow(machine).to receive_message_chain("config.bolt.inventory_config").and_return(config.inventory_config)
       allow(machine).to receive_message_chain("config.vm.communicator").and_return(:ssh)
@@ -70,7 +72,7 @@ describe VagrantBolt::Util::Bolt do
       allow(env).to receive_message_chain("vagrantfile.config.bolt.inventory_config").and_return(config_hash)
       allow(env).to receive(:active_machines).and_return(['machine'])
       allow(env).to receive(:machine).and_return(machine)
-      allow_any_instance_of(VagrantBolt::Util::Machine).to receive(:nodes_in_environment).with(env).and_return([machine])
+      allow_any_instance_of(VagrantBolt::Util::Machine).to receive(:machines_in_environment).with(env).and_return([machine])
       allow_any_instance_of(VagrantBolt::Util::Machine).to receive(:running?).with(machine).and_return(true)
     end
 
@@ -95,7 +97,7 @@ describe VagrantBolt::Util::Bolt do
       config.node_list = 'ssh://test:22'
       config.user = 'user'
       config.finalize!
-      expected = "bolt task run 'foo' --user \'user\' --inventoryfile '#{inventory_path}' --nodes \'ssh://test:22\'"
+      expected = "bolt task run 'foo' --user \'user\' --inventoryfile '#{inventory_path}' --targets \'ssh://test:22\'"
       expect(subject.generate_bolt_command(config, inventory_path)).to eq(expected)
     end
 
@@ -107,10 +109,18 @@ describe VagrantBolt::Util::Bolt do
     end
 
     it 'adds directories to the command' do
+      config.modulepath = 'baz'
+      config.project = 'foo'
+      config.finalize!
+      expected = "bolt task run 'foo' --modulepath 'baz' --project 'foo' --inventoryfile '#{inventory_path}'"
+      expect(subject.generate_bolt_command(config, inventory_path)).to eq(expected)
+    end
+
+    it 'uses project when boltdir is specified' do
       config.modulepath = 'baz'
       config.boltdir = 'foo'
       config.finalize!
-      expected = "bolt task run 'foo' --boltdir 'foo' --modulepath 'baz' --inventoryfile '#{inventory_path}'"
+      expected = "bolt task run 'foo' --modulepath 'baz' --project 'foo' --inventoryfile '#{inventory_path}'"
       expect(subject.generate_bolt_command(config, inventory_path)).to eq(expected)
     end
 
@@ -138,6 +148,15 @@ describe VagrantBolt::Util::Bolt do
       expect(subject.generate_bolt_command(config, inventory_path)).to eq(expected)
     end
 
+    it 'run_as is not included' do
+      config.node_list = 'ssh://test:22'
+      config.user = 'user'
+      config.run_as = 'foo'
+      config.finalize!
+      expected = "bolt task run 'foo' --user \'user\' --inventoryfile '#{inventory_path}' --targets \'ssh://test:22\'"
+      expect(subject.generate_bolt_command(config, inventory_path)).to eq(expected)
+    end
+
     it 'debug, verbose, and noop are omitted when false' do
       config.debug = false
       config.verbose = false

data/tasks/changelog.rake

@@ -4,5 +4,5 @@ require_relative '../lib/vagrant-bolt/version'
 GitHubChangelogGenerator::RakeTask.new :changelog do |config|
   config.user ='oscar-stack'
   config.project = 'vagrant-bolt'
-  config.future_release = VagrantBolt::VERSION
+  config.future_release = "v#{VagrantBolt::VERSION}"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: vagrant-bolt
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.4.0
 platform: ruby
 authors:
 - Jarret Lavallee
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2019-07-01 00:00:00.000000000 Z
+date: 2020-12-23 00:00:00.000000000 Z
 dependencies: []
 description: "  Vagrant provisioning with Puppet Bolt\n"
 email:
@@ -17,10 +17,10 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/spec.yml"
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
-- ".travis.yml"
 - ".yardopts"
 - CHANGELOG.md
 - Gemfile
@@ -32,25 +32,8 @@ files:
 - acceptance/artifacts/.keep
 - acceptance/components/bolt_spec.rb
 - acceptance/skeletons/advanced/Vagrantfile
+- acceptance/skeletons/base/Puppetfile
 - acceptance/skeletons/base/Vagrantfile
-- acceptance/skeletons/base/modules/facts/CHANGELOG.md
-- acceptance/skeletons/base/modules/facts/CONTRIBUTING.md
-- acceptance/skeletons/base/modules/facts/Gemfile
-- acceptance/skeletons/base/modules/facts/LICENSE
-- acceptance/skeletons/base/modules/facts/README.md
-- acceptance/skeletons/base/modules/facts/Rakefile
-- acceptance/skeletons/base/modules/facts/checksums.json
-- acceptance/skeletons/base/modules/facts/lib/puppet/functions/facts/group_by.rb
-- acceptance/skeletons/base/modules/facts/metadata.json
-- acceptance/skeletons/base/modules/facts/plans/info.pp
-- acceptance/skeletons/base/modules/facts/plans/init.pp
-- acceptance/skeletons/base/modules/facts/tasks/bash.json
-- acceptance/skeletons/base/modules/facts/tasks/bash.sh
-- acceptance/skeletons/base/modules/facts/tasks/init.json
-- acceptance/skeletons/base/modules/facts/tasks/powershell.json
-- acceptance/skeletons/base/modules/facts/tasks/powershell.ps1
-- acceptance/skeletons/base/modules/facts/tasks/ruby.json
-- acceptance/skeletons/base/modules/facts/tasks/ruby.rb
 - acceptance/skeletons/provisioner/Vagrantfile
 - acceptance/skeletons/trigger/Vagrantfile
 - acceptance/vagrant-spec.config.rb
@@ -88,7 +71,7 @@ homepage: https://github.com/oscar-stack/vagrant-bolt
 licenses:
 - Apache-2.0
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -103,9 +86,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6
-signing_key: 
+rubyforge_project:
+rubygems_version: 2.7.6.2
+signing_key:
 specification_version: 4
 summary: Vagrant provisioning with Puppet Bolt
 test_files: []