vagrant-cloudstack 0.0.5

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

@@ -0,0 +1,21 @@
+require "vagrant-cloudstack/util/timer"
+
+module VagrantPlugins
+  module Cloudstack
+    module Action
+      # This is the same as the builtin provision except it times the
+      # provisioner runs.
+      class TimedProvision < Vagrant::Action::Builtin::Provision
+        def run_provisioner(env, pname, p)
+          timer = Util::Timer.time do
+            super
+          end
+
+          env[:metrics] ||= {}
+          env[:metrics]["provisioner_times"] ||= []
+          env[:metrics]["provisioner_times"] << [p.class.to_s, timer]
+        end
+      end
+    end
+  end
+end

data/lib/vagrant-cloudstack/action/warn_networks.rb

@@ -0,0 +1,19 @@
+module VagrantPlugins
+  module Cloudstack
+    module Action
+      class WarnNetworks
+        def initialize(app, env)
+          @app = app
+        end
+
+        def call(env)
+          if env[:machine].config.vm.networks.length > 0
+            env[:ui].warn(I18n.t("vagrant_cloudstack.warn_networks"))
+          end
+
+          @app.call(env)
+        end
+      end
+    end
+  end
+end

data/lib/vagrant-cloudstack/config.rb

@@ -0,0 +1,253 @@
+require "vagrant"
+
+module VagrantPlugins
+  module Cloudstack
+    class Config < Vagrant.plugin("2", :config)
+      # Cloudstack api host.
+      #
+      # @return [String]
+      attr_accessor :host
+
+      # Cloudstack api path.
+      #
+      # @return [String]
+      attr_accessor :path
+
+      # Cloudstack api port.
+      #
+      # @return [String]
+      attr_accessor :port
+
+      # Cloudstack api scheme
+      #
+      # @return [String]
+      attr_accessor :scheme
+
+      # The API key for accessing Cloudstack.
+      #
+      # @return [String]
+      attr_accessor :api_key
+
+      # The secret key for accessing Cloudstack.
+      #
+      # @return [String]
+      attr_accessor :secret_key
+
+      # The timeout to wait for an instance to become ready.
+      #
+      # @return [Fixnum]
+      attr_accessor :instance_ready_timeout
+
+      # Domain id to launch the instance into.
+      #
+      # @return [String]
+      attr_accessor :domain_id
+
+      # Network uuid that the instance should use
+      #
+      # @return [String]
+      attr_accessor :network_id
+
+      # Project uuid that the instance should belong to
+      #
+      # @return [String]
+      attr_accessor :project_id
+
+      # Service offering uuid to use for the instance
+      #
+      # @return [String]
+      attr_accessor :service_offering_id
+
+      # Template uuid to use for the instance
+      #
+      # @return [String]
+      attr_accessor :template_id
+
+      # Zone uuid to launch the instance into. If nil, it will
+      # launch in default project.
+      #
+      # @return [String]
+      attr_accessor :zone_id
+
+      def initialize(domain_specific=false)
+        @host                   = UNSET_VALUE
+        @path                   = UNSET_VALUE
+        @port                   = UNSET_VALUE
+        @scheme                 = UNSET_VALUE
+        @api_key                = UNSET_VALUE
+        @secret_key             = UNSET_VALUE
+        @instance_ready_timeout = UNSET_VALUE
+        @domain_id              = UNSET_VALUE
+        @network_id             = UNSET_VALUE
+        @project_id             = UNSET_VALUE
+        @service_offering_id    = UNSET_VALUE
+        @template_id            = UNSET_VALUE
+        @zone_id                = UNSET_VALUE
+
+        # Internal state (prefix with __ so they aren't automatically
+        # merged)
+        @__compiled_domain_configs = {}
+        @__finalized = false
+        @__domain_config = {}
+        @__domain_specific = domain_specific
+      end
+
+      # Allows domain-specific overrides of any of the settings on this
+      # configuration object. This allows the user to override things like
+      # template and keypair name for domains. Example:
+      #
+      #     cloudstack.domain_config "abcd-ef01-2345-6789" do |domain|
+      #       domain.template_id = "1234-5678-90ab-cdef"
+      #       domain.keypair_name = "company-east"
+      #     end
+      #
+      # @param [String] domain The Domain 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 domain configuration.
+      def domain_config(domain, attributes=nil, &block)
+        # Append the block to the list of domain configs for that domain.
+        # We'll evaluate these upon finalization.
+        @__domain_config[domain] ||= []
+
+        # Append a block that sets attributes if we got one
+        if attributes
+          attr_block = lambda do |config|
+            config.set_options(attributes)
+          end
+
+          @__domain_config[domain] << attr_block
+        end
+
+        # Append a block if we got one
+        @__domain_config[domain] << block if block_given?
+      end
+
+      #-------------------------------------------------------------------
+      # Internal methods.
+      #-------------------------------------------------------------------
+
+      def merge(other)
+        super.tap do |result|
+          # Copy over the domain specific flag. "True" is retained if either
+          # has it.
+          new_domain_specific = other.instance_variable_get(:@__domain_specific)
+          result.instance_variable_set(
+            :@__domain_specific, new_domain_specific || @__domain_specific)
+
+          # Go through all the domain configs and prepend ours onto
+          # theirs.
+          new_domain_config = other.instance_variable_get(:@__domain_config)
+          @__domain_config.each do |key, value|
+            new_domain_config[key] ||= []
+            new_domain_config[key] = value + new_domain_config[key]
+          end
+
+          # Set it
+          result.instance_variable_set(:@__domain_config, new_domain_config)
+
+          # Merge in the tags
+          result.tags.merge!(self.tags)
+          result.tags.merge!(other.tags)
+        end
+      end
+
+      def finalize!
+        # Domain_id must be nil, since we can't default that
+        @host = nil if @host == UNSET_VALUE
+
+        # Path must be nil, since we can't default that
+        @path = nil if @path == UNSET_VALUE
+
+        # Port must be nil, since we can't default that
+        @port = nil if @port == UNSET_VALUE
+
+        # Scheme is 'http' by default
+        @scheme = "http" if @scheme == UNSET_VALUE
+
+        # Api key must be nil, since we can't default that
+        @api_key = nil if @api_key == UNSET_VALUE
+
+        # Secret key must be nil, since we can't default that
+        @secret_key = nil if @secret_key == UNSET_VALUE
+
+        # Set the default timeout for waiting for an instance to be ready
+        @instance_ready_timeout = 120 if @instance_ready_timeout == UNSET_VALUE
+
+        # Domain id must be nil, since we can't default that
+        @domain_id = nil if @domain_id == UNSET_VALUE
+
+        # Network uuid must be nil, since we can't default that
+        @network_id = nil if @network_id == UNSET_VALUE
+
+        # Project uuid must be nil, since we can't default that
+        @project_id = nil if @project_id == UNSET_VALUE
+
+        # Service offering uuid must be nil, since we can't default that
+        @service_offering_id = nil if @service_offering_id == UNSET_VALUE
+
+        # Template uuid must be nil, since we can't default that
+        @template_id = nil if @template_id == UNSET_VALUE
+
+        # Zone uuid must be nil, since we can't default that
+        @zone_id = nil if @zone_id == UNSET_VALUE
+
+        # Compile our domain specific configurations only within
+        # NON-DOMAIN-SPECIFIC configurations.
+        if !@__domain_specific
+          @__domain_config.each do |domain, blocks|
+            config = self.class.new(true).merge(self)
+
+            # Execute the configuration for each block
+            blocks.each { |b| b.call(config) }
+
+            # The domain name of the configuration always equals the
+            # domain config name:
+            config.domain = domain
+
+            # Finalize the configuration
+            config.finalize!
+
+            # Store it for retrieval
+            @__compiled_domain_configs[domain] = config
+          end
+        end
+
+        # Mark that we finalized
+        @__finalized = true
+      end
+
+      def validate(machine)
+        errors = []
+
+        if @domain
+          # Get the configuration for the domain we're using and validate only
+          # that domain.
+          config = get_domain_config(@domain)
+
+          if !config.use_fog_profile
+            errors << I18n.t("vagrant_cloudstack.config.api_key_required") if \
+              config.access_key_id.nil?
+            errors << I18n.t("vagrant_cloudstack.config.secret_key_required") if \
+              config.secret_access_key.nil?
+          end
+
+          errors << I18n.t("vagrant_cloudstack.config.ami_required") if config.ami.nil?
+        end
+
+        { "Cloudstack Provider" => errors }
+      end
+
+      # This gets the configuration for a specific domain. It shouldn't
+      # be called by the general public and is only used internally.
+      def get_domain_config(name)
+        if !@__finalized
+          raise "Configuration must be finalized before calling this method."
+        end
+
+        # Return the compiled domain config
+        @__compiled_domain_configs[name] || self
+      end
+    end
+  end
+end

data/lib/vagrant-cloudstack/errors.rb

@@ -0,0 +1,23 @@
+require "vagrant"
+
+module VagrantPlugins
+  module Cloudstack
+    module Errors
+      class VagrantCloudstackError < Vagrant::Errors::VagrantError
+        error_namespace("vagrant_cloudstack.errors")
+      end
+
+      class FogError < VagrantCloudstackError
+        error_key(:fog_error)
+      end
+
+      class InstanceReadyTimeout < VagrantCloudstackError
+        error_key(:instance_ready_timeout)
+      end
+
+      class RsyncError < VagrantCloudstackError
+        error_key(:rsync_error)
+      end
+    end
+  end
+end

data/lib/vagrant-cloudstack/plugin.rb

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

data/lib/vagrant-cloudstack/provider.rb

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

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

@@ -0,0 +1,17 @@
+module VagrantPlugins
+  module Cloudstack
+    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