vagrant-openstack-provider 0.2.0 → 0.3.0

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

@@ -20,6 +20,10 @@ module VagrantPlugins
         @project_id = nil
         @endpoints = {}
       end
+
+      def reset
+        initialize
+      end
     end
 
     def self.session

data/lib/vagrant-openstack-provider/client/request_logger.rb

@@ -0,0 +1,24 @@
+require 'log4r'
+require 'restclient'
+require 'json'
+
+module VagrantPlugins
+  module Openstack
+    module HttpUtils
+      module RequestLogger
+        def log_request(method, url, body = nil, headers)
+          @logger.debug "request  => method  : #{method}"
+          @logger.debug "request  => url     : #{url}"
+          @logger.debug "request  => headers : #{headers}"
+          @logger.debug "request  => body    : #{body}" unless body.nil?
+        end
+
+        def log_response(response)
+          @logger.debug "response => code    : #{response.code}"
+          @logger.debug "response => headers : #{response.headers}"
+          @logger.debug "response => body    : #{response}"
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,31 @@
+require 'vagrant-openstack-provider/client/openstack'
+
+module VagrantPlugins
+  module Openstack
+    module Command
+      class AbstractCommand < Vagrant.plugin('2', :command)
+        def initialize(argv, env)
+          @env = env
+          super(argv, env)
+        end
+
+        def execute(name)
+          env = {}
+          with_target_vms(nil, provider: :openstack) do |machine|
+            env[:machine] = machine
+            env[:ui] = @env.ui
+          end
+
+          VagrantPlugins::Openstack::Action::ConnectOpenstack.new(nil, env).call(env)
+
+          cmd(name, @argv, env)
+          @env.ui.info('')
+        end
+
+        def cmd(_name, _argv, _env)
+          fail 'Command not implemented. \'cmd\' method must be overridden in all subclasses'
+        end
+      end
+    end
+  end
+end

data/lib/vagrant-openstack-provider/command/flavor_list.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 FlavorList < AbstractCommand
+        include VagrantPlugins::Openstack::Command::Utils
+
+        def self.synopsis
+          I18n.t('vagrant_openstack.command.flavor_list_synopsis')
+        end
+        def cmd(name, argv, env)
+          fail Errors::NoArgRequiredForCommand, cmd: name unless argv.size == 1
+          flavors = env[:openstack_client].nova.get_all_flavors(env)
+          display_item_list(env, flavors)
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,34 @@
+require 'vagrant-openstack-provider/command/utils'
+require 'vagrant-openstack-provider/command/abstract_command'
+
+module VagrantPlugins
+  module Openstack
+    module Command
+      class FloatingIpList < AbstractCommand
+        include VagrantPlugins::Openstack::Command::Utils
+
+        def self.synopsis
+          I18n.t('vagrant_openstack.command.flaotingip_list_synopsis')
+        end
+        def cmd(name, argv, env)
+          fail Errors::NoArgRequiredForCommand, cmd: name unless argv.size == 1
+
+          floating_ip_pools = env[:openstack_client].nova.get_floating_ip_pools(env)
+          floating_ips = env[:openstack_client].nova.get_floating_ips(env)
+
+          rows = []
+          floating_ip_pools.each do |floating_ip_pool|
+            rows << [floating_ip_pool['name']]
+          end
+          display_table(env, ['Floating IP pools'], rows)
+
+          rows = []
+          floating_ips.each do |floating_ip|
+            rows << [floating_ip['id'], floating_ip['ip'], floating_ip['pool'], floating_ip['instance_id']]
+          end
+          display_table(env, ['Id', 'IP', 'Pool', 'Instance id'], rows)
+        end
+      end
+    end
+  end
+end

data/lib/vagrant-openstack-provider/command/image_list.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 ImageList < AbstractCommand
+        include VagrantPlugins::Openstack::Command::Utils
+
+        def self.synopsis
+          I18n.t('vagrant_openstack.command.image_list_synopsis')
+        end
+        def cmd(name, argv, env)
+          fail Errors::NoArgRequiredForCommand, cmd: name unless argv.size == 1
+          images = env[:openstack_client].nova.get_all_images(env)
+          display_item_list(env, images)
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,51 @@
+module VagrantPlugins
+  module Openstack
+    module Command
+      COMMANDS = [
+        { name: :'image-list', file: 'image_list' , clazz: 'ImageList' },
+        { name: :'flavor-list', file: 'flavor_list', clazz: 'FlavorList' },
+        { name: :'network-list', file: 'network_list', clazz: 'NetworkList' },
+        { name: :'floatingip-list', file: 'floatingip_list', clazz: 'FloatingIpList' }
+      ]
+
+      class Main < Vagrant.plugin('2', :command)
+        def self.synopsis
+          Openstack.init_i18n
+          I18n.t('vagrant_openstack.command.main_synopsis')
+        end
+
+        def initialize(argv, env)
+          @env = env
+          @main_args, @sub_command, @sub_args = split_main_and_subcommand(argv)
+          @commands = Vagrant::Registry.new
+
+          COMMANDS.each do |cmd|
+            @commands.register(cmd[:name]) do
+              require_relative cmd[:file]
+              Command.const_get(cmd[:clazz])
+            end
+          end
+
+          super(argv, env)
+        end
+
+        def execute
+          Openstack.init_i18n
+          command_class = @commands.get(@sub_command.to_sym) if @sub_command
+          return usage unless command_class && @sub_command
+          command_class.new(@sub_args, @env).execute(@sub_command)
+        end
+
+        def usage
+          @env.ui.info I18n.t('vagrant_openstack.command.main_usage')
+          @env.ui.info ''
+          @env.ui.info I18n.t('vagrant_openstack.command.available_subcommands')
+          @commands.each do |key, value|
+            @env.ui.info "     #{key.to_s.ljust(20)} #{value.synopsis}"
+          end
+          @env.ui.info ''
+        end
+      end
+    end
+  end
+end

data/lib/vagrant-openstack-provider/command/network_list.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 NetworkList < AbstractCommand
+        include VagrantPlugins::Openstack::Command::Utils
+
+        def self.synopsis
+          I18n.t('vagrant_openstack.command.network_list_synopsis')
+        end
+        def cmd(name, argv, env)
+          fail Errors::NoArgRequiredForCommand, cmd: name unless argv.size == 1
+          flavors = env[:openstack_client].neutron.get_private_networks(env)
+          display_item_list(env, flavors)
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,22 @@
+require 'terminal-table'
+
+module VagrantPlugins
+  module Openstack
+    module Command
+      module Utils
+        def display_item_list(env, items)
+          rows = []
+          items.each do |item|
+            rows << [item.id, item.name]
+          end
+          display_table(env, %w('Id' 'Name'), rows)
+        end
+
+        def display_table(env, headers, rows)
+          table = Terminal::Table.new headings: headers, rows: rows
+          env[:ui].info("\n#{table}\n")
+        end
+      end
+    end
+  end
+end

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

@@ -1,4 +1,5 @@
 require 'vagrant'
+require 'colorize'
 
 module VagrantPlugins
   module Openstack
@@ -70,6 +71,11 @@ module VagrantPlugins
       # @return [String]
       attr_accessor :floating_ip
 
+      # The floating IP pool from where new IPs will be allocated
+      #
+      # @return [String]
+      attr_accessor :floating_ip_pool
+
       # Sync folder method. Can be either "rsync" or "none"
       #
       # @return [String]
@@ -80,6 +86,16 @@ module VagrantPlugins
       # @return [Array]
       attr_accessor :networks
 
+      # Public key path to create OpenStack keypair
+      #
+      # @return [Array]
+      attr_accessor :public_key_path
+
+      # Availability Zone
+      #
+      # @return [String]
+      attr_accessor :availability_zone
+
       def initialize
         @password = UNSET_VALUE
         @openstack_compute_url = UNSET_VALUE
@@ -95,8 +111,11 @@ module VagrantPlugins
         @ssh_username = UNSET_VALUE
         @ssh_timeout = UNSET_VALUE
         @floating_ip = UNSET_VALUE
+        @floating_ip_pool = UNSET_VALUE
         @sync_method = UNSET_VALUE
+        @availability_zone = UNSET_VALUE
         @networks = []
+        @public_key_path = UNSET_VALUE
       end
 
       # rubocop:disable Style/CyclomaticComplexity
@@ -112,8 +131,11 @@ module VagrantPlugins
         @username = nil if @username == UNSET_VALUE
         @rsync_includes = nil if @rsync_includes.empty?
         @floating_ip = nil if @floating_ip == UNSET_VALUE
+        @floating_ip_pool = nil if @floating_ip_pool == UNSET_VALUE
         @sync_method = 'rsync' if @sync_method == UNSET_VALUE
         @keypair_name = nil if @keypair_name == UNSET_VALUE
+        @public_key_path = nil if @public_key_path == UNSET_VALUE
+        @availability_zone = nil if @availability_zone == UNSET_VALUE
 
         # The SSH values by default are nil, and the top-level config
         # `config.ssh` values are used.
@@ -127,12 +149,18 @@ module VagrantPlugins
         @rsync_includes << inc
       end
 
-      def validate(_machine)
+      def validate(machine)
         errors = _detected_errors
 
         errors << I18n.t('vagrant_openstack.config.password_required') unless @password
         errors << I18n.t('vagrant_openstack.config.username_required') unless @username
