vagrant-openstack-provider 0.5.2 → 0.6.0

data/lib/vagrant-openstack-provider/config_resolver.rb

@@ -40,11 +40,13 @@ module VagrantPlugins
         config = env[:machine].provider_config
         nova = env[:openstack_client].nova
         return config.floating_ip if config.floating_ip
-        fail Errors::UnableToResolveFloatingIP unless config.floating_ip_pool
-        nova.get_all_floating_ips(env).each do |single|
-          return single.ip if single.pool == config.floating_ip_pool && single.instance_id.nil?
-        end unless config.floating_ip_pool_always_allocate
-        nova.allocate_floating_ip(env, config.floating_ip_pool).ip
+        fail Errors::UnableToResolveFloatingIP if config.floating_ip_pool.nil? || config.floating_ip_pool.empty?
+        @logger.debug 'Searching for available ips'
+        free_ip = search_free_ip(config, nova, env)
+        return free_ip unless free_ip.nil?
+        @logger.debug 'Allocate new ip anyway'
+        allocated_ip = allocate_ip(config, nova, env)
+        return allocated_ip unless allocated_ip.nil?
       end
 
       def resolve_keypair(env)
@@ -133,6 +135,35 @@ module VagrantPlugins
 
       private
 
+      def search_free_ip(config, nova, env)
+        @logger.debug 'Retrieving all allocated floating ips on tenant'
+        all_floating_ips = nova.get_all_floating_ips(env)
+        all_floating_ips.each do |floating_ip|
+          log_attach = floating_ip.instance_id ? "attached to #{floating_ip.instance_id}" : 'not attached'
+          @logger.debug "#{floating_ip.ip} #{log_attach}" if config.floating_ip_pool.include? floating_ip.pool
+          return floating_ip.ip if (config.floating_ip_pool.include? floating_ip.pool) && floating_ip.instance_id.nil?
+        end unless config.floating_ip_pool_always_allocate
+        @logger.debug 'No free ip found'
+        nil
+      end
+
+      def allocate_ip(config, nova, env)
+        allocation_error = nil
+        config.floating_ip_pool.each do |floating_ip_pool|
+          begin
+            @logger.debug "Allocating ip in pool #{floating_ip_pool}"
+            return nova.allocate_floating_ip(env, floating_ip_pool).ip
+          rescue Errors::VagrantOpenstackError => e
+            @logger.warn "Error allocating ip in pool #{floating_ip_pool} : #{e}"
+            allocation_error = e
+            next if e.extra_data[:code] == 404
+            raise allocation_error
+          end
+        end
+        @logger.warn 'Impossible to allocate a new IP'
+        fail allocation_error
+      end
+
       def generate_keypair(env)
         key = SSHKey.generate
         nova = env[:openstack_client].nova

data/lib/vagrant-openstack-provider/errors.rb

@@ -8,6 +8,10 @@ module VagrantPlugins
         error_key(:default)
       end
 
+      class Timeout < VagrantOpenstackError
+        error_key(:timeout)
+      end
+
       class AuthenticationRequired < VagrantOpenstackError
         error_key(:authentication_required)
       end
@@ -20,8 +24,8 @@ module VagrantPlugins
         error_key(:bad_authentication_endpoint)
       end
 
-      class MultipleApiVersion < VagrantOpenstackError
-        error_key(:multiple_api_version)
+      class NoMatchingApiVersion < VagrantOpenstackError
+        error_key(:no_matching_api_version)
       end
 
       class CreateBadState < VagrantOpenstackError
@@ -132,6 +136,10 @@ module VagrantPlugins
         error_key(:instance_not_found)
       end
 
+      class StackNotFound < VagrantOpenstackError
+        error_key(:stack_not_found)
+      end
+
       class NetworkServiceUnavailable < VagrantOpenstackError
         error_key(:nerwork_service_unavailable)
       end
@@ -139,6 +147,26 @@ module VagrantPlugins
       class VolumeServiceUnavailable < VagrantOpenstackError
         error_key(:volume_service_unavailable)
       end
+
+      class FloatingIPAlreadyAssigned < VagrantOpenstackError
+        error_key(:floating_ip_already_assigned)
+      end
+
+      class FloatingIPNotAvailable < VagrantOpenstackError
+        error_key(:floating_ip_not_available)
+      end
+
+      class ServerStatusError < VagrantOpenstackError
+        error_key(:server_status_error)
+      end
+
+      class StackStatusError < VagrantOpenstackError
+        error_key(:stack_status_error)
+      end
+
+      class MissingNovaEndpoint < VagrantOpenstackError
+        error_key(:missing_nova_endpoint)
+      end
     end
   end
 end

