yao 0.7.0 → 0.8.0

data/lib/yao/resources/subnet.rb

@@ -1,6 +1,10 @@
 module Yao::Resources
   class Subnet < Base
-    friendly_attributes :name, :cidr, :gateway_ip, :network_id, :tenant_id, :ip_version,
+
+    include NetworkAssociationable
+    include TenantAssociationable
+
+    friendly_attributes :name, :cidr, :gateway_ip, :network_id, :ip_version,
                         :dns_nameservers, :host_routes, :enable_dhcp
 
     def allocation_pools
@@ -9,10 +13,6 @@ module Yao::Resources
       end
     end
 
-    def network
-      Yao::Network.find network_id
-    end
-
     alias dhcp_enabled? enable_dhcp
 
     self.service        = "network"

data/lib/yao/resources/tenant.rb

@@ -9,7 +9,7 @@ module Yao::Resources
     self.return_single_on_querying = true
 
     def servers
-      @servers ||= Yao::Server.list_detail(all_tenants: 1).select{|s| s.tenant_id == id }
+      @servers ||= Yao::Server.list(all_tenants: 1).select{|s| s.tenant_id == id }
     end
 
     def meters

data/lib/yao/resources/tenant_associationable.rb

@@ -0,0 +1,17 @@
+module Yao
+  module Resources
+    module TenantAssociationable
+
+      def self.included(base)
+        base.friendly_attributes :project_id
+        base.friendly_attributes :tenant_id
+      end
+
+      def tenant
+        @tenant ||= Yao::Tenant.find(project_id || tenant_id)
+      end
+
+      alias :project :tenant
+    end
+  end
+end

data/lib/yao/resources/user.rb

@@ -8,13 +8,24 @@ module Yao::Resources
     self.resource_name  = "user"
     self.resources_name = "users"
     self.admin          = true
-    self.return_single_on_querying = true
 
     class << self
-      def get_by_name(name)
-        self.list(name: name)
+      def find_by_name(name, query={})
+        if api_verion_v2?
+          [super]
+        else
+          super
+        end
+      end
+
+      def return_single_on_querying
+        api_verion_v2?
+      end
+
+      private
+      def api_verion_v2?
+        client.url_prefix.to_s.match?(/v2\.0/)
       end
-      alias find_by_name get_by_name
     end
   end
 end

data/lib/yao/resources/volume.rb

@@ -7,15 +7,6 @@ module Yao::Resources
     self.service        = "volumev3"
     self.resource_name  = "volume"
     self.resources_name = "volumes"
-
-    class << self
-      def list_detail(query={})
-        return_resources(
-            resources_from_json(
-                GET([resources_path, "detail"].join("/"), query).body
-            )
-        )
-      end
-    end
+    self.resources_detail_available = true
   end
 end

data/lib/yao/version.rb

@@ -1,3 +1,3 @@
 module Yao
-  VERSION = "0.7.0"
+  VERSION = "0.8.0"
 end

data/test/config.rb

@@ -6,6 +6,7 @@ require 'yao'
 require 'support/auth_stub'
 require 'support/authv3_stub'
 require 'support/restfully_accesible_stub'
+require 'support/test_yao_resource'
 
 require 'webmock/test_unit'
 

data/test/support/auth_stub.rb

@@ -1,4 +1,5 @@
 module AuthStub
