vagrant-mcs 0.6.0

data/lib/vagrant-mcs/errors.rb

@@ -0,0 +1,43 @@
+require "vagrant"
+
+module VagrantPlugins
+  module MCS
+    module Errors
+      class VagrantMCSError < Vagrant::Errors::VagrantError
+        error_namespace("vagrant_mcs.errors")
+      end
+
+      class FogError < VagrantMCSError
+        error_key(:fog_error)
+      end
+
+      class InternalFogError < VagrantMCSError
+        error_key(:internal_fog_error)
+      end
+
+      class InstanceReadyTimeout < VagrantMCSError
+        error_key(:instance_ready_timeout)
+      end
+
+      class InstancePackageError < VagrantMCSError
+        error_key(:instance_package_error)
+      end
+
+      class InstancePackageTimeout < VagrantMCSError
+        error_key(:instance_package_timeout)
+      end
+
+      class RsyncError < VagrantMCSError
+        error_key(:rsync_error)
+      end
+
+      class MkdirError < VagrantMCSError
+        error_key(:mkdir_error)
+      end
+
+      class ElbDoesNotExistError < VagrantMCSError
+        error_key("elb_does_not_exist")
+      end
+    end
+  end
+end

data/lib/vagrant-mcs/plugin.rb

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

data/lib/vagrant-mcs/provider.rb

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

data/lib/vagrant-mcs/util/elb.rb

@@ -0,0 +1,56 @@
+module VagrantPlugins
+  module MCS
+    module ElasticLoadBalancer
+
+      def register_instance(env, elb_name, instance_id)
+        env[:ui].info I18n.t("vagrant_mcs.elb.registering", instance_id: instance_id, elb_name: elb_name), :new_line => false
+        elb = get_load_balancer(env[:mcs_elb], elb_name)
+        unless elb.instances.include? instance_id
+          elb.register_instances([instance_id])
+          env[:ui].info I18n.t("vagrant_mcs.elb.ok"), :prefix => false
+          adjust_availability_zones env, elb
+        else
+          env[:ui].info I18n.t("vagrant_mcs.elb.skipped"), :prefix => false
+        end
+      end
+
+      def deregister_instance(env, elb_name, instance_id)
+        env[:ui].info I18n.t("vagrant_mcs.elb.deregistering", instance_id: instance_id, elb_name: elb_name), :new_line => false
+        elb = get_load_balancer(env[:mcs_elb], elb_name)
+        if elb.instances.include? instance_id
+          elb.deregister_instances([instance_id])
+          env[:ui].info I18n.t("vagrant_mcs.elb.ok"), :prefix => false
+          adjust_availability_zones env, elb
+        else
+          env[:ui].info I18n.t("vagrant_mcs.elb.skipped"), :prefix => false
+        end
+      end
+
+      def adjust_availability_zones(env, elb)
+        env[:ui].info I18n.t("vagrant_mcs.elb.adjusting", elb_name: elb.id), :new_line => false
+
+        instances = env[:mcs_compute].servers.all("instance-id" => elb.instances)
+        
+        azs = if instances.empty?
+                ["#{env[:machine].provider_config.region}a"]
+              else
+                instances.map(&:availability_zone).uniq
+              end
+
+        az_to_disable = elb.availability_zones - azs
+        az_to_enable = azs - elb.availability_zones
+
+        elb.enable_availability_zones az_to_enable unless az_to_enable.empty?
+        elb.disable_availability_zones az_to_disable unless az_to_disable.empty?
+
+        env[:ui].info I18n.t("vagrant_mcs.elb.ok"), :prefix => false
+      end
+
+      private
+
+      def get_load_balancer(mcs, name)
+        mcs.load_balancers.find { |lb| lb.id == name } or raise Errors::ElbDoesNotExistError
+      end
+    end
+  end
+end

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

@@ -0,0 +1,17 @@
+module VagrantPlugins
+  module MCS
+    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-mcs/version.rb

@@ -0,0 +1,5 @@
+module VagrantPlugins
+  module MCS
+    VERSION = '0.6.0'
+  end
+end

data/lib/vagrant-mcs.rb

