vagrant-openstack-provider 0.1

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.1.0"
+  raise "Openstack Cloud provider is only compatible with Vagrant 1.1+"
+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) 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 = "0.1"
+  end
+end

data/locales/en.yml

@@ -0,0 +1,85 @@
+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...
+    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!
+    timeout: |-
+      Timeout!
+    rsync_folder: |-
+      Rsyncing folder: %{hostpath} => %{guestpath}
+    waiting_for_build: |-
+      Waiting for the server to be built...
+    waiting_for_rackconnect: |-
+      Waiting for RackConnect to complete...
+    waiting_for_ssh: |-
+      Waiting for SSH to become available...
+    warn_networks: |-
+      Warning! The Openstack provider doesn't support any of the Vagrant
+      high-level network configurations (`config.vm.network`). They
+      will be silently ignored.
+
+    config:
+      api_key_required: |-
+        An API key is required.
+      username_required: |-
+        A username is required.
+      invalid_uri: |-
+        The value for %{key} is not a valid URI: %{uri}
+      metadata_must_be_hash: |-
+        Metadata must be a hash.
+
+    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.
+      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.
+      sync_method_error: |-
+        Value '%{sync_method_value}' is not allowed for 'sync_method' configuration parameter. Valid values are 'rsync' and 'none'
+      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}
+      ssh_unavailble: |-
+        SSH server anavailable on instance %{host}. You should maybe increase the timeout value which currently is %{timeout} second(s).
+
+    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_error: |-
+        error
+      long_error: |-
+        The server is in an erroneous state. Contact Openstack support
+        or 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/vagrant-openstack/config_spec.rb

