tenderloin 0.2.0

data/LICENCE

@@ -0,0 +1,21 @@
+The MIT License
+
+Copyright (c) 2010 Mitchell Hashimoto and John Bender
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,50 @@
+# Tenderloin
+
+Tenderloin is a tool for building and distributing virtualized development environments.
+
+It is based on [Vagrant](http://vagrantup.com), specifically the 0.1.4 release. This was
+the simplest, and provided a good starting point
+
+It is designed to use VMWare Fusion as the underlying provider. You will need Fusion 5.
+
+## Quick Start
+
+    gem install tenderloin
+
+To build your first virtual environment:
+
+    loin init
+    loin box add base http://s3.lstoll.net/<todo>.box
+    loin up
+
+The file describing your VM is called 'Tenderfile', but you can optionally change this with
+the -f flag, to allow multiple VM descriptions in the same place.
+
+## Builsding base boxes
+
+Currently base boxes are built manually. The process:
+
+* Create image in Fusion
+* Set user and password to 'tenderloin'
+* Set sudo to not prompt for password
+* Install VMWare additions
+* Ensure you have a single .vmdk disk. If not, convert with:
+
+    /Applications/VMware\ Fusion.app/Contents/Library/vmware-vdiskmanager -r Virtual\ Disk.vmdk -t 0 precise64.vmdk
+
+and then edit the vmx to point to this.
+
+* Compress and shrink the disk
+
+    /Applications/VMware\ Fusion.app/Contents/Library/vmware-vdiskmanager -d precise64.vmdk
+    /Applications/VMware\ Fusion.app/Contents/Library/vmware-vdiskmanager -k precise64.vmdk
+
+* Create a Tenderfile. Example:
+
+    Tenderloin::Config.run do |config|
+        config.vm.box_vmx = "precise64.vmx"
+    end
+
+* Tar them up as a .box
+
+    tar -cvf precise64.box precise64.vmx Tenderfile precise64.vmdk

data/Version

@@ -0,0 +1 @@
+0.1.4

data/bin/loin

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+require 'tenderloin'
+
+Tenderloin::CLI.start(ARGV)

data/config/default.rb

@@ -0,0 +1,26 @@
+Tenderloin::Config.run do |config|
+  # default config goes here
+  config.tenderloin.log_output = STDOUT
+  config.tenderloin.dotfile_name = ".tenderloin"
+  config.tenderloin.home = "~/.tenderloin"
+
+  config.ssh.username = "tenderloin"
+  config.ssh.password = "tenderloin"
+  # config.ssh.host = "localhost"
+  config.ssh.max_tries = 10
+  config.ssh.timeout = 30
+
+  config.vm.box_vmx = "box.vmx"
+  config.vm.project_directory = "/tenderloin"
+
+  config.package.name = 'tenderloin'
+  config.package.extension = '.box'
+
+  config.chef.enabled = false
+  config.chef.cookbooks_path = "cookbooks"
+  config.chef.provisioning_path = "/tmp/tenderloin-chef"
+  config.chef.json = {
+    :instance_role => "tenderloin",
+    :recipes => ["tenderloin_main"]
+  }
+end

data/lib/tenderloin/actions/base.rb

@@ -0,0 +1,93 @@
+module Tenderloin
+  module Actions
+    # Base class for any command actions.
+    #
+    # Actions are the smallest unit of functionality found within
+    # Tenderloin. Tenderloin composes many actions together to execute
+    # its complex tasks while keeping the individual pieces of a
+    # task as discrete reusable actions. Actions are ran exclusively
+    # by an {Runner action runner} which is simply a subclass of {Runner}.
+    #
+    # Actions work by implementing any or all of the following methods
+    # which a {Runner} executes:
+    #
+    # * `prepare` - Called once for each action before any action has `execute!`
+    #   called. This is meant for basic setup.
+    # * `execute!` - This is where the meat of the action typically goes;
+    #   the main code which executes the action.
+    # * `cleanup` - This is called exactly once for each action after every
+    #   other action is completed. It is meant for cleaning up any resources.
+    # * `rescue` - This is called if an exception occurs in _any action_. This
+    #   gives every other action a chance to clean itself up.
+    #
+    # For details of each step of an action, read the specific function call
+    # documentation below.
+    class Base
+      # The {Runner runner} which is executing the action
+      attr_reader :runner
+
+      # Included so subclasses don't need to include it themselves.
+      include Tenderloin::Util
+
+      # Initialization of the action, passing any arguments which may have
+      # been given to the {Runner runner}. This method can be used by subclasses
+      # to save any of the configuration options which are passed in.
+      def initialize(runner, *args)
+        @runner = runner
+      end
+
+      # This method is called once per action, allowing the action
+      # to setup any callbacks, add more events, etc. Prepare is
+      # called in the order the actions are defined, and the action
+      # itself has no control over this.
+      #
+      # Examples of its usage:
+      #
+      # Perhaps we need an additional action only if a configuration is set:
+      #
+      #     def prepare
+      #       @vm.actions << FooAction if Tenderloin.config[:foo] == :bar
+      #     end
+      #
+      def prepare; end
+
+      # This method is called once, after preparing, to execute the
+      # actual task. This method is responsible for calling any
+      # callbacks. Adding new actions here will have unpredictable
+      # effects and should never be done.
+      #
+      # Examples of its usage:
+      #
+      #     def execute!
+      #       @vm.invoke_callback(:before_oven, "cookies")
+      #       # Do lots of stuff here
+      #       @vm.invoke_callback(:after_oven, "more", "than", "one", "option")
+      #     end
+      #
+      def execute!; end
+
+      # This method is called after all actions have finished executing.
+      # It is meant as a place where final cleanup code can be done, knowing
+      # that all other actions are finished using your data.
+      def cleanup; end
+
+      # This method is only called if some exception occurs in the chain
+      # of actions. If an exception is raised in any action in the current
+      # chain, then every action part of that chain has {#rescue} called
+      # before raising the exception further. This method should be used to
+      # perform any cleanup necessary in the face of errors.
+      #
+      # **Warning:** Since this method is called when an exception is already
+      # raised, be _extra careful_ when implementing this method to handle
+      # all your own exceptions, otherwise it'll mask the initially raised
+      # exception.
+      def rescue(exception); end
+    end
+
+    # An exception which occured within an action. This should be used instead of
+    # {Tenderloin::Util#error_and_exit error_and_exit}, since it allows the {Runner} to call
+    # {Base#rescue rescue} on all the actions and properly exit. Any message
+    # passed into the {ActionException} is then shown and and tenderloin exits.
+    class ActionException < Exception; end
+  end
+end

data/lib/tenderloin/actions/box/add.rb

@@ -0,0 +1,22 @@
+module Tenderloin
+  module Actions
+    module Box
+      # A meta-action which adds a box by downloading and unpackaging it.
+      # This action downloads and unpackages a box with a given URI. This
+      # is a _meta action_, meaning it simply adds more actions to the
+      # action chain, and those actions do the work.
+      #
+      # This is the action called by {Box#add}.
+      class Add < Base
+        def prepare
+          if File.exists?(@runner.directory)
+            raise ActionException.new("A box with the name '#{@runner.name}' already exists, please use another name or use `tenderloin box remove #{@runner.name}`")
+          end
+
+          @runner.add_action(Download)
+          @runner.add_action(Unpackage)
+        end
+      end
+    end
+  end
+end

data/lib/tenderloin/actions/box/destroy.rb

@@ -0,0 +1,14 @@
+module Tenderloin
+  module Actions
+    module Box
+      # Action to destroy a box. This action is not reversible and expects
+      # to be called by a {Box} object.
+      class Destroy < Base
+        def execute!
+          logger.info "Deleting box directory..."
+          FileUtils.rm_rf(@runner.directory)
+        end
+      end
+    end
+  end
+end

data/lib/tenderloin/actions/box/download.rb

@@ -0,0 +1,63 @@
+module Tenderloin
+  module Actions
+    module Box
+      # An action which acts on a box by downloading the box file from
+      # the given URI into a temporary location. This action parses a
+      # given URI and handles downloading it via one of the many Tenderloin
+      # downloads (such as {Tenderloin::Downloaders::File}).
+      #
+      # This action cleans itself up by removing the downloaded box file.
+      class Download < Base
+        BASENAME = "box"
+        BUFFERSIZE = 1048576 # 1 MB
+
+        attr_reader :downloader
+
+        def prepare
+          # Parse the URI given and prepare a downloader
+          uri = URI.parse(@runner.uri)
+          uri_map = [[URI::HTTP, Downloaders::HTTP], [URI::Generic, Downloaders::File]]
+
+          uri_map.find do |uri_type, downloader_klass|
+            if uri.is_a?(uri_type)
+              logger.info "#{uri_type} for URI, downloading via #{downloader_klass}..."
+              @downloader = downloader_klass.new
+            end
+          end
+
+          raise ActionException.new("Unknown URI type for box download.") unless @downloader
+        end
+
+        def execute!
+          with_tempfile do |tempfile|
+            download_to(tempfile)
+            @runner.temp_path = tempfile.path
+          end
+        end
+
+        def cleanup
+          if @runner.temp_path && File.exist?(@runner.temp_path)
+            logger.info "Cleaning up downloaded box..."
+            File.unlink(@runner.temp_path)
+          end
+        end
+
+        def rescue(exception)
+          cleanup
+        end
+
+        def with_tempfile
+          logger.info "Creating tempfile for storing box file..."
+          Tempfile.open(BASENAME, Env.tmp_path) do |tempfile|
+            yield tempfile
+          end
+        end
+
+        def download_to(f)
+          logger.info "Copying box to temporary location..."
+          downloader.download!(@runner.uri, f)
+        end
+      end
+    end
+  end
+end

data/lib/tenderloin/actions/box/unpackage.rb

@@ -0,0 +1,46 @@
+module Tenderloin
+  module Actions
+    module Box
+      # This action unpackages a downloaded box file into its final
+      # box destination within the tenderloin home folder.
+      class Unpackage < Base
+
+        def execute!
+          @runner.invoke_around_callback(:unpackage) do
+            setup_box_dir
+            decompress
+          end
+        end
+
+        def rescue(exception)
+          if File.directory?(box_dir)
+            logger.info "An error occurred, rolling back box unpackaging..."
+            FileUtils.rm_rf(box_dir)
+          end
+        end
+
+        def setup_box_dir
+          if File.directory?(box_dir)
+            error_and_exit(<<-msg)
+This box appears to already exist! Please call `tenderloin box remove #{@runner.name}`
+and then try to add it again.
+msg
+          end
+
+          FileUtils.mkdir_p(box_dir)
+        end
+
+        def box_dir
+          @runner.directory
+        end
+
+        def decompress
+          Dir.chdir(box_dir) do
+            logger.info "Extracting box to #{box_dir}..."
+            Archive::Tar::Minitar.unpack(@runner.temp_path, box_dir)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/tenderloin/actions/runner.rb

@@ -0,0 +1,138 @@
+module Tenderloin
+  module Actions
+    # Base class for any class which will act as a runner
+    # for actions. A runner handles queueing up and executing actions,
+    # and executing the methods of an action in the proper order. The
+    # action runner also handles invoking callbacks that actions may
+    # request.
+    #
+    # # Executing Actions
+    #
+    # Actions can be executed by adding them and executing them all
+    # at once:
+    #
+    #     runner = Tenderloin::Actions::Runner.new
+    #     runner.add_action(FooAction)
+    #     runner.add_action(BarAction)
+    #     runner.add_action(BazAction)
+    #     runner.execute!
+    #
+    # Single actions have a shorthand to be executed:
+    #
+    #     Tenderloin::Actions::Runner.execute!(FooAction)
+    #
+    # Arguments may be passed into added actions by adding them after
+    # the action class:
+    #
+    #     runner.add_action(FooAction, "many", "arguments", "may", "follow")
+    #
+    class Runner
+      include Tenderloin::Util
+
+      class << self
+        # Executes a specific action, optionally passing in any arguments to that
+        # action. This method is shorthand to initializing a runner, adding a single
+        # action, and executing it.
+        def execute!(action_klass, *args)
+          runner = new
+          runner.add_action(action_klass, *args)
+          runner.execute!
+        end
+      end
+
+      # Returns an array of all the actions in queue. Because this
+      # will persist accross calls (calling {#actions} twice will yield
+      # exactly the same object), to clear or modify it, use the ruby
+      # array methods which act on `self`, such as `Array#clear`.
+      #
+      # @return [Array]
+      def actions
+        @actions ||= []
+      end
+
+      # Returns the first action instance which matches the given class.
+      #
+      # @param [Class] action_klass The action to search for in the queue
+      # @return [Object]
+      def find_action(action_klass)
+        actions.find { |a| a.is_a?(action_klass) }
+      end
+
+      # Add an action to the list of queued actions to execute. This method
+      # appends the given action class to the end of the queue. Any arguments
+      # given after the class are passed into the class constructor.
+      def add_action(action_klass, *args)
+        actions << action_klass.new(self, *args)
+      end
+
+      # Execute the actions in queue. This method can also optionally be used
+      # to execute a single action on an instance. The syntax for executing a
+      # single method on an instance is the same as the {execute!} class method.
+      def execute!(single_action=nil, *args)
+
+        if single_action
+          actions.clear
+          add_action(single_action, *args)
+        end
+
+        # Raising it here might be too late and hard debug where the actions are comming from (meta actions)
+        raise DuplicateActionException.new if action_klasses.uniq.size < action_klasses.size
+    
+        # Call the prepare method on each once its
+        # initialized, then call the execute! method
+        begin
+          [:prepare, :execute!, :cleanup].each do |method|
+            actions.each do |action|
+              action.send(method)
+            end
+          end
+        rescue Exception => e
+          # Run the rescue code to do any emergency cleanup
+          actions.each do |action|
+            action.rescue(e)
+          end
+
+          # If its an ActionException, error and exit the message
+          if e.is_a?(ActionException)
+            error_and_exit(e.message)
+            return
+          end
+
+          # Finally, reraise the exception
+          raise
+        end
+
+        # Clear the actions
+        actions.clear
+      end
+
+      # Invokes an "around callback" which invokes before_name and
+      # after_name for the given callback name, yielding a block between
+      # callback invokations.
+      def invoke_around_callback(name, *args)
+        invoke_callback("before_#{name}".to_sym, *args)
+        yield
+        invoke_callback("after_#{name}".to_sym, *args)
+      end
+
+      # Invokes a single callback. This method will go through each action
+      # and call the method given in the parameter `name` if the action
+      # responds to it.
+      def invoke_callback(name, *args)
+        # Attempt to call the method for the callback on each of the
+        # actions
+        results = []
+        actions.each do |action|
+          results << action.send(name, *args) if action.respond_to?(name)
+        end
+        results
+      end
+
+      def action_klasses
+        actions.map { |a| a.class }
+      end
+    end
+    
+    class DuplicateActionException < Exception; end
+  end
+end

data/lib/tenderloin/actions/vm/boot.rb

@@ -0,0 +1,52 @@
+module Tenderloin
+  module Actions
+    module VM
+      class Boot < Base
+        def execute!
+          @runner.invoke_around_callback(:boot) do
+            # Startup the VM
+            boot
+
+            # Wait for it to complete booting, or error if we could
+            # never detect it booted up successfully
+            if !wait_for_boot
+              error_and_exit(<<-error)
+Failed to connect to VM! Failed to boot?
+error
+            end
+          end
+        end
+
+        def collect_shared_folders
+          # The root shared folder for the project
+          ["tenderloin-root", Env.root_path, Tenderloin.config.vm.project_directory]
+        end
+
+        def boot
+          logger.info "Booting VM..."
+
+          @runner.fusion_vm.start(:headless => true)
+        end
+
+        def wait_for_boot(sleeptime=5)
+          logger.info "Waiting for VM to boot..."
+
+          Tenderloin.config[:ssh][:max_tries].to_i.times do |i|
+            logger.info "Trying to connect (attempt ##{i+1} of #{Tenderloin.config[:ssh][:max_tries]})..."
+            ip = @runner.fusion_vm.ip
+
+            if ip && Tenderloin::SSH.up?(ip)
+              logger.info "VM booted and ready for use on IP: " + ip
+              return true
+            end
+
+            sleep sleeptime
+          end
+
+          logger.info "Failed to connect to VM! Failed to boot?"
+          false
+        end
+      end
+    end
+  end
+end

data/lib/tenderloin/actions/vm/destroy.rb

@@ -0,0 +1,18 @@
+require 'fileutils'
+
+module Tenderloin
+  module Actions
+    module VM
+      class Destroy < Base
+        def execute!
+          @runner.execute!(Halt) if @runner.running?
+          @runner.invoke_around_callback(:destroy) do
+            logger.info "Destroying VM and associated drives..."
+            @runner.fusion_vm.delete
+            FileUtils.rm_rf(File.dirname(@runner.vmx_path))
+          end
+        end
+      end
+    end
+  end
+end

data/lib/tenderloin/actions/vm/halt.rb

@@ -0,0 +1,14 @@
+module Tenderloin
+  module Actions
+    module VM
+      class Halt < Base
+        def execute!
+          raise ActionException.new("VM is not running! Nothing to shut down!") unless @runner.running?
+
+          logger.info "Forcing shutdown of VM..."
+          @runner.fusion_vm.stop(:force => true)
+        end
+      end
+    end
+  end
+end

data/lib/tenderloin/actions/vm/import.rb

@@ -0,0 +1,32 @@
+require 'fileutils'
+
+module Tenderloin
+  module Actions
+    module VM
+      class Import < Base
+        def execute!
+          @runner.invoke_around_callback(:import) do
+            Busy.busy do
+              logger.info "Importing base VM (#{Tenderloin::Env.box.vmx_file})..."
+              # Use the first argument passed to the action
+              # @runner.vm = VirtualBox::VM.import(Tenderloin::Env.box.ovf_file)
+              @runner.vm_id = (0...15).map{ ('a'..'z').to_a[rand(26)] }.join
+              vmdir = File.join(Tenderloin::Env.vms_path, @runner.vm_id)
+
+              FileUtils.mkdir_p(vmdir) unless Dir.exists?(vmdir)
+
+              # Copy the VMX over
+              FileUtils.cp(Tenderloin::Env.box.vmx_file, File.join(vmdir, @runner.vm_id + ".vmx"))
+
+              # Copy all VMDK's over
+              Dir.glob(File.join(File.dirname(Tenderloin::Env.box.vmx_file), "*.vmdk")) do |f|
+                FileUtils.cp File.expand_path(f), vmdir
+              end
+
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/tenderloin/actions/vm/move_hard_drive.rb

@@ -0,0 +1,53 @@
+module Tenderloin
+  module Actions
+    module VM
+      class MoveHardDrive < Base
+        def execute!
+          unless @runner.powered_off?
+            error_and_exit(<<-error)
+The virtual machine must be powered off to move its disk.
+error
+            return
+          end
+
+          destroy_drive_after { clone_and_attach }
+        end
+
+        def hard_drive
+          @hard_drive ||= find_hard_drive
+        end
+
+        # TODO won't work if the first disk is not the boot disk or even if there are multiple disks
+        def find_hard_drive
+          @runner.vm.storage_controllers.each do |sc|
+            sc.devices.each do |d|
+              return d if d.image.is_a?(VirtualBox::HardDrive)
+            end
+          end
+        end
+
+        def clone_and_attach
+          logger.info "Cloning current VM Disk to new location (#{new_image_path})..."
+          hard_drive.image = hard_drive.image.clone(new_image_path, Tenderloin.config.vm.disk_image_format, true)
+
+          logger.info "Attaching new disk to VM ..."
+          @runner.vm.save
+        end
+
+        def destroy_drive_after
+          old_image = hard_drive.image
+
+          yield
+
+          logger.info "Destroying old VM Disk (#{old_image.filename})..."
+          old_image.destroy(true)
+        end
+
+        # Returns the path to the new location for the hard drive
+        def new_image_path
+          File.join(Tenderloin.config.vm.hd_location, hard_drive.image.filename)
+        end
+      end
+    end
+  end
+end