openstack-vagrant 1.1.2

data/lib/vagrant-openstack/action/read_ssh_info_from_cache.rb

@@ -0,0 +1,53 @@
+require "log4r"
+require "json"
+
+class ::Hash
+  def method_missing(name)
+    return self[name] if key? name
+    self.each { |k,v| return v if k.to_s.to_sym == name }
+    super.method_missing name
+  end
+end
+
+module VagrantPlugins
+  module OpenStack
+    module Action
+      # This action reads the SSH info for the machine and puts it into the
+      # `:machine_ssh_info` key in the environment.
+      class ReadSSHInfoFromCache
+        def initialize(app, env)
+          @app    = app
+          @logger = Log4r::Logger.new("vagrant_openstack::action::read_ssh_info")
+        end
+
+        def call(env)
+          ssh_info = read_ssh_info(env[:machine])
+          
+          if ssh_info and ssh_info[:host] != nil
+            env[:machine_ssh_info] = ssh_info
+          end 
+          @app.call(env)
+        end
+
+        def read_ssh_info(machine)
+          return nil if machine.id.nil?
+
+          cached_metadata_file = machine.data_dir.join("cached_metadata")
+
+          @logger.info("Loading cached metadata from #{cached_metadata_file}")
+          server = JSON.load(cached_metadata_file.read) rescue nil
+
+          config = machine.provider_config
+
+          host = server.addresses[config.public_network_name].last['addr'] rescue nil
+
+          return {
+            :host => host,
+            :port => 22,
+            :username => config.ssh_username
+          }
+        end
+      end
+    end
+  end
+end

data/lib/vagrant-openstack/action/read_state.rb

@@ -0,0 +1,38 @@
+require "log4r"
+
+module VagrantPlugins
+  module OpenStack
+    module Action
+      # This action reads the state of the machine and puts it in the
+      # `:machine_state_id` key in the environment.
+      class ReadState
+        def initialize(app, env)
+          @app    = app
+          @logger = Log4r::Logger.new("vagrant_openstack::action::read_state")
+        end
+
+        def call(env)
+          env[:machine_state_id] = read_state(env[:openstack_compute], env[:machine])
+
+          @app.call(env)
+        end
+
+        def read_state(openstack, machine)
+          return :not_created if machine.id.nil?
+
+          # Find the machine
+          server = openstack.servers.get(machine.id)
+          if server.nil? || server.state == "DELETED"
+            # The machine can't be found
+            @logger.info("Machine not found or deleted, assuming it got destroyed.")
+            machine.id = nil
+            return :not_created
+          end
+
+          # Return the state
+          return server.state.downcase.to_sym
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,58 @@
+require "log4r"
+
+require "vagrant/util/subprocess"
+
+module VagrantPlugins
+  module OpenStack
+    module Action
+      # This middleware uses `rsync` to sync the folders over to the
+      # remote instance.
+      class SyncFolders
+        def initialize(app, env)
+          @app    = app
+          @logger = Log4r::Logger.new("vagrant_openstack::action::sync_folders")
+        end
+
+        def call(env)
+          @app.call(env)
+
+          ssh_info = env[:machine].ssh_info
+
+          env[:machine].config.vm.synced_folders.each do |id, data|
+            hostpath  = File.expand_path(data[:hostpath], env[:root_path])
+            guestpath = data[:guestpath]
+            next if data[:disabled]
+
+            # Make sure there is a trailing slash on the host path to
+            # avoid creating an additional directory with rsync
+            hostpath = "#{hostpath}/" if hostpath !~ /\/$/
+
+            env[:ui].info(I18n.t("vagrant_openstack.rsync_folder",
+                                :hostpath => hostpath,
+                                :guestpath => guestpath))
+
+            # Create the guest path
+            env[:machine].communicate.sudo("mkdir -p '#{guestpath}'")
+            env[:machine].communicate.sudo(
+              "chown #{ssh_info[:username]} '#{guestpath}'")
+
+            # Rsync over to the guest path using the SSH info
+            command = [
+              "rsync", "--verbose", "--archive", "--compress", "--delete",
+              "-e", "ssh -p #{ssh_info[:port]} -i '#{ssh_info[:private_key_path][0]}' -o StrictHostKeyChecking=no -o UserKnownHostsFile=/dev/null",
+              hostpath,
+              "#{ssh_info[:username]}@#{ssh_info[:host]}:#{guestpath}"]
+
+            r = Vagrant::Util::Subprocess.execute(*command)
+            if r.exit_code != 0
+              raise Errors::RsyncError,
+                :guestpath => guestpath,
+                :hostpath => hostpath,
+                :stderr => r.stderr
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/vagrant-openstack/action.rb

