vagrant-openstack-provider 0.4.1 → 0.5.0

data/lib/vagrant-openstack-provider/command/abstract_command.rb

@@ -6,7 +6,7 @@ module VagrantPlugins
       class AbstractCommand < Vagrant.plugin('2', :command)
         def initialize(argv, env)
           @env = env
-          super(argv, env)
+          super(normalize_args(argv), env)
         end
 
         def execute(name)
@@ -22,6 +22,15 @@ module VagrantPlugins
           @env.ui.info('')
         end
 
+        #
+        # Before Vagrant 1.5, args list ends with an extra arg '--'. It removes it if present.
+        #
+        def normalize_args(args)
+          return args if args.nil?
+          args.pop if args.size > 0 && args.last == '--'
+          args
+        end
+
         def cmd(_name, _argv, _env)
           fail 'Command not implemented. \'cmd\' method must be overridden in all subclasses'
         end

data/lib/vagrant-openstack-provider/command/flavor_list.rb

@@ -11,7 +11,7 @@ module VagrantPlugins
           I18n.t('vagrant_openstack.command.flavor_list_synopsis')
         end
         def cmd(name, argv, env)
-          fail Errors::NoArgRequiredForCommand, cmd: name unless argv.size == 0 || argv == ['--']
+          fail Errors::NoArgRequiredForCommand, cmd: name unless argv.size == 0
           flavors = env[:openstack_client].nova.get_all_flavors(env)
 
           rows = []

data/lib/vagrant-openstack-provider/command/floatingip_list.rb

@@ -11,7 +11,7 @@ module VagrantPlugins
           I18n.t('vagrant_openstack.command.flaotingip_list_synopsis')
         end
         def cmd(name, argv, env)
-          fail Errors::NoArgRequiredForCommand, cmd: name unless argv.size == 0 || argv == ['--']
+          fail Errors::NoArgRequiredForCommand, cmd: name unless argv.size == 0
 
           floating_ip_pools = env[:openstack_client].nova.get_floating_ip_pools(env)
           floating_ips = env[:openstack_client].nova.get_floating_ips(env)

data/lib/vagrant-openstack-provider/command/image_list.rb

@@ -11,7 +11,7 @@ module VagrantPlugins
           I18n.t('vagrant_openstack.command.image_list_synopsis')
         end
         def cmd(name, argv, env)
-          fail Errors::NoArgRequiredForCommand, cmd: name unless argv.size == 0 || argv == ['--']
+          fail Errors::NoArgRequiredForCommand, cmd: name unless argv.size == 0
           images = env[:openstack_client].nova.get_all_images(env)
           display_item_list(env, images)
         end

data/lib/vagrant-openstack-provider/command/main.rb

@@ -6,7 +6,8 @@ module VagrantPlugins
         { name: :'flavor-list', file: 'flavor_list', clazz: 'FlavorList' },
         { name: :'network-list', file: 'network_list', clazz: 'NetworkList' },
         { name: :'floatingip-list', file: 'floatingip_list', clazz: 'FloatingIpList' },
-        { name: :'volume-list', file: 'volume_list', clazz: 'VolumeList' }
+        { name: :'volume-list', file: 'volume_list', clazz: 'VolumeList' },
+        { name: :'reset', file: 'reset', clazz: 'Reset' }
       ]
 
       class Main < Vagrant.plugin('2', :command)

data/lib/vagrant-openstack-provider/command/network_list.rb

@@ -11,8 +11,14 @@ module VagrantPlugins
           I18n.t('vagrant_openstack.command.network_list_synopsis')
         end
         def cmd(name, argv, env)
-          fail Errors::NoArgRequiredForCommand, cmd: name unless argv.size == 0 || argv == ['--']
-          flavors = env[:openstack_client].neutron.get_private_networks(env)
+          fail Errors::UnrecognizedArgForCommand, cmd: name, arg: argv[1] if argv.size > 1
+          if argv.size == 0
+            flavors = env[:openstack_client].neutron.get_private_networks(env)
+          elsif argv[0] == 'all'
+            flavors = env[:openstack_client].neutron.get_all_networks(env)
+          else
+            fail Errors::UnrecognizedArgForCommand, cmd: name, arg: argv[0]
+          end
           display_item_list(env, flavors)
         end
       end

