vagrant-bolt 0.1.2 → 0.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 990a16a93781adb1b28be300b0ea508f803ff3c0bc9be52116248e32de342b37
-  data.tar.gz: 7040a8261b3361000aa348c33655ef305450d143a0242258ba8e43a02038e027
+  metadata.gz: 0e18fae2e9bc92dec9f02ffcfe99e50dcfdf70f02ef25868446f031b580687f1
+  data.tar.gz: a9990a2aad67e44d5ef23044a6f670eb53aec993d14d682b28b6283445976899
 SHA512:
-  metadata.gz: 4e69a5dc28b0091ade803b1f2e8fa350b9684b4ef55ebfa7d52b3a02fd8bbabafacff0a54bf9522cdd71a0c65d30de4ec596fbc0c4044c57545e16a1b72e494d
-  data.tar.gz: 5ba5d41497a76f67ae8092edf8928e584331813d9103852193008fdd40456b03b23999e05ae03e1a18d7e4cf35417f87a1f6cafd2b498ed872c973b5f36f9d28
+  metadata.gz: 7db61b05179dc83445106b6e0fdf3a0e8dafc6d4691a215e7ace0702fe6f37ec34736958e7342eeca655eeb2d3ebf5b7c6785dd27504de9bf7fc9f423fbd50af
+  data.tar.gz: b71aae81653b51f13af5ff054e87a29981f6856410633ec733d64eb69cdae3930c4d82ab9bf428e1559193bcf6b2251cc1c746c2bf389d36871349a0b5d24ea1

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/.gitignore

@@ -1,6 +1,7 @@
 *.swp
 .bundle
 .vendor
+/vendor
 spec/fixtures
 .ruby-version
 .yardoc
@@ -15,3 +16,4 @@ Gemfile.local
 /site-modules
 *.box
 *.rerun.json
+.resource_types

data/.rubocop.yml

@@ -1,5 +1,6 @@
 ---
 AllCops:
+  NewCops: disable
   DisplayCopNames: true
   TargetRubyVersion: '2.4'
   Include:
@@ -96,14 +97,6 @@ Metrics/CyclomaticComplexity:
   Enabled: false
 Metrics/PerceivedComplexity:
   Enabled: false
-Metrics/MethodLength:
-  Enabled: true
-  ExcludedMethods:
-    - initialize
-    - finalize!
-    - validate
-    - to_proc
-  Max: 25
 Metrics/ClassLength:
   Enabled: false
 Metrics/ModuleLength:
@@ -122,3 +115,5 @@ Metrics/BlockLength:
     - "acceptance/**/*.rb"
 Style/RescueStandardError:
   EnforcedStyle: implicit
+Lint/MissingSuper:
+  Enabled: false

data/CHANGELOG.md

@@ -1,6 +1,68 @@
-# Change Log
+# Changelog
+
+## [v0.4.1](https://github.com/oscar-stack/vagrant-bolt/tree/v0.4.1) (2021-03-15)
+
+[Full Changelog](https://github.com/oscar-stack/vagrant-bolt/compare/v0.4.0...v0.4.1)
+
+**Closed issues:**
+
+- `config.bolt.debug = true` fails when running with Bolt 3.0 [\#19](https://github.com/oscar-stack/vagrant-bolt/issues/19)
+
+**Merged pull requests:**
+
+- Fix config.debug = true for Bolt 3.0 [\#20](https://github.com/oscar-stack/vagrant-bolt/pull/20) ([op-ct](https://github.com/op-ct))
+
+## [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:**
+
+- \(maint\) Change to github actions from travis [\#18](https://github.com/oscar-stack/vagrant-bolt/pull/18) ([jarretlavallee](https://github.com/jarretlavallee))
+- 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)
+
+**Merged pull requests:**
+
+- Update inventory naming [\#16](https://github.com/oscar-stack/vagrant-bolt/pull/16) ([jarretlavallee](https://github.com/jarretlavallee))
+
+## [v0.2.1](https://github.com/oscar-stack/vagrant-bolt/tree/v0.2.1) (2020-03-23)
+
+[Full Changelog](https://github.com/oscar-stack/vagrant-bolt/compare/v0.2.0...v0.2.1)
+
+**Closed issues:**
+
+- Replace bolt argument nodes with targets [\#13](https://github.com/oscar-stack/vagrant-bolt/issues/13)
+
+**Merged pull requests:**
+
+- Fix config builder role filtering [\#15](https://github.com/oscar-stack/vagrant-bolt/pull/15) ([jarretlavallee](https://github.com/jarretlavallee))
+
+## [v0.2.0](https://github.com/oscar-stack/vagrant-bolt/tree/v0.2.0) (2020-02-26)
+
+[Full Changelog](https://github.com/oscar-stack/vagrant-bolt/compare/v0.1.2...v0.2.0)
+
+**Merged pull requests:**
+
+- Change nodes to targets in config [\#14](https://github.com/oscar-stack/vagrant-bolt/pull/14) ([jarretlavallee](https://github.com/jarretlavallee))
+- Update to Bolt inventory v2 [\#12](https://github.com/oscar-stack/vagrant-bolt/pull/12) ([jarretlavallee](https://github.com/jarretlavallee))
 
 ## [v0.1.2](https://github.com/oscar-stack/vagrant-bolt/tree/v0.1.2) (2019-10-17)
+
 [Full Changelog](https://github.com/oscar-stack/vagrant-bolt/compare/v0.1.1...v0.1.2)
 
 **Merged pull requests:**
@@ -9,6 +71,7 @@
 - Fix changelog version tag [\#10](https://github.com/oscar-stack/vagrant-bolt/pull/10) ([jarretlavallee](https://github.com/jarretlavallee))
 
 ## [v0.1.1](https://github.com/oscar-stack/vagrant-bolt/tree/v0.1.1) (2019-07-01)
+
 [Full Changelog](https://github.com/oscar-stack/vagrant-bolt/compare/v0.1.0...v0.1.1)
 
 **Merged pull requests:**
@@ -18,6 +81,9 @@
 - Add connect\_timeout option to inventory [\#7](https://github.com/oscar-stack/vagrant-bolt/pull/7) ([jarretlavallee](https://github.com/jarretlavallee))
 
 ## [v0.1.0](https://github.com/oscar-stack/vagrant-bolt/tree/v0.1.0) (2018-12-11)
+
+[Full Changelog](https://github.com/oscar-stack/vagrant-bolt/compare/4574482459a0f320bb6b25557199a1612b19ea72...v0.1.0)
+
 **Merged pull requests:**
 
 - \(SUP-874\) Add a command line interface [\#6](https://github.com/oscar-stack/vagrant-bolt/pull/6) ([jarretlavallee](https://github.com/jarretlavallee))
@@ -29,4 +95,4 @@
 
 
 
-\* *This Change Log was automatically generated by [github_changelog_generator](https://github.com/skywinder/Github-Changelog-Generator)*
+\* *This Changelog was automatically generated by [github_changelog_generator](https://github.com/github-changelog-generator/github-changelog-generator)*

data/Gemfile

@@ -3,7 +3,7 @@
 source 'https://rubygems.org'
 require 'rubygems/version'
 
-vagrant_branch = ENV['TEST_VAGRANT_VERSION'] || 'v2.2.2'
+vagrant_branch = ENV['TEST_VAGRANT_VERSION'] || 'v2.2.9'
 
 group :plugins do
   gemspec
@@ -21,17 +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'
+  gem 'vagrant-spec', git: 'https://github.com/hashicorp/vagrant-spec.git',
+                   branch: 'main'
 end
 
 group :system_tests do
-  gem 'bolt', ">=1.5.0"
+  gem 'bolt', "~> 2.36.0"
 end
 
 

data/README.md

@@ -177,13 +177,13 @@ VagrantBolt.task('facts', env, machine, user: 'ubuntu', password: 'testpassword'
 Run the `facts` plan on `server1` and `server2`.
 
 ~~~ruby
-VagrantBolt.plan('facts', env, machine, nodes: [:server1, :server2])
+VagrantBolt.plan('facts', env, machine, targets: [:server1, :server2])
 ~~~
 
-Run the `hostname` command on all nodes.
+Run the `hostname` command on all targets.
 
 ~~~ruby
-VagrantBolt.command('/bin/hostname', env, machine, nodes: 'all')
+VagrantBolt.command('/bin/hostname', env, machine, targets: 'all')
 ~~~
 
 Run the `service::linux` task as `root` to restart `cron` with a specific path to the bolt executable. This configuration specifies params for the `service::linux` task.
@@ -218,22 +218,26 @@ 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
-* `node_list`
-  * Description: A string containing bolt node list in URI format
-    * This will override `nodes` and `excludes`
-  * Default: `%{protocol}://%{ssh_ip}:%{ssh_port}` if `nodes` is not specified
-* `nodes`
+* `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`
+  * Default: `%{protocol}://%{ssh_ip}:%{ssh_port}` if `targets` is not specified
+* `targets`
   * Description: An array of machine names to run the task or plan on
-    * The `node_list` will override this setting.
+    * The `target_list` will override this setting.
     * A special `ALL` string can be used instead of an array to use all active machines in the environment
   * Valid Values: An array of machine symbols or the string "ALL"
   * Default: `[]`
 * `excludes`
   * Description: An array of machine names to not run the task on
-    * The `node_list` will override this setting.
-    * This setting will take precidence over `nodes`
+    * The `target_list` will override this setting.
+    * This setting will take precidence over `targets`
   * Valid Values: An array of machine symbols
   * Default: `[]`
 * `params`
@@ -260,6 +264,10 @@ The settings available in the triggers and the provisioner are the same.
   * Description: A boolean which controls if the connection should use SSL on with WinRM (Windows)
 * `ssl_verify`
   * Description: A boolean which controls if the connection should verify SSL on with WinRM (Windows)
+* `machine_alias`
+  * Description: A string to use as the machine's alias in the bolt inventory file. Defaults to nil unless `machine_name` is configured in which case it defaults to the machine name.
+* `machine_name`
+  * Description: A string to use as the machine's name in the bolt inventory file. Defaults to the machine name.
 * `modulepath`
   * Description: A string containing the path to bolt modules
 * `tmpdir`
@@ -277,7 +285,14 @@ The settings available in the triggers and the provisioner are the same.
 * `vars`
   * Description: A hash containing arbitrary data that may be passed to run_* functions or used for logic in plans
 * `facts`
-  * Description: A hash containing observed information about the node including what can be collected by Facter
+  * Description: A hash containing observed information about the target including what can be collected by Facter
+
+**Deprecated Parameters**
+
+* `node_list`
+  * Replaced by `target_list`
+* `nodes`
+  * Replaced by `targets`
 
 Config Builder
 --------------
@@ -373,7 +388,7 @@ The command can be used to deploy the Puppetfile, for example.
 vagrant bolt puppetfile install
 ~~~
 
-It can be used to run ad-hoc tasks on a node by specifying the node by its machine name.
+It can be used to run ad-hoc tasks on a target by specifying the target by its machine name.
 
 ~~~shell
 vagrant bolt -u task run facts -n server
@@ -390,7 +405,7 @@ vagrant bolt command run 'date' -n agent,master
 Other Use Cases
 ---------------
 
-There are some other use cases for Vagrant Bolt. One of which is to not use the triggers or provisioning to run bolt commands on the nodes, but to manage the inventory file for manual testing. This can easily be accomplished by using a trigger to manage the `inventory.yaml` file and specifying the configuration for the nodes in the config based on the options above. Below is an example trigger that will manage a `./inventory.yaml` file for use with external bolt commands.
+There are some other use cases for Vagrant Bolt. One of which is to not use the triggers or provisioning to run bolt commands on the targets, but to manage the inventory file for manual testing. This can easily be accomplished by using a trigger to manage the `inventory.yaml` file and specifying the configuration for the targets in the config based on the options above. Below is an example trigger that will manage a `./inventory.yaml` file for use with external bolt commands.
 
 ~~~ruby
 require 'vagrant-bolt'
@@ -423,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.17+ 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,10 +22,10 @@ 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.scan(%r{Successful on 1 node}).size).to eq(3)
+      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,10 +37,10 @@ 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.scan(%r{Successful on 1 node}).size).to eq(3)
+      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
 
@@ -50,18 +51,18 @@ shared_examples 'provider/virtualbox' do |provider, options|
 
     it 'runs a task, plan, and command' do
       expect(@result.exit_code).to eq(0)
-      result = assert_execute('vagrant', 'bolt', 'task', 'run', 'facts', '-n', 'server')
+      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.scan(%r{Successful on 1 node}).size).to eq(1)
-      result = assert_execute('vagrant', 'bolt', 'plan', 'run', 'facts', '-n', 'server')
+      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.scan(%r{Successful on 1 node}).size).to eq(1)
-      result = assert_execute('vagrant', 'bolt', 'command', 'run', 'hostname', '-n', 'server')
+      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.scan(%r{Successful on 1 node}).size).to eq(1)
+      expect(result.stdout).to match(%r{bolt 'command' 'run'})
+      expect(result.stdout.scan(%r{Successful on 1 target}).size).to eq(1)
     end
   end
 
@@ -79,20 +80,18 @@ shared_examples 'provider/virtualbox' do |provider, options|
       # Check for root level triggers
       result = assert_execute('vagrant', 'provision')
       expect(result.exit_code).to eq(0)
-      # Ensure that the trigger is run on both nodes
+      # Ensure that the trigger is run on both targets
       expect(result.stdout.scan(%r{server[12]:\s+allnodetest}).size).to eq(4)
-      # Ensure that 'nodes = all' includes both nodes
-      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'})
+      # Ensure that 'targets = all' includes both targets
+      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 nodes
-      expect(result.stdout).to match(%r{Bolt: Running bolt command locally: \/[^\ ]+bolt command run[^\n]+configtest[^\n]+server2})
+      # Ensure excludes overrides targets
+      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