@@ -0,0 +1,129 @@
+require "pathname"
+
+require "vagrant/action/builder"
+
+module VagrantPlugins
+  module OpenStack
+    module Action
+      # Include the built-in modules so we can use them as top-level things.
+      include Vagrant::Action::Builtin
+
+      # This action is called to destroy the remote machine.
+      def self.action_destroy
+        Vagrant::Action::Builder.new.tap do |b|
+          b.use ConfigValidate
+          b.use Call, IsCreated do |env, b2|
+            if !env[:result]
+              b2.use MessageNotCreated
+              next
+            end
+
+            b2.use ConnectOpenStack
+            b2.use DeleteServer
+          end
+        end
+      end
+
+      # This action is called to read the SSH info of the machine. The
+      # resulting state is expected to be put into the `:machine_ssh_info`
+      # key.
+      def self.action_read_ssh_info
+        Vagrant::Action::Builder.new.tap do |b|
+          b.use ConfigValidate
+          b.use Call, ReadSSHInfoFromCache do |env, b2|
+            if !env[:machine_ssh_info]
+              b2.use ConnectOpenStack
+              b2.use ReadSSHInfoFromAPI
+            end
+          end
+        end
+      end
+
+      # This action is called to read the state of the machine. The
+      # resulting state is expected to be put into the `:machine_state_id`
+      # key.
+      def self.action_read_state
+        Vagrant::Action::Builder.new.tap do |b|
+          b.use ConfigValidate
+          b.use ConnectOpenStack
+          b.use ReadState
+        end
+      end
+
+      def self.action_ssh
+        Vagrant::Action::Builder.new.tap do |b|
+          b.use ConfigValidate
+          b.use Call, IsCreated do |env, b2|
+            if !env[:result]
+              b2.use MessageNotCreated
+              next
+            end
+
+            b2.use SSHExec
+          end
+        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 MessageNotCreated
+              next
+            end
+
+            b2.use SSHRun
+          end
+        end
+      end
+
+      def self.action_up
+        Vagrant::Action::Builder.new.tap do |b|
+          b.use defined?(HandleBox) ? HandleBox : HandleBoxUrl
+          b.use ConfigValidate
+          b.use Call, IsCreated do |env, b2|
+            if env[:result]
+              b2.use MessageAlreadyCreated
+              next
+            end
+
+            b2.use ConnectOpenStack
+            b2.use Provision
+            b2.use SyncFolders
+            b2.use SetHostname
+            b2.use CreateServer
+          end
+        end
+      end
+
+      def self.action_provision
+        Vagrant::Action::Builder.new.tap do |b|
+          b.use ConfigValidate
+          b.use Call, IsCreated do |env, b2|
+            if !env[:result]
+              b2.use MessageNotCreated
+              next
+            end
+
+            b2.use Provision
+            b2.use SyncFolders
+          end
+        end
+      end
+
+      # The autoload farm
+      action_root = Pathname.new(File.expand_path("../action", __FILE__))
+      autoload :ConnectOpenStack, action_root.join("connect_openstack")
+      autoload :CreateServer, action_root.join("create_server")
+      autoload :DeleteServer, action_root.join("delete_server")
+      autoload :IsCreated, action_root.join("is_created")
+      autoload :MessageAlreadyCreated, action_root.join("message_already_created")
+      autoload :MessageNotCreated, action_root.join("message_not_created")
+      autoload :ReadSSHInfoFromAPI, action_root.join("read_ssh_info_from_api")
+      autoload :ReadSSHInfoFromCache, action_root.join("read_ssh_info_from_cache")
+      autoload :ReadState, action_root.join("read_state")
+      autoload :SyncFolders, action_root.join("sync_folders")
+    end
+  end
+end

data/lib/vagrant-openstack/config.rb

