lab 0.0.3 → 0.0.4

data/lib/lab/driver/vm_driver.rb

@@ -0,0 +1,180 @@
+##
+## $Id$
+##
+
+#
+# 	!!WARNING!! - All drivers are expected to filter input before running
+#	anything based on it. This is particularly important in the case
+#	of the drivers which wrap a command line to provide functionality.  
+#
+
+module Lab
+module Drivers
+class VmDriver
+	
+	attr_accessor :vmid 
+	attr_accessor :location
+	attr_accessor :os
+	attr_accessor :tools
+	attr_accessor :credentials
+	
+	def initialize(config)
+	
+		@vmid = filter_command(config["vmid"].to_s)
+		@location = filter_command(config["location"])
+		@credentials = config["credentials"] || []
+		@tools = filter_input(config["tools"])
+		@os = filter_input(config["os"])
+		@hostname = filter_input(config["hostname"]) || filter_input(config["vmid"].to_s)
+
+		# Currently only implemented for the first set
+		if @credentials.count > 0
+			@vm_user = filter_input(@credentials[0]['user'])
+			@vm_pass = filter_input(@credentials[0]['pass'])
+			@vm_keyfile = filter_input(@credentials[0]['keyfile'])
+		end
+	end
+
+	## This interface must be implemented in a child driver class
+	## #########################################################
+
+	def register
+		raise "Command not Implemented"
+	end
+		
+	def unregister
+		raise "Command not Implemented"
+	end
+
+	def start
+		raise "Command not Implemented"
+	end
+
+	def stop
+		raise "Command not Implemented"
+	end
+
+	def suspend
+		raise "Command not Implemented"
+	end
+
+	def pause
+		raise "Command not Implemented"
+	end
+
+	def resume
+		raise "Command not Implemented"
+	end
+
+	def reset
+		raise "Command not Implemented"
+	end
+
+	def create_snapshot(snapshot)
+		raise "Command not Implemented"
+	end
+
+	def revert_snapshot(snapshot)
+		raise "Command not Implemented"
+	end
+
+	def delete_snapshot(snapshot)
+		raise "Command not Implemented"
+	end
+
+	def run_command(command)	
+		raise "Command not Implemented"
+	end
+	
+	def copy_from(from, to)
+		raise "Command not Implemented"
+	end
+	
+	def copy_to(from, to)
+		raise "Command not Implemented"
+	end
+
+	def check_file_exists(file)
+		raise "Command not Implemented"
+	end
+
+	def create_directory(directory)
+		raise "Command not Implemented"
+	end
+
+	def cleanup
+		raise "Command not Implemented"
+	end
+
+	## End Interface
+	## #########################################################
+
+private
+
+	def scp_to(local,remote)
+		#require 'net/scp'
+		#::Net::SCP.start(@hostname, @vm_user, :password => @vm_pass) do |scp|
+		#	scp.upload!(from,to)
+		#end	
+
+		system_command("scp #{local} #{@vm_user}@#{@hostname}:#{remote}")
+	end
+	
+	def scp_from(local,remote)
+		#require 'net/scp'
+		# download a file from a remote server
+		#::Net::SCP.start(@hostname, @vm_user, :password => @vm_pass) do |scp|
+		#	scp.download!(from,to)
+		#end
+		
+		system_command("scp #{@vm_user}@#{@hostname}:#{remote} #{local}")
+
+	end
+	
+	def ssh_exec(command)
+		
+		::Net::SSH.start(@hostname, @vm_user, :password => @vm_pass) do |ssh|
+			result = ssh.exec!(command)
+		end
+		
+		`scp #{@vm_user}@#{@hostname} from to`
+	end
+
+	def filter_input(string)
+		return "" unless string # nil becomes empty string
+		return unless string.class == String # Allow other types unmodified
+		
+		unless /^[\d\w\s\[\]\{\}\/\\\.\-\"\(\):!]*$/.match string
+			raise "WARNING! Invalid character in: #{string}"
+		end
+
+	string
+	end
+
+	def filter_command(string)
+		return "" unless string # nil becomes empty string
+		return unless string.class == String # Allow other types unmodified		
+		
+		unless /^[\d\w\s\[\]\{\}\/\\\.\-\"\(\)]*$/.match string
+			raise "WARNING! Invalid character in: #{string}"
+		end
+
+	string
+	end
+	
+	# The only reason we don't filter here is because we need
+	# the ability to still run clean (controlled entirely by us)
+	# command lines.
+	def system_command(command)
+		#puts "DEBUG: system command #{command}"
+		system(command)
+	end
+	
+	
+	def remote_system_command(command)
+		system_command("ssh #{@user}@#{@host} \"#{command}\"")
+	end
+end
+
+end
+end

data/lib/lab/driver/workstation_driver.rb

@@ -0,0 +1,188 @@
+require 'vm_driver'
+
+##
+## $Id$
+##
+
+module Lab
+module Drivers
+
+class WorkstationDriver < VmDriver
+
+	def initialize(config)
+		super(config)
+		
+		if !File.exist?(@location)
+			raise ArgumentError,"Couldn't find: #{@location}"
+		end
+	end
+
+	def start
+		system_command("vmrun -T ws start " + "\'#{@location}\' nogui")
+	end
+
+	def stop
+		system_command("vmrun -T ws stop " + "\'#{@location}\' nogui")
+	end
+
+	def suspend
+		system_command("vmrun -T ws suspend " + "\'#{@location}\' nogui")
+	end
+
+	def pause
+		system_command("vmrun -T ws pause " + "\'#{@location}\' nogui")
+	end
+
+	def reset
+		system_command("vmrun -T ws reset " + "\'#{@location}\' nogui")
+	end
+
+	def create_snapshot(snapshot)
+		snapshot = filter_input(snapshot)
+		system_command("vmrun -T ws snapshot " + "\'#{@location}\' \'#{snapshot}\' nogui")
+	end
+
+	def revert_snapshot(snapshot)
+		snapshot = filter_input(snapshot)
+		system_command("vmrun -T ws revertToSnapshot " + "\'#{@location}\' \'#{snapshot}\' nogui")
+	end
+
+	def delete_snapshot(snapshot)
+		snapshot = filter_input(snapshot)
+		system_command("vmrun -T ws deleteSnapshot " + "\'#{@location}\' \'#{snapshot}\' nogui" )
+	end
+
+	def run_command(command)
+
+		script_rand_name = rand(10000)
+
+		if @os == "windows"
+			local_tempfile_path = "/tmp/lab_script_#{script_rand_name}.bat"
+			remote_tempfile_path = "C:\\\\lab_script_#{script_rand_name}.bat"
+			remote_run_command = remote_tempfile_path
+		else
+			local_tempfile_path = "/tmp/lab_script_#{script_rand_name}.sh"
+			remote_tempfile_path = "/tmp/lab_script_#{script_rand_name}.sh"
+			remote_run_command = "/bin/sh #{remote_tempfile_path}"
+		end
+
+		# write out our script locally
+		File.open(local_tempfile_path, 'w') {|f| f.write(command) }
+
+		# we really can't filter command, so we're gonna stick it in a script
+		if @tools
+			# copy our local tempfile to the guest
+			vmrunstr = "vmrun -T ws -gu #{@vm_user} -gp #{@vm_pass} " +
+					"copyFileFromHostToGuest \'#{@location}\' \'#{local_tempfile_path}\'" +
+					" \'#{remote_tempfile_path}\' nogui"
+			system_command(vmrunstr)
+
+			# now run it on the guest
+			vmrunstr = "vmrun -T ws -gu #{@vm_user} -gp #{@vm_pass} " + 
+					"runProgramInGuest \'#{@location}\' -noWait -activeWindow \'#{remote_run_command}\'"
+			system_command(vmrunstr)
+
+			## CLEANUP
+			# delete it on the guest
+			vmrunstr = "vmrun -T ws -gu #{@vm_user} -gp #{@vm_pass} " + 
+					"deleteFileInGuest \'#{@location}\' \'#{remote_tempfile_path}\'"
+			system_command(vmrunstr)
+
+			# delete it locally
+			local_delete_command = "rm #{local_tempfile_path}"
+			system_command(local_delete_command)
+		else
+			# since we can't copy easily w/o tools, let's just run it directly :/
+			if @os == "linux"
+				
+				output_file = "/tmp/lab_command_output_#{rand(1000000)}"
+				
+				scp_to(local_tempfile_path, remote_tempfile_path)
+				ssh_exec(remote_run_command + "> #{output_file}")
+				scp_from(output_file, output_file)
+				
+				ssh_exec("rm #{output_file}")
+				ssh_exec("rm #{remote_tempfile_path}")
+				
+				# Ghettohack!
+				string = File.open(output_file,"r").read
+				`rm #{output_file}`
+				
+			else
+				raise "zomgwtfbbqnotools"
+			end	
+		end
+	return string
+	end
+	
+	def copy_from(from, to)
+		from = filter_input(from)
+		to = filter_input(to)
+		if @tools
+			vmrunstr = "vmrun -T ws -gu \'#{@vm_user}\' -gp \'#{@vm_pass}\' copyFileFromGuestToHost " +
+					"\'#{@location}\' \'#{from}\' \'#{to}\'" 
+		else
+			scp_from(from, to)
+		end
+		system_command(vmrunstr)
+	end
+
+	def copy_to(from, to)
+		from = filter_input(from)
+		to = filter_input(to)
+		if @tools
+			vmrunstr = "vmrun -T ws -gu #{@vm_user} -gp #{@vm_pass} copyFileFromHostToGuest " +
+				"\'#{@location}\' \'#{from}\' \'#{to}\'"
+			system_command(vmrunstr)
+		else
+			scp_to(from, to)
+		end
+	end
+
+	def check_file_exists(file)
+		file = filter_input(file)
+		if @tools
+			vmrunstr = "vmrun -T ws -gu \'#{@vm_user}\' -gp \'#{@vm_pass}\' fileExistsInGuest " +
+				"\'#{@location}\' \'#{file}\' "
+			system_command(vmrunstr)
+		else
+			raise "Unsupported"
+		end
+	end
+
+	def create_directory(directory)
+		directory = filter_input(directory)
+		if @tools
+			vmrunstr = "vmrun -T ws -gu \'#{@vm_user}\' -gp \'#{@vm_pass}\' createDirectoryInGuest " +
+					" \'#{@location}\' \'#{directory}\' "
+			system_command(vmrunstr)
+		else
+			raise "Unsupported"
+		end
+
+		
+	end
+
+	def cleanup
+
+	end
+
+	def running?
+		## Get running Vms
+		running = `vmrun list`
+		running_array = running.split("\n")
+		running_array.shift
+
+		running_array.each do |vmx|
+			if vmx.to_s == @location.to_s
+				return true
+			end
+		end
+
+		return false
+	end
+
+end
+
+end 
+end

data/lib/lab/driver/workstation_vixr_driver.rb

@@ -0,0 +1,126 @@
+require 'vm_driver'
+##
+## $Id$
+##
+
+# This requires rhythmx's vixr driver from https://github.com/rhythmx/vixr 
+# and below that, the VIX api from vmware http://www.vmware.com/support/developer/vix-api/
+
+module Lab
+module Drivers
+
+class WorkstationVixrDriver < VmDriver
+
+	attr_accessor :type
+	attr_accessor :location
+
+	def initialize(vmid, location, os=nil, tools=false, credentials=nil)
+
+		# We have to treat this differently, as it's not in the same tree
+		begin
+			require 'vixr'
+		rescue LoadError
+			puts 	"WARNING: Library pro_vixr not found. To resolve this error, please\n" + 
+				"         install the vixr gem. Latest is available here:\n" +
+				"https://github.com/rhythmx/vixr ."
+			raise "Unable to create vixr driver"
+		end
+		
+		@vmid = filter_command(vmid)
+		@location = filter_command(location)
+
+		if !File.exist?(@location)
+			raise ArgumentError,"Couldn't find: " + location
+		end
+
+		@credentials = credentials
+		@tools = tools	# not used in command lines, no filter
+		@os = os	# not used in command lines, no filter
+
+		# TODO - Currently only implemented for the first set
+		if @credentials.count > 0
+			@vm_user = filter_input(@credentials[0]['user']) || "\'\'"
+			@vm_pass = filter_input(@credentials[0]['pass']) || "\'\'"
+		end
+		
+		host = VixR.connect()
+		vm = host.open_vmx(@location)
+		
+	end
+
+	def start
+		vm.power_on
+	end
+
+	def stop
+		vm.power_off
+	end
+
+	def suspend
+		vm.suspend
+	end
+
+	def pause
+		vm.pause
+	end
+
+	def reset
+		vm.reset
+	end
+
+	def create_snapshot(snapshot)
+		snapshot = filter_input(snapshot)
+		system_command("ssh #{@user}@#{@host} vmrun -T ws snapshot \\\'#{@location}\\\' #{snapshot} nogui")
+	end
+
+	def revert_snapshot(snapshot)
+		snapshot = filter_input(snapshot)
+		system_command("ssh #{@user}@#{@host} vmrun -T ws revertToSnapshot \\\'#{@location}\\\' #{snapshot} nogui")
+	end
+
+	def delete_snapshot(snapshot)
+		snapshot = filter_input(snapshot)
+		system_command("ssh #{@user}@#{@host} vmrun -T ws deleteSnapshot \\\'#{@location}\\\' #{snapshot} nogui" )
+	end
+
+
+	def run_command(command)
+		command = filter_input(command)
+		if vm.login(@vm_user,@vm_pass)
+			vm.run_prog(command)
+		end
+	end
+	
+	def copy_from(from, to)
+		from = filter_input(from)
+		to = filter_input(to)
+		cp_from_host(from,to)
+	end
+
+	def copy_to(from, to)
+		from = filter_input(from)
+		to = filter_input(to)
+		vm.cp_to_guest(from,to)
+	end
+
+	def check_file_exists(file)
+		file = filter_input(file)
+		file_exists?(file)
+	end
+
+	def create_directory(directory)
+		directory = filter_input(directory)
+	end
+
+	def cleanup
+
+	end
+
+	def running?
+		vm.running?
+	end
+
+end
+
+end 
+end