beaker-vagrant 0.5.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b0507afd930ed4038b5828c44deaba498093bce5
-  data.tar.gz: 2936af72e1c7ca90377b1179ec783fc2257ff697
+  metadata.gz: d84392a96de3ef88f5b20f1ecb2eb5ec74afdb55
+  data.tar.gz: 5b1b20587489bfd00f891071dbb21c8322baafe4
 SHA512:
-  metadata.gz: 4b513ccb24fcdd1f0dd5fb13c4779629d0b913988398fbab3bf69bb48ec181678ff50c3d2ed3e26209588c42fd3454ec5204ba52a4534faf0c2b114c6e108928
-  data.tar.gz: 423b6c4bff4c7561750f38017986a682327d37563bc99737a1351ee2363ac7d9918f14357cadf423c37add92bfef912508b96b8745c8f58c6366b020a8784b91
+  metadata.gz: c572ba506cdd9bbe3daffb77ac24c13a86b808bfb2c7c47e4dfcce244d80094ef13ecb7dc346f4cf22aa78f55ca7c35f36844cbd4f8bbf5d603dd4bdc2ebd756
+  data.tar.gz: d53012692dfbda60846694697c948a499d1685c47c5dd94ff7a85a0f69601758a2a998fa552c084e67e52417d35f630bead60e61904d035a16153e55c0d0eac7

data/README.md