@@ -0,0 +1,18 @@
+require "pathname"
+
+require "vagrant-mcs/plugin"
+
+module VagrantPlugins
+  module MCS
+    lib_path = Pathname.new(File.expand_path("../vagrant-mcs", __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,153 @@
+en:
+  vagrant_mcs:
+    already_status: |-
+      The machine is already %{status}.
+    burning_ami: |-
+      Waiting for the AMI '%{ami_id}' to burn...
+    elb:
+      adjusting: |-
+        Adjusting availability zones of ELB %{elb_name}...
+      registering: |-
+        Registering %{instance_id} at ELB %{elb_name}...
+      deregistering: |-
+        Deregistering %{instance_id} from ELB %{elb_name}...
+      ok: |-
+        ok
+      skipped: |-
+        skipped
+
+    launching_instance: |-
+      Launching an instance with the following settings...
+    launch_no_keypair: |-
+      Warning! You didn't specify a keypair to launch your instance with.
+      This can sometimes result in not being able to access your instance.
+    launch_vpc_warning: |-
+      Warning! You're launching this instance into a VPC without an
+      elastic IP. Please verify you're properly connected to a VPN so
+      you can access this machine, otherwise Vagrant will not be able
+      to SSH into it.
+    not_created: |-
+      Instance is not created. Please run `vagrant up` first.
+    packaging_instance: |-
+      Burning instance %{instance_id} into an ami
+    packaging_instance_complete: |-
+      Burn was successful in %{time_seconds}s
+    ready: |-
+      Machine is booted and ready for use!
+    rsync_not_found_warning: |-
+      Warning! Folder sync disabled because the rsync binary is missing in the %{side}.
+      Make sure rsync is installed and the binary can be found in the PATH.
+    rsync_folder: |-
+      Rsyncing folder: %{hostpath} => %{guestpath}
+    starting: |-
+      Starting the instance...
+    stopping: |-
+      Stopping the instance...
+    terminating: |-
+      Terminating the instance...
+    waiting_for_ready: |-
+      Waiting for instance to become "ready"...
+    waiting_for_ssh: |-
+      Waiting for SSH to become available...
+    warn_networks: |-
+      Warning! The MCS provider doesn't support any of the Vagrant
+      high-level network configurations (`config.vm.network`). They
+      will be silently ignored.
+    warn_ssh_access: |-
+      Warning! Vagrant might not be able to SSH into the instance.
+      Please check your security groups settings.
+    will_not_destroy: |-
+      The instance '%{name}' will not be destroyed, since the confirmation
+      was declined.
+
+    config:
+      access_key_id_required: |-
+        An access key ID must be specified via "access_key_id"
+      ami_required: |-
+        An AMI must be configured via "ami" (region: #{region})
+      private_key_missing: |-
+        The specified private key for MCS could not be found
+      region_required: |-
+        A region must be specified via "region"
+      secret_access_key_required: |-
+        A secret access key is required via "secret_access_key"
+      subnet_id_required_with_public_ip: |-
+        If you assign a public IP address to an instance in a VPC, a subnet must be specifed via "subnet_id"
+
+    errors:
+      fog_error: |-
+        There was an error talking to MCS. The error message is shown
+        below:
+
+        %{message}
+      internal_fog_error: |-
+        There was an error talking to MCS. The error message is shown
+        below:
+
+        Error: %{error}
+        Response: %{response}
+      instance_ready_timeout: |-
+        The instance never became "ready" in MCS. The timeout currently
+        set waiting for the instance to become ready is %{timeout} seconds.
+        Please verify that the machine properly boots. If you need more time
+        set the `instance_ready_timeout` configuration on the MCS provider.
+      instance_package_error: |-
+        There was an error packaging the instance. See details below for more info.
+
+        AMI Id: %{ami_id}
+        Error: %{err}
+      instance_package_timeout: |-
+        The AMI failed to become "ready" in MCS. The timeout currently
+        set waiting for the instance to become ready is %{timeout} seconds. For 
+        larger instances AMI burning may take long periods of time. Please
+        ensure the timeout is set high enough, it can be changed by adjusting
+        the `instance_package_timeout` configuration on the MCS provider.
+      rsync_error: |-
+        There was an error when attempting to rsync a shared folder.
+        Please inspect the error message below for more info.
+
+        Host path: %{hostpath}
+        Guest path: %{guestpath}
+        Error: %{stderr}
+      mkdir_error: |-
+        There was an error when attempting to create a shared host folder.
+        Please inspect the error message below for more info.
+
+        Host path: %{hostpath}
+        Error: %{err}
+      elb_does_not_exist: |-
+        ELB configured for the instance does not exist
+
+    states:
+      short_not_created: |-
+        not created
+      long_not_created: |-
+        The EC2 instance is not created. Run `vagrant up` to create it.
+
+      short_stopped: |-
+        stopped
+      long_stopped: |-
+        The EC2 instance is stopped. Run `vagrant up` to start it.
+
+      short_stopping: |-
+        stopping
+      long_stopping: |-
+        The EC2 instance is stopping. Wait until is completely stopped to
+        run `vagrant up` and start it.
+
+      short_pending: |-
+        pending
+      long_pending: |-
+        The EC2 instance is pending a start (i.e. this is a transition state).
+
+      short_running: |-
+        running
+      long_running: |-
+        The EC2 instance is running. To stop this machine, you can run
+        `vagrant halt`. To destroy the machine, you can run `vagrant destroy`.
+
+      short_pending: |-
+        pending
+      long_pending: |-
+        The EC2 instance is still being initialized. To destroy this machine,
+        you can run `vagrant destroy`.

data/spec/spec_helper.rb

@@ -0,0 +1 @@
+

data/spec/vagrant-aws/config_spec.rb

@@ -0,0 +1,225 @@
+require "vagrant-mcs/config"
+
+describe VagrantPlugins::MCS::Config do
+  let(:instance) { described_class.new }
+
+  # Ensure tests are not affected by MCS credential environment variables
+  before :each do
+    ENV.stub(:[] => nil)
+  end
+
+  describe "defaults" do
+    subject do
+      instance.tap do |o|
+        o.finalize!
+      end
+    end
+
+    its("access_key_id")     { should be_nil }
+    its("ami")               { should be_nil }
+    its("availability_zone") { should be_nil }
+    its("instance_ready_timeout") { should == 120 }
+    its("instance_package_timeout") { should == 600 }
+    its("instance_type")     { should == "m3.medium" }
+    its("keypair_name")      { should be_nil }
+    its("private_ip_address") { should be_nil }
+    its("region")            { should == "us-east-1" }
+    its("secret_access_key") { should be_nil }
+    its("session_token") { should be_nil }
+    its("security_groups")   { should == [] }
+    its("subnet_id")         { should be_nil }
+    its("iam_instance_profile_arn") { should be_nil }
+    its("iam_instance_profile_name") { should be_nil }
+    its("tags")              { should == {} }
+    its("user_data")         { should be_nil }
+    its("use_iam_profile")   { should be_false }
+    its("block_device_mapping")  {should == [] }
+    its("elastic_ip")        { should be_nil }
+    its("terminate_on_shutdown") { should == false }
+    its("ssh_host_attribute") { should be_nil }
+    its("monitoring")        { should == false }
+    its("ebs_optimized")     { should == false }
+    its("associate_public_ip")     { should == false }
+  end
+
+  describe "overriding defaults" do
+    # I typically don't meta-program in tests, but this is a very
+    # simple boilerplate test, so I cut corners here. It just sets
+    # each of these attributes to "foo" in isolation, and reads the value
+    # and asserts the proper result comes back out.
+    [:access_key_id, :ami, :availability_zone, :instance_ready_timeout,
+      :instance_package_timeout, :instance_type, :keypair_name, :ssh_host_attribute,
+      :ebs_optimized, :region, :secret_access_key, :session_token, :monitoring,
+      :associate_public_ip, :subnet_id, :tags, :elastic_ip, :terminate_on_shutdown,
+      :iam_instance_profile_arn, :iam_instance_profile_name,
+      :use_iam_profile, :user_data, :block_device_mapping].each do |attribute|
+
+      it "should not default #{attribute} if overridden" do
+        instance.send("#{attribute}=".to_sym, "foo")
+        instance.finalize!
+        instance.send(attribute).should == "foo"
+      end
+    end
+    it "should not default security_groups if overridden" do
+      instance.security_groups = "foo"
+      instance.finalize!
+      instance.security_groups.should == ["foo"]
+    end
+  end
+
+  describe "getting credentials from environment" do
+    context "without EC2 credential environment variables" do
+      subject do
+        instance.tap do |o|
+          o.finalize!
+        end
+      end
+
+      its("access_key_id")     { should be_nil }
+      its("secret_access_key") { should be_nil }
+      its("session_token")     { should be_nil }
+    end
+
+    context "with EC2 credential environment variables" do
+      before :each do
+        ENV.stub(:[]).with("MCS_ACCESS_KEY").and_return("access_key")
+        ENV.stub(:[]).with("MCS_SECRET_KEY").and_return("secret_key")
+        ENV.stub(:[]).with("MCS_SESSION_TOKEN").and_return("session_token")
+      end
+
+      subject do
+        instance.tap do |o|
+          o.finalize!
+        end
+      end
+
+      its("access_key_id")     { should == "access_key" }
+      its("secret_access_key") { should == "secret_key" }
+      its("session_token")     { should == "session_token" }
+    end
+  end
+
+  describe "region config" do
+    let(:config_access_key_id)     { "foo" }
+    let(:config_ami)               { "foo" }
+    let(:config_instance_type)     { "foo" }
+    let(:config_keypair_name)      { "foo" }
+    let(:config_region)            { "foo" }
+    let(:config_secret_access_key) { "foo" }
+    let(:config_session_token)     { "foo" }
+
+    def set_test_values(instance)
+      instance.access_key_id     = config_access_key_id
+      instance.ami               = config_ami
+      instance.instance_type     = config_instance_type
+      instance.keypair_name      = config_keypair_name
+      instance.region            = config_region
+      instance.secret_access_key = config_secret_access_key
+      instance.session_token     = config_session_token
+    end
+
+    it "should raise an exception if not finalized" do
+      expect { instance.get_region_config("us-east-1") }.
+        to raise_error
+    end
+
+    context "with no specific config set" do
+      subject do
+        # Set the values on the top-level object
+        set_test_values(instance)
+
+        # Finalize so we can get the region config
+        instance.finalize!
+
+        # Get a lower level region
+        instance.get_region_config("us-east-1")
+      end
+
+      its("access_key_id")     { should == config_access_key_id }
+      its("ami")               { should == config_ami }
+      its("instance_type")     { should == config_instance_type }
+      its("keypair_name")      { should == config_keypair_name }
+      its("region")            { should == config_region }
+      its("secret_access_key") { should == config_secret_access_key }
+      its("session_token")     { should == config_session_token }
+    end
+
+    context "with a specific config set" do
+      let(:region_name) { "hashi-region" }
+
+      subject do
+        # Set the values on a specific region
+        instance.region_config region_name do |config|
+          set_test_values(config)
+        end
+
+        # Finalize so we can get the region config
+        instance.finalize!
+
+        # Get the region
+        instance.get_region_config(region_name)
+      end
+
+      its("access_key_id")     { should == config_access_key_id }
+      its("ami")               { should == config_ami }
+      its("instance_type")     { should == config_instance_type }
+      its("keypair_name")      { should == config_keypair_name }
+      its("region")            { should == region_name }
+      its("secret_access_key") { should == config_secret_access_key }
+      its("session_token")     { should == config_session_token }
+    end
+
+    describe "inheritance of parent config" do
+      let(:region_name) { "hashi-region" }
+
+      subject do
+        # Set the values on a specific region
+        instance.region_config region_name do |config|
+          config.ami = "child"
+        end
+
+        # Set some top-level values
+        instance.access_key_id = "parent"
+        instance.ami = "parent"
+
+        # Finalize and get the region
+        instance.finalize!
+        instance.get_region_config(region_name)
+      end
+
+      its("access_key_id") { should == "parent" }
+      its("ami")           { should == "child" }
+    end
+
+    describe "shortcut configuration" do
+      subject do
+        # Use the shortcut configuration to set some values
+        instance.region_config "us-east-1", :ami => "child"
+        instance.finalize!
+        instance.get_region_config("us-east-1")
+      end
+
+      its("ami") { should == "child" }
+    end
+
+    describe "merging" do
+      let(:first)  { described_class.new }
+      let(:second) { described_class.new }
+
+      it "should merge the tags and block_device_mappings" do
+        first.tags["one"] = "one"
+        second.tags["two"] = "two"
+        first.block_device_mapping = [{:one => "one"}]
+        second.block_device_mapping = [{:two => "two"}]
+
+        third = first.merge(second)
+        third.tags.should == {
+          "one" => "one",
+          "two" => "two"
+        }
+        third.block_device_mapping.index({:one => "one"}).should_not be_nil
+        third.block_device_mapping.index({:two => "two"}).should_not be_nil
+      end
+    end
+  end
+end