data/lib/vagrant-openstack-provider/command/reset.rb

@@ -0,0 +1,21 @@
+require 'vagrant-openstack-provider/command/utils'
+require 'vagrant-openstack-provider/command/abstract_command'
+
+module VagrantPlugins
+  module Openstack
+    module Command
+      class Reset < AbstractCommand
+        include VagrantPlugins::Openstack::Command::Utils
+
+        def self.synopsis
+          I18n.t('vagrant_openstack.command.reset')
+        end
+        def cmd(name, argv, env)
+          fail Errors::NoArgRequiredForCommand, cmd: name unless argv.size == 0
+          FileUtils.remove_dir("#{env[:machine].data_dir}")
+          env[:ui].info 'Vagrant OpenStack Provider has been reset'
+        end
+      end
+    end
+  end
+end

data/lib/vagrant-openstack-provider/command/utils.rb

@@ -14,7 +14,7 @@ module VagrantPlugins
 
         def display_table(env, headers, rows)
           table = Terminal::Table.new headings: headers, rows: rows
-          env[:ui].info("\n#{table}\n")
+          env[:ui].info("\n#{table}")
         end
       end
     end

data/lib/vagrant-openstack-provider/command/volume_list.rb

@@ -11,7 +11,7 @@ module VagrantPlugins
           I18n.t('vagrant_openstack.command.volume_list_synopsis')
         end
         def cmd(name, argv, env)
-          fail Errors::NoArgRequiredForCommand, cmd: name unless argv.size == 0 || argv == ['--']
+          fail Errors::NoArgRequiredForCommand, cmd: name unless argv.size == 0
           volumes = env[:openstack_client].cinder.get_all_volumes(env)
 
           rows = []

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

@@ -136,6 +136,11 @@ module VagrantPlugins
       # @return [Hash]
       attr_accessor :metadata
 
+      # Flag to enable/disable all SSH actions (to use for instance on private networks)
+      #
+      # @return [Boolean]
+      attr_accessor :ssh_disabled
+
       def initialize
         @password = UNSET_VALUE
         @openstack_compute_url = UNSET_VALUE
@@ -164,6 +169,7 @@ module VagrantPlugins
         @security_groups = UNSET_VALUE
         @user_data = UNSET_VALUE
         @metadata = UNSET_VALUE
+        @ssh_disabled = UNSET_VALUE
       end
 
       # rubocop:disable Style/CyclomaticComplexity
@@ -191,6 +197,7 @@ module VagrantPlugins
         @security_groups = nil if @security_groups == UNSET_VALUE
         @user_data = nil if @user_data == UNSET_VALUE
         @metadata = nil if @metadata == UNSET_VALUE
+        @ssh_disabled = false if @ssh_disabled == UNSET_VALUE
 
         # The SSH values by default are nil, and the top-level config
         # `config.ssh` values are used.
@@ -212,6 +219,7 @@ module VagrantPlugins
         errors << I18n.t('vagrant_openstack.config.username_required') unless @username
 
         validate_ssh_username(machine, errors)
+        validate_ssh_timeout(errors)
 
         if machine.config.ssh.private_key_path
           puts I18n.t('vagrant_openstack.config.keypair_name_required').yellow unless @keypair_name || @public_key_path
@@ -231,12 +239,19 @@ module VagrantPlugins
         { 'Openstack Provider' => errors }
       end
 
+      private
+
       def validate_ssh_username(machine, errors)
         puts I18n.t('vagrant_openstack.config.ssh_username_deprecated').yellow if @ssh_username
         errors << I18n.t('vagrant_openstack.config.ssh_username_required') unless @ssh_username || machine.config.ssh.username
       end
 
