require 'fileutils' require 'systemu' require 'net/ssh' require 'net/scp' require 'rspec-system/node_set/base' module RSpecSystem # A NodeSet implementation for Vagrant. class NodeSet::Vagrant < RSpecSystem::NodeSet::Base include RSpecSystem::Log include RSpecSystem::Util ENV_TYPE = 'vagrant' VALID_VM_OPTIONS = ['ip'] # Creates a new instance of RSpecSystem::NodeSet::Vagrant # # @param setname [String] name of the set to instantiate # @param config [Hash] nodeset configuration hash # @param custom_prefabs_path [String] path of custom prefabs yaml file # @param options [Hash] options Hash def initialize(setname, config, custom_prefabs_path, options) super @vagrant_path = File.expand_path(File.join(RSpec.configuration.system_tmp, 'vagrant_projects', setname)) RSpec.configuration.rspec_storage[:nodes] ||= {} end # Setup the NodeSet by starting all nodes. # # @return [void] def setup create_vagrantfile() teardown() output << bold(color("localhost$", :green)) << " vagrant up\n" vagrant("up") # Establish ssh connectivity nodes.each do |k,v| output << bold(color("localhost$", :green)) << " ssh #{k}\n" chan = Net::SSH.start(k, 'vagrant', :config => ssh_config) RSpec.configuration.rspec_storage[:nodes][k] = { :ssh => chan, } end nil end # Shutdown the NodeSet by shutting down or pausing all nodes. # # @return [void] def teardown nodes.each do |k,v| storage = RSpec.configuration.rspec_storage[:nodes][k] next if storage.nil? ssh = storage[:ssh] ssh.close unless ssh.closed? end if destroy output << bold(color("localhost$", :green)) << " vagrant destroy --force\n" vagrant("destroy --force") end nil end # Run a command on a host in the NodeSet. # # @param opts [Hash] options # @return [Hash] a hash containing :exit_code, :stdout and :stderr def run(opts) dest = opts[:n].name cmd = opts[:c] ssh = RSpec.configuration.rspec_storage[:nodes][dest][:ssh] ssh_exec!(ssh, "cd /tmp && sudo sh -c #{shellescape(cmd)}") end # Transfer files to a host in the NodeSet. # # @param opts [Hash] options # @return [Boolean] returns true if command succeeded, false otherwise # @todo This is damn ugly, because we ssh in as vagrant, we copy to a temp # path then move it later. Its slow and brittle and we need a better # solution. Its also very Linux-centrix in its use of temp dirs. def rcp(opts) dest = opts[:d].name source = opts[:sp] dest_path = opts[:dp] # Grab a remote path for temp transfer tmpdest = tmppath # Do the copy and print out results for debugging cmd = "scp -r '#{source}' #{dest}:#{tmpdest}" output << bold(color("localhost$", :green)) << " #{cmd}\n" ssh = RSpec.configuration.rspec_storage[:nodes][dest][:ssh] ssh.scp.upload! source.to_s, tmpdest.to_s, :recursive => true # Now we move the file into their final destination result = shell(:n => opts[:d], :c => "mv #{tmpdest} #{dest_path}") if result[:exit_code] == 0 return true else return false end end # Create the Vagrantfile for the NodeSet. # # @api private def create_vagrantfile output << bold(color("localhost$", :green)) << " cd #{@vagrant_path}\n" FileUtils.mkdir_p(@vagrant_path) File.open(File.expand_path(File.join(@vagrant_path, "Vagrantfile")), 'w') do |f| f.write('Vagrant.configure("2") do |c|' + "\n") nodes.each do |k,v| ps = v.provider_specifics['vagrant'] default_options = { 'mac' => randmac } options = default_options.merge(v.options || {}) node_config = " c.vm.define '#{k}' do |v|\n" node_config << " v.vm.hostname = '#{k}'\n" node_config << " v.vm.box = '#{ps['box']}'\n" node_config << " v.vm.box_url = '#{ps['box_url']}'\n" unless ps['box_url'].nil? node_config << customize_vm(k,options) node_config << " v.vm.provider 'virtualbox' do |vbox|\n" node_config << customize_virtualbox(k,options) node_config << " end\n" node_config << " end\n" f.write(node_config) end f.write("end\n") end nil end # Adds virtualbox customization to the Vagrantfile # # @api private # @param name [String] name of the node # @param options [Hash] customization options # @return [String] a series of vbox.customize lines def customize_virtualbox(name,options) custom_config = "" options.each_pair do |key,value| next if VALID_VM_OPTIONS.include?(key) case key when 'cpus','memory' custom_config << " vbox.customize ['modifyvm', :id, '--#{key}','#{value}']\n" when 'mac' custom_config << " vbox.customize ['modifyvm', :id, '--macaddress1','#{value}']\n" else log.warn("Skipped invalid custom option for node #{name}: #{key}=#{value}") end end custom_config end # Adds VM customization to the Vagrantfile # # @api private # @param name [String] name of the node # @param options [Hash] customization options # @return [String] a series of v.vm lines def customize_vm(name,options) vm_config = "" options.each_pair do |key,value| case key when 'ip' vm_config << " v.vm.network :private_network, :ip => '#{value}'\n" else next end end vm_config end # Here we get vagrant to drop the ssh_config its using so we can monopolize # it for transfers and custom stuff. We drop it into a single file, and # since its indexed based on our own node names its quite ideal. # # @api private # @return [String] path to ssh_config file def ssh_config ssh_config_path = File.expand_path(File.join(@vagrant_path, "ssh_config")) begin File.unlink(ssh_config_path) rescue Errno::ENOENT end self.nodes.each do |k,v| Dir.chdir(@vagrant_path) do result = systemu("vagrant ssh-config #{k} >> #{ssh_config_path}") end end ssh_config_path end # Execute vagrant command in vagrant_path # # @api private # @param args [String] args to vagrant # @todo This seems a little too specific these days, might want to # generalize. It doesn't use systemu, because we want to see the output # immediately, but still - maybe we can make systemu do that. def vagrant(args) Dir.chdir(@vagrant_path) do system("vagrant #{args}") end nil end end end