beaker-vagrant 0.6.7 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cc3033b00b34521daab9d6221f02c1514cffaff1c64863dcb5643bf964e28f10
-  data.tar.gz: be554ffaf55e253e2ef2c61f86c3b9fec52f043f3ce496d1eb5c898e4c4c9da2
+  metadata.gz: 4ee5ce13c977a0b3bd07ff792f1f722d986e1e50a332bb4762d1d15c8c8dfe48
+  data.tar.gz: 9e17a0f6f245ba61142e42883f0d2b5ac456e40b92b26d6b8c22d08dffc0c7b2
 SHA512:
-  metadata.gz: bf38bd6c73c279461c5f9f8a9334a5bbbfb37658dfb0e8463b861fdfbd6c81e1c0132fd8a865a5c3ad08766a89f1ec1792bde7457d9a7d258e2891d5061537c3
-  data.tar.gz: 54d4ecc9660e53f1c49a1e786407ed1c5c20461fc3ff6756cfe1699d91468c0c9fa01b4e5717258d6f70454e825c8d5fda7ec65d3a3ec17bc49365364b57a122
+  metadata.gz: 6b2c6c0ed39876e4f630d9dac376f782a00277011c8b5321567ed09635e55f04b7656df59f0658b1565a3fd474bf632017ea9a9ca99bdd5ba083ebc2791aea7e
+  data.tar.gz: 4f429aeccdbb05b4a9eeccf817e44327a463315a16c7a517914469a4a09f9b046d3ea8fc4342208ae2071f1a907324c20c23e1006feff3fe9e96979f6739a6a4

data/.github/workflows/release.yml

@@ -0,0 +1,24 @@
+name: Release
+
+on:
+  create:
+    ref_type: tag
+
+jobs:
+  release:
+    runs-on: ubuntu-latest
+    if: github.repository == 'voxpupuli/beaker-vagrant'
+    env:
+      BUNDLE_WITHOUT: release
+    steps:
+      - uses: actions/checkout@v2
+      - name: Install Ruby 2.7
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: '2.7'
+      - name: Build gem
+        run: gem build *.gemspec
+      - name: Publish gem
+        run: gem push *.gem
+        env:
+          GEM_HOST_API_KEY: '${{ secrets.RUBYGEMS_AUTH_TOKEN }}'

data/beaker-vagrant.gemspec

@@ -24,18 +24,14 @@ Gem::Specification.new do |s|
   if RUBY_VERSION < "2.3"
     s.add_development_dependency 'fakefs', '~> 0.6', '< 0.14'
   else
-    s.add_development_dependency 'fakefs', '~> 0.6'
+    s.add_development_dependency 'fakefs', '>= 0.6', '< 2.0'
   end
-  s.add_development_dependency 'rake', '~> 10.1'
+  s.add_development_dependency 'rake', '~> 13.0'
   s.add_development_dependency 'simplecov'
   s.add_development_dependency 'pry', '~> 0.10'
 
   # Documentation dependencies
   s.add_development_dependency 'yard'
   s.add_development_dependency 'thin'
-
-  # Run time dependencies
-  s.add_runtime_dependency 'stringify-hash', '~> 0.0.0'
-
 end
 

data/lib/beaker-vagrant/version.rb

@@ -1,3 +1,3 @@
 module BeakerVagrant
-  VERSION = '0.6.7'
+  VERSION = '0.7.0'
 end

data/lib/beaker/hypervisor/vagrant.rb

@@ -5,12 +5,6 @@ module Beaker
 
     require 'beaker/hypervisor/vagrant/mount_folder'
     require 'beaker/hypervisor/vagrant_virtualbox'
-    # Return a random mac address
-    #
-    # @return [String] a random mac address
-    def randmac
-      "080027" + (1..3).map{"%0.2X"%rand(256)}.join
-    end
 
     def rand_chunk
       (2 + rand(252)).to_s #don't want a 0, 1, or a 255
@@ -27,19 +21,17 @@ module Beaker
 
     def private_network_generator(host)
       private_network_string = "    v.vm.network :private_network, ip: \"#{host['ip'].to_s}\", :netmask => \"#{host['netmask'] ||= "255.255.0.0"}\""