@@ -0,0 +1,184 @@
+if ENV['COVERAGE'] != 'false'
+  require 'simplecov'
+  require 'coveralls'
+  SimpleCov.formatter = SimpleCov::Formatter::MultiFormatter[
+    SimpleCov::Formatter::HTMLFormatter,
+    Coveralls::SimpleCov::Formatter
+  ]
+  SimpleCov.start
+end
+
+require "vagrant-openstack/config"
+require 'fog'
+
+describe VagrantPlugins::Openstack::Config do
+  describe "defaults" do
+    let(:vagrant_public_key) { Vagrant.source_root.join("keys/vagrant.pub") }
+
+    subject do
+      super().tap do |o|
+        o.finalize!
+      end
+    end
+
+    its(:api_key)  { should be_nil }
+    its(:openstack_region) { should be_nil }
+    its(:openstack_compute_url) { should be_nil }
+    its(:openstack_auth_url) { should be_nil }
+    its(:flavor)   { should eq(/m1.tiny/) }
+    its(:image)    { should eq(/cirros/) }
+    its(:rackconnect) { should be_nil }
+    its(:network) { should be_nil }
+    its(:server_name) { should be_nil }
+    its(:username) { should be_nil }
+    its(:disk_config) { should be_nil }
+    its(:network) { should be_nil }
+    its(:rsync_includes) { should be_nil }
+    its(:keypair_name) { should be_nil }
+    its(:ssh_username) { should be_nil }
+  end
+
+  describe "overriding defaults" do
+    [:api_key,
+      :openstack_region,
+      :openstack_compute_url,
+      :openstack_auth_url,
+      :flavor,
+      :image,
+      :rackconnect,
+      :server_name,
+      :network,
+      :disk_config,
+      :username,
+      :keypair_name,
+      :ssh_username].each do |attribute|
+      it "should not default #{attribute} if overridden" do
+        subject.send("#{attribute}=".to_sym, "foo")
+        subject.finalize!
+        subject.send(attribute).should == "foo"
+      end
+    end
+
+    it "should not default rsync_includes if overridden" do 
+      inc = "core"
+      subject.send(:rsync_include, inc)
+      subject.finalize!
+      subject.send(:rsync_includes).should include(inc)
+    end
+  end
+
+  describe "validation" do
+    let(:machine) { double("machine") }
+    let(:validation_errors) { subject.validate(machine)['Openstack Provider'] }
+    let(:error_message) { double("error message") }
+
+    before(:each) do
+      machine.stub_chain(:env, :root_path).and_return '/'
+      subject.username = 'foo'
+      subject.api_key = 'bar'
+      subject.keypair_name = 'keypair'
+    end
+
+    subject do
+      super().tap do |o|
+        o.finalize!
+      end
+    end
+
+    context "with invalid key" do
+      it "should raise an error" do
+        subject.nonsense1 = true
+        subject.nonsense2 = false
+        I18n.should_receive(:t).with('vagrant.config.common.bad_field',
+          { :fields => 'nonsense1, nonsense2' })
+        .and_return error_message
+        validation_errors.first.should == error_message
+      end
+    end
+    context "with good values" do
+      it "should validate" do
+        validation_errors.should be_empty
+      end
+    end
+
+    context "the keypair name" do
+      it "should error if not given" do
+        subject.keypair_name = nil
+        I18n.should_receive(:t).with('vagrant_openstack.config.keypair_name required').and_return error_message
+        validation_errors.first.should == error_message
+      end
+    end
+
+    context "the API key" do
+      it "should error if not given" do
+        subject.api_key = nil
+        I18n.should_receive(:t).with('vagrant_openstack.config.api_key required').and_return error_message
+        validation_errors.first.should == error_message
+      end
+    end
+
+    context "the username" do
+      it "should error if not given" do
+        subject.username = nil
+        I18n.should_receive(:t).with('vagrant_openstack.config.username required').and_return error_message
+        validation_errors.first.should == error_message
+      end
+    end
+
+    [:openstack_compute_url, :openstack_auth_url].each do |url|
+      context "the #{url}" do
+        it "should not validate if the URL is invalid" do
+          subject.send "#{url}=", 'baz'
+          I18n.should_receive(:t).with('vagrant_openstack.config.invalid_uri', {:key => url, :uri => 'baz'}).and_return error_message
+          validation_errors.first.should == error_message
+        end
+      end
+    end
+  end
+
+  describe "openstack_auth_url" do
+    it "should return UNSET_VALUE if openstack_auth_url and openstack_region are UNSET" do
+      subject.openstack_auth_url.should == VagrantPlugins::Openstack::Config::UNSET_VALUE
+    end
+    it "should return UNSET_VALUE if openstack_auth_url is UNSET and openstack_region is :ord" do
+      subject.openstack_region = :ord
+      subject.openstack_auth_url.should == VagrantPlugins::Openstack::Config::UNSET_VALUE
+    end
+    it "should return custom endpoint if supplied and openstack_region is :lon" do
+      my_endpoint = 'http://custom-endpoint.com'
+      subject.openstack_region = :lon
+      subject.openstack_auth_url = my_endpoint
+      subject.openstack_auth_url.should == my_endpoint
+    end
+    it "should return custom endpoint if supplied and openstack_region is UNSET" do
+      my_endpoint = 'http://custom-endpoint.com'
+      subject.openstack_auth_url = my_endpoint
+      subject.openstack_auth_url.should == my_endpoint
+    end
+  end
+
+
+  describe "lon_region?" do
+    it "should return false if openstack_region is UNSET_VALUE" do
+      subject.openstack_region = VagrantPlugins::Openstack::Config::UNSET_VALUE
+      subject.send(:lon_region?).should be_false
+    end
+    it "should return false if openstack_region is nil" do
+      subject.openstack_region = nil
+      subject.send(:lon_region?).should be_false
+    end
+    it "should return false if openstack_region is :ord" do
+      subject.openstack_region = :ord
+      subject.send(:lon_region?).should be_false
+    end
+    it "should return true if openstack_region is 'lon'" do
+      subject.openstack_region = 'lon'
+      subject.send(:lon_region?).should be_true
+    end
+    it "should return true if openstack_Region is :lon" do
+      subject.openstack_region = :lon
+      subject.send(:lon_region?).should be_true
+    end
+  end
+
+end

data/stackrc