+
   def stub_auth_request(auth_url, username, password, tenant)
     stub_request(:post, "#{auth_url}/tokens")
       .with(

data/test/support/test_yao_resource.rb

@@ -0,0 +1,49 @@
+class TestYaoResource < Test::Unit::TestCase
+  include AuthStub
+
+  def setup
+    initialize_test_client!
+  end
+
+  def teardown
+    reset_test_client!
+  end
+
+  private
+
+  # Yao::Resources::* のテストで Yao.default.pool の設定を都度都度 記述しなくていいよういするヘルパー
+  # endpoint の URL がマチマチだとテストを記述するのが面倒なので example.com で統一している
+  def initialize_test_client!
+    auth_url = "http://example.com:12345"
+    username = "yao"
+    tenant   = "default"
+    password = "password"
+
+    stub_auth_request(auth_url, username, password, tenant)
+
+    Yao.config.set :auth_url, auth_url
+    Yao::Auth.new(tenant_name: tenant, username: username, password: password)
+
+    client = Yao::Client.gen_client("https://example.com:12345")
+    Yao.default_client.admin_pool["identity"] = client
+    Yao.default_client.pool["network"]        = client
+    Yao.default_client.pool["compute"]        = client
+    Yao.default_client.pool["metering"]       = client
+    Yao.default_client.pool["volumev3"]       = client
+  end
+
+  # 他のテストで副作用を出さないように Yao::Client.default_client, Yao::Conig を nil でリセットしておきます
+  def reset_test_client!
+    Yao::Client.default_client = nil
+
+    Yao::Config::HOOK_RENEW_CLIENT_KEYS.each do |key|
+      Yao.configure do
+        set key, nil
+      end
+    end
+
+    # https://github.com/bblimke/webmock/wiki/Clear-stubs-and-request-history
+    # 他のテストに作用しないように stub_request を reset する
+    WebMock.reset!
+  end
+end

data/test/yao/resources/test_aggregates.rb

@@ -1,7 +1,4 @@
-require "time"
-require "date"
-
-class TestAggregates < Test::Unit::TestCase
+class TestAggregates < TestYaoResource
   def test_server_aggregates
     params = {
       "availability_zone" => "nova",

data/test/yao/resources/test_base.rb

@@ -1,4 +1,4 @@
-class TestResourceBase < Test::Unit::TestCase
+class TestResourceBase < TestYaoResource
   def setup
     stub(Yao::Resources::Base).get { Yao::Resources::Base.new({"id" => "foor", "name" => "bar"}) }
   end

data/test/yao/resources/test_compute_services.rb

@@ -0,0 +1,118 @@
+class TestComputeServices < TestYaoResource
+
+  def test_compute_services
+
+    # https://docs.openstack.org/api-ref/compute/?expanded=update-forced-down-detail,update-compute-service-detail,list-compute-services-detail#compute-services-os-services
+    params = {
+      "id" =>  1,
+      "binary" =>  "nova-scheduler",
+      "disabled_reason" =>  "test1",
+      "host" =>  "host1",
+      "state" =>  "up",
+      "status" =>  "disabled",
+      "updated_at" =>  "2012-10-29T13:42:02.000000",
+      "forced_down" =>  false,
+      "zone" =>  "internal"
+    }
+    compute_service = Yao::ComputeServices.new(params)
+
+    assert_equal(compute_service.id, 1)
+    assert_equal(compute_service.binary, "nova-scheduler")
+    assert_equal(compute_service.disabled_reason, "test1")
+    assert_equal(compute_service.host, "host1")
+    assert_equal(compute_service.state, "up")
+    assert_equal(compute_service.status, "disabled")
+    assert_equal(compute_service.updated, Time.mktime(2012,10,29,13,42,2))
+    assert_equal(compute_service.forced_down, false)
+    assert_equal(compute_service.zone, "internal")
+  end
+
+  def test_enable
+    stub = stub_request(:put, "https://example.com:12345/os-services/enable").
+      with(
+        body: <<~JSON.chomp
+        {"host":"host1","binary":"nova-compute"}
+        JSON
+      ).to_return(
+        status: 200,
+        body: <<-JSON,
+        {
+            "service": {
+                "binary": "nova-compute",
+                "host": "host1",
+                "status": "enabled"
+            }
+        }
+        JSON
+        headers: {'Content-Type' => 'application/json'}
+      )
+
+    compute_service = Yao::ComputeServices.enable('host1', 'nova-compute')
+
+    assert_equal(compute_service.host, "host1")
+    assert_equal(compute_service.binary, "nova-compute")
+    assert_equal(compute_service.status, "enabled")
+
+    assert_requested stub
+  end
+
+  def test_disable
+    stub = stub_request(:put, "https://example.com:12345/os-services/disable").
+      with(
+        body: <<~JSON.chomp
+        {"host":"host1","binary":"nova-compute"}
+        JSON
+      ).to_return(
+        status: 200,
+        body: <<-JSON,
+        {
+            "service": {
+                "binary": "nova-compute",
+                "host": "host1",
+                "status": "disabled"
+           }
+        }
+        JSON
+        headers: {'Content-Type' => 'application/json'}
+    )
+
+    compute_service = Yao::ComputeServices.disable('host1', 'nova-compute')
+
+    assert_equal(compute_service.host, "host1")
+    assert_equal(compute_service.binary, "nova-compute")
+    assert_equal(compute_service.status, "disabled")
+
+    assert_requested stub
+  end
+
+  def test_disable_with_reason
+    stub = stub_request(:put, "https://example.com:12345/os-services/disable-log-reason").
+      with(
+        body: <<~JSON.chomp
+        {"host":"host1","binary":"nova-compute","disabled_reason":"test2"}
+        JSON
+      ).to_return(
+        status: 200,
+        body: <<-JSON,
+        {
+            "service": {
+                "binary": "nova-compute",
+                "disabled_reason": "test2",
+                "host": "host1",
+                "status": "disabled"
+            }
+        }
+        JSON
+        headers: {'Content-Type' => 'application/json'}
+    )
+
+    compute_service = Yao::ComputeServices.disable('host1', 'nova-compute', 'test2')
+
+    assert_equal(compute_service.host, "host1")
+    assert_equal(compute_service.binary, "nova-compute")
+    assert_equal(compute_service.status, "disabled")
+    assert_equal(compute_service.disabled_reason, "test2")
+
+    assert_requested stub
+  end
+end

data/test/yao/resources/test_flavor.rb

@@ -1,8 +1,4 @@
-class TestFlavor < Test::Unit::TestCase
-
-  def setup
-    Yao.default_client.pool["compute"] = Yao::Client.gen_client("https://example.com:12345")
-  end
+class TestFlavor < TestYaoResource
 
   def test_flavor
     # https://docs.openstack.org/api-ref/compute/?expanded=list-flavors-detail,list-flavors-with-details-detail#list-flavors-with-details
@@ -50,8 +46,8 @@ class TestFlavor < Test::Unit::TestCase
     assert_equal(flavor.memory, 512)
   end
 
-  def test_list_detail
-    stub_request(:get, "https://example.com:12345/flavors/detail").
+  def test_list
+    stub = stub_request(:get, "https://example.com:12345/flavors/detail").
       to_return(
         status: 200,
         body: <<-JSON,
@@ -87,8 +83,18 @@ class TestFlavor < Test::Unit::TestCase
         headers: {'Content-Type' => 'application/json'}
       )
 
-    flavors = Yao::Flavor.list_detail
-    assert { flavors.first.instance_of? Yao::Flavor }
+    assert(Yao::Flavor.resources_detail_available)
+
+    flavors = Yao::Flavor.list
+    assert_instance_of(Yao::Flavor, flavors.first)
     assert_equal(flavors.first.name, "m1.tiny")
+
+    assert_requested(stub)
+  end
+
+  def test_list_detail
+    # Yao::Flavor.list_detail と Yao::Flavor.list が alias にあることをテストする
+    # see also: https://stackoverflow.com/questions/25883618/how-to-test-method-alias-ruby
+    assert_equal(Yao::Flavor.method(:list_detail), Yao::Flavor.method(:list))
   end
 end

data/test/yao/resources/test_floating_ip.rb

@@ -1,10 +1,4 @@
-class TestFloatingIP < Test::Unit::TestCase
-
-  def setup
-    Yao.default_client.admin_pool["identity"] = Yao::Client.gen_client("https://example.com:12345")
-    Yao.default_client.pool["network"]  = Yao::Client.gen_client("https://example.com:12345")
-    Yao.default_client.pool["compute"]  = Yao::Client.gen_client("https://example.com:12345")
-  end
+class TestFloatingIP < TestYaoResource
 
   def test_floating_ip
     params = {
@@ -67,33 +61,37 @@ class TestFloatingIP < Test::Unit::TestCase
 
   def test_floating_ip_to_router
 
-    stub_request(:get, "https://example.com:12345/routers/00000000-0000-0000-0000-000000000000")
+    stub = stub_request(:get, "https://example.com:12345/routers/00000000-0000-0000-0000-000000000000")
       .to_return(
         status: 200,
         body: <<-JSON,
         {
-          "routers": [{
-            "id": "0123456789abcdef0123456789abcdef"
-          }]
+          "router": {
+            "id": "00000000-0000-0000-0000-000000000000"
+          }
         }
         JSON
         headers: {'Content-Type' => 'application/json'}
       )
 
     fip = Yao::FloatingIP.new("router_id" => "00000000-0000-0000-0000-000000000000")
+
     assert_instance_of(Yao::Router, fip.router)
+    assert_equal(fip.router.id, "00000000-0000-0000-0000-000000000000")
+
+    assert_requested(stub)
   end
 
-  def test_floating_to_tenant
+  def test_tenant
 
-    stub_request(:get, "https://example.com:12345/tenants/0123456789abcdef0123456789abcdef")
+    stub = stub_request(:get, "https://example.com:12345/tenants/0123456789abcdef0123456789abcdef")
       .to_return(
          status: 200,
          body: <<-JSON,
         {
-          "tenants": [{
+          "tenant": {
             "id": "0123456789abcdef0123456789abcdef"
-          }]
+          }
         }
         JSON
         headers: {'Content-Type' => 'application/json'}
@@ -106,24 +104,31 @@ class TestFloatingIP < Test::Unit::TestCase
 
     assert_instance_of(Yao::Tenant, fip.tenant)
     assert_instance_of(Yao::Tenant, fip.project)
+    assert_equal(fip.tenant.id, '0123456789abcdef0123456789abcdef')
+
+    assert_requested(stub)
   end
 
   def test_floating_ip_to_port
 
-    stub_request(:get, "https://example.com:12345/ports/00000000-0000-0000-0000-000000000000")
+    stub = stub_request(:get, "https://example.com:12345/ports/00000000-0000-0000-0000-000000000000")
       .to_return(
         status: 200,
         body: <<-JSON,
         {
-          "ports": [{
-            "id": "0123456789abcdef0123456789abcdef"
-          }]
+          "port": {
+            "id": "00000000-0000-0000-0000-000000000000"
+          }
         }
         JSON
         headers: {'Content-Type' => 'application/json'}
       )
 
     fip = Yao::FloatingIP.new("port_id" => "00000000-0000-0000-0000-000000000000")
+
     assert_instance_of(Yao::Port, fip.port)
+    assert_equal(fip.port.id, "00000000-0000-0000-0000-000000000000")
+
+    assert_requested(stub)
   end
 end

data/test/yao/resources/test_host.rb

@@ -1,4 +1,4 @@
-class TestHost < Test::Unit::TestCase
+class TestHost < TestYaoResource
 
   def test_host
     # https://docs.openstack.org/api-ref/compute/?expanded=list-flavors-detail,list-flavors-with-details-detail,list-hosts-detail#hosts-os-hosts-deprecated