vagrant-xenserver 0.0.11 → 0.0.12

data/lib/vagrant-xenserver/config.rb

@@ -8,6 +8,16 @@ module VagrantPlugins
       # @return [String]
       attr_accessor :xs_host
 
+      # The port to communicate with the API on XenServer
+      #
+      # @return [Int]
+      attr_accessor :xs_port
+
+      # True if the API should be accessed over SSL/TLS
+      #
+      # @return [Bool]
+      attr_accessor :xs_use_ssl
+
       # The XenServer username
       #
       # @return [String]
@@ -18,30 +28,61 @@ module VagrantPlugins
       # @return [String]
       attr_accessor :xs_password
 
+      # Name of the VM
+      #
+      # @return [String]
+      attr_accessor :name
+
       # True if the VM should be PV
       #
       # @return [Bool]
       attr_accessor :pv
 
+      # Timeout for commands sent to XenServer
+      #
+      # @return [Int]
+      attr_accessor :api_timeout
+
       # Memory settings
       #
       # @return [Int]
       attr_accessor :memory
 
+      # XVA URL: If this is set, we'll assume that the XenServer should directly download an XVA from the specified URL
+      #
+      # @return [String]
+      attr_accessor :xva_url
+
+      # Use HIMN: If this is set, we'll use the host-internal-management-network to connect to the VM (proxying via dom0)
+      # Useful if the guest does not have tools installed
+      attr_accessor :use_himn
+
       def initialize
         @xs_host = UNSET_VALUE
+        @xs_port = UNSET_VALUE
+        @xs_use_ssl = UNSET_VALUE
         @xs_username = UNSET_VALUE
         @xs_password = UNSET_VALUE
+        @name = UNSET_VALUE
         @pv = UNSET_VALUE
+        @api_timeout = UNSET_VALUE
         @memory = UNSET_VALUE
+        @xva_url = UNSET_VALUE
+        @use_himn = UNSET_VALUE
       end
 
       def finalize!
         @xs_host = nil if @xs_host == UNSET_VALUE
+        @xs_port = 80 if @xs_port == UNSET_VALUE
+        @xs_use_ssl = false if @xs_use_ssl == UNSET_VALUE
         @xs_username = nil if @xs_username == UNSET_VALUE
         @xs_password = nil if @xs_password == UNSET_VALUE
+        @name = nil if @name == UNSET_VALUE
         @pv = nil if @pv == UNSET_VALUE
+        @api_timeout = 60 if @api_timeout == UNSET_VALUE
         @memory = 1024 if @memory == UNSET_VALUE
+        @xva_url = nil if @xva_url == UNSET_VALUE
+        @use_himn = false if @use_himn == UNSET_VALUE
       end
 
       def validate(machine)
@@ -50,8 +91,12 @@ module VagrantPlugins
         errors << I18n.t("vagrant_xenserver.config.username_required") if @xs_username.nil?
         errors << I18n.t("vagrant_xenserver.config.password_required") if @xs_password.nil?
 
+        if not (machine.config.vm.networks.any? { |type,options| type == :public_network })
+          errors << I18n.t("vagrant_xenserver.config.himn_required") if not @use_himn
+        end
         { "XenServer Provider" => errors }
       end
     end
   end
 end
+

data/lib/vagrant-xenserver/errors.rb

@@ -26,6 +26,26 @@ module VagrantPlugins
       class UnknownOS < VagrantXenServerError
         error_key(:unknown_os)
       end
+
+      class QemuImgError < VagrantXenServerError
+        error_key(:qemuimg_error)
+      end
+
+      class NoDefaultSR < VagrantXenServerError
+        error_key(:nodefaultsr_error)
+      end
+
+      class NoHostsAvailable < VagrantXenServerError
+        error_key(:nohostsavailable_error)
+      end
+
+      class Import404 < VagrantXenServerError
+        error_key(:import404)
+      end
+
+      class InsufficientSpace < VagrantXenServerError
+        error_key(:insufficientspace)
+      end
     end
   end
 end

data/lib/vagrant-xenserver/plugin.rb

@@ -20,9 +20,17 @@ module VagrantPlugins
       end
 
       provider('xenserver', parallel: true) do
+        setup_i18n
+
 	require_relative "provider"
         Provider
       end
+
+      def self.setup_i18n
+        I18n.load_path << File.expand_path('locales/en.yml',
+                                           XenServer.source_root)
+        I18n.reload!
+      end
     end
   end
 end

data/lib/vagrant-xenserver/util/exnhandler.rb

@@ -0,0 +1,49 @@
+# Handle the errors thrown by XenServer
+require "json"
+
+module VagrantPlugins
+  module XenServer
+    module MyUtil
+      class Exnhandler
+
+        def self.def(api,error)
+          # Default case: raise generic API error
+          raise Errors::APIError,
+                api: api,
+                error: String(error)
+        end
+
+        def self.handle(api,error)
+          case error[0]
+          when "IMPORT_ERROR"
+            case error[1]
+            when "404 Not Found"
+              raise Errors::Import404
+            else
+              Exnhandler.def(api,error)
+            end
+          when "SR_BACKEND_FAILURE_44"
+            raise Errors::InsufficientSpace
+          else
+            raise Errors::APIError,
+                  api: api,
+                  error: String(error)
+          end
+        end
+
+        def self.handle_xenapiexn(api,e,logger)
+          case e
+          when XenApi::Errors::SRFull
+            raise Errors::InsufficientSpace
+          when XenApi::Errors::GenericError
+            # Grotesque hack - get the error array back by parsing the string
+            # representation as JSON. Bleurgh!
+            self.handle(api,JSON.parse(e.message))
+          else
+            self.handle(api,e)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/vagrant-xenserver/version.rb

@@ -1,6 +1,6 @@
 module VagrantPlugins
   module XenServer
-    VERSION = "0.0.11"
+    VERSION = "0.0.12"
   end
 end
 

data/locales/en.yml

@@ -7,4 +7,23 @@ en:
         The XenServer username must be defined via "xs_username"
       password_required: |-
         The password for the XenServer username must be defined via "xs_password"
-
+      himn_required: |-
+        Either a public network must be specified or the Host Internal Management Network
+        parameter must be enabled. Public networks require the XenServer tools to be
+        installed in the guest. If this is not the case, the HIMN must be used by specifying
+        'use_himn=true' in the provider configuration.
+    errors:
+      login_error: |-
+        Failed to login to the XenServer. Check the "xs_username" and "xs_password" parameters
+      qemuimg_error: |-
+        Failure executing qemu-img. Check that it is installed and working, and that the VHD file referenced is valid.
+      nodefaultsr_error: |-
+        Failed to find a valid default SR for the pool. Please set one.
+      nohostsavailable_error: |-
+        No hosts were available to start the VM. Check the memory, disks and whether the hosts are enabled
+      import404: |-
+        The XVA import failed with a 404 Not Found error: Check the xva_url parameter of your box.
+      insufficientspace: |-
+        There is insufficient space available on the SR.
+      api_error: |-
+        The API call '%{api}' failed with error '%{error}'.

data/vagrant-xenserver.gemspec

@@ -15,6 +15,7 @@ Gem::Specification.new do |s|
   s.add_development_dependency "rake"
   s.add_runtime_dependency "nokogiri", "~> 1.6.3"
   s.add_runtime_dependency "json"
+  s.add_runtime_dependency "xenapi"
 
   s.files         = `git ls-files`.split($\)
   s.executables   = [] # gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: vagrant-xenserver
 version: !ruby/object:Gem::Version
-  version: 0.0.11
+  version: 0.0.12
 platform: ruby
 authors:
 - Jon Ludlam
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-07-21 00:00:00.000000000 Z
+date: 2016-08-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -52,6 +52,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: xenapi
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Enables Vagrant to manage XenServers.
 email: jonathan.ludlam@citrix.com
 executables: []
@@ -63,25 +77,30 @@ files:
 - LICENSE
 - README.md
 - Rakefile
+- example_box/install_wheezy.sh
 - example_box/metadata.json
+- example_box/mkbox.sh
 - lib/vagrant-xenserver.rb
 - lib/vagrant-xenserver/action.rb
 - lib/vagrant-xenserver/action/clone_disk.rb
+- lib/vagrant-xenserver/action/clone_vm.rb
 - lib/vagrant-xenserver/action/connect_xs.rb
+- lib/vagrant-xenserver/action/create_template.rb
 - lib/vagrant-xenserver/action/create_vifs.rb
 - lib/vagrant-xenserver/action/create_vm.rb
 - lib/vagrant-xenserver/action/destroy_vm.rb
+- lib/vagrant-xenserver/action/download_xva.rb
 - lib/vagrant-xenserver/action/dummy.rb
 - lib/vagrant-xenserver/action/halt_vm.rb
 - lib/vagrant-xenserver/action/is_created.rb
 - lib/vagrant-xenserver/action/is_running.rb
 - lib/vagrant-xenserver/action/is_suspended.rb
-- lib/vagrant-xenserver/action/maybe_upload_disk.rb
 - lib/vagrant-xenserver/action/prepare_nfs_settings.rb
 - lib/vagrant-xenserver/action/prepare_nfs_valid_ids.rb
 - lib/vagrant-xenserver/action/read_ssh_info.rb
 - lib/vagrant-xenserver/action/read_state.rb
 - lib/vagrant-xenserver/action/resume_vm.rb
+- lib/vagrant-xenserver/action/set_vm_params.rb
 - lib/vagrant-xenserver/action/start_vm.rb
 - lib/vagrant-xenserver/action/suspend_vm.rb
 - lib/vagrant-xenserver/action/upload_vhd.rb
@@ -90,10 +109,10 @@ files:
 - lib/vagrant-xenserver/errors.rb
 - lib/vagrant-xenserver/plugin.rb
 - lib/vagrant-xenserver/provider.rb
+- lib/vagrant-xenserver/util/exnhandler.rb
 - lib/vagrant-xenserver/util/uploader.rb
 - lib/vagrant-xenserver/version.rb
 - locales/en.yml
-- test
 - vagrant-xenserver.gemspec
 homepage: http://github.com/jonludlam/vagrant-xenserver
 licenses:
@@ -115,7 +134,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.3
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: Enables Vagrant to manage XenServers.

data/lib/vagrant-xenserver/action/maybe_upload_disk.rb

@@ -1,85 +0,0 @@
-require "log4r"
-require "xmlrpc/client"
-require "vagrant-xenserver/util/uploader"
-require "rexml/document"
-
-module VagrantPlugins
-  module XenServer
-    module Action
-      class UploadXVA
-        def initialize(app, env)
-          @app = app
-          @logger = Log4r::Logger.new("vagrant::xenserver::actions::maybe_upload_disk")
-        end
-        
-        def call(env)
-          #box_image_file = env[:machine].box.directory.join('export.xva').to_s
-          box_image_file = "/home/jludlam/devel/vagrant-xenserver/centos-6.5.vhd"
-          hostname = env[:machine].provider_config.xs_host
-          session = env[:session]
-
-          @logger.info("box name=" + env[:machine].box.name.to_s)
-          @logger.info("box version=" + env[:machine].box.version.to_s)
-
-          # Create a task to so we can get the result of the upload
-          task_result = env[:xc].call("task.create", env[:session], "vagrant-xva-upload",
-                        "Task to track progress of the XVA upload from vagrant")
-          
-          if task_result["Status"] != "Success"
-            raise Errors::APIError
-          end
-
-          task = task_result["Value"]
-
-          url = "https://#{hostname}/import?session_id=#{session}&task_id=#{task}"
-
-          uploader_options = {}
-          uploader_options[:ui] = env[:ui]
-          uploader_options[:insecure] = true
-          
-          uploader = MyUtil::Uploader.new(box_image_file, url, uploader_options)
-
-          begin
-            uploader.upload!
-          rescue Errors::UploaderInterrupted
-            env[:ui].info(I18n.t("vagrant.xenserver.action.upload_xva.interrupted"))
-            raise
-          end
-
-          task_status = ""
-
-          begin
-            sleep(0.2)
-            task_status_result = env[:xc].call("task.get_status",env[:session],task)
-            if task_status_result["Status"] != "Success"
-              raise Errors::APIError
-            end
-            task_status = task_status_result["Value"]
-          end while task_status == "pending"
-
-          @logger.info("task_status="+task_status)
-
-          if task_status != "success"
-            raise Errors::APIError
-          end
-
-          task_result_result = env[:xc].call("task.get_result",env[:session],task)
-          if task_result_result["Status"] != "Success"
-            raise Errors::APIError
-          end
-
-          task_result = task_result_result["Value"]
-
-          doc = REXML::Document.new(task_result)
-
-          doc.elements.each('value/array/data/value') do |ele|
-            @logger.info("ele=" + ele.text)
-          end
-
-          @logger.info("task_result=" + task_result)
-
-        end
-      end
-    end
-  end
-end