vagrant-brightbox 0.1.0

data/lib/vagrant-brightbox/config.rb

@@ -0,0 +1,268 @@
+require "vagrant"
+
+module VagrantPlugins
+  module Brightbox
+    class Config < Vagrant.plugin("2", :config)
+      # The API Client ID for accessing Brightbox.
+      #
+      # @return [String]
+      attr_accessor :client_id
+
+      # The secret access key for accessing Brightbox.
+      #
+      # @return [String]
+      attr_accessor :secret
+
+      # The URL to use as the API endpoint
+      #
+      # @return [String]
+      attr_accessor :api_url
+
+      # The URL to use as the API authentication endpoint
+      #
+      # @return [String]
+      attr_accessor :auth_url
+
+      # Email or user id for user based authentication
+      #
+      # @return [String]
+      attr_accessor :username
+
+      # Password for user based authentication
+      #
+      # @return [String]
+      attr_accessor :password
+
+      # The account id of the account on which operations should be performed
+      # 
+      # @return [String]
+      attr_accessor :account
+
+
+      # The ID of the Image to use.
+      #
+      # @return [String]
+      attr_accessor :image_id
+
+      # The zone to launch the server into. If nil, it will
+      # use the default for your account.
+      #
+      # @return [String]
+      attr_accessor :zone
+
+      # The type of server to launch, such as "nano"
+      #
+      # @return [String]
+      attr_accessor :server_type
+
+      # The name of the server. This defaults to the name of the machine
+      # defined by Vagrant (via `config.vm.define`), but can be overriden
+      # here.
+      attr_accessor :server_name
+
+      # The name of the Brightbox region in which to create the server.
+      #
+      # @return [String]
+      attr_accessor :region
+
+      # The server groups to set on the server. This must
+      # be a list of group IDs.
+      #
+      # @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.
+      #
+      # @return [String]
+      attr_accessor :ssh_username
+
+      def initialize(region_specific=false)
+        @client_id      = UNSET_VALUE
+        @secret  = UNSET_VALUE
+        @api_url  = UNSET_VALUE
+        @auth_url  = UNSET_VALUE
+        @username  = UNSET_VALUE
+        @password  = UNSET_VALUE
+        @account  = UNSET_VALUE
+        @image_id                = UNSET_VALUE
+        @zone  = 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
+
+        # Internal state (prefix with __ so they aren't automatically
+        # merged)
+        @__compiled_region_configs = {}
+        @__finalized = false
+        @__region_config = {}
+        @__region_specific = region_specific
+      end
+
+      # Allows region-specific overrides of any of the settings on this
+      # configuration object. This allows the user to override things like
+      # Image and keypair name for regions. Example:
+      #
+      #     brightbox.region_config "gb1" do |region|
+      #       region.image_id = "img-umqoe"
+      #     end
+      #
+      # @param [String] region The region name to configure.
+      # @param [Hash] attributes Direct attributes to set on the configuration
+      #   as a shortcut instead of specifying a full block.
+      # @yield [config] Yields a new Brightbox configuration.
+      def region_config(region, attributes=nil, &block)
+        # Append the block to the list of region configs for that region.
+        # We'll evaluate these upon finalization.
+        @__region_config[region] ||= []
+
+        # Append a block that sets attributes if we got one
+        if attributes
+          attr_block = lambda do |config|
+            config.set_options(attributes)
+          end
+
+          @__region_config[region] << attr_block
+        end
+
+        # Append a block if we got one
+        @__region_config[region] << block if block_given?
+      end
+
+      #-------------------------------------------------------------------
+      # Internal methods.
+      #-------------------------------------------------------------------
+
+      def merge(other)
+        super.tap do |result|
+          # Copy over the region specific flag. "True" is retained if either
+          # has it.
+          new_region_specific = other.instance_variable_get(:@__region_specific)
+          result.instance_variable_set(
+            :@__region_specific, new_region_specific || @__region_specific)
+
+          # Go through all the region configs and prepend ours onto
+          # theirs.
+          new_region_config = other.instance_variable_get(:@__region_config)
+          @__region_config.each do |key, value|
+            new_region_config[key] ||= []
+            new_region_config[key] = value + new_region_config[key]
+          end
+
+          # Set it
+          result.instance_variable_set(:@__region_config, new_region_config)
+
+        end
+      end
+
+      def finalize!
+        # Default region is UK gb1. Because that's all there is at the moment!
+        @region = "gb1" if @region == UNSET_VALUE
+
+        # The server groups are empty by default.
+        @server_groups = [] if @server_groups == UNSET_VALUE
+
+        # Everything defaults to nil
+        @client_id     = nil if @client_id     == UNSET_VALUE
+        @secret = nil if @secret == UNSET_VALUE
+        @auth_url = nil if @auth_url == UNSET_VALUE
+        @api_url = nil if @api_url == UNSET_VALUE
+        @username = nil if @username == UNSET_VALUE
+        @password = nil if @password == UNSET_VALUE
+        @account = nil if @account == UNSET_VALUE
+        @image_id = nil if @image_id == UNSET_VALUE
+        @server_type = nil if @server_type == UNSET_VALUE
+        @server_name = nil if @server_name == UNSET_VALUE
+        @zone = nil if @zone == 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
+
+        # Compile our region specific configurations only within
+        # NON-REGION-SPECIFIC configurations.
+        if !@__region_specific
+          @__region_config.each do |region, blocks|
+            config = self.class.new(true).merge(self)
+
+            # Execute the configuration for each block
+            blocks.each { |b| b.call(config) }
+
+            # The region name of the configuration always equals the
+            # region config name:
+            config.region = region
+
+            # Finalize the configuration
+            config.finalize!
+
+            # Store it for retrieval
+            @__compiled_region_configs[region] = config
+          end
+        end
+
+        # Mark that we finalized
+        @__finalized = true
+      end
+
+      def validate(machine)
+        errors = []
+
+        errors << I18n.t("vagrant_brightbox.config.region_required") if @region.nil?
+
+	errors << I18n.t("vagrant_brightbox.config.region_invalid") unless valid_region?
+
+        if @region && valid_region?
+          # Get the configuration for the region we're using and validate only
+          # that region.
+          config = get_region_config(@region)
+
+	  # Secret could be in fog config file. 
+	  unless fog_config_file_exists?
+	    errors << I18n.t("vagrant_brightbox.config.client_id_required") if \
+	      config.client_id.nil?
+	    errors << I18n.t("vagrant_brightbox.config.secret_required") if \
+	      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 }
+      end
+
+      def fog_config_file_exists?
+        File.file?(File.join(ENV['HOME'], '.fog'))
+      end
+
+      def valid_region?
+        return false unless @region =~ /gb1/
+	@region == 'gb1' || !(@auth_url.nil? || @api_url.nil?)
+      end
+
+      # This gets the configuration for a specific region. It shouldn't
+      # be called by the general public and is only used internally.
+      def get_region_config(name)
+        if !@__finalized
+          raise "Configuration must be finalized before calling this method."
+        end
+
+        # Return the compiled region config
+        @__compiled_region_configs[name] || self
+      end
+    end
+  end
+end

