vagrant-aws 0.0.1 → 0.1.0

data/lib/vagrant-aws/config.rb

@@ -1,38 +1,253 @@
-module VagrantAWS
-	# A configuration class to configure defaults which are used for
-  # the `vagrant-aws` plugin.
-  class Config < Vagrant::Config::Base
-    configures :aws
-   	
-		attr_accessor :key_name
-		attr_writer   :private_key_path
-		attr_accessor :username
-		attr_accessor :security_groups
-
-		attr_accessor :image
-		attr_accessor :flavor
-
-		attr_accessor :region
-		attr_accessor :availability_zone
-
-		def initialize
-			@security_groups   = ["default"]
-			@region            = "us-east-1"
-			@username          = "ubuntu"
-			@image             = "ami-2ec83147"
-			@flavor            = "t1.micro"
-		end
-
-		def using?
-			return top.env.is_a?(VagrantAWS::Environment)
-		end
-
-		def private_key_path
-			@private_key_path.nil? ? nil : File.expand_path(@private_key_path)
-		end
-		
-		def validate(errors)
-			errors.add(I18n.t("vagrant.config.ssh.private_key_missing", :path => private_key_path)) if private_key_path && !File.exists?(private_key_path)
-		end
-	end
-end	
+require "vagrant"
+
+module VagrantPlugins
+  module AWS
+    class Config < Vagrant.plugin("2", :config)
+      # The access key ID for accessing AWS.
+      #
+      # @return [String]
+      attr_accessor :access_key_id
+
+      # The ID of the AMI to use.
+      #
+      # @return [String]
+      attr_accessor :ami
+
+      # The availability zone to launch the instance into. If nil, it will
+      # use the default for your account.
+      #
+      # @return [String]
+      attr_accessor :availability_zone
+
+      # The type of instance to launch, such as "m1.small"
+      #
+      # @return [String]
+      attr_accessor :instance_type
+
+      # The name of the keypair to use.
+      #
+      # @return [String]
+      attr_accessor :keypair_name
+
+      # The private IP address to give this machine (VPC).
+      #
+      # @return [String]
+      attr_accessor :private_ip_address
+
+      # The name of the AWS region in which to create the instance.
+      #
+      # @return [String]
+      attr_accessor :region
+
+      # The secret access key for accessing AWS.
+      #
+      # @return [String]
+      attr_accessor :secret_access_key
+
+      # The security groups to set on the instance. For VPC this must
+      # be a list of IDs. For EC2, it can be either.
+      #
+      # @return [Array<String>]
+      attr_accessor :security_groups
+
+      # The path to the SSH private key to use with this EC2 instance.
+      # This overrides the `config.ssh.private_key_path` variable.
+      #
+      # @return [String]
+      attr_accessor :ssh_private_key_path
+
+      # The SSH username to use with this EC2 instance. This overrides
+      # the `config.ssh.username` variable.
+      #
+      # @return [String]
+      attr_accessor :ssh_username
+
+      # The subnet ID to launch the machine into (VPC).
+      #
+      # @return [String]
+      attr_accessor :subnet_id
+
+      # The tags for the machine.
+      #
+      # @return [Hash<String, String>]
+      attr_accessor :tags
+
+      def initialize(region_specific=false)
+        @access_key_id      = UNSET_VALUE
+        @ami                = UNSET_VALUE
+        @availability_zone  = UNSET_VALUE
+        @instance_type      = UNSET_VALUE
+        @keypair_name       = UNSET_VALUE
+        @private_ip_address = UNSET_VALUE
+        @region             = UNSET_VALUE
+        @secret_access_key  = UNSET_VALUE
+        @security_groups    = UNSET_VALUE
+        @ssh_private_key_path = UNSET_VALUE
+        @ssh_username       = UNSET_VALUE
+        @subnet_id          = UNSET_VALUE
+        @tags               = {}
+
+        # 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
+      # AMI and keypair name for regions. Example:
+      #
+      #     aws.region_config "us-east-1" do |region|
+      #       region.ami = "ami-12345678"
+      #       region.keypair_name = "company-east"
+      #     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 AWS 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)
+
+          # Merge in the tags
+          result.tags.merge!(self.tags)
+          result.tags.merge!(other.tags)
+        end
+      end
+
+      def finalize!
+        # The access keys default to nil
+        @access_key_id     = nil if @access_key_id     == UNSET_VALUE
+        @secret_access_key = nil if @secret_access_key == UNSET_VALUE
+
+        # AMI must be nil, since we can't default that
+        @ami = nil if @ami == UNSET_VALUE
+
+        # Default instance type is an m1.small
+        @instance_type = "m1.small" if @instance_type == UNSET_VALUE
+
+        # Keypair defaults to nil
+        @keypair_name = nil if @keypair_name == UNSET_VALUE
+
+        # Default the private IP to nil since VPC is not default
+        @private_ip_address = nil if @private_ip_address == UNSET_VALUE
+
+        # Default region is us-east-1. This is sensible because AWS
+        # generally defaults to this as well.
+        @region = "us-east-1" if @region == UNSET_VALUE
+        @availability_zone = nil if @availability_zone == UNSET_VALUE
+
+        # The security groups are empty by default.
+        @security_groups = [] if @security_groups == 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
+
+        # Subnet is nil by default otherwise we'd launch into VPC.
+        @subnet_id = nil if @subnet_id == 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_aws.config.region_required") if @region.nil?
+
+        if @region
+          # Get the configuration for the region we're using and validate only
+          # that region.
+          config = get_region_config(@region)
+
+          errors << I18n.t("vagrant_aws.config.access_key_id_required") if \
+            config.access_key_id.nil?
+          errors << I18n.t("vagrant_aws.config.secret_access_key_required") if \
+            config.secret_access_key.nil?
+          errors << I18n.t("vagrant_aws.config.ami_required") if config.ami.nil?
+
+          if config.ssh_private_key_path && \
+            !File.file?(File.expand_path(config.ssh_private_key_path, machine.env.root_path))
+            errors << I18n.t("vagrant_aws.config.private_key_missing")
+          end
+        end
+
+        { "AWS Provider" => errors }
+      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-aws/errors.rb

