yao 0.15.0 → 0.18.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b2448b0a2070a9d61401c29e6f53445a4cb0c9bbd8f1bc98aac172661d6d9bc0
-  data.tar.gz: 0f50c66bd6fd508c0b47132c672395da04037cb4dd59842d48006c386d19f9fb
+  metadata.gz: a30ea9865b8d2944f386d9fe9cfc843a6414b1de2fe3fa53f0515c6679042697
+  data.tar.gz: 3e3ff0f51fccd67726f8e70e5801db2299963d7627898312a4640e37027bc8ad
 SHA512:
-  metadata.gz: 4e6553ffc603ead2c2ec1d4a4fcc133381b3b4065f7cdce8df9705a8776ab7cf916d1d49d7cc59f5b5453c55b8d8bb1890cec7c35ace2d67f698a43e72f11450
-  data.tar.gz: 0b79462e8a112e7b12f490f8d24e3839b80792d2f4247fee849963c07b4b3b732d3d773a9b4806f27427812e80823e27b7f69a2e0ea198f5286bb7c18439b85c
+  metadata.gz: 7b13454b9f63ce5388d5f5402a7b75db56a23a080ede490748d9928ac2a96e6d094418e3e247b120a3d41224d7896e732d1e8a19d12d13c84e0a73a9dc3d86d9
+  data.tar.gz: a3fdc1732d6d1853c612a204180968f6a62accddf65c66b74983f23bacbfd89bf699e4bb30086c6e10ba9eaefa7976ed8357b9da7e32c98bc046dd60f394d206

data/.github/workflows/rubocop.yml

@@ -8,9 +8,9 @@ jobs:
     steps:
     - uses: actions/checkout@master
     - name: Set up Ruby
-      uses: actions/setup-ruby@v1
+      uses: ruby/setup-ruby@v1
       with:
-        ruby-version: 3.0
+        ruby-version: 3.1
     - name: Install dependencies
       run: |
         gem install bundler --no-document

data/.github/workflows/ubuntu-rvm.yml

@@ -7,7 +7,7 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        ruby: [ 'ruby-3.0.3' ]
+        ruby: [ 'ruby-3.1.1' ]
     steps:
     - uses: actions/checkout@master
     - name: Set up RVM

data/.github/workflows/ubuntu.yml

@@ -7,11 +7,11 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        ruby: [3.0, 2.7, 2.6]
+        ruby: [3.1, 3.0, 2.7]
     steps:
     - uses: actions/checkout@master
     - name: Set up Ruby
-      uses: actions/setup-ruby@v1
+      uses: ruby/setup-ruby@v1
       with:
         ruby-version: ${{ matrix.ruby }}
     - name: Install dependencies

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/base.rb

@@ -8,9 +8,6 @@ module Yao::Resources
     def self.friendly_attributes(*names)
       names.map(&:to_s).each do |name|
         define_method(name) do
-          if !@data.key?(name) && id
-            @data = self.class.get(id).to_hash
-          end
           self[name]
         end
       end
@@ -58,6 +55,9 @@ module Yao::Resources
     # @param name [String]
     # @return [String]
     def [](name)
+      unless @data["id"].nil? || @data.key?(name) || name.include?("__")
+        @data = self.class.get(@data["id"]).to_hash
+      end
       @data[name]
     end
 
@@ -80,18 +80,30 @@ module Yao::Resources
 
     # @return [Date]
     def created
-      if date = self["created"] || self["created_at"]
+      if date = self["created_at"] || self["created"]
         Time.parse(date)
       end
     end
 
     # @return [Date]
     def updated
-      if date = self["updated"] || self["updated_at"]
+      if date = self["updated_at"] || self["updated"]
         Time.parse(date)
       end
     end
 
+    # @param resource_params [Hash]
+    # @return [Yao::Resources::*]
+    def update(resource_params)
+      self.class.update(id, resource_params)
+    end
+
+    # @return [String]
+    def destroy
+      self.class.destroy(id)
+    end
+    alias delete destroy
+
     extend RestfullyAccessible
   end
 end

data/lib/yao/resources/flavor.rb

@@ -20,5 +20,15 @@ module Yao::Resources
     self.resource_name  = "flavor"
     self.resources_name = "flavors"
     self.resources_detail_available = true
+
+    class << self
+      # override Yao::Resources::RestfullyAccessible#find_by_name
+      # @return [Array<Yao::Resources::Role>]
+      def find_by_name(name, query={})
+        list(query).select do |flavor|
+          flavor.name == name
+        end
+      end
+    end
   end
 end

data/lib/yao/resources/floating_ip.rb

@@ -2,7 +2,7 @@ module Yao::Resources
   class FloatingIP < Base
 
     include PortAssociationable
-    include TenantAssociationable
+    include ProjectAssociationable
 
     friendly_attributes :router_id, :description, :dns_domain, :dns_name,
                         :revision_number,
