vagrant-bolt 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5db77647479d994addb8c0d44266d5408001a0035f7d57d913107f88c1290a07
-  data.tar.gz: 5ede9d54e55e4401133fa1ede70d62bf7e9ab6aef4805a9533bc0b106cea7cee
+  metadata.gz: c5315c29b84aa2be5b9d66ef518e07d5eebae92b357becebd7697ee2f4905dee
+  data.tar.gz: 4da2668141db99cac3f88b6fe29b8309a4d55e5661549b9480f6691fe199f859
 SHA512:
-  metadata.gz: 90a889e58965672e19a4b4fdd5e667fe05ace1d96d401481e9c73cfba89cc26e284c557a530902b38b97a8bb1cb68f45e163ffd2ecc3094380c309fe4d38920b
-  data.tar.gz: d25d14d296e07fcf22d8a75612e37525495a4e33d2b2f031b804e9d1ac2e28ab0e82c2bd0352329d4a6cc421a7e22be505d842b0e90d3d804cd207f0659a3d8d
+  metadata.gz: d9709b7a1074d96f56fab489b309dcce03f141ff5fdaf469761a60ef4fe42820a0f8e4183c071a0bf31a4690ac9c6ce5153383c13ebeab6f7f2332ba0cbc3b9e
+  data.tar.gz: 79248aa3739f5908cab9676c3badb6e1237fd2da799beedbbc1033052abb4468c2b7aa5d7bcb6ca8c079456c8d859ec5587479b96fc011070370ce7ca8a93fc8

data/.github/workflows/spec.yml

@@ -0,0 +1,71 @@
+name: Spec and Lint
+
+on:
+  push:
+    branches:
+      - master
+  pull_request:
+    branches:
+      - master
+
+jobs:
+  spec:
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        include:
+          - vagrant: 'v2.2.1'
+            ruby: 2.5
+          - vagrant: 'v2.2.14'
+            ruby: 2.5
+          - vagrant: 'HEAD'
+            ruby: 2.6
+          - vagrant: 'HEAD'
+            ruby: 2.7
+    steps:
+      - name: Checkout Source
+        uses: actions/checkout@v2
+
+      - name: Setup Ruby ${{ matrix.ruby }}
+        uses: actions/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+
+      - name: Cache gems
+        uses: actions/cache@v2
+        with:
+          path: vendor/gems
+          key: ${{ runner.os }}-pr-${{ hashFiles('**/Gemfile') }}
+          restore-keys: |
+            ${{ runner.os }}-pr-
+            ${{ runner.os }}-
+
+      - name: Install gems
+        env:
+          TEST_VAGRANT_VERSION: ${{ matrix.vagrant }}
+        run: |
+          gem install bundler
+          bundle config path vendor/gems
+          bundle config jobs 8
+          bundle config retry 3
+          bundle install
+          bundle clean
+
+      - name: bundler environment
+        env:
+          TEST_VAGRANT_VERSION: ${{ matrix.vagrant }}
+        run: |
+          bundle env
+
+      - name: Rubocop
+        env:
+          TEST_VAGRANT_VERSION: ${{ matrix.vagrant }}
+        run: |
+          bundle exec rake rubocop
+
+      - name: Spec Tests
+        env:
+          TEST_VAGRANT_VERSION: ${{ matrix.vagrant }}
+        run: |
+          bundle exec rake spec

data/.rubocop.yml

@@ -1,5 +1,6 @@
 ---
 AllCops:
+  NewCops: disable
   DisplayCopNames: true
   TargetRubyVersion: '2.4'
   Include:
@@ -114,3 +115,5 @@ Metrics/BlockLength:
     - "acceptance/**/*.rb"
 Style/RescueStandardError:
   EnforcedStyle: implicit
+Lint/MissingSuper:
+  Enabled: false

data/CHANGELOG.md

@@ -1,5 +1,24 @@
 # Changelog
 