data/lib/vagrant-openstack-provider/logging.rb

@@ -0,0 +1,39 @@
+module VagrantPlugins
+  module Openstack
+    module Logging
+      # This initializes the logging so that our logs are outputted at
+      # the same level as Vagrant core logs.
+      def self.init
+        # 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.
+          begin
+            level = Log4r.const_get(ENV['VAGRANT_OPENSTACK_LOG'].upcase)
+          rescue NameError
+            level = nil
+          end
+        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 unless level.is_a?(Integer)
+
+        # Set the logging level
+        # logs as long as we have a valid level.
+        if level
+          logger = Log4r::Logger.new('vagrant_openstack')
+          out = Log4r::Outputter.stdout
+          out.formatter = Log4r::PatternFormatter.new(pattern: '%d | %5l | %m', date_pattern: '%Y-%m-%d %H:%M')
+          logger.outputters = out
+          logger.level = level
+        end
+      end
+    end
+  end
+end

data/lib/vagrant-openstack-provider/version.rb

@@ -1,5 +1,5 @@
 module VagrantPlugins
   module Openstack
-    VERSION = '0.5.2'
+    VERSION = '0.6.0'
   end
 end

data/locales/en.yml

@@ -1,9 +1,32 @@
 en:
   vagrant_openstack:
+    global_error: |-
+      An unknow error happened in Vagrant OpenStack provider
+
+      To easily debug what happened, we recommend to set the environment
+      variable VAGRANT_OPENSTACK_LOG to debug
+
+          $ export VAGRANT_OPENSTACK_LOG=debug
+
+      If doing this does not help fixing your issue, there may be a bug
+      in the provider. Please submit an issue on Github at
+      https://github.com/ggiamarchi/vagrant-openstack-provider
+      with the stracktrace and the logs.
+
+      We are looking for feedback, so feel free to ask questions or
+      describe features you would like to see in this provider.
     already_created: |-
       The server is already created.
+    create_stack: |-
+      Creating Heat Stack.
+    delete_stack: |-
+      Deleting Heat Stack.
     already_suspended: |-
-      The server is already suspended
+      The server is already suspended.
+    ongoing_task: |-
+      The server is currently running a task and cannot execute your request.
+    not_suspended: |-
+      The server is not currently "suspended" and cannot be resumed.
     deleting_server: |-
       Deleting server...
     finding_flavor: |-
@@ -40,6 +63,12 @@ en:
       Waiting for the server to stop...
     waiting_start: |-
       Waiting for the server to start...
+    waiting_deleted: |-
+      Waiting for the server to be deleted...
+    waiting_for_stack: |-
+      Waiting for Heat Stack to be created...
+    waiting_for_stack_deleted: |-
+      Waiting for Heat Stack to be created...
     warn_networks: |-
       Warning! The Openstack provider doesn't support any of the Vagrant
       high-level network configurations (`config.vm.network`). They
@@ -48,6 +77,12 @@ en:
       As Neutron endpoint is not available, the identifier '%{network}' is assumed to be an id (not a name).
     warn_volume_identifier_is_assumed_to_be_an_id: |-
       As Cinder endpoint is not available, the identifier '%{volume}' is assumed to be an id (not a name).
+    ssh_disabled_provisioning: |-
+      Provisioning will not be performed because provider config ssh_disabled is set to true
+    ssh_disabled_sync_folders: |-
+      Folders will not be synced because provider config ssh_disabled is set to true
+    disabled_sync_folders: |-
+      Sync folders are disabled in the provider configuration
 
     config:
       password_required: |-
@@ -56,6 +91,13 @@ en:
         A username is required.
       invalid_uri: |-
         The value for %{key} is not a valid URI: %{uri}
+      invalid_stack: |-
+        One of the stacks in the stacks provider configuration is invalid
+        The configuration option should have the following format:
+        os.stacks                = [{
+          name: 'mystack',
+          template: '/path/to/heat_template.yml',
+        }]
       metadata_must_be_hash: |-
         Metadata must be a hash.
       keypair_name_required: |-
@@ -78,8 +120,14 @@ en:
     errors:
       default: |-
         %{message}
+      timeout: |-
+        Timeout occurred
       authentication_required: |-
         Authentication token is missing or no longer valid.
