vagrant-prison 0.0.4 → 0.1.0

data/README.md

@@ -1,6 +1,37 @@
 # Vagrant::Prison
 
 Drive vagrant configuration directly from your test suite, rakefiles, etc.
+Basically anywhere you can write ruby, you can drive Vagrant.
+
+## Reasoning and Use Cases
+
+When you create and configure a `Vagrantfile`, the internals of Vagrant coerce
+this into a `Vagrant::Environment` object that has a number of properties.
+Unfortunately, much of Vagrant's design runs under the expectation that all
+this data comes from a `Vagrantfile` on disk in the current working directory,
+and therefore `Vagrant::Environment` objects can't be created programmatically
+-- a problem when you have a desire to create them dynamically and templating
+Vagrantfiles all over the place isn't really a solution. 
+
+For example, if you want to maintain parity between configuration supplied to
+Vagrant and your tool that uses Vagrant, or if you want to allow the user to
+supply additional code to be injected into Vagrantfiles and ensure the code is
+not only syntactically correct, but is evaluated in the right context. 
+Additionally prison objects can be modified and appended to post hoc, which has
+some nice advantages from a flexibility standpoint.
+
+You can also marshal `Vagrant::Prison` objects -- something you can't do with
+`Vagrant::Environment`. What this is good for is left as an exercise to the
+reader.
+
+Vagrant::Prison is to Vagrant what unix jails are ... to unix. It fakes out
+Vagrant well enough to think it's working with a traditional `Vagrantfile`, but
+it's actually working with something emulating one, without actually modifying
+the internals of Vagrant itself. It accomplishes this with recording proxies
+that are played back to Vagrant when it starts.
+
+Vagrant::Prison is **not** threadsafe. This is actually a limitation of
+Vagrant, but there's nothing we can or will do to work around it.
 
 ## Installation
 
@@ -36,12 +67,24 @@ prison.configure do |config|
   end
 end
 
-# if you don't set :ui_class here, it still works, it just provides no output.
+# here's a basic way to start your vms:
+
+prison.start
+
+# If you need more flexibility, all the internal Vagrant tooling works -- it
+# has no idea it's working with a facsimile.
+#
+# note that if you don't set :ui_class here, it still works, it just provides
+# no output.
 Vagrant::Command::Up.new(
   [], 
   prison.construct(:ui_class => Vagrant::UI::Basic)
 ).execute
 
+#
+# Since we've configured it to destroy on exit here, sleep until someone hits
+# ^C.
+#
 begin
   sleep
 rescue Interrupt

data/lib/vagrant/prison.rb

@@ -16,6 +16,23 @@ EOF
 
 class Vagrant::Prison
   attr_reader :dir
+  # name this prison. only used for your needs to refer to later.
+  attr_accessor :name
+
+  def self.cleanup(dir, env)
+    Vagrant::Prison.new(dir, false, env).cleanup
+  end
+
+  # Prisons can't be marshalled because they contain a Vagrant::Environment,
+  # which has some properties about it that Marshal rejects. This routine takes
+  # the output of Vagrant::Prison#save and rebuilds the object.
+  def self._load(str)
+    hash = Marshal.load(str)
+    prison = new(hash[:dir], hash[:cleanup_on_exit])
+    prison.name = hash[:name]
+    prison.configure_environment(hash[:env_opts])
+    return prison
+  end
 
   #
   # Construct a new Vagrant sandbox. Takes two arguments: (the third should be
@@ -28,15 +45,33 @@ class Vagrant::Prison
   #   the program exits, or when this object is garbage collected, which ever
   #   comes first.
   #
-  def initialize(dir=nil, cleanup_on_exit=true, env=nil)
-    @dir    = dir ||= Dir.mktmpdir
-    @initial_config = nil
-    @env    = env
-    @cleanup_on_exit = cleanup_on_exit
+  def initialize(dir=nil, cleanup_on_exit=true, env_opts={})
+    @dir              = dir ||= Dir.mktmpdir
+    @initial_config   = nil
+    @env_opts         = env_opts.merge(:cwd => @dir, :ui_class => Vagrant::UI::Basic)
+    @cleanup_on_exit  = cleanup_on_exit
+    @name             = "default"
   end
 
-  def self.cleanup(dir, env)
-    Vagrant::Prison.new(dir, false, env).cleanup
+  #
+  # Return a marshalled representation of a Vagrant::Prison. This actually
+  # yields a marshalled array of the directory the prison lives in, and the
+  # options used for creating the Vagrant::Environment.
+  #
+  # This routine will raise if the environment has not been configured yet.
+  #
+
+  def _dump(level)
+    unless @env_opts
+      raise "This environment has not been configured/created! Cannot be dumped."
+    end
+
+    Marshal.dump({
+      :dir              => @dir,
+      :cleanup_on_exit  => @cleanup_on_exit,
+      :env_opts         => @env_opts,
+      :name             => @name
+    })
   end
 
   #