@@ -19,10 +19,31 @@ module Yao::Resources
       @router ||= Yao::Router.get(router_id)
     end
 
-    # @return [Yao::Resources::Tenant]
-    def project
-      @project ||= Yao::Tenant.get(project_id)
+    # @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
-    alias :tenant :project
   end
 end

data/lib/yao/resources/loadbalancer_pool.rb

@@ -7,21 +7,11 @@ module Yao::Resources
     map_attribute_to_resources loadbalancers: LoadBalancer
     map_attribute_to_resources listeners: LoadBalancerListener
 
-    # @return [Date]
-    def created_at
-      Date.parse(self["created_at"])
-    end
-
-    # @return [Date]
-    def updated_at
-      Date.parse(self["updated_at"])
-    end
-
     # @return [Yao::Resources::LoadBalancerListener]
     def listeners
-      self["listeners"].map do |listener|
-        Yao::LoadBalancerListener.find listener["id"]
-      end
+      @listeners ||= self["listeners"].map do |listener|
+                       Yao::LoadBalancerListener.get(listener["id"])
+                     end
     end
 
     # @return [Yao::Resources::Tenant]
@@ -32,18 +22,18 @@ module Yao::Resources
     end
     alias :tenant :project
 
-    # @return [Yao::Resources::LoadBalancerListener]
+    # @return [Yao::Resources::LoadBalancerPoolMember]
     def members
-      self["members"].map do |member|
-        Yao::LoadBalancerPoolMember.find(self,member["id"])
-      end
+      @members ||= self["members"].map do |member|
+                     Yao::LoadBalancerPoolMember.get(self, member["id"])
+                   end
     end
 
     # @return [Yao::Resources::LoadBalancerHealthMonitor]
     def healthmonitor
-      if healthmonitor_id = self["healthmonitor_id"]
-        Yao::LoadBalancerHealthMonitor.find healthmonitor_id
-      end
+      @healthmonitor ||= if healthmonitor_id = self["healthmonitor_id"]
+                           Yao::LoadBalancerHealthMonitor.get(healthmonitor_id)
+                         end
     end
 
     self.service        = "load-balancer"

data/lib/yao/resources/meter.rb

@@ -1,7 +1,7 @@
 module Yao::Resources
   class Meter < Base
 
-    include TenantAssociationable
+    include ProjectAssociationable
 
     friendly_attributes :meter_id, :name, :user_id, :resource_id, :source, :type, :unit
 

data/lib/yao/resources/network.rb

@@ -1,6 +1,6 @@
 module Yao::Resources
   class Network < Base
-    include TenantAssociationable
+    include ProjectAssociationable
 
     friendly_attributes :name, :status, :shared, :subnets, :admin_state_up
     map_attribute_to_attribute "provider:physical_network" => :physical_network

data/lib/yao/resources/old_sample.rb

@@ -1,6 +1,6 @@
 module Yao::Resources
   class OldSample < Base
-    include TenantAssociationable
+    include ProjectAssociationable
 
     friendly_attributes :counter_name, :counter_type, :counter_unit, :counter_volume,
                         :message_id, :resource_id, :timestamp, :resource_metadata, :user_id,

data/lib/yao/resources/port.rb

@@ -2,7 +2,7 @@ module Yao::Resources
   class Port < Base
 
     include NetworkAssociationable
-    include TenantAssociationable
+    include ProjectAssociationable
 
     friendly_attributes :name, :mac_address, :status, :allowed_address_pairs,
                         :device_owner, :fixed_ips, :security_groups, :device_id,
@@ -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/{tenant_associationable.rb → project_associationable.rb}

@@ -1,18 +1,18 @@
 module Yao
   module Resources
-    module TenantAssociationable
+    module ProjectAssociationable
 
       def self.included(base)
         base.friendly_attributes :project_id
         base.friendly_attributes :tenant_id
       end
 
-      # @return [Yao::Resources::Tenant]
-      def tenant
-        @tenant ||= Yao::Tenant.find(project_id || tenant_id)
+      # @return [Yao::Resources::Project]
+      def project
+        @project ||= Yao::Project.find(project_id || tenant_id)
       end
 
-      alias :project :tenant
+      alias :tenant :project
     end
   end
 end

data/lib/yao/resources/resource.rb

@@ -1,7 +1,7 @@
 require 'time'
 module Yao::Resources
   class Resource < Base
-    include TenantAssociationable
+    include ProjectAssociationable
 
     friendly_attributes :user_id, :resource_id,
                         :last_sample_timestamp, :first_sample_timestamp,

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
+    rescue Yao::ItemNotFound, Yao::NotFound, Yao::InvalidRequest
       nil
     end
 
@@ -188,6 +188,7 @@ module Yao::Resources
       res = DELETE(create_url(id))
       res.body
     end