data/lib/vagrant-brightbox/errors.rb

@@ -0,0 +1,34 @@
+require "vagrant"
+
+module VagrantPlugins
+  module Brightbox
+    module Errors
+      class VagrantBrightboxError < Vagrant::Errors::VagrantError
+        error_namespace("vagrant_brightbox.errors")
+      end
+
+      class FogError < VagrantBrightboxError
+        def initialize(message = nil, *args)
+	  if message.is_a?(Hash)
+	    target = message[:message]
+	    if target.respond_to?(:body)
+	      puts target.body.inspect
+	      decode = Fog::JSON.decode(target.body)
+	      if decode["errors"] 
+		message[:message] = decode["error_name"]+":\n"+decode["errors"].join("\n")
+	      elsif decode["error_description"]
+	        message[:message] = decode["error"] + ": " + decode["error_description"]
+	      end
+	    end
+	  end
+	  super
+	end
+        error_key(:fog_error)
+      end
+
+      class RsyncError < VagrantBrightboxError
+        error_key(:rsync_error)
+      end
+    end
+  end
+end

data/lib/vagrant-brightbox/plugin.rb

@@ -0,0 +1,73 @@
+begin
+  require "vagrant"
+rescue LoadError
+  raise "The Vagrant Brightbox plugin must be run within Vagrant."
+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+"
+end
+
+module VagrantPlugins
+  module Brightbox
+    class Plugin < Vagrant.plugin("2")
+      name "Brightbox"
+      description <<-DESC
+      This plugin installs a provider that allows Vagrant to manage
+      servers in the Brightbox Cloud
+      DESC
+
+      config(:brightbox, :provider) do
+        require_relative "config"
+        Config
+      end
+
+      provider(:brightbox) do
+        # Setup logging and i18n
+        setup_logging
+        setup_i18n
+
+        # Return the provider
+        require_relative "provider"
+        Provider
+      end
+
+      # This initializes the internationalization strings.
+      def self.setup_i18n
+        I18n.load_path << File.expand_path("locales/en.yml", Brightbox.source_root)
+        I18n.reload!
+      end
+
+      # This sets up our log level to be whatever VAGRANT_LOG is.
+      def self.setup_logging
+        require "log4r"
+
+        level = nil
+        begin
+          level = Log4r.const_get(ENV["VAGRANT_LOG"].upcase)
+        rescue NameError
+          # This means that the logging constant wasn't found,
+          # which is fine. We just keep `level` as `nil`. But
+          # we tell the user.
+          level = nil
+        end
+
+        # Some constants, such as "true" resolve to booleans, so the
+        # above error checking doesn't catch it. This will check to make
+        # sure that the log level is an integer, as Log4r requires.
+        level = nil if !level.is_a?(Integer)
+
+        # Set the logging level on all "vagrant" namespaced
+        # logs as long as we have a valid level.
+        if level
+          logger = Log4r::Logger.new("vagrant_brightbox")
+          logger.outputters = Log4r::Outputter.stderr
+          logger.level = level
+          logger = nil
+        end
+      end
+    end
+  end
+end