@@ -0,0 +1,126 @@
+require "vagrant"
+
+module VagrantPlugins
+  module OpenStack
+    class Config < Vagrant.plugin("2", :config)
+      # The API key to access OpenStack.
+      #
+      # @return [String]
+      attr_accessor :api_key
+
+      # The endpoint to access OpenStack.
+      #
+      # @return [String]
+      attr_accessor :endpoint
+
+      # Openstack region, if your openstack instance uses these.
+      # Rackspace typically uses these. You need to provide their three letter acronym (for example: DFW)
+      # @return [String]
+      attr_accessor :region
+
+      # The flavor of server to launch, either the ID or name. This
+      # can also be a regular expression to partially match a name.
+      attr_accessor :flavor
+
+      # The name or ID of the image to use. This can also be a regular
+      # expression to partially match a name.
+      attr_accessor :image
+
+      # 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 username to access OpenStack.
+      #
+      # @return [String]
+      attr_accessor :username
+
+      # The name of the keypair to use.
+      #
+      # @return [String]
+      attr_accessor :keypair_name
+
+      # The SSH username to use with this OpenStack instance. This overrides
+      # the `config.ssh.username` variable.
+      #
+      # @return [String]
+      attr_accessor :ssh_username
+
+      # User data to be sent to the newly created OpenStack instance. Use this
+      # e.g. to inject a script at boot time.
+      #
+      # @return [String]
+      attr_accessor :user_data
+
+      # Metadata to be sent to the newly created OpenStack instance.
+      #
+      # @return [Hash]
+      attr_accessor :metadata
+
+      # @return [String]
+      attr_accessor :public_network_name
+
+      # @return [String]
+      attr_accessor :networks
+
+      # @return [String]
+      attr_accessor :tenant
+
+      # @return [Hash]
+      attr_accessor :scheduler_hints
+
+      def initialize
+        @api_key  = UNSET_VALUE
+        @endpoint = UNSET_VALUE
+        @region = UNSET_VALUE
+        @flavor   = UNSET_VALUE
+        @image    = UNSET_VALUE
+        @server_name = UNSET_VALUE
+        @username = UNSET_VALUE
+        @keypair_name = UNSET_VALUE
+        @ssh_username = UNSET_VALUE
+        @user_data = UNSET_VALUE
+        @metadata = UNSET_VALUE
+        @public_network_name = UNSET_VALUE
+        @networks = UNSET_VALUE
+        @tenant = UNSET_VALUE
+        @scheduler_hints = UNSET_VALUE
+      end
+
+      def finalize!
+        @api_key  = nil if @api_key == UNSET_VALUE
+        @endpoint = nil if @endpoint == UNSET_VALUE
+        @region = nil if @region == UNSET_VALUE
+        @flavor   = /m1.tiny/ if @flavor == UNSET_VALUE
+        @image    = /cirros/ if @image == UNSET_VALUE
+        @server_name = nil if @server_name == UNSET_VALUE
+        @username = nil if @username == UNSET_VALUE
+
+        # Keypair defaults to nil
+        @keypair_name = nil if @keypair_name == UNSET_VALUE
+
+        # The SSH values by default are nil, and the top-level config
+        # `config.ssh` values are used.
+        @ssh_username = nil if @ssh_username == UNSET_VALUE
+
+        @user_data = "" if @user_data == UNSET_VALUE
+        @metadata = {} if @metadata == UNSET_VALUE
+
+        @public_network_name = "public" if @public_network_name == UNSET_VALUE
+        @networks = [@public_network_name] if @networks == UNSET_VALUE
+        @tenant = nil if @tenant == UNSET_VALUE
+        @scheduler_hints = {} if @scheduler_hints == UNSET_VALUE
+      end
+
+      def validate(machine)
+        errors = []
+
+        errors << I18n.t("vagrant_openstack.config.api_key_required") if !@api_key
+        errors << I18n.t("vagrant_openstack.config.username_required") if !@username
+
+        { "OpenStack Provider" => errors }
+      end
+    end
+  end
+end

data/lib/vagrant-openstack/errors.rb

@@ -0,0 +1,35 @@
+require "vagrant"
+
+module VagrantPlugins
+  module OpenStack
+    module Errors
+      class VagrantOpenStackError < Vagrant::Errors::VagrantError
+        error_namespace("vagrant_openstack.errors")
+      end
+
+      class CreateBadState < VagrantOpenStackError
+        error_key(:create_bad_state)
+      end
+
+      class SshUnavailable < VagrantOpenStackError
+        error_key(:ssh_unavailable)
+      end
+
+      class NoMatchingFlavor < VagrantOpenStackError
+        error_key(:no_matching_flavor)
+      end
+
+      class NoMatchingImage < VagrantOpenStackError
+        error_key(:no_matching_image)
+      end
+
+      class NoMatchingNetwork < VagrantOpenStackError
+        error_key(:no_matching_network)
+      end
+
+      class RsyncError < VagrantOpenStackError
+        error_key(:rsync_error)
+      end
+    end
+  end
+end

data/lib/vagrant-openstack/plugin.rb

