vagrant-openstack-provider 0.1.2 → 0.2.0

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

@@ -0,0 +1,41 @@
+require 'log4r'
+require 'restclient'
+require 'json'
+
+require 'vagrant-openstack-provider/client/keystone'
+require 'vagrant-openstack-provider/client/nova'
+require 'vagrant-openstack-provider/client/neutron'
+
+module VagrantPlugins
+  module Openstack
+    class Session
+      include Singleton
+
+      attr_accessor :token
+      attr_accessor :project_id
+      attr_accessor :endpoints
+
+      def initialize
+        @token = nil
+        @project_id = nil
+        @endpoints = {}
+      end
+    end
+
+    def self.session
+      Session.instance
+    end
+
+    def self.keystone
+      Openstack::KeystoneClient.instance
+    end
+
+    def self.nova
+      Openstack::NovaClient.instance
+    end
+
+    def self.neutron
+      Openstack::NeutronClient.instance
+    end
+  end
+end

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

@@ -0,0 +1,38 @@
+require 'log4r'
+require 'restclient'
+require 'json'
+
+require 'vagrant-openstack-provider/client/keystone'
+
+module VagrantPlugins
+  module Openstack
+    module Utils
+      def handle_response(response)
+        case response.code
+        when 200, 201, 202, 204
+          response
+        when 401
+          fail Errors::AuthenticationRequired
+        when 400
+          fail Errors::VagrantOpenstackError, message: JSON.parse(response.to_s)['badRequest']['message']
+        else
+          fail Errors::VagrantOpenstackError, message: response.to_s
+        end
+      end
+
+      def authenticated(env)
+        nb_retry = 0
+        begin
+          return yield
+        rescue Errors::AuthenticationRequired => e
+          nb_retry += 1
+          env[:ui].warn(e)
+          env[:ui].warn(I18n.t('vagrant_openstack.trying_authentication'))
+          env[:openstack_client].keystone.authenticate(env)
+          retry if nb_retry < 3
+          raise e
+        end
+      end
+    end
+  end
+end

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

@@ -1,48 +1,24 @@
-require "vagrant"
+require 'vagrant'
 
 module VagrantPlugins
   module Openstack
-    class Config < Vagrant.plugin("2", :config)
+    class Config < Vagrant.plugin('2', :config)
       # The API key to access Openstack.
       #
-      # @return [String]
-      attr_accessor :api_key
-
-      # The region to access Openstack. If nil, it will default
-      # to DFW.
-      # (formerly know as 'endpoint')
-      #
-      # expected to be a symbol - :dfw (default), :ord, :lon
-      #
-      # Users should preference the openstack_region setting over openstack_compute_url
-      attr_accessor :openstack_region
+      attr_accessor :password
 
-      # The compute_url to access Openstack. If nil, it will default
-      # to DFW.
-      # (formerly know as 'endpoint')
+      # The compute service url to access Openstack. If nil, it will read from
+      # hypermedia catalog form REST API
       #
-      # expected to be a string url -
-      # 'https://dfw.servers.api.openstackcloud.com/v2'
-      # 'https://ord.servers.api.openstackcloud.com/v2'
-      # 'https://lon.servers.api.openstackcloud.com/v2'
-      #
-      # alternatively, can use constants if you require 'fog/openstack' in your Vagrantfile
-      # Fog::Compute::OpenstackV2::DFW_ENDPOINT
-      # Fog::Compute::OpenstackV2::ORD_ENDPOINT
-      # Fog::Compute::OpenstackV2::LON_ENDPOINT
-      #
-      # Users should preference the openstack_region setting over openstack_compute_url
       attr_accessor :openstack_compute_url
 
-      # The authenication endpoint. This defaults to Openstack's global authentication endpoint.
-      # Users of the London data center should specify the following:
-      # https://lon.identity.api.openstackcloud.com/v2.0
-      attr_writer :openstack_auth_url
-
-      # Network configurations for the instance
+      # The network service url to access Openstack. If nil, it will read from
+      # hypermedia catalog form REST API
       #
-      # @return [String]
-      attr_accessor :network
+      attr_accessor :openstack_network_url
+
+      # The authentication endpoint. This defaults to Openstack's global authentication endpoint.
+      attr_accessor :openstack_auth_url
 
       # The flavor of server to launch, either the ID or name. This
       # can also be a regular expression to partially match a name.
@@ -52,22 +28,6 @@ module VagrantPlugins
       # expression to partially match a name.
       attr_accessor :image
 
-      # Alternately, if a keypair were already uploaded to Openstack,
-      # the key name could be provided.
-      #
-      # @return [String]
-      attr_accessor :key_name
-
-      # A Hash of metadata that will be sent to the instance for configuration
-      #
-      # @return [Hash]
-      attr_accessor :metadata
-
-      # The option that indicates RackConnect usage or not.
-      #
-      # @return [Boolean]
-      attr_accessor :rackconnect
-
       #
       # The name of the openstack project on witch the vm will be created.
       #
@@ -78,9 +38,6 @@ module VagrantPlugins
       # here.
       attr_accessor :server_name
 
-      # Specify the availability zone in which to create the instance
-      attr_accessor :availability_zone
-
       # The username to access Openstack.
       #
       # @return [String]
@@ -103,18 +60,6 @@ module VagrantPlugins
       # @return [Integer]
       attr_accessor :ssh_timeout
 
-      # The disk configuration value.
-      #   * AUTO -   The server is built with a single partition the size of the target flavor disk. The file system is automatically adjusted to fit the entire partition.
-      #              This keeps things simple and automated. AUTO is valid only for images and servers with a single partition that use the EXT3 file system.
-      #              This is the default setting for applicable Openstack base images.
-      #
-      #   * MANUAL - The server is built using whatever partition scheme and file system is in the source image. If the target flavor disk is larger,
-      #              the remaining disk space is left unpartitioned. This enables images to have non-EXT3 file systems, multiple partitions,
-      #              and so on, and enables you to manage the disk configuration.
-      #
-      # This defaults to MANUAL
-      attr_accessor :disk_config
-
       # Opt files/directories in to the rsync operation performed by this provider
       #
       # @return [Array]
@@ -130,96 +75,79 @@ module VagrantPlugins
       # @return [String]
       attr_accessor :sync_method
 
+      # Network list the VM will be connected to
+      #
+      # @return [Array]
+      attr_accessor :networks
+
       def initialize
-        @api_key = UNSET_VALUE
-        @openstack_region = UNSET_VALUE
+        @password = UNSET_VALUE
         @openstack_compute_url = UNSET_VALUE
+        @openstack_network_url = UNSET_VALUE
         @openstack_auth_url = UNSET_VALUE
         @flavor = UNSET_VALUE
         @image = UNSET_VALUE
-        @rackconnect = UNSET_VALUE
-        @availability_zone = UNSET_VALUE
         @tenant_name = UNSET_VALUE
         @server_name = UNSET_VALUE
         @username = UNSET_VALUE
-        @disk_config = UNSET_VALUE
-        @network = UNSET_VALUE
         @rsync_includes = []
         @keypair_name = UNSET_VALUE
         @ssh_username = UNSET_VALUE
         @ssh_timeout = UNSET_VALUE
         @floating_ip = UNSET_VALUE
         @sync_method = UNSET_VALUE
+        @networks = []
       end
 
+      # rubocop:disable Style/CyclomaticComplexity
       def finalize!
-        @api_key = nil if @api_key == UNSET_VALUE
-        @openstack_region = nil if @openstack_region == UNSET_VALUE
+        @password = nil if @password == UNSET_VALUE
         @openstack_compute_url = nil if @openstack_compute_url == UNSET_VALUE
+        @openstack_network_url = nil if @openstack_network_url == UNSET_VALUE
         @openstack_auth_url = nil if @openstack_auth_url == UNSET_VALUE
-        @flavor = /m1.tiny/ if @flavor == UNSET_VALUE # TODO No default value
-        @image = /cirros/ if @image == UNSET_VALUE    # TODO No default value
-        @rackconnect = nil if @rackconnect == UNSET_VALUE
-        @availability_zone = nil if @availability_zone == UNSET_VALUE
+        @flavor = nil if @flavor == UNSET_VALUE
+        @image = nil if @image == UNSET_VALUE
         @tenant_name = nil if @tenant_name == UNSET_VALUE
         @server_name = nil if @server_name == UNSET_VALUE
-        @metadata = nil if @metadata == UNSET_VALUE
-        @network = nil if @network == UNSET_VALUE
         @username = nil if @username == UNSET_VALUE
-        @disk_config = nil if @disk_config == UNSET_VALUE
         @rsync_includes = nil if @rsync_includes.empty?
         @floating_ip = nil if @floating_ip == UNSET_VALUE
-        @sync_method = "rsync" if @sync_method == UNSET_VALUE
-
-        # Keypair defaults to nil
+        @sync_method = 'rsync' if @sync_method == UNSET_VALUE
         @keypair_name = nil if @keypair_name == UNSET_VALUE
 
         # The SSH values by default are nil, and the top-level config
         # `config.ssh` values are used.
         @ssh_username = nil if @ssh_username == UNSET_VALUE
-        @ssh_timeout = 60 if @ssh_timeout == UNSET_VALUE
-      end
-
-      # @note Currently, you must authenticate against the UK authenication endpoint to access the London Data center.
-      #     Hopefully this method makes the experience more seemless for users of the UK cloud.
-      def openstack_auth_url
-        if (@openstack_auth_url.nil? || @openstack_auth_url == UNSET_VALUE) && lon_region?
-          Fog::Openstack::UK_AUTH_ENDPOINT
-        else
-          @openstack_auth_url
-        end
+        @ssh_timeout = 180 if @ssh_timeout == UNSET_VALUE
+        @networks = nil if @networks.empty?
       end
+      # rubocop:enable Style/CyclomaticComplexity
 
       def rsync_include(inc)
         @rsync_includes << inc
       end
 
-      def validate(machine)
+      def validate(_machine)
         errors = _detected_errors
 
-        errors << I18n.t("vagrant_openstack.config.api_key required") if !@api_key
-        errors << I18n.t("vagrant_openstack.config.username required") if !@username
-        errors << I18n.t("vagrant_openstack.config.keypair_name required") if !@keypair_name
+        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
 
         {
-          :openstack_compute_url => @openstack_compute_url,
-          :openstack_auth_url => @openstack_auth_url
+          openstack_compute_url: @openstack_compute_url,
+          openstack_network_url: @openstack_network_url,
+          openstack_auth_url: @openstack_auth_url
         }.each_pair do |key, value|
-          errors << I18n.t("vagrant_openstack.config.invalid_uri", :key => key, :uri => value) unless value.nil? || valid_uri?(value)
+          errors << I18n.t('vagrant_openstack.config.invalid_uri', key: key, uri: value) unless value.nil? || valid_uri?(value)
         end
 
-        { "Openstack Provider" => errors }
-      end
-
-      private
-
-      def lon_region?
-        openstack_region && openstack_region != UNSET_VALUE && openstack_region.to_sym == :lon
+        { 'Openstack Provider' => errors }
       end
 
       private
 
-      def valid_uri? value
+      def valid_uri?(value)
         uri = URI.parse value
         uri.kind_of?(URI::HTTP)
       end

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

@@ -1,10 +1,15 @@
-require "vagrant"
+require 'vagrant'
 
 module VagrantPlugins
   module Openstack
     module Errors
       class VagrantOpenstackError < Vagrant::Errors::VagrantError
-        error_namespace("vagrant_openstack.errors")
+        error_namespace('vagrant_openstack.errors')
+        error_key(:default)
+      end
+
+      class AuthenticationRequired < VagrantOpenstackError
+        error_key(:authentication_required)
       end
 
       class CreateBadState < VagrantOpenstackError
@@ -30,7 +35,6 @@ module VagrantPlugins
       class SshUnavailable < VagrantOpenstackError
         error_key(:ssh_unavailble)
       end
-
     end
   end
 end

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

@@ -1,25 +1,25 @@
 begin
-  require "vagrant"
+  require 'vagrant'
 rescue LoadError
-  raise "The Openstack Cloud provider must be run within Vagrant."
+  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+"
+if Vagrant::VERSION < '1.1.0'
+  fail 'Openstack Cloud provider is only compatible with Vagrant 1.1+'
 end
 
 module VagrantPlugins
   module Openstack
-    class Plugin < Vagrant.plugin("2")
-      name "Openstack Cloud"
+    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"
+        require_relative 'config'
         Config
       end
 
@@ -29,7 +29,7 @@ module VagrantPlugins
         Openstack.init_logging
 
         # Load the actual provider
-        require_relative "provider"
+        require_relative 'provider'
         Provider
       end
     end

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

@@ -1,10 +1,10 @@
-require "vagrant"
+require 'vagrant'
 
-require "vagrant-openstack-provider/action"
+require 'vagrant-openstack-provider/action'
 
 module VagrantPlugins
   module Openstack