+    alias delete destroy
 
     private
 
@@ -234,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
-        item = find_by_name(name)
+      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/resources/role_assignment.rb

@@ -11,9 +11,9 @@ module Yao::Resources
     self.admin          = true
     self.api_version    = "v3"
 
-    # @return [Yao::Resources::Tenant]
+    # @return [Yao::Resources::Project]
     def project
-      @project ||= Yao::Tenant.get(scope["project"]["id"])
+      @project ||= Yao::Project.get(scope["project"]["id"])
     end
 
     class << self

data/lib/yao/resources/router.rb

@@ -1,15 +1,31 @@
 module Yao::Resources
   class Router < Base
-    include TenantAssociationable
+    include ProjectAssociationable
 
     friendly_attributes :name, :description, :admin_state_up, :status, :external_gateway_info,
-                        :network_id, :enable_snat, :external_fixed_ips, :routes, :destination, :nexthop, :distributed,
-                        :ha, :availability_zone_hints, :availability_zones
+                        :routes, :distributed, :ha, :availability_zone_hints, :availability_zones
 
     self.service        = 'network'
     self.resource_name  = 'router'
     self.resources_name = 'routers'
 
+    # @return [bool]
+    def enable_snat
+      external_gateway_info["enable_snat"]
+    end
+
+    # @return [Array<Hash>]
+    def external_fixed_ips
+      external_gateway_info["external_fixed_ips"]
+    end
+
+    # @return [Yao::Resource::Network]
+    def external_network
+      @external_network ||= if network_id = external_gateway_info["network_id"]
+                              Yao::Network.get(network_id)
+                            end
+    end
+
     # @return [Array<Yao::Resources::Port>]
     def interfaces
       Yao::Port.list(device_id: id)
@@ -29,13 +45,6 @@ module Yao::Resources
       def remove_interface(id, param)
         PUT(['routers', id, 'remove_router_interface.json'].join('/'), param.to_json)
       end
-
-      # @param name [String]
-      # @return [Array<Yao::Resources::Router>]
-      def get_by_name(name)
-        self.list(name: name)
-      end
-      alias find_by_name get_by_name
     end
   end
 end

data/lib/yao/resources/security_group.rb

@@ -1,7 +1,7 @@
 require 'yao/resources/security_group_rule'
 module Yao::Resources
   class SecurityGroup < Base
-    include TenantAssociationable
+    include ProjectAssociationable
 
     friendly_attributes :name, :description
 

data/lib/yao/resources/server.rb

@@ -2,7 +2,7 @@ require 'yao/resources/metadata_available'
 require 'yao/resources/action'
 module Yao::Resources
   class Server < Base
-    include TenantAssociationable
+    include ProjectAssociationable
 
     friendly_attributes :addresses, :metadata, :name, :progress,
                         :status, :user_id, :key_name
@@ -32,6 +32,11 @@ module Yao::Resources
       Yao::OldSample.list(counter_name, query).select{|os| os.resource_metadata["instance_id"] == id}
     end
 
+    # @return [Array<Yao::Resources::Port>]
+    def ports
+      @ports ||= Yao::Port.list(device_id: id)
+    end
+
     # @param id [String]
     # @return [Hash]
     def self.start(id)

data/lib/yao/resources/subnet.rb

@@ -2,7 +2,7 @@ module Yao::Resources
   class Subnet < Base
 
     include NetworkAssociationable
-    include TenantAssociationable
+    include ProjectAssociationable
 
     friendly_attributes :name, :cidr, :gateway_ip, :network_id, :ip_version,
                         :dns_nameservers, :host_routes, :enable_dhcp

data/lib/yao/resources/volume.rb

@@ -2,6 +2,8 @@ require 'yao/resources/volume_action'
 
 module Yao::Resources
   class Volume < Base
+    include ProjectAssociationable
+
     friendly_attributes :attachments, :availability_zone, :bootable, :descriptions, :encrypted, :metadata, :multiattach, :name, :replication_status, :size, :snapshot_id, :status, :user_id, :volume_type
     alias :type :volume_type
 

data/lib/yao/resources.rb

@@ -1,7 +1,7 @@
 module Yao
   module Resources
     require "yao/resources/base"
-    require "yao/resources/tenant_associationable"
+    require "yao/resources/project_associationable"
     require "yao/resources/port_associationable"
     require "yao/resources/network_associationable"
     require "yao/resources/server_usage_associationable"

data/lib/yao/version.rb

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

data/test/yao/resources/test_base.rb

@@ -23,4 +23,25 @@ class TestResourceBase < TestYaoResource
     assert_equal(nil, base.empty)
   end
 
+  def test_update
+    stub(Yao::Resources::Base).update('foo', {name: 'BAR'}) { Yao::Resources::Base.new('id' => 'foo', 'name' => 'BAR')}
+    base = Yao::Resources::Base.new({'id' => 'foo', 'name' => 'bar'})
+    got = base.update(name: 'BAR')
+    assert_equal(got.name, 'BAR')
+  end
+
+  def test_destroy
+    stub(Yao::Resources::Base).destroy('foo') { nil }
+    base = Yao::Resources::Base.new({'id' => 'foo'})
+    got = base.destroy
+    assert_equal(got, nil)
+  end
+
+  def test_delete
+    stub(Yao::Resources::Base).destroy('foo') { nil }
+    base = Yao::Resources::Base.new({'id' => 'foo'})
+    got = base.delete
+    assert_equal(got, nil)
+  end
+
 end

data/test/yao/resources/test_flavor.rb

@@ -46,48 +46,64 @@ class TestFlavor < TestYaoResource
     assert_equal(512, flavor.memory)
   end
 
-  def test_list
-    stub = stub_request(:get, "https://example.com:12345/flavors/detail").
+  def flavor_detail
+    JSON.parse(<<~JSON)
+      {
+          "OS-FLV-DISABLED:disabled": false,
+          "disk": 20,
+          "OS-FLV-EXT-DATA:ephemeral": 0,
+          "os-flavor-access:is_public": true,
+          "id": "7",
+          "links": [
+              {
+                  "href": "http://openstack.example.com/v2/6f70656e737461636b20342065766572/flavors/7",
+                  "rel": "self"
+              },
+              {
+                  "href": "http://openstack.example.com/6f70656e737461636b20342065766572/flavors/7",
+                  "rel": "bookmark"
+              }
+          ],
+          "name": "m1.small.description",
+          "ram": 2048,
+          "swap": 0,
+          "vcpus": 1,
+          "rxtx_factor": 1.0,
+          "description": "test description",
+          "extra_specs": {
+              "hw:cpu_policy": "shared",
+              "hw:numa_nodes": "1"
+          }
+      }
+    JSON
+  end
+
+  def stub_flavors_detail(query=nil)
+    url = ['https://example.com:12345/flavors/detail',query].compact.join('?')
+    stub_request(:get, url).
       to_return(
         status: 200,
-        body: <<-JSON,
-        {
-            "flavors": [
-                {
-                    "OS-FLV-DISABLED:disabled": false,
-                    "disk": 1,
-                    "OS-FLV-EXT-DATA:ephemeral": 0,
-                    "os-flavor-access:is_public": true,
-                    "id": "1",
-                    "links": [
-                        {
-                            "href": "http://openstack.example.com/v2/6f70656e737461636b20342065766572/flavors/1",
-                            "rel": "self"
-                        },
-                        {
-                            "href": "http://openstack.example.com/6f70656e737461636b20342065766572/flavors/1",
-                            "rel": "bookmark"
-                        }
-                    ],
-                    "name": "m1.tiny",
-                    "ram": 512,
-                    "swap": "",
-                    "vcpus": 1,
-                    "rxtx_factor": 1.0,
-                    "description": null,
-                    "extra_specs": {}
-                }
-            ]
-        }
-        JSON
+        body: { flavors:[flavor_detail] }.to_json,
         headers: {'Content-Type' => 'application/json'}
       )
+  end
 
+  def stub_flavor(id)
+    stub_request(:get, "https://example.com:12345/flavors/#{id}").
+      to_return(
+        status: 200,
+        body: { 'flavor': flavor_detail }.to_json,
+        headers: {'Content-Type' => 'application/json'}
+      )
+  end
+
+  def test_list
+    stub = stub_flavors_detail
     assert(Yao::Flavor.resources_detail_available)
 
     flavors = Yao::Flavor.list
     assert_instance_of(Yao::Flavor, flavors.first)
-    assert_equal("m1.tiny", flavors.first.name)
+    assert_equal("m1.small.description", flavors.first.name)
 
     assert_requested(stub)
   end
@@ -97,4 +113,22 @@ class TestFlavor < TestYaoResource
     # see also: https://stackoverflow.com/questions/25883618/how-to-test-method-alias-ruby
     assert_equal(Yao::Flavor.method(:list), Yao::Flavor.method(:list_detail))
   end
+
+  def test_get_by_id
+    stub = stub_flavor(7)
+    flavor = Yao::Flavor.get('7')
+    assert_equal('m1.small.description', flavor.name)
+    assert_requested(stub)
+  end
+
+  def test_get_by_name
+    stub = stub_request(:get, "https://example.com:12345/flavors/m1.small.description").to_return(status: 404)
+    stub2 = stub_flavors_detail
+    stub3 = stub_flavor(7)
+    flavor = Yao::Flavor.get('m1.small.description')
+    assert_equal('7', flavor.id)
+    assert_requested(stub)
+    assert_requested(stub2)
+    assert_requested(stub3)
+  end
 end