Class: Beaker::Vagrant

Inherits:
Hypervisor show all
Defined in:
lib/beaker/hypervisor/vagrant.rb

Constant Summary

Constants inherited from Hypervisor

Hypervisor::CHARMAP

Constants included from HostPrebuiltSteps

HostPrebuiltSteps::APT_CFG, HostPrebuiltSteps::CUMULUS_PACKAGES, HostPrebuiltSteps::DEBIAN_PACKAGES, HostPrebuiltSteps::ETC_HOSTS_PATH, HostPrebuiltSteps::ETC_HOSTS_PATH_SOLARIS, HostPrebuiltSteps::FREEBSD_PACKAGES, HostPrebuiltSteps::IPS_PKG_REPO, HostPrebuiltSteps::NTPSERVER, HostPrebuiltSteps::OPENBSD_PACKAGES, HostPrebuiltSteps::PSWINDOWS_PACKAGES, HostPrebuiltSteps::ROOT_KEYS_SCRIPT, HostPrebuiltSteps::ROOT_KEYS_SYNC_CMD, HostPrebuiltSteps::ROOT_KEYS_SYNC_CMD_AIX, HostPrebuiltSteps::SLEEPWAIT, HostPrebuiltSteps::SLES10_PACKAGES, HostPrebuiltSteps::SLES_PACKAGES, HostPrebuiltSteps::SOLARIS10_PACKAGES, HostPrebuiltSteps::TRIES, HostPrebuiltSteps::UNIX_PACKAGES, HostPrebuiltSteps::WINDOWS_PACKAGES

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from Hypervisor

#configure, create, #generate_host_name, #proxy_package_manager, #validate

Methods included from HostPrebuiltSteps

#add_el_extras, #additive_hash_merge, #apt_get_update, #check_and_install_packages_if_needed, #construct_env, #copy_file_to_remote, #copy_ssh_to_root, #disable_iptables, #disable_se_linux, #disable_updates, #enable_root_login, #epel_info_for, #get_domain_name, #get_ip, #hack_etc_hosts, #package_proxy, #proxy_config, #set_env, #set_etc_hosts, #sync_root_keys, #timesync, #validate_host

Methods included from DSL::Patterns

#block_on

Constructor Details

#initialize(vagrant_hosts, options) ⇒ Vagrant

Returns a new instance of Vagrant.



146
147
148
149
150
151
152
153
154
155
156
 
# File 'lib/beaker/hypervisor/vagrant.rb', line 146

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', File.basename(options[:hosts_file])))
  FileUtils.mkdir_p(@vagrant_path)
  @vagrant_file = File.expand_path(File.join(@vagrant_path, "Vagrantfile"))
  @vagrant_env = { "RUBYLIB" => "" }
end

Class Method Details

.provider_vfile_section(host, options) ⇒ Object 



103
104
105
106
 
# File 'lib/beaker/hypervisor/vagrant.rb', line 103

def self.provider_vfile_section host, options
  # Backwards compatibility; default to virtualbox
  Beaker::VagrantVirtualbox.provider_vfile_section(host, options)
end

Instance Method Details

#cleanup ⇒ Object 



196
197
198
199
200
201
202
203
204
 
# File 'lib/beaker/hypervisor/vagrant.rb', line 196

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)
end

#get_ip_from_vagrant_file(hostname) ⇒ Object 



129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
 
# File 'lib/beaker/hypervisor/vagrant.rb', line 129

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
      raise("Unable to determine ip for vagrant box #{hostname}")
    end
  else
    raise("No vagrant file found (should be located at #{@vagrant_file})")
  end
  ip
end

#make_vfile(hosts, options = {}) ⇒ Object 



21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
 
# File 'lib/beaker/hypervisor/vagrant.rb', line 21