@@ -0,0 +1,32 @@
+
+#!/bin/bash
+
+# With the addition of Keystone, to use an openstack cloud you should
+# authenticate against keystone, which returns a **Token** and **Service
+# Catalog**.  The catalog contains the endpoint for all services the
+# user/tenant has access to - including nova, glance, keystone, swift.
+#
+# *NOTE*: Using the 2.0 *auth api* does not mean that compute api is 2.0.  We
+# will use the 1.1 *compute api*
+export OS_AUTH_URL=https://cloud.numergy.com:5000/v2.0/tokens
+export OS_COMPUTE_URL=https://cloud.numergy.com:8774/v2/7f264bf82ce7420e8d7939f31dd1daac
+
+# With the addition of Keystone we have standardized on the term **tenant**
+# as the entity that owns the resources.
+export OS_TENANT_ID=7f264bf82ce7420e8d7939f31dd1daac
+export OS_TENANT_NAME="PaaS"
+
+# In addition to the owning entity (tenant), openstack stores the entity
+# performing the action as the **user**.
+if [ -z "$OS_USERNAME" ]; then
+  echo "Please enter your OpenStack username: "
+  read -sr OS_USERNAME_INPUT
+  export OS_USERNAME=$OS_USERNAME_INPUT
+fi
+
+# With Keystone you pass the keystone password.
+if [ -z "$OS_PASSWORD" ]; then
+  echo "Please enter your OpenStack Password: "
+  read -sr OS_PASSWORD_INPUT
+  export OS_PASSWORD=$OS_PASSWORD_INPUT
+fi

data/vagrant-openstack.gemspec

@@ -0,0 +1,23 @@
+# -*- 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          = "vagrant-openstack-provider"
+  gem.version       = VagrantPlugins::Openstack::VERSION
+  gem.authors       = ["Guillaume Giamarchi", "Julien Vey"]
+  gem.email         = ["guillaume.giamarchi@gmail.com", "vey.julien@gmail.com"]
+  gem.description   = "Enables Vagrant to manage machines in Openstack Cloud."
+  gem.summary       = "Enables Vagrant to manage machines in Openstack Cloud."
+  gem.homepage      = "https://github.com/ggiamarchi/vagrant-openstack"
+
+  gem.add_development_dependency "rake"
+  gem.add_development_dependency "rspec", "~> 2.13.0"
+  gem.add_development_dependency "aruba"
+
+  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

metadata

@@ -0,0 +1,135 @@
+--- !ruby/object:Gem::Specification
+name: vagrant-openstack-provider
+version: !ruby/object:Gem::Version
+  version: '0.1'
+platform: ruby
+authors:
+- Guillaume Giamarchi
+- Julien Vey
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-04-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.13.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.13.0
+- !ruby/object:Gem::Dependency
+  name: aruba
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Enables Vagrant to manage machines in Openstack Cloud.
+email:
+- guillaume.giamarchi@gmail.com
+- vey.julien@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Appraisals
+- CHANGELOG.md
+- Gemfile
+- LICENSE.txt
+- RELEASE.md
+- Rakefile
+- Vagrantfile
+- dummy.box
+- example_box/README.md
+- example_box/metadata.json
+- features/provision.feature
+- features/steps/sdk_steps.rb
+- features/steps/server_steps.rb
+- features/support/env.rb
+- features/support/fog_mock.rb
+- features/vagrant-openstack.feature
+- gemfiles/latest_stable.gemfile
+- gemfiles/oldest_current.gemfile
+- gemfiles/previous_release.gemfile
+- lib/vagrant-openstack.rb
+- lib/vagrant-openstack/action.rb
+- lib/vagrant-openstack/action/connect_openstack.rb
+- lib/vagrant-openstack/action/create_server.rb
+- lib/vagrant-openstack/action/delete_server.rb
+- lib/vagrant-openstack/action/is_created.rb
+- lib/vagrant-openstack/action/message_already_created.rb
+- lib/vagrant-openstack/action/message_not_created.rb
+- lib/vagrant-openstack/action/read_ssh_info.rb
+- lib/vagrant-openstack/action/read_state.rb
+- lib/vagrant-openstack/action/sync_folders.rb
+- lib/vagrant-openstack/config.rb
+- lib/vagrant-openstack/errors.rb
+- lib/vagrant-openstack/openstack_client.rb
+- lib/vagrant-openstack/plugin.rb
+- lib/vagrant-openstack/provider.rb
+- lib/vagrant-openstack/version.rb
+- locales/en.yml
+- spec/vagrant-openstack/config_spec.rb
+- stackrc
+- vagrant-openstack.gemspec
+homepage: https://github.com/ggiamarchi/vagrant-openstack
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Enables Vagrant to manage machines in Openstack Cloud.
+test_files:
+- features/provision.feature
+- features/steps/sdk_steps.rb
+- features/steps/server_steps.rb
+- features/support/env.rb
+- features/support/fog_mock.rb
+- features/vagrant-openstack.feature
+- spec/vagrant-openstack/config_spec.rb