data/lib/vagrant-brightbox/provider.rb

@@ -0,0 +1,50 @@
+require "log4r"
+require "vagrant"
+
+module VagrantPlugins
+  module Brightbox
+    class Provider < Vagrant.plugin("2", :provider)
+      def initialize(machine)
+        @machine = machine
+      end
+
+      def action(name)
+        # Attempt to get the action method from the Action class if it
+        # exists, otherwise return nil to show that we don't support the
+        # given action.
+        action_method = "action_#{name}"
+        return Action.send(action_method) if Action.respond_to?(action_method)
+        nil
+      end
+
+      def ssh_info
+        # Run a custom action called "read_ssh_info" which does what it
+        # says and puts the resulting SSH info into the `:machine_ssh_info`
+        # key in the environment.
+        env = @machine.action("read_ssh_info")
+        env[:machine_ssh_info]
+      end
+
+      def state
+        # Run a custom action we define called "read_state" which does
+        # what it says. It puts the state in the `:machine_state_id`
+        # key in the environment.
+        env = @machine.action("read_state")
+
+        state_id = env[:machine_state_id]
+
+        # Get the short and long description
+        short = I18n.t("vagrant_brightbox.states.short_#{state_id}")
+        long  = I18n.t("vagrant_brightbox.states.long_#{state_id}")
+
+        # Return the MachineState object
+        Vagrant::MachineState.new(state_id, short, long)
+      end
+
+      def to_s
+        id = @machine.id.nil? ? "new" : @machine.id
+        "Brightbox (#{id})"
+      end
+    end
+  end
+end

data/lib/vagrant-brightbox/util/timer.rb

