vagrant-openstack-provider 0.5.2 → 0.6.0

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

@@ -21,9 +21,30 @@ module VagrantPlugins
         end
       end
 
+      class Image < Item
+        attr_accessor :visibility
+        attr_accessor :size
+        attr_accessor :min_ram
+        attr_accessor :min_disk
+
+        def initialize(id, name, visibility = nil, size = nil, min_ram = nil, min_disk = nil)
+          @visibility = visibility
+          @size = size
+          @min_ram = min_ram
+          @min_disk = min_disk
+          super(id, name)
+        end
+
+        protected
+
+        def state
+          [@id, @name, @visibility, @size, @min_ram, @min_disk]
+        end
+      end
+
       class Flavor < Item
         #
-        # THe number of vCPU
+        # The number of vCPU
         #
         attr_accessor :vcpus
 
@@ -115,6 +136,25 @@ module VagrantPlugins
           [@id, @name, @size, @status, @bootable, @instance_id, @device]
         end
       end
+
+      class Subnet < Item
+        attr_accessor :cidr
+        attr_accessor :enable_dhcp
+        attr_accessor :network_id
+
+        def initialize(id, name, cidr, enable_dhcp, network_id)
+          @cidr = cidr
+          @enable_dhcp = enable_dhcp
+          @network_id = network_id
+          super(id, name)
+        end
+
+        protected
+
+        def state
+          [@id, @name, @cidr, @enable_dhcp, @network_id]
+        end
+      end
     end
   end
 end

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

@@ -0,0 +1,63 @@
+require 'log4r'
+require 'restclient'
+require 'json'
+
+require 'vagrant-openstack-provider/client/http_utils'
+require 'vagrant-openstack-provider/client/domain'
+
+module VagrantPlugins
+  module Openstack
+    class GlanceClient
+      include Singleton
+      include VagrantPlugins::Openstack::HttpUtils
+      include VagrantPlugins::Openstack::Domain
+
+      def initialize
+        @logger = Log4r::Logger.new('vagrant_openstack::glance')
+        @session = VagrantPlugins::Openstack.session
+      end
+
+      def get_api_version_list(_env)
+        json = RestClient.get(@session.endpoints[:image], 'X-Auth-Token' => @session.token, :accept => :json) do |response|
+          log_response(response)
+          case response.code
+          when 200, 300
+            response
+          when 401
+            fail Errors::AuthenticationFailed
+          else
+            fail Errors::VagrantOpenstackError, message: response.to_s
+          end
+        end
+        JSON.parse(json)['versions']
+      end
+
+      # Endpoint /images exists on both v1 and v2 API
+      # The attribute 'visibility' is used to detect
+      # if the call has been made on v1 or v2
+      #
+      # In case of v2 we have all the needed information,
+      # but in case of v1 we don't and we have to call
+      # /images/detail to get full details
+      #
+      def get_all_images(env)
+        images_json = get(env, "#{@session.endpoints[:image]}/images")
+        images = JSON.parse(images_json)['images']
+
+        return images if images.empty?
+
+        is_v1 = false
+        unless images[0].key? 'visibility'
+          is_v1 = true
+          images_json = get(env, "#{@session.endpoints[:image]}/images/detail")
+          images = JSON.parse(images_json)['images']
+        end
+
+        images.map do |i|
+          i['visibility'] = i['is_public'] ? 'public' : 'private' if is_v1
+          Image.new(i['id'], i['name'], i['visibility'], i['size'], i['min_ram'], i['min_disk'])
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,50 @@
+require 'log4r'
+require 'restclient'
+require 'json'
+
+require 'vagrant-openstack-provider/client/http_utils'
+require 'vagrant-openstack-provider/client/domain'
+
+module VagrantPlugins
+  module Openstack
+    class HeatClient
+      include Singleton
+      include VagrantPlugins::Openstack::HttpUtils
+      include VagrantPlugins::Openstack::Domain
+
+      def initialize
+        @logger = Log4r::Logger.new('vagrant_openstack::glance')
+        @session = VagrantPlugins::Openstack.session
+      end
+
+      def create_stack(env, options)
+        stack = {}.tap do |s|
+          s['stack_name'] = options[:name] if options[:name]
+          s['template'] = options[:template]
+        end
+        stack_res = post(env, "#{@session.endpoints[:orchestration]}/stacks", stack.to_json)
+        JSON.parse(stack_res)['stack']['id']
+      end
+
+      def get_stack_details(env, stack_name, stack_id)
+        stack_exists do
+          server_details = get(env, "#{@session.endpoints[:orchestration]}/stacks/#{stack_name}/#{stack_id}")
+          JSON.parse(server_details)['stack']
+        end
+      end
+
+      def delete_stack(env, stack_name, stack_id)
+        stack_exists do
+          delete(env, "#{@session.endpoints[:orchestration]}/stacks/#{stack_name}/#{stack_id}")
+        end
+      end
+
+      def stack_exists
+        return yield
+      rescue Errors::VagrantOpenstackError => e
+        raise Errors::StackNotFound if e.extra_data[:code] == 404
+        raise e
+      end
+    end
+  end
+end

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

@@ -55,6 +55,24 @@ module VagrantPlugins
         end
       end
 
+      def get_api_version_list(service_type)
+        url = @session.endpoints[service_type]
+        headers = { 'X-Auth-Token' => @session.token, :accept => :json }
+        log_request(:GET, url, headers)
+        json = RestClient.get(url, headers) do |response|
+          log_response(response)
+          case response.code
+          when 200, 300
+            response
+          when 401
+            fail Errors::AuthenticationFailed
+          else
+            fail Errors::VagrantOpenstackError, message: response.to_s
+          end
+        end
+        JSON.parse(json)['versions']
+      end
+
       private
 
       ERRORS =

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

@@ -17,21 +17,6 @@ module VagrantPlugins
         @session = VagrantPlugins::Openstack.session
       end
 
-      def get_api_version_list(_env)
-        json = RestClient.get(@session.endpoints[:network], 'X-Auth-Token' => @session.token, :accept => :json) do |response|
-          log_response(response)
-          case response.code
-          when 200, 300
-            response
-          when 401
-            fail Errors::AuthenticationFailed
-          else
-            fail Errors::VagrantOpenstackError, message: response.to_s
-          end
-        end
-        JSON.parse(json)['versions']
-      end
-
       def get_private_networks(env)
         get_networks(env, false)
       end
@@ -40,6 +25,15 @@ module VagrantPlugins
         get_networks(env, true)
       end
 
+      def get_subnets(env)
+        subnets_json = get(env, "#{@session.endpoints[:network]}/subnets")
+        subnets = []
+        JSON.parse(subnets_json)['subnets'].each do |n|
+          subnets << Subnet.new(n['id'], n['name'], n['cidr'], n['enable_dhcp'], n['network_id'])
+        end
+        subnets
+      end
+
       private
 
       def get_networks(env, all)

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

@@ -45,7 +45,7 @@ module VagrantPlugins
 
       def get_all_images(env)
         images_json = get(env, "#{@session.endpoints[:compute]}/images")
-        JSON.parse(images_json)['images'].map { |fl| Item.new(fl['id'], fl['name']) }
+        JSON.parse(images_json)['images'].map { |fl| Image.new(fl['id'], fl['name'], 'unknown') }
       end
 
       def create_server(env, options)
@@ -193,9 +193,9 @@ module VagrantPlugins
         JSON.parse(ip_details)['floating_ips'].each do |ip|
           next unless ip['ip'] == floating_ip
           return if ip['instance_id'].nil?
-          fail "Floating IP #{floating_ip} already assigned to another server"
+          fail Errors::FloatingIPAlreadyAssigned, floating_ip: floating_ip
         end
-        fail "Floating IP #{floating_ip} not available for this tenant"
+        fail Errors::FloatingIPNotAvailable, floating_ip: floating_ip
       end
     end
   end

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

@@ -2,10 +2,12 @@ require 'log4r'
 require 'restclient'
 require 'json'
 
+require 'vagrant-openstack-provider/client/heat'
 require 'vagrant-openstack-provider/client/keystone'
 require 'vagrant-openstack-provider/client/nova'
 require 'vagrant-openstack-provider/client/neutron'
 require 'vagrant-openstack-provider/client/cinder'
+require 'vagrant-openstack-provider/client/glance'
 
 module VagrantPlugins
   module Openstack
@@ -39,6 +41,10 @@ module VagrantPlugins
       Openstack::NovaClient.instance
     end
 
+    def self.heat
+      Openstack::HeatClient.instance
+    end
+
     def self.neutron
       Openstack::NeutronClient.instance
     end
@@ -46,5 +52,9 @@ module VagrantPlugins
     def self.cinder
       Openstack::CinderClient.instance
     end
+
+    def self.glance
+      Openstack::GlanceClient.instance
+    end
   end
 end

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

@@ -20,7 +20,14 @@ module VagrantPlugins
 
           cmd(name, @argv, env)
           @env.ui.info('')
+        # rubocop:disable Lint/RescueException
+        rescue Errors::VagrantOpenstackError, SystemExit, Interrupt => e
+          raise e
+        rescue Exception => e
+          puts I18n.t('vagrant_openstack.global_error').red unless e.message && e.message.start_with?('Catched Error:')
+          raise e
         end
+        # rubocop:enable Lint/RescueException
 
         #
         # Before Vagrant 1.5, args list ends with an extra arg '--'. It removes it if present.

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

@@ -12,8 +12,18 @@ module VagrantPlugins
         end
         def cmd(name, argv, env)
           fail Errors::NoArgRequiredForCommand, cmd: name unless argv.size == 0
-          images = env[:openstack_client].nova.get_all_images(env)
-          display_item_list(env, images)
+          rows = []
+          headers = %w(Id Name)
+          if env[:openstack_client].session.endpoints.key? :image
+            images = env[:openstack_client].glance.get_all_images(env)
+            images.each { |i| rows << [i.id, i.name, i.visibility, i.size.to_i / 1024 / 1024, i.min_ram, i.min_disk] }
+            headers << ['Visibility', 'Size (Mo)', 'Min RAM (Go)', 'Min Disk (Go)']
+            headers = headers.flatten
+          else
+            images = env[:openstack_client].nova.get_all_images(env)
+            images.each { |image| rows << [image.id, image.name] }
+          end
+          display_table(env, headers, rows)
         end
       end
     end

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

@@ -5,6 +5,7 @@ module VagrantPlugins
         { 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: :'subnet-list', file: 'subnet_list', clazz: 'SubnetList' },
         { name: :'floatingip-list', file: 'floatingip_list', clazz: 'FloatingIpList' },
         { name: :'volume-list', file: 'volume_list', clazz: 'VolumeList' },
         { name: :'reset', file: 'reset', clazz: 'Reset' }

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

@@ -13,13 +13,13 @@ module VagrantPlugins
         def cmd(name, argv, 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)
+            networks = env[:openstack_client].neutron.get_private_networks(env)
           elsif argv[0] == 'all'
-            flavors = env[:openstack_client].neutron.get_all_networks(env)
+            networks = env[:openstack_client].neutron.get_all_networks(env)
           else
             fail Errors::UnrecognizedArgForCommand, cmd: name, arg: argv[0]
           end
-          display_item_list(env, flavors)
+          display_item_list(env, networks)
         end
       end
     end

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

@@ -0,0 +1,25 @@
+require 'vagrant-openstack-provider/command/utils'
+require 'vagrant-openstack-provider/command/abstract_command'
+
+module VagrantPlugins
+  module Openstack
+    module Command
+      class SubnetList < AbstractCommand
+        include VagrantPlugins::Openstack::Command::Utils
+
+        def self.synopsis
+          I18n.t('vagrant_openstack.command.subnet_list_synopsis')
+        end
+
+        def cmd(name, argv, env)
+          fail Errors::NoArgRequiredForCommand, cmd: name unless argv.size == 0
+          rows = []
+          env[:openstack_client].neutron.get_subnets(env).each do |subnet|
+            rows << [subnet.id, subnet.name, subnet.cidr, subnet.enable_dhcp, subnet.network_id]
+          end
+          display_table(env, ['Id', 'Name', 'CIDR', 'DHCP', 'Network Id'], rows)
+        end
+      end
+    end
+  end
+end

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

@@ -8,24 +8,32 @@ module VagrantPlugins
       #
       attr_accessor :password
 
-      # The compute service url to access Openstack. If nil, it will read from
-      # hypermedia catalog form REST API
+      # The compute service url to access Openstack. If nil, it will read from hypermedia catalog form REST API
       #
       attr_accessor :openstack_compute_url
 
-      # The network service url to access Openstack. If nil, it will read from
-      # hypermedia catalog form REST API
+      # The network service url to access Openstack. If nil, it will read from hypermedia catalog form REST API
       #
       attr_accessor :openstack_network_url
 
-      # The block storage service url to access Openstack. If nil, it will read from
-      # hypermedia catalog form REST API
+      # The block storage service url to access Openstack. If nil, it will read from hypermedia catalog form REST API
       #
       attr_accessor :openstack_volume_url
 
+      # The orchestration service url to access Openstack. If nil, it will read from hypermedia catalog form REST API
+      #
+      attr_accessor :openstack_orchestration_url
+
+      # The image service url to access Openstack. If nil, it will read from hypermedia catalog form REST API
+      #
+      attr_accessor :openstack_image_url
+
       # The authentication endpoint. This defaults to Openstack's global authentication endpoint.
       attr_accessor :openstack_auth_url
 
+      # Openstack region
+      attr_accessor :region
+
       # The flavor of server to launch, either the ID or name. This
       # can also be a regular expression to partially match a name.
       attr_accessor :flavor
@@ -96,6 +104,12 @@ module VagrantPlugins
       # @return [String]
       attr_accessor :sync_method
 
+      # Sync folder ignore files. A list of files containing exclude patterns to ignore in the rsync operation
+      #  performed by this provider
+      #
+      # @return [Array]
+      attr_accessor :rsync_ignore_files
+
       # Network list the VM will be connected to
       #
       # @return [Array]
@@ -106,6 +120,11 @@ module VagrantPlugins
       # @return [Array]
       attr_accessor :volumes
 
+      # Stack that will be created and associated to the instances
+      #
+      # @return [Array]
+      attr_accessor :stacks
+
       # Public key path to create OpenStack keypair
       #
       # @return [Array]
@@ -146,7 +165,10 @@ module VagrantPlugins
         @openstack_compute_url = UNSET_VALUE
         @openstack_network_url = UNSET_VALUE
         @openstack_volume_url = UNSET_VALUE
+        @openstack_orchestration_url = UNSET_VALUE
+        @openstack_image_url = UNSET_VALUE
         @openstack_auth_url = UNSET_VALUE
+        @region = UNSET_VALUE
         @flavor = UNSET_VALUE
         @image = UNSET_VALUE
         @volume_boot = UNSET_VALUE
@@ -154,15 +176,17 @@ module VagrantPlugins
         @server_name = UNSET_VALUE
         @username = UNSET_VALUE
         @rsync_includes = []
+        @rsync_ignore_files = []
         @keypair_name = UNSET_VALUE
         @ssh_username = UNSET_VALUE
         @ssh_timeout = UNSET_VALUE
         @floating_ip = UNSET_VALUE
-        @floating_ip_pool = UNSET_VALUE
+        @floating_ip_pool = []
         @floating_ip_pool_always_allocate = UNSET_VALUE
         @sync_method = UNSET_VALUE
         @availability_zone = UNSET_VALUE
         @networks = []
+        @stacks = []
         @volumes = []
         @public_key_path = UNSET_VALUE
         @scheduler_hints = UNSET_VALUE
@@ -172,13 +196,49 @@ module VagrantPlugins
         @ssh_disabled = UNSET_VALUE
       end
 
+      def merge(other)
+        result = self.class.new
+
+        # Set all of our instance variables on the new class
+        [self, other].each do |obj|
+          obj.instance_variables.each do |key|
+            # Ignore keys that start with a double underscore. This allows
+            # configuration classes to still hold around internal state
+            # that isn't propagated.
+            next if key.to_s.start_with?('@__')
+
+            # Let user inputs a string or an array for floating ip pool attribute
+            obj.floating_ip_pool = [obj.floating_ip_pool].flatten if key.eql?(:@floating_ip_pool) && !obj.floating_ip_pool.nil?
+
+            # Don't set the value if it is the unset value, either.
+            value = obj.instance_variable_get(key)
+
+            if [:@networks, :@volumes, :@rsync_includes, :@ignore_files, :@floating_ip_pool, :@stacks].include? key
+              result.instance_variable_set(key, value) unless value.empty?
+            else
+              result.instance_variable_set(key, value) if value != UNSET_VALUE
+            end
+          end
+        end
+
+        # Persist through the set of invalid methods
+        this_invalid  = @__invalid_methods || Set.new
+        other_invalid = other.instance_variable_get(:"@__invalid_methods") || Set.new
+        result.instance_variable_set(:"@__invalid_methods", this_invalid + other_invalid)
+
+        result
+      end
+
       # rubocop:disable Style/CyclomaticComplexity
       def finalize!
         @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_orchestration_url = nil if @openstack_orchestration_url == UNSET_VALUE
         @openstack_volume_url = nil if @openstack_volume_url == UNSET_VALUE
+        @openstack_image_url = nil if @openstack_image_url == UNSET_VALUE
         @openstack_auth_url = nil if @openstack_auth_url == UNSET_VALUE
+        @region = nil if @region == UNSET_VALUE
         @flavor = nil if @flavor == UNSET_VALUE
         @image = nil if @image == UNSET_VALUE
         @volume_boot = nil if @volume_boot == UNSET_VALUE
@@ -186,6 +246,7 @@ module VagrantPlugins
         @server_name = nil if @server_name == UNSET_VALUE
         @username = nil if @username == UNSET_VALUE
         @rsync_includes = nil if @rsync_includes.empty?
+        @rsync_ignore_files = nil if @rsync_ignore_files.empty?
         @floating_ip = nil if @floating_ip == UNSET_VALUE
         @floating_ip_pool = nil if @floating_ip_pool == UNSET_VALUE
         @floating_ip_pool_always_allocate = false if floating_ip_pool_always_allocate == UNSET_VALUE
@@ -205,6 +266,7 @@ module VagrantPlugins
         @ssh_timeout = 180 if @ssh_timeout == UNSET_VALUE
         @networks = nil if @networks.empty?
         @volumes = nil if @volumes.empty?
+        @stacks = nil if @stacks.empty?
       end
       # rubocop:enable Style/CyclomaticComplexity
 
@@ -219,6 +281,7 @@ module VagrantPlugins
         errors << I18n.t('vagrant_openstack.config.username_required') unless @username
 
         validate_ssh_username(machine, errors)
+        validate_stack_config(errors)
         validate_ssh_timeout(errors)
 
         if machine.config.ssh.private_key_path
@@ -231,6 +294,8 @@ module VagrantPlugins
           openstack_compute_url: @openstack_compute_url,
           openstack_network_url: @openstack_network_url,
           openstack_volume_url: @openstack_volume_url,
+          openstack_orchestration_url: @openstack_orchestration_url,
+          openstack_image_url: @openstack_image_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)
@@ -241,6 +306,12 @@ module VagrantPlugins
 
       private
 
+      def validate_stack_config(errors)
+        @stacks.each do |stack|
+          errors << I18n.t('vagrant_openstack.config.invalid_stack') unless stack[:name] && stack[:template]
+        end unless @stacks.nil?
+      end
+
       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