yao 0.17.0 → 0.18.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 22e30555da286a1d595d60c3278cb2d3b63d1353defa42ebfade5851341d486b
-  data.tar.gz: 27ed61a3d891a286a54c78af0f6b7eea591e461b7bca75e5e2da93e30f2e6741
+  metadata.gz: a30ea9865b8d2944f386d9fe9cfc843a6414b1de2fe3fa53f0515c6679042697
+  data.tar.gz: 3e3ff0f51fccd67726f8e70e5801db2299963d7627898312a4640e37027bc8ad
 SHA512:
-  metadata.gz: e5610760a589bb5e0bbdd8bbfd6da917628865faa8b64f46f8cc9dbe94f6e9eb95929daf93d1831de5b2bc8a520b94da33455619bb1f412bbeda8dc51833cd5e
-  data.tar.gz: 8c2e8f48490af04d4f3a7cb9b42506f74f36fb99d39dc91a7036444de996838639443e3064a01616a9354078b98ca1092a9dfe9dd05feee96dd0cfb7198efadb
+  metadata.gz: 7b13454b9f63ce5388d5f5402a7b75db56a23a080ede490748d9928ac2a96e6d094418e3e247b120a3d41224d7896e732d1e8a19d12d13c84e0a73a9dc3d86d9
+  data.tar.gz: a3fdc1732d6d1853c612a204180968f6a62accddf65c66b74983f23bacbfd89bf699e4bb30086c6e10ba9eaefa7976ed8357b9da7e32c98bc046dd60f394d206

data/lib/yao/error.rb

@@ -1,7 +1,7 @@
 module Yao
   class ReadOnlyViolationError < ::StandardError; end
   class TooManyItemFonud       < ::StandardError; end
-  class InvalidResponse        < ::StandardError; end
+  class InvalidRequest         < ::StandardError; end
 
   class ServerError < ::StandardError
     def initialize(message, requested_env)

data/lib/yao/resources/floating_ip.rb

@@ -18,5 +18,32 @@ module Yao::Resources
     def router
       @router ||= Yao::Router.get(router_id)
     end
+
+    # @param [Yao::Resources::Port]
+    # @return [Yao::Resources::FloatingIP]
+    def associate_port(port)
+      self.class.associate_port(id, port.id)
+    end
+
+    # @return [Yao::Resources::FloatingIP]
+    def disassociate_port
+      self.class.disassociate_port(id)
+    end
+
+    class << self
+
+      # @param id [String] ID of floating_ip
+      # @param port_id [String] ID of port
+      # @return [Yao::Resources::FloatingIP]
+      def associate_port(id, port_id)
+        update(id, port_id: port_id)
+      end
+
+      # @param id [String] ID of floating_ip
+      # @return [Yao::Resources::FloatingIP]
+      def disassociate_port(id)
+        update(id, port_id: nil)
+      end
+    end
   end
 end

data/lib/yao/resources/port.rb

@@ -19,6 +19,22 @@ module Yao::Resources
       @subnet ||= Yao::Subnet.find fixed_ips.first["subnet_id"]
     end
 
+    # @return [Yao::FloatingIP]
+    def floating_ip
+      # notice: port が floating_ip を持たない場合has_floating_ip? を呼び出す度に
+      # Yao::FloatingIP.list を評価しなくていいように defined? を入れている
+      if defined?(@floating_ip)
+        @floating_ip
+      else
+        @floating_ip = Yao::FloatingIP.list(port_id: id).first
+      end
+    end
+
+    # @return [Bool]
+    def has_floating_ip?
+      !!floating_ip
+    end
+
     self.service        = "network"
     self.resource_name  = "port"
     self.resources_name = "ports"

data/lib/yao/resources/restfully_accessible.rb

@@ -131,7 +131,7 @@ module Yao::Resources
     # @param query [Hash]
     # @return [Yao::Resources::*]
     def get(id_or_name_or_permalink, query={})
-      res = if id_or_name_or_permalink.start_with?("http://", "https://")
+      res = if id_or_name_or_permalink&.start_with?("http://", "https://")
               GET(id_or_name_or_permalink, query)
             elsif uuid?(id_or_name_or_permalink)
               GET(create_url(id_or_name_or_permalink), query)
@@ -148,7 +148,7 @@ module Yao::Resources
     # @return [Yao::Resources::*]
     def get!(id_or_name_or_permalink, query={})
       get(id_or_name_or_permalink, query)