-      private
+      def validate_ssh_timeout(errors)
+        return if @ssh_timeout.nil? || @ssh_timeout == UNSET_VALUE
+        @ssh_timeout = Integer(@ssh_timeout) if @ssh_timeout.is_a? String
+      rescue ArgumentError
+        errors << I18n.t('vagrant_openstack.config.invalid_value_for_parameter', parameter: 'ssh_timeout', value: @ssh_timeout)
+      end
 
       def valid_uri?(value)
         uri = URI.parse value

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

@@ -0,0 +1,262 @@
+module VagrantPlugins
+  module Openstack
+    class ConfigResolver
+      def initialize
+        @logger = Log4r::Logger.new('vagrant_openstack::action::config_resolver')
+      end
+
+      def resolve_ssh_port(env)
+        machine_config = env[:machine].config
+        return machine_config.ssh.port if machine_config.ssh.port
+        22
+      end
+
+      def resolve_flavor(env)
+        @logger.info 'Resolving flavor'
+        config = env[:machine].provider_config
+        nova = env[:openstack_client].nova
+        env[:ui].info(I18n.t('vagrant_openstack.finding_flavor'))
+        flavors = nova.get_all_flavors(env)
+        @logger.info "Finding flavor matching name '#{config.flavor}'"
+        flavor = find_matching(flavors, config.flavor)
+        fail Errors::NoMatchingFlavor unless flavor
+        flavor
+      end
+
+      def resolve_image(env)
+        @logger.info 'Resolving image'
+        config = env[:machine].provider_config
+        return nil if config.image.nil?
+        nova = env[:openstack_client].nova
+        env[:ui].info(I18n.t('vagrant_openstack.finding_image'))
+        images = nova.get_all_images(env)
+        @logger.info "Finding image matching name '#{config.image}'"
+        image = find_matching(images, config.image)
+        fail Errors::NoMatchingImage unless image
+        image
+      end
+
+      def resolve_floating_ip(env)
+        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
+      end
+
+      def resolve_keypair(env)
+        config = env[:machine].provider_config
+        nova = env[:openstack_client].nova
+        return config.keypair_name if config.keypair_name
+        return nova.import_keypair_from_file(env, config.public_key_path) if config.public_key_path
+        generate_keypair(env)
+      end
+
+      def resolve_networks(env)
+        @logger.info 'Resolving network(s)'
+        config = env[:machine].provider_config
+        return [] if config.networks.nil? || config.networks.empty?
+        env[:ui].info(I18n.t('vagrant_openstack.finding_networks'))
+        return resolve_networks_without_network_service(env) unless env[:openstack_client].session.endpoints.key? :network
+
+        private_networks = env[:openstack_client].neutron.get_private_networks(env)
+        private_network_ids = private_networks.map { |v| v.id }
+
+        networks = []
+        config.networks.each do |network|
+          networks << resolve_network(network, private_networks, private_network_ids)
+        end
+        @logger.debug("Resolved networks : #{networks.to_json}")
+        networks
+      end
+
+      def resolve_volume_boot(env)
+        @logger.info 'Resolving image'
+        config = env[:machine].provider_config
+        return nil if config.volume_boot.nil?
+        return resolve_volume_without_volume_service(env, config.volume_boot, 'vda') unless env[:openstack_client].session.endpoints.key? :volume
+
+        volume_list = env[:openstack_client].cinder.get_all_volumes(env)
+        volume_ids = volume_list.map { |v| v.id }
+
+        @logger.debug(volume_list)
+
+        volume = resolve_volume(config.volume_boot, volume_list, volume_ids)
+        device = volume[:device].nil? ? 'vda' : volume[:device]
+
+        { id: volume[:id], device: device }
+      end
+
+      def resolve_volumes(env)
+        @logger.info 'Resolving volume(s)'
+        config = env[:machine].provider_config
+        return [] if config.volumes.nil? || config.volumes.empty?
+        env[:ui].info(I18n.t('vagrant_openstack.finding_volumes'))
+        return resolve_volumes_without_volume_service(env) unless env[:openstack_client].session.endpoints.key? :volume
+
+        volume_list = env[:openstack_client].cinder.get_all_volumes(env)
+        volume_ids = volume_list.map { |v| v.id }
+
+        @logger.debug(volume_list)
+
+        volumes = []
+        config.volumes.each do |volume|
+          volumes << resolve_volume(volume, volume_list, volume_ids)
+        end
+        @logger.debug("Resolved volumes : #{volumes.to_json}")
+        volumes
+      end
+
+      def resolve_ssh_username(env)
+        config = env[:machine].provider_config
+        machine_config = env[:machine].config
+        return machine_config.ssh.username if machine_config.ssh.username
+        return config.ssh_username if config.ssh_username
+        fail Errors::NoMatchingSshUsername
+      end
+
+      def resolve_security_groups(env)
+        groups = []
+        env[:machine].provider_config.security_groups.each do |group|
+          case group
+          when String
+            groups << { name: group }
+          when Hash
+            groups << group
+          end
+        end unless env[:machine].provider_config.security_groups.nil?
+        groups
+      end
+
+      private
+
+      def generate_keypair(env)
+        key = SSHKey.generate
+        nova = env[:openstack_client].nova
+        generated_keyname = nova.import_keypair(env, key.ssh_public_key)
+        file_path = "#{env[:machine].data_dir}/#{generated_keyname}"
+        File.write(file_path, key.private_key)
+        File.chmod(0600, file_path)
+        generated_keyname
+      end
+
+      def resolve_networks_without_network_service(env)
+        config = env[:machine].provider_config
+        networks = []
+        config.networks.each do |network|
+          case network
+          when String
+            env[:ui].info(I18n.t('vagrant_openstack.warn_network_identifier_is_assumed_to_be_an_id', network: network))
+            networks << { uuid: network }
+          when Hash
+            fail Errors::ConflictNetworkNameId, network: network if network.key?(:name) && network.key?(:id)
+            fail Errors::NetworkServiceUnavailable if network.key? :name
+            if network.key?(:address)
+              networks << { uuid: network[:id], fixed_ip: network[:address] }
+            else
+              networks << { uuid: network[:id] }
+            end
+          end
+        end
+        networks
+      end
+
+      def resolve_network(network, network_list, network_ids)
+        return resolve_network_from_string(network, network_list) if network.is_a? String
+        return resolve_network_from_hash(network, network_list, network_ids) if network.is_a? Hash
+        fail Errors::InvalidNetworkObject, network: network
+      end
+
+      def resolve_network_from_string(network, network_list)
+        found_network = find_matching(network_list, network)
+        fail Errors::UnresolvedNetwork, network: network if found_network.nil?
+        { uuid: found_network.id }
+      end
+
+      def resolve_network_from_hash(network, network_list, network_ids)
+        if network.key?(:id)
+          fail Errors::ConflictNetworkNameId, network: network if network.key?(:name)
+          network_id = network[:id]
+          fail Errors::UnresolvedNetworkId, id: network_id unless network_ids.include? network_id
+        elsif network.key?(:name)
+          network_list.each do |v|
+            next unless v.name.eql? network[:name]
+            fail Errors::MultipleNetworkName, name: network[:name] unless network_id.nil?
+            network_id = v.id
+          end
+          fail Errors::UnresolvedNetworkName, name: network[:name] unless network_ids.include? network_id
+        else
+          fail Errors::ConflictNetworkNameId, network: network
+        end
+        return { uuid: network_id, fixed_ip: network[:address] } if network.key?(:address)
+        { uuid: network_id }
+      end
+
+      def resolve_volumes_without_volume_service(env)
+        env[:machine].provider_config.volumes.map { |volume| resolve_volume_without_volume_service(env, volume) }
+      end
+
+      def resolve_volume_without_volume_service(env, volume, default_device = nil)
+        case volume
+        when String
+          env[:ui].info(I18n.t('vagrant_openstack.warn_volume_identifier_is_assumed_to_be_an_id', volume: volume))
+          return { id: volume, device: default_device }
+        when Hash
+          fail Errors::ConflictVolumeNameId, volume: volume if volume.key?(:name) && volume.key?(:id)
+          fail Errors::VolumeServiceUnavailable if volume.key? :name
+          return { id: volume[:id], device: volume[:device] || default_device }
+        end
+        fail Errors::InvalidVolumeObject, volume: volume
+      end
+
+      def resolve_volume(volume, volume_list, volume_ids)
+        return resolve_volume_from_string(volume, volume_list) if volume.is_a? String
+        return resolve_volume_from_hash(volume, volume_list, volume_ids) if volume.is_a? Hash
+        fail Errors::InvalidVolumeObject, volume: volume
+      end
+
+      def resolve_volume_from_string(volume, volume_list)
+        found_volume = find_matching(volume_list, volume)
+        fail Errors::UnresolvedVolume, volume: volume if found_volume.nil?
+        { id: found_volume.id, device: nil }
+      end
+
+      def resolve_volume_from_hash(volume, volume_list, volume_ids)
+        device = nil
+        device = volume[:device] if volume.key?(:device)
+        if volume.key?(:id)
+          fail Errors::ConflictVolumeNameId, volume: volume if volume.key?(:name)
+          volume_id = volume[:id]
+          fail Errors::UnresolvedVolumeId, id: volume_id unless volume_ids.include? volume_id
+        elsif volume.key?(:name)
+          volume_list.each do |v|
+            next unless v.name.eql? volume[:name]
+            fail Errors::MultipleVolumeName, name: volume[:name] unless volume_id.nil?
+            volume_id = v.id
+          end
+          fail Errors::UnresolvedVolumeName, name: volume[:name] unless volume_ids.include? volume_id
+        else
+          fail Errors::ConflictVolumeNameId, volume: volume
+        end
+        { id: volume_id, device: device }
+      end
+
+      # This method finds a matching _thing_ in a collection of
+      # _things_. This works matching if the ID or NAME equals to
+      # `name`. Or, if `name` is a regexp, a partial match is chosen
+      # as well.
+      def find_matching(collection, name)
+        collection.each do |single|
+          return single if single.id == name
+          return single if single.name == name
+          return single if name.is_a?(Regexp) && name =~ single.name
+        end
+        @logger.error "Element '#{name}' not found in collection #{collection}"
+        nil
+      end
+    end
+  end
+end

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