+      floating_ip_already_assigned: |-
+        Floating IP %{floating_ip} already assigned to another server
+      floating_ip_not_available: |-
+        Floating IP %{floating_ip} not available for this tenant
       authentication_failed: |-
         Authentication failed.
       bad_authentication_endpoint: |-
@@ -89,11 +137,11 @@ en:
         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.
-      multiple_api_version: |-
-        Multiple version found for %{api_name} API
+      no_matching_api_version: |-
+        No matching version found for %{api_name} API
 
         %{version_list}
-        You must specify the desired network API url by setting
+        You must specify the desired %{api_name} API url by setting
         the provider's property '%{url_property}'.
       no_matching_flavor: |-
         No matching flavor was found! Please check your flavor setting
@@ -158,12 +206,21 @@ en:
         Dashboard instead of using vagrant commands.
         We recommend using the command `vagrant openstack reset` to reset
         vagrant to a clear state
+      stack_not_found: |-
+        Heat stack not found
       nerwork_service_unavailable: |-
         Neutron service endpoint is not available, thus there is not way to retrieve
         network id from its name. You have to provide only ids in your Vagrantfile.
       volume_service_unavailable: |-
         Cinder service endpoint is not available, thus there is not way to retrieve
         volume id from its name. You have to provide only ids in your Vagrantfile.
+      server_status_error: |-
+        Server '%{server}' is in error status.
+      stack_status_error: |-
+        Heat Stack '%{stack}' is in error status.
+      missing_nova_endpoint: |-
+        Nova endpoint must either be present in your keystone service catalog or be
+        specified using the provider's attribute 'openstack_compute_url'
 
     states:
       short_active: |-
@@ -239,6 +296,50 @@ en:
         not created
       long_not_created: |-
         The server is not created. Run `vagrant up` to create it.
+      short_suspending: |-
+        suspending
+      long_suspending: |-
+        The server is active and currently suspending, either by request or necessity.
+      short_resuming: |-
+        resuming
+      long_resuming: |-
+        The server is suspended and currently resuming by request.
+      short_spawning: |-
+        spawning
+      long_spawning: |-
+        The server is not created yet but is currently spawning by request.
+      short_scheduling: |-
+        scheduling
+      long_scheduling: |-
+        The server is building and currently scheduling by necessity.
+      short_deleting: |-
+        deleting
+      long_deleting: |-
+        The server is created and currently deleting by request.
+      short_rebooting: |-
+        rebooting
+      long_rebooting: |-
+        The server is currently rebooting, either by request or necessity.
+      short_reboot_pending: |-
+        reboot_pending
+      long_reboot_pending: |-
+        The server reboot is pending by necessity.
+      short_reboot_started: |-
+        reboot_started
+      long_reboot_started: |-
+        The server is starting to reboot, either by request or necessity.
+      short_rebooting_hard: |-
+        rebooting_hard
+      long_rebooting_hard: |-
+        The server is currently hard rebooting, either by request.
+      short_reboot_pending_hard: |-
+        reboot_pending_hard
+      long_reboot_pending_hard: |-
+        The server hard reboot is pending by necessity.
+      short_reboot_started_hard: |-
+        reboot_started_hard
+      long_reboot_started_hard: |-
+        The server is starting to hard reboot by request.
 
     client:
       looking_for_available_endpoints: |-
@@ -261,6 +362,8 @@ en:
         List available flavors
       network_list_synopsis : |-
         List private networks in project
+      subnet_list_synopsis : |-
+        List subnets for available networks
       flaotingip_list_synopsis : |-
         List floating IP and floating IP pools
       volume_list_synopsis : |-

data/spec/vagrant-openstack-provider/action/connect_openstack_spec.rb

@@ -17,9 +17,11 @@ describe VagrantPlugins::Openstack::Action::ConnectOpenstack do
       config.stub(:openstack_compute_url) { nil }
       config.stub(:openstack_network_url) { nil }
       config.stub(:openstack_volume_url) { nil }
+      config.stub(:openstack_image_url) { nil }
       config.stub(:tenant_name) { 'testTenant' }
       config.stub(:username) { 'username' }
       config.stub(:password) { 'password' }
+      config.stub(:region) { nil }
     end
   end
 
@@ -42,6 +44,82 @@ describe VagrantPlugins::Openstack::Action::ConnectOpenstack do
     end
   end
 
