vagrant-cloudstack 1.4.0 → 1.5.0

data/lib/vagrant-cloudstack/action/terminate_instance.rb

@@ -37,15 +37,7 @@ module VagrantPlugins
             options['expunge'] = expunge_on_destroy
 
             job = server.destroy(options)
-            while true
-              response = env[:cloudstack_compute].query_async_job_result({:jobid => job.id})
-              if response['queryasyncjobresultresponse']['jobstatus'] != 0
-                break
-              else
-                env[:ui].info('Waiting for instance to be deleted')
-                sleep 2
-              end
-            end
+            wait_for_job_ready(env, job.id, 'Waiting for instance to be deleted')
           end
 
           remove_volumes(env)
@@ -73,14 +65,7 @@ module VagrantPlugins
               begin
                 resp = env[:cloudstack_compute].detach_volume({:id => volume_id})
                 job_id = resp['detachvolumeresponse']['jobid']
-                while true
-                  response = env[:cloudstack_compute].query_async_job_result({:jobid => job_id})
-                  if response['queryasyncjobresultresponse']['jobstatus'] != 0
-                    break
-                  else
-                    sleep 2
-                  end
-                end
+                wait_for_job_ready(env, job_id)
               rescue Fog::Compute::Cloudstack::Error => e
                 if e.message =~ /Unable to execute API command detachvolume.*entity does not exist/
                   env[:ui].warn(I18n.t('vagrant_cloudstack.detach_volume_failed', message: e.message))
@@ -163,14 +148,7 @@ module VagrantPlugins
               begin
                 resp = env[:cloudstack_compute].delete_port_forwarding_rule({:id => rule_id})
                 job_id = resp['deleteportforwardingruleresponse']['jobid']
-                while true
-                  response = env[:cloudstack_compute].query_async_job_result({:jobid => job_id})
-                  if response['queryasyncjobresultresponse']['jobstatus'] != 0
-                    break
-                  else
-                    sleep 2
-                  end
-                end
+                wait_for_job_ready(env, job_id)
               rescue Fog::Compute::Cloudstack::Error => e
                 if e.message =~ /Unable to execute API command deleteportforwardingrule.*entity does not exist/
                   env[:ui].warn(" -- Failed to delete portforwarding rule: #{e.message}")
@@ -204,14 +182,7 @@ module VagrantPlugins
                 }
                 resp = env[:cloudstack_compute].request(options)
                 job_id = resp['disablestaticnatresponse']['jobid']
-                while true
-                  response = env[:cloudstack_compute].query_async_job_result({:jobid => job_id})
-                  if response['queryasyncjobresultresponse']['jobstatus'] != 0
-                    break
-                  else
-                    sleep 2
-                  end
-                end
+                wait_for_job_ready(env, job_id)
               rescue Fog::Compute::Cloudstack::Error => e
                 raise Errors::FogError, :message => e.message
               end
@@ -244,14 +215,7 @@ module VagrantPlugins
                 }
                 resp = env[:cloudstack_compute].request(options)
                 job_id = resp[response_string]['jobid']
-                while true
-                  response = env[:cloudstack_compute].query_async_job_result({:jobid => job_id})
-                  if response['queryasyncjobresultresponse']['jobstatus'] != 0
-                    break
-                  else
-                    sleep 2
-                  end
-                end
+                wait_for_job_ready(env, job_id)
               rescue Fog::Compute::Cloudstack::Error => e
                 if e.message =~ /Unable to execute API command deletefirewallrule.*entity does not exist/
                   env[:ui].warn(" -- Failed to delete #{type_string}: #{e.message}")
@@ -263,6 +227,18 @@ module VagrantPlugins
             firewall_file.delete
           end
         end
+
+        def wait_for_job_ready(env, job_id, message=nil)
+          while true
+            response = env[:cloudstack_compute].query_async_job_result({:jobid => job_id})
+            if response['queryasyncjobresultresponse']['jobstatus'] != 0
+              break
+            else
+              env[:ui].info(message) if message
+              sleep 2
+            end
+          end
+        end
       end
     end
   end

data/lib/vagrant-cloudstack/config.rb

@@ -3,6 +3,12 @@ require "vagrant"
 module VagrantPlugins
   module Cloudstack
     class Config < Vagrant.plugin("2", :config)