@@ -6,16 +6,22 @@ Beaker library to use vagrant hypervisor
 
 This is a gem that allows you to use hosts with [vagrant](docs/vagrant.md) hypervisor with [beaker](https://github.com/puppetlabs/beaker). 
 
-### Right Now? (beaker 3.x)
+## With Beaker 3.x
 
-This gem is already included as [beaker dependency](https://github.com/puppetlabs/beaker/blob/master/beaker.gemspec) for you, so you don't need to do anything special to use this gem's functionality with beaker.
+This library is included as a dependency of Beaker 3.x versions, so there's nothing to do.
 
-### In beaker's Next Major Version? (beaker 4.x)
+## With Beaker 4.x
 
-In beaker's next major version, the requirement for beaker-vagrant will be pulled
-from that repo. When that happens, then the usage pattern will change. In order
-to use this then, you'll need to include beaker-vagrant as a dependency right
-next to beaker itself.
+As of Beaker 4.0, all hypervisor and DSL extension libraries have been removed and are no longer dependencies. In order to use a specific hypervisor or DSL extension library in your project, you will need to include them alongside Beaker in your Gemfile or project.gemspec. E.g.
+
+~~~ruby
+# Gemfile
+gem 'beaker', '~>4.0'
+gem 'beaker-vagrant'
+# project.gemspec
+s.add_runtime_dependency 'beaker', '~>4.0'
+s.add_runtime_dependency 'beaker-vagrant'
+~~~
 
 # Spec tests
 

data/acceptance/config/nodes/redhat-nodes.yml

@@ -7,18 +7,18 @@ HOSTS:
       - databse
       - classifier
       - default
-    platform: el-7-x86_64 
+    platform: el-7-x86_64
     template: redhat-7-x86_64
-    box: puppetlabs/centos-7.0-64-nocm
-    box_url: https://vagrantcloud.com/puppetlabs/boxes/centos-7.0-64-nocm
+    box: centos/7
+    box_url: https://app.vagrantup.com/centos/boxes/7
     hypervisor: vagrant
   redhat7-64-2:
     roles:
       - agent
     platform: el-7-x86_64
     template: redhat-7-x86_64
-    box: puppetlabs/centos-7.0-64-nocm 
-    box_url: https://vagrantcloud.com/puppetlabs/boxes/centos-7.0-64-nocm
+    box: centos/7
+    box_url: https://app.vagrantup.com/centos/boxes/7
     hypervisor: vagrant
 CONFIG:
   nfs_server: none

data/beaker-vagrant.gemspec

@@ -20,7 +20,12 @@ Gem::Specification.new do |s|
   # Testing dependencies
   s.add_development_dependency 'rspec', '~> 3.0'
   s.add_development_dependency 'rspec-its'
-  s.add_development_dependency 'fakefs', '~> 0.6'
+  # pin fakefs for Ruby < 2.3
+  if RUBY_VERSION < "2.3"
+    s.add_development_dependency 'fakefs', '~> 0.6', '< 0.14'
+  else
+    s.add_development_dependency 'fakefs', '~> 0.6'
+  end
   s.add_development_dependency 'rake', '~> 10.1'
   s.add_development_dependency 'simplecov'
   s.add_development_dependency 'pry', '~> 0.10'

data/docs/vagrant.md

@@ -1,21 +1,29 @@
 # Vagrant
 
-Vagrant's slogan is "development environments made easy". They provide an
+Vagrant's slogan is "development environments made easy". Vagrant provides an
 abstraction on top of a VM or cloud provider that allows you to manage
-hosts and their provisioning. [Their Site](https://www.vagrantup.com/).
+hosts and their provisioning. <https://www.vagrantup.com/>.
 
-# Getting Started
+## Getting Started
 
 ### Requirements
 
 A prerequisite for using the vagrant hypervisor with beaker is that the
-**Vagrant 1.7+** package needs to installed - 
-see [downloads.vagrantup.com](http://downloads.vagrantup.com/) for downloads.
+`Vagrant` package, minimum version 1.7, needs to installed. Version 2.1.2 (latest as of time of writing) has been tested. See [downloads.vagrantup.com](http://downloads.vagrantup.com/) for downloads or install with Homebrew:
 
-Currently, we provide a suite of pre-built, publicly available vagrant boxes for
-use in constructing tests: [Puppet Labs Vagrant Boxes](https://vagrantcloud.com/puppetlabs/).
-You can use these boxes easily by pulling one of our
-[Example Vagrant Hosts Files](vagrant_hosts_file_examples.md).
+~~~console
+$ brew install cask vagrant
+~~~
+
+You will also need a virtualization provider. Beaker-vagrant is most commonly used as an interface to VirtualBox, so you'll also need that:
+
+~~~console
+$ brew install cask virtualbox
+~~~
+
+Historically, we provided a suite of pre-built, publicly available Vagrant boxes for use in constructing tests: [Puppet Labs Vagrant Boxes](https://vagrantcloud.com/puppetlabs/). However, these boxes have not been updated recently and *will* have issues (ex: outdated cURL on CentOS). You can use these easily by pulling one of our [Example Vagrant Hosts Files](vagrant_hosts_file_examples.md), but this should be avoided if possible.
+
+For acceptance testing of beaker-vagrant, we use [the official CentOS 7 box](https://app.vagrantup.com/centos/boxes/7).
 
 ### Setup a Vagrant Hosts File
 
@@ -180,6 +188,29 @@ When using the Vagrant Hypervisor, beaker can create attached volumes which appe
             size: 5120
         volume_storage_controller: USB
 
+### Adding vagrant shell provisioner
+
+When using the Vagrant Hypervisor, beaker can create the Vagrantfile with a shell provisioner. This is done by using the `shell_provisioner` option in the nodeset file.
+
+**Example hosts file**
+
+    HOSTS:
+      ubuntu-1404-x64-master:
+        roles:
+          - master
+          - agent
+          - dashboard
+          - database
+        platform: ubuntu-1404-x86_64
+        hypervisor: vagrant
+        box: puppetlabs/ubuntu-14.04-64-nocm
+        box_url: https://vagrantcloud.com/puppetlabs/boxes/ubuntu-14.04-64-nocm
+        ip: 192.168.20.20
+        shell_provisioner:
+          path: /home/user/scripts/bootstrap.sh
+
+In the above, beaker will create a Vagrantfile which runs the above shell script on the Agent guest.
+
 # vagrant plugins #
 
 You can check more information for some suported vagrant plugins:

data/lib/beaker-vagrant/version.rb

@@ -1,3 +1,3 @@
 module BeakerVagrant
-  VERSION = '0.5.0'
+  VERSION = '0.6.0'
 end

data/lib/beaker/hypervisor/vagrant.rb

@@ -35,6 +35,19 @@ module Beaker
       end
     end
 
+    def shell_provisioner_generator(provisioner_config)
+      unless provisioner_config['path'].nil? || provisioner_config['path'].empty?
+        unless provisioner_config['args'].nil?
+          shell_provisioner_string = "    v.vm.provision 'shell', :path => '#{provisioner_config['path']}', :args => '#{provisioner_config['args']}' \n"
+        else
+          shell_provisioner_string = "    v.vm.provision 'shell', :path => '#{provisioner_config['path']}'\n"
+        end
+        shell_provisioner_string
+      else
+        raise "No path defined for shell_provisioner or path empty"
+      end
+    end
+
     def make_vfile hosts, options = {}
       #HACK HACK HACK - add checks here to ensure that we have box + box_url
       #generate the VagrantFile
@@ -53,6 +66,7 @@ module Beaker
         v_file << "    v.vm.box_download_insecure = '#{host['box_download_insecure']}'\n" unless host['box_download_insecure'].nil?
         v_file << "    v.vm.box_check_update = '#{host['box_check_update'] ||= 'true'}'\n"
         v_file << "    v.vm.synced_folder '.', '/vagrant', disabled: true\n" if host['synced_folder'] == 'disabled'
+        v_file << shell_provisioner_generator(host['shell_provisioner']) if host['shell_provisioner']
         v_file << private_network_generator(host)
 
         unless host['mount_folders'].nil?
@@ -131,6 +145,32 @@ module Beaker
       Beaker::VagrantVirtualbox.provider_vfile_section(host, options)
     end
 
+    def set_all_ssh_config
+      @logger.debug "configure vagrant boxes (set ssh-config, switch to root user, hack etc/hosts)"
+      @hosts.each do |host|
+        if host[:platform] =~ /windows/
+          @logger.debug "skip ssh hacks on windows box #{host[:name]}"
+          set_ssh_config host, host['user']
+          next
+        end
+
+        default_user = host['user']
+
+        set_ssh_config host, 'vagrant'
+
+        #copy vagrant's keys to roots home dir, to allow for login as root
+        copy_ssh_to_root host, @options
+        #ensure that root login is enabled for this host
+        enable_root_login host, @options
+        #shut down connection, will reconnect on next exec
+        host.close
+
+        set_ssh_config host, default_user
+      end
+
+      hack_etc_hosts @hosts, @options
+    end
+
     def set_ssh_config host, user
         f = Tempfile.new("#{host.name}")
         ssh_config = Dir.chdir(@vagrant_path) do
@@ -145,6 +185,11 @@ module Beaker
 
         #set the user
         ssh_config = ssh_config.gsub(/User vagrant/, "User #{user}")
+
+        if @options[:forward_ssh_agent] == true
+          ssh_config = ssh_config.gsub(/IdentitiesOnly yes/, "IdentitiesOnly no")
+        end
+
         f.write(ssh_config)
         f.rewind
         host['ssh'] = {:config => f.path()}
@@ -182,65 +227,46 @@ module Beaker
       @vagrant_env = { "RUBYLIB" => "" }
     end
 
-    def provision(provider = nil)
-      if !@options[:provision] and !File.file?(@vagrant_file)
-        raise "Beaker is configured with provision = false but no vagrant file was found at #{@vagrant_file}. You need to enable provision"
-      end
-      if @options[:provision]
-        #setting up new vagrant hosts
-        #make sure that any old boxes are dead dead dead
-        begin
-          vagrant_cmd("destroy --force") if File.file?(@vagrant_file)
-        rescue RuntimeError => e
-          # LATER: use <<~MESSAGE once we're on Ruby 2.3
-          @logger.debug(%Q{
-            Beaker failed to destroy the existing VM's. If you think this is
-            an error or you upgraded from an older version of beaker try
-            verifying the VM exists and deleting the existing Vagrantfile if
-            you believe it is safe to do so. WARNING: If a VM still exists
-            please run 'vagrant destroy'.
-
-            cd #{@vagrant_path}
-            vagrant status
-            vagrant destroy # only need to run this is a VM is not created
-            rm #{@vagrant_file} # only do this if all VM's are actually destroyed
-          }.each_line.map(&:strip).join("\n"))
-          raise e
+    def configure(opts = {})
+      if !@options[:provision]
+        if !File.file?(@vagrant_file)
+          raise "Beaker is configured with provision = false but no vagrant file was found at #{@vagrant_file}. You need to enable provision"
         end
 
-        make_vfile @hosts, @options
-
-        vagrant_cmd("up#{" --provider #{provider}" if provider}")
-      else #set host ip of already up boxes
         @hosts.each do |host|
           host[:ip] = get_ip_from_vagrant_file(host.name)
         end
-      end
-
-      @logger.debug "configure vagrant boxes (set ssh-config, switch to root user, hack etc/hosts)"
-      @hosts.each do |host|
-        if host[:platform] =~ /windows/
-          @logger.debug "skip ssh hacks on windows box #{host[:name]}"
-          set_ssh_config host, host['user']
-          next
-        end
 
-        default_user = host['user']
-
-        set_ssh_config host, 'vagrant'
-
-        #copy vagrant's keys to roots home dir, to allow for login as root
-        copy_ssh_to_root host, @options
-        #ensure that root login is enabled for this host
-        enable_root_login host, @options
-        #shut down connection, will reconnect on next exec
-        host.close
+        set_all_ssh_config
+      end
+    end
 
-        set_ssh_config host, default_user
+    def provision(provider = nil)
+      #setting up new vagrant hosts
+      #make sure that any old boxes are dead dead dead
+      begin
+        vagrant_cmd("destroy --force") if File.file?(@vagrant_file)
+      rescue RuntimeError => e
+        # LATER: use <<~MESSAGE once we're on Ruby 2.3
+        @logger.debug(%Q{
+          Beaker failed to destroy the existing VM's. If you think this is
+          an error or you upgraded from an older version of beaker try
+          verifying the VM exists and deleting the existing Vagrantfile if
+          you believe it is safe to do so. WARNING: If a VM still exists
+          please run 'vagrant destroy'.
+          cd #{@vagrant_path}
+          vagrant status
+          vagrant destroy # only need to run this is a VM is not created
+          rm #{@vagrant_file} # only do this if all VM's are actually destroyed
+        }.each_line.map(&:strip).join("\n"))
+        raise e
       end
 
-      hack_etc_hosts @hosts, @options
+      make_vfile @hosts, @options
+
+      vagrant_cmd("up#{" --provider #{provider}" if provider}")
 
+      set_all_ssh_config
     end
 
     def cleanup

data/spec/beaker/hypervisor/vagrant_spec.rb

@@ -178,6 +178,61 @@ EOF
       expect( vagrantfile ).to match(/v.vm.synced_folder '\/valid', '\/valid', create: true/)
     end
 
+    it "can make a Vagrantfile with optional shell provisioner" do
+      path = vagrant.instance_variable_get( :@vagrant_path )
+      allow( vagrant ).to receive( :randmac ).and_return( "0123456789" )
+
+      shell_path = '/path/to/shell/script'
+      hosts = make_hosts({
+        :shell_provisioner => {
+          :path => shell_path
+        }
+      }, 1)
+      vagrant.make_vfile( hosts, options )
+
+      vagrantfile = File.read( File.expand_path( File.join( path, "Vagrantfile")))
+      expect( vagrantfile ).to match(/v.vm.provision 'shell', :path => '#{shell_path}'/)
+    end
+
+    it "can make a Vagrantfile with optional shell provisioner with args" do
+      path = vagrant.instance_variable_get( :@vagrant_path )
+      allow( vagrant ).to receive( :randmac ).and_return( "0123456789" )
+
+      shell_path = '/path/to/shell/script.sh'
+      shell_args = 'arg1 arg2'
+      hosts = make_hosts({
+        :shell_provisioner => {
+          :path => shell_path,
+          :args => shell_args
+        }
+      }, 1)
+      vagrant.make_vfile( hosts, options )
+
+      vagrantfile = File.read( File.expand_path( File.join( path, "Vagrantfile")))
+      expect( vagrantfile ).to match(/v.vm.provision 'shell', :path => '#{shell_path}', :args => '#{shell_args}'/)
+    end
+
+    it "raises an error if path is not set on shell_provisioner" do
+      path = vagrant.instance_variable_get( :@vagrant_path )
+      allow( vagrant ).to receive( :randmac ).and_return( "0123456789" )
+
+      hosts = make_hosts({:shell_provisioner => {}}, 1)
+      expect{ vagrant.make_vfile( hosts, options ) }.to raise_error RuntimeError, /No path defined for shell_provisioner or path empty/
+    end
+
+    it "raises an error if path is EMPTY on shell_provisioner" do
+      path = vagrant.instance_variable_get( :@vagrant_path )
+      allow( vagrant ).to receive( :randmac ).and_return( "0123456789" )
+
+      empty_shell_path = ''
+      hosts = make_hosts({
+        :shell_provisioner => {
+          :path => empty_shell_path
+        }
+      }, 1)
+      expect{ vagrant.make_vfile( hosts, options ) }.to raise_error RuntimeError, /No path defined for shell_provisioner or path empty/
+    end
+
     context "when generating a windows config" do
       before do
         path = vagrant.instance_variable_get( :@vagrant_path )
@@ -389,39 +444,121 @@ EOF
       end
     end
 
-    it "can generate a ssh-config file" do
-      host = @hosts[0]
-      name = host.name
-      allow( Dir ).to receive( :chdir ).and_yield()
-      out = double( 'stdout' )
-      allow( out ).to receive( :read ).and_return("Host #{name}
-    HostName 127.0.0.1
-    User vagrant
-    Port 2222
-    UserKnownHostsFile /dev/null
-    StrictHostKeyChecking no
-    PasswordAuthentication no
-    IdentityFile /home/root/.vagrant.d/insecure_private_key
-    IdentitiesOnly yes")
-
-      wait_thr = OpenStruct.new
-      state = double( 'state' )
-      allow( state ).to receive( :success? ).and_return( true )
-      wait_thr.value = state
-
-      allow( Open3 ).to receive( :popen3 ).with( {"RUBYLIB"=>""}, 'vagrant', 'ssh-config', name ).and_return( [ "", out, "", wait_thr ])
-
-      file = double( 'file' )
-      allow( file ).to receive( :path ).and_return( '/path/sshconfig' )
-      allow( file ).to receive( :rewind ).and_return( true )
-
-      expect( Tempfile ).to receive( :new ).with( "#{host.name}").and_return( file )
-      expect( file ).to receive( :write ).with("Host ip.address.for.#{name}\n    HostName 127.0.0.1\n    User root\n    Port 2222\n    UserKnownHostsFile /dev/null\n    StrictHostKeyChecking no\n    PasswordAuthentication no\n    IdentityFile /home/root/.vagrant.d/insecure_private_key\n    IdentitiesOnly yes")
-
-      vagrant.set_ssh_config( host, 'root' )
-      expect( host['ssh'] ).to be === { :config => file.path }
-      expect( host['user']).to be === 'root'
+    describe "set_ssh_config" do
+      let( :out ) { double( 'stdout' ) }
+      let( :host ) { @hosts[0] }
+      let( :name ) { host.name }
+      let( :file ) { double( 'file' ) }
+
+      before :each do
+        allow( Dir ).to receive( :chdir ).and_yield()
+        wait_thr = OpenStruct.new
+        state = double( 'state' )
+        allow( state ).to receive( :success? ).and_return( true )
+        wait_thr.value = state
+
+        allow( Open3 ).to receive( :popen3 ).with( {"RUBYLIB"=>""}, 'vagrant', 'ssh-config', name ).and_return( [ "", out, "", wait_thr ])
+
+        allow( file ).to receive( :path ).and_return( '/path/sshconfig' )
+        allow( file ).to receive( :rewind ).and_return( true )
+
+        allow( out ).to receive( :read ).and_return("Host #{name}
+        HostName 127.0.0.1
+        User vagrant
+        Port 2222
+        UserKnownHostsFile /dev/null
+        StrictHostKeyChecking no
+        PasswordAuthentication no
+        IdentityFile /home/root/.vagrant.d/insecure_private_key
+        IdentitiesOnly yes")
+      end
+
+      it "can generate a ssh-config file" do
+       expect( Tempfile ).to receive( :new ).with( "#{host.name}").and_return( file )
+        expect( file ).to receive( :write ).with("Host ip.address.for.#{name}\n        HostName 127.0.0.1\n        User root\n        Port 2222\n        UserKnownHostsFile /dev/null\n        StrictHostKeyChecking no\n        PasswordAuthentication no\n        IdentityFile /home/root/.vagrant.d/insecure_private_key\n        IdentitiesOnly no")
+
+        vagrant.set_ssh_config( host, 'root' )
+        expect( host['ssh'] ).to be === { :config => file.path }
+        expect( host['user']).to be === 'root'
+      end
+
+      context "when :forward_ssh_agent is false" do
+        it "should not change IdentitiesOnly to no" do
+          options = vagrant.instance_variable_get( :@options )
+          options['forward_ssh_agent'] = false
+          options = vagrant.instance_variable_set( :@options, options )
+
+          expect( Tempfile ).to receive( :new ).with( "#{host.name}").and_return( file )
+          expect( file ).to receive( :write ).with("Host ip.address.for.#{name}\n        HostName 127.0.0.1\n        User root\n        Port 2222\n        UserKnownHostsFile /dev/null\n        StrictHostKeyChecking no\n        PasswordAuthentication no\n        IdentityFile /home/root/.vagrant.d/insecure_private_key\n        IdentitiesOnly yes")
 
+          vagrant.set_ssh_config( host, 'root' )
+          expect( host['ssh'] ).to be === { :config => file.path }
+          expect( host['user']).to be === 'root'
+        end
+      end
+    end
+
+    context 'with options[:provision] = false' do
+      let(:options) { super().merge(provision: false) }
+
+      context 'when Vagrantfile does not exist' do
+        it 'raises an error' do
+          expect { vagrant.configure }.to raise_error RuntimeError, /no vagrant file was found/
+        end
+      end
+
+      it 'calls #get_ip_from_vagrant_file' do
+        vagrant.make_vfile(@hosts)
+
+        @hosts.each do |host|
+          allow(vagrant).to receive(:set_ssh_config).with(host, anything)
+          expect(vagrant).to receive(:get_ip_from_vagrant_file).with(host.name)
+        end
+
+        vagrant.configure
+      end
+
+      it 'calls #set_all_ssh_config' do
+        vagrant.make_vfile(@hosts)
+        expect(vagrant).to receive(:set_all_ssh_config)
+        vagrant.configure
+      end
+    end
+
+    describe '#set_all_ssh_config' do
+      before do
+        allow(vagrant).to receive(:set_ssh_config)
+      end
+
+      it 'calls #set_ssh_config' do
+        @hosts.each do |host|
+          expect(vagrant).to receive(:set_ssh_config).with(host, 'vagrant')
+          expect(vagrant).to receive(:set_ssh_config).with(host, host['user'])
+        end
+
+        vagrant.set_all_ssh_config
+      end
+
+      it 'calls #copy_ssh_to_root' do
+        @hosts.each do |host|
+          expect(vagrant).to receive(:copy_ssh_to_root).with(host, options)
+        end
+
+        vagrant.set_all_ssh_config
+      end
+
+      it 'calls #enable_root_login' do
+        @hosts.each do |host|
+          expect(vagrant).to receive(:enable_root_login).with(host, options)
+        end
+
+        vagrant.set_all_ssh_config
+      end
+
+      it 'calls #hack_etc_hosts' do
+        expect(vagrant).to receive(:hack_etc_hosts).with(@hosts, options)
+        vagrant.set_all_ssh_config
+      end
     end
 
     describe "get_ip_from_vagrant_file" do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: beaker-vagrant
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.6.0
 platform: ruby
 authors:
 - Rishi Javia, Kevin Imber, Tony Vu
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-05-03 00:00:00.000000000 Z
+date: 2018-11-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec