deltacloud-core 0.1.2 → 0.3.0

data/tests/common.rb

@@ -0,0 +1,172 @@
+# 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.
+#
+
+$:.unshift File.join(File.dirname(__FILE__), '..')
+
+require 'rubygems'
+require 'yaml'
+require 'test/unit'
+require 'spec'
+require 'nokogiri'
+require 'json'
+require 'digest/sha1'
+require 'base64'
+require 'rack/test'
+require 'server'
+
+driver
+
+# Set proper environment variables for running test
+
+ENV['RACK_ENV']     = 'test'
+ENV['API_HOST']     = 'localhost'
+ENV['API_PORT']     = '4040'
+
+configure :test do
+  set :environment, :test
+  set :raise_errors, false
+  set :show_exceptions, false
+end
+
+Spec::Runner.configure do |conf|
+  conf.include Rack::Test::Methods
+end
+
+module DeltacloudTestCommon
+
+  def recording?
+    @use_recording
+  end
+
+  def record!
+    @use_recording = true
+  end
+
+
+  # Authentication helper for Basic HTTP authentication
+  # To change default user credentials stored in ENV['API_USER|PASSWORD'] you
+  # need to set opts[:credentials] = { :user => '...', :password => '...'}
+  #
+  def authenticate(opts={})
+    credentials = opts[:credentials] || { :user => ENV['API_USER'], :password => ENV['API_PASSWORD']}
+    return {
+      'HTTP_AUTHORIZATION' => "Basic " + Base64.encode64("#{credentials[:user]}:#{credentials[:password]}")
+    }
+  end
+
+  # HTTP Accept header helper.
+  # Will set appropriate value for this header.
+  # Available options for format are: :json, :html or :xml
+  # By default :xml is used
+  #
+  def accept(format=:xml)
+    case format
+      when :json then 'application/json;q=0.9'
+      when :html then 'text/html;q=0.9'
+      when :xml then 'application/xml;q=0.9'
+      else 'application/xml;q=0.9'
+    end
+  end
+
+  # This helper will execute GET operation on given URI.
+  # You can set additional parameters using params Hash, which will be passed to
+  # request.
+  # You can change format used for communication using opts[:format] = :xml | :html :json
+  # You can turn on recording (you need to configure it first in setup.rb) using
+  # opts[:record] (true/false)
+  # You can force authentication using opts[:auth] parameter or use
+  # 'get_auth_url' which will do it for you ;-)
+  #
+  def get_url(uri, params={}, opts={})
+    header 'Accept', accept(opts[:format] || :xml)
+    if DeltacloudTestCommon::recording?
+      VCR.use_cassette("get-" + Digest::SHA1.hexdigest("#{uri}-#{params}}")) do
+        get(uri, params || {}, opts[:auth] ? authenticate(opts) : {})
+      end
+    else
+      get(uri, params || {}, opts[:auth] ? authenticate(opts) : {})
+    end
+    last_response.status.should_not == 401
+  end
+
+  def get_auth_url(uri, params={}, opts={})
+    opts.merge!(:auth => true)
+    get_url(uri, params, opts)
+  end
+
+  def post_url(uri, params={}, opts={})
+    header 'Accept', accept(opts[:format] || :xml)
+    if DeltacloudTestCommon::recording?
+      VCR.use_cassette("post-" + Digest::SHA1.hexdigest("#{uri}-#{params}")) do
+        post(uri, params || {}, authenticate(opts))
+      end
+    else
+        post(uri, params || {}, authenticate(opts))
+    end
+  end
+
+  def delete_url(uri, params={}, opts={})
+    header 'Accept', accept(opts[:format] || :xml)
+    if DeltacloudTestCommon::recording?
+      VCR.use_cassette("delete-"+Digest::SHA1.hexdigest("#{uri}-#{params}")) do
+        delete(uri, params || {}, authenticate(opts))
+      end
+    else
+        delete(uri, params || {}, authenticate(opts))
+    end
+  end
+
+  def put_url(uri, params={}, opts={})
+    header 'Accept', accept(opts[:format] || :xml)
+    if DeltacloudTestCommon::recording?
+      VCR.use_cassette("put-"+Digest::SHA1.hexdigest("#{uri}-#{params}-#{authenticate(opts)}")) do
+        put(uri, params || {}, authenticate(opts))
+      end
+    else
+        put(uri, params || {}, authenticate(opts))
+    end
+  end
+
+  # This helper will automatically convert output from method above to Nokogiri
+  # XML object
+  def last_xml_response
+    Nokogiri::XML(last_response.body) #if last_response.status.to_s =~ /2(\d+)/
+  end
+
+  # Check if given URI require authentication
+  def require_authentication?(uri)
+    get uri, {}
+    true if last_response.status == 401
+  end
+
+  def with_provider(new_provider, &block)
+    old_provider = ENV["API_PROVIDER"]
+    begin
+      ENV["API_PROVIDER"] = new_provider
+      yield
+    ensure
+      ENV["API_PROVIDER"] = old_provider
+    end
+  end
+
+  def add_created_instance(id)
+    $created_instances ||= []
+    $created_instances << id
+  end
+
+end
+
+include DeltacloudTestCommon

data/tests/drivers/mock/api_test.rb

@@ -0,0 +1,133 @@
+# 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.
+#
+
+$:.unshift File.join(File.dirname(__FILE__), '..', '..', '..')
+require 'tests/common'
+
+module DeltacloudUnitTest
+  class ApiTest < Test::Unit::TestCase
+    include Rack::Test::Methods
+
+    def app
+      Sinatra::Application
+    end
+
+    def test_it_returns_entry_points
+      get_auth_url '/api'
+      (last_xml_response/'/api/link').length.should > 0
+    end
+
+    def test_it_has_correct_attributes_set
+      get_auth_url '/api'
+      (last_xml_response/'/api/link').each do |link|
+        link.attributes.keys.sort.should == [ 'href', 'rel' ]
+      end
+    end
+
+    def test_it_responses_to_html
+      get_url '/api', {}, { :format => :html }
+      last_response.status.should == 200
+      Nokogiri::HTML(last_response.body).search('html').first.name.should == 'html'
+    end
+
+    def test_it_responses_to_json
+      get_url '/api', {}, { :format => :json }
+      last_response.status.should == 200
+      JSON::parse(last_response.body).class.should == Hash
+      JSON::parse(last_response.body)['api'].class.should == Hash
+    end
+
+    def test_it_switches_drivers
+      with_provider("") do
+        get_auth_url '/api'
+        (last_xml_response/"api/link[rel = 'instances']").first.should_not == nil
+      end
+
+      # Switch to storage-only mock driver
+      with_provider("storage") do
+        get_auth_url '/api'
+        (last_xml_response/"api/link[rel = 'instances']").first.should == nil
+      end
+    end
+
+    def test_it_handles_unsupported_collections
+      get_auth_url '/api/no_such_collection'
+      last_response.status.should == 404
+
+      with_provider("storage") do
+        get_auth_url '/api/instances'
+        last_response.status.should == 404
+      end
+    end
+
+    def test_it_allows_accessing_docs
+      get_url '/api/docs/instances'
+      last_response.status.should == 200
+
+      with_provider("storage") do
+        get_url '/api/docs/instances'
+        last_response.status.should == 404
+      end
+    end
+
+    def test_it_respond_to_head
+      head '/api/instances'
+      last_response.headers['Allow'].should_not == nil
+      last_response.headers['Allow'].split(',').include?('HEAD').should == true
+    end
+
+    def test_it_expose_available_drivers
+      get_auth_url '/api/drivers'
+      last_response.status.should == 200
+      (last_xml_response/"drivers").length.should > 0
+      (last_xml_response/'drivers/driver').length.should > 0
+      (last_xml_response/"drivers/driver[@id = 'mock']").length.should == 1
+    end
+
+    def test_it_expose_ec2_driver_entrypoints
+      get_auth_url '/api/drivers'
+      last_response.status.should == 200
+      ec2 = (last_xml_response/'drivers/driver[@id=ec2]').first
+      (ec2/"provider").length.should > 0
+      (ec2/"provider[@id = 'eu-west-1']").length.should == 1
+      get_auth_url ec2[:href]
+      eu_west = (last_xml_response/"provider[@id = 'eu-west-1']").first
+      (eu_west/"entrypoint").length.should > 0
+      (eu_west/"entrypoint[@kind = 'ec2']").length.should == 1
+    end
+
+    def test_it_supports_matrix_params
+      get_auth_url "/api;driver=ec2"
+      last_response.status.should == 200
+      (last_xml_response/'api').first[:driver].should == 'ec2'
+      get_auth_url "/api;driver=mock"
+      (last_xml_response/'api').first[:driver].should == 'mock'
+      get_auth_url "/api;driver=ec2/hardware_profiles"
+      (last_xml_response/'hardware_profiles/hardware_profile/@id').map {|n| n.to_s}.include?('m1.small').should == true
+      last_response.status.should == 200
+    end
+
+    def test_it_change_features_after_driver_change
+      get_auth_url "/api;driver=ec2"
+      (last_xml_response/'api/link[@rel="instances"]/feature[@name="user_name"]').first.should == nil
+      (last_xml_response/'api/link[@rel="instances"]/feature[@name="user_data"]').first.should_not == nil
+      get_auth_url "/api;driver=mock"
+      (last_xml_response/'api/link[@rel="instances"]/feature[@name="user_name"]').first.should_not == nil
+      (last_xml_response/'api/link[@rel="instances"]/feature[@name="user_data"]').first.should == nil
+    end
+
+  end
+end

