furnish-vagrant 0.0.3 → 0.1.0

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    YTVhMzE5YTgzNzdmMzMxMGQ3OTY3MjllMjdiMTI2YTFlODI5N2JhZA==
+  data.tar.gz: !binary |-
+    MjBkNTAwMWFjYjE5MTcxMjQyY2FhZjc5NTNlOTFjNTIwN2IyYjZiZg==
+!binary "U0hBNTEy":
+  metadata.gz: !binary |-
+    ZmEwYTNlODUxNTljNjFmZGIxYTE4N2ZhOTNiZDQyMjA1ZTFiOTI3NTEwM2Rj
+    YzlmOGY5YjQzYzM2MzJiYzBiMTg2MmYwMzFhMjRhNzM3MjRjZTJhMTk0NmU3
+    YzAxZGIxZWI2MmQzZWNkOWQwMTMyYzhjNWQ2YWM1Y2IzMDUwZDY=
+  data.tar.gz: !binary |-
+    YjdmY2QxODY4ODU5MzVjYzFkZTBmODgwN2MyNTQ2Mjg3ZWU5MzgxZGFjMmU3
+    Y2JmYjE5NzNhZDM3YjEyZTkwNThhMWUwMzZkOTI2OTRlNTc3MTc2MzZiZTE4
+    NGU1NThlN2JjNGVkYmI2NzU5OTJjNzA3Y2YwYzQ3OWUyYjk3MjE=

data/CHANGELOG.md

@@ -1,3 +1,6 @@
+* 0.1.0 (04/10/2013)
+  * Update provisioner to use furnish 0.1.0 and Furnish::Provisioner::API.
+  * Ensure function on ruby 2.0.
 * 0.0.3 (03/25/2013)
   * Update dependency to vagrant-prison 0.2.0.
 * 0.0.2 (03/25/2013)

data/Gemfile

@@ -2,5 +2,3 @@ source 'https://rubygems.org'
 
 # Specify your gem's dependencies in furnish-vagrant.gemspec
 gemspec
-
-gem 'guard-rake', :git => "https://github.com/erikh/guard-rake", :branch => "failure_ok"

data/Guardfile

@@ -5,6 +5,6 @@ guard 'minitest' do
   watch(%r!^test/helper\.rb!) { "test" }
 end
 
-guard 'rake', :failure_ok => true, :run_on_all => false, :task => 'rdoc_cov' do
+guard 'rake', :run_on_all => false, :task => 'rdoc_cov' do
   watch(%r!^lib/(.*)([^/]+)\.rb!)
 end

data/furnish-vagrant.gemspec

@@ -18,13 +18,13 @@ Gem::Specification.new do |gem|
   gem.require_paths = ["lib"]
 
   gem.add_dependency 'vagrant-prison',  '~> 0.2.0'
-  gem.add_dependency 'furnish',         '~> 0.0.4'
+  gem.add_dependency 'furnish',         '~> 0.1.0'
 
-  gem.add_development_dependency 'furnish-ip', '~> 0.0.3'
+  gem.add_development_dependency 'furnish-ip', '~> 0.1.0'
   gem.add_development_dependency 'rake'
   gem.add_development_dependency 'minitest', '~> 4.5.0'
   gem.add_development_dependency 'guard-minitest'
-  gem.add_development_dependency 'guard-rake'
+  gem.add_development_dependency 'guard-rake', '~> 0.0.8'
   gem.add_development_dependency 'rdoc', '~> 4'
   gem.add_development_dependency 'rb-fsevent'
   gem.add_development_dependency 'simplecov'

data/lib/furnish/provisioners/vagrant.rb

@@ -1,5 +1,7 @@
 require 'vagrant/prison'
 require 'furnish/vagrant/ui'
+require 'furnish/provisioners/api'
+require 'set'
 
 module Furnish # :nodoc:
   module Provisioner # :nodoc:
@@ -20,17 +22,82 @@ module Furnish # :nodoc:
     # See Furnish::IP (furnish-ip) gem for a provisioner which can be used to
     # deal with IP allocation and vagrant.
     #
-    class Vagrant
-      # Furnish provisioner requirement; name of Furnish::ProvisionerGroup
-      attr_accessor :name
+    class Vagrant < API
+      ##
+      # :attr: box_url
+      #
+      # Specifies vagrant's box_url. If specified, and #box is not, #box will
+      # be extracted from this value.
+      #
+      # Boxes will be downloaded on demand if they do not already exist.
+      #
+      furnish_property :box_url,
+        "Vagrant's box_url argument",
+        String
 
