veewee 0.3.7 → 0.3.9

data/.gitignore

@@ -9,6 +9,8 @@ tmp/*
 definitions/*
 Vagrantfile
 Vagrantfile.*
+!lib/veewee/templates/Vagrantfile.erb
+!lib/veewee/provider/kvm/templates/Vagrantfile
 cookbooks/*
 manifests/*
 boxes/*
@@ -17,3 +19,6 @@ pkg/*
 .vagrant
 virtualfloppy.vfd
 *.swp
+AutoPartition.app
+.rbenv-gemsets
+.project

data/.rvmrc

@@ -1,5 +1,6 @@
 rvm use ruby-1.9.2@veewee --create
+#rvm use ruby-1.8.7@veewee --create
 
 alias veewee="bundle exec veewee"
-alias vagrant="bundle exec vagrant"
 alias irb="bundle exec irb"
+#alias vagrant="bundle exec vagrant"

data/.travis.yml

@@ -0,0 +1,8 @@
+language: ruby
+rvm:
+  - 1.9.2
+  - 1.9.2-p320
+  - 1.9.3
+  - 2.0
+notifications:
+  irc: "chat.freenode.net#veewee"

data/CONTRIBUTE.md

@@ -0,0 +1,51 @@
+# Contribute to Veewee
+
+If you are looking to improve Veewee in some manner, you've come to the right place.
+
+
+## TODOs
+
+A running [TODO](doc/TODO.md) list is available for ideas on future improvements.
+
+
+## Steps to Contribute
+
+### Getting started
+
+In order to contribute anything, you'll want to follow these steps first:
+
+* Get an account on [Github](https://github.com)
+* Then fork the [veewee repository](https://github.com/jedi4ever/veewee) to your own Github account
+* If you haven't already, familiarize yourself with the [Requirements](doc/requirements.md) and [Installation](doc/installation.md) docs
+* Clone the veewee **fork** to your machine:
+
+    ~~~ sh
+    $ cd <path_to_workspace>
+    $ git clone https://github.com/<your github account>/veewee.git
+    $ cd veewee
+    ~~~
+
+* Check out a new branch to make your changes on: `git checkout -b <your_new_patch>`
+
+
+### For adding a new Template
+
+If you have a new and amazing Veewee definition, share your 'template'. That would be fun!
+
+* Before saving changes to a 'template', first try your changes in `definitions/mynewos/`
+* Build the box and run the **validation** tests
+* When the box builds OK and all tests are green, move `definition/mynewos/` to a sensible directory under the `templates/` directory. **Hint:** Follow the same naming schema of existing boxes (explained in the [Veewee Basics](doc/basics.md) doc)
+
+
+### For adding new Features
+
+* Run any existing tests that are related to your patch
+* For bonus points add tests to validate your changes
+
+
+### To submit your Contribution
+
+* Please commit with descriptive messages
+* Submit a pull request on Github from the __your_new_patch__ branch on __your fork__ to the __master__ branch on __jedi4ever/veewee__
+* One of the editors will review the change, and either merge it or provide some feedback. Community review is also encouraged.
+

data/Gemfile

@@ -8,11 +8,20 @@ source "http://rubygems.org"
 #gem "veewee", :path => "."
 #gem "fission", :path => '/Users/patrick/dev/fission'
 
+group :kvm do
+  gem "ruby-libvirt"
+end
+
+group :windows do
+  gem "em-winrm", :git => 'http://github.com/hh/em-winrm.git', :ref => '31745601d3'
+  gem "log4r"
+end
+
 group :test do
   gem "rake"
-  #gem "ruby-libvirt"
-  gem "em-winrm", :git => 'git://github.com/hh/em-winrm.git', :ref => '31745601d3'
+  #gem "vagrant" , "1.0.7"
   #gem "chef"
   #gem "knife-windows"
 end
+
 gemspec

data/README.md

@@ -1,37 +1,103 @@
-**VeeWee:** the tool to easily build vagrant base boxes or kvm,virtualbox and fusion images
+# Veewee
 
-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 built. Therefore lots of people end up first building their own base box to use with vagrant.
+[![Build Status](https://travis-ci.org/jedi4ever/veewee.png)](https://travis-ci.org/jedi4ever/veewee)
 
-Besides building Vagrant boxes, veewee can also be used for:
+Veewee is a tool for easily (and repeatedly) building custom [Vagrant](https://github.com/mitchellh/vagrant) base boxes, KVMs, and virtual machine images.
 
-- create vmware (fusion), kvm  virtual machines 
-- interact with with those vms (up, destroy, halt, ssh)
-- export them : OVA for fusion, IMG for KVM and ovf for virtualbox
 
-Before you start read through:
+## About Vagrant
 
-- the [requirements](https://github.com/jedi4ever/veewee/tree/master/doc/requirements.md)
-- the [installation](https://github.com/jedi4ever/veewee/tree/master/doc/installation.md) procedure
+Vagrant is a great tool for creating and configuring lightweight, reproducible, portable virtual machine environments - often used with the addition of automation tools such as [Chef](https://github.com/opscode/chef) or [Puppet](https://github.com/puppetlabs/puppet).
 
-Depending on how you want to use veewee, read through one of the following guides: (**work in progres**)
+The first step to build a new virtual machine is to download an existing 'base box'. I believe this scares a lot of people as they don't know how these unverified boxes were built. Therefore a lot of people end up building their own base box which is often time consuming and cumbersome. Veewee aims to automate all the steps for building base boxes and to collect best practices in a transparent way.
 
-- [guide for vagrant](https://github.com/jedi4ever/veewee/tree/master/doc/vagrant.md)
 
-- [guide for Virtualbox](https://github.com/jedi4ever/veewee/tree/master/doc/vbox.md)
-- [guide for Vmware fusion](https://github.com/jedi4ever/veewee/tree/master/doc/fusion.md)
-- [guide for KVM](https://github.com/jedi4ever/veewee/tree/master/doc/kvm.md)
+## Veewee's Supported VM Providers
 
-You can also look at the more detailed pages on each subject in the [documentation directory](https://github.com/jedi4ever/veewee/tree/master/doc)
+Veewee isn't only for Vagrant.  It currently supports exporting VM images for the following providers:
+
+* [VirtualBox](http://www.virtualbox.org/) - exports to `OVF` filetype
+* [VMware (Fusion)](http://www.vmware.com/products/fusion/) - exports to `OVA` filetype
+* [KVM](http://www.linux-kvm.org/) - exports to `IMG` filetype
+* [Parallels](http://www.parallels.com/) - none yet, but can export to `parallels` format (provided by [vagrant-parallels](https://github.com/yshahin/vagrant-parallels))
+
+
+## Getting Started
+
+Before you start, we recommend reading through these pages:
+
+* [Requirements](doc/requirements.md) that must be met before installing Veewee
+* [Veewee Installation](doc/installation.md) instructions
+* [Command Options](doc/commands.md) highlights various approaches for executing Veewee on the command line
+
+Next, learn about Veewee fundamentals:
+
+* [Veewee Basics](doc/basics.md) covers creating standard-issue boxes
+* [Customizing Definitions](doc/customize.md) helps you fine tune each box definition to meet your exact needs
+* [Veeweefile](doc/veeweefile.md) can be used to define your own paths
+
+Then depending on how you want to use Veewee, we suggest to read through one of the following guides:
+
+* [Guide for Vagrant](doc/vagrant.md)
+* [Guide for VirtualBox](doc/vbox.md)
+* [Guide for VMware Fusion](doc/fusion.md)
+* [Guide for KVM](doc/kvm.md)
+* [Guide for Parallels Desktop](doc/parallels.md)
+
+Major noteworthy changes between versions can be found here:
+
+* [Changes](doc/changes.md) between versions
+
+A complete list of all docs can be found by viewing the [doc directory](doc).
 
-People have reported good experiences, why don't you give it a try?
 
-## If you have a setup working, share your 'definition' with me. That would be fun! 
+## Veewee Commands
 
-IDEAS:
+Below is an overview of the `veewee` command options:
+
+    $ bundle exec veewee
+
+    # Commands:
+    #   veewee add_share       # Adds a Share to the Guest
+    #   veewee fusion          # Subcommand for Vmware fusion
+    #   veewee help [COMMAND]  # Describe available commands or one specific command
+    #   veewee kvm             # Subcommand for KVM
+    #   veewee parallels       # Subcommand for Parallels
+    #   veewee vbox            # Subcommand for VirtualBox
+    #   veewee version         # Prints the Veewee version information
+
+Learn how to avoid typing `bundle exec` by visiting the [Commands](doc/commands.md) doc.
+
+
+## Veewee Provider Subcommands
+
+Below is an overview of the `veewee` provider subcommand options:
+
+    $ bundle exec veewee <provider>
+
+    # Commands:
+    #   veewee <provider> build [BOX_NAME]                 # Build box
+    #   veewee <provider> copy [BOXNAME] [SRC] [DST]       # Copy a file to the VM
+    #   veewee <provider> define [BOXNAME] [TEMPLATE]      # Define a new basebox starting from a template
+    #   veewee <provider> destroy [BOXNAME]                # Destroys the basebox that was built
+    #   veewee <provider> halt [BOXNAME]                   # Activates a shutdown on the basebox
+    #   veewee <provider> help [COMMAND]                   # Describe subcommands or one specific subcommand
+    #   veewee <provider> list                             # Lists all defined boxes
+    #   veewee <provider> ostypes                          # List the available Operating System types
+    #   veewee <provider> screenshot [NAME] [PNGFILENAME]  # Takes a screenshot of the box
+    #   veewee <provider> ssh [BOXNAME] [COMMAND]          # Interactive ssh login
+    #   veewee <provider> templates                        # List the currently available templates
+    #   veewee <provider> undefine [BOXNAME]               # Removes the definition of a basebox
+    #   veewee <provider> up [BOXNAME]                     # Starts a Box
+    #   veewee <provider> validate [NAME]                  # Validates a box against vagrant compliancy rules
+    #   veewee <provider> winrm [BOXNAME] [COMMAND]        # Execute command via winrm
+
+
+## Contribute
+
+People have reported good experiences, why don't you give it a try?
 
-- Now you integrate this with your CI build to create a daily basebox
+If you have a setup working, share your 'definition' with me. That would be fun!
 
-[whren - 2012/04/12]
+See [CONTRIBUTE.md](CONTRIBUTE.md).
 
-See [use of pre_postinstall_file in definition.rb](https://github.com/whren/veewee/wiki/Use-of-pre_postinstall_file-in-definition.rb)

data/Rakefile

@@ -8,7 +8,6 @@ desc 'Default: run tests'
 task :default => :test
 
 require 'rake/testtask'
-Bundler::GemHelper.install_tasks
 
 desc 'Tests not requiring an real box'
 Rake::TestTask.new do |t|
@@ -67,7 +66,7 @@ task :iso, [:template_name] do |t, args|
               # other problem, raise
               raise "Got ftp site but doesn't support size subcommand"
             end
-            # fallback solution 
+            # fallback solution
           end
 
         end
@@ -83,18 +82,22 @@ task :iso, [:template_name] do |t, args|
   end
 end
 
-desc 'Autobuilds all templates and runs validation.'
-task :autotest, [:pattern] do |t, args|
+desc 'Builds a template and runs validation.'
+task :autotest, [:name] do |t, args|
+
+  # Disable color if the proper argument was passed
+  shell = ARGV.include?("--no-color") ? Thor::Shell::Basic.new : Thor::Base.shell.new
 
   # We overrule all timeouts for tcp and ssh
   #ENV['VEEWEE_TIMEOUT']='600'
 
   ve = Veewee::Environment.new
+  ve.ui = ::Veewee::UI::Shell.new(ve, shell)
   ve.templates.each do |name, template|
 
     # If pattern was given, only take the ones that match the pattern
-    unless args[:pattern].nil?
-      next unless name.match(args[:pattern])
+    unless args[:name].nil?
+      next unless name == args[:name]
     end
 
     begin
@@ -104,7 +107,7 @@ task :autotest, [:pattern] do |t, args|
       puts "AUTO: Building #{name}"
       box.build({ "auto" => true, "force" => true, 'nogui' => true })
       puts "AUTO: Validating #{name}"
-      box.validate_vagrant
+      box.validate_vagrant({'tags' => ['virtualbox']})
       puts "AUTO: Success #{name}"
       box.destroy
     rescue Exception => ex
@@ -118,6 +121,7 @@ task :autotest, [:pattern] do |t, args|
           puts "AUTO: Error taking screenshot"
         end
       end
+      exit -1
     end
 
   end

data/bin/veewee

@@ -6,6 +6,7 @@ end
 
 require 'veewee'
 
+ENV["VEEWEE_LOG"] = "debug" if ARGV.include?('--debug')
 env = Veewee::Environment.new
 
 begin

data/doc/TODO.md

@@ -0,0 +1,76 @@
+# TODO
+
+## Ideas
+
+* Integrate Veewee with your CI build to create baseboxes on a daily basis
+* Use of pre_postinstall_file in `definition.rb` _by whren - 2012-04-12_. See [use of pre_postinstall_file in definition.rb](https://github.com/whren/veewee/wiki/use-of-pre_postinstall_file-in-definition.rb)]
+
+
+## Requirements
+
+    virtualbox ->
+
+    kvm -> ruby-libvirt gem
+    v0.8.3 or higher
+    require libvirt 0.8+ version
+    have a default dir pool installed
+    permissions to write create new volumes
+
+    vmfusion -> VMWare fusion installed
+    Tested on VMWare fusion 0.3.x
+
+
+## Changes to Definitions
+
+Virtualbox options ioapic, pae are now moved to :virtualbox => { vm_options => [ :ioapic => 'on' ]} ;
+Now you can pass all options you have to virtualbox
+
+
+## Use as a library
+
+    ostype_id (not used for all providers)
+
+    Rakefile contains check iso
+    Rakefile contains test
+    Rakefile contains real_test
+
+
+## Templates
+
+    check for .veewee_version or .vmfusion_version to see for which provider we are building this
+    include/exclude can do this
+    default user becomes veewee, vagrant.sh will create the vagrant user if used under vagrant
+    uploading vmware.iso
+    uploading virtualbox.iso
+
+
+## Validation
+
+    veewee.feature (depending on virtualbox, vagrant)
+    no more ssh_steps
+    uses @tags per provider
+
+    # veewee vmfusion export ova
+    # vagrant basebox export box
+
+
+## New options
+
+    --postinstall-include/exclude
+    --auto (download yes)
+    --force also for export
+    --debug (debug output)
+
+    ostypes are now synchronized accross kvm
+
+
+## More Todos
+
+    veewee steps (username,password, + VEEWEE env variables)
+    validate vms - + features selection
+    check libvirt version
+    windows test
+    validation of checks (also - include/exclude)
+    check execs with exit code
+    multinetwork card
+    dkms for kernel installs

data/doc/basics.md

@@ -0,0 +1,200 @@
+# Veewee Basics
+
+Veewee uses definitions to build new virtual machines. And every 'definition' is derived from a 'template'.
+
+A template is represented by a sub-directory in the `templates/` folder. There you'll find many preconfigured templates.  With a single template you can spawn any number of customizable defintions.
+
+
+## Template naming scheme
+
+Each template folder name follows a naming scheme to help you choosing the right template:
+
+    <OS name>-<version>-<architecture>[-<install flavor>]
+
+For example, the template for a Ubuntu 12.10 server (i386) basebox looks like this:
+
+    ubuntu-12.10-server-i386[-netboot]
+    ^       ^           ^     ^ 
+    |       |           |     +----- install flavor                        
+    |       |           +----- architecture
+    |       +----- version
+    +----- OS name
+
+
+## Typical usage
+
+A common workflow to build a new base box with Veewee is:
+
+1. List all templates to find a single template to use
+2. Define a new box definition from a selected template
+3. [Customize](customize.md) the definition (optional)
+4. Build a VM using standard ISOs, your own definition settings, and some postinstall scripts
+5. Validate the new VM
+6. Manually alter the VM by logging in with ssh (optional; but not recommended)
+7. Export the VM for distribution or to be used in Vagrant
+
+
+## Getting help
+
+If you'd like some help with a particular command:
+
+    $ bundle exec veewee help <command>
+
+And if you're not sure how to use a subcommand, get help with:
+
+    $ bundle exec veewee <provider> help <subcommand>
+
+The subcommand help is often useful since it will list available optional flag arguments.
+
+
+## List existing definitions
+
+To list all available definitions that you've previously created or copied:
+
+    $ bundle exec veewee <provider> list
+
+
+## Listing available templates
+
+Veewee provides templates for a lot of different operation systems. To see all the templates provided:
+
+    $ bundle exec veewee <provider> templates
+
+Templates have the same structure as definitions, but templates are used to generate definitions. Definitions are simply **your** customizable templates that you can modify as you see fit.
+
+
+## Create a definition
+
+A definition is created by cloning a template into the `definitions/` folder.
+
+To create a definition, use the `define` subcommand:
+
+    $ bundle exec veewee <provider> define 'myubuntubox' 'ubuntu-12.10-server-amd64'
+
+If you want to use an external repository for the definition, you can specify a git URL:
+
+    $ bundle exec veewee <provider> define 'myubuntubox' 'git://github.com/jedi4ever/myubuntubox'
+
+
+## Modify a definition (optional)
+
+You can tweak and customize every detail of the box by modifying and extending the (sane) default settings
+that come with a template. If you want to modify these settings take a look at the [Customization](customize.md)  instructions.
+
+
+## Remove a definition
+
+If you change your mind and want to get rid of a definition simply call this subcommand:
+
+    $ bundle exec veewee <provider> undefine 'myubuntubox'
+
+Or you can remove the folder under `definitions`:
+
+    $ rm -r ./definitions/myubuntubox
+
+
+## Manage ISO files
+
+The distro ISOs (also called *disk images*) provide all files needed to install the OS. This file is essential for starting the installation process. 
+
+If you already have an `.iso` file for the desired distribution on your disk, put it inside the `iso/` directory and make sure `definition.rb` is referencing the correct file. 
+
+If an expected ISO is not found in the `iso/` directory, Veewee will ask you to download the ISO file from the web. Depending on your internet connection fetching an ISO file can take a while.
+
+
+## Build a new VM image
+
+In order to build the defined box, execute this subcommand:
+
+    $ bundle exec veewee <provider> build 'myubuntubox'
+
+The `build` subcommand can take the following optional flags:
+
+Flag Option                  | Description
+-----------------------------|-------------    
+--force                      | overwrites if already exists
+--auto                       | automatically downloads the ISO without asking
+--nogui                      | builds in the background rather than opening a VM GUI and building in the GUI window
+--debug                      | enabled debug mode output
+--redirectconsole            | redirects console output
+--postinstall-include=[...]  | forces specified file(s) to get included in postinstall even if filename has a leading underscore
+--postinstall-exclude=[...]  | forces specified file(s) to get excluded from postinstall even if filename has no leading underscore
+
+The `build` subcommand will run the following routines behind the scenes:
+
+* Create a machine and disk according to the `definition.rb`
+  Note: `:os_type_id` is the internal name Virtualbox uses for a given distribution
+* Mount the ISO file `:iso_file`
+* Boot up the machine and wait for `:boot_time`
+* Send the keystrokes in `:boot_cmd_sequence`
+* Start up a webserver on `:kickstart_port` to wait for a request from the `:kickstart_file`
+  IMPORTANT: Do NOT 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` and `:ssh_password`
+* `sudo` execute the `:postinstall_files`
+
+
+## Validate a build
+
+After an OS has been installed on your VM image, you can verify that the machine is configured as intended with the `validate` subcommand. Veewee provides several tests to help you with that. The tests are located under the `validation/` directory.
+
+This subcommand executes all tests on a given machine:
+
+    $ bundle exec veewee <provider> validate 'myubuntubox'
+
+Validate will run some [cucumber tests](http://cukes.info/) against the box to see if it has the necessary bits and pieces (e.g. for vagrant to work).
+
+
+## Export a build for distribution
+
+The following subcommand take care of exporting:
+
+    $ bundle exec veewee <provider> export 'mybuntubox'
+
+The exported filetype depends on the provider. For more details on the providers, please have a look at the [Providers](providers.md) doc.
+
+
+## Learn by example
+
+Let's say you'd like to make a *Ubuntu 12.10 server (i386)* base box that's compatible with VirtualBox.
+
+First go and find the `ubuntu-12.10-server-i386` template:
+
+    $ bundle exec veewee vbox templates | grep -i ubuntu
+
+Then use the `define` command to create a new definition with a custom name. The following command copies the folder `templates/ubuntu-12.10-server-i386` to `definitions/myubuntubox`:
+
+    $ bundle exec veewee vbox define 'myubuntubox' 'ubuntu-12.10-server-i386'
+    #
+    # The basebox 'myubuntubox' has been successfully created from the template 'ubuntu-12.10-server-i386'
+    # You can now edit the definition files stored in definitions/myubuntubox or build the box with:
+    # veewee vbox build 'myubuntubox'
+
+**IMPORTANT:** You should avoid dots in the name because the box name gets used as the hostname also. Dots in the box name currently lead to invalid hostnames which causes several negative side effects (e.g. preventing the network devices to start).    
+
+Confirm that all expected files are in place:
+
+    $ ls definitions/myubuntubox
+    # => definition.rb postinstall.sh preseed.cfg ...
+
+You can now inspect and optionally [customize](customize.md) the defaults.
+
+Next it's time to build the VM image with:
+
+    $ bundle exec veewee vbox build 'myubuntubox'
+
+Veewee now asks to download the distro ISO (unless `--auto` is provided) and will start creating the VM image.  This process can take some time.
+
+After the build completes, you can run the provided test suite on your new VM:
+
+    $ bundle exec veewee vbox validate 'myubuntubox'
+
+Validation is highly recommended before requesting a fork pull on any modified templates.
+
+Finally let's export the box so it can be distributed or used by Vagrant:
+
+    $ bundle exec veewee vbox export 'myubuntubox'    
+
+
+## Up Next
+
+[Customizing Definitions](customize.md) helps you fine tune each box definition to meet your exact needs.