-        errors << I18n.t('vagrant_openstack.config.keypair_name_required') unless @keypair_name
+
+        if machine.config.ssh.private_key_path
+          # Waiting for https://github.com/mitchellh/vagrant/issues/4388 to improve this
+          puts I18n.t('vagrant_openstack.config.keypair_name_required').yellow unless @keypair_name || @public_key_path
+        else
+          errors << I18n.t('vagrant_openstack.config.private_key_missing') if @keypair_name || @public_key_path
+        end
 
         {
           openstack_compute_url: @openstack_compute_url,
@@ -149,7 +177,7 @@ module VagrantPlugins
 
       def valid_uri?(value)
         uri = URI.parse value
-        uri.kind_of?(URI::HTTP)
+        uri.is_a?(URI::HTTP)
       end
     end
   end

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

@@ -12,6 +12,18 @@ module VagrantPlugins
         error_key(:authentication_required)
       end
 
+      class AuthenticationFailed < VagrantOpenstackError
+        error_key(:authentication_failed)
+      end
+
+      class BadAuthenticationEndpoint < VagrantOpenstackError
+        error_key(:bad_authentication_endpoint)
+      end
+
+      class MultipleApiVersion < VagrantOpenstackError
+        error_key(:multiple_api_version)
+      end
+
       class CreateBadState < VagrantOpenstackError
         error_key(:create_bad_state)
       end
@@ -35,6 +47,22 @@ module VagrantPlugins
       class SshUnavailable < VagrantOpenstackError
         error_key(:ssh_unavailble)
       end
+
+      class NoArgRequiredForCommand < VagrantOpenstackError
+        error_key(:no_arg_required_for_command)
+      end
+
+      class UnableToResolveFloatingIP < VagrantOpenstackError
+        error_key(:unable_to_resolve_floating_ip)
+      end
+
+      class UnableToResolveIP < VagrantOpenstackError
+        error_key(:unable_to_resolve_ip)
+      end
+
+      class UnableToResolveSSHKey < VagrantOpenstackError
+        error_key(:unable_to_resolve_ssh_key)
+      end
     end
   end
 end

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

@@ -32,6 +32,11 @@ module VagrantPlugins
         require_relative 'provider'
         Provider
       end
+
+      command('openstack') do
+        require_relative 'command/main'
+        Command::Main
+      end
     end
   end
 end

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

@@ -1,5 +1,5 @@
 module VagrantPlugins
   module Openstack
-    VERSION = '0.2.0'
+    VERSION = '0.3.0'
   end
 end

data/locales/en.yml

@@ -28,12 +28,16 @@ en:
       Trying authentication...
     rsync_folder: |-
       Rsyncing folder: %{hostpath} => %{guestpath}
+    using_floating_ip: |-
+      Using floating IP %{floating_ip}
     waiting_for_build: |-
       Waiting for the server to be built...
     waiting_for_ssh: |-
       Waiting for SSH to become available...
     waiting_stop: |-
       Waiting for the server to stop...
+    waiting_start: |-
+      Waiting for the server to start...
     warn_networks: |-
       Warning! The Openstack provider doesn't support any of the Vagrant
       high-level network configurations (`config.vm.network`). They
@@ -49,18 +53,34 @@ en:
       metadata_must_be_hash: |-
         Metadata must be a hash.
       keypair_name_required: |-
-        A keypair name is required.
+        Warning! You have specified ssh.private_key_path in your Vagrant configuration.
+        but nor keypair_name neither public_key_path are present. The openstack provider
+        will automatically generate a new keypair and your configuration option
+        ssh.private_key_path will be overriden
+      private_key_missing: |-
+        config.ssh.private_key_path is required when either keypair_name or
+        public_key_path is set in Vagrantfile
 
     errors:
       default: |-
         %{message}
       authentication_required: |-
         Authentication token is missing or no longer valid.
+      authentication_failed: |-
+        Authentication failed.
+      bad_authentication_endpoint: |-
+        Bad authentication endpoint.
       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.
+      multiple_api_version: |-
+        Multiple version found for %{api_name} API
+
+        %{version_list}
+        You must specify the desired network API url by setting
+        the provider's property '%{url_property}'.
       no_matching_flavor: |-
         No matching flavor was found! Please check your flavor setting
         to make sure you have a valid flavor chosen.
@@ -78,6 +98,14 @@ en:
         Error: %{stderr}
       ssh_unavailble: |-
         SSH server anavailable on instance %{host}. You should maybe increase the timeout value which currently is %{timeout} second(s).
+      no_arg_required_for_command: |-
+        Command '%{cmd}' does not required any argument.
+      unable_to_resolve_floating_ip: |-
+        Vagrant was unable to resolve a floating ip to communicate with your OpenStack instance. Please specify in your Vagrantfile either `floating_ip` or `floating_ip_pool`.
+      unable_to_resolve_ip: |-
+        Vagrant was unable to resolve a valid ip to ssh on your OpenStack instance.
+      unable_to_resolve_ssh_key: |-
+        Vagrant was unable to resolve a valid ssh key to connect to your OpenStack instance. Please specify in your Vagrantfile either `public_key_path` or `keypair_name`.
 
     states:
       short_active: |-
@@ -161,3 +189,19 @@ en:
         %{size} endpoints are available for service '%{type}' but only the first one will be used
       authentication: |-
         Authentication on project %{project} with user %{user}
+
+    command:
+      main_synopsis: |-
+        Openstack provider specific commands
+      main_usage : |-
+        Usage: vagrant openstack command
+      available_subcommands: |-
+        Available subcommands:
+      image_list_synopsis : |-
+        List available images
+      flavor_list_synopsis : |-
+        List available flavors
+      network_list_synopsis : |-
+        List private networks in project
+      flaotingip_list_synopsis : |-
+        List floating IP and floating IP pools