-      # Vagrant's box_url argument. box will be coerced from this if it is not
-      # supplied.
-      attr_accessor :box_url
+      ##
+      # :attr: box
+      #
+      # Specified a vagrant box name. Will be used for all VMs, will be used
+      # from #box_url if unset.
+      #
+      furnish_property :box,
+        "Vagrant's box argument. Will be extracted from box_url if unset.",
+        String
 
-      # Vagrant's box argument. if not supplied, will come from box_url. One of
-      # box or box_url must exist for provisioning to succeed.
-      attr_accessor :box
+      ##
+      # :attr: number_of_servers
+      #
+      # The integer number of boxes to bring up for this provision.
+      #
+      # Takes a list of IPs from a previous provisioner's :ips result. This
+      # :ips does not yield a count that matches this number, provisioning will
+      # fail.
+      furnish_property :number_of_servers,
+        "The number of boxes to bring up for this provision",
+        Integer
+
+      ##
+      # :attr: db_name
+      #
+      # A tag that namespaces the VMs provisioned here.
+      #
+      # The default is "default".
+      furnish_property :db_name,
+        "'default' by default, a tag namespacing this set of provisions",
+        String
+
+      ##
+      # :attr: customizations
+      #
+      # An array of strings, or array of array of strings, which are passed to
+      # vagrant's vm.customize for each block. These are usually parameters
+      # passed directly to VBoxManage.
+      #
+      # Example:
+      #
+      #     # one customization
+      #     Furnish::Provisioners::Vagrant.new(
+      #       :customizations => ["modifyvm", :id, "--memory", 1024]
+      #     )
+      #
+      #     # multiple customizations
+      #     Furnish::Provisioners::Vagrant.new(
+      #       :customizations => [
+      #         [ "modifyvm", :id, "--memory", 1024 ]
+      #         [ "modifyvm", :id, "--cpus", 4 ]
+      #       ]
+      #     )
+      #
+      furnish_property :customizations,
+        "an array of arguments that would go to vm.customize. If an array of arrays are supplied, vm.customize is called for each inner array with it as the argument.",
+        Array
+
+      configure_startup do
+        requires :ips, "A set of IP addresses to use for the host-only networks.", Set
+      end
+
+      configure_shutdown { accepts_from_any true }
 
       #
       # Construct a new vagrant provisioner -- takes a hash of arguments.
@@ -43,13 +110,7 @@ module Furnish # :nodoc:
       # * :customziations - an array of arguments that would go to vm.customize. If an array of arrays are supplied, vm.customize is called for each inner array with it as the argument.
       #
       def initialize(args)
-        unless args.kind_of?(Hash)
-          raise ArgumentError, "arguments must be a hash"
-        end
-
-        args.each do |k,v|
-          instance_variable_set("@#{k}", v)
-        end
+        super
 
         normalize_box_args
         normalize_customizations
@@ -63,13 +124,13 @@ module Furnish # :nodoc:
       # Helper method to structure supplied customizations.
       #
       def normalize_customizations
-        if @customizations
-          unless @customizations.kind_of?(Array)
+        if customizations
+          unless customizations.kind_of?(Array)
             raise ArgumentError, "customizations must be an array of customizations, or array of array of multiple customizations."
           end
 
-          unless @customizations.all? { |x| x.kind_of?(Array) }
-            @customizations = [@customizations]
+          unless customizations.all? { |x| x.kind_of?(Array) }
+            @customizations = [customizations]
           end
         end
       end
@@ -78,71 +139,71 @@ module Furnish # :nodoc:
       # Helper method to coerce box and box_url into something normal.
       #
       def normalize_box_args
-        if @box_url
-          @box = File.basename(@box_url).gsub(/\.box$/, '')
+        if box_url
+          @box = File.basename(box_url).gsub(/\.box$/, '')
         end
 
-        unless @box
+        unless box
           raise ArgumentError, "#{self.class} must be configured with a box or box_url."
         end
       end
 
       #
-      # Provision with vagrant. Expects a list of IP addresses used as its
+      # Provision with vagrant. Expects a set of IP addresses used as its
       # arguments.
       #
-      # During provisioning, the startup method is expected to get a list of IP
-      # addresses to configure vagrant's boxes with as a part of a host-only
-      # network. If the number of servers and the number of IP addresses received
-      # are not equal, provisioning will fail.
+      # During provisioning, the startup method is expected to get a set of IP
+      # addresses via :ips to configure vagrant's boxes with as a part of a
+      # host-only network. If the number of servers and the number of IP
+      # addresses received are not equal, provisioning will fail.
       #
-      def startup(*args)
-        ips = args.first
+      def startup(args={})
+        ips = args[:ips]
 
-        if ips.count != @number_of_servers
+        if ips.count != number_of_servers
           raise "The number of requested IP addresses does not match the number of requested servers"
         end
 
         @prison = ::Vagrant::Prison.new(Dir.mktmpdir, false)
 