@@ -0,0 +1,37 @@
+begin
+  require "vagrant"
+rescue LoadError
+  raise "The OpenStack Cloud provider 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 "OpenStack Cloud provider is only compatible with Vagrant 1.2+"
+end
+
+module VagrantPlugins
+  module OpenStack
+    class Plugin < Vagrant.plugin("2")
+      name "OpenStack Cloud"
+      description <<-DESC
+      This plugin enables Vagrant to manage machines in OpenStack Cloud.
+      DESC
+
+      config(:openstack, :provider) do
+        require_relative "config"
+        Config
+      end
+
+      provider(:openstack, parallel: true) do
+        # Setup some things
+        OpenStack.init_i18n
+        OpenStack.init_logging
+
+        # Load the actual provider
+        require_relative "provider"
+        Provider
+      end
+    end
+  end
+end

data/lib/vagrant-openstack/provider.rb

@@ -0,0 +1,50 @@
+require "vagrant"
+
+require "vagrant-openstack/action"
+
+module VagrantPlugins
+  module OpenStack
+    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_openstack.states.short_#{state_id}")
+        long  = I18n.t("vagrant_openstack.states.long_#{state_id}")
+
+        # Return the MachineState object
+        Vagrant::MachineState.new(state_id, short, long)
+      end
+
+      def to_s
+        "OpenStack Cloud"
+      end
+    end
+  end
+end

data/lib/vagrant-openstack/version.rb

@@ -0,0 +1,5 @@
+module VagrantPlugins
+  module OpenStack
+    VERSION = "1.1.2"
+  end
+end

data/lib/vagrant-openstack.rb

@@ -0,0 +1,53 @@
+require "pathname"
+
+require "vagrant-openstack/plugin"
+
+module VagrantPlugins
+  module OpenStack
+    lib_path = Pathname.new(File.expand_path("../vagrant-openstack", __FILE__))
+    autoload :Errors, lib_path.join("errors")
+
+    # This initializes the i18n load path so that the plugin-specific
+    # translations work.
+    def self.init_i18n
+      I18n.load_path << File.expand_path("locales/en.yml", source_root)
+      I18n.reload!
+    end
+
+    # This initializes the logging so that our logs are outputted at
+    # the same level as Vagrant core logs.
+    def self.init_logging
+      # Initialize logging
+      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_openstack")
+        logger.outputters = Log4r::Outputter.stderr
+        logger.level = level
+        logger = nil
+      end
+    end
+
+    # 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,81 @@
+en:
+  vagrant_openstack:
+    already_created: |-
+      The server is already created.
+    deleting_server: |-
+      Deleting server...
+    finding_flavor: |-
+      Finding flavor for server...
+    finding_image: |-
+      Finding image for server...
+    finding_network: |-
+      Finding network 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...
+
+    config:
+      api_key_required: |-
+        An API key is required.
+      username_required: |-
+        A username is required.
+
+    errors:
+      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.
+      ssh_unavailable: |-
+        The server has been created successfully but it refuses incomming
+        ssh connections.
+      no_matching_flavor: |-
+        No matching flavor was found! Please check your flavor setting
+        to make sure you have a valid flavor chosen.
+      no_matching_image: |-
+        No matching image was found! Please check your image setting to
+        make sure you have a valid image chosen.
+      no_matching_network: |-
+        No network was found for name "%{network_name}". Please check your
+        network setting to make sure you have a valid network chosen.
+      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_build: |-
+        building
+      long_build: |-
+        The server is currently being built. You must wait for this to
+        complete before you can access it. You can delete the server, however,
+        by running `vagrant destroy`.
+      short_shutoff: |-
+        shutoff
+      long_shutoff: |-
+        The server is shutoff.
+      short_error: |-
+        error
+      long_error: |-
+        The server is in an erroneous state. Destroy the machine with
+        `vagrant destroy`.
+      short_not_created: |-
+        not created
+      long_not_created: |-
+        The server is not created. Run `vagrant up` to create it.

data/openstack-vagrant.gemspec

@@ -0,0 +1,24 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'vagrant-openstack/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "openstack-vagrant"
+  gem.version       = VagrantPlugins::OpenStack::VERSION
+  gem.authors       = ["Mitchell Hashimoto"]
+  gem.email         = ["mitchell@hashicorp.com"]
+  gem.description   = "Enables Vagrant to manage machines in OpenStack Cloud."
+  gem.summary       = "Enables Vagrant to manage machines in OpenStack Cloud."
+  gem.homepage      = "http://www.vagrantup.com"
+
+  gem.add_runtime_dependency "fog", "~> 1.22"
+
+  gem.add_development_dependency "rake"
+  gem.add_development_dependency "rspec", "~> 2.13.0"
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+end