def make_vfile hosts, options = {}
  #HACK HACK HACK - add checks here to ensure that we have box + box_url
  #generate the VagrantFile
  v_file = "Vagrant.configure(\"2\") do |c|\n"
  v_file << "  c.ssh.forward_agent = true\n" if options[:forward_ssh_agent] == true
  v_file << "  c.ssh.insert_key = false\n"
  hosts.each do |host|
    host['ip'] ||= randip #use the existing ip, otherwise default to a random ip
    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"
    v_file << "    v.vm.box_url = '#{host['box_url']}'\n" unless host['box_url'].nil?
    v_file << "    v.vm.box_version = '#{host['box_version']}'\n" unless host['box_version'].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 << "    v.vm.network :private_network, ip: \"#{host['ip'].to_s}\", :netmask => \"#{host['netmask'] ||= "255.255.0.0"}\", :mac => \"#{randmac}\"\n"

    unless host['mount_folders'].nil? 
      host['mount_folders'].each do |name, folder|
        v_file << "    v.vm.synced_folder '#{folder[:from]}', '#{folder[:to]}', create: true\n"
      end
    end

    unless host['forwarded_ports'].nil?
      host['forwarded_ports'].each do |_name, port|
        fwd = "    v.vm.network :forwarded_port,"
        fwd << " protocol: '#{port[:protocol]}'," unless port[:protocol].nil?
        fwd << " guest_ip: '#{port[:to_ip]}'," unless port[:to_ip].nil?
        fwd << " guest: #{port[:to]},"
        fwd << " host_ip: '#{port[:from_ip]}'," unless port[:from_ip].nil?
        fwd << " host: #{port[:from]}"
        fwd << "\n"

        v_file << fwd
      end
    end

    if /windows/i.match(host['platform'])
      #due to a regression bug in versions of vagrant 1.6.2, 1.6.3, 1.6.4, >= 1.7.3 ssh fails to forward 
      #automatically (note <=1.6.1, 1.6.5, 1.7.0 - 1.7.2 are uneffected)
      #Explicitly setting SSH port forwarding due to this bug
      v_file << "    v.vm.network :forwarded_port, guest: 22, host: 2222, id: 'ssh', auto_correct: true\n"
      v_file << "    v.vm.network :forwarded_port, guest: 3389, host: 3389, id: 'rdp', auto_correct: true\n"
      v_file << "    v.vm.network :forwarded_port, guest: 5985, host: 5985, id: 'winrm', auto_correct: true\n"
      v_file << "    v.vm.guest = :windows\n"
    end

    if /osx/i.match(host['platform'])
      v_file << "    v.vm.network 'private_network', ip: '10.0.1.10'\n"
      v_file << "    v.vm.synced_folder '.', '/vagrant', :nfs => true\n"
    end

    if /freebsd/i.match(host['platform'])
      v_file << "    v.ssh.shell = 'sh'\n"
      v_file << "    v.vm.guest = :freebsd\n"

      # FreeBSD NFS has a character restriction of 88 characters
      # So you can enable it but if your module has a long name it probably won't work...
      # So to keep things simple let's rsync by default!
      #
      # Further reading if interested:
      # http://www.secnetix.de/olli/FreeBSD/mnamelen.hawk
      # https://bugs.freebsd.org/bugzilla/show_bug.cgi?id=167105
      #
      if host['vagrant_freebsd_nfs'].nil?
        v_file << "    v.vm.synced_folder '.', '/vagrant', type: 'rsync'\n"
      else
        v_file << "    v.vm.synced_folder '.', '/vagrant', :nfs => true\n"
      end
    end

    v_file << self.class.provider_vfile_section(host, options)

    v_file << "  end\n"
    @logger.debug "created Vagrantfile for VagrantHost #{host.name}"
  end
  v_file << "end\n"
  File.open(@vagrant_file, 'w') do |f|
    f.write(v_file)
  end
end

#provision(provider = nil) ⇒ Object 



158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
 
# File 'lib/beaker/hypervisor/vagrant.rb', line 158

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
    vagrant_cmd("destroy --force") if File.file?(@vagrant_file)

    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|
    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
     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

#rand_chunk ⇒ Object 



13
14
15
 
# File 'lib/beaker/hypervisor/vagrant.rb', line 13

def rand_chunk
  (2 + rand(252)).to_s #don't want a 0, 1, or a 255
end

#randip ⇒ Object 



17
18
19
 
# File 'lib/beaker/hypervisor/vagrant.rb', line 17

def randip
  "10.255.#{rand_chunk}.#{rand_chunk}"
end

#randmac ⇒ String

Return a random mac address

Returns:

  • (String) —

    a random mac address



9
10
11
 
# File 'lib/beaker/hypervisor/vagrant.rb', line 9

def randmac
  "080027" + (1..3).map{"%0.2X"%rand(256)}.join
end

#set_ssh_config(host, user) ⇒ Object 



108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
 
# File 'lib/beaker/hypervisor/vagrant.rb', line 108

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}")
    f.write(ssh_config)
    f.rewind
    host['ssh'] = {:config => f.path()}
    host['user'] = user
    @temp_files << f
end

#vagrant_cmd(args) ⇒ Object 



206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
 
# File 'lib/beaker/hypervisor/vagrant.rb', line 206

def vagrant_cmd(args)
  Dir.chdir(@vagrant_path) do
    exit_status = 1
    Open3.popen3(@vagrant_env, "vagrant #{args}") {|stdin, stdout, stderr, wait_thr|
      while line = stdout.gets
        @logger.info(line)
      end
      if not wait_thr.value.success?
        raise "Failed to exec 'vagrant #{args}'. Error was #{stderr.read}"
      end
      exit_status = wait_thr.value
    }
    if exit_status != 0
      raise "Failed to execute vagrant_cmd ( #{args} ). Error was #{stderr.read}"
    end
  end
end