-        @prison.name = name
+        @prison.name = furnish_group_name
 
         @prison.configure do |config|
-          config.vm.box_url = @box_url
-          config.vm.box = @box
+          config.vm.box_url = box_url
+          config.vm.box = box
 
-          if @customizations
-            @customizations.each { |c| config.vm.customize c }
+          if customizations
+            customizations.each { |c| config.vm.customize c }
           end
 
           ips.each_with_index do |ip, x|
-            config.vm.define "#{name}-#{x}" do |this_config|
+            config.vm.define "#{furnish_group_name}-#{x}" do |this_config|
               this_config.vm.network :hostonly, ip
             end
           end
         end
 
         @prison.construct(:ui_class => Furnish::Vagrant::UI)
-        @db[name] = @prison # eager save in case start has issues
+        @db[furnish_group_name] = @prison # eager save in case start has issues
 
-        return @prison.start ? ips : false
+        return @prison.start ? { } : false
       ensure
-        @db[name] = @prison
+        @db[furnish_group_name] = @prison
       end
 
       #
       # Deprovision with Vagrant.
       #
-      def shutdown
-        @prison ||= @db[name]
+      def shutdown(args={})
+        @prison ||= @db[furnish_group_name]
 
         if @prison
           @prison.configure_environment(:ui_class => Furnish::Vagrant::UI)
           @prison.cleanup
         end
 
-        @db.delete(name)
-        return true
+        @db.delete(furnish_group_name)
+        return { }
       end
 
       #
@@ -150,7 +211,7 @@ module Furnish # :nodoc:
       # prison directory used for this provision.
       #
       def report
-        ["#{@number_of_servers} servers; prison dir: #{@prison.dir}"]
+        ["#{number_of_servers} servers", "prison dir: #{@prison.dir || "unprovisioned"}"]
       end
     end
   end

data/lib/furnish/vagrant/version.rb

@@ -1,6 +1,6 @@
 module Furnish
   module Vagrant
     # The version of furnish-vagrant.
-    VERSION = '0.0.3'
+    VERSION = '0.1.0'
   end
 end

data/test/test_vagrant.rb

@@ -16,6 +16,7 @@ class TestVagrant < Furnish::TestCase
     Furnish::Vagrant::UI.debug_level = 0
 
     @sched = Furnish::Scheduler.new
+    @klass = Furnish::Provisioner::Vagrant
     sched.serial = true
     setup_ip
   end
@@ -58,10 +59,14 @@ class TestVagrant < Furnish::TestCase
     @ip.allocate("10.10.10.1")
   end
 
