vagrant-brightbox 0.1.0 → 0.2.0

data/CHANGELOG.md

@@ -1,4 +1,13 @@
-# 0.1.0 (unreleased)
+# 0.2.0 (April 19, 2013)
+
+* Merge from upstream 'vagrant-aws' v0.2.2
+* Ability to specify a timeout for waiting for server to build.
+* Add support for `vagrant ssh -c`
+* Better error messages if server doesn't build in time.
+* Implement `:disabled` flag support for shared folders.
+* `brightbox.user_data` to specify user data on the server.
+
+# 0.1.0 (April 15, 2013)
 
 * Exclude the ".vagrant" directory from rsync.
 * Initial release.

data/README.md

@@ -1,10 +1,10 @@
 # Vagrant Brightbox Provider
 
-This is a [Vagrant](http://www.vagrantup.com) 1.1+ plugin that adds a [Brightbox](http://brightbox.com/)
+This is a [Vagrant](http://www.vagrantup.com) 1.2+ plugin that adds a [Brightbox](http://brightbox.com/)
 provider to Vagrant, allowing Vagrant to control and provision servers in
-the Brightbox Cloud
+the Brightbox Cloud.
 
-**Note:** This plugin requires Vagrant 1.1+,
+**Note:** This plugin requires Vagrant 1.2+,
 
 ## Features
 
@@ -28,50 +28,68 @@ $ vagrant up --provider=brightbox
 ...
 ```
 
-Of course prior to doing this, you'll need to obtain an Brightbox-compatible
+Of course prior to doing this, you'll need to obtain a Brightbox-compatible
 box file for Vagrant.
 
 ## Quick Start
 
-After installing the plugin (instructions above), the quickest way to get
-started is to actually use a dummy Brightbox box and specify all the details
-manually within a `config.vm.provider` block. So first, add the dummy
-box using any name you want:
+After installing the plugin (instructions above), select the Brightbox
+Cloud image you want to use and note the id.  You can find these using
+the Brightbox CLI or the Cloud GUI in the normal way, or you can view the
+[Vagrant image page](http://docs.brightbox.com/vagrant/images).
+
+Then add your chosen box to your vagrant installation using the
+`config.vm.box` tag from your Vagrantfile, e.g.
 
 ```
-$ vagrant box add dummy https://github.com/NeilW/vagrant-brightbox/raw/master/dummy.box
-...
+$ vagrant box add precise32 http://docs.brightbox.com/vagrant/img-mvunm.box
+```
+
+If you have your `~/.fog` setup to access Brightbox then you can now
+bring up your configuration on Brightbox Cloud with:
+
 ```
+$ vagrant up --provider=brightbox
+```
+
+## Generic Setup
 
-And then make a Vagrantfile that looks like the following, filling in
-your information where necessary.
+If you don't want to be adding new box files for every type of image on
+Brightbox Cloud you can shift the configuration into the Vagrantfile by
+using the `dummy.box` Vagrant box file which has no preconfigured defaults.
+
+First add the dummy box to your vagrant installation.
+
+```
+$ vagrant box add dummy http://docs.brightbox.com/vagrant/dummy.box
+```
+
+Then make a Vagrantfile that looks like the following, filling in
+your information where necessary along with your choice of image id
 
 ```ruby
 Vagrant.configure("2") do |config|
   config.vm.box = "dummy"
 
-  config.vm.provider :brightbox do |brightbox|
+  config.vm.provider :brightbox do |brightbox, override|
     brightbox.client_id = "YOUR API CLIENT ID"
     brightbox.secret = "YOUR API SECRET"
-    brightbox.ssh_private_key_path = "PATH TO YOUR PRIVATE KEY"
 
     brightbox.image_id = "img-q6gc8"
-    brightbox.ssh_username = "ubuntu"
+
+    override.ssh.username = "ubuntu"
+    override.ssh.private_key_path = "PATH TO YOUR PRIVATE KEY"
   end
 end
 ```
 
-And then run `vagrant up --provider=brightbox`.
+Finally run `vagrant up --provider=brightbox` to build your setup on Brightbox Cloud.
 
 This will start an Ubuntu 12.04 server in the gb1 region within
 your account. And assuming your SSH information was filled in properly
 within your Vagrantfile, SSH and provisioning will work as well.
 
-Note that normally a lot of this boilerplate is encoded within the box
-file, but the box file used for the quick start, the "dummy" box, has
-no preconfigured defaults.
-
-Instead of having to add our client credentials to each Vagrantfile
+Instead of having to add your client credentials to each Vagrantfile
 we can put them in the Fog configuration file. Create a new
 file at `~/.fog` and add the following:
 
@@ -86,33 +104,42 @@ file at `~/.fog` and add the following:
 Every provider in Vagrant must introduce a custom box format. This
 provider introduces `brightbox` boxes. You can view an example box in
 the [example_box/ directory](https://github.com/NeilW/vagrant-brightbox/tree/master/example_box).
+
 That directory also contains instructions on how to build a box.
 
-The box format is basically just the required `metadata.json` file
+The box format is the required `metadata.json` file
 along with a `Vagrantfile` that does default settings for the
 provider-specific configuration for this provider.
 
+## Box Format Dowloadable Images
+
+You can view the [list of current Vagrant box
+files](http://docs.brightbox.com/vagrant) on the Brightbox documentation
+site.
+
 ## Configuration
 
 This provider exposes quite a few provider-specific configuration options:
 
-* `client_id` - The api access key for accessing Brightbox in the form 'cli-xxxxx'
+* `client_id` - The api access key for accessing Brightbox in the form
+'cli-xxxxx'
 * `secret` - The api secret access code for accessing Brightbox
 * `image_id` - The image id to boot, in the form 'img-xxxxx'
 * `zone` - The zone within the region to launch
   the server. If nil, it will use the default for this account. 
 * `server_type` - The type of server, such as "nano"
 * `region` - The region to start the server in, such as "gb1"
-* `ssh_private_key_path` - The path to the SSH private key. This overrides
-  `config.ssh.private_key_path`.
-* `ssh_username` - The SSH username, which overrides `config.ssh.username`.
 * `security_groups` - An array of security groups for the server.
+* `server_build_timeout` - The number of seconds to wait for the instance
+to become ready on Brightbox Cloud. Defaults to 120 seconds.
 
-If you are the collaborator on a number of accounts you can specify which one you want by setting the following options:
+If you are the collaborator on a number of accounts you can specify
+which one you want by setting the following options:
 
 * `username` - User id in the form 'usr-xxxxx'
 * `password` - The password for the user id
-* `account` - Create servers in the context of this account - in the form 'acc-xxxxx'
+* `account` - Create servers in the context of this account - in the form
+'acc-xxxxx'
 
 These can be set like typical provider-specific configuration:
 

data/lib/vagrant-brightbox/action.rb

@@ -108,6 +108,19 @@ module VagrantPlugins
         end
       end
 
+      def self.action_ssh_run
+        Vagrant::Action::Builder.new.tap do |b|
+	  b.use ConfigValidate
+	  b.use Call, IsCreated do |env, b2|
+	    if env[:result]
+	      b2.use SSHRun
+	    else
+	      b2.use MessageNotCreated
+	    end
+	  end
+	end
+      end
+
       def self.action_up
         Vagrant::Action::Builder.new.tap do |b|
           b.use ConfigValidate
@@ -123,7 +136,7 @@ module VagrantPlugins
 		end
 	      end
 	    else
-	      b2.use Provision
+	      b2.use TimedProvision
 	      b2.use SyncFolders
 	      b2.use CreateServer
 	      b2.use MapCloudIp
@@ -143,8 +156,6 @@ module VagrantPlugins
 	alias action_suspend action_package
       end
         
-        
-
       # The autoload farm
       action_root = Pathname.new(File.expand_path("../action", __FILE__))
       autoload :ConnectBrightbox, action_root.join("connect_brightbox")
@@ -161,6 +172,7 @@ module VagrantPlugins
       autoload :ForcedHalt, action_root.join("forced_halt")
       autoload :StartServer, action_root.join("start_server")
       autoload :Unsupported, action_root.join("unsupported")
+      autoload :TimedProvision, action_root.join("timed_provision")
     end
   end
 end

data/lib/vagrant-brightbox/action/create_server.rb

@@ -30,9 +30,11 @@ module VagrantPlugins
           server_name      = region_config.server_name
           server_type      = region_config.server_type
           server_groups    = region_config.server_groups
+	  user_data	   = region_config.user_data
 
           # Launch!
           env[:ui].info(I18n.t("vagrant_brightbox.launching_server"))
+	  env[:ui].info(I18n.t("vagrant_brightbox.supplied_user_data")) if user_data
           env[:ui].info(" -- Type: #{server_type}") if server_type
           env[:ui].info(" -- Image: #{image_id}") if image_id
           env[:ui].info(" -- Region: #{region}")
@@ -45,12 +47,11 @@ module VagrantPlugins
               :image_id           => image_id,
 	      :name		  => server_name,
               :flavor_id          => server_type,
+	      :user_data	  => user_data,
               :zone_id 		  => zone
             }
 
-            if !server_groups.empty?
-              options[:server_groups] = server_groups
-            end
+	    options[:server_groups] = server_groups unless server_groups.empty?
 
             server = env[:brightbox_compute].servers.create(options)
           rescue Excon::Errors::HTTPStatusError => e
@@ -62,14 +63,24 @@ module VagrantPlugins
 
           # Wait for the server to build
           env[:metrics]["server_build_time"] = Util::Timer.time do
+	    tries = region_config.server_build_timeout / 2
             env[:ui].info(I18n.t("vagrant_brightbox.waiting_for_build"))
-            retryable(:on => Fog::Errors::TimeoutError, :tries => 30) do
-              # If we're interrupted don't worry about waiting
-              next if env[:interrupted]
-
-              # Wait for the server to be ready
-              server.wait_for(2) { ready? }
-            end
+	    begin
+	      retryable(:on => Fog::Errors::TimeoutError, :tries => tries) do
+		# If we're interrupted don't worry about waiting
+		next if env[:interrupted]
+
+		# Wait for the server to be ready
+		server.wait_for(2) { ready? }
+	      end
+	    rescue Fog::Errors::TimeoutError
+	      # Delete the server
+	      terminate(env)
+
+	      # Notify the user
+	      raise Errors::ServerBuildTimeout,
+	        timeout: region_config.server_build_timeout
+	    end
           end
 
           @logger.info("Time for server to build: #{env[:metrics]["server_build_time"]}")

data/lib/vagrant-brightbox/action/read_ssh_info.rb

@@ -29,10 +29,6 @@ module VagrantPlugins
             return nil
           end
 
-          # Get the configuration
-          region = machine.provider_config.region
-          config = machine.provider_config.get_region_config(region)
-
 	  if use_private_network?(machine.config.vm.networks)
 	    host_name = server.fqdn
 	  elsif use_ipv6_public_network?(machine.config.vm.networks)
@@ -47,9 +43,7 @@ module VagrantPlugins
           # Read the DNS info
           return {
             :host => host_name,
-            :port => 22,
-            :private_key_path => config.ssh_private_key_path,
-            :username => config.ssh_username
+            :port => 22
           }
         end
 

data/lib/vagrant-brightbox/action/sync_folders.rb

@@ -2,12 +2,15 @@ require "log4r"
 
 require "vagrant/util/subprocess"
 
+require "vagrant/util/scoped_hash_override"
+
 module VagrantPlugins
   module Brightbox
     module Action
-      # This middleware uses `rsync` to sync the folders over to the
-      # Brightbox server.
+      # This middleware uses `rsync` to sync the folders 
       class SyncFolders
+        include Vagrant::Util::ScopedHashOverride
+
         def initialize(app, env)
           @app    = app
           @logger = Log4r::Logger.new("vagrant_brightbox::action::sync_folders")
@@ -19,6 +22,11 @@ module VagrantPlugins
           ssh_info = env[:machine].ssh_info
 
           env[:machine].config.vm.synced_folders.each do |id, data|
+            data = scoped_hash_override(data, :brightbox)
+
+            # Ignore disabled shared folders
+            next if data[:disabled]
+
             hostpath  = File.expand_path(data[:hostpath], env[:root_path])
             guestpath = data[:guestpath]
 

data/lib/vagrant-brightbox/action/timed_provision.rb

@@ -6,14 +6,14 @@ module VagrantPlugins
       # This is the same as the builtin provision except it times the
       # provisioner runs.
       class TimedProvision < Vagrant::Action::Builtin::Provision
-        def run_provisioner(env, p)
+        def run_provisioner(env, name, p)
           timer = Util::Timer.time do
             super
           end
 
           env[:metrics] ||= {}
           env[:metrics]["provisioner_times"] ||= []
-          env[:metrics]["provisioner_times"] << [p.class.to_s, timer]
+          env[:metrics]["provisioner_times"] << [name, timer]
         end
       end
     end

data/lib/vagrant-brightbox/config.rb

@@ -50,6 +50,11 @@ module VagrantPlugins
       # @return [String]
       attr_accessor :zone
 
+      # The timeout to wait for a server to become ready
+      #
+      # @return [Fixnum]
+      attr_accessor :server_build_timeout
+
       # The type of server to launch, such as "nano"
       #
       # @return [String]
@@ -71,17 +76,10 @@ module VagrantPlugins
       # @return [Array<String>]
       attr_accessor :server_groups
 
-      # The path to the SSH private key to use with this server.
-      # This overrides the `config.ssh.private_key_path` variable.
-      #
-      # @return [String]
-      attr_accessor :ssh_private_key_path
-
-      # The SSH username to use with this server. This overrides
-      # the `config.ssh.username` variable.
+      # The user data string
       #
       # @return [String]
-      attr_accessor :ssh_username
+      attr_accessor :user_data
 
       def initialize(region_specific=false)
         @client_id      = UNSET_VALUE
@@ -93,12 +91,12 @@ module VagrantPlugins
         @account  = UNSET_VALUE
         @image_id                = UNSET_VALUE
         @zone  = UNSET_VALUE
+	@server_build_timeout = UNSET_VALUE
         @server_type      = UNSET_VALUE
 	@server_name	  = UNSET_VALUE
         @region             = UNSET_VALUE
         @server_groups    = UNSET_VALUE
-        @ssh_private_key_path = UNSET_VALUE
-        @ssh_username       = UNSET_VALUE
+	@user_data	    = UNSET_VALUE
 
         # Internal state (prefix with __ so they aren't automatically
         # merged)
@@ -184,11 +182,11 @@ module VagrantPlugins
         @server_name = nil if @server_name == UNSET_VALUE
         @zone = nil if @zone == UNSET_VALUE
 
+	# User data is nil by default
+	@user_data = nil if @user_data == UNSET_VALUE
 
-        # The SSH values by default are nil, and the top-level config
-        # `config.ssh` values are used.
-        @ssh_private_key_path = nil if @ssh_private_key_path == UNSET_VALUE
-        @ssh_username = nil if @ssh_username == UNSET_VALUE
+	# The default timeout is 120 seconds
+	@server_build_timeout = 120 if @server_build_timeout == UNSET_VALUE
 
         # Compile our region specific configurations only within
         # NON-REGION-SPECIFIC configurations.
@@ -216,7 +214,7 @@ module VagrantPlugins
       end
 
       def validate(machine)
-        errors = []
+        errors = _detected_errors
 
         errors << I18n.t("vagrant_brightbox.config.region_required") if @region.nil?
 
@@ -235,10 +233,6 @@ module VagrantPlugins
 	      config.secret.nil?
 	  end
 
-          if config.ssh_private_key_path && \
-            !File.file?(File.expand_path(config.ssh_private_key_path, machine.env.root_path))
-            errors << I18n.t("vagrant_brightbox.config.private_key_missing")
-          end
         end
 
         { "Brightbox Provider" => errors }

data/lib/vagrant-brightbox/errors.rb

@@ -26,6 +26,10 @@ module VagrantPlugins
         error_key(:fog_error)
       end
 
+      class ServerBuildTimeout < VagrantBrightboxError
+        error_key(:server_build_timeout)
+      end
+
       class RsyncError < VagrantBrightboxError
         error_key(:rsync_error)
       end

data/lib/vagrant-brightbox/plugin.rb

@@ -6,8 +6,8 @@ end
 
 # This is a sanity check to make sure no one is attempting to install
 # this into an early Vagrant version.
-if Vagrant::VERSION < "1.1.0"
-  raise "The Vagrant Brightbox plugin is only compatible with Vagrant 1.1+"
+if Vagrant::VERSION < "1.2.0"
+  raise "The Vagrant Brightbox plugin is only compatible with Vagrant 1.2+"
 end
 
 module VagrantPlugins

data/lib/vagrant-brightbox/version.rb

@@ -1,5 +1,5 @@
 module VagrantPlugins
   module Brightbox
-    VERSION = "0.1.0"
+    VERSION = "0.2.0"
   end
 end

data/locales/en.yml

@@ -7,7 +7,9 @@ en:
     finding_image: |-
       Finding image for server...
     launching_server: |-
-      Launching a server with the following settings...
+      Launching a server with the following settings
+    supplied_user_data: |-
+      using supplied user_data string
     not_created: |-
       The server hasn't been created yet. Run `vagrant up` first.
     ready: |-
@@ -60,6 +62,12 @@ en:
         message is shown below:
 
         %{message}
+      server_build_timeout: |-
+        The server never became available on Brightbox Cloud. The timeout
+        currently set waiting for the server to build is %{timeout}
+        seconds. Please verify that the server properly boots. If you
+        need more time set the `server_build_timeout` configuration in
+        the Brightbox provider.
       rsync_error: |-
         There was an error when attemping to rsync a share folder.
         Please inspect the error message below for more info.

data/spec/vagrant-brightbox/config_spec.rb

@@ -22,20 +22,19 @@ describe VagrantPlugins::Brightbox::Config do
     # Server
     its("image_id")               { should be_nil }
     its("zone") { should be_nil }
+    its("server_build_timeout") { should == 120 }
     its("server_type")     { should be_nil }
     its("server_name")     { should be_nil }
     its("region")            { should == "gb1" }
     its("server_groups")   { should == [] }
+    its("user_data")	   { should be nil }
 
-    # Access
-    its("ssh_private_key_path") { should be_nil }
-    its("ssh_username")      { should be_nil }
   end
 
   describe "overriding defaults" do
     [:client_id, :secret, :auth_url, :api_url, :username, :password, :account,
-     :image_id, :zone, :server_type, :server_name, :region, :server_groups,
-      :ssh_private_key_path, :ssh_username].each do |attribute|
+     :image_id, :zone, :server_build_timeout, :server_type, :server_name,
+     :region, :server_groups, :user_data].each do |attribute|
 
       it "should not default #{attribute} if overridden" do
         instance.send("#{attribute}=".to_sym, "foo")
@@ -60,6 +59,7 @@ describe VagrantPlugins::Brightbox::Config do
     let(:config_server_groups)     { ["foo", "bar"] }
     let(:config_zone)     { "foo" }
     let(:config_region)            { "foo" }
+    let(:config_user_data)  { "user_data" }
 
     def set_test_values(instance)
       instance.client_id       = config_client_id
@@ -76,6 +76,7 @@ describe VagrantPlugins::Brightbox::Config do
       instance.region          = config_region
       instance.zone	       = config_zone
       instance.server_groups   = config_server_groups
+      instance.user_data       = config_user_data
     end
 
     it "should raise an exception if not finalized" do
@@ -109,6 +110,7 @@ describe VagrantPlugins::Brightbox::Config do
       its("region")            { should == config_region }
       its("zone")            { should == config_zone }
       its("server_groups")            { should == config_server_groups }
+      its("user_data")       { should == config_user_data }
     end
 
     context "with a specific config set" do
@@ -140,6 +142,7 @@ describe VagrantPlugins::Brightbox::Config do
       its("server_type")     { should == config_server_type }
       its("zone")            { should == config_zone }
       its("server_groups")            { should == config_server_groups }
+      its("user_data")       { should == config_user_data }
     end
 
     describe "inheritance of parent config" do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: vagrant-brightbox
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
   prerelease: 
 platform: ruby
 authors:
@@ -10,11 +10,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-04-05 00:00:00.000000000 Z
+date: 2013-04-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: fog
-  requirement: &17243720 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -22,10 +22,15 @@ dependencies:
         version: 1.10.0
   type: :runtime
   prerelease: false
-  version_requirements: *17243720
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.10.0
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &17241820 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -33,10 +38,15 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *17241820
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &17277700 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -44,7 +54,12 @@ dependencies:
         version: 2.13.0
   type: :development
   prerelease: false
-  version_requirements: *17277700
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.13.0
 description: Enables Vagrant to manage servers in Brightbox Cloud.
 email:
 - neil@aldur.co.uk
@@ -59,7 +74,6 @@ files:
 - README.md
 - Rakefile
 - Vagrantfile.example
-- dummy.box
 - example_box/README.md
 - example_box/metadata.json
 - lib/vagrant-brightbox.rb
@@ -102,7 +116,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 2290728058853834092
+      hash: -4267484700850995720
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -111,10 +125,10 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 2290728058853834092
+      hash: -4267484700850995720
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.11
+rubygems_version: 1.8.23
 signing_key: 
 specification_version: 3
 summary: Enables Vagrant to manage servers in Brightbox Cloud.