veewee 0.0.2

data/.gitignore

@@ -0,0 +1,7 @@
+.DS_Store
+gems/*
+iso/*
+tmp/*
+definitions/*
+boxes/*
+pkg/*

data/.rvmrc

@@ -0,0 +1,2 @@
+rvm use ruby-1.9.2
+rvm gemset use veewee

data/Gemfile

@@ -0,0 +1,5 @@
+source "http://rubygems.org"
+
+gem "veewee", :path => "."
+
+#gem "vagrant", :git => "git://github.com/mitchellh/vagrant.git"

data/Gemfile.lock

@@ -0,0 +1,53 @@
+PATH
+  remote: .
+  specs:
+    veewee (0.0.2)
+      highline (~> 1.6.1)
+      net-ssh (~> 2.1.0)
+      popen4 (~> 0.1.2)
+      progressbar
+      thor (~> 0.14.6)
+      vagrant (~> 0.7.0)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    Platform (0.4.0)
+    abstract (1.0.0)
+    archive-tar-minitar (0.5.2)
+    erubis (2.6.6)
+      abstract (>= 1.0.0)
+    ffi (0.6.3)
+      rake (>= 0.8.7)
+    highline (1.6.1)
+    i18n (0.5.0)
+    json (1.4.6)
+    mario (0.0.6)
+    net-scp (1.0.4)
+      net-ssh (>= 1.99.1)
+    net-ssh (2.1.0)
+    open4 (1.0.1)
+    popen4 (0.1.2)
+      Platform (>= 0.4.0)
+      open4 (>= 0.4.0)
+    progressbar (0.9.0)
+    rake (0.8.7)
+    thor (0.14.6)
+    vagrant (0.7.1)
+      archive-tar-minitar (= 0.5.2)
+      erubis (~> 2.6.6)
+      i18n (~> 0.5.0)
+      json (~> 1.4.6)
+      mario (~> 0.0.6)
+      net-scp (~> 1.0.4)
+      net-ssh (~> 2.1.0)
+      thor (~> 0.14.6)
+      virtualbox (~> 0.8.3)
+    virtualbox (0.8.3)
+      ffi (~> 0.6.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  veewee!

data/README.md

@@ -0,0 +1,124 @@
+**VeeWee:** the tool to easily build vagrant base boxes
+Vagrant is a great tool to test new things or changes in a virtual machine(Virtualbox) using either chef or puppet.
+The first step is to download an existing 'base box'. I believe this scares a lot of people as they don't know who or how this box was build. Therefore lots of people end up first building their own base box to use with vagrant.
+
+Veewee tries to automate this and to share the knowledge and sources you need to create a basebox. Instead of creating custom ISO's from your favorite distribution, it leverages the 'keyboardputscancode' command of Virtualbox so send the actual 'boot prompt' keysequence to boot an existing iso.
+
+Before we can actually build the boxes, we need to take care of the minimal things to install:
+- Have Virtualbox 4.x installed -> download it from http://download.virtualbox.org/virtualbox/
+
+
+ALPHA CODE: -> you're on your own....
+
+## Installation: 
+__from source__
+$ git clone https://github.com/jedi4ever/veewee.git
+$ cd veewee
+$ gem install bundler
+$ bundle install
+
+__as a gem__
+$ gem install veewee
+
+
+## List all templates
+$ vagrant basebox templates
+
+## Define a new box (ex. Ubuntu 10.10 server i386)
+
+this is essentially making a copy based on the  templates provided above.
+
+$ vagrant basebox define 'myubuntubox' 'ubuntu-10.10-server-i386'
+template successfully copied
+
+-> 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
+
+<pre>
+Veewee::Session.declare( {
+  :cpu_count => '1', :memory_size=> '256', 
+  :disk_size => '10140', :disk_format => 'VDI',:disk_size => '10240' ,
+  :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"
+   }
+)
+</pre>
+
+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.
+
+## Put your isofile inside the $VEEWEE/iso directory or if you don't run
+$ vagrant 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
+
+## Build the new box:
+$ vagrant 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
+- Wait for ssh login to work with :ssh_user , :ssh_password
+- Sudo execute the :postinstall_files
+
+## 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
+$ vagrant box add 'myubuntubox' 'myubuntubox.box'
+
+## Use it in vagrant
+Start vagrant init in another window (as we have set the Virtualbox env to tmp before)
+$ To import it into vagrant type:
+
+To use it:
+vagrant init 'myubuntubox'
+vagrant up
+vagrant ssh
+
+## If you have a setup working, share your 'definition' with me. That would be fun! 
+
+IDEAS:
+
+- Now you integrate this with your CI build to create a daily basebox
+
+FUTURE IDEAS:
+
+- use snapshots to fastforward initial boot, and every postinstall command
+- export to AMI too
+- provide for more failsafe execution, testing parameters
+- use more virtualbox ruby instead of calling the VBoxManage command
+- Verify the installation with cucumber-nagios (ssh functionality)
+- Do the same for Vmware Fusion
+
+BUGS: Lots = Like I said it currently works for me, on my machine and with the correct magic sequence :)

data/Rakefile

@@ -0,0 +1,92 @@
+require 'rubygems'
+require 'bundler'
+require 'bundler/setup'
+Bundler::GemHelper.install_tasks
+
+#Setup some base variables to use
+veewee_dir= "."
+definition_dir= File.expand_path(File.join(veewee_dir, "definitions"))
+lib_dir= File.expand_path(File.join(veewee_dir, "lib"))
+box_dir= File.expand_path(File.join(veewee_dir, "boxes"))
+template_dir=File.expand_path(File.join(veewee_dir, "templates"))
+vbox_dir=File.expand_path(File.join(veewee_dir, "tmp"))
+tmp_dir=File.expand_path(File.join(veewee_dir, "tmp"))
+iso_dir=File.expand_path(File.join(veewee_dir, "iso"))
+
+
+#Load Veewee::Session libraries
+Dir.glob(File.join(lib_dir, '**','*.rb')).each {|f| 
+  require f  }
+
+#Initialize
+Veewee::Session.setenv({:veewee_dir => veewee_dir, :definition_dir => definition_dir,
+   :template_dir => template_dir, :iso_dir => iso_dir, :box_dir => box_dir, :tmp_dir => tmp_dir})
+
+desc 'Default: list templates'
+task :default => [:templates]
+
+desc 'List templates'
+task :templates do
+    Veewee::Session.list_templates
+end
+
+desc 'Define box'
+task :define, [:boxname,:template_name] do |t,args|
+    if args.to_hash.size!=2
+      puts "needs two arguments: rake define['boxname','template_name']"
+      exit
+    end
+    Veewee::Session.define(args.boxname,args.template_name)
+end
+
+desc 'Undefine box'
+task :undefine, [:boxname] do |t,args|
+    if args.to_hash.size!=1
+      puts "needs one arguments: rake undefine[\"yourname\"]"
+      exit
+    end
+    Veewee::Session.undefine(args.boxname)
+end
+
+desc 'List Definitions'
+task :definitions do 
+    Veewee::Session.list_definitions
+end
+
+desc 'Build box'
+task :build, [:boxname] do |t,args|
+    if args.to_hash.size!=1
+      puts "needs one arguments: rake build['boxname']"
+      exit
+    end
+    Veewee::Session.build(args.boxname)
+end
+
+desc 'List boxes'
+task :boxes do
+    Veewee::Session.list_boxes
+end
+
+desc 'Export box'
+task :export, [:boxname] do |t,args|
+  if args.to_hash.size!=1
+    puts "needs one arguments: rake export['boxname']"
+    exit
+  end
+    Veewee::Session.export_box(args.boxname)
+end
+
+desc 'Remove box'
+task :remove_box, [:boxname] do |t,args|
+    Veewee::Session.remove_box(args.boxname)
+end
+
+desc 'List ostypes available'
+task :list_ostypes do |t,args|
+    Veewee::Session.list_ostypes
+end
+
+desc 'Clean all unfinished builds'
+task :clean do 
+    Veewee::Session.clean
+end

data/bin/veewee

@@ -0,0 +1,79 @@
+#!/usr/bin/env ruby
+
+require 'rubygems'
+require 'thor'
+require 'bundler'
+require 'virtualbox'
+require 'veewee'
+
+
+#Setup some base variables to use
+veewee_dir= File.expand_path(File.join(File.dirname(__FILE__),".."))
+definition_dir= File.expand_path(File.join(".", "definitions"))
+lib_dir= File.expand_path(File.join(veewee_dir, "lib"))
+box_dir= File.expand_path(File.join(veewee_dir, "boxes"))
+template_dir=File.expand_path(File.join(veewee_dir, "templates"))
+
+#vbox_dir=File.expand_path(File.join(veewee_dir, "tmp"))
+tmp_dir=File.expand_path(File.join(veewee_dir, "tmp"))
+
+iso_dir=File.expand_path(File.join(veewee_dir, "iso"))
+
+#needs to be moved to the config files to be allowed override
+#ENV['VBOX_USER_HOME']=vbox_dir
+
+#Load Veewee::Session libraries
+Dir.glob(File.join(lib_dir, '**','*.rb')).each {|f|
+  require f  }
+
+#Initialize
+Veewee::Session.setenv({:veewee_dir => veewee_dir, :definition_dir => definition_dir,
+   :template_dir => template_dir, :iso_dir => iso_dir, :box_dir => box_dir, :tmp_dir => tmp_dir})
+
+
+   
+class VeeweeCLI < Thor 
+  
+  desc "init [NAME] [TEMPLATE]", "initializes a box from a template" 
+  method_options :force => :boolean
+  def init(boxname=nil, template=nil)
+    if (boxname.nil?)  
+      puts "please provide a boxname"
+      exit
+    end
+    
+    puts "Init a new box #{boxname}, starting from template #{template}"
+  	Veewee::Session.define(boxname,template)
+  	
+  end
+
+  desc "templates", "list the template available" 
+  def templates 
+    Veewee::Session.list_templates
+  end
+  
+  desc "build [NAME]", "build the box defined" 
+  method_options :force => :boolean
+  def build(boxname)
+    puts "Building box #{boxname}"
+	  Veewee::Session.build(boxname)
+  end
+
+  desc "export [NAME]", "export the box" 
+  method_options :force => :boolean  
+  def export(boxname)
+      if (!boxname.nil?)
+        Veewee::Session.export_box(boxname)
+      end
+  end
+  
+end
+
+
+
+version=VirtualBox.version
+if (version.match(/^4./))
+   	VeeweeCLI.start
+else
+   	puts "veewee only supports VirtualBox 4.x"
+end

data/iso/.gitignore

@@ -0,0 +1,2 @@
+*
+!.gitignore

data/lib/vagrant_init.rb

@@ -0,0 +1 @@
+require 'veewee'

data/lib/veewee/command.rb

@@ -0,0 +1,66 @@
+require 'veewee/session'
+
+#Load Veewee::Session libraries
+lib_dir= File.expand_path(File.join(File.dirname(__FILE__),"..","..", "lib"))
+Dir.glob(File.join(lib_dir, '**','*.rb')).each {|f| require f  }
+
+#Setup some base variables to use
+template_dir=File.expand_path(File.join(lib_dir,"..", "templates"))
+
+veewee_dir="."
+definition_dir= File.expand_path(File.join(veewee_dir, "definitions"))
+tmp_dir=File.expand_path(File.join(veewee_dir, "tmp"))
+iso_dir=File.expand_path(File.join(veewee_dir, "iso"))
+box_dir=File.expand_path(File.join(veewee_dir, "boxes"))
+
+#Initialize
+Veewee::Session.setenv({:veewee_dir => veewee_dir, :definition_dir => definition_dir,
+   :template_dir => template_dir, :iso_dir => iso_dir, :box_dir => box_dir, :tmp_dir => tmp_dir})
+
+module Veewee
+class Command < Vagrant::Command::GroupBase
+  register "basebox","Commands to manage baseboxes"  
+
+  desc "templates", "List the currently available box templates"
+  def templates
+    Veewee::Session.list_templates
+  end
+
+  desc "define BOXNAME TEMPLATE", "Define a new box starting from a template"
+  method_option :force,:type => :boolean , :default => false, :aliases => "-f", :desc => "overwrite the definition"
+  def define(boxname, template)    
+    Veewee::Session.define(boxname,template,options)
+  end
+
+  desc "build BOXNAME", "Build the box BOXNAME"
+  method_option :force,:type => :boolean , :default => false, :aliases => "-f", :desc => "overwrite the basebox"
+  def build(boxname)
+    Veewee::Session.build(boxname,options)
+  end
+
+  desc "ostypes", "List the available Operating System types"
+  def ostypes
+    Veewee::Session.list_ostypes
+  end
+  
+  desc "destroy BOXNAME", "Destroy the virtualmachine of a basebox"
+  def destroy(boxname)
+    puts Veewee::Session.destroy_vm(boxname)
+  end
+  
+  desc "list", "Lists all defined boxes"
+  def list
+  Veewee::Session.list_definitions
+  end
+  
+  desc "export [NAME]", "export the box" 
+  method_options :force => :boolean  
+  def export(boxname)
+      if (!boxname.nil?)
+        Veewee::Session.export_box(boxname)
+      end
+  end
+  
+end
+
+end

data/lib/veewee/config.rb

@@ -0,0 +1,5 @@
+module Veewee
+  class BaseBoxConfig < Vagrant::Config::Base
+    configures :basebox
+  end
+end

data/lib/veewee/export.rb

@@ -0,0 +1,81 @@
+require 'pathname'
+module Veewee
+  class Export
+
+#    Shellutil.execute("vagrant package --base #{vmname} --include /tmp/Vagrantfile --output /tmp/#{vmname}.box", {:progress => "on"})    
+    
+    def self.vagrant(boxname,boxdir,definition)
+      
+      #Check if box already exists
+      vm=VirtualBox::VM.find(boxname)
+      if vm.nil?
+        puts "#{boxname} is not found, maybe you need to build first?"
+        exit
+      end
+      #We need to shutdown first
+      if vm.running?
+        puts "Vagrant requires the box to be shutdown, before it can export"
+        puts "Sudo also needs to work for user #{definition[:ssh_user]}"
+        puts "Performing a clean shutdown now."
+        ssh_options={ :user => definition[:ssh_user], :port => definition[:ssh_host_port], :password => definition[:ssh_password],
+            :timeout => definition[:ssh_timeout]}       
+                    
+        Veewee::Ssh.execute("localhost","sudo #{definition[:shutdown_cmd]}",ssh_options)
+
+        #Wait for state poweroff
+        while (vm.running?) do 
+          print '.'
+          sleep 1
+        end
+        puts
+        puts "Machine #{boxname} is powered off cleanly"
+      end
+
+      #Vagrant requires a relative path for output of boxes
+  
+      #4.0.x. not using boxes as a subdir
+      boxdir=Pathname.new(Dir.pwd)
+      
+      full_path=File.join(boxdir,boxname+".box")
+      path1=Pathname.new(full_path)
+      path2=Pathname.new(Dir.pwd)
+      box_path=path1.relative_path_from(path2).to_s
+      
+      if File.exists?("#{box_path}")
+        puts "box #{boxname} already exists"
+        exit
+      end
+      
+      puts "Excuting vagrant voodoo:"
+      export_command="vagrant package --base '#{boxname}' --output '#{box_path}'"
+      puts "#{export_command}"
+      Veewee::Shell.execute("#{export_command}") #hmm, needs to get the gem_home set?
+      puts
+      
+      #add_ssh_nat_mapping back!!!!      
+      
+      puts "To import it into vagrant type:"
+      puts "vagrant box add '#{boxname}' '#{box_path}'"
+      puts ""
+      puts "To use it:"
+      puts "vagrant init '#{boxname}'"
+      puts "vagrant up"
+      puts "vagrant ssh"
+    end
+ 
+  end
+end
+
+
+#      #currently vagrant has a problem with the machine up, it calculates the wrong port to ssh to poweroff the system
+#      thebox.execute("shutdown -h now") 
+#      thebox.wait_for_state("poweroff")
+         
+#      Shellutil.execute("echo 'Vagrant::Config.run do |config|' > /tmp/Vagrantfile")    
+#      Shellutil.execute("echo '   config.ssh.forwarded_port_key = \"ssh\"' >> /tmp/Vagrantfile")    
+#      Shellutil.execute("echo '   config.vm.forward_port(\"ssh\",22,#{host_port})' >> /tmp/Vagrantfile")    
+#      Shellutil.execute("echo 'end' >> /tmp/Vagrantfile") 
+
+ 
+#vagrant export disables the machine
+#      thebox.ssh_enable_vmachine({:hostport => host_port , :guestport => 22} )

data/lib/veewee/scancode.rb

@@ -0,0 +1,108 @@
+module Veewee
+  class Scancode
+  
+    def self.send_sequence(vboxcmd,vname,sequence)
+            puts
+            counter=0
+            sequence.each { |s|
+              counter=counter+1
+ 
+              s.gsub!(/%IP%/,Veewee::Session.local_ip);
+              s.gsub!(/%PORT%/,'7122');
+              s.gsub!(/%NAME%/, vname);
+              puts "Typing:[#{counter}]: "+s
+
+              keycodes=string_to_keycode(s)
+      
+              # VBox seems to have issues with sending the scancodes as one big
+              # .join()-ed string. It seems to get them out or order or ignore some.
+              # A workaround is to send the scancodes one-by-one.
+              codes=""
+              for keycode in keycodes.split(' ') do
+                   send_keycode(vboxcmd,vname,keycode)    
+                   sleep 0.01                  
+              end
+        	    #sleep after each sequence (needs to be param)
+        	    sleep 1
+    	    }
+
+          puts "Done typing."
+          puts
+  
+    end
+
+    def self.send_keycode(vboxcmd,vname,keycode)
+           command= "#{vboxcmd} controlvm '#{vname}' keyboardputscancode #{keycode}"
+           #puts "#{command}"
+                  IO.popen("#{command}") { |f| print '' }
+    end
+
+    def self.string_to_keycode(thestring)
+  
+      #http://www.win.tue.nl/~aeb/linux/kbd/scancodes-1.html
+  
+            k=Hash.new
+            k['1'] = '02' ; k['2'] = '03' ; k['3'] = '04'; k['4']= '05' ;k['5']='06'; k['6'] = '07' ; k['7'] = '08'; k['8'] = '09'; k['9']= '0a'; k['0']='0b'; k['-'] = '0c'; k['='] = '0d' ;
+            k['Tab'] = '0f'; 
+            k['q']  = '10' ;       k['w']  = '11' ;       k['e']  = '12';       k['r'] = '13'       ; k['t'] = '14'       ; k['y'] = '15';      k['u']= '16'        ; k['i']='17';      k['o'] = '18'       ; k['p'] = '19' ; 
+           
+            k['Q']  = '2a 10 aa' ; k['W']  = '2a 11 aa' ; k['E']  = '2a 12 aa'; k['R'] = '2a 13 aa' ; k['T'] = '2a 14 aa' ; k['Y'] = '2a 15 aa'; k['U']= '2a 16 aa' ; k['I']='2a 17 aa'; k['O'] = '2a 18 aa' ; k['P'] = '2a 19 aa' ;
+
+            k['a'] = '1e'; k['s']  = '1f' ; k['d']  = '20' ; k['f']  = '21'; k['g'] = '22' ; k['h'] = '23' ; k['j'] = '24'; k['k']= '25' ; k['l']='26'; k[';'] = '27' 
+            k['A'] = '2a 1e aa'; k['S']  = '2a 1f aa' ; k['D']  = '2a 20 aa' ; k['F']  = '2a 21 aa'; k['G'] = '2a 22 aa' ; k['H'] = '2a 23 aa' ; k['J'] = '2a 24 aa'; k['K']= '2a 25 aa' ; k['L']='2a 26 aa'; 
+            
+            k[';'] = '27' ;k['"']='28';
+
+            k['[']='1a'; k[']']='1b'
+
+            k['z'] = '2c'; k['x']  = '2d' ; k['c']  = '2e' ; k['v']  = '2f'; k['b'] = '30' ; k['n'] = '31' ; k['m'] = '32';
+            k['Z'] = '2a 2c aa'; k['X']  = '2a 2d aa' ; k['C']  = '2a 2e aa' ; k['V']  = '2a 2f aa'; k['B'] = '2a 30 aa' ; k['N'] = '2a 31 aa' ; k['M'] = '2a 32 aa';
+            
+            k[',']= '33' ; k['.']='34'; k['/'] = '35' ;k[':'] = '2a 27 aa';
+            k['%'] = '2a 06 aa';  k['_'] = '2a 0c aa';
+
+          special=Hash.new;
+          special['<Enter>'] = '1c';
+          special['<Backspace>'] = '0e';
+          special['<Spacebar>'] = '39';
+          special['<Return>'] = '1c'
+          special['<Esc>'] = '01';
+          #special['<Up>'] = '01';
+          #special['<Down>'] = '01';
+          #special['<PageUp>'] = '01';
+          #special['<PageDown>'] = '01';
+
+          keycodes=''
+          thestring.gsub!(/ /,"<Spacebar>")
+
+          until thestring.length == 0
+            nospecial=true;
+            special.keys.each { |key|
+              if thestring.start_with?(key)
+                #take thestring
+                #check if it starts with a special key + pop special string
+                keycodes=keycodes+special[key]+' ';
+                 thestring=thestring.slice(key.length,thestring.length-key.length)
+                  nospecial=false;
+                break;
+              end
+            }
+            if nospecial
+              code=k[thestring.slice(0,1)]
+              if !code.nil?
+                keycodes=keycodes+code+' '
+              else
+                puts "no scan code for #{thestring.slice(0,1)}"
+              end
+              #pop one
+              thestring=thestring.slice(1,thestring.length-1)
+            end
+          end
+
+            return keycodes
+    end
+
+  end
+end
+
+