+  def make_auto_ip(num, ip=@ip)
+    Furnish::Provisioner::AutoIP.new(:ip => ip, :number_of_addresses => num)
+  end
+
   def make_provisioner(num=1)
     [
-      Furnish::Provisioner::AutoIP.new(@ip, num),
-      Furnish::Provisioner::Vagrant.new(
+      make_auto_ip(num),
+      @klass.new(
         :box_url            => BOX_URL,
         :number_of_servers  => num
       )
@@ -70,35 +75,86 @@ class TestVagrant < Furnish::TestCase
 
   def test_constructor
     assert_raises(ArgumentError, "arguments must be a hash") do
-      Furnish::Provisioner::Vagrant.new(nil)
+      @klass.new(nil)
     end
 
     assert_raises(ArgumentError, "Furnish::Provisioner::Vagrant must be configured with a box or box_url") do
-      Furnish::Provisioner::Vagrant.new({})
+      @klass.new({})
     end
 
-    assert(Furnish::Provisioner::Vagrant.new(:box_url => BOX_URL))
-    assert(Furnish::Provisioner::Vagrant.new(:box => "precise64"))
+    assert(@klass.new(:box_url => BOX_URL))
+    assert(@klass.new(:box => "precise64"))
 
     assert_raises(ArgumentError, "customizations must be an array of customizations, or array of array of multiple customizations.") do
-      Furnish::Provisioner::Vagrant.new(:box_url => BOX_URL, :customizations => 1)
+      @klass.new(:box_url => BOX_URL, :customizations => 1)
     end
 
     assert(
-      Furnish::Provisioner::Vagrant.new(
+      @klass.new(
         :box_url => BOX_URL,
         :customizations => %w[one two three]
       )
     )
 
     assert(
-      Furnish::Provisioner::Vagrant.new(
+      @klass.new(
         :box_url => BOX_URL,
         :customizations => [%w[one two three], %w[four five six]]
       )
     )
   end
 
+  def test_properties
+    assert_equal(
+      {
+        :box_url => {
+          :description => "Vagrant's box_url argument",
+          :type => String
+        },
+
+        :box => {
+          :description => "Vagrant's box argument. Will be extracted from box_url if unset.",
+          :type => String
+        },
+
+        :number_of_servers => {
+          :description => "The number of boxes to bring up for this provision",
+          :type => Integer
+        },
+
+        :db_name => {
+          :description => "'default' by default, a tag namespacing this set of provisions",
+          :type => String
+        },
+
+        :customizations => {
+          :description => "an array of arguments that would go to vm.customize. If an array of arrays are supplied, vm.customize is called for each inner array with it as the argument.",
+          :type => Array
+        }
+      },
+      @klass.furnish_properties
+    )
+  end
+
+  def test_protocol
+    assert_equal(
+      {
+        :ips => {
+          :description => "A set of IP addresses to use for the host-only networks.",
+          :type => Set
+        }
+      },
+      @klass.startup_protocol[:requires]
+    )
+
+    assert_empty(@klass.startup_protocol[:accepts])
+    assert_empty(@klass.startup_protocol[:yields])
+    assert_empty(@klass.shutdown_protocol[:accepts])
+    assert_empty(@klass.shutdown_protocol[:yields])
+    assert_empty(@klass.shutdown_protocol[:requires])
+    assert(@klass.shutdown_protocol[:accepts_from_any])
+  end
+
   def test_basic_provision
     sched.schedule_provision('test1', make_provisioner, [])
     sched.run
@@ -118,22 +174,34 @@ class TestVagrant < Furnish::TestCase
     assert_equal(3, @ip.group_ips('test2').count, '3 machines and IPs were allocated for test2 group')
 
     assert_match(
-      /^1 servers; prison dir: /,
+      /^1 servers/,
       sched.vm.groups['test1'].last.report.first,
       "report reflects number of servers provisioned for group test1"
     )
 
     assert_match(
-      /^3 servers; prison dir: /,
+      /^prison dir:/,
+      sched.vm.groups['test1'].last.report.last,
+      "second report reflects prison dir for group test1"
+    )
+
+    assert_match(
+      /^3 servers/,
       sched.vm.groups['test2'].last.report.first,
       "report reflects number of servers provisioned for group test2"
     )
+
+    assert_match(
+      /^prison dir:/,
+      sched.vm.groups['test2'].last.report.last,
+      "second report reflects prison dir for group test2"
+    )
   end
 
   def test_invalid_provision
     mismatched_num = [
-      Furnish::Provisioner::AutoIP.new(@ip, 1),
-      Furnish::Provisioner::Vagrant.new(
+      make_auto_ip(1),
+      @klass.new(
         :box_url            => BOX_URL,
         :number_of_servers  => 3
       )
@@ -149,8 +217,8 @@ class TestVagrant < Furnish::TestCase
 
   def test_customized_provision
     customized = [
-      Furnish::Provisioner::AutoIP.new(@ip, 1),
-      Furnish::Provisioner::Vagrant.new(
+      make_auto_ip(1),
+      @klass.new(
         :box_url            => BOX_URL,
         :number_of_servers  => 1,
         :customizations     => [["modifyvm", :id, "--memory", 1024]]

metadata

@@ -1,20 +1,18 @@
 --- !ruby/object:Gem::Specification
 name: furnish-vagrant
 version: !ruby/object:Gem::Version
-  version: 0.0.3
-  prerelease: 
+  version: 0.1.0
 platform: ruby
 authors:
 - Erik Hollensbe
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-03-26 00:00:00.000000000 Z
+date: 2013-04-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: vagrant-prison
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -22,7 +20,6 @@ dependencies:
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -30,39 +27,34 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: furnish
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 0.0.4
+        version: 0.1.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 0.0.4
+        version: 0.1.0
 - !ruby/object:Gem::Dependency
   name: furnish-ip
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 0.0.3
+        version: 0.1.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 0.0.3
+        version: 0.1.0
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -70,7 +62,6 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -78,7 +69,6 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -86,7 +76,6 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -94,7 +83,6 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: guard-minitest
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -102,7 +90,6 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -110,23 +97,20 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: guard-rake
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.0.8
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.0.8
 - !ruby/object:Gem::Dependency
   name: rdoc
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -134,7 +118,6 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -142,7 +125,6 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: rb-fsevent
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -150,7 +132,6 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -158,7 +139,6 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -166,7 +146,6 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -174,7 +153,6 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: net-ssh
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -182,7 +160,6 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -209,33 +186,26 @@ files:
 - test/test_vagrant.rb
 homepage: https://github.com/chef-workflow/furnish-vagrant
 licenses: []
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: 1570501891906116783
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: 1570501891906116783
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.25
+rubygems_version: 2.0.3
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Furnish -> Vagrant 1.0.x bridge
 test_files:
 - test/helper.rb