+## [v0.4.0](https://github.com/oscar-stack/vagrant-bolt/tree/v0.4.0) (2020-12-23)
+
+[Full Changelog](https://github.com/oscar-stack/vagrant-bolt/compare/v0.3.0...v0.4.0)
+
+**Merged pull requests:**
+
+- Remove deprecated Bolt features [\#17](https://github.com/oscar-stack/vagrant-bolt/pull/17) ([jarretlavallee](https://github.com/jarretlavallee))
+
+**Changes**
+
+- This release requires bolt 2.16.0+
+- Several deprecated features have been removed such as the following
+  - `boltdir` has been changed to `project`. The `project` setting defaults to `boltdir` to avoid breaking changes
+  - `run-as` has been removed from the `winrm` settings hash in the inventory file
+  - `version` has been removed from the inventory file
+  - `run-as` has been removed from the command line as it was overridden by the inventory file
+- Acceptance tests have been fixed to use the gem installation of bolt
+- Travis-CI tests have been migrated to Github Actions
+
 ## [v0.3.0](https://github.com/oscar-stack/vagrant-bolt/tree/v0.3.0) (2020-06-02)
 
 [Full Changelog](https://github.com/oscar-stack/vagrant-bolt/compare/v0.2.1...v0.3.0)

data/Gemfile

@@ -21,18 +21,18 @@ end
 group :test do
   if %r{head}i.match?(vagrant_branch)
     gem 'vagrant', git: 'https://github.com/hashicorp/vagrant.git',
-                   branch: 'master'
+                   branch: 'main'
   else
     gem 'vagrant', git: 'https://github.com/hashicorp/vagrant.git',
                    tag: vagrant_branch
   end
 
   gem 'vagrant-spec', git: 'https://github.com/hashicorp/vagrant-spec.git',
-                   branch: 'master'
+                   branch: 'main'
 end
 
 group :system_tests do
-  gem 'bolt', "~> 2.0.0"
+  gem 'bolt', "~> 2.36.0"
 end
 
 

data/README.md

@@ -218,8 +218,12 @@ The settings available in the triggers and the provisioner are the same.
   * Description: A string containing the full path to the bolt executable
   * Default: `/opt/puppetlabs/bin/bolt` if it exists, else the first `bolt` in the PATH
 * `boltdir`
+  * DEPRECATED use `project` instead
   * Description: A string containing the bolt working directory
   * Default: The vagrant root
+* `project`
+  * Description: A string containing the bolt project
+  * Default: The value of `boltdir` for backwards compatibilty
 * `target_list`
   * Description: A string containing bolt target list in URI format
     * This will override `targets` and `excludes`
@@ -434,8 +438,8 @@ Requirements
 ------------
 
 * Vagrant 2.2.0+ is required for this plugin.
-* Bolt 1.10+ needs to be installed on the platform machine and accessible on the path. Use the `bolt_exe` config parameter if it is not on the path.
-* Ruby 2.3+
+* Bolt 2.16+ needs to be installed on the platform machine and accessible on the path. Use the `bolt_exe` config parameter if it is not on the path.
+* Ruby 2.5+
 
 Known Issues
 ------------

data/acceptance/components/bolt_spec.rb

@@ -7,6 +7,7 @@ shared_examples 'provider/virtualbox' do |provider, options|
   before do
     environment.skeleton('base')
     assert_execute('vagrant', 'box', 'add', 'box', options[:box])
+    execute('bolt', '--project', '.', 'puppetfile', 'install')
   end
 
   after do
@@ -21,9 +22,9 @@ shared_examples 'provider/virtualbox' do |provider, options|
 
     it 'runs a task, plan, and command' do
       expect(@result.exit_code).to eq(0)
-      expect(@result.stdout).to match(%r{Bolt: Running bolt command locally: \/[^\ ]+bolt task run 'facts'})
-      expect(@result.stdout).to match(%r{Bolt: Running bolt command locally: \/[^\ ]+bolt plan run 'facts'})
-      expect(@result.stdout).to match(%r{Bolt: Running bolt command locally: \/[^\ ]+bolt command run})
+      expect(@result.stdout).to match(%r{bolt task run 'facts'})
+      expect(@result.stdout).to match(%r{bolt plan run 'facts'})
+      expect(@result.stdout).to match(%r{bolt command run})
       expect(@result.stdout.scan(%r{Successful on 1 target}).size).to eq(3)
     end
   end
@@ -36,9 +37,9 @@ shared_examples 'provider/virtualbox' do |provider, options|
 
     it 'runs a task, plan, and command' do
       expect(@result.exit_code).to eq(0)
-      expect(@result.stdout).to match(%r{Bolt: Running bolt command locally: \/[^\ ]+bolt task run 'facts'})
-      expect(@result.stdout).to match(%r{Bolt: Running bolt command locally: \/[^\ ]+bolt plan run 'facts'})
-      expect(@result.stdout).to match(%r{Bolt: Running bolt command locally: \/[^\ ]+bolt command run})
+      expect(@result.stdout).to match(%r{bolt task run 'facts'})
+      expect(@result.stdout).to match(%r{bolt plan run 'facts'})
+      expect(@result.stdout).to match(%r{bolt command run})
       expect(@result.stdout.scan(%r{Successful on 1 target}).size).to eq(3)
     end
   end
@@ -52,15 +53,15 @@ shared_examples 'provider/virtualbox' do |provider, options|
       expect(@result.exit_code).to eq(0)
       result = assert_execute('vagrant', 'bolt', 'task', 'run', 'facts', '-t', 'server')
       expect(result.exit_code).to eq(0)
-      expect(result.stdout).to match(%r{Bolt: Running bolt command locally: '\/[^\ ]+bolt' 'task' 'run' 'facts'})
+      expect(result.stdout).to match(%r{bolt 'task' 'run' 'facts'})
       expect(result.stdout.scan(%r{Successful on 1 target}).size).to eq(1)
       result = assert_execute('vagrant', 'bolt', 'plan', 'run', 'facts', '-t', 'server')
       expect(result.exit_code).to eq(0)
-      expect(result.stdout).to match(%r{Bolt: Running bolt command locally: '\/[^\ ]+bolt' 'plan' 'run' 'facts'})
+      expect(result.stdout).to match(%r{bolt 'plan' 'run' 'facts'})
       expect(result.stdout.scan(%r{Successful on 1 target}).size).to eq(1)
       result = assert_execute('vagrant', 'bolt', 'command', 'run', 'hostname', '-t', 'server')
       expect(result.exit_code).to eq(0)
-      expect(result.stdout).to match(%r{Bolt: Running bolt command locally: '\/[^\ ]+bolt' 'command' 'run'})
+      expect(result.stdout).to match(%r{bolt 'command' 'run'})
       expect(result.stdout.scan(%r{Successful on 1 target}).size).to eq(1)
     end
   end
@@ -82,17 +83,15 @@ shared_examples 'provider/virtualbox' do |provider, options|
       # Ensure that the trigger is run on both targets
       expect(result.stdout.scan(%r{server[12]:\s+allnodetest}).size).to eq(4)
       # Ensure that 'targets = all' includes both targets
-      expect(result.stdout).to match(%r{Bolt: Running bolt command locally: \/[^\ ]+bolt command run[^\n]+allnodetest[^\n]+server[12],server[12]})
-      # Ensure that the root level `run_as` is used
-      expect(result.stdout).to match(%r{Bolt: Running bolt command locally: \/[^\ ]+bolt command run[^\n]+allnodetest[^\n]+--run-as 'root'})
+      expect(result.stdout).to match(%r{bolt command run[^\n]+allnodetest[^\n]+server[12],server[12]})
+      # Ensure that the root level `run_as` is not used
+      expect(result.stdout).to match(%r{bolt command run[^\n]+allnodetest})
       ## Configtest
       # Ensure excludes overrides targets
-      expect(result.stdout).to match(%r{Bolt: Running bolt command locally: \/[^\ ]+bolt command run[^\n]+configtest[^\n]+server2})
+      expect(result.stdout).to match(%r{bolt command run[^\n]+configtest[^\n]+server2})
       # Ensure verbose and debug flags are correctly handled
-      expect(result.stdout).to match(%r{Bolt: Running bolt command locally: \/[^\ ]+bolt command run[^\n]+configtest[^\n]+--verbose})
-      expect(result.stdout).not_to match(%r{Bolt: Running bolt command locally: \/[^\ ]+bolt command run[^\n]+configtest[^\n]+--debug})
-      # Ensure run_as override
-      expect(result.stdout).to match(%r{Bolt: Running bolt command locally: \/[^\ ]+bolt command run[^\n]+configtest[^\n]+--run-as 'vagrant'})
+      expect(result.stdout).to match(%r{bolt command run[^\n]+configtest[^\n]+--verbose})
+      expect(result.stdout).not_to match(%r{bolt command run[^\n]+configtest[^\n]+--debug})
     end
   end
 end

data/acceptance/skeletons/advanced/Vagrantfile

@@ -1,6 +1,6 @@
 require 'vagrant-spec/which'
 Vagrant.configure('2') do |config|
-  config.bolt.bolt_exe = Vagrant::Spec::Which.which('bolt')
+  config.bolt.bolt_exe = [Vagrant::Spec::Which.which('ruby'), Vagrant::Spec::Which.which('bolt')]
   config.bolt.run_as = 'root'
   config.vm.box = 'box'
   # Run a trigger on all nodes after provision

data/acceptance/skeletons/base/Puppetfile

@@ -0,0 +1,2 @@
+mod 'puppetlabs-facts', '1.2.0'
+mod 'puppetlabs-ruby_task_helper', '0.5.1'

data/acceptance/skeletons/base/Vagrantfile

@@ -1,6 +1,6 @@
 require 'vagrant-spec/which'
 Vagrant.configure('2') do |config|
-  config.bolt.bolt_exe = Vagrant::Spec::Which.which('bolt')
+  config.bolt.bolt_exe = [Vagrant::Spec::Which.which('ruby'), Vagrant::Spec::Which.which('bolt')]
   config.vm.box = 'box'
   config.vm.define 'server' do |node|
     node.vm.provision :bolt do |bolt|

data/acceptance/skeletons/provisioner/Vagrantfile

@@ -1,6 +1,6 @@
 require 'vagrant-spec/which'
 Vagrant.configure('2') do |config|
-  config.bolt.bolt_exe = Vagrant::Spec::Which.which('bolt')
+  config.bolt.bolt_exe = [Vagrant::Spec::Which.which('ruby'), Vagrant::Spec::Which.which('bolt')]
   config.vm.box = 'box'
   config.vm.define 'server' do |node|
     node.vm.provision :bolt do |bolt|

data/acceptance/skeletons/trigger/Vagrantfile

@@ -1,6 +1,6 @@
 require 'vagrant-spec/which'
 Vagrant.configure('2') do |config|
-  config.bolt.bolt_exe = Vagrant::Spec::Which.which('bolt')
+  config.bolt.bolt_exe = [Vagrant::Spec::Which.which('ruby'), Vagrant::Spec::Which.which('bolt')]
   config.vm.box = 'box'
   config.vm.define 'server' do |node|
     node.trigger.after :up do |trigger|

data/acceptance/vagrant-spec.config.rb

@@ -11,11 +11,11 @@ ENV['VAGRANT_DISABLE_PLUGIN_INIT'] = '1'
 Vagrant::Spec::Acceptance.configure do |c|
   acceptance_dir = Pathname.new File.expand_path(__dir__)
 
-  c.component_paths = [(acceptance_dir + 'components').to_s]
-  c.skeleton_paths = [(acceptance_dir + 'skeletons').to_s]
+  c.component_paths = ["#{acceptance_dir}/components"]
+  c.skeleton_paths = ["#{acceptance_dir}/skeletons"]
 
   c.provider 'virtualbox',
-             box: (acceptance_dir + 'artifacts' + 'virtualbox.box').to_s,
+             box: "#{acceptance_dir}/artifacts/virtualbox.box",
              env_vars: {
                'VBOX_USER_HOME' => '{{homedir}}',
              }

data/lib/vagrant-bolt/command.rb

@@ -42,21 +42,21 @@ class VagrantBolt::Command < Vagrant.plugin('2', :command)
     execute_bolt_command(bolt_args)
   end
 
-  # Run a bolt command with the inventory path, and boltdir
+  # Run a bolt command with the inventory path, and project
   # @param args [Array<String>] An array containing the bolt arguments
   def execute_bolt_command(args)
     bolt_exe = @env.vagrantfile.config.bolt.bolt_exe
-    boltdir = VagrantBolt::Util::Config.relative_path(@env.vagrantfile.config.bolt.boltdir, @env.root_path)
+    project = VagrantBolt::Util::Config.relative_path(@env.vagrantfile.config.bolt.project, @env.root_path)
     inventoryfile = VagrantBolt::Util::Bolt.inventory_file(@env)
 
     quoted_args = args.flatten.compact.map { |a| "'#{a}'" }
     command = [
-      "\'#{bolt_exe}\'",
+      bolt_exe,
       quoted_args,
-      '--boltdir',
-      "\'#{boltdir}\'",
+      '--project',
+      project,
     ]
     command << ['--inventoryfile', "\'#{inventoryfile}\'"] if File.exist?(inventoryfile)
-    VagrantBolt::Util::Machine.run_command(command.flatten.join(" "), @env.ui)
+    VagrantBolt::Util::Machine.run_command(command.flatten.join(' '), @env.ui)
   end
 end

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

@@ -137,6 +137,8 @@ class VagrantBolt::Config::Bolt < VagrantBolt::Config::Global
       'vars',
       'facts',
       'features',
+      'boltdir',
+      'run_as',
     ]
   end
 end

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

@@ -6,7 +6,7 @@ class VagrantBolt::Config::Global < Vagrant.plugin('2', :config)
   attr_accessor :bolt_exe
 
   # @!attribute [rw] boltdir
-  # @return [String] The bolt working directory. Defaults to `.`
+  # @return [String] DEPRECATED use `project`. The bolt working directory. Defaults to `.`
   attr_accessor :boltdir
 
   # @!attribute [rw] host_key_check
@@ -45,6 +45,10 @@ class VagrantBolt::Config::Global < Vagrant.plugin('2', :config)
   # @return [String] The path of the private_key to authenticate on the machine.
   attr_accessor :private_key
 
+  # @!attribute [rw] project
+  # @return [String] The bolt project. Defaults to `.`
+  attr_accessor :project
+
   # @!attribute [rw] run_as
   # @return [String] User to run as using privilege escalation.
   attr_accessor :run_as
@@ -96,6 +100,7 @@ class VagrantBolt::Config::Global < Vagrant.plugin('2', :config)
     @password        = UNSET_VALUE
     @port            = UNSET_VALUE
     @private_key     = UNSET_VALUE
+    @project         = UNSET_VALUE
     @run_as          = UNSET_VALUE
     @ssl             = UNSET_VALUE
     @ssl_verify      = UNSET_VALUE
@@ -120,6 +125,7 @@ class VagrantBolt::Config::Global < Vagrant.plugin('2', :config)
     @port            = nil if @port == UNSET_VALUE
     @password        = nil if @password == UNSET_VALUE
     @private_key     = nil if @private_key == UNSET_VALUE
+    @project         = @boltdir if @project == UNSET_VALUE || @project.nil?
     @run_as          = nil if @run_as == UNSET_VALUE
     @ssl             = nil if @ssl == UNSET_VALUE
     @ssl_verify      = nil if @ssl_verify == UNSET_VALUE
@@ -136,9 +142,8 @@ class VagrantBolt::Config::Global < Vagrant.plugin('2', :config)
   # 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
+    return '/opt/puppetlabs/bin/bolt' if !Vagrant::Util::Platform.windows? && File.file?('/opt/puppetlabs/bin/bolt')
+
     Vagrant::Util::Which.which('bolt') || 'bolt'
   end
 
@@ -191,7 +196,6 @@ class VagrantBolt::Config::Global < Vagrant.plugin('2', :config)
       'winrm': [
         'user',
         'password',
-        'run_as',
         'ssl',
         'ssl_verify',
         'port',

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

@@ -13,7 +13,7 @@ class VagrantBolt::ConfigBuilder::Config < ConfigBuilder::Model::Base
   def_model_attribute :bolt_exe
 
   # @!attribute [rw] boltdir
-  # @return [String] The bolt working directory. Defaults to `.`
+  # @return [String] DEPRECATED use `project`.  The bolt working directory. Defaults to `.`
   def_model_attribute :boltdir
 
   # @!attribute [rw] debug
@@ -72,6 +72,10 @@ class VagrantBolt::ConfigBuilder::Config < ConfigBuilder::Model::Base
   # @return [Hash] The paramater hash for the task or plan
   def_model_attribute :params
 
+  # @!attribute [rw] project
+  # @return [String] The bolt working directory. Defaults to `.`
+  def_model_attribute :project
+
   # @!attribute [rw] command
   # @return [Symbol] Whether bolt should use a task or plan
   def_model_attribute :command
@@ -163,6 +167,7 @@ class VagrantBolt::ConfigBuilder::Config < ConfigBuilder::Model::Base
       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(:project)         { |val| bolt.project         = 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 }

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

@@ -30,6 +30,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) || []
+
     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

@@ -13,7 +13,7 @@ class VagrantBolt::ConfigBuilder::Provisioner < ConfigBuilder::Model::Provisione
   def_model_attribute :bolt_exe
 
   # @!attribute [rw] boltdir
-  # @return [String] The bolt working directory. Defaults to `.`
+  # @return [String] DEPRECATED use `project`. The bolt working directory. Defaults to `.`
   def_model_attribute :boltdir
 
   # @!attribute [rw] debug
@@ -91,6 +91,10 @@ class VagrantBolt::ConfigBuilder::Provisioner < ConfigBuilder::Model::Provisione
   # @return [String] The path of the private_key to authenticate on the machine.
   def_model_attribute :private_key
 
+  # @!attribute [rw] project
+  # @return [String] The bolt working directory. Defaults to `.`
+  def_model_attribute :project
+
   # @!attribute [rw] run_as
   # @return [String] User to run as using privilege escalation.
   def_model_attribute :run_as