veewee 0.3.0.alpha4 → 0.3.0.alpha5

data/doc/installation.md

@@ -0,0 +1,24 @@
+This needs to be bulked out more, but for now, here is a basic guide to installing Veewee from source.
+
+First, if you are not using RVM, it's recommended that you do so as veewee will install in it's own gemset which keeps veewee and it's dependancies completely separate from your other Ruby gems.
+
+RVM is available here: http://beginrescueend.com/
+
+You can install it as follows:
+
+    $ bash -s stable < <(curl -s https://raw.github.com/wayneeseguin/rvm/master/binscripts/rvm-installer)
+    $ source ~/.bash_profile
+
+Now, install Ruby 1.9.2 using RVM:
+
+    $ rvm install 1.9.2
+
+Ok, now that we have RVM installed, you can now install Veewee.
+
+When you cd into the veewee directory, rvm should automatically read the .rvmrc file and prompt you to verify it - you can do so by pressing Y. This will then create a gemset for veewee.
+
+    $ git clone https://github.com/jedi4ever/veewee.git
+    $ cd veewee
+    $ gem install bundler
+    $ bundle install
+

data/doc/kvm.md

@@ -0,0 +1,2 @@
+Coming Soon
+

data/doc/providers.md

@@ -0,0 +1,23 @@
+# Providers in Veewee
+
+Initially veewee started as provider for virtualbox. From v0.3 Vmware fusion and KVM support are introduced.
+
+## Virtualbox
+
+To interact with virtualbox, veewee executes shell-commands through the 'VboxManage' command. The virtualbox gem library proved to be less stable.
+
+To simulate the typing, veewee uses the 'VBoxManage controlvm 'myubuntu' keyboardputscancode <keycode>'.
+Scancode are injected directly the keyboard buffer with this. And as this buffer is small, we can't type fast.
+This is why you have the delay while veewee types the commands. Speeding it up, will make the keyboard buffer loose keystrokes.
+
+## Vmware fusion
+
+To interact with Vmware fusion, we leverage (a currently patched) version of [Fission gem](https://github.com/thbishop/fission). This takes care of the heavy lifting.
+
+To interact with the screen , veewee enables VNC on the created vmware fusion machines and use the [Ruby-VNC gem](http://code.google.com/p/ruby-vnc/) to send the keystrokes. Here too , sending keystrokes too fast is a problem.
+
+## KVM
+
+To interact  with KVM veewee, uses [libvirt support](http://libvirt.org/ruby/) provided through [Fog gem](http://fog.io) libvirt support
+
+To interact with the screen , veewee enables VNC on the created vmware fusion machines and use the [Ruby-VNC gem](http://code.google.com/p/ruby-vnc/) to send the keystrokes. Here too , sending keystrokes too fast is a problem.

data/doc/requirements.md

@@ -0,0 +1 @@
+Coming Soon

data/doc/running.md

@@ -0,0 +1,83 @@
+# Running veewee
+
+## Calling veewee
+
+### Using veewee cli
+The first way to call veewee is through the 'veewee' cli command:
+
+    $ veewee
+    Tasks:
+      veewee fusion       # Subcommand for Vmware fusion
+      veewee help [TASK]  # Describe available tasks or one specific task
+      veewee kvm          # Subcommand for kvm
+      veewee vbox         # Subcommand for virtualbox
+      veewee version      # Prints the Veewee version information
+
+### Using veewee as a vagrant plugin
+The second way is to use it a vagrant plugin. Veewee registeres itself as a subcommand 'basebox'
+
+    $ vagrant basebox
+    Usage: vagrant basebox <command> [<args>]
+
+    Available subcommands:
+         build
+         define
+         destroy
+         export
+         halt
+         list
+         ostypes
+         ssh
+         templates
+         undefine
+         up
+
+    For help on any individual command run `vagrant basebox COMMAND -h`
+
+## Available commands
+
+The following command are available: change the vbox to fusion or kvm if you want to use a different <provider>
+
+    Tasks:
+      veewee vbox build [BOX_NAME]             # Build box
+      veewee vbox define [BOXNAME] [TEMPLATE]  # Define a new basebox starting fr...
+      veewee vbox destroy [BOXNAME]            # Destroys the basebox that was built
+      veewee vbox halt [BOXNAME]               # Activates a shutdown on the basebox
+      veewee vbox help [COMMAND]               # Describe subcommands or one spec...
+      veewee vbox list                         # Lists all defined boxes
+      veewee vbox ostypes                      # List the available Operating Sys...
+      veewee vbox ssh [BOXNAME] [COMMAND]      # Shows SSH information
+      veewee vbox templates                    # List the currently available tem...
+      veewee vbox undefine [BOXNAME]           # Removes the definition of a base...
+      veewee vbox up [BOXNAME]                 # Starts a Box
+      veewee vbox validate [NAME]              # Validates a box against vagrant ...
+
+## Non-Vagrant usage
+A typical cycle would be:
+
+  $ veewee vbox define 'mybuntu' 'ubuntu-10.10-amd64'
+  $ veewee vbox build 'myubuntu'
+  $ veewee vbox ssh 'myubuntu'
+  $ veewee vbox halt 'myubuntu'
+  $ veewee vbox up 'myubuntu'
+  $ veewee vbox export 'myubuntu'
+
+## Vagrant usage
+
+A typical cycle would be:
+
+    $ vagrant basebox define 'myubuntu' 'ubuntu-10.10-amd64'
+    $ vagrant basebox  build 'myubuntu'
+    $ vagrant basebox  export 'myubuntu'
+
+    $ vagrant basebox add 'myubuntu' 'myubuntu.box'
+    $ vagrant init 'mybuntu'
+    $ vagrant up
+    $ vagrant ssh
+
+## Exporting a vm
+The export format depends on the provider:
+
+- fusion : exports to an 'ova' file
+- kvm : export to a raw '.img' file
+- vbox: exports to a '.box' format (for use in vagrant)

data/doc/template.md

@@ -0,0 +1,102 @@
+# Veewee Template
+
+## Listing available templates
+
+Veewee provides templates for a lot of different os-es.
+
+To see all the templates provided:
+
+    veewee vbox templates
+
+    The following templates are available:
+    veewee vbox define '<box_name>' 'archlinux-i386'
+    veewee vbox define '<box_name>' 'archlinux-i386-netboot'
+    veewee vbox define '<box_name>' 'archlinux-x86_64'
+    veewee vbox define '<box_name>' 'archlinux-x86_64-netboot'
+    veewee vbox define '<box_name>' 'CentOS-4.8-i386'
+    veewee vbox define '<box_name>' 'CentOS-5.5-x86_64-netboot'
+    veewee vbox define '<box_name>' 'CentOS-5.6-i386'
+    veewee vbox define '<box_name>' 'CentOS-5.6-i386-netboot'
+    veewee vbox define '<box_name>' 'CentOS-5.6-x86_64-netboot'
+    veewee vbox define '<box_name>' 'CentOS-5.7-i386-netboot'
+    veewee vbox define '<box_name>' 'CentOS-5.7-x86_64-netboot'
+    veewee vbox define '<box_name>' 'CentOS-6.0-i386'
+    veewee vbox define '<box_name>' 'CentOS-6.0-i386-netboot'
+    veewee vbox define '<box_name>' 'CentOS-6.0-x86_64'
+    veewee vbox define '<box_name>' 'CentOS-6.0-x86_64-minimal'
+    veewee vbox define '<box_name>' 'CentOS-6.0-x86_64-netboot'
+    veewee vbox define '<box_name>' 'CentOS-6.1-x86_64-minimal'
+    veewee vbox define '<box_name>' 'CentOS-6.2-x86_64-minimal'
+    veewee vbox define '<box_name>' 'Debian-5.0.8-amd64-netboot'
+    veewee vbox define '<box_name>' 'Debian-5.0.8-i386-netboot'
+    veewee vbox define '<box_name>' 'Debian-6.0.3-amd64-netboot'
+    veewee vbox define '<box_name>' 'Debian-6.0.3-i386-netboot'
+    veewee vbox define '<box_name>' 'Fedora-14-amd64'
+    veewee vbox define '<box_name>' 'Fedora-14-amd64-netboot'
+    veewee vbox define '<box_name>' 'Fedora-14-i386'
+    veewee vbox define '<box_name>' 'Fedora-14-i386-netboot'
+    veewee vbox define '<box_name>' 'Fedora-15-i386'
+    veewee vbox define '<box_name>' 'Fedora-15-i386-netboot'
+    veewee vbox define '<box_name>' 'Fedora-15-x86_64'
+    veewee vbox define '<box_name>' 'Fedora-15-x86_64-netboot'
+    veewee vbox define '<box_name>' 'Fedora-16-i386'
+    veewee vbox define '<box_name>' 'Fedora-16-x86_64'
+    veewee vbox define '<box_name>' 'freebsd-8.2-experimental'
+    veewee vbox define '<box_name>' 'freebsd-8.2-pcbsd-i386'
+    veewee vbox define '<box_name>' 'freebsd-8.2-pcbsd-i386-netboot'
+    veewee vbox define '<box_name>' 'funtoo-latest-generic_64-stable'
+    veewee vbox define '<box_name>' 'gentoo-latest-i386-experimental'
+    veewee vbox define '<box_name>' 'gentoo-latest-x86_64-experimental'
+    veewee vbox define '<box_name>' 'openbsd50_amd64'
+    veewee vbox define '<box_name>' 'openbsd50_i386'
+    veewee vbox define '<box_name>' 'openindiana-148-ai-x86'
+    veewee vbox define '<box_name>' 'openSUSE-11.4-DVD-i586'
+    veewee vbox define '<box_name>' 'openSUSE-11.4-DVD-x86_64'
+    veewee vbox define '<box_name>' 'opensuse-11.4-i386-experimental'
+    veewee vbox define '<box_name>' 'openSUSE-11.4-NET-i586'
+    veewee vbox define '<box_name>' 'openSUSE-11.4-NET-x86_64'
+    veewee vbox define '<box_name>' 'openSUSE-12.1-DVD+NET-i586'
+    veewee vbox define '<box_name>' 'openSUSE-12.1-DVD+NET-x86_64'
+    veewee vbox define '<box_name>' 'scientificlinux-6.1-i386-netboot'
+    veewee vbox define '<box_name>' 'scientificlinux-6.1-x86_64-netboot'
+    veewee vbox define '<box_name>' 'SLES-11-SP1-DVD-i586-GM'
+    veewee vbox define '<box_name>' 'SLES-11-SP1-DVD-x86_64-GM'
+    veewee vbox define '<box_name>' 'solaris-11-express-i386'
+    veewee vbox define '<box_name>' 'Sysrescuecd-2.0.0-experimental'
+    veewee vbox define '<box_name>' 'ubuntu-10.04.2-amd64-netboot'
+    veewee vbox define '<box_name>' 'ubuntu-10.04.2-server-i386-netboot'
+    veewee vbox define '<box_name>' 'ubuntu-10.04.3-server-amd64'
+    veewee vbox define '<box_name>' 'ubuntu-10.04.3-server-amd64-alt'
+    veewee vbox define '<box_name>' 'ubuntu-10.04.3-server-i386'
+    veewee vbox define '<box_name>' 'ubuntu-10.10-server-amd64'
+    veewee vbox define '<box_name>' 'ubuntu-10.10-server-amd64-netboot'
+    veewee vbox define '<box_name>' 'ubuntu-10.10-server-i386'
+    veewee vbox define '<box_name>' 'ubuntu-10.10-server-i386-netboot'
+    veewee vbox define '<box_name>' 'ubuntu-11.04-server-amd64'
+    veewee vbox define '<box_name>' 'ubuntu-11.04-server-i386'
+    veewee vbox define '<box_name>' 'ubuntu-11.10-server-amd64'
+    veewee vbox define '<box_name>' 'ubuntu-11.10-server-amd64-ishaya'
+    veewee vbox define '<box_name>' 'ubuntu-11.10-server-amd64-ruby192'
+    veewee vbox define '<box_name>' 'ubuntu-11.10-server-i386'
+    veewee vbox define '<box_name>' 'ubuntu-8.04.4-server-amd64'
+    veewee vbox define '<box_name>' 'ubuntu-8.04.4-server-i386'
+    veewee vbox define '<box_name>' 'windows-2008R1-serverstandard-amd64'
+    veewee vbox define '<box_name>' 'windows-2008R2-amd64'
+    veewee vbox define '<box_name>' 'windows-2008R2-serverstandard-amd64'
+    veewee vbox define '<box_name>' 'windows-7-enterprise-amd64'
+    veewee vbox define '<box_name>' 'windows-7-enterprise-i386'
+    veewee vbox define '<box_name>' 'windows-7-premium-amd64'
+    veewee vbox define '<box_name>' 'windows-7-professional-amd64'
+    veewee vbox define '<box_name>' 'windows-7-ultimate-amd64'
+    veewee vbox define '<box_name>' 'windows-7sp1-ultimate-amd64'
+    veewee vbox define '<box_name>' 'windows-8-preview-dev-amd64'
+
+
+## Structure
+Templates have the same structure as a <definition> but are provided by veewee as templates for definitions.
+
+## Extending templates
+
+- fork veewee
+- add a new template under the templates directory
+- send me a pull request

data/doc/vagrant.md

@@ -0,0 +1,119 @@
+## Define a new box
+Let's define a  Ubuntu 10.10 server i386 basebox called myunbuntubox
+this is essentially making a copy based on the  templates provided above.
+
+    $ veewee vbox basebox define 'myubuntubox' 'ubuntu-10.10-server-i386'
+    The basebox 'myubuntubox' has been succesfully created from the template ''ubuntu-10.10-server-i386'
+    You can now edit the definition files stored in definitions/myubuntubox
+    or build the box with:
+    veewee vbox basebox build 'myubuntubox'
+
+-> This copies over the templates/ubuntu-10.10-server-i386 to definition/myubuntubox
+
+    $ ls definitions/myubuntubox
+    definition.rb	postinstall.sh	postinstall2.sh	preseed.cfg
+
+## Optionally modify the definition.rb , postinstall.sh or preseed.cfg
+
+    Veewee::Definition.declare( {
+    :cpu_count => '1', :memory_size=> '256', 
+    :disk_size => '10140', :disk_format => 'VDI',
+    :os_type_id => 'Ubuntu',
+    :iso_file => "ubuntu-10.10-server-i386.iso", 
+    :iso_src => "http://releases.ubuntu.com/maverick/ubuntu-10.10-server-i386.iso",
+    :iso_md5 => "ce1cee108de737d7492e37069eed538e",
+    :iso_download_timeout => "1000",
+    :boot_wait => "10",
+    :boot_cmd_sequence => [ 
+        '<Esc><Esc><Enter>',
+        '/install/vmlinuz noapic preseed/url=http://%IP%:%PORT%/preseed.cfg ',
+        'debian-installer=en_US auto locale=en_US kbd-chooser/method=us ',
+        'hostname=%NAME% ',
+        'fb=false debconf/frontend=noninteractive ',
+        'console-setup/ask_detect=false console-setup/modelcode=pc105 console-setup/layoutcode=us ',
+        'initrd=/install/initrd.gz -- <Enter>' 
+      ],
+    :kickstart_port => "7122", :kickstart_timeout => "10000",:kickstart_file => "preseed.cfg",
+    :ssh_login_timeout => "10000",:ssh_user => "vagrant", :ssh_password => "vagrant",:ssh_key => "",
+    :ssh_host_port => "2222", :ssh_guest_port => "22",
+    :sudo_cmd => "echo '%p'|sudo -S sh '%f'",
+    :shutdown_cmd => "shutdown -H",
+    :postinstall_files => [ "postinstall.sh"],:postinstall_timeout => "10000"
+     }
+    )
+
+If you need to change values in the templates, be sure to run the rake undefine, the rake define again to copy the changes across.
+
+## Getting the cdrom file in place
+Put your isofile inside the 'currentdir'/iso directory or if you don't run
+
+    $ veewee vbox basebox build 'myubuntubox'
+
+- the build assumes your iso files are in 'currentdir'/iso
+- if it can not find it will suggest to download the iso for you
+- use '--force' to overwrite an existing install
+
+## Build the new box:
+
+    $ veewee vbox basebox build 'myubuntubox'
+
+- This will create a machine + disk according to the definition.rb
+- Note: :os_type_id = The internal Name Virtualbox uses for that Distribution
+- Mount the ISO File :iso_file
+- Boot up the machine and wait for :boot_time
+- Send the keystrokes in :boot_cmd_sequence
+- Startup a webserver on :kickstart_port to wait for a request for the :kickstart_file (don't navigate to the file in your browser or the server will stop and the installer will not be able to find your preseed)
+- Wait for ssh login to work with :ssh_user , :ssh_password
+- Sudo execute the :postinstall_files
+
+## Validate the vm 
+
+    $ veewee vbox validate 'myubuntubox'
+
+this will run some cucumber test against the box to see if it has the necessary bits and pieces for vagrant to work
+
+## Export the vm to a .box file
+
+    $ vagrant basebox export 'myubuntubox'
+
+this is actually calling - vagrant package --base 'myubuntubox' --output 'boxes/myubuntubox.box'
+
+this will result in a myubuntubox.box
+
+## Add the box as one of your boxes
+To import it into vagrant type:
+
+    $ vagrant box add 'myubuntubox' 'myubuntubox.box'
+
+## Use it in vagrant
+
+To use it:
+
+    $ vagrant init 'myubuntubox'
+    $ vagrant up
+    $ vagrant ssh
+
+## How to add a new OS/installation (needs some love)
+
+I suggest the easiest way is to get an account on github and fork of the veewee repository
+
+    $ git clone https://github.com/*your account*/veewee.git
+    $ cd veewee
+    $ gem install bundler
+    $ bundle install
+
+If you don't use rvm, be sure to execute vagrant through bundle exec
+
+    $ alias vagrant="bundle exec vagrant"
+
+Start of an existing one
+
+    $ veewee vbox basebox define 'mynewos' 'ubuntu...'
+
+- Do changes in the currentdir/definitions/mynewos
+- When it builds ok, move the definition/mynewos to a sensible directory under templates
+- commit the changes (git commit -a)
+- push the changes to github (git push)
+- go to the github gui and issue a pull request for it
+
+## If you have a setup working, share your 'definition' with me. That would be fun! 

data/doc/vbox.md

@@ -0,0 +1,2 @@
+Coming Soon
+

data/lib/net/vnc/vnc.rb

@@ -73,7 +73,7 @@ module Net
     attr_reader :server, :display, :options, :socket, :pointer
 
     def initialize display=':0', options={}
-      @server = 'localhost'
+      @server = '127.0.0.1'
       if display =~ /^(.*)(:\d+)$/
         @server, display = $1, $2
       end

data/lib/python/parallels_sdk_check.py

@@ -0,0 +1,19 @@
+import sys
+import prlsdkapi
+
+prlsdk = prlsdkapi.prlsdk
+consts = prlsdkapi.prlsdk.consts
+
+# Initialize the Parallels API Library
+prlsdk.InitializeSDK(consts.PAM_DESKTOP_MAC)
+
+# Obtain a server object identifying the Parallels Service.
+server = prlsdkapi.Server()
+
+# Log in. (local as we do Parallels Desktop
+login_job=server.login_local()
+login_job.wait()
+
+# Logoff and deinitialize the library
+server.logoff()
+prlsdkapi.deinit_sdk

data/lib/python/parallels_send_key.py

@@ -0,0 +1,73 @@
+import sys
+import prlsdkapi
+
+if len(sys.argv) != 4:
+    print "Usage: parallels_send_keycode '<VM_NAME>' '<keyname>' '<press|release>'"
+    exit()
+
+# Parse arguments
+vm_name=sys.argv[1]
+# Keycode to use
+keyname=sys.argv[2]
+# Release or press
+state=sys.argv[3]
+
+print "Sending keyname '%(keyname)s' to VM '%(vm_name)s'" % {"keyname": keyname, "vm_name":vm_name}
+
+prlsdk = prlsdkapi.prlsdk
+consts = prlsdkapi.prlsdk.consts
+
+# Initialize the Parallels API Library
+prlsdk.InitializeSDK(consts.PAM_DESKTOP_MAC)
+
+# Obtain a server object identifying the Parallels Service.
+server = prlsdkapi.Server()
+
+# Log in. (local as we do Parallels Desktop
+login_job=server.login_local()
+login_job.wait()
+
+# Get a list of virtual machines.
+# Find the specified virtual machine and
+# obtain an object identifying it.
+vm_list = server.get_vm_list()
+result= vm_list.wait()
+
+print prlsdkapi.prlsdk.consts.ScanCodesList
+
+# Look for the VM with the name speficied on the CLI
+found = False
+for i in range(result.get_params_count()):
+  VM = result.get_param_by_index(i)
+  print VM.get_name()
+  if VM.get_name() == vm_name:
+    found = True
+    break
+
+press = consts.PKE_PRESS
+release = consts.PKE_RELEASE
+
+# Access the Remote Desktop Access session
+vm_io = prlsdkapi.VmIO()
+try:
+  vm_io.connect_to_vm(VM).wait()
+except prlsdkapi.PrlSDKError, e:
+  print "Error: %s" % e
+  exit()
+
+scan_code = consts.ScanCodesList[keyname]
+
+if state == 'press':
+  vm_io.send_key_event(VM,scan_code,press)
+elif  state == 'release':
+  vm_io.send_key_event(VM,scan_code,release)
+else:
+  print "invalid state: %s" % state
+  exit()
+
+# End the Remote Deskop Access session
+vm_io.disconnect_from_vm(VM)
+
+# Logoff and deinitialize the library
+server.logoff()
+prlsdkapi.deinit_sdk