data/tests/drivers/mock/hardware_profiles_test.rb

@@ -0,0 +1,134 @@
+# 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.
+#
+
+$:.unshift File.join(File.dirname(__FILE__), '..', '..', '..')
+require 'tests/common'
+
+module DeltacloudUnitTest
+  class HardwareProfilesTest < Test::Unit::TestCase
+    include Rack::Test::Methods
+
+    def app
+      Sinatra::Application
+    end
+
+    def test_it_returns_hardware_profiles
+      get_url '/api/hardware_profiles'
+      (last_xml_response/'hardware_profiles/hardware_profile').length.should > 0
+    end
+
+    def test_it_has_correct_attributes_set
+      get_auth_url '/api/hardware_profiles'
+      (last_xml_response/'hardware_profiles/hardware_profile').each do |profile|
+        profile.attributes.keys.sort.should == [ 'href', 'id' ]
+      end
+    end
+
+    def test_hardware_profiles_have_name
+      get_auth_url '/api/hardware_profiles'
+      (last_xml_response/'hardware_profiles/hardware_profile').each do |profile|
+        (profile/'name').text.should_not == nil
+      end
+    end
+
+    def test_hardware_profiles_have_unique_name
+      get_auth_url '/api/hardware_profiles'
+      names = []
+      (last_xml_response/'hardware_profiles/hardware_profile').each do |profile|
+        names << (profile/'name').text
+      end
+      names.should == names.uniq
+    end
+
+    def test_hardware_profiles_have_unique_id
+      get_auth_url '/api/hardware_profiles'
+      ids = []
+      (last_xml_response/'hardware_profiles/hardware_profile').each do |profile|
+        ids << profile['id']
+      end
+      ids.should == ids.uniq
+    end
+
+    def test_m1_xlarge_profile_has_correct_attributes
+      get_auth_url '/api/hardware_profiles'
+      profile = (last_xml_response/'hardware_profiles/hardware_profile[@id="m1-xlarge"]')
+      test_profile_properties(profile)
+    end
+
+    def test_it_returns_valid_hardware_profile
+      get_auth_url '/api/hardware_profiles/m1-xlarge'
+      profile = (last_xml_response/'hardware_profile')
+      test_profile_properties(profile)
+    end
+
+    def test_it_responses_to_json
+      get_url '/api/hardware_profiles', {}, { :format => :json }
+      JSON::parse(last_response.body).class.should == Hash
+      JSON::parse(last_response.body)['hardware_profiles'].class.should == Array
+      get_url '/api/hardware_profiles/m1-xlarge', {}, { :format => :json }
+      last_response.status.should == 200
+      JSON::parse(last_response.body).class.should == Hash
+      JSON::parse(last_response.body)['hardware_profile'].class.should == Hash
+    end
+
+    def test_it_responses_to_html
+      get_url '/api/hardware_profiles', {}, { :format => :html }
+      last_response.status.should == 200
+      Nokogiri::HTML(last_response.body).search('html').first.name.should == 'html'
+      get_url '/api/hardware_profiles/m1-xlarge', {}, { :format => :html }
+      last_response.status.should == 200
+      Nokogiri::HTML(last_response.body).search('html').first.name.should == 'html'
+    end
+
+    def test_it_returns_error_on_wrong_name
+      get_url '/api/hardware_profiles/m1-unknown-wrongname', {}, { :format => :html }
+      last_response.status.should == 404
+      get_auth_url '/api/hardware_profiles/m1-unknown-wrongname'
+      last_response.status.should == 404
+      get_url '/api/hardware_profiles/m1-unknown-wrongname', {}, { :format => :json }
+      last_response.status.should == 404
+    end
+
+    private
+
+    def test_profile_properties(profile)
+      (profile/'property').each do |properties|
+        properties.attributes.keys.sort.should == [ 'kind', 'name', 'unit', 'value' ]
+      end
+
+      (profile/'property[@name="architecture"]').first['kind'].should == 'fixed'
+      (profile/'property[@name="architecture"]').first['unit'].should == 'label'
+
+      (profile/'property[@name="memory"]').first['kind'].should == 'range'
+      (profile/'property[@name="memory"]').first['unit'].should == 'MB'
+      (profile/'property[@name="memory"]/range').length.should == 1
+      (profile/'property[@name="memory"]/range').first.attributes.keys.sort.should == [ 'first', 'last' ]
+
+      (profile/'property[@name="cpu"]').first['kind'].should == 'fixed'
+      (profile/'property[@name="cpu"]').first['unit'].should == 'count'
+
+      (profile/'property[@name="storage"]').first['kind'].should == 'enum'
+      (profile/'property[@name="storage"]').first['unit'].should == 'GB'
+      (profile/'property[@name="storage"]/enum').length.should == 1
+      (profile/'property[@name="storage"]/enum/entry').length.should == 3
+      (profile/'property[@name="storage"]/enum/entry').each do |entry|
+        entry.attributes.keys.should == [ 'value' ]
+        entry['value'].should_not == nil
+      end
+    end
+
+  end
+end