@@ -1,29 +1,19 @@
-module VagrantAWS
-	module Errors
+require "vagrant"
 
-		class VagrantError < Vagrant::Errors::VagrantError
-			def error_namespace; "vagrant.plugins.aws.errors"; end
-		end
+module VagrantPlugins
+  module AWS
+    module Errors
+      class VagrantAWSError < Vagrant::Errors::VagrantError
+        error_namespace("vagrant_aws.errors")
+      end
 
-		class NotYetSupported < VagrantError
-			error_key(:not_yet_supported)
-		end
+      class FogError < VagrantAWSError
+        error_key(:fog_error)
+      end
 
-		class KeyNameNotSpecified < VagrantError
-			error_key(:key_name_not_specified)
-		end
-
-		class PrivateKeyFileNotSpecified < VagrantError
-			error_key(:private_key_file_not_specified)
-		end
-
-		class EBSDeviceRequired < VagrantError
-			error_key(:ebs_device_required)
-		end
-
-		class VMCreateFailure < VagrantError
-			error_key(:vm_create_failure)
-		end
-
-	end
+      class RsyncError < VagrantAWSError
+        error_key(:rsync_error)
+      end
+    end
+  end
 end

data/lib/vagrant-aws/plugin.rb

@@ -0,0 +1,73 @@
+begin
+  require "vagrant"
+rescue LoadError
+  raise "The Vagrant AWS 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 AWS plugin is only compatible with Vagrant 1.1+"
+end
+
+module VagrantPlugins
+  module AWS
+    class Plugin < Vagrant.plugin("2")
+      name "AWS"
+      description <<-DESC
+      This plugin installs a provider that allows Vagrant to manage
+      machines in AWS (EC2/VPC).
+      DESC
+
+      config(:aws, :provider) do
+        require_relative "config"
+        Config
+      end
+
+      provider(:aws) 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", AWS.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_aws")
+          logger.outputters = Log4r::Outputter.stderr
+          logger.level = level
+          logger = nil
+        end
+      end
+    end
+  end
+end

data/lib/vagrant-aws/provider.rb

@@ -0,0 +1,50 @@
+require "log4r"
+require "vagrant"
+
+module VagrantPlugins
+  module AWS
+    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_aws.states.short_#{state_id}")
+        long  = I18n.t("vagrant_aws.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
+        "AWS (#{id})"
+      end
+    end
+  end
+end