vagrant-profitbricks 1.0.0

data/lib/vagrant-profitbricks/errors.rb

@@ -0,0 +1,39 @@
+require "vagrant"
+
+module VagrantPlugins
+  module ProfitBricks
+    module Errors
+      class VagrantProfitBricksError < Vagrant::Errors::VagrantError
+        error_namespace("vagrant_profitbricks.errors")
+      end
+
+      class CreateBadState < VagrantProfitBricksError
+        error_key(:create_bad_state)
+      end
+
+      class NoMatchingFlavor < VagrantProfitBricksError
+        error_key(:no_matching_flavor)
+      end
+
+      class NoMatchingImage < VagrantProfitBricksError
+        error_key(:no_matching_image)
+      end
+
+      class NoMatchingDatacenter < VagrantProfitBricksError
+        error_key(:no_matching_datacenter)
+      end
+
+      class RsyncError < VagrantProfitBricksError
+        error_key(:rsync_error)
+      end
+
+      class ImageOrLicenceTypeMustBeProvided < VagrantProfitBricksError
+        error_key(:image_or_licence_type_must_be_provided)
+      end
+
+      class ImagePasswordOrSSHKeysMustBeProvided < VagrantProfitBricksError
+        error_key(:image_password_or_ssh_keys_must_be_provided)
+      end     
+    end
+  end
+end

data/lib/vagrant-profitbricks/plugin.rb

@@ -0,0 +1,44 @@
+begin
+  require "vagrant"
+rescue LoadError
+  raise "The ProfitBricks 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 "ProfitBricks Cloud provider is only compatible with Vagrant 1.1+"
+end
+
+module VagrantPlugins
+  module ProfitBricks
+    class Plugin < Vagrant.plugin("2")
+      name "ProfitBricks Cloud"
+      description <<-DESC
+        This plugin enables Vagrant to manage machines in the ProfitBricks Cloud.
+      DESC
+
+      config(:profitbricks, :provider) do
+        require_relative "config"
+        Config
+      end
+
+      provider(:profitbricks, { :box_optional => true, parallel: true}) do
+        # Setup localization and logging
+        ProfitBricks.init_i18n
+        ProfitBricks.init_logging
+
+        # Load the actual provider
+        require_relative "provider"
+        Provider
+      end
+
+      command('profitbricks') do
+        ProfitBricks.init_i18n
+        
+        require_relative "command/root"
+        Command::Root
+      end
+    end
+  end
+end

data/lib/vagrant-profitbricks/provider.rb

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

data/lib/vagrant-profitbricks/version.rb

@@ -0,0 +1,5 @@
+module VagrantPlugins
+  module ProfitBricks
+    VERSION = "1.0.0"
+  end
+end

data/locales/en.yml

@@ -0,0 +1,124 @@
+en:
+  vagrant_profitbricks:
+    already_created: |-
+      The server is already created.
+    creating_image: |-
+      Creating image...
+    deleting_server: |-
+      Deleting server and attached volumes...
+    finding_flavor: |-
+      Finding flavor for server...
+    finding_image: |-
+      Finding image for server...
+    creating_volume: |-
+      Creating volume for server...
+    creating_server: |-
+      Creating server...
+    attaching_volume: |-
+      Attaching volume to server...
+    creating_interface: |-
+      Creating nic interface with internet access...
+    image_ready: |-
+      Image created
+    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_profitbricks_connect: |-
+      Waiting for ProfitBricks Connection to complete...
+    waiting_for_communicator: |-
+      Waiting for %{communicator} to become available at %{address}...
+    warn_insecure_ssh: |-
+      Warning! By not specifying a custom public/private keypair,
+      Vagrant is defaulting to use the insecure keypair that ships with
+      Vagrant. While this isn't much of a big deal for local development,
+      this is quite insecure for remote servers. Please specify a custom
+      public/private keypair.
+    warn_insecure_winrm: |-
+      Warning! Vagrant is using plaintext communication for WinRM. While
+      this isn't much of a big deal for local development, this is quite
+      insecure for remote servers. Please configure WinRM to use SSL.
+    will_not_destroy: |-
+      The server will not be deleted.
+    sync_folders: |-
+        Profitbricks support for Vagrant 1.3 has been deprecated. Please
+        upgrade to the latest version of vagrant for continued support.
+    creating_datacenter: |-
+      Creating datacenter %{name}, in location %{location}.
+    config:
+      password_required: |-
+        An API password is required.
+      public_key_not_found: |-
+        The public key file could not be found. Please make sure
+        you specified a valid path.
+      username_required: |-
+        A username is required.
+      datacenter_required: |-
+        A datacenter id or name (can be regex) is required.
+      invalid_uri: |-
+        The value for %{key} is not a valid URI: %{uri}
+      metadata_must_be_hash: |-
+        Metadata must be a hash.
+    command:
+      available_subcommands: |-
+        Available subcommands:
+      help_subcommands: |-
+        For help on any individual subcommand run
+      synopsis: |-
+        ProfitBricks provider specific commands
+    errors:
+      server_not_found: |-
+        Vagrant was unable to find the ProfitBricks server used for your vagrant machine.
+        It might be already deleted.
+      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.
+      no_matching_datacenter: |-
+        No matching datacenter was found! Please check your datacenter id to
+        make sure you have a valid id 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_error: |-
+        error
+      long_error: |-
+        The server is in an erroneous state. Contact ProfitBricks 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.
+      long_available: |-
+        The server is up and running. Run `vagrant ssh` to access it.
+      short_available: |-
+        available