+      INSTANCE_VAR_DEFAULT_NIL = %w(host name path port domain_id network_id network_name project_id service_offering_id service_offering_name
+           template_id template_name zone_id zone_name keypair pf_ip_address_id pf_ip_address pf_public_port
+           pf_public_rdp_port pf_private_port pf_trusted_networks display_name group user_data ssh_key ssh_user
+           ssh_network_id ssh_network_name vm_user vm_password private_ip_address).freeze
+      INSTANCE_VAR_DEFAULT_EMPTY_ARRAY = %w(static_nat port_forwarding_rules firewall_rules security_group_ids security_group_names security_groups).freeze
+
       # Cloudstack api host.
       #
       # @return [String]
@@ -252,53 +258,25 @@ module VagrantPlugins
       # @return [Boolean]
       attr_accessor :expunge_on_destroy
 
-      def initialize(domain_specific=false)
-        @host                      = UNSET_VALUE
-        @name                      = UNSET_VALUE
-        @path                      = UNSET_VALUE
-        @port                      = UNSET_VALUE
-        @scheme                    = UNSET_VALUE
-        @api_key                   = UNSET_VALUE
-        @secret_key                = UNSET_VALUE
-        @instance_ready_timeout    = UNSET_VALUE
-        @domain_id                 = UNSET_VALUE
-        @network_id                = UNSET_VALUE
-        @network_name              = UNSET_VALUE
-        @network_type              = UNSET_VALUE
-        @project_id                = UNSET_VALUE
-        @service_offering_id       = UNSET_VALUE
-        @service_offering_name     = UNSET_VALUE
-        @template_id               = UNSET_VALUE
-        @template_name             = UNSET_VALUE
-        @zone_id                   = UNSET_VALUE
-        @zone_name                 = UNSET_VALUE
-        @keypair                   = UNSET_VALUE
-        @static_nat                = UNSET_VALUE
-        @pf_ip_address_id          = UNSET_VALUE
-        @pf_ip_address             = UNSET_VALUE
-        @pf_public_port            = UNSET_VALUE
-        @pf_public_rdp_port        = UNSET_VALUE
-        @pf_private_rdp_port       = UNSET_VALUE
-        @pf_public_port_randomrange= UNSET_VALUE
-        @pf_private_port           = UNSET_VALUE
-        @pf_open_firewall          = UNSET_VALUE
-        @pf_trusted_networks       = UNSET_VALUE
-        @port_forwarding_rules     = UNSET_VALUE
-        @firewall_rules            = UNSET_VALUE
-        @security_group_ids        = UNSET_VALUE
-        @display_name              = UNSET_VALUE
-        @group                     = UNSET_VALUE
-        @security_group_names      = UNSET_VALUE
-        @security_groups           = UNSET_VALUE
-        @user_data                 = UNSET_VALUE
-        @ssh_key                   = UNSET_VALUE
-        @ssh_user                  = UNSET_VALUE
-        @ssh_network_id            = UNSET_VALUE
-        @ssh_network_name          = UNSET_VALUE
-        @vm_user                   = UNSET_VALUE
-        @vm_password               = UNSET_VALUE
-        @private_ip_address        = UNSET_VALUE
-        @expunge_on_destroy        = UNSET_VALUE
+      def initialize(domain_specific = false)
+        # Initialize groups in bulk, re-use these groups to set defaults in bulk
+        INSTANCE_VAR_DEFAULT_NIL.each do |instance_variable|
+          instance_variable_set("@#{instance_variable}", UNSET_VALUE)
+        end
+        # Initialize groups in bulk, re-use these groups to set defaults in bulk
+        INSTANCE_VAR_DEFAULT_EMPTY_ARRAY.each do |instance_variable|
+          instance_variable_set("@#{instance_variable}", UNSET_VALUE)
+        end
+
+        @scheme                     = UNSET_VALUE
+        @api_key                    = UNSET_VALUE
+        @secret_key                 = UNSET_VALUE
+        @instance_ready_timeout     = UNSET_VALUE
+        @network_type               = UNSET_VALUE
+        @pf_private_rdp_port        = UNSET_VALUE
+        @pf_public_port_randomrange = UNSET_VALUE
+        @pf_open_firewall           = UNSET_VALUE
+        @expunge_on_destroy         = UNSET_VALUE
 
         # Internal state (prefix with __ so they aren't automatically
         # merged)
@@ -369,17 +347,17 @@ module VagrantPlugins
       end
 
       def finalize!
-        # Host must be nil, since we can't default that
-        @host                   = nil if @host == UNSET_VALUE
-
-        # Name must be nil, since we can't default that
-        @name                   = nil if @name == UNSET_VALUE
-
-        # Path must be nil, since we can't default that
-        @path                   = nil if @path == UNSET_VALUE
+        INSTANCE_VAR_DEFAULT_NIL.each do |instance_variable|
+          # ... must be nil, since we can't default that
+          instance_variable_set("@#{instance_variable}", nil) if
+              instance_variable_get("@#{instance_variable}") == UNSET_VALUE
+        end
 
-        # Port must be nil, since we can't default that
-        @port                   = nil if @port == UNSET_VALUE
+        INSTANCE_VAR_DEFAULT_EMPTY_ARRAY.each do |instance_variable|
+          # ... must be empty array
+          instance_variable_set("@#{instance_variable}", []) if
+              instance_variable_get("@#{instance_variable}") == UNSET_VALUE
+        end
 
         # We default the scheme to whatever the user has specifid in the .fog file
         # *OR* whatever is default for the provider in the fog library
@@ -393,131 +371,31 @@ module VagrantPlugins
         # Set the default timeout for waiting for an instance to be ready
         @instance_ready_timeout = 120 if @instance_ready_timeout == UNSET_VALUE
 
-        # Domain id must be nil, since we can't default that
-        @domain_id              = nil if @domain_id == UNSET_VALUE
-
-        # Network uuid must be nil, since we can't default that
-        @network_id             = nil if @network_id == UNSET_VALUE
-
-        # Network uuid must be nil, since we can't default that
-        @network_name           = nil if @network_name == UNSET_VALUE
-
         # NetworkType is 'Advanced' by default
         @network_type           = "Advanced" if @network_type == UNSET_VALUE
 
-        # Project uuid must be nil, since we can't default that
-        @project_id             = nil if @project_id == UNSET_VALUE
-
-        # Service offering uuid must be nil, since we can't default that
-        @service_offering_id    = nil if @service_offering_id == UNSET_VALUE
-
-        # Service offering name must be nil, since we can't default that
-        @service_offering_name  = nil if @service_offering_name == UNSET_VALUE
-
-        # Template uuid must be nil, since we can't default that
-        @template_id            = nil if @template_id == UNSET_VALUE
-
-        # Template name must be nil, since we can't default that
-        @template_name          = nil if @template_name == UNSET_VALUE
-
-        # Zone uuid must be nil, since we can't default that
-        @zone_id                = nil if @zone_id == UNSET_VALUE
-
-        # Zone uuid must be nil, since we can't default that
-        @zone_name              = nil if @zone_name == UNSET_VALUE
-
-        # Keypair defaults to nil
-        @keypair                = nil if @keypair == UNSET_VALUE
-
-        # Static NAT must be empty array
-        @static_nat             = [] if @static_nat == UNSET_VALUE
-
-        # IP address id must be nil, since we can't default that
-        @pf_ip_address_id       = nil if @pf_ip_address_id == UNSET_VALUE
-
-        # IP address must be nil, since we can't default that
-        @pf_ip_address          = nil if @pf_ip_address == UNSET_VALUE
-
-        # Public port must be nil, since we can't default that
-        @pf_public_port         = nil if @pf_public_port == UNSET_VALUE
-
-        # Public port must be nil, since we can't default that
-        @pf_public_rdp_port     = nil if @pf_public_rdp_port == UNSET_VALUE
-
         # Private rdp port defaults to 3389
         @pf_private_rdp_port     = 3389 if @pf_private_rdp_port == UNSET_VALUE
 
         # Public port random-range, default to rfc6335 'Dynamic Ports'; "(never assigned)"
-        @pf_public_port_randomrange = {:start=>49160, :end=>49200} if @pf_public_port_randomrange == UNSET_VALUE
-
-        # Private port must be nil, since we can't default that
-        @pf_private_port        = nil if @pf_private_port == UNSET_VALUE
+        @pf_public_port_randomrange = {:start=>49152, :end=>65535} if @pf_public_port_randomrange == UNSET_VALUE
 
         # Open firewall is true by default (for backwards compatibility)
         @pf_open_firewall       = true if @pf_open_firewall == UNSET_VALUE
 
-        # Trusted networks must be nil, since we can't default that
-        @pf_trusted_networks    = nil if @pf_trusted_networks == UNSET_VALUE
-
-        # Port forwarding rules  must be empty array
-        @port_forwarding_rules  = [] if @port_forwarding_rules == UNSET_VALUE
-
-        # Firewall rules  must be empty array
-        @firewall_rules         = [] if @firewall_rules == UNSET_VALUE
-
-        # Security Group IDs must be nil, since we can't default that
-        @security_group_ids     = [] if @security_group_ids == UNSET_VALUE
-
-        # Security Group Names must be nil, since we can't default that
-        @security_group_names   = [] if @security_group_names == UNSET_VALUE
-
-        # Security Groups must be nil, since we can't default that
-        @security_groups        = [] if @security_groups == UNSET_VALUE
-
-        # Display name must be nil, since we can't default that
-        @display_name           = nil if @display_name == UNSET_VALUE
-
-        # Group must be nil, since we can't default that
-        @group                  = nil if @group == UNSET_VALUE
-
-        # User Data is nil by default
-        @user_data              = nil if @user_data == UNSET_VALUE
-
-        # ssh key is nil by default
-        @ssh_key                = nil if @ssh_key == UNSET_VALUE
-
-        # ssh user is nil by default
-        @ssh_user               = nil if @ssh_user == UNSET_VALUE
-
-        # ssh network_id is nil by default
-        @ssh_network_id         = nil if @ssh_network_id == UNSET_VALUE
-
-        # ssh network_name is nil by default
-        @ssh_network_name       = nil if @ssh_network_name == UNSET_VALUE
-
-        # vm user is nil by default
-        @vm_user               = nil if @vm_user == UNSET_VALUE
-
-        # vm password is nil by default
-        @vm_password               = nil if @vm_password == UNSET_VALUE
-
-        # private ip is nil by default
-        @private_ip_address     = nil if @private_ip_address == UNSET_VALUE
-
         # expunge on destroy is nil by default
         @expunge_on_destroy     = false if @expunge_on_destroy == UNSET_VALUE
 
         # Compile our domain specific configurations only within
         # NON-DOMAIN-SPECIFIC configurations.
-        if !@__domain_specific
+        unless @__domain_specific
           @__domain_config.each do |domain, blocks|
             config = self.class.new(true).merge(self)
 
             # Execute the configuration for each block
             blocks.each { |b| b.call(config) }
 
-            # The domain name of the configuration always equals the
-            # domain config name:
+            # The domain name of the configuration always equals the domain config name:
             config.domain = domain
 
             # Finalize the configuration
@@ -536,11 +414,10 @@ module VagrantPlugins
         errors = []
 
         if @domain
-          # Get the configuration for the domain we're using and validate only
-          # that domain.
+          # Get the configuration for the domain we're using and validate only that domain.
           config = get_domain_config(@domain)
 
-          if !config.use_fog_profile
+          unless config.use_fog_profile
             errors << I18n.t("vagrant_cloudstack.config.api_key_required") if \
                config.access_key_id.nil?
             errors << I18n.t("vagrant_cloudstack.config.secret_key_required") if \
@@ -554,9 +431,7 @@ module VagrantPlugins
       # This gets the configuration for a specific domain. It shouldn't
       # be called by the general public and is only used internally.
       def get_domain_config(name)
-        if !@__finalized
-          raise "Configuration must be finalized before calling this method."
-        end
+        raise 'Configuration must be finalized before calling this method.' unless @__finalized
 
         # Return the compiled domain config
         @__compiled_domain_configs[name] || self

data/lib/vagrant-cloudstack/exceptions/exceptions.rb

@@ -1,9 +1,14 @@
 module VagrantPlugins
   module Cloudstack
     module Exceptions
-      class IpNotFoundException < Exception
+      class IpNotFoundException < StandardError
       end
-      class DuplicatePFRule < Exception
+      class DuplicatePFRule < StandardError
+      end
+      class CloudstackResourceNotFound < StandardError
+        def initialize(msg='Resource not found in cloudstack')
+          super
+        end
       end
     end
   end

data/lib/vagrant-cloudstack/service/cloudstack_resource_service.rb

@@ -1,7 +1,11 @@
+require 'vagrant-cloudstack/exceptions/exceptions'
+
 module VagrantPlugins
   module Cloudstack
     module Service
       class CloudstackResourceService
+        include VagrantPlugins::Cloudstack::Exceptions
+
         def initialize(cloudstack_compute, ui)
           @cloudstack_compute = cloudstack_compute
           @ui                 = ui
@@ -9,13 +13,13 @@ module VagrantPlugins
 
         def sync_resource(resource, api_parameters = {})
           @resource_details = nil
-          if resource.id.nil? and resource.name
+          if resource.id.nil? and !(resource.name.nil? || resource.name.empty? )
             resource.id = name_to_id(resource.name, resource.kind, api_parameters)
           elsif resource.id
             resource.name = id_to_name(resource.id, resource.kind, api_parameters)
           end
 
-          unless resource.is_undefined?
+          unless resource.is_id_undefined? || resource.is_name_undefined?
             resource.details = @resource_details
             @ui.detail("Syncronized resource: #{resource}")
           end
@@ -37,14 +41,22 @@ module VagrantPlugins
         def resourcefield_to_id(resource_type, resource_field, resource_field_value, options={})
           @ui.info("Fetching UUID for #{resource_type} with #{resource_field} '#{resource_field_value}'")
           full_response = translate_from_to(resource_type, options)
-          @resource_details = full_response.find {|type| type[resource_field] == resource_field_value }
-          @resource_details['id']
+          @resource_details = full_response.find {|type| type[resource_field] == resource_field_value } if full_response
+          if @resource_details
+            @resource_details['id']
+          else
+            raise CloudstackResourceNotFound.new("No UUID found for #{resource_type} with #{resource_field} '#{resource_field_value}'")
+          end
         end
 
         def id_to_resourcefield(resource_id, resource_type, resource_field, options={})
           @ui.info("Fetching #{resource_field} for #{resource_type} with UUID '#{resource_id}'")
           options = options.merge({'id' => resource_id})
-          full_response = translate_from_to(resource_type, options)
+          begin
+            full_response = translate_from_to(resource_type, options)
+          rescue Fog::Compute::Cloudstack::BadRequest => e
+            raise CloudstackResourceNotFound.new("No Name found for #{resource_type} with UUID '#{resource_id}', #{e.class.to_s} reports:\n #{e.message}")
+          end
           @resource_details = full_response[0]
           @resource_details[resource_field]
         end

data/lib/vagrant-cloudstack/version.rb

@@ -1,5 +1,5 @@
 module VagrantPlugins
   module Cloudstack
-    VERSION = '1.4.0'
+    VERSION = '1.5.0'
   end
 end

data/spec/spec_helper.rb

@@ -1,8 +1,53 @@
 require 'simplecov'
 require 'coveralls'
 require 'rspec/its'
+require 'i18n'
 
 Dir["#{__dir__}/vagrant-cloudstack/support/**/*.rb"].each { |f| require f }
 
 SimpleCov.start
 Coveralls.wear!
+
+ZONE_NAME = 'Zone Name'.freeze
+ZONE_ID = 'Zone UUID'.freeze
+SERVICE_OFFERING_NAME = 'Service Offering Name'.freeze
+SERVICE_OFFERING_ID = 'Service Offering UUID'.freeze
+TEMPLATE_NAME = 'Template Name'.freeze
+TEMPLATE_ID = 'Template UUID'.freeze
+NETWORK_NAME = 'Network Name'.freeze
+NETWORK_ID = 'Network UUID'.freeze
+VPC_ID = 'VPC UUID'.freeze
+DISPLAY_NAME = 'Display Name'.freeze
+DISK_OFFERING_NAME = 'Disk Offering Name'.freeze
+DISK_OFFERING_ID = 'Disk Offering UUID'.freeze
+
+SERVER_ID = 'Server UUID'.freeze
+NETWORK_TYPE_ADVANCED = 'Advanced'.freeze
+NETWORK_TYPE_BASIC = 'Basic'.freeze
+SECURITY_GROUPS_ENABLED = true
+SECURITY_GROUPS_DISABLED = false
+SECURITY_GROUP_ID   = 'UUID of Security Group'.freeze
+SECURITY_GROUP_NAME = 'Name of Security Group'.freeze
+SECURITY_GROUP_DESC = 'Description of Security Group'.freeze
+
+PF_IP_ADDRESS = 'Public IP for port forwarding'.freeze
+PF_IP_ADDRESS_ID = 'UUID of Public IP for port forwarding'.freeze
+PF_TRUSTED_NETWORKS = 'IP Ranges to allow public access from'.freeze
+PF_RANDOM_START = 49_152
+GUEST_PORT_SSH = 22
+GUEST_PORT_WINRM = 5985
+GUEST_PORT_RDP = 3389
+
+COMMUNICATOR_SSH = 'VagrantPlugins::CommunicatorSSH::Communicator'.freeze
+COMMUNICATOR_WINRM = 'VagrantPlugins::CommunicatorWinRM::Communicator'.freeze
+
+SSH_GENERATED_PRIVATE_KEY = '-----BEGIN RSA PRIVATE KEY-----\nMIICWwIBA==\n-----END RSA PRIVATE KEY-----'.freeze
+SSH_GENERATED_KEY_NAME = 'SSH Generated Key Name'.freeze
+JOB_ID = 'UUID of a Job'.freeze
+PORT_FORWARDING_RULE_ID = 'UUID of port forwarding rule'.freeze
+ACL_ID = 'UUID of an ACL'.freeze
+GENERATED_PASSWORD = 'Generated password'.freeze
+VOLUME_ID = 'UUID of volume'.freeze
+
+I18n.load_path << File.expand_path('../../locales/en.yml', __FILE__)
+I18n.reload!