-    rescue Yao::ItemNotFound, Yao::NotFound, Yao::InvalidResponse
+    rescue Yao::ItemNotFound, Yao::NotFound, Yao::InvalidRequest
       nil
     end
 
@@ -235,15 +235,19 @@ module Yao::Resources
     # @return [Yao::Resources::*]
     def get_by_name(name, query={})
 
+      # 空またnilの場合listと同じURLにリクエストしてしまい意図しないレスポンスが返ってくる
+      if name.nil? || name.empty?
+        raise Yao::InvalidRequest.new("Invalid request with empty name or nil")
+      end
+
       begin
         GET(create_url(name), query)
-      rescue => e
-        raise e unless e.class == Yao::ItemNotFound || e.class == Yao::NotFound
+      rescue Yao::ItemNotFound, Yao::NotFound => e
         item = find_by_name(name).select { |r| r.name == name }
         if item.size > 1
           raise Yao::TooManyItemFonud.new("More than one resource exists with the name '#{name}'")
         elsif item.size.zero?
-          raise Yao::InvalidResponse.new("No resource exists with the name '#{name}'")
+          raise e
         end
         GET(create_url(item.first.id), query)
       end

data/lib/yao/version.rb

@@ -1,3 +1,3 @@
 module Yao
-  VERSION = "0.17.0"
+  VERSION = "0.18.0"
 end

data/test/yao/resources/test_floating_ip.rb

@@ -131,4 +131,95 @@ class TestFloatingIP < TestYaoResource
 
     assert_requested(stub)
   end
+
+  def test_associate_port
+
+    floating_ip = Yao::FloatingIP.new("id" => "00000000-0000-0000-0000-000000000000")
+    port = Yao::Port.new("id" => "01234567-0123-0123-0123-0123456789ab")
+
+    stub = stub_request(:put, "https://example.com:12345/floatingips/00000000-0000-0000-0000-000000000000").
+      with(
+        body: '{"floatingip":{"port_id":"01234567-0123-0123-0123-0123456789ab"}}'
+      )
+      .to_return(
+        status: 200,
+        body: <<-JSON,
+        {
+          "floatingip": {
+            "id": "00000000-0000-0000-0000-000000000000"
+          }
+        }
+        JSON
+        headers: {'Content-Type' => 'application/json'}
+      )
+
+    resource = Yao::FloatingIP.associate_port(floating_ip.id, port.id)
+    assert_instance_of(Yao::FloatingIP, resource)
+    assert_equal("00000000-0000-0000-0000-000000000000", resource.id)
+
+    assert_requested(stub)
+  end
+
+  sub_test_case 'Yao::FloatingIP#associate_port' do
+
+    def setup
+      stub(Yao::Resources::FloatingIP).associate_port {}
+    end
+
+    def test_associate_port
+      floating_ip = Yao::FloatingIP.new("id" => "00000000-0000-0000-0000-000000000000")
+      port = Yao::Port.new("id" => "01234567-0123-0123-0123-0123456789ab")
+
+      floating_ip.associate_port(port)
+
+      assert_received(Yao::Resources::FloatingIP) { |subject|
+        subject.associate_port(floating_ip.id, port.id)
+      }
+    end
+  end
+
+  def test_disassociate_port
+
+    stub = stub_request(:put, "https://example.com:12345/floatingips/00000000-0000-0000-0000-000000000000").
+      with(
+        body: '{"floatingip":{"port_id":null}}'
+      )
+      .to_return(
+        status: 200,
+        body: <<-JSON,
+        {
+          "floatingip": {
+            "id": "00000000-0000-0000-0000-000000000000"
+          }
+        }
+        JSON
+        headers: {'Content-Type' => 'application/json'}
+      )
+
+    floating_ip = Yao::FloatingIP.new("id" => "00000000-0000-0000-0000-000000000000")
+
+    resource = Yao::FloatingIP.disassociate_port(floating_ip.id)
+    assert_instance_of(Yao::FloatingIP, resource)
+    assert_equal("00000000-0000-0000-0000-000000000000", resource.id)
+
+    assert_requested(stub)
+  end
+
+  sub_test_case 'Yao::FloatingIP#disassociate_port' do
+
+    def setup
+      stub(Yao::Resources::FloatingIP).disassociate_port {}
+    end
+
+    def test_associate_port
+      floating_ip = Yao::FloatingIP.new("id" => "00000000-0000-0000-0000-000000000000")
+      port = Yao::Port.new("id" => "01234567-0123-0123-0123-0123456789ab")
+
+      floating_ip.disassociate_port
+
+      assert_received(Yao::Resources::FloatingIP) { |subject|
+        subject.disassociate_port(floating_ip.id)
+      }
+    end
+  end
 end