data/tests/drivers/mock/images_test.rb

@@ -0,0 +1,126 @@
+# 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.
+#
+
+$:.unshift File.join(File.dirname(__FILE__), '..', '..', '..')
+require 'tests/common'
+
+module DeltacloudUnitTest
+  class HardwareProfilesTest < Test::Unit::TestCase
+    include Rack::Test::Methods
+
+    def app
+      Sinatra::Application
+    end
+
+    def test_it_require_authentication
+      require_authentication?('/api/images').should == true
+    end
+
+    def test_it_returns_images
+      get_auth_url '/api/images', {}
+      (last_xml_response/'images/image').length.should > 0
+    end
+
+    def test_it_has_correct_attributes_set
+      get_auth_url '/api/images', {}
+      (last_xml_response/'images/image').each do |image|
+        image.attributes.keys.sort.should == [ 'href', 'id' ]
+      end
+    end
+
+    def test_img1_has_correct_attributes
+      get_auth_url '/api/images', {}
+      image = (last_xml_response/'images/image[@id="img1"]')
+      test_image_attributes(image)
+    end
+
+    def test_it_returns_valid_image
+      get_auth_url '/api/images/img1', {}
+      image = (last_xml_response/'image')
+      test_image_attributes(image)
+    end
+
+    def test_it_has_unique_ids
+      get_auth_url '/api/images', {}
+      ids = []
+      (last_xml_response/'images/image').each do |image|
+        ids << image['id'].to_s
+      end
+      ids.sort.should == ids.sort.uniq
+    end
+
+    def test_it_has_valid_urls
+      get_auth_url '/api/images', {}
+      ids = []
+      images = (last_xml_response/'images/image')
+      images.each do |image|
+        get_auth_url image['href'].to_s, {}
+        (last_xml_response/'image').first['href'].should == image['href'].to_s
+      end
+    end
+
+    def test_it_can_filter_using_owner_id
+      get_auth_url '/api/images', { :owner_id => 'mockuser' }
+      (last_xml_response/'images/image').length.should == 1
+      (last_xml_response/'images/image/owner_id').first.text.should == 'mockuser'
+    end
+
+    def test_it_can_filter_using_unknown_owner_id
+      get_auth_url '/api/images', { :architecture => 'unknown_user' }
+      (last_xml_response/'images/image').length.should == 0
+    end
+
+    def test_it_can_filter_using_architecture
+      get_auth_url '/api/images', { :architecture => 'x86_64' }
+      (last_xml_response/'images/image').length.should == 1
+      (last_xml_response/'images/image/architecture').first.text.should == 'x86_64'
+    end
+
+    def test_it_can_filter_using_unknown_architecture
+      get_auth_url '/api/images', { :architecture => 'unknown_arch' }
+      (last_xml_response/'images/image').length.should == 0
+    end
+
+    def test_it_responses_to_json
+      get_auth_url '/api/images', {}, { :format => :json }
+      JSON::parse(last_response.body).class.should == Hash
+      JSON::parse(last_response.body)['images'].class.should == Array
+      get_auth_url '/api/images/img1', {}, { :format => :json }
+      last_response.status.should == 200
+      JSON::parse(last_response.body).class.should == Hash
+      JSON::parse(last_response.body)['image'].class.should == Hash
+    end
+
+    def test_it_responses_to_html
+      get_auth_url '/api/images', {}, { :format => :html }
+      last_response.status.should == 200
+      Nokogiri::HTML(last_response.body).search('html').first.name.should == 'html'
+      get_auth_url '/api/images/img1', {}, { :format => :html }
+      last_response.status.should == 200
+      Nokogiri::HTML(last_response.body).search('html').first.name.should == 'html'
+    end
+
+    private
+
+    def test_image_attributes(image)
+      (image/'name').text.should_not nil
+      (image/'owner_id').text.should_not nil
+      (image/'description').text.should_not nil
+      (image/'architecture').text.should_not nil
+    end
+
+  end
+end