deltacloud-client-vm 1.1.4.2 → 1.1.4.3

data/lib/deltacloud_vm/core_ext.rb

@@ -0,0 +1,19 @@
+# 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_relative './core_ext/element'
+require_relative './core_ext/fixnum'
+require_relative './core_ext/nil'
+require_relative './core_ext/string'

data/lib/deltacloud_vm/core_ext/element.rb

@@ -0,0 +1,32 @@
+# 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.
+
+module Nokogiri
+  module XML
+
+    class Element
+
+      def text_at(xpath)
+        (val = self.at(xpath)) ? val.text.strip : nil
+      end
+
+      def attr_at(xpath, attr_name)
+        (val = self.at(xpath)) ? val[attr_name.to_s.strip] : nil
+      end
+
+    end
+
+  end
+end

data/lib/deltacloud_vm/core_ext/fixnum.rb

@@ -0,0 +1,30 @@
+# 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.
+
+class Fixnum
+
+  def is_redirect?
+    (self.to_s =~ /^3(\d+)$/) ? true : false
+  end
+
+  def is_ok?
+    (self.to_s =~ /^2(\d+)$/) ? true : false
+  end
+
+  def is_no_content?
+    self == 204
+  end
+
+end

data/lib/deltacloud_vm/core_ext/nil.rb

@@ -0,0 +1,22 @@
+# 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.
+
+class NilClass
+
+  def to_xml
+    raise DeltacloudVM::Client::InvalidXMLError.new('Server returned empty body')
+  end
+
+end

data/lib/deltacloud_vm/core_ext/string.rb

@@ -0,0 +1,49 @@
+# 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.
+
+class String
+
+  # Used to automagically convert any XML in String
+  # (like HTTP response body) to Nokogiri::XML object
+  #
+  # If Nokogiri::XML fails, InvalidXMLError is returned.
+  #
+  def to_xml
+    Nokogiri::XML(self)
+  end
+
+  unless method_defined? :camelize
+    def camelize
+      split('_').map { |w| w.capitalize }.join
+    end
+  end
+
+  unless method_defined? :pluralize
+    def pluralize
+      return self + 'es' if self =~ /ess$/
+      return self[0, self.length-1] + "ies" if self =~ /ty$/
+      return self if self =~ /data$/
+      self + "s"
+    end
+  end
+
+  unless method_defined? :singularize
+    def singularize
+      return self.gsub(/ies$/, 'y') if self =~ /ies$/
+      return self.gsub(/es$/, '') if self =~ /sses$/
+      self.gsub(/s$/, '')
+    end
+  end
+end

data/lib/deltacloud_vm/error_response.rb

@@ -0,0 +1,93 @@
+# 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.
+
+module DeltacloudVM
+  class ErrorResponse < Faraday::Response::Middleware
+
+    include DeltacloudVM::Client::Helpers::Model
+
+    # This method tries to parse the error XML from DeltacloudVM API
+    # In case there is no error returned in body, it will try to use
+    # the generic error reporting.
+    #
+    # - name    -> DeltacloudVM::Client::+Class+
+    # - error   -> DeltacloudVM XML error representation
+    # - message -> Exception message (overiden by error body message if
+    #              present)
+    #
+    def client_error(name, error, message=nil)
+      args = {
+        :message => message,
+        :status => error ? error[:status] : '500'
+      }
+      # If DeltacloudVM API sends an error in the response body, parse it.
+      # Otherwise, when DC API sends just plain text error, use
+      # it as the exception message.
+      # If DC API does not send anything back, then fallback to
+      # the 'message' attribute.
+      #
+      if error and !error[:body].empty?
+        if xml_error?(error)
+          args.merge! parse_error(error[:body].to_xml.root)
+        else
+          args[:message] = error[:body]
+        end
+      end
+      error(name).new(args)
+    end
+
+    def call(env)
+      @app.call(env).on_complete do |e|
+        case e[:status].to_s
+        when '401'
+          raise client_error(:authentication_error, e,
+            'Invalid :api_user or :api_password')
+        when '405'
+          raise client_error(
+            :invalid_state, e, 'Resource state does not permit this action'
+          )
+        when '404'
+          raise client_error(:not_found, e, 'Object not found')
+        when /40\d/
+          raise client_error(:client_failure, e)
+        when '500'
+          raise client_error(:server_error, e)
+        when '502'
+          raise client_error(:backend_error, e)
+        when '501'
+          raise client_error(:not_supported, e)
+        end
+      end
+    end
+
+    private
+
+    def xml_error?(error)
+      error[:body].to_xml.root && error[:body].to_xml.root.name == 'error'
+    end
+
+    # Parse the DeltacloudVM API error body to Hash
+    #
+    def parse_error(body)
+      args = {}
+      args[:original_error] = body.to_s
+      args[:server_backtrace] = body.text_at('backtrace')
+      args[:message] ||= body.text_at('message')
+      args[:driver] = body.attr_at('backend', 'driver')
+      args[:provider] = body.attr_at('backend', 'provider')
+      args
+    end
+  end
+end

data/tests/client/client_test.rb

@@ -0,0 +1,51 @@
+# 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_relative '../test_helper'
+
+describe DeltacloudVM::Client do
+
+  before do
+    VCR.insert_cassette(__name__)
+  end
+
+  after do
+    VCR.eject_cassette
+  end
+
+  it 'support #VERSION' do
+    DeltacloudVM::Client::VERSION.wont_be_nil
+  end
+
+  it 'support #Client' do
+    DeltacloudVM.must_respond_to 'Client'
+  end
+
+  it 'support to change driver with #Client' do
+    client = DeltacloudVM::Client(
+      DELTACLOUD_URL, DELTACLOUD_USER, DELTACLOUD_PASSWORD,
+      :driver => :ec2
+    )
+    client.request_driver.must_equal :ec2
+    client.current_driver.must_equal 'ec2'
+  end
+
+  it 'support to test of valid DC connection' do
+    DeltacloudVM::Client.must_respond_to 'valid_connection?'
+    DeltacloudVM::Client.valid_connection?(DELTACLOUD_URL).must_equal true
+    DeltacloudVM::Client.valid_connection?('http://unknown:9999').must_equal false
+  end
+
+end

data/tests/client/connection_test.rb

@@ -0,0 +1,77 @@
+# 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_relative '../test_helper'
+
+describe DeltacloudVM::Client::Connection do
+
+  before do
+    VCR.insert_cassette(__name__)
+  end
+
+  after do
+    VCR.eject_cassette
+  end
+
+  it 'connects to DeltacloudVM API' do
+    client = new_client
+    client.connection.wont_be_nil
+    client.connection.must_be_kind_of Faraday::Connection
+    client.version.wont_be_nil
+  end
+
+  it 'supports #version' do
+    client = new_client
+    client.must_respond_to :version
+    client.version.wont_be_nil
+    client.version.wont_be_empty
+  end
+
+  it 'caches the API entrypoint' do
+    client = new_client
+    client.cache_entrypoint!.wont_be_nil
+  end
+
+  it 'supports #valid_credentials?' do
+    client = new_client
+    client.must_respond_to :"valid_credentials?"
+    client.valid_credentials?.must_equal true
+    client = DeltacloudVM::Client(DELTACLOUD_URL, 'foo', 'bar')
+    client.valid_credentials?.must_equal false
+  end
+
+  it 'supports switching drivers per instance' do
+    client = new_client
+    client.current_driver.must_equal 'mock'
+    ec2_client = client.use(:ec2, 'foo', 'bar')
+    ec2_client.current_driver.must_equal 'ec2'
+    client.current_driver.must_equal 'mock'
+  end
+
+  it 'supports switching providers per instance' do
+    client = new_client
+    ec2_client = client.use(:ec2, 'foo', 'bar', 'eu-west-1')
+    ec2_client.current_provider.must_equal 'eu-west-1'
+    ec2_client = client.use(:ec2, 'foo', 'bar', 'us-east-1')
+    ec2_client.current_provider.must_equal 'us-east-1'
+  end
+
+  it 'support switching provider without credentials' do
+    client = new_client.use(:ec2, 'foo', 'bar', 'eu-west-1')
+    new_provider = client.use_provider('us-east-1')
+    new_provider.current_provider.must_equal 'us-east-1'
+  end
+
+end

data/tests/core_ext/element_test.rb

@@ -0,0 +1,40 @@
+# 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_relative '../test_helper'
+
+describe Nokogiri::XML::Element do
+
+  before do
+    mock_xml = Nokogiri::XML(
+      '<root><test id="1"><inner id="2">VALUE</inner><r></r></test></root>'
+    )
+    @mock_el = mock_xml.root
+  end
+
+  it 'support #text_at' do
+    @mock_el.text_at('test/inner').must_equal 'VALUE'
+    @mock_el.text_at('test/unknown').must_be_nil
+    @mock_el.text_at('test/r').must_equal ''
+  end
+
+  it 'support #attr_at' do
+    @mock_el.attr_at('test', :id).must_equal '1'
+    @mock_el.attr_at('test', 'id').must_equal '1'
+    @mock_el.attr_at('test/inner', 'id').must_equal '2'
+    @mock_el.attr_at('r', 'id').must_be_nil
+  end
+
+end

data/tests/core_ext/fixnum_test.rb

@@ -0,0 +1,35 @@
+# 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_relative '../test_helper'
+
+describe Fixnum do
+
+  it 'support #is_redirect?' do
+    300.must_respond_to :"is_redirect?"
+    300.is_redirect?.must_equal true
+    310.is_redirect?.must_equal true
+    399.is_redirect?.must_equal true
+    510.is_redirect?.must_equal false
+  end
+
+  it 'support #is_ok?' do
+    200.must_respond_to :"is_ok?"
+    200.is_ok?.must_equal true
+    210.is_ok?.must_equal true
+    299.is_ok?.must_equal true
+    510.is_ok?.must_equal false
+  end
+end