+  let(:neutron_france) do
+    double.tap do |neutron|
+      neutron.stub(:get_api_version_list).with(anything) do
+        [
+          {
+            'status' => 'CURRENT',
+            'id' => 'v2.0',
+            'links' => [
+              {
+                'href' => 'http://france.neutron/v2.0',
+                'rel' => 'self'
+              }
+            ]
+          }
+        ]
+      end
+    end
+  end
+
+  let(:glance) do
+    double.tap do |glance|
+      glance.stub(:get_api_version_list).with(anything) do
+        [
+          {
+            'status' => 'CURRENT',
+            'id' => 'v2.1',
+            'links' => [
+              {
+                'href' => 'http://glance/v2.0',
+                'rel' => 'self'
+              }
+            ]
+          }
+        ]
+      end
+    end
+  end
+
+  let(:glance_v1) do
+    double.tap do |glance|
+      glance.stub(:get_api_version_list).with(anything) do
+        [
+          {
+            'status' => 'CURRENT',
+            'id' => 'v1.0',
+            'links' => [
+              {
+                'href' => 'http://glance/v1',
+                'rel' => 'self'
+              }
+            ]
+          }
+        ]
+      end
+    end
+  end
+
+  let(:glance_france) do
+    double.tap do |glance|
+      glance.stub(:get_api_version_list).with(anything) do
+        [
+          {
+            'status' => 'CURRENT',
+            'id' => 'v2.1',
+            'links' => [
+              {
+                'href' => 'http://france.glance/v2.0',
+                'rel' => 'self'
+              }
+            ]
+          }
+        ]
+      end
+    end
+  end
+
   let(:env) do
     Hash.new.tap do |env|
       env[:ui] = double
@@ -51,6 +129,7 @@ describe VagrantPlugins::Openstack::Action::ConnectOpenstack do
       env[:machine].stub(:provider_config) { config }
       env[:openstack_client] = double('openstack_client')
       env[:openstack_client].stub(:neutron) { neutron }
+      env[:openstack_client].stub(:glance) { glance }
     end
   end
 
@@ -86,6 +165,26 @@ describe VagrantPlugins::Openstack::Action::ConnectOpenstack do
             ],
             'type' => 'network',
             'name' => 'neutron'
+          },
+          {
+            'endpoints' => [
+              {
+                'publicURL' => 'http://cinder/v2/projectId',
+                'id' => '2'
+              }
+            ],
+            'type' => 'volume',
+            'name' => 'cinder'
+          },
+          {
+            'endpoints' => [
+              {
+                'publicURL' => 'http://glance',
+                'id' => '2'
+              }
+            ],
+            'type' => 'image',
+            'name' => 'glance'
           }
         ]
 
@@ -93,18 +192,103 @@ describe VagrantPlugins::Openstack::Action::ConnectOpenstack do
           keystone.stub(:authenticate).with(anything) { catalog }
           env[:openstack_client].stub(:keystone) { keystone }
         end
-        env[:openstack_client].stub(:neutron) { neutron }
+        env[:openstack_client].stub(:neutron)  { neutron }
+        env[:openstack_client].stub(:glance)   { glance }
 
         @action.call(env)
 
         expect(env[:openstack_client].session.endpoints)