-    class Provider < Vagrant.plugin("2", :provider)
+    class Provider < Vagrant.plugin('2', :provider)
       def initialize(machine)
         @machine = machine
       end
@@ -22,7 +22,7 @@ module VagrantPlugins
         # 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.action('read_ssh_info')
         env[:machine_ssh_info]
       end
 
@@ -30,7 +30,7 @@ module VagrantPlugins
         # 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")
+        env = @machine.action('read_state')
 
         state_id = env[:machine_state_id]
 
@@ -43,7 +43,7 @@ module VagrantPlugins
       end
 
       def to_s
-        "Openstack Cloud"
+        'Openstack Cloud'
       end
     end
   end

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

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

data/locales/en.yml

@@ -2,44 +2,60 @@ en:
   vagrant_openstack:
     already_created: |-
       The server is already created.
+    already_suspended: |-
+      The server is already suspended
     deleting_server: |-
       Deleting server...
     finding_flavor: |-
       Finding flavor for server...
     finding_image: |-
       Finding image for server...
+    finding_networks: |-
+      Finding network(s) 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!
+    stopping_server: |-
+      Stopping server...
+    starting_server: |-
+      Starting server...
     timeout: |-
       Timeout!
+    trying_authentication: |-
+      Trying authentication...
     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...
+    waiting_stop: |-
+      Waiting for the server to stop...
     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.
+      password_required: |-
+        A password 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.
+      keypair_name_required: |-
+        A keypair name is required.
 
     errors:
+      default: |-
+        %{message}
+      authentication_required: |-
+        Authentication token is missing or no longer valid.
       create_bad_state: |-
         While creating the server, it transitioned to an unexpected
         state: '%{state}', instead of properly booting. Run `vagrant status`
@@ -77,9 +93,71 @@ en:
       short_error: |-
         error
       long_error: |-
-        The server is in an erroneous state. Contact Openstack support
+        The server is in an erroneous state. Contact your OpenStack administrator
         or destroy the machine with `vagrant destroy`.
+      short_hard_reboot: |-
+        hard reboot
+      long_hard_reboot: |-
+        The server is hard rebooting. This is equivalent to pulling the power plug
+        on a physical server, plugging it back in, and rebooting it.
+      short_password: |-
+        password reset
+      long_password: |-
+        The password is being reset on the server.
+      short_reboot: |-
+        reboot
+      long_reboot: |-
+        The server is in a soft reboot state. A reboot command was passed to the operating system.
+      short_rebuild: |-
+        rebuild
+      long_rebuild: |-
+        The server is currently being rebuilt from an image.
+      short_rescue: |-
+        rescue
+      long_rescue: |-
+        The server is in rescue mode.
+      short_resize: |-
+        resize
+      long_resize: |-
+         Server is performing the differential copy of data that changed during
+         its initial copy. Server is down for this stage.
+      short_revert_resize: |-
+        revert resize
+      long_revert_resize: |-
+        The resize or migration of a server failed for some reason. The destination
+        server is being cleaned up and the original source server is restarting.
+      short_shutoff: |-
+        shutoff
+      long_shutoff: |-
+        The virtual machine (VM) was powered down by the user, but not through the
+        OpenStack Compute API. For example, the user issued a shutdown -h command
+        from within the server instance. If the OpenStack Compute manager detects
+        that the VM was powered down, it transitions the server instance to the
+        SHUTOFF status. If you use the OpenStack Compute API to restart the instance,
+        the instance might be deleted first, depending on the value in the
+        shutdown_terminate database field on the Instance model.
+      short_suspended: |-
+        suspended
+      long_suspended: |-
+        The server is suspended, either by request or necessity. This status appears
+        for only the following hypervisors: XenServer/XCP, KVM, and ESXi.
+      short_unknown: |-
+        unknown
+      long_unknown: |-
+        The state of the server is unknown. Contact your cloud provider.
+      short_verify_resize: |-
+        verify resize
+      long_verifiy_resize: |-
+        System is awaiting confirmation that the server is operational after a move or resize.
       short_not_created: |-
         not created
       long_not_created: |-
         The server is not created. Run `vagrant up` to create it.
+
+    client:
+      looking_for_available_endpoints: |-
+        Looking for available endpoints...
+      multiple_endpoint: |-
+        %{size} endpoints are available for service '%{type}' but only the first one will be used
+      authentication: |-
+        Authentication on project %{project} with user %{user}