rbovirt 0.0.15 → 0.0.16

data/Rakefile

@@ -15,7 +15,7 @@ require 'jeweler'
 Jeweler::Tasks.new do |gem|
   # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
   gem.name = "rbovirt"
-  gem.homepage = "http://github.com/rbovirt/rbovirt"
+  gem.homepage = "http://github.com/abenari/rbovirt"
   gem.license = "MIT"
   gem.summary = %Q{A Ruby client for oVirt REST API}
   gem.description = %Q{A Ruby client for oVirt REST API}

data/VERSION

@@ -1 +1 @@
-0.0.15
+0.0.16

data/lib/client/cluster_api.rb

@@ -12,11 +12,12 @@ module OVIRT
 
     def clusters(opts={})
       headers = {:accept => "application/xml; detail=datacenters"}
-      search= opts[:search] || ("datacenter=%s" % current_datacenter.name)
-      http_get("/clusters?search=%s" % CGI.escape(search), headers).xpath('/clusters/cluster').collect do |cl|
+      path = "/clusters"
+      path += search_url(opts) unless filtered_api
+      http_get(path, headers).xpath('/clusters/cluster').collect do |cl|
         cluster = OVIRT::Cluster.new(self, cl)
         #the following line is needed as a work-around a bug in RHEV 3.0 rest-api
-        cluster if cluster.datacenter.id == current_datacenter.id
+        cluster if !filtered_api || (cluster.datacenter.id == current_datacenter.id)
       end.compact
     end
 

data/lib/client/host_api.rb

@@ -6,8 +6,9 @@ module OVIRT
     end
 
     def hosts(opts={})
-      search= opts[:search] || ("datacenter=%s" % current_datacenter.name)
-      http_get("/hosts?search=%s" % CGI.escape(search)).xpath('/hosts/host').collect do |h|
+      path = "/hosts"
+      path += search_url(opts) unless filtered_api
+      http_get(path).xpath('/hosts/host').collect do |h|
         OVIRT::Host::new(self, h)
       end
     end

data/lib/client/storage_domain_api.rb

@@ -6,12 +6,13 @@ module OVIRT
     end
 
     def storagedomains(opts={})
-      search= opts[:search] || ("datacenter=%s" % current_datacenter.name)
-      http_get("/storagedomains?search=%s" % CGI.escape(search)).xpath('/storage_domains/storage_domain').collect do |sd|
+      path = "/storagedomains"
+      path += search_url(opts) unless filtered_api
+      http_get(path).xpath('/storage_domains/storage_domain').collect do |sd|
         storage_domain = OVIRT::StorageDomain::new(self, sd)
         #filter by role is not supported by the search language. The work around is to list all, then filter.
         (opts[:role].nil? || storage_domain.role == opts[:role]) ? storage_domain : nil
       end.compact
     end
   end
-end
+end

data/lib/client/template_api.rb

@@ -1,8 +1,9 @@
 module OVIRT
   class Client
     def templates(opts={})
-      search= opts[:search] || ("datacenter=%s" % current_datacenter.name)
-      http_get("/templates?search=%s" % CGI.escape(search)).xpath('/templates/template').collect do |t|
+      path = "/templates"
+      path += search_url(opts) unless filtered_api
+      http_get(path).xpath('/templates/template').collect do |t|
         OVIRT::Template::new(self, t)
       end.compact
     end
@@ -34,4 +35,4 @@ module OVIRT
       end
     end
   end
-end
+end

data/lib/client/vm_api.rb

@@ -7,8 +7,9 @@ module OVIRT
 
     def vms(opts={})
       headers = {:accept => "application/xml; detail=disks; detail=nics; detail=hosts"}
-      search= opts[:search] || ("datacenter=%s" % current_datacenter.name)
-      http_get("/vms?search=%s" % CGI.escape(search), headers).xpath('/vms/vm').collect do |vm|
+      path = "/vms"
+      path += search_url(opts) unless filtered_api
+      http_get(path, headers).xpath('/vms/vm').collect do |vm|
         OVIRT::VM::new(self, vm)
       end
     end

data/lib/ovirt/host.rb

@@ -1,6 +1,6 @@
 module OVIRT
- class Host < BaseObject
-    attr_reader :description, :status, :cluster
+  class Host < BaseObject
+    attr_reader :description, :status, :cluster, :address
 
     def initialize(client, xml)
       super(client, xml[:id], xml[:href], (xml/'name').first.text)
@@ -12,8 +12,9 @@ module OVIRT
 
     def parse_xml_attributes!(xml)
       @description = ((xml/'description').first.text rescue nil)
+      @address = ((xml/'address').first.text rescue nil)
       @status = (xml/'status').first.text
-      @clister = Link::new(@client, (xml/'cluster').first[:id], (xml/'cluster').first[:href])
+      @cluster = Link::new(@client, (xml/'cluster').first[:id], (xml/'cluster').first[:href])
     end
   end
 end

data/lib/ovirt/vm.rb

@@ -23,7 +23,7 @@ module OVIRT
       return false unless @status =~ /down/i
       volumes.each do |volume|
         return false if volume.status =~ /locked/i
-      end if @client.api_version?("3","1")
+      end if @client.api_version?("3","1") || @client.api_version?("3","2")
       true
     end
 

data/lib/rbovirt.rb

@@ -35,13 +35,14 @@ module OVIRT
 
   class Client
 
-    attr_reader :credentials, :api_entrypoint, :datacenter_id, :cluster_id
+    attr_reader :credentials, :api_entrypoint, :datacenter_id, :cluster_id, :filtered_api
 
-    def initialize(username, password, api_entrypoint, datacenter_id=nil, cluster_id=nil)
+    def initialize(username, password, api_entrypoint, datacenter_id=nil, cluster_id=nil, filtered_api = false)
       @credentials = { :username => username, :password => password }
       @datacenter_id = datacenter_id
       @cluster_id = cluster_id
       @api_entrypoint = api_entrypoint
+      @filtered_api = filtered_api
     end
 
     def api_version
@@ -60,6 +61,11 @@ module OVIRT
     end
 
     private
+    def search_url opts
+      search = opts[:search] || ("datacenter=%s" % current_datacenter.name)
+      "?search=%s" % CGI.escape(search)
+    end
+
     def current_datacenter
       @current_datacenter ||= self.datacenter_id ? datacenter(self.datacenter_id) : datacenters.first
     end
@@ -94,7 +100,7 @@ module OVIRT
 
     def http_delete(suburl)
       begin
-        headers = {:accept => 'application/xml'}.merge(auth_header)
+        headers = {:accept => 'application/xml'}.merge(auth_header).merge(filter_header)
         Nokogiri::XML(RestClient::Resource.new(@api_entrypoint)[suburl].delete(headers))
       rescue
         handle_fault $!
@@ -107,6 +113,10 @@ module OVIRT
       { :authorization => "Basic " + encoded_credentials }
     end
 
+    def filter_header
+      filtered_api ? { :filter => "true" } : {}
+    end
+
     def base_url
       url = URI.parse(@api_entrypoint)
       "#{url.scheme}://#{url.host}:#{url.port}"
@@ -117,15 +127,14 @@ module OVIRT
     end
 
     def has_datacenter?(vm)
-      value=!(vm/'data_center').empty?
-      value
+      (vm/'data_center').any?
     end
 
     def http_headers(headers ={})
       headers.merge({
         :content_type => 'application/xml',
-        :accept => 'application/xml'
-      }).merge(auth_header)
+        :accept => 'application/xml',
+      }).merge(auth_header).merge(filter_header)
     end
 
     def handle_fault(f)

data/rbovirt.gemspec

@@ -5,7 +5,7 @@
 
 Gem::Specification.new do |s|
   s.name = "rbovirt"
-  s.version = "0.0.15"
+  s.version = "0.0.16"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Amos Benari"]
@@ -48,7 +48,7 @@ Gem::Specification.new do |s|
     "spec/spec_helper.rb",
     "spec/unit/vm_spec.rb"
   ]
-  s.homepage = "http://github.com/rbovirt/rbovirt"
+  s.homepage = "http://github.com/abenari/rbovirt"
   s.licenses = ["MIT"]
   s.require_paths = ["lib"]
   s.rubygems_version = "1.8.24"

data/spec/integration/api_spec.rb

@@ -1,6 +1,6 @@
 require "#{File.dirname(__FILE__)}/../spec_helper"
 
-describe OVIRT, "API" do
+shared_examples_for "API" do
 
   # This spec requires the API to be stable, so that projects using
   # OVIRT do not have to update their code if a new (minor)
@@ -13,38 +13,69 @@ describe OVIRT, "API" do
   # Because of the API stability guarantee, these spec's may only
   # be changed for new major releases.
 
+  it "test_should_return_a_version" do
+    @client.api_version.class.should eql(String)
+  end
+
+  it "test_should_return_datacenters" do
+    @client.datacenters.class.should eql(Array)
+  end
+
+  it "test_should_return_clusters" do
+    @client.clusters.class.should eql(Array)
+  end
+
+  it "test_should_return_templates" do
+    @client.templates.class.should eql(Array)
+  end
+
+  it "test_should_return_vms" do
+    @client.vms.class.should eql(Array)
+  end
+
+  it "test_should_return_storage" do
+    @client.storagedomains.class.should eql(Array)
+  end
+end
+
+describe OVIRT, "Admin API" do
+
   before(:all) do
     user, password, url = endpoint
-    @client = ::OVIRT::Client.new(user, password, url)
+    @client = ::OVIRT::Client.new(user, password, url, nil, nil, false)
   end
 
   after(:all) do
   end
 
-  context 'basic api and listing' do
-    it "test_should_return_a_version" do
-      @client.api_version.class.should eql(String)
-    end
+  context 'basic admin api and listing' do
+    it_behaves_like "API"
 
-    it "test_should_return_datacenters" do
-      @client.datacenters.class.should eql(Array)
+    it "test_should_return_hosts" do
+      @client.hosts.class.should eql(Array)
     end
+  end
 
-    it "test_should_return_clusters" do
-      @client.clusters.class.should eql(Array)
-    end
+end
 
-    it "test_should_return_templates" do
-      @client.templates.class.should eql(Array)
-    end
+describe OVIRT, "User API" do
 
-    it "test_should_return_vms" do
-      @client.vms.class.should eql(Array)
-    end
-    it "test_should_return_storage" do
-      @client.storagedomains.class.should eql(Array)
-    end
+  before(:all) do
+    user, password, url = endpoint
+    @client = ::OVIRT::Client.new(user, password, url, nil, nil, support_user_level_api)
+  end
 
+  after(:all) do
   end
 
-end
+  context 'basic user api and listing' do
+    it_behaves_like "API"
+    #User level API doesn't support returning hosts
+    it "test_should_not_return_hosts" do
+      if support_user_level_api
+        expect {@client.hosts}.to raise_error
+      end
+    end
+  end
+
+end

data/spec/integration/vm_crud_spec.rb

@@ -1,73 +1,93 @@
 require "#{File.dirname(__FILE__)}/../spec_helper"
 
-describe "VM Life cycle" do
+shared_examples_for "Basic VM Life cycle" do
 
   before(:all) do
-    user, password, url = endpoint
-    @client = ::OVIRT::Client.new(user, password, url)
+    @blank_template_id =  "00000000-0000-0000-0000-000000000000"
+    @cluster = @client.clusters.first.id
+    name = 'vm-'+Time.now.to_i.to_s
+    @vm = @client.create_vm(:name => name, :template => @blank_template_id, :cluster => @cluster)
+    @client.add_volume(@vm.id)
+    @client.add_interface(@vm.id)
+    while !@client.vm(@vm.id).ready? do
+    end
   end
 
-  context 'basic vm and templates operations' do
+  after(:all) do
+    @client.destroy_vm(@vm.id)
+  end
 
-    before(:all) do
-      name = 'vm-'+Time.now.to_i.to_s
-      @vm = @client.create_vm(:name => name)
-      @client.add_volume(@vm.id)
-      @client.add_interface(@vm.id)
-      while !@client.vm(@vm.id).ready? do
-      end
+  it "test_should_create_template" do
+    template_name = "tmplt-"+Time.now.to_i.to_s
+    template = @client.create_template(:vm => @vm.id, :name => template_name, :description => "test_template")
+    template.class.to_s.should eql("OVIRT::Template")
+    while !@client.vm(@vm.id).ready? do
     end
+    @client.destroy_template(template.id)
+  end
 
-    after(:all) do
-      @client.destroy_vm(@vm.id)
-    end
+  it "test_should_return_a_template" do
+    @client.template(@blank_template_id).id.should eql(@blank_template_id)
+  end
 
-    it "test_should_create_template" do
-      template_name = "tmplt-"+Time.now.to_i.to_s
-      template = @client.create_template(:vm => @vm.id, :name => template_name, :description => "test_template")
-      template.class.to_s.should eql("OVIRT::Template")
-      while !@client.vm(@vm.id).ready? do
-      end
-      @client.destroy_template(template.id)
-    end
+  it "test_should_return_a_vm" do
+    @client.vm(@vm.id).id.should eql(@vm.id)
+  end
 
-    it "test_should_return_a_template" do
-      @client.template(@blank_template_id).id.should eql(@blank_template_id)
+  it "test_should_start_and_stop_vm" do
+    @client.vm_action(@vm.id, :start)
+    while !@client.vm(@vm.id).running? do
     end
+    @client.vm_action(@vm.id, :shutdown)
+  end
 
-    it "test_should_return_a_vm" do
-      @client.vm(@vm.id).id.should eql(@vm.id)
+  it "test_should_set_vm_ticket" do
+    @client.vm_action(@vm.id, :start)
+    while !@client.vm(@vm.id).running? do
     end
+    @client.set_ticket(@vm.id)
+    @client.vm_action(@vm.id, :shutdown)
+  end
 
-    it "test_should_start_and_stop_vm" do
-      @client.vm_action(@vm.id, :start)
-      @client.vm_action(@vm.id, :shutdown)
-    end
+  it "test_should_destroy_vm" do
+    name = 'd-'+Time.now.to_i.to_s
+    vm = @client.create_vm(:name => name, :template =>@blank_template_id, :cluster => @cluster)
+    @client.destroy_vm(vm.id)
+  end
 
-    it "test_should_set_vm_ticket" do
-      @client.vm_action(@vm.id, :start)
-      while !@client.vm(@vm.id).running? do
-      end
-      @client.set_ticket(@vm.id)
-      @client.vm_action(@vm.id, :shutdown)
-    end
+  it "test_should_update_vm" do
+    name = 'u-'+Time.now.to_i.to_s
+    @client.update_vm(:id => @vm.id, :name=> name, :cluster => @cluster)
+  end
 
-    it "test_should_destroy_vm" do
-      name = 'd-'+Time.now.to_i.to_s
-      vm = @client.create_vm(:name => name)
-      @client.destroy_vm(vm.id)
-    end
+  it "test_should_create_a_vm" do
+    name = 'c-'+Time.now.to_i.to_s
+    vm = @client.create_vm(:name => name, :template => @blank_template_id, :cluster => @cluster)
+    vm.class.to_s.should eql("OVIRT::VM")
+    @client.destroy_vm(vm.id)
+  end
+end
 
-    it "test_should_update_vm" do
-      name = 'u-'+Time.now.to_i.to_s
-      @client.update_vm(:id => @vm.id, :name=> name)
-    end
+describe "Admin API VM Life cycle" do
 
-    it "test_should_create_a_vm" do
-      name = 'c-'+Time.now.to_i.to_s
-      vm = @client.create_vm(:name => name)
-      vm.class.to_s.should eql("OVIRT::VM")
-      @client.destroy_vm(vm.id)
-    end
+  before(:all) do
+    user, password, url = endpoint
+    @client = ::OVIRT::Client.new(user, password, url, nil, nil, false)
+  end
+
+  context 'admin basic vm and templates operations' do
+    it_behaves_like "Basic VM Life cycle"
+  end
+end
+
+describe "User API VM Life cycle" do
+
+  before(:all) do
+    user, password, url = endpoint
+    @client = ::OVIRT::Client.new(user, password, url, nil, nil, support_user_level_api)
+  end
+
+  context 'user basic vm and templates operations' do
+    it_behaves_like "Basic VM Life cycle"
   end
 end

data/spec/lib/endpoint.rb

@@ -1,8 +1,8 @@
 module OVIRT::RSpec::Endpoint
 
- def endpoint
-   file = File.expand_path("../endpoint.yml", File.dirname(__FILE__))
-   @endpoint ||= YAML.load(File.read(file))
+  def endpoint
+    file = File.expand_path("../endpoint.yml", File.dirname(__FILE__))
+    @endpoint ||= YAML.load(File.read(file))
     user = @endpoint['user']
     password= @endpoint['password']
     hostname = @endpoint['hostname']
@@ -11,4 +11,8 @@ module OVIRT::RSpec::Endpoint
     return user, password, url
   end
 
+  def support_user_level_api
+    @endpoint['version'] && @endpoint['version'] > 3.1
+  end
+
 end

metadata

@@ -1,135 +1,136 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: rbovirt
-version: !ruby/object:Gem::Version 
-  hash: 1
+version: !ruby/object:Gem::Version
+  version: 0.0.16
   prerelease: 
-  segments: 
-  - 0
-  - 0
-  - 15
-  version: 0.0.15
 platform: ruby
-authors: 
+authors:
 - Amos Benari
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2012-11-11 00:00:00 Z
-dependencies: 
-- !ruby/object:Gem::Dependency 
-  type: :runtime
-  requirement: &id001 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
-  version_requirements: *id001
+date: 2012-11-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
   name: nokogiri
-  prerelease: false
-- !ruby/object:Gem::Dependency 
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :runtime
-  requirement: &id002 !ruby/object:Gem::Requirement 
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
-  version_requirements: *id002
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
   name: rest-client
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
   prerelease: false
-- !ruby/object:Gem::Dependency 
-  type: :development
-  requirement: &id003 !ruby/object:Gem::Requirement 
+  version_requirements: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
-  version_requirements: *id003
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
   name: shoulda
-  prerelease: false
-- !ruby/object:Gem::Dependency 
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
-  requirement: &id004 !ruby/object:Gem::Requirement 
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 23
-        segments: 
-        - 1
-        - 0
-        - 0
+      - !ruby/object:Gem::Version
         version: 1.0.0
-  version_requirements: *id004
-  name: bundler
-  prerelease: false
-- !ruby/object:Gem::Dependency 
   type: :development
-  requirement: &id005 !ruby/object:Gem::Requirement 
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 7
-        segments: 
-        - 1
-        - 6
-        - 4
-        version: 1.6.4
-  version_requirements: *id005
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+- !ruby/object:Gem::Dependency
   name: jeweler
-  prerelease: false
-- !ruby/object:Gem::Dependency 
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.6.4
   type: :development
-  requirement: &id006 !ruby/object:Gem::Requirement 
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
-  version_requirements: *id006
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.6.4
+- !ruby/object:Gem::Dependency
   name: rcov
-  prerelease: false
-- !ruby/object:Gem::Dependency 
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
-  requirement: &id007 !ruby/object:Gem::Requirement 
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 15
-        segments: 
-        - 2
-        - 6
-        version: "2.6"
-  version_requirements: *id007
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
   name: rspec-rails
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.6'
+  type: :development
   prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.6'
 description: A Ruby client for oVirt REST API
 email: abenari@redhat.com
 executables: []
-
 extensions: []
-
-extra_rdoc_files: 
+extra_rdoc_files:
 - LICENSE.txt
 - README.rdoc
-files: 
+files:
 - .document
 - Gemfile
 - LICENSE.txt
@@ -160,38 +161,29 @@ files:
 - spec/lib/endpoint.rb
 - spec/spec_helper.rb
 - spec/unit/vm_spec.rb
-homepage: http://github.com/rbovirt/rbovirt
-licenses: 
+homepage: http://github.com/abenari/rbovirt
+licenses:
 - MIT
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
+required_ruby_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: 
-rubygems_version: 1.8.24
+rubygems_version: 1.8.23
 signing_key: 
 specification_version: 3
 summary: A Ruby client for oVirt REST API
 test_files: []
-