ovirt 0.4.2 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5eb20c16fc490965286768f8a1ec0068a75c0e01
-  data.tar.gz: f86dd519bac3b0b97b42199c232c9975229a5a92
+  metadata.gz: e8e5086cc3efac6612e4e1631b5af6d14c6c5280
+  data.tar.gz: 25b06d7e055266368c2a3bf5ce9348a464459a9a
 SHA512:
-  metadata.gz: f79e2e12f2faca3d402a7aa5244c28165e8e1ee45b849444b7f46122964575afbdf0ec40351b5bd37f7074ae3ebe847e4539e32eb1cc8bb908ac566c0c29a743
-  data.tar.gz: a9b079f45a56188e8d40e21b8c0e9bd588b0faf3b46c180f5aa8f41622707a22154f416cfb23142a55e8024e78371f2ee90734ed726d8116097952ef4c36a33e
+  metadata.gz: d0fd8d69ed5af1e4392a023307b4165baea65a35c009d6da188f01e072d1caf5c2e06d2cc8d9683b0879d7fc204a233e334171f999812a3eac047b9c1f8e1ed7
+  data.tar.gz: daad3060acc9154fb9271c9e24ca2e3202ba5b82d7075cc21809a9a0c45312050fabb95dbcd85ea775dc3c19e1a85ac195c384f9a2f593af214d55b13dbf20a2

data/lib/ovirt/event.rb

@@ -298,7 +298,6 @@ module Ovirt
        521 => "USER_SUSPEND_VM_FINISH_FAILURE",
        522 => "HOST_SET_NONOPERATIONAL_DOMAIN",
        523 => "HOST_SET_NONOPERATIONAL_DOMAIN_FAILED",
-       524 => "AUTO_SUSPEND_VM",
        524 => "HOST_DOMAIN_DELAY_INTERVAL",
        525 => "AUTO_SUSPEND_VM_FINISH_SUCCESS",
        526 => "AUTO_SUSPEND_VM_FINISH_FAILURE",

data/lib/ovirt/exception.rb

@@ -10,4 +10,7 @@ module Ovirt
   class VmAlreadyRunning < Error; end
   class VmIsNotRunning   < Error; end
   class VmNotReadyToBoot < Error; end
+
+  class UsageError < Error; end
+  class CloudInitSyntaxError < UsageError; end
 end

data/lib/ovirt/legacy_support/cloud_init_via_floppy_payload.rb

@@ -0,0 +1,7 @@
+module Ovirt
+  module CloudInitViaFloppyPayload
+    def cloud_init=(content)
+      attach_floppy("user-data.txt" => content)
+    end
+  end
+end

data/lib/ovirt/service.rb

@@ -240,8 +240,10 @@ module Ovirt
       doc    = Nokogiri::XML(response)
       action = doc.xpath("action").first
       node   = action || doc
-      reason = node.xpath("fault/detail").text
-      raise Ovirt::Error, reason
+      fault  = node.xpath("fault/detail").text
+      usage  = node.xpath("usage_message/message").text
+      raise Ovirt::Error, fault unless fault.blank?
+      raise Ovirt::UsageError, usage
     end
 
     def parse_set_cookie_header(set_cookie_header)

data/lib/ovirt/version.rb

@@ -1,3 +1,3 @@
 module Ovirt
-  VERSION = "0.4.2"
+  VERSION = "0.5.0"
 end

data/lib/ovirt/vm.rb

@@ -1,3 +1,5 @@
+require_relative 'legacy_support/cloud_init_via_floppy_payload'
+
 module Ovirt
   class Vm < Template
     self.top_level_strings    = [:name, :origin, :type, :description]
@@ -6,6 +8,8 @@ module Ovirt
     self.top_level_timestamps = [:creation_time, :start_time]
     self.top_level_objects    = [:cluster, :template, :host]
 
+    include CloudInitViaFloppyPayload
+
     attr_accessor :creation_status_link
 
     def initialize(*args)
@@ -122,6 +126,22 @@ module Ovirt
       end
     end
 
+    def cloud_init=(content)
+      if service.version[:major].to_i == 3 && service.version[:minor].to_i < 4
+        super  # Use legacy method defined in CloudInitViaFloppyPayload
+      else
+        begin
+          update! do |xml|
+            xml.initialization do
+              converted_cloud_init(content).each { |k, v| xml.send(k, v) }
+            end
+          end
+        rescue Ovirt::UsageError => err
+          raise CloudInitSyntaxError, err.message
+        end
+      end
+    end
+
     # Attaches a payload.
     #
     # payloads:: Hash of payload_type => {file_name => content} that will be
@@ -332,5 +352,19 @@ module Ovirt
       raise TemplateAlreadyExists, err.message if err.message.include?("Template name already exists")
       raise
     end
+
+    private
+
+    def converted_cloud_init(content)
+      ovirt_cloud_init_keys = %w(active_directory_ou authorized_ssh_keys dns_search dns_servers domain host_name input_locale nic_configurations org_name regenerate_ssh_keys root_password system_locale timezone ui_language user_locale user_name)
+
+      require 'yaml'
+      raw_content = YAML.load(content)
+
+      hash = ovirt_cloud_init_keys.each_with_object({}) { |k, h| h[k] = raw_content.delete(k) }
+      custom_script = YAML.dump(raw_content).to_s.sub("---\n", "")
+      hash[:custom_script] = custom_script unless custom_script.blank?
+      hash.delete_nils
+    end
   end
 end

data/spec/factories/service.rb

@@ -0,0 +1,5 @@
+FactoryGirl.define do
+  factory :service, :class => "Ovirt::Service" do
+    initialize_with { new(:server => "", :username => "", :password => "") }
+  end
+end

data/spec/factories/vm.rb

@@ -0,0 +1,40 @@
+FactoryGirl.define do
+  factory :vm, :class => "Ovirt::Vm" do
+    initialize_with { new(service, {}) }
+    service { build(:service) }
+  end
+
+  factory :vm_full, :parent => :vm do
+    initialize_with do
+      new(service,
+        {
+          :actions           => {:stop => '/api/vms/128f9ffd-b82c-41e4-8c00-9742ed173bac/stop'},
+          :id                => "128f9ffd-b82c-41e4-8c00-9742ed173bac",
+          :href              => "/api/vms/128f9ffd-b82c-41e4-8c00-9742ed173bac",
+          :cluster           => {
+            :id   => "5be5d08a-a60b-11e2-bee6-005056a217db",
+            :href => "/api/clusters/5be5d08a-a60b-11e2-bee6-005056a217db"},
+          :template          => {
+            :id   => "00000000-0000-0000-0000-000000000000",
+            :href => "/api/templates/00000000-0000-0000-0000-000000000000"},
+          :name              => "bd-skeletal-clone-from-template",
+          :origin            => "rhev",
+          :type              => "server",
+          :memory            => 536_870_912,
+          :stateless         => false,
+          :creation_time     => "2013-09-04 16:24:20 -0400",
+          :status            => {:state => "down"},
+          :display           => {:type => "spice", :monitors => 1},
+          :usb               => {:enabled => false},
+          :cpu               => {:sockets => 1, :cores => 1},
+          :high_availability => {:priority => 1, :enabled => false},
+          :os                => {:type => "unassigned", :boot_order => [{:dev => "hd"}]},
+          :custom_attributes => [],
+          :placement_policy  => {:affinity => "migratable", :host => {}},
+          :memory_policy     => {:guaranteed => 536_870_912},
+          :guest_info        => {}
+        }
+      )
+    end
+  end
+end

data/spec/legacy_support/cloud_init_via_floppy_payload_spec.rb

@@ -0,0 +1,14 @@
+require 'spec_helper'
+
+describe Ovirt::CloudInitViaFloppyPayload do
+  let(:vm) { build(:vm) }
+
+  it "cloud_init= Ovirt 3.3 and older" do
+    cloud_config = "#cloud_config\nroot_password: some_password\nregenerate_ssh_keys: false\ncustom_script: \"#!/bin/bash\necho 'hi'\""
+
+    expect(vm.service).to receive(:api).and_return(:product_info => {:version => {:major => "3", :minor => "3", :revision => "0", :build => "0"}})
+    expect(vm).to         receive(:attach_floppy).with("user-data.txt" => cloud_config)
+
+    vm.cloud_init = cloud_config
+  end
+end

data/spec/service_spec.rb

@@ -2,9 +2,7 @@ require 'spec_helper'
 require 'rest-client'
 
 describe Ovirt::Service do
-  before do
-    @service = described_class.new(:server => "", :username => "", :password => "")
-  end
+  let(:service) { build(:service) }
 
   context "#resource_post" do
     it "raises Ovirt::Error if HTTP 409 response code received" do
@@ -23,14 +21,32 @@ EOX
         block.call(return_data)
       end
 
-      @service.stub(:create_resource).and_return(rest_client)
-      expect { @service.resource_post('uri', 'data') }.to raise_error(Ovirt::Error, error_detail)
+      service.stub(:create_resource).and_return(rest_client)
+      expect { service.resource_post('uri', 'data') }.to raise_error(Ovirt::Error, error_detail)
+    end
+
+    it "raises Ovirt::Error if HTTP 409 response code received" do
+      error_detail = "Usage message"
+      return_data = <<-EOX.chomp
+<usage_message>
+  <message>#{error_detail}</message>
+</usage_message>
+EOX
+
+      rest_client = double('rest_client').as_null_object
+      rest_client.should_receive(:post) do |&block|
+        return_data.stub(:code).and_return(409)
+        block.call(return_data)
+      end
+
+      service.stub(:create_resource).and_return(rest_client)
+      expect { service.resource_post('uri', 'data') }.to raise_error(Ovirt::UsageError, error_detail)
     end
   end
 
   it "#resource_get on exception" do
-    @service.stub(:create_resource).and_raise(Exception, "BLAH")
-    expect { @service.resource_get('api') }.to raise_error(Exception, "BLAH")
+    service.stub(:create_resource).and_raise(Exception, "BLAH")
+    expect { service.resource_get('api') }.to raise_error(Exception, "BLAH")
   end
 
   context ".ovirt?" do

data/spec/spec_helper.rb

@@ -1,3 +1,6 @@
+require 'factory_girl'
+FactoryGirl.find_definitions
+
 # This file was generated by the `rspec --init` command. Conventionally, all
 # specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
 # Require this file using `require "spec_helper"` to ensure that it is only
@@ -13,6 +16,7 @@ RSpec.configure do |config|
   # the seed, which is printed after each run.
   #     --seed 1234
   config.order = 'random'
+  config.include FactoryGirl::Syntax::Methods
 end
 
 begin

data/spec/template_spec.rb

@@ -1,9 +1,9 @@
 require 'spec_helper'
 
 describe Ovirt::Template do
+  let(:service) { build(:service) }
   before do
-    @service = double('service')
-    @template = Ovirt::Template.new(@service, {
+    @template = Ovirt::Template.new(service, {
        :id                => "128f9ffd-b82c-41e4-8c00-9742ed173bac",
        :href              => "/api/vms/128f9ffd-b82c-41e4-8c00-9742ed173bac",
        :cluster           => {
@@ -46,8 +46,8 @@ describe Ovirt::Template do
         :os_type           => "rhel5_64"}
       @template.stub(:nics).and_return([])
       @template.stub(:disks).and_return([])
-      @service.stub(:blank_template).and_return(double('blank template'))
-      @service.blank_template.should_receive(:create_vm).once.with(expected_data)
+      service.stub(:blank_template).and_return(double('blank template'))
+      service.blank_template.should_receive(:create_vm).once.with(expected_data)
       @template.create_vm(options)
     end
 
@@ -90,13 +90,13 @@ EOX
         :name       => 'new name',
         :cluster    => 'fb27f9a0-cb75-4e0f-8c07-8dec0c5ab483',
         :os_type    => 'test'}
-      @service.should_receive(:resource_post).once.with(:vms, expected_data).and_return(response_xml)
+      service.should_receive(:resource_post).once.with(:vms, expected_data).and_return(response_xml)
       @template.create_vm(options)
     end
 
     context "#create_new_disks_from_template" do
       before do
-        @disk = Ovirt::Disk.new(@service, {
+        @disk = Ovirt::Disk.new(service, {
           :id=>"01eae62b-90df-424d-978c-beaa7eb2f7f6",
           :href=>"/api/templates/54f1b9f4-0e89-4c72-9a26-f94dcb857264/disks/01eae62b-90df-424d-978c-beaa7eb2f7f6",
           :name=>"clone_Disk1",

data/spec/vm_spec.rb

@@ -1,40 +1,12 @@
 require 'spec_helper'
 
 describe Ovirt::Vm do
-  before do
-    @service = Ovirt::Service.new({:server => "", :username => "", :password => ""})
-    @vm = Ovirt::Vm.new(@service, {
-       :actions           => {:stop => '/api/vms/128f9ffd-b82c-41e4-8c00-9742ed173bac/stop'},
-       :id                => "128f9ffd-b82c-41e4-8c00-9742ed173bac",
-       :href              => "/api/vms/128f9ffd-b82c-41e4-8c00-9742ed173bac",
-       :cluster           => {
-         :id   => "5be5d08a-a60b-11e2-bee6-005056a217db",
-         :href => "/api/clusters/5be5d08a-a60b-11e2-bee6-005056a217db"},
-       :template          => {
-         :id   => "00000000-0000-0000-0000-000000000000",
-         :href => "/api/templates/00000000-0000-0000-0000-000000000000"},
-       :name              => "bd-skeletal-clone-from-template",
-       :origin            => "rhev",
-       :type              => "server",
-       :memory            => 536_870_912,
-       :stateless         => false,
-       :creation_time     => "2013-09-04 16:24:20 -0400",
-       :status            => {:state => "down"},
-       :display           => {:type => "spice", :monitors => 1},
-       :usb               => {:enabled => false},
-       :cpu               => {:sockets => 1, :cores => 1},
-       :high_availability => {:priority => 1, :enabled => false},
-       :os                => {:type => "unassigned", :boot_order => [{:dev => "hd"}]},
-       :custom_attributes => [],
-       :placement_policy  => {:affinity => "migratable", :host => {}},
-       :memory_policy     => {:guaranteed => 536_870_912},
-       :guest_info        => {}
-    })
-  end
+  let(:service) { vm.service }
+  let(:vm)      { build(:vm_full) }
 
   context "#create_disk" do
     before do
-      @resource_url = "#{@vm.attributes[:href]}/disks"
+      @resource_url = "#{vm.attributes[:href]}/disks"
       @base_options = {
         :storage            => "aa7e70e5-abcd-1234-a605-92ce6ba652a8",
         :id                 => "01eae62b-90df-424d-978c-beaa7eb2f7f6",
@@ -77,16 +49,16 @@ EOX
           expected_data = @base_data
           options = @base_options.merge(boolean_key => true)
 
-          @service.should_receive(:resource_post).once.with(@resource_url, expected_data)
-          @vm.create_disk(options)
+          service.should_receive(:resource_post).once.with(@resource_url, expected_data)
+          vm.create_disk(options)
         end
 
         it "set to false" do
           expected_data = @base_data.gsub("<#{boolean_key.to_s}>true</#{boolean_key.to_s}>", "<#{boolean_key.to_s}>false</#{boolean_key.to_s}>")
           options = @base_options.merge(boolean_key => false)
 
-          @service.should_receive(:resource_post).once.with(@resource_url, expected_data)
-          @vm.create_disk(options)
+          service.should_receive(:resource_post).once.with(@resource_url, expected_data)
+          vm.create_disk(options)
         end
 
         it "unset" do
@@ -94,8 +66,8 @@ EOX
           options = @base_options.dup
           options.delete(boolean_key)
 
-          @service.should_receive(:resource_post).once.with(@resource_url, expected_data)
-          @vm.create_disk(options)
+          service.should_receive(:resource_post).once.with(@resource_url, expected_data)
+          vm.create_disk(options)
         end
       end
     end
@@ -104,7 +76,7 @@ EOX
   context "#create_nic" do
     before do
       @name         = 'nic_name'
-      @resource_url = "#{@vm.attributes[:href]}/nics"
+      @resource_url = "#{vm.attributes[:href]}/nics"
       @base_options = {:name => @name}
     end
 
@@ -119,23 +91,23 @@ EOX
 
     it "populates the interface" do
       interface = 'interface'
-      @service.should_receive(:resource_post).once.with(
+      service.should_receive(:resource_post).once.with(
           @resource_url, expected_data("<interface>#{interface}</interface>"))
-      @vm.create_nic(@base_options.merge({:interface => interface}))
+      vm.create_nic(@base_options.merge({:interface => interface}))
     end
 
     it "populates the network id" do
       network_id = 'network_id'
-      @service.should_receive(:resource_post).once.with(
+      service.should_receive(:resource_post).once.with(
           @resource_url, expected_data("<network id=\"#{network_id}\"/>"))
-      @vm.create_nic(@base_options.merge({:network_id => network_id}))
+      vm.create_nic(@base_options.merge({:network_id => network_id}))
     end
 
     it "populates the MAC address" do
       mac_address = 'mac_address'
-      @service.should_receive(:resource_post).once.with(
+      service.should_receive(:resource_post).once.with(
           @resource_url, expected_data("<mac address=\"#{mac_address}\"/>"))
-      @vm.create_nic(@base_options.merge({:mac_address => mac_address}))
+      vm.create_nic(@base_options.merge({:mac_address => mac_address}))
     end
   end
 
@@ -159,10 +131,10 @@ EOX
 </vm>
 EOX
 
-      @service.should_receive(:resource_put).once.with(
-          @vm.attributes[:href],
+      service.should_receive(:resource_put).once.with(
+          vm.attributes[:href],
           expected_data).and_return(return_data)
-      @vm.memory_reserve = memory_reserve
+      vm.memory_reserve = memory_reserve
     end
   end
 
@@ -182,8 +154,8 @@ EOX
         block.call(return_data)
       end
 
-      @service.stub(:create_resource).and_return(rest_client)
-      expect { @vm.stop }.to raise_error Ovirt::VmIsNotRunning
+      service.stub(:create_resource).and_return(rest_client)
+      expect { vm.stop }.to raise_error Ovirt::VmIsNotRunning
     end
   end
 
@@ -222,9 +194,9 @@ EOX
   </memory_policy>
 </vm>
 EOX
-        @service.should_receive(:version).twice.and_return(:major=>"3", :minor=>"0", :build=>"0", :revision=>"0")
-        @service.should_receive(:resource_put).once.with(@vm.attributes[:href], expected_data).and_return(return_data)
-        @vm.detach_floppy
+        service.should_receive(:version).twice.and_return(:major=>"3", :minor=>"0", :build=>"0", :revision=>"0")
+        service.should_receive(:resource_put).once.with(vm.attributes[:href], expected_data).and_return(return_data)
+        vm.detach_floppy
       end
 
       it "Ovirt 3.3 should remove payload" do
@@ -252,10 +224,54 @@ EOX
   </memory_policy>
 </vm>
 EOX
-        @service.should_receive(:version).and_return(:major=>"3", :minor=>"3", :build=>"0", :revision=>"0")
-        @service.should_receive(:resource_put).once.with(@vm.attributes[:href], expected_data).and_return(return_data)
-        @vm.detach_floppy
+        service.should_receive(:version).and_return(:major=>"3", :minor=>"3", :build=>"0", :revision=>"0")
+        service.should_receive(:resource_put).once.with(vm.attributes[:href], expected_data).and_return(return_data)
+        vm.detach_floppy
       end
     end
   end
+
+  it "cloud_init= Ovirt 3.4 and newer" do
+    cloud_config = <<-EOCC.chomp
+#cloud_config
+regenerate_ssh_keys: false
+root_password: some_password
+fqdn: example.example.com
+debug: True
+EOCC
+
+    expected_data = <<-EOX.chomp
+<vm>
+  <initialization>
+    <regenerate_ssh_keys>false</regenerate_ssh_keys>
+    <root_password>some_password</root_password>
+    <custom_script>fqdn: example.example.com\ndebug: true\n</custom_script>
+  </initialization>
+</vm>
+EOX
+
+    return_data = <<-EOX.chomp
+<vm href="/api/vms/128f9ffd-b82c-41e4-8c00-9742ed173bac" id="128f9ffd-b82c-41e4-8c00-9742ed173bac">
+  <name>bd-skeletal-clone-from-template</name>
+  <cpu>
+    <topology sockets="1" cores="1"/>
+  </cpu>
+  <os type="rhel_6x64">
+    <boot dev="hd"/>
+  </os>
+  <placement_policy>
+    <host id="a3abe9ed-fa52-4a7f-8a9b-1eebc782781f"/>
+    <affinity>migratable</affinity>
+  </placement_policy>
+  <memory_policy>
+    <guaranteed>1073741824</guaranteed>
+    <ballooning>true</ballooning>
+  </memory_policy>
+</vm>
+EOX
+
+    expect(service).to receive(:api).and_return(:product_info => {:version => {:major => "3", :minor => "4", :revision => "0", :build => "0"}})
+    expect(service).to receive(:resource_put).once.with(vm.attributes[:href], expected_data).and_return(return_data)
+    vm.cloud_init = cloud_config
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ovirt
 version: !ruby/object:Gem::Version
-  version: 0.4.2
+  version: 0.5.0
 platform: ruby
 authors:
 - Jason Frey
@@ -15,7 +15,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-04-22 00:00:00.000000000 Z
+date: 2015-07-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -31,6 +31,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: factory_girl
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -176,6 +190,7 @@ files:
 - lib/ovirt/host.rb
 - lib/ovirt/host_nic.rb
 - lib/ovirt/inventory.rb
+- lib/ovirt/legacy_support/cloud_init_via_floppy_payload.rb
 - lib/ovirt/network.rb
 - lib/ovirt/nic.rb
 - lib/ovirt/permission.rb
@@ -194,6 +209,9 @@ files:
 - lib/ovirt/vmpool.rb
 - spec/base_spec.rb
 - spec/event_spec.rb
+- spec/factories/service.rb
+- spec/factories/vm.rb
+- spec/legacy_support/cloud_init_via_floppy_payload_spec.rb
 - spec/service_spec.rb
 - spec/spec_helper.rb
 - spec/template_spec.rb
@@ -218,7 +236,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.4.5
 signing_key: 
 specification_version: 4
 summary: Ovirt provides a simple Object Oriented interface to the REST API of oVirt
@@ -226,6 +244,9 @@ summary: Ovirt provides a simple Object Oriented interface to the REST API of oV
 test_files:
 - spec/base_spec.rb
 - spec/event_spec.rb
+- spec/factories/service.rb
+- spec/factories/vm.rb
+- spec/legacy_support/cloud_init_via_floppy_payload_spec.rb
 - spec/service_spec.rb
 - spec/spec_helper.rb
 - spec/template_spec.rb