vagrant-openstack-cloud-provider 1.1.4

data/lib/vagrant-openstack-cloud-provider/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-cloud-provider/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-cloud-provider/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-cloud-provider/provider.rb

@@ -0,0 +1,50 @@
+require "vagrant"
+
+require "vagrant-openstack-cloud-provider/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-cloud-provider/version.rb

@@ -0,0 +1,5 @@
+module VagrantPlugins
+  module OpenStack
+    VERSION = "1.1.4"
+  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/spec/spec_helper.rb

@@ -0,0 +1,21 @@
+require_relative '../lib/vagrant-openstack-cloud-provider/errors'
+require 'simplecov'
+SimpleCov.start
+
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# Require this file using `require "spec_helper"` to ensure that it is only
+# loaded once.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = 'random'
+end

data/spec/vagrant-openstack-cloud-provider/action/create_server_spec.rb

@@ -0,0 +1,89 @@
+require 'spec_helper'
+require 'vagrant-openstack-cloud-provider/errors'
+require 'vagrant-openstack-cloud-provider/action/create_server'
+
+describe VagrantPlugins::OpenStack::Action::CreateServer do
+  describe '#server_to_be_available?' do
+    subject {
+      described_class.new(nil, nil)
+    }
+
+    let(:server) { double }
+
+    it "returns true when server is active" do
+      server.stub(:state).and_return('ACTIVE')
+      subject.server_to_be_available?(server).should == true
+    end
+
+    it "should raise when the server state is ERROR" do
+      server.stub(:state).and_return('ERROR')
+      expect { subject.server_to_be_available?(server) }.to raise_error(RuntimeError)
+    end
+  end
+
+  describe '#ssh_responding?' do
+    subject {
+      described_class.new(nil, nil)
+    }
+
+    let(:ui) { double }
+    let(:machine) { double }
+    let(:communicate) { double }
+
+    it "should continue if ssh is available" do
+      ui.stub(:info)
+      communicate.stub(:ready?).and_return(true)
+      machine.stub(:communicate).and_return(communicate)
+      env = { :ui => ui, :interrupted => false, :machine => machine }
+      subject.send('ssh_responding?', env)
+    end
+
+    it "should raise if ssh isn't available" do
+      ui.stub(:info)
+      communicate.stub(:ready?).and_return(false)
+      machine.stub(:communicate).and_return(communicate)
+      env = { :ui => ui, :interrupted => false, :machine => machine }
+      expect { subject.send('ssh_responding?', env) }.to raise_error(VagrantPlugins::OpenStack::Errors::SshUnavailable)
+    end
+  end
+
+  describe '#find_matching' do
+    subject {
+      described_class.new(nil, nil)
+    }
+
+    it "returns a match for a list of hashes" do
+      haystack = [{"status"=>"ACTIVE", "subnets"=>["d8908f8c-07f4-405b-bbab-e19c768f293f"], "name"=>"solidfire", "provider:physical_network"=>"physnet1", "admin_state_up"=>true, "tenant_id"=>"2c9fba23721f4126ab244020e641f5f5", "provider:network_type"=>"vlan", "router:external"=>false, "shared"=>true, "id"=>"192702e6-3444-4162-b244-3af8b50fbb45", "provider:segmentation_id"=>3999}, {"status"=>"ACTIVE", "subnets"=>["d4318e28-5acd-415f-b300-0502f33b0dea"], "name"=>"public", "provider:physical_network"=>"physnet0", "admin_state_up"=>true, "tenant_id"=>"2c9fba23721f4126ab244020e641f5f5", "provider:network_type"=>"vlan", "router:external"=>false, "shared"=>true, "id"=>"e44bf8cb-7326-4abc-b96d-5404d5ed7767", "provider:segmentation_id"=>2753}]
+      needle = {"status"=>"ACTIVE", "subnets"=>["d4318e28-5acd-415f-b300-0502f33b0dea"], "name"=>"public", "provider:physical_network"=>"physnet0", "admin_state_up"=>true, "tenant_id"=>"2c9fba23721f4126ab244020e641f5f5", "provider:network_type"=>"vlan", "router:external"=>false, "shared"=>true, "id"=>"e44bf8cb-7326-4abc-b96d-5404d5ed7767", "provider:segmentation_id"=>2753}
+
+      subject.send('find_matching', haystack, needle['name']).should == needle
+    end
+
+    it "returns a match for a list of objects with matching id" do
+      object1 = double()
+      object1.stub('id' => 'matching_value')
+      object1.stub('name' => 'not_this')
+
+      haystack = [object1]
+      subject.send('find_matching', haystack, 'matching_value').should == object1
+    end
+
+    it "returns a match for a list of objects with matching name" do
+      object1 = double()
+      object1.stub('id' => 'not_this')
+      object1.stub('name' => 'matching_value')
+
+      haystack = [object1]
+      subject.send('find_matching', haystack, 'matching_value').should == object1
+    end
+
+    it "returns a match for a list of objects with a matching regexp" do
+      object1 = double()
+      object1.stub('id' => 'not_this')
+      object1.stub('name' => '2020 des fin fin')
+
+      haystack = [object1]
+      subject.send('find_matching', haystack, /des fin/).should == object1
+    end
+  end
+end