@@ -52,6 +52,10 @@ module VagrantPlugins
         error_key(:no_arg_required_for_command)
       end
 
+      class UnrecognizedArgForCommand < VagrantOpenstackError
+        error_key(:unrecognized_arg_for_command)
+      end
+
       class UnableToResolveFloatingIP < VagrantOpenstackError
         error_key(:unable_to_resolve_floating_ip)
       end
@@ -64,6 +68,30 @@ module VagrantPlugins
         error_key(:unable_to_resolve_ssh_key)
       end
 
+      class InvalidNetworkObject < VagrantOpenstackError
+        error_key(:invalid_network_format)
+      end
+
+      class UnresolvedNetwork < VagrantOpenstackError
+        error_key(:unresolved_network)
+      end
+
+      class UnresolvedNetworkId < VagrantOpenstackError
+        error_key(:unresolved_network_id)
+      end
+
+      class UnresolvedNetworkName < VagrantOpenstackError
+        error_key(:unresolved_network_name)
+      end
+
+      class ConflictNetworkNameId < VagrantOpenstackError
+        error_key(:conflict_network_name_id)
+      end
+
+      class MultipleNetworkName < VagrantOpenstackError
+        error_key(:multiple_network_name)
+      end
+
       class InvalidVolumeObject < VagrantOpenstackError
         error_key(:invalid_volume_format)
       end
@@ -99,6 +127,18 @@ module VagrantPlugins
       class NoMatchingSshUsername < VagrantOpenstackError
         error_key(:ssh_username_missing)
       end
+
+      class InstanceNotFound < VagrantOpenstackError
+        error_key(:instance_not_found)
+      end
+
+      class NetworkServiceUnavailable < VagrantOpenstackError
+        error_key(:nerwork_service_unavailable)
+      end
+
+      class VolumeServiceUnavailable < VagrantOpenstackError
+        error_key(:volume_service_unavailable)
+      end
     end
   end
 end