@@ -44,8 +79,11 @@ class Vagrant::Prison
   # the directory will be deleted.
   #
   def cleanup
-    destroy
-    FileUtils.rm_r(dir)
+    if File.directory?(dir)
+      return destroy && FileUtils.rm_r(dir)
+    end
+
+    return false
   end
 
   #
@@ -63,6 +101,13 @@ class Vagrant::Prison
     @env_opts
   end
 
+  #
+  # Returns the Vagrant::Environment, if any.
+  #
+  def env
+    @env
+  end
+
   #
   # Configures a Vagrantfile.
   #
@@ -106,8 +151,8 @@ class Vagrant::Prison
   # re-creating it.
   #
   def configure_environment(env_opts={})
-    @env_opts ||= env_opts.merge(:cwd => dir) 
-    @env ||= Vagrant::Environment.new(@env_opts)
+    @env_opts.merge!(env_opts)
+    @env = Vagrant::Environment.new(@env_opts)
   end
 
   #
@@ -120,6 +165,10 @@ class Vagrant::Prison
   # * if you set `cleanup_on_exit` in the constructor, runs `cleanup` on
   #   garbage collection of this object or program exit, which ever comes first.
   #
+  # Note, if you supplied environment options here, they will merge into the
+  # ones supplied to the constructor, before the Vagrant::Environment was
+  # created.
+  #
   def construct(env_opts={})
     FileUtils.mkdir_p(dir)
 
@@ -134,20 +183,44 @@ class Vagrant::Prison
 
     File.binwrite(File.join(dir, "Vagrantfile"), to_write)
 
-    if @cleanup_on_exit
-      # clean up after garbage collection or if the system exits
-      ObjectSpace.define_finalizer(self) do
-        Vagrant::Prison.cleanup(dir, env)
-      end
+    build_cleanup_hooks if @cleanup_on_exit
 
-      obj = self # look ma, closures
+    return @env
+  end
 
-      at_exit do
-        obj.cleanup
-      end
+  #
+  # Create the cleanup hooks that tell ruby to torch this prison on garbage
+  # collection or exit.
+  #
+  def build_cleanup_hooks
+    raise "Environment not configured!" unless @env
+
+    env = @env
+
+    # clean up after garbage collection or if the system exits
+    ObjectSpace.define_finalizer(self) do
+      Vagrant::Prison.cleanup(dir, env)
     end
 
-    return @env
+    at_exit do
+      self.cleanup
+    end
+  end
+
+  #
+  # Start or 'up' the entire prison. Convenience Method. Will also construct
+  # the environment if it is not already constructed.
+  #
+
+  def start
+    construct unless @env
+
+    Dir.chdir(dir) do
+      Vagrant::Command::Up.new([], @env).execute
+    end
+    return true
+  rescue SystemExit => e
+    return e.status == 0
   end
 
   #
@@ -155,7 +228,19 @@ class Vagrant::Prison
   # `cleanup` for a one-shot way to orchestrate that.
   #
   def destroy
-    Dir.chdir(dir)
-    Vagrant::Command::Destroy.new(%w[-f], @env).execute
+    require 'timeout'
+    Dir.chdir(dir) do
+      begin
+        Timeout.timeout(60) do
+          Vagrant::Command::Halt.new([], @env).execute rescue nil
+        end
+      rescue Timeout::Error
+        $stderr.puts "Timeout reached; forcing destroy"
+      end
+      Vagrant::Command::Destroy.new(%w[-f], @env).execute rescue nil
+    end
+    return true
+  rescue SystemExit => e
+    return e.status == 0
   end
 end

data/lib/vagrant/prison/version.rb

@@ -1,5 +1,5 @@
 module Vagrant
   class Prison
-    VERSION = "0.0.4"
+    VERSION = "0.1.0"
   end
 end

data/vagrant-prison.gemspec

@@ -10,7 +10,7 @@ Gem::Specification.new do |gem|
   gem.email         = ["erik+github@hollensbe.org"]
   gem.description   = %q{A programmatic way to configure and sandbox Vagrant}
   gem.summary       = %q{A programmatic way to configure and sandbox Vagrant}
-  gem.homepage      = ""
+  gem.homepage      = "https://github.com/chef-workflow/vagrant-prison"
 
   gem.files         = `git ls-files`.split($/)
   gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: vagrant-prison
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-11-09 00:00:00.000000000 Z
+date: 2012-12-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: vagrant
@@ -43,7 +43,7 @@ files:
 - lib/vagrant/prison/config_proxy.rb
 - lib/vagrant/prison/version.rb
 - vagrant-prison.gemspec
-homepage: ''
+homepage: https://github.com/chef-workflow/vagrant-prison
 licenses: []
 post_install_message: 
 rdoc_options: []
@@ -68,3 +68,4 @@ signing_key:
 specification_version: 3
 summary: A programmatic way to configure and sandbox Vagrant
 test_files: []
+has_rdoc: