deltacloud-core 1.0.4 → 1.0.5

data/tests/cimi/collections/machines_test.rb

@@ -5,6 +5,8 @@ require_relative './common.rb'
 
 describe CIMI::Collections::Machines do
 
+  NS = { "c" => "http://schemas.dmtf.org/cimi/1" }
+
   before do
     def app; run_frontend(:cimi) end
     authorize 'mockuser', 'mockpassword'
@@ -33,6 +35,43 @@ describe CIMI::Collections::Machines do
     xml.root.name.must_equal 'Machine'
   end
 
+  describe "$expand" do
+    def machine(*expand)
+      url = '/machines/inst1'
+      url += "?$expand=#{expand.join(",")}" unless expand.empty?
+      get root_url url
+      status.must_equal 200
+    end
+
+    def ids(coll)
+      xml.xpath("/c:Machine/c:#{coll}/c:id", NS)
+    end
+
+    it "should not expand collections when missing" do
+      machine
+      ids(:disks).must_be_empty
+      ids(:volumes).must_be_empty
+    end
+
+    it "should expand named collections" do
+      machine :disks
+      ids(:disks).size.must_equal 1
+      ids(:volumes).must_be_empty
+    end
+
+    it "should expand multiple named collections" do
+      machine :disks, :volumes
+      ids(:disks).size.must_equal 1
+      ids(:volumes).size.must_equal 1
+    end
+
+    it "should expand all collections with *" do
+      machine "*"
+      ids(:disks).size.must_equal 1
+      ids(:volumes).size.must_equal 1
+    end
+  end
+
   it 'should not return non-existing machine' do
     get root_url '/machines/unknown-machine'
     status.must_equal 404

data/tests/cimi/model/collection_spec.rb

@@ -0,0 +1,109 @@
+# Licensed to the Apache Software Foundation (ASF) under one or more
+# contributor license agreements.  See the NOTICE file distributed with
+# this work for additional information regarding copyright ownership.  The
+# ASF licenses this file to you under the Apache License, Version 2.0 (the
+# "License"); you may not use this file except in compliance with the
+# License.  You may obtain a copy of the License at
+#
+#       http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.  See the
+# License for the specific language governing permissions and limitations
+# under the License.
+#
+require 'rubygems'
+require 'require_relative' if RUBY_VERSION < '1.9'
+
+require_relative '../spec_helper.rb' if require 'minitest/autorun'
+
+require 'nokogiri'
+require 'json'
+
+describe "Collection class" do
+
+  BASE_URL = "http://example.com/cimi"
+  COLL_URL = BASE_URL + "/models"
+
+  class Model < CIMI::Model::Base
+    scalar :text
+  end
+
+  class Container < CIMI::Model::Base
+    collection :models, :class => Model
+  end
+
+  before do
+    @models = ["m1", "m2"].map { |s| Model.new(:text => s) }
+    @xml = IO::read(File::join(DATA_DIR, "container.xml"))
+    @json = IO::read(File::join(DATA_DIR, "container.json"))
+  end
+
+  describe "XML serialization" do
+    it "empty collection only has href" do
+      cont = Container.new(:id => BASE_URL)
+      doc = to_dom(cont)
+
+      (doc/"/c:Container/c:models/@href").text.must_equal COLL_URL
+      (doc/"/c:Container/c:models/c:id").size.must_equal 0
+    end
+
+    it "contains count of models" do
+      cont = Container.new(:id => BASE_URL, :models => @models)
+      doc = to_dom(cont)
+
+      (doc/"/c:Container/c:models/c:count").text.must_equal "2"
+      (doc/"/c:Container/c:models/c:Model").size.must_equal 2
+    end
+  end
+
+  describe "JSON serialization" do
+    it "empty collection only has href" do
+      cont = Container.new(:id => BASE_URL)
+      json = to_json(cont)
+
+      json["models"]["href"].must_equal COLL_URL
+      json["models"].keys.must_equal ["href"]
+    end
+
+    it "contains count of models" do
+      cont = Container.new(:id => BASE_URL, :models => @models)
+      json = to_json(cont)
+
+      json["models"]["count"].must_equal 2
+      json["models"]["models"].size.must_equal 2
+    end
+  end
+
+  it "deserializes from XML" do
+    cont = Container.from_xml(@xml)
+    cont.id.must_equal BASE_URL
+    cont.models.count.must_equal "2"
+    cont.models.entries.size.must_equal 2
+    cont.models.entries[0].text.must_equal "m1"
+    cont.models.entries[1].text.must_equal "m2"
+  end
+
+  it "deserializes from JSON" do
+    cont = Container.from_json(@json)
+    cont.id.must_equal BASE_URL
+    # FIXME: This is a very annoying difference between XML and JSON; in XML
+    # all scalars are strings, in JSON, strings that look like integers are
+    # converted to integer objects
+    cont.models.count.must_equal 2
+    cont.models.entries.size.must_equal 2
+    cont.models.entries[0].text.must_equal "m1"
+    cont.models.entries[1].text.must_equal "m2"
+  end
+
+  def to_dom(model)
+    doc = Nokogiri::XML(model.to_xml)
+    doc.root.add_namespace("c", doc.namespaces["xmlns"])
+    doc
+  end
+
+  def to_json(model)
+    JSON.parse(model.to_json)
+  end
+end

data/tests/cimi/{spec/cimi/model → model}/credential_spec.rb

@@ -18,7 +18,7 @@ require 'rubygems'
 require 'require_relative' if RUBY_VERSION < '1.9'
 
 if require 'minitest/autorun'
-  require_relative '../../spec_helper.rb'
+  require_relative '../spec_helper.rb'
 end
 
 describe "Credential model" do

data/tests/cimi/{spec/cimi/model → model}/machine_configuration_spec.rb

@@ -15,7 +15,7 @@
 #
 require 'rubygems'
 require 'require_relative' if RUBY_VERSION < '1.9'
-require_relative '../../spec_helper.rb' if require 'minitest/autorun'
+require_relative '../spec_helper.rb' if require 'minitest/autorun'
 
 describe "MachineConfiguration model" do
 

data/tests/cimi/{spec/cimi/model → model}/machine_image_spec.rb

@@ -16,7 +16,7 @@
 require 'rubygems'
 require 'require_relative' if RUBY_VERSION < '1.9'
 
-require_relative '../../spec_helper.rb' if require 'minitest/autorun'
+require_relative '../spec_helper.rb' if require 'minitest/autorun'
 
 describe "MachineImage model" do
 

data/tests/cimi/{spec/cimi/model → model}/machine_spec.rb

@@ -16,7 +16,7 @@
 require 'rubygems'
 require 'require_relative' if RUBY_VERSION < '1.9'
 
-require_relative '../../spec_helper.rb' if require 'minitest/autorun'
+require_relative '../spec_helper.rb' if require 'minitest/autorun'
 
 describe "Machine model" do
 

data/tests/cimi/{spec/cimi/model → model}/machine_template_spec.rb

@@ -16,7 +16,7 @@
 require 'rubygems'
 require 'require_relative' if RUBY_VERSION < '1.9'
 
-require_relative '../../spec_helper.rb' if require 'minitest/autorun'
+require_relative '../spec_helper.rb' if require 'minitest/autorun'
 
 describe "MachineTemplate model" do
 

data/tests/cimi/{spec/cimi/model → model}/schema_spec.rb

@@ -16,7 +16,7 @@
 require 'rubygems'
 require 'require_relative' if RUBY_VERSION < '1.9'
 
-require_relative '../../spec_helper.rb' if require 'minitest/autorun'
+require_relative '../spec_helper.rb' if require 'minitest/autorun'
 
 describe "Schema" do
   before do

data/tests/cimi/{spec/cimi/model → model}/volume_configuration_spec.rb

@@ -17,7 +17,7 @@
 require 'rubygems'
 require 'require_relative' if RUBY_VERSION < '1.9'
 
-require_relative '../../spec_helper.rb' if require 'minitest/autorun'
+require_relative '../spec_helper.rb' if require 'minitest/autorun'
 
 describe "Volume Configuration model" do
 

data/tests/cimi/{spec/cimi/model → model}/volume_image_spec.rb

@@ -16,7 +16,7 @@
 require 'rubygems'
 require 'require_relative' if RUBY_VERSION < '1.9'
 
-require_relative '../../spec_helper.rb' if require 'minitest/autorun'
+require_relative '../spec_helper.rb' if require 'minitest/autorun'
 
 describe "Volume Image model" do
 

data/tests/cimi/{spec/cimi/model → model}/volume_spec.rb

@@ -16,7 +16,7 @@
 require 'rubygems'
 require 'require_relative' if RUBY_VERSION < '1.9'
 
-require_relative '../../spec_helper.rb' if require 'minitest/autorun'
+require_relative '../spec_helper.rb' if require 'minitest/autorun'
 
 describe "Volume model" do
 

data/tests/cimi/{spec/cimi/model → model}/volume_template_spec.rb

@@ -16,7 +16,7 @@
 require 'rubygems'
 require 'require_relative' if RUBY_VERSION < '1.9'
 
-require_relative '../../spec_helper.rb' if require 'minitest/autorun'
+require_relative '../spec_helper.rb' if require 'minitest/autorun'
 
 describe "Volume Template model" do
 

data/tests/cimi/{spec/spec_helper.rb → spec_helper.rb}

@@ -20,10 +20,10 @@ require 'minitest/spec'
 require 'xmlsimple'
 require 'require_relative' if RUBY_VERSION < '1.9'
 
-require_relative '../../../lib/deltacloud/core_ext.rb'
-require_relative '../../../lib/cimi/models.rb'
+require_relative '../../lib/deltacloud/core_ext.rb'
+require_relative '../../lib/cimi/models.rb'
 
-DATA_DIR = File::join(File::expand_path(File::dirname(__FILE__)), 'cimi', 'data')
+DATA_DIR = File::join(File::expand_path(File::dirname(__FILE__)), 'data')
 
 def parse_xml(xml, opts = {})
   opts[:force_content] = true
@@ -32,6 +32,9 @@ def parse_xml(xml, opts = {})
 end
 
 class HashCmp
+
+  IGNORED_KEYS = [ "resourceURI" ]
+
   def initialize(exp, act)
     @exp = exp
     @act = act
@@ -77,7 +80,7 @@ class HashCmp
       unless (missing = exp.keys - act.keys).empty?
         error "Missing key(s) at /#{path.join("/")}: #{missing.inspect}"
       end
-      unless (excess = act.keys - exp.keys).empty?
+      unless (excess = act.keys - exp.keys - IGNORED_KEYS).empty?
         error "Excess key(s) at /#{path.join("/")}: #{excess.inspect}"
       end
       (exp.keys - missing - excess).each do |k|

data/tests/drivers/base/exceptions_test.rb

@@ -6,7 +6,7 @@ require_relative '../../../lib/deltacloud/drivers/exceptions'
 class TestException < StandardError; end
 
 class ExceptionTestClass
-  include Deltacloud::ExceptionHandler
+  include Deltacloud::Exceptions
 
   def raise_exception(id)
     case id
@@ -30,12 +30,12 @@ end
 
 def raise_error(id); ExceptionTestClass.new.raise_exception(id); end
 
-describe Deltacloud::ExceptionHandler do
+describe Deltacloud::Exceptions do
 
   it 'should capture exception when match the exception message' do
-    lambda { raise_error 1 }.must_raise Deltacloud::ExceptionHandler::BackendError
+    lambda { raise_error 1 }.must_raise Deltacloud::Exceptions::BackendError
 
-    begin raise_error(1); rescue Deltacloud::ExceptionHandler::BackendError => e
+    begin raise_error(1); rescue Deltacloud::Exceptions::BackendError => e
       e.code.must_equal 500
       e.message.must_equal 'Test1ErrorMessage'
       e.backtrace.wont_be_empty
@@ -44,8 +44,8 @@ describe Deltacloud::ExceptionHandler do
   end
 
   it 'should capture exception when match the exception class' do
-    lambda { raise_error 2 }.must_raise Deltacloud::ExceptionHandler::ValidationFailure
-    begin raise_error(2); rescue Deltacloud::ExceptionHandler::ValidationFailure => e
+    lambda { raise_error 2 }.must_raise Deltacloud::Exceptions::ValidationFailure
+    begin raise_error(2); rescue Deltacloud::Exceptions::ValidationFailure => e
       e.code.must_equal 400
       e.message.must_equal 'StandardErrorTest'
       e.backtrace.wont_be_empty
@@ -53,8 +53,8 @@ describe Deltacloud::ExceptionHandler do
   end
 
   it 'should capture exception when no match found' do
-    lambda { raise_error 3 }.must_raise Deltacloud::ExceptionHandler::BackendError
-    begin raise_error(3); rescue Deltacloud::ExceptionHandler::BackendError => e
+    lambda { raise_error 3 }.must_raise Deltacloud::Exceptions::BackendError
+    begin raise_error(3); rescue Deltacloud::Exceptions::BackendError => e
       e.code.must_equal 500
       e.message.must_equal 'Unhandled exception or status code (not captured)'
       e.backtrace.wont_be_empty

data/tests/drivers/ec2/buckets_test.rb

@@ -24,7 +24,7 @@ describe 'Ec2Driver Buckets' do
   it 'must throw error when wrong credentials for buckets' do
     Proc.new do
       @driver.backend.buckets(OpenStruct.new(:user => 'unknown', :password => 'wrong'))
-    end.must_raise Deltacloud::ExceptionHandler::AuthenticationFailure, 'Authentication Failure'
+    end.must_raise Deltacloud::Exceptions::AuthenticationFailure, 'Authentication Failure'
   end
 
 

data/tests/drivers/ec2/images_test.rb

@@ -17,7 +17,7 @@ describe 'Ec2Driver Images' do
   it 'must throw error when wrong credentials' do
     Proc.new do
       @driver.backend.images(OpenStruct.new(:user => 'unknown', :password => 'wrong'))
-    end.must_raise Deltacloud::ExceptionHandler::AuthenticationFailure, 'Authentication Failure'
+    end.must_raise Deltacloud::Exceptions::AuthenticationFailure, 'Authentication Failure'
   end
 
   it 'must return list of images' do

data/tests/drivers/ec2/instance_test.rb

@@ -17,7 +17,7 @@ describe 'Ec2Driver Instances' do
   it 'must throw error when wrong credentials' do
     Proc.new do
       @driver.backend.images(OpenStruct.new(:user => 'unknown', :password => 'wrong'))
-    end.must_raise Deltacloud::ExceptionHandler::AuthenticationFailure, 'Authentication Failure'
+    end.must_raise Deltacloud::Exceptions::AuthenticationFailure, 'Authentication Failure'
   end
 
   it 'must return list of instances' do

data/tests/drivers/ec2/keys_test.rb

@@ -17,7 +17,7 @@ describe 'Ec2Driver Keys' do
   it 'must throw error when wrong credentials' do
     Proc.new do
       @driver.backend.images(OpenStruct.new(:user => 'unknown', :password => 'wrong'))
-    end.must_raise Deltacloud::ExceptionHandler::AuthenticationFailure, 'Authentication Failure'
+    end.must_raise Deltacloud::Exceptions::AuthenticationFailure, 'Authentication Failure'
   end
 
   it 'must return list of keys' do
@@ -44,7 +44,7 @@ describe 'Ec2Driver Keys' do
     key = @driver.create_key(:key_name => 'test-key-1')
     key.wont_be_nil
     key.must_be_kind_of Key
-    Proc.new { @driver.create_key(:key_name => 'test-key-1') }.must_raise Deltacloud::ExceptionHandler::ProviderError, 'KeyExist'
+    Proc.new { @driver.create_key(:key_name => 'test-key-1') }.must_raise Deltacloud::Exceptions::ProviderError, 'KeyExist'
     @driver.destroy_key :id => key.id
     @driver.key(:id => key.id).must_be_nil
   end

data/tests/drivers/ec2/realms_test.rb

@@ -17,7 +17,7 @@ describe 'Ec2Driver Realms' do
   it 'must throw error when wrong credentials' do
     Proc.new do
       @driver.backend.realms(OpenStruct.new(:user => 'unknown', :password => 'wrong'))
-    end.must_raise Deltacloud::ExceptionHandler::AuthenticationFailure, 'Authentication Failure'
+    end.must_raise Deltacloud::Exceptions::AuthenticationFailure, 'Authentication Failure'
   end
 
   it 'must return list of realms' do

data/tests/drivers/ec2/storage_snapshots_test.rb

@@ -16,7 +16,7 @@ describe 'Ec2Driver StorageSnapshots' do
   it 'must throw error when wrong credentials' do
     Proc.new do
       @driver.backend.images(OpenStruct.new(:user => 'unknown', :password => 'wrong'))
-    end.must_raise Deltacloud::ExceptionHandler::AuthenticationFailure, 'Authentication Failure'
+    end.must_raise Deltacloud::Exceptions::AuthenticationFailure, 'Authentication Failure'
   end
 
   it 'must return list of storage snapshots' do

data/tests/drivers/gogrid/hardware_profiles_test.rb

@@ -17,7 +17,7 @@ describe 'GoGrid Hardware Profiles' do
   it 'must throw error when wrong credentials' do
     Proc.new do
       @driver.backend.realms(OpenStruct.new(:user => 'unknown', :password => 'wrong'))
-    end.must_raise Deltacloud::ExceptionHandler::AuthenticationFailure, 'Authentication Failure'
+    end.must_raise Deltacloud::Exceptions::AuthenticationFailure, 'Authentication Failure'
   end
 
   it 'must return list of hardware profiles' do

data/tests/drivers/gogrid/images_test.rb

@@ -17,7 +17,7 @@ describe 'GoGridDriver Images' do
   it 'must throw error when wrong credentials' do
     Proc.new do
       @driver.backend.images(OpenStruct.new(:user => 'unknown', :password => 'wrong'))
-    end.must_raise Deltacloud::ExceptionHandler::AuthenticationFailure, 'Authentication Failure'
+    end.must_raise Deltacloud::Exceptions::AuthenticationFailure, 'Authentication Failure'
   end
 
   it 'must return list of images' do

data/tests/drivers/gogrid/instances_test.rb

@@ -58,7 +58,7 @@ describe 'GoGridDriver Instances' do
   it 'must throw error when wrong credentials' do
     Proc.new do
       @driver.backend.images(OpenStruct.new(:user => 'unknown', :password => 'wrong'))
-    end.must_raise Deltacloud::ExceptionHandler::AuthenticationFailure, 'Authentication Failure'
+    end.must_raise Deltacloud::Exceptions::AuthenticationFailure, 'Authentication Failure'
   end
 
   it 'must return list of instances' do

data/tests/drivers/gogrid/realms_test.rb

@@ -17,7 +17,7 @@ describe 'GoGridDriver Realms' do
   it 'must throw error when wrong credentials' do
     Proc.new do
       @driver.backend.realms(OpenStruct.new(:user => 'unknown', :password => 'wrong'))
-    end.must_raise Deltacloud::ExceptionHandler::AuthenticationFailure, 'Authentication Failure'
+    end.must_raise Deltacloud::Exceptions::AuthenticationFailure, 'Authentication Failure'
   end
 
   it 'must return list of realms' do