-      case host['network_mac']
-      when 'false'
-        @mac = randmac
-        private_network_string << "\n"
-      when nil
-        @mac = randmac
-        private_network_string << ", :mac => \"#{@mac}\"\n"
+      if host['network_mac']
+        private_network_string << ", :mac => \"#{host['network_mac']}\"\n"
       else
-        @mac = host['network_mac']
-        private_network_string << ", :mac => \"#{@mac}\"\n"
+        private_network_string << "\n"
       end
     end
 
+    def connection_preference(host)
+      [:hostname]
+    end
+
     def shell_provisioner_generator(provisioner_config)
       unless provisioner_config['path'].nil? || provisioner_config['path'].empty?
         unless provisioner_config['args'].nil?
@@ -62,7 +54,7 @@ module Beaker
 
       hosts.each do |host|
         host.name.tr!('_','-') # Rewrite Hostname with hyphens instead of underscores to get legal hostname
-        host['ip'] ||= randip(host.host_hash[:hypervisor]) #use the existing ip, otherwise default to a random ip
+        set_host_default_ip(host)
         v_file << "  c.vm.define '#{host.name}' do |v|\n"
         v_file << "    v.vm.hostname = '#{host.name}'\n"
         v_file << "    v.vm.box = '#{host['box']}'\n"
@@ -72,7 +64,7 @@ module Beaker
         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)
+        v_file << private_network_generator(host) if host['ip']
 
         unless host['mount_folders'].nil?
           host['mount_folders'].each do |name, folder|
@@ -132,7 +124,6 @@ module Beaker
           else
             v_file << "    v.vm.synced_folder '.', '/vagrant', :nfs => true\n"
           end
-          v_file << "    v.vm.base_mac = '#{@mac}'\n"
         end
 
         v_file << self.class.provider_vfile_section(host, options)
@@ -189,72 +180,45 @@ module Beaker
     end
 
     def set_ssh_config host, user