data/spec/spec_helper.rb

@@ -0,0 +1,20 @@
+if ENV['COVERAGE'] != 'false'
+  require 'simplecov'
+  require 'coveralls'
+  SimpleCov.formatter = SimpleCov::Formatter::MultiFormatter[
+    SimpleCov::Formatter::HTMLFormatter,
+    Coveralls::SimpleCov::Formatter
+  ]
+  SimpleCov.start
+
+  # Normally classes are lazily loaded, so any class without a test
+  # is missing from the report.  This ensures they show up so we can
+  # see uncovered methods.
+  require 'vagrant'
+  Dir["lib/**/*.rb"].each do|file|
+    require_string = file.match(/lib\/(.*)\.rb/)[1]
+    require require_string
+  end
+end
+
+require 'fog/profitbricks'

data/spec/vagrant-profitbricks/actions/list_flavors_spec.rb

@@ -0,0 +1,48 @@
+require 'spec_helper'
+require "vagrant-profitbricks/action/list_flavors"
+
+describe VagrantPlugins::ProfitBricks::Action::ListFlavors do
+  let(:app) { lambda { |env| } }
+  let(:ui) { Vagrant::UI::Silent.new }
+  let(:flavors) {
+    Fog.mock!
+    Fog::Compute.new({
+      :provider => :profitbricks,
+      :profitbricks_username => 'anything',
+	  :profitbricks_password => 'anything'
+    }).flavors
+  }
+  let(:compute_connection) { double('fog connection') }
+  let(:env) do
+    {
+      :profitbricks_compute => compute_connection,
+      :ui => ui
+    }
+  end
+
+  subject(:action) { described_class.new(app, env) }
+
+  before do
+    allow(compute_connection).to receive(:flavors).and_return flavors
+  end
+
+  it 'get flavors from Fog' do
+    expect(compute_connection).to receive(:flavors).and_return flavors
+    action.call(env)
+  end
+
+  it 'writes a sorted, formatted flavor table to Vagrant::UI' do
+    header_line = '%-36s %s' % ['Flavor ID', 'Flavor Name']
+    expect(ui).to receive(:info).with(header_line)
+    flavors.sort_by(&:id).each do |flavor|
+      formatted_line = '%-36s %s' % [flavor.id, flavor.name]
+      expect(ui).to receive(:info).with formatted_line
+    end
+    action.call(env)
+  end
+
+  it 'continues the middleware chain' do
+    expect(app).to receive(:call).with(env)
+    action.call(env)
+  end
+end

data/spec/vagrant-profitbricks/actions/list_images_spec.rb

@@ -0,0 +1,48 @@
+require 'spec_helper'
+require "vagrant-profitbricks/action/list_images"
+
+describe VagrantPlugins::ProfitBricks::Action::ListImages do
+  let(:app) { lambda { |env| } }
+  let(:ui) { Vagrant::UI::Silent.new }
+  let(:images) {
+    Fog.mock!
+    Fog::Compute.new({
+      :provider => :profitbricks,
+      :profitbricks_password => 'anything',
+      :profitbricks_username => 'anything',
+    }).images
+  }
+  let(:compute_connection) { double('fog connection') }
+  let(:env) do
+    {
+      :profitbricks_compute => compute_connection,
+      :ui => ui
+    }
+  end
+
+  subject(:action) { described_class.new(app, env) }
+
+  before do
+    allow(compute_connection).to receive(:images).and_return images
+  end
+
+  it 'get images from Fog' do
+    expect(compute_connection).to receive(:images).and_return images
+    action.call(env)
+  end
+
+  it 'writes a sorted, formatted image table to Vagrant::UI' do
+    header_line = '%-36s %s' % ['Image ID', 'Image Name']
+    expect(ui).to receive(:info).with(header_line)
+    images.sort_by(&:name).each do |image|
+      formatted_line = '%-36s %s' % [image.id.to_s, image.name]
+      expect(ui).to receive(:info).with formatted_line
+    end
+    action.call(env)
+  end
+
+  it 'continues the middleware chain' do
+    expect(app).to receive(:call).with(env)
+    action.call(env)
+  end
+end