data/test/yao/resources/test_port.rb

@@ -170,4 +170,52 @@ class TestPort < TestYaoResource
 
     assert_requested(stub)
   end
+
+  def test_floating_ip
+
+    stub = stub_request(:get, "https://example.com:12345/floatingips?port_id")
+      .to_return(
+        status: 200,
+        body: <<-JSON,
+        {
+          "floatingips": [{
+            "id": "00000000-0000-0000-0000-000000000000"
+          }]
+        }
+        JSON
+        headers: {'Content-Type' => 'application/json'}
+      )
+
+    params = {
+      "port_id" => "00000000-0000-0000-0000-000000000000",
+    }
+
+    port = Yao::Port.new(params)
+    assert_instance_of(Yao::FloatingIP, port.floating_ip)
+    assert_true(port.has_floating_ip?)
+    assert_requested(stub)
+  end
+
+  def test_floating_ip_empty
+
+    stub = stub_request(:get, "https://example.com:12345/floatingips?port_id")
+      .to_return(
+        status: 200,
+        body: <<-JSON,
+        {
+          "floatingips": []
+        }
+        JSON
+        headers: {'Content-Type' => 'application/json'}
+      )
+
+    params = {
+      "port_id" => "00000000-0000-0000-0000-000000000000",
+    }
+
+    port = Yao::Port.new(params)
+    assert_nil(port.floating_ip)
+    assert_false(port.has_floating_ip?)
+    assert_requested(stub)
+  end
 end

data/test/yao/resources/test_restfully_accessible.rb

@@ -88,7 +88,7 @@ class TestRestfullyAccesible < Test::Unit::TestCase
       stub_get_request_not_found([@url, @resources_name, name].join('/'))
       stub_get_request_with_json_response([@url, "#{@resources_name}?name=#{name}"].join('/'), body)
 
-      assert_raise(Yao::InvalidResponse, "raise proper exception") do
+      assert_raise(Yao::ItemNotFound, "raise proper exception") do
         Test.get(name)
       end
     end
@@ -139,6 +139,46 @@ class TestRestfullyAccesible < Test::Unit::TestCase
 
       assert_equal(uuid, Test.send(:get_by_name, 'dummy').body[@resource_name]['id'])
     end
+
+    test 'multiple same name found' do
+      name = 'dummy'
+      uuid = '00112233-4455-6677-8899-aabbccddeeff'
+      list_body = { @resources_name => [
+        { 'name' => 'dummy', 'id' => uuid },
+        { 'name' => 'dummy', 'id' => '308cb410-9c84-40ec-a3eb-583001aaa7fd' }
+      ]}
+      stub1 = stub_get_request_not_found([@url, @resources_name, name].join('/'))
+      stub2 = stub_get_request_with_json_response([@url, "#{@resources_name}?name=#{name}"].join('/'), list_body)
+
+      assert_raise(Yao::TooManyItemFonud, "More than one resource exists with the name '#{name}'") do
+        Test.send(:get_by_name, name)
+      end
+    end
+
+    test 'empty name' do
+      assert_raise(Yao::InvalidRequest, "Invalid requeset with empty name or nil") do
+        Test.send(:get_by_name, '')
+      end
+    end
+
+    test 'nil' do
+      assert_raise(Yao::InvalidRequest, "Invalid requeset with empty name or nil") do
+        Test.send(:get_by_name, nil)
+      end
+    end
+
+    test 'not found' do
+      name = "dummy"
+      uuid = "00112233-4455-6677-8899-aabbccddeeff"
+      body = {@resources_name => []}
+
+      stub1 = stub_get_request_not_found([@url, @resources_name, name].join('/'))
+      stub2 = stub_get_request_with_json_response([@url, "#{@resources_name}?name=#{name}"].join('/'), body)
+
+      assert_raise(Yao::ItemNotFound) do
+        Test.send(:get_by_name, name)
+      end
+    end
   end
 
   def test_find_by_name

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: yao
 version: !ruby/object:Gem::Version
-  version: 0.17.0
+  version: 0.18.0
 platform: ruby
 authors:
 - Uchio, KONDO
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-04-26 00:00:00.000000000 Z
+date: 2022-04-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json