-          .to eq(compute: 'http://nova/v2/projectId', network: 'http://neutron/v2.0')
+          .to eq(compute: 'http://nova/v2/projectId',
+                 network: 'http://neutron/v2.0',
+                 volume:  'http://cinder/v2/projectId',
+                 image:   'http://glance/v2.0')
+      end
+    end
+
+    context 'with multiple regions' do
+      it 'read service catalog and stores endpoints URL for desired regions in session' do
+        catalog = [
+          {
+            'endpoints' => [
+              {
+                'publicURL' => 'http://france.nova/v2/projectId',
+                'id' => '1',
+                'region' => 'france'
+              },
+              {
+                'publicURL' => 'http://us.nova/v2/projectId',
+                'id' => '4',
+                'region' => 'us'
+              }
+            ],
+            'type' => 'compute',
+            'name' => 'nova'
+          },
+          {
+            'endpoints' => [
+              {
+                'publicURL' => 'http://france.neutron',
+                'id' => '2',
+                'region' => 'france'
+              },
+              {
+                'publicURL' => 'http://us.neutron',
+                'id' => '5',
+                'region' => 'us'
+              }
+            ],
+            'type' => 'network',
+            'name' => 'neutron'
+          },
+          {
+            'endpoints' => [
+              {
+                'publicURL' => 'http://france.glance',
+                'id' => '3',
+                'region' => 'france'
+              },
+              {
+                'publicURL' => 'http://us.glance',
+                'id' => '6',
+                'region' => 'us'
+              }
+            ],
+            'type' => 'image',
+            'name' => 'glance'
+          }
+        ]
+
+        double.tap do |keystone|
+          keystone.stub(:authenticate).with(anything) { catalog }
+          env[:openstack_client].stub(:keystone) { keystone }
+        end
+
+        env[:openstack_client].stub(:neutron)  { neutron_france }
+        env[:openstack_client].stub(:glance)   { glance_france }
+        config.stub(:region) { 'france' }
+
+        @action.call(env)
+
+        expect(env[:openstack_client].session.endpoints)
+        .to eq(compute: 'http://france.nova/v2/projectId',
+               network: 'http://france.neutron/v2.0',
+               image:   'http://france.glance/v2.0')
       end
     end
 
     context 'with multiple endpoints for a service' do
       it 'takes the first one' do
         catalog = [
+          {
+            'endpoints' => [
+              {
+                'publicURL' => 'http://nova',
+                'id' => '1'
+              }
+            ],
+            'type' => 'compute',
+            'name' => 'nova'
+          },
           {
             'endpoints' => [
               {
@@ -129,11 +313,74 @@ describe VagrantPlugins::Openstack::Action::ConnectOpenstack do
 
         @action.call(env)
 
-        expect(env[:openstack_client].session.endpoints).to eq(network: 'http://neutron/v2.0')
+        expect(env[:openstack_client].session.endpoints).to eq(compute: 'http://nova', network: 'http://neutron/v2.0')
+      end
+    end
+
+    context 'with glance v1 only' do
+      it 'read service catalog and stores endpoints URL in session', :focus do
+        catalog = [
+          {
+            'endpoints' => [
+              {
+                'publicURL' => 'http://nova/v2/projectId',
+                'id' => '1'
+              }
+            ],
+            'type' => 'compute',
+            'name' => 'nova'
+          },
+          {
+            'endpoints' => [
+              {
+                'publicURL' => 'http://glance',
+                'id' => '2'
+              }
+            ],
+            'type' => 'image',
+            'name' => 'glance'
+          }
+        ]
+
+        double.tap do |keystone|
+          keystone.stub(:authenticate).with(anything) { catalog }
+          env[:openstack_client].stub(:keystone) { keystone }
+        end
+        env[:openstack_client].stub(:glance) { glance_v1 }
+
+        @action.call(env)
+
+        expect(env[:openstack_client].session.endpoints)
+        .to eq(compute: 'http://nova/v2/projectId',
+               image:   'http://glance/v1')
+      end
+    end
+
+    context 'with nova endpoint missing' do
+      it 'raise an error' do
+        catalog = [
+          {
+            'endpoints' => [
+              {
+                'publicURL' => 'http://keystone',
+                'id' => '1'
+              }
+            ],
+            'type' => 'identity',
+            'name' => 'keystone'
+          }
+        ]
+
+        double.tap do |keystone|
+          keystone.stub(:authenticate).with(anything) { catalog }
+          env[:openstack_client].stub(:keystone) { keystone }
+        end
+
+        expect { @action.call(env) }.to raise_error Errors::MissingNovaEndpoint
       end
     end
 
-    context 'with multiple versions for network service' do
+    context 'with no matching versions for network service' do
 
       let(:neutron) do
         double.tap do |neutron|
@@ -141,10 +388,10 @@ describe VagrantPlugins::Openstack::Action::ConnectOpenstack do
             [
               {
                 'status' => 'CURRENT',
-                'id' => 'v2.0',
+                'id' => 'v1.1',
                 'links' => [
                   {
-                    'href' => 'http://neutron/v2.0',
+                    'href' => 'http://neutron/v1.1',
                     'rel' => 'self'
                   }
                 ]
@@ -164,7 +411,7 @@ describe VagrantPlugins::Openstack::Action::ConnectOpenstack do
         end
       end
 
-      it 'raise a MultipleApiVersion error' do
+      it 'raise an error' do
         catalog = [
           {
             'endpoints' => [
@@ -184,7 +431,7 @@ describe VagrantPlugins::Openstack::Action::ConnectOpenstack do
         end
         env[:openstack_client].stub(:neutron) { neutron }
 
-        expect { @action.call(env) }.to raise_error(Errors::MultipleApiVersion)
+        expect { @action.call(env) }.to raise_error(Errors::NoMatchingApiVersion)
       end
     end