@@ -0,0 +1,17 @@
+module VagrantPlugins
+  module Brightbox
+    module Util
+      class Timer
+        # A basic utility method that times the execution of the given
+        # block and returns it.
+        def self.time
+          start_time = Time.now.to_f
+          yield
+          end_time = Time.now.to_f
+
+          end_time - start_time
+        end
+      end
+    end
+  end
+end

data/lib/vagrant-brightbox/version.rb

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

data/lib/vagrant-brightbox.rb

@@ -0,0 +1,18 @@
+require "pathname"
+
+require "vagrant-brightbox/plugin"
+
+module VagrantPlugins
+  module Brightbox
+    lib_path = Pathname.new(File.expand_path("../vagrant-brightbox", __FILE__))
+    autoload :Action, lib_path.join("action")
+    autoload :Errors, lib_path.join("errors")
+
+    # This returns the path to the source of this plugin.
+    #
+    # @return [Pathname]
+    def self.source_root
+      @source_root ||= Pathname.new(File.expand_path("../../", __FILE__))
+    end
+  end
+end

data/locales/en.yml

@@ -0,0 +1,88 @@
+en:
+  vagrant_brightbox:
+    already_created: |-
+      The server is already created.
+    deleting_server: |-
+      Deleting server...
+    finding_image: |-
+      Finding image for server...
+    launching_server: |-
+      Launching a server with the following settings...
+    not_created: |-
+      The server hasn't been created yet. Run `vagrant up` first.
+    ready: |-
+      The server is ready!
+    rsync_folder: |-
+      Rsyncing folder: %{hostpath} => %{guestpath}
+    waiting_for_build: |-
+      Waiting for the server to be built...
+    waiting_for_ssh: |-
+      Waiting for SSH to become available...
+    mapped_cloud_ip: |-
+      Mapped IPv4 Cloud IP '%{cloud_ip}' to server '%{server}'
+    starting_server: |-
+      Starting server...
+    stopping_server: |-
+      Stopping server...
+    unsupported: |-
+      This command is not supported on the Brightbox Provider
+
+    config:
+      region_required: |-
+        A region must be specified via "region".
+      region_invalid: |-
+        You must specify the correct 'auth_url' and 'api_url' with
+        anything other than the default 'gb1' region.
+      private_key_missing: |-
+        The specified private key for Brightbox cloud could not be found.
+      client_id_required: |-
+        You must include a client_id in the Vagrantfile, or in the file '~/.fog'.
+      secret_required: |-
+        You must include the secret associated with the client_id in
+        the Vagrantfile, or in the file '~/.fog'.
+      username_required: |-
+        A username is required.
+
+    errors:
+      no_free_cloud_ip: |-
+        Warning! Unable to find a free cloup ip from your allocation. IPv4
+        public network access will not be available.
+      create_bad_state: |-
+        While creating the server, it transitioned to an unexpected
+        state: '%{state}', instead of properly booting. Run `vagrant status`
+        to find out what can be done about this state, or `vagrant destroy`
+        if you want to start over.
+      no_matching_image: |-
+        No matching image was found! Please check your image setting to
+        make sure you have a valid image chosen.
+      fog_error: |-
+        There was an error talking to the Brightbox cloud. The error
+        message is shown below:
+
+        %{message}
+      rsync_error: |-
+        There was an error when attemping to rsync a share folder.
+        Please inspect the error message below for more info.
+
+        Host path: %{hostpath}
+        Guest path: %{guestpath}
+        Error: %{stderr}
+
+    states:
+      short_active: |-
+        active
+      long_active: |-
+        The server is up and running. Run `vagrant ssh` to access it.
+      short_inactive: |-
+        inactive
+      long_inactive: |-
+        The server has been created but is offline. Run `vagrant up` to restart.
+      short_creating: |-
+        creating
+      long_creating: |-
+        The server is currently being built. You must wait for this to
+        complete before you can access it or destroy it
+      short_not_created: |-
+        not created
+      long_not_created: |-
+        The server is not created. Run `vagrant up` to create it.