-        f = Tempfile.new("#{host.name}")
-        ssh_config = Dir.chdir(@vagrant_path) do
-          stdin, stdout, stderr, wait_thr = Open3.popen3(@vagrant_env, 'vagrant', 'ssh-config', host.name)
-          if not wait_thr.value.success?
-            raise "Failed to 'vagrant ssh-config' for #{host.name}"
-          end
-          stdout.read
-        end
-        #replace hostname with ip
-        ssh_config = ssh_config.gsub(/Host #{host.name}/, "Host #{host['ip']}") unless not host['ip']
-
-        #set the user
-        ssh_config = ssh_config.gsub(/User vagrant/, "User #{user}")
+      return unless Dir.exist?(@vagrant_path)
 
-        if @options[:forward_ssh_agent] == true
-          ssh_config = ssh_config.gsub(/IdentitiesOnly yes/, "IdentitiesOnly no")
+      ssh_config = Dir.chdir(@vagrant_path) do
+        stdout, _, status = Open3.capture3(@vagrant_env, 'vagrant', 'ssh-config', host.name)
+        unless status.success?
+          raise "Failed to 'vagrant ssh-config' for #{host.name}"
         end
 
-        f.write(ssh_config)
-        f.rewind
-
-        host[:vagrant_ssh_config] = f.path
-        host['ssh'] = host['ssh'].merge(Net::SSH.configuration_for(host['ip'], f.path))
-        host['user'] = user
-        @temp_files << f
-    end
+        Tempfile.create do |f|
+          f.write(stdout)
+          f.flush
 
-    def get_ip_from_vagrant_file(hostname)
-      ip = ''
-      if File.file?(@vagrant_file) #we should have a vagrant file available to us for reading
-        f = File.read(@vagrant_file)
-        m = /'#{hostname}'.*?ip:\s*('|")\s*([^'"]+)('|")/m.match(f)
-        if m
-          ip = m[2]
-          @logger.debug("Determined existing vagrant box #{hostname} ip to be: #{ip} ")
-        else
-          ip = nil
-          @logger.debug("Unable to determine ip for vagrant box #{hostname}")
+          Net::SSH::Config.for(host.name, [f.path])
         end
-      else
-        raise("No vagrant file found (should be located at #{@vagrant_file})")
       end
-      ip
+
+      ssh_config[:user] = user
+      ssh_config[:keys_only] = false if @options[:forward_ssh_agent] == true
+
+      host['ssh'] = host['ssh'].merge(ssh_config)
+      host['user'] = user
     end
 
     def initialize(vagrant_hosts, options)
       require 'tempfile'
       @options = options
       @logger = options[:logger]
-      @temp_files = []
       @hosts = vagrant_hosts
-      @vagrant_path = File.expand_path(File.join(File.basename(__FILE__), '..', '.vagrant', 'beaker_vagrant_files', 'beaker_' + File.basename(options[:hosts_file])))
+      @vagrant_path = File.expand_path(File.join('.vagrant', 'beaker_vagrant_files', 'beaker_' + File.basename(options[:hosts_file])))
       @vagrant_file = File.expand_path(File.join(@vagrant_path, "Vagrantfile"))
       @vagrant_env = { "RUBYLIB" => "", "RUBYOPT" => "" }
     end
 
     def configure(opts = {})
-      if !@options[:provision]
-        if !File.file?(@vagrant_file)
+      unless @options[:provision]
+        unless 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
 
-        @hosts.each do |host|
-          host[:ip] = get_ip_from_vagrant_file(host.name)
-        end
-
         set_all_ssh_config
       end
       super
@@ -292,9 +256,6 @@ module Beaker
 
     def cleanup
       @logger.debug "removing temporary ssh-config files per-vagrant box"
-      @temp_files.each do |f|
-        f.close()
-      end
       @logger.notify "Destroying vagrant boxes"
       vagrant_cmd("destroy --force")
       FileUtils.rm_rf(@vagrant_path)
@@ -350,5 +311,11 @@ module Beaker
         end
       end
     end
+
+    private
+
+    def set_host_default_ip(host)
+      host['ip'] ||= randip(host.host_hash[:hypervisor]) # use the existing ip, otherwise default to a random ip
+    end
   end
 end

data/lib/beaker/hypervisor/vagrant_custom.rb

@@ -6,6 +6,7 @@ class Beaker::VagrantCustom < Beaker::Vagrant
   end
 
   def make_vfile hosts, options = {}
+    FileUtils.mkdir_p(@vagrant_path)
     FileUtils.cp(@options[:vagrantfile_path], @vagrant_file)
   end
 end

data/lib/beaker/hypervisor/vagrant_libvirt.rb

@@ -1,27 +1,17 @@
 require 'beaker/hypervisor/vagrant'
 
 class Beaker::VagrantLibvirt < Beaker::Vagrant
-  @memory = nil
-  @cpu    = nil
-
-  class << self
-    attr_reader :memory
-  end
-
-  # Return a random mac address with colons
-  #
-  # @return [String] a random mac address
-  def randmac
-    "08:00:27:" + (1..3).map{"%0.2X"%rand(256)}.join(':')
-  end
+  def initialize(*)
+    super
 
-  def provision(provider = 'libvirt')
     # This needs to be unique for every system with the same hostname but does
     # not affect VirtualBox
     vagrant_path_digest = Digest::SHA256.hexdigest(@vagrant_path)
-    @vagrant_path = @vagrant_path + '_' + vagrant_path_digest[0..2] + vagrant_path_digest[-3..-1]
+    @vagrant_path += '_' + vagrant_path_digest[0..2] + vagrant_path_digest[-3..-1]
     @vagrant_file = File.expand_path(File.join(@vagrant_path, "Vagrantfile"))
+  end
 
+  def provision(provider = 'libvirt')
     super
   end
 
@@ -30,19 +20,19 @@ class Beaker::VagrantLibvirt < Beaker::Vagrant
       "      node.cpus = #{cpus(host, options)}\n" +
       "      node.memory = #{memsize(host, options)}\n" +
       "      node.qemu_use_session = false\n" +
-      build_options_str(options) +
+      build_options(options).join("\n") + "\n" +
       "    end\n"
   end
 
-  def self.build_options_str(options)
-    other_options_str = ''
-    if options['libvirt']
-      other_options = []
-      options['libvirt'].each do |k, v|
-        other_options << "      node.#{k} = '#{v}'"
-      end
-      other_options_str = other_options.join("\n")
-    end
-    "#{other_options_str}\n"
+  def self.build_options(options)
+    return [] unless options['libvirt']
+
+    options['libvirt'].map { |k, v| "      node.#{k} = '#{v}'" }
+  end
+
+  private
+
+  def set_host_default_ip(host)
+    # In vagrant-libvirt hosts get a management IP, no need for a default
   end
 end

data/spec/beaker/hypervisor/vagrant_custom_spec.rb

@@ -19,9 +19,10 @@ describe Beaker::VagrantCustom do
       expect( vagrant ).to receive( :set_ssh_config ).with( host, host_prev_name ).once
     end
     expect( vagrant ).to receive( :hack_etc_hosts ).with( @hosts, options ).once
-    FakeFS.activate!
     expect( vagrant ).to receive( :vagrant_cmd ).with( "up" ).once
-    vagrant.provision
+    FakeFS do
+      vagrant.provision
+    end
   end
 
   context 'takes vagrant configuration from existing file' do

data/spec/beaker/hypervisor/vagrant_desktop_spec.rb

@@ -2,71 +2,57 @@ require 'spec_helper'
 
 describe Beaker::VagrantDesktop do
   let( :options ) { make_opts.merge({ :hosts_file => 'sample.cfg', 'logger' => double().as_null_object }) }
-  let( :vagrant ) { Beaker::VagrantDesktop.new( @hosts, options ) }
-
-  before :each do
-    @hosts = make_hosts()
-  end
+  let( :vagrant ) { described_class.new( hosts, options ) }
+  let( :hosts ) { make_hosts }
 
   it "uses the vmware_desktop provider for provisioning" do
-    @hosts.each do |host|
+    hosts.each do |host|
       host_prev_name = host['user']
       expect( vagrant ).to receive( :set_ssh_config ).with( host, 'vagrant' ).once
       expect( vagrant ).to receive( :copy_ssh_to_root ).with( host, options ).once
       expect( vagrant ).to receive( :set_ssh_config ).with( host, host_prev_name ).once
     end
-    expect( vagrant ).to receive( :hack_etc_hosts ).with( @hosts, options ).once
+    expect( vagrant ).to receive( :hack_etc_hosts ).with( hosts, options ).once
     expect( vagrant ).to receive( :vagrant_cmd ).with( "up --provider vmware_desktop" ).once
-    vagrant.provision
-  end
-
-  it "can make a Vagranfile for a set of hosts" do
-    path = vagrant.instance_variable_get( :@vagrant_path )
-    allow( vagrant ).to receive( :randmac ).and_return( "0123456789" )
-
-    vagrant.make_vfile( @hosts )
-
-    vagrantfile = File.read( File.expand_path( File.join( path, "Vagrantfile")))
-    expect( vagrantfile ).to include( %Q{    v.vm.provider :vmware_desktop do |v|\n      v.vmx['memsize'] = '1024'\n    end})
+    FakeFS do
+      vagrant.provision
+    end
   end
 
-  it "can enable whitelist_verified on hosts" do 
-    path = vagrant.instance_variable_get( :@vagrant_path )
-    hosts = make_hosts({:whitelist_verified => true},1)
-
-    vagrant.make_vfile( hosts )
-
-    vagrantfile = File.read( File.expand_path( File.join( path, 'Vagrantfile' )))
-    expect( vagrantfile ).to include( %Q{ v.vmx['whitelist_verified'] = 'true'})
-  end
+  context 'can make a Vagrantfile' do
+    subject do
+      FakeFS do
+        vagrant.make_vfile(hosts)
+        File.read(vagrant.instance_variable_get(:@vagrant_file))
+      end
+    end
 
-  it "can enable functional_hgfs on hosts" do 
-    path = vagrant.instance_variable_get( :@vagrant_path )
-    hosts = make_hosts({:functional_hgfs => true},1)
+    it "for a set of hosts" do
+      is_expected.to include( %Q{    v.vm.provider :vmware_desktop do |v|\n      v.vmx['memsize'] = '1024'\n    end})
+    end
 
-    vagrant.make_vfile( hosts )
+    context 'with whitelist_verified' do
+      let(:hosts) { make_hosts({:whitelist_verified => true}, 1) }
 
-    vagrantfile = File.read( File.expand_path( File.join( path, 'Vagrantfile' )))
-    expect( vagrantfile ).to include( %Q{ v.vmx['functional_hgfs'] = 'true'})
-  end
+      it { is_expected.to include( %Q{ v.vmx['whitelist_verified'] = 'true'}) }
+    end
 
-  it "can enable unmount_default_hgfs on hosts" do 
-    path = vagrant.instance_variable_get( :@vagrant_path )
-    hosts = make_hosts({:unmount_default_hgfs => true},1)
+    context 'with functional_hgfs' do
+      let(:hosts) { make_hosts({:functional_hgfs => true}, 1) }
 
-    vagrant.make_vfile( hosts )
+      it { is_expected.to include( %Q{ v.vmx['functional_hgfs'] = 'true'}) }
+    end
 
-    vagrantfile = File.read( File.expand_path( File.join( path, 'Vagrantfile' )))
-    expect( vagrantfile ).to include( %Q{ v.vmx['unmount_default_hgfs'] = 'true'})
-  end
+    context 'with unmount_default_hgfs' do
+      let(:hosts) { make_hosts({:unmount_default_hgfs => true}, 1) }
 
-  it "can enable gui on hosts" do 
-    path = vagrant.instance_variable_get( :@vagrant_path )
-    hosts = make_hosts({:gui => true},1)
+      it { is_expected.to include( %Q{ v.vmx['unmount_default_hgfs'] = 'true'}) }
+    end
 
-    vagrant.make_vfile( hosts )
+    context "with gui" do
+      let(:hosts) { make_hosts({:gui => true},1) }
 
-    vagrantfile = File.read( File.expand_path( File.join( path, 'Vagrantfile' )))
-    expect( vagrantfile ).to include( %Q{ v.vmx['gui'] = true})
+      it { is_expected.to include( %Q{ v.vmx['gui'] = true}) }
+    end
   end
 end

data/spec/beaker/hypervisor/vagrant_fusion_spec.rb

@@ -2,31 +2,31 @@ require 'spec_helper'
 
 describe Beaker::VagrantFusion do
   let( :options ) { make_opts.merge({ :hosts_file => 'sample.cfg', 'logger' => double().as_null_object }) }
-  let( :vagrant ) { Beaker::VagrantFusion.new( @hosts, options ) }
-
-  before :each do
-    @hosts = make_hosts()
-  end
+  let( :vagrant ) { described_class.new( hosts, options ) }
+  let( :hosts ) { make_hosts() }
 
   it "uses the vmware_fusion provider for provisioning" do
-    @hosts.each do |host|
+    hosts.each do |host|
       host_prev_name = host['user']
       expect( vagrant ).to receive( :set_ssh_config ).with( host, 'vagrant' ).once
       expect( vagrant ).to receive( :copy_ssh_to_root ).with( host, options ).once
       expect( vagrant ).to receive( :set_ssh_config ).with( host, host_prev_name ).once
     end
-    expect( vagrant ).to receive( :hack_etc_hosts ).with( @hosts, options ).once
+    expect( vagrant ).to receive( :hack_etc_hosts ).with( hosts, options ).once
     expect( vagrant ).to receive( :vagrant_cmd ).with( "up --provider vmware_fusion" ).once
     vagrant.provision
   end
 
-  it "can make a Vagranfile for a set of hosts" do
-    path = vagrant.instance_variable_get( :@vagrant_path )
-    allow( vagrant ).to receive( :randmac ).and_return( "0123456789" )
-
-    vagrant.make_vfile( @hosts )
+  context 'Correct vagrant configuration' do
+    subject do
+      FakeFS do
+        vagrant.make_vfile( hosts, options )
+        File.read(vagrant.instance_variable_get(:@vagrant_file))
+      end
+    end
 
-    vagrantfile = File.read( File.expand_path( File.join( path, "Vagrantfile")))
-    expect( vagrantfile ).to include( %Q{    v.vm.provider :vmware_fusion do |v|\n      v.vmx['memsize'] = '1024'\n    end})
+    it 'has a provider section' do
+      is_expected.to include( %Q{    v.vm.provider :vmware_fusion do |v|\n      v.vmx['memsize'] = '1024'\n    end})
+    end
   end
 end