vagrant-bolt 0.3.0 → 0.4.0

data/lib/vagrant-bolt/runner.rb

@@ -51,7 +51,7 @@ class VagrantBolt::Runner
 
     # 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

@@ -45,7 +45,7 @@ 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 = { 'version' => 2, 'targets' => [] }
+      inventory = { 'targets' => [] }
       inventory.merge!(env.vagrantfile.config.bolt.inventory_config.compact)
       VagrantBolt::Util::Machine.machines_in_environment(env).each do |vm|
         next unless VagrantBolt::Util::Machine.running?(vm)

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

data/lib/vagrant-bolt/version.rb

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

data/spec/unit/config/bolt_spec.rb

@@ -106,6 +106,7 @@ describe VagrantBolt::Config::Bolt do
       "modulepath",
       "bolt_exe",
       "boltdir",
+      "project",
       "noop",
     ]
     expected_nil.each do |val|
@@ -124,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,
           },
         },
@@ -138,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

@@ -26,7 +26,7 @@ describe VagrantBolt::Config::Global do
 
     expected_values = {
       bolt_exe: "/opt/puppetlabs/bin/bolt",
-      boltdir: ".",
+      project: ".",
     }
     expected_values.each do |val, expected|
       it "defaults #{val} to #{expected}" do
@@ -70,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,
           },
         },
@@ -84,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

@@ -125,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.target_list = 'ssh://test:22'
       config.finalize!
-      command = "bolt task run 'foo' --boltdir '.' --inventoryfile '#{inventory_path}' --targets '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

@@ -51,7 +51,6 @@ describe VagrantBolt::Util::Bolt do
       {
         'targets' => [machine_hash],
         'config' => config_hash['config'],
-        'version' => 2,
       }
     end
     before(:each) do
@@ -110,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
 
@@ -141,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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: vagrant-bolt
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Jarret Lavallee
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-06-02 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: 
+rubyforge_project:
 rubygems_version: 2.7.6.2
-signing_key: 
+signing_key:
 specification_version: 4
 summary: Vagrant provisioning with Puppet Bolt
 test_files: []

data/.travis.yml

@@ -1,28 +0,0 @@
----
-sudo: false
-dist: trusty
-language: ruby
-cache: bundler
-before_install:
-  - bundle -v
-  - rm -f Gemfile.lock
-  - gem update --system
-  - gem --version
-  - bundle -v
-notifications:
-  email: false
-script:
-  - 'bundle exec rake rubocop spec'
-bundler_args: --without system_tests
-env:
-  global:
-    - NOKOGIRI_USE_SYSTEM_LIBRARIES=true
-rvm:
-  - 2.5.0
-matrix:
-  fast_finish: true
-  include:
-    - rvm: 2.5.0
-      env: TEST_VAGRANT_VERSION=v2.2.9
-    - rvm: 2.6.6
-      env: TEST_VAGRANT_VERSION=HEAD

data/acceptance/skeletons/base/modules/facts/CHANGELOG.md

@@ -1,26 +0,0 @@
-# Change Log
-
-## 0.3.1
-### Fixed
-- Allow setting Puppet gem version via `PUPPET_GEM_VERSION` so we can use Puppet 5 to ship the module.
-
-## 0.3.0
-### Fixed
-- Task metadata specifies environment input to work around BOLT-691.
-
-### Changed
-- Stop hiding failures gathering facts in the `facts` plan.
-
-### Removed
-- `facts::retrieve` as redundant with the `facts` task when cross-platform
-tasks are supported.
-
-## 0.2.0
-### Added
-- Legacy facts added to results.
-- Improve ability of bash and ruby task to find facter executable path.
-
-## 0.1.2
-
-### Changed
-- Move facts to external module (from bolt).

data/acceptance/skeletons/base/modules/facts/CONTRIBUTING.md

@@ -1,279 +0,0 @@
-# Contributing to Puppet modules
-
-So you want to contribute to a Puppet module: Great! Below are some instructions to get you started doing
-that very thing while setting expectations around code quality as well as a few tips for making the
-process as easy as possible. 
-
-### Table of Contents
-
-1. [Getting Started](#getting-started)
-1. [Commit Checklist](#commit-checklist)
-1. [Submission](#submission)
-1. [More about commits](#more-about-commits)
-1. [Testing](#testing)
-    - [Running Tests](#running-tests)
-    - [Writing Tests](#writing-tests)
-1. [Get Help](#get-help)
-
-## Getting Started
-
-- Fork the module repository on GitHub and clone to your workspace
-
-- Make your changes!
-
-## Commit Checklist
-
-### The Basics
-
-- [x] my commit is a single logical unit of work
-
-- [x] I have checked for unnecessary whitespace with "git diff --check" 
-
-- [x] my commit does not include commented out code or unneeded files
-
-### The Content
-
-- [x] my commit includes tests for the bug I fixed or feature I added
-
-- [x] my commit includes appropriate documentation changes if it is introducing a new feature or changing existing functionality
-    
-- [x] my code passes existing test suites
-
-### The Commit Message
-
-- [x] the first line of my commit message includes:
-
-  - [x] an issue number (if applicable), e.g. "(MODULES-xxxx) This is the first line" 
-  
-  - [x] a short description (50 characters is the soft limit, excluding ticket number(s))
-
-- [x] the body of my commit message:
-
-  - [x] is meaningful
-
-  - [x] uses the imperative, present tense: "change", not "changed" or "changes"
-
-  - [x] includes motivation for the change, and contrasts its implementation with the previous behavior
-
-## Submission
-
-### Pre-requisites
-
-- Make sure you have a [GitHub account](https://github.com/join)
-
-- [Create a ticket](https://tickets.puppet.com/secure/CreateIssue!default.jspa), or [watch the ticket](https://tickets.puppet.com/browse/) you are patching for.
-
-### Push and PR
-
-- Push your changes to your fork
-
-- [Open a Pull Request](https://help.github.com/articles/creating-a-pull-request-from-a-fork/) against the repository in the puppetlabs organization
-
-## More about commits 
-
-  1.  Make separate commits for logically separate changes.
-
-      Please break your commits down into logically consistent units
-      which include new or changed tests relevant to the rest of the
-      change.  The goal of doing this is to make the diff easier to
-      read for whoever is reviewing your code.  In general, the easier
-      your diff is to read, the more likely someone will be happy to
-      review it and get it into the code base.
-
-      If you are going to refactor a piece of code, please do so as a
-      separate commit from your feature or bug fix changes.
-
-      We also really appreciate changes that include tests to make
-      sure the bug is not re-introduced, and that the feature is not
-      accidentally broken.
-
-      Describe the technical detail of the change(s).  If your
-      description starts to get too long, that is a good sign that you
-      probably need to split up your commit into more finely grained
-      pieces.
-
-      Commits which plainly describe the things which help
-      reviewers check the patch and future developers understand the
-      code are much more likely to be merged in with a minimum of
-      bike-shedding or requested changes.  Ideally, the commit message
-      would include information, and be in a form suitable for
-      inclusion in the release notes for the version of Puppet that
-      includes them.
-
-      Please also check that you are not introducing any trailing
-      whitespace or other "whitespace errors".  You can do this by
-      running "git diff --check" on your changes before you commit.
-
-  2.  Sending your patches
-
-      To submit your changes via a GitHub pull request, we _highly_
-      recommend that you have them on a topic branch, instead of
-      directly on "master".
-      It makes things much easier to keep track of, especially if
-      you decide to work on another thing before your first change
-      is merged in.
-
-      GitHub has some pretty good
-      [general documentation](http://help.github.com/) on using
-      their site.  They also have documentation on
-      [creating pull requests](https://help.github.com/articles/creating-a-pull-request-from-a-fork/).
-
-      In general, after pushing your topic branch up to your
-      repository on GitHub, you can switch to the branch in the
-      GitHub UI and click "Pull Request" towards the top of the page
-      in order to open a pull request.
-
-  3.  Update the related JIRA issue.
-
-      If there is a JIRA issue associated with the change you
-      submitted, then you should update the ticket to include the
-      location of your branch, along with any other commentary you
-      may wish to make.
-
-# Testing
-
-## Getting Started
-
-Our Puppet modules provide [`Gemfile`](./Gemfile)s, which can tell a Ruby package manager such as [bundler](http://bundler.io/) what Ruby packages,
-or Gems, are required to build, develop, and test this software.
-
-Please make sure you have [bundler installed](http://bundler.io/#getting-started) on your system, and then use it to 
-install all dependencies needed for this project in the project root by running
-
-```shell
-% bundle install --path .bundle/gems
-Fetching gem metadata from https://rubygems.org/........
-Fetching gem metadata from https://rubygems.org/..
-Using rake (10.1.0)
-Using builder (3.2.2)
--- 8><-- many more --><8 --
-Using rspec-system-puppet (2.2.0)
-Using serverspec (0.6.3)
-Using rspec-system-serverspec (1.0.0)
-Using bundler (1.3.5)
-Your bundle is complete!
-Use `bundle show [gemname]` to see where a bundled gem is installed.
-```
-
-NOTE: some systems may require you to run this command with sudo.
-
-If you already have those gems installed, make sure they are up-to-date:
-
-```shell
-% bundle update
-```
-
-## Running Tests
-
-With all dependencies in place and up-to-date, run the tests:
-
-### Unit Tests
-
-```shell
-% bundle exec rake spec
-```
-
-This executes all the [rspec tests](http://rspec-puppet.com/) in the directories defined [here](https://github.com/puppetlabs/puppetlabs_spec_helper/blob/699d9fbca1d2489bff1736bb254bb7b7edb32c74/lib/puppetlabs_spec_helper/rake_tasks.rb#L17) and so on. 
-rspec tests may have the same kind of dependencies as the module they are testing. Although the module defines these dependencies in its [metadata.json](./metadata.json),
-rspec tests define them in [.fixtures.yml](./fixtures.yml).
-
-### Acceptance Tests
-
-Some Puppet modules also come with acceptance tests, which use [beaker][]. These tests spin up a virtual machine under
-[VirtualBox](https://www.virtualbox.org/), controlled with [Vagrant](http://www.vagrantup.com/), to simulate scripted test
-scenarios. In order to run these, you need both Virtualbox and Vagrant installed on your system.
-
-Run the tests by issuing the following command
-
-```shell
-% bundle exec rake spec_clean
-% bundle exec rspec spec/acceptance
-```
-
-This will now download a pre-fabricated image configured in the [default node-set](./spec/acceptance/nodesets/default.yml),
-install Puppet, copy this module, and install its dependencies per [spec/spec_helper_acceptance.rb](./spec/spec_helper_acceptance.rb)
-and then run all the tests under [spec/acceptance](./spec/acceptance).
-
-A specific node set can be selected by setting the `BEAKER_set` environment variable
-
-```shell
-% export BEAKER_set=spec/acceptance/nodesets/centos-7-x64
-```
-
-If using a VM pooler node set, a password must be set via `BEAKER_password`.
-
-## Writing Tests
-
-### Unit Tests
-
-When writing unit tests for Puppet, [rspec-puppet][] is your best friend. It provides tons of helper methods for testing your manifests against a 
-catalog (e.g. contain_file, contain_package, with_params, etc). It would be ridiculous to try and top rspec-puppet's [documentation][rspec-puppet_docs] 
-but here's a tiny sample:
-
-Sample manifest:
-
-```puppet
-file { "a test file":
-  ensure => present,
-  path   => "/etc/sample",
-}
-```
-
-Sample test:
-
-```ruby
-it 'does a thing' do
-  expect(subject).to contain_file("a test file").with({:path => "/etc/sample"})
-end
-```
-
-### Acceptance Tests
-
-Writing acceptance tests for Puppet involves [beaker][] and its cousin [beaker-rspec][]. A common pattern for acceptance tests is to create a test manifest, apply it
-twice to check for idempotency or errors, then run expectations.
-
-```ruby
-it 'does an end-to-end thing' do
-  pp = <<-EOF
-    file { 'a test file': 
-      ensure  => present,
-      path    => "/etc/sample",
-      content => "test string",
-    }
-    
-  apply_manifest(pp, :catch_failures => true)
-  apply_manifest(pp, :catch_changes => true)
-  
-end
-
-describe file("/etc/sample") do
-  it { is_expected.to contain "test string" }
-end
-
-```
-
-# If you have commit access to the repository
-
-Even if you have commit access to the repository, you still need to go through the process above, and have someone else review and merge
-in your changes.  The rule is that **all changes must be reviewed by a project developer that did not write the code to ensure that
-all changes go through a code review process.**
-
-The record of someone performing the merge is the record that they performed the code review. Again, this should be someone other than the author of the topic branch.
-
-# Get Help
-
-### On the web
-* [Puppet help messageboard](http://puppet.com/community/get-help)
-* [Writing tests](https://docs.puppet.com/guides/module_guides/bgtm.html#step-three-module-testing)
-* [General GitHub documentation](http://help.github.com/)
-* [GitHub pull request documentation](http://help.github.com/send-pull-requests/)
-
-### On chat
-* Slack (slack.puppet.com) #forge-modules, #puppet-dev, #windows, #voxpupuli
-* IRC (freenode) #puppet-dev, #voxpupuli
-
-
-[rspec-puppet]: http://rspec-puppet.com/
-[rspec-puppet_docs]: http://rspec-puppet.com/documentation/
-[beaker]: https://github.com/puppetlabs/beaker
-[beaker-rspec]: https://github.com/puppetlabs/beaker-rspec