data/spec/vagrant-profitbricks/config_spec.rb

@@ -0,0 +1,150 @@
+require 'spec_helper'
+require "vagrant-profitbricks/config"
+
+describe VagrantPlugins::ProfitBricks::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(:password)  { should be_nil }
+    its(:profitbricks_url) { should be_nil }
+    its(:profitbricks_cores) { should eq(1) }
+    its(:profitbricks_ram) { should eq(256) }
+    its(:image) { should eq(/ubuntu/) }
+    its(:server_name) { should be_nil }
+    its(:username) { should be_nil }
+    its(:networks) { should be_nil }
+    its(:admin_password)  { should be_nil }
+  end
+
+  describe "overriding defaults" do
+    [:password,
+      :profitbricks_url,
+      :profitbricks_cores,
+      :profitbricks_ram,
+      :image,
+      :server_name,
+      :username,
+      :admin_password
+    ].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 networks if overridden" do
+      net_id = "deadbeef-0000-0000-0000-000000000000"
+      subject.send(:network, net_id)
+      subject.finalize!
+      subject.send(:networks).should include(net_id)
+      subject.send(:networks).should include(VagrantPlugins::ProfitBricks::Config::PUBLIC_NET_ID)
+      subject.send(:networks).should include(VagrantPlugins::ProfitBricks::Config::SERVICE_NET_ID)
+    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)['ProfitBricks Provider'] }
+    let(:error_message) { double("error message") }
+
+    before(:each) do
+      machine.stub_chain(:env, :root_path).and_return '/'
+      subject.username = 'foo'
+      subject.password = 'bar'
+      subject.datacenter_id = 'dc'
+    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 API password" do
+      it "should error if not given" do
+        subject.password = nil
+        I18n.should_receive(:t).with('vagrant_profitbricks.config.password_required').and_return error_message
+        validation_errors.first.should == error_message
+      end
+    end
+
+    # context "the public key path" do
+    #   it "should have errors if the key doesn't exist" do
+    #     subject.public_key_path = 'missing'
+    #     I18n.should_receive(:t).with('vagrant_profitbricks.config.public_key_not_found').and_return error_message
+    #     validation_errors.first.should == error_message
+    #   end
+    #   it "should not have errors if the key exists with an absolute path" do
+    #     subject.public_key_path = File.expand_path 'locales/en.yml', Dir.pwd
+    #     validation_errors.should be_empty
+    #   end
+    #   it "should not have errors if the key exists with a relative path" do
+    #     machine.stub_chain(:env, :root_path).and_return '.'
+    #     subject.public_key_path = 'locales/en.yml'
+    #     validation_errors.should be_empty
+    #   end
+    # end
+
+    context "the username" do
+      it "should error if not given" do
+        subject.username = nil
+        I18n.should_receive(:t).with('vagrant_profitbricks.config.username_required').and_return error_message
+        validation_errors.first.should == error_message
+      end
+    end
+
+    [:profitbricks_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_profitbricks.config.invalid_uri', {:key => url, :uri => 'baz'}).and_return error_message
+          validation_errors.first.should == error_message
+        end
+      end
+    end
+  end
+
+  describe "network" do
+    it "should remove SERVICE_NET_ID if :service_net is detached" do
+      subject.send(:network, :service_net, :attached => false)
+      subject.send(:networks).should_not include(VagrantPlugins::ProfitBricks::Config::SERVICE_NET_ID)
+    end
+
+    it "should not allow duplicate networks" do
+      net_id = "deadbeef-0000-0000-0000-000000000000"
+      subject.send(:network, net_id)
+      subject.send(:network, net_id)
+      subject.send(:networks).count(net_id).should == 1
+    end
+  end
+end