yao 0.13.4 → 0.16.0

data/lib/yao/resources/security_group_rule.rb

@@ -3,6 +3,8 @@ module Yao::Resources
   class SecurityGroupRule < Base
     friendly_attributes :ethertype
 
+    # @param _name [Symbol]
+    # @param _guard_name [Symbol]
     def self.define_attribute_with_guard(_name, _guard_name)
       name = _name.to_s
       guard_name = _guard_name.to_s
@@ -16,10 +18,15 @@ module Yao::Resources
     define_attribute_with_guard :protocol, :ip_protocol
     define_attribute_with_guard :security_group_id, :parent_group_id
 
+    # @return [Yao::Resources::SecurityGroup]
     def security_group
       SecurityGroup.find(security_group_id)
     end
 
+    # if port_range_max == port_range_min
+    # @return [Integer]
+    # else
+    # @return [Range]
     def port
       if port_range_max == port_range_min
         port_range_max
@@ -28,6 +35,7 @@ module Yao::Resources
       end
     end
 
+    # @return [String]
     def remote_ip_cidr
       if cidr = self["remote_ip_prefix"]
         cidr
@@ -36,10 +44,12 @@ module Yao::Resources
       end
     end
 
+    # @return [Range]
     def port_range
       port_range_max..port_range_min
     end
 
+    # @return [Yao::Resources::SecurityGroup]
     def remote_group
       return nil if self["remote_group_id"].nil? && (self["group"].nil? || self["group"].empty?)
 

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
@@ -25,34 +25,54 @@ module Yao::Resources
     self.resources_name = "servers"
     self.resources_detail_available = true
 
+    # @param counter_name [String]
+    # @param query [Hash]
+    # @return [Array<Yao::OldSample>]
     def old_samples(counter_name: nil, query: {})
       Yao::OldSample.list(counter_name, query).select{|os| os.resource_metadata["instance_id"] == id}
     end
 
+    # @param id [String]
+    # @return [Hash]
     def self.start(id)
       action(id, "os-start" => nil)
     end
 
+    # @param id [String]
+    # @return [Hash]
     def self.shutoff(id)
       action(id, "os-stop" => nil)
     end
 
+    # @param id [String]
+    # @return [Hash]
     def self.reboot(id)
       action(id,"reboot" => { "type" => "HARD" })
     end
 
+    # @param id [String]
+    # @param flavor_id [String]
+    # @return [Hash]
     def self.resize(id, flavor_id)
       action(id,"resize" => { "flavorRef" => flavor_id })
     end
 
+    # @param id [String]
+    # @param sg_name [String]
+    # @return [Hash]
     def self.add_security_group(id, sg_name)
       action(id, {"addSecurityGroup": {"name": sg_name}})
     end
 
+    # @param id [String]
+    # @param sg_name [String]
+    # @return [Hash]
     def self.remove_security_group(id, sg_name)
       action(id, {"removeSecurityGroup": {"name": sg_name}})
     end
 
+    # @param id [String]
+    # @return [Hash]
     def self.get_vnc_console(id)
       response = action(id, {"os-getVNCConsole": {"type": "novnc"}})
       response.dig("console", "url")

data/lib/yao/resources/server_group.rb

@@ -6,4 +6,4 @@ module Yao::Resources
     self.resource_name  = "server_group"
     self.resources_name = "os-server-groups"
   end
-end
+end

data/lib/yao/resources/server_usage_associationable.rb

@@ -0,0 +1,12 @@
+module Yao::Resources
+  module ServerUsageAssociationable
+    # @param opt [Hash]
+    # @return [Hash]
+    def server_usage(params = {})
+      path = "./os-simple-tenant-usage/#{id}"
+      client = Yao.default_client.pool['compute']
+      res = client.get(path, params, {"Accept" => "application/json"})
+      res.body["tenant_usage"]
+    end
+  end
+end

data/lib/yao/resources/subnet.rb

@@ -2,11 +2,12 @@ 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
 
+    # @return [Array<Range>]
     def allocation_pools
       self["allocation_pools"].map do |pool|
         pool["start"]..pool["end"]

data/lib/yao/resources/tenant.rb

@@ -1,5 +1,7 @@
 module Yao::Resources
   class Tenant < Base
+    include ServerUsageAssociationable
+
     friendly_attributes :id, :name, :description, :enabled
 
     self.service        = "identity"
@@ -8,22 +10,31 @@ module Yao::Resources
     self.admin          = true
     self.return_single_on_querying = true
 
+    # @return [Yao::Resources::Server]
     def servers
       @servers ||= Yao::Server.list(all_tenants: 1, project_id: id)
     end
 
+    # @return [Yao::Resources::Meter]
     def meters
       @meters ||= Yao::Meter.list({'q.field' => 'project_id', 'q.op' => 'eq', 'q.value' => id})
     end
 
+    # @return [Yao::Resources::Port]
     def ports
       @ports ||= Yao::Port.list(tenant_id: id)
     end
 
+    # @return [Array<Yao::Resources::Meter>]
     def meters_by_name(meter_name)
       meters.select{|m| m.name == meter_name}
     end
 
+    # @return [Yao::Resources::RoleAssignment]
+    def role_assignment
+      Yao::RoleAssignment.get(tenant: id)
+    end
+
     class << self
       def accessible
         as_member { self.list }

data/lib/yao/resources/user.rb

@@ -1,6 +1,6 @@
 module Yao::Resources
   class User < Base
-    friendly_attributes :name, :email, :enabled, :id
+    friendly_attributes :name, :email, :enabled
 
     alias enabled? enabled
 
@@ -9,12 +9,19 @@ module Yao::Resources
     self.resources_name = "users"
     self.admin          = true
 
+    # @return [Yao::Resources::RoleAssignment]
+    def role_assignment
+      Yao::RoleAssignment.get(user: self)
+    end
+
     class << self
+      # @return [Bool]
       def return_single_on_querying
         api_verion_v2?
       end
 
       private
+      # @return [Bool]
       def api_verion_v2?
         client.url_prefix.to_s.match?(/v2\.0/)
       end

data/lib/yao/resources/volume.rb

@@ -1,12 +1,25 @@
+require 'yao/resources/volume_action'
+
 module Yao::Resources
   class Volume < Base
-    friendly_attributes :name, :size, :volume_type
+    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
 
+    map_attribute_to_attribute 'os-vol-host-attr:host' => :host
     map_attribute_to_attribute 'os-vol-tenant-attr:tenant_id' => :tenant_id
 
     self.service        = "volumev3"
     self.resource_name  = "volume"
     self.resources_name = "volumes"
     self.resources_detail_available = true
+
+    def status=(s)
+      self.class.set_status(self.id, s)
+      self['status'] = s
+    end
+
+    extend VolumeAction
   end
 end

data/lib/yao/resources/volume_action.rb

@@ -0,0 +1,13 @@
+require 'yao/resources/action'
+
+module Yao::Resources
+  module VolumeAction
+    include Action
+
+    def set_status(id, status)
+      action(id, 'os-reset_status' => {
+        'status' => status,
+      })
+    end
+  end
+end

data/lib/yao/resources.rb

@@ -1,9 +1,10 @@
 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"
 
     autoload :Server,                    "yao/resources/server"
     autoload :ServerGroup,               "yao/resources/server_group"
@@ -42,6 +43,8 @@ module Yao
     autoload :Sample,                    "yao/resources/sample"
   end
 
+  # @param name [String]
+  # @return [object]
   def self.const_missing(name)
     new_klass = Yao::Resources.const_get(name)
     Yao.const_set(name, new_klass)

data/lib/yao/token.rb

@@ -2,6 +2,7 @@ require 'yao/client'
 
 module Yao
   class Token
+
     def self.issue(cli, auth_info)
       t = new(auth_info)
       t.refresh(cli)

data/lib/yao/version.rb

@@ -1,3 +1,3 @@
 module Yao
-  VERSION = "0.13.4"
+  VERSION = "0.16.0"
 end

data/test/yao/resources/test_base.rb

@@ -12,4 +12,36 @@ class TestResourceBase < TestYaoResource
     base.class.friendly_attributes(:name)
     assert_equal("bar", base.name)
   end
+
+  def test_map_attribute_to_resource
+    base = Yao::Resources::Base.new("string" => "hoge")
+    base.class.map_attribute_to_resource string: String
+    assert_equal("hoge", base.string)
+
+    base = Yao::Resources::Base.new({"empty" => ""})
+    base.class.map_attribute_to_resource empty: NilClass
+    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

data/test/yao/resources/test_floating_ip.rb

@@ -82,14 +82,14 @@ class TestFloatingIP < TestYaoResource
     assert_requested(stub)
   end
 
-  def test_tenant
+  def test_project
 
-    stub = stub_request(:get, "https://example.com:12345/tenants/0123456789abcdef0123456789abcdef")
+    stub = stub_request(:get, "https://example.com:12345/projects/0123456789abcdef0123456789abcdef")
       .to_return(
          status: 200,
          body: <<-JSON,
         {
-          "tenant": {
+          "project": {
             "id": "0123456789abcdef0123456789abcdef"
           }
         }
@@ -102,8 +102,8 @@ class TestFloatingIP < TestYaoResource
       "tenant_id"  => "0123456789abcdef0123456789abcdef",
     )
 
-    assert_instance_of(Yao::Tenant, fip.tenant)
-    assert_instance_of(Yao::Tenant, fip.project)
+    assert_instance_of(Yao::Project, fip.tenant)
+    assert_instance_of(Yao::Project, fip.project)
     assert_equal('0123456789abcdef0123456789abcdef', fip.tenant.id)
 
     assert_requested(stub)

data/test/yao/resources/test_image.rb

@@ -41,6 +41,11 @@ class TestImage < TestYaoResource
 
   end
 
+  def test_empty_image
+    image = Yao::Server.new("image"=>"").image
+    assert_equal(image, nil)
+  end
+
   def test_to_hash
     server = Yao::Resources::Server.new(
       "OS-DCF:diskConfig" => "AUTO",

data/test/yao/resources/test_loadbalancer_pool.rb

@@ -13,7 +13,14 @@ class TestLoadBalancerPool < TestYaoResource
         "type" => "SOURCE_IP"
       },
       "operating_status" => "ONLINE",
-      "name" => "round_robin_pool"
+      "name" => "round_robin_pool",
+      "members" => [
+        {"id" => "957a1ace-1bd2-449b-8455-820b6e4b63f3"},
+      ],
+      "listeners" => [
+        {"id" => "023f2e34-7806-443b-bfae-16c324569a3d"}
+      ],
+      "healthmonitor_id" => "8ed3c5ac-6efa-420c-bedb-99ba14e58db5",
     }
 
     pool = Yao::Resources::LoadBalancerPool.new(params)
@@ -30,5 +37,143 @@ class TestLoadBalancerPool < TestYaoResource
     }, pool.session_persistence)
     assert_equal("ONLINE", pool.operating_status)
     assert_equal("round_robin_pool", pool.name)
+
+    # https://docs.openstack.org/api-ref/load-balancer/v2/?expanded=show-member-details-detail#show-member-details
+    stub = stub_request(:get, "http://endpoint.example.com:9876/v2.0/lbaas/pools//members/957a1ace-1bd2-449b-8455-820b6e4b63f3")
+          .to_return(
+            status: 200,
+            body: <<-JSON,
+            {
+              "member": {
+                "monitor_port": 8080,
+                "project_id": "e3cd678b11784734bc366148aa37580e",
+                "name": "web-server-1",
+                "weight": 20,
+                "backup": false,
+                "admin_state_up": true,
+                "subnet_id": "bbb35f84-35cc-4b2f-84c2-a6a29bba68aa",
+                "created_at": "2017-05-11T17:21:34",
+                "provisioning_status": "ACTIVE",
+                "monitor_address": null,
+                "updated_at": "2017-05-11T17:21:37",
+                "address": "192.0.2.16",
+                "protocol_port": 80,
+                "id": "957a1ace-1bd2-449b-8455-820b6e4b63f3",
+                "operating_status": "NO_MONITOR",
+                "tags": ["test_tag"]
+              }
+            }
+            JSON
+            headers: {'Content-Type' => 'application/json'}
+          )
+
+    assert_instance_of(Yao::LoadBalancerPoolMember, pool.members.first)
+    assert_equal("957a1ace-1bd2-449b-8455-820b6e4b63f3", pool.members.first.id)
+    assert_equal("web-server-1", pool.members.first.name)
+    assert_requested(stub)
+
+    # https://docs.openstack.org/api-ref/load-balancer/v2/?expanded=show-member-details-detail,show-listener-details-detail,show-pool-details-detail#show-listener-details
+    stub = stub_request(:get, "http://endpoint.example.com:9876/v2.0/lbaas/listeners/023f2e34-7806-443b-bfae-16c324569a3d")
+          .to_return(
+            status: 200,
+            body: <<-JSON,
+            {
+              "listener": {
+                "description": "A great TLS listener",
+                "admin_state_up": true,
+                "project_id": "e3cd678b11784734bc366148aa37580e",
+                "protocol": "TERMINATED_HTTPS",
+                "protocol_port": 443,
+                "provisioning_status": "ACTIVE",
+                "default_tls_container_ref": "http://198.51.100.10:9311/v1/containers/a570068c-d295-4780-91d4-3046a325db51",
+                "loadbalancers": [
+                  {
+                    "id": "607226db-27ef-4d41-ae89-f2a800e9c2db"
+                  }
+                ],
+                "insert_headers": {
+                  "X-Forwarded-Port": "true",
+                  "X-Forwarded-For": "true"
+                },
+                "created_at": "2017-02-28T00:42:44",
+                "updated_at": "2017-02-28T00:44:30",
+                "id": "023f2e34-7806-443b-bfae-16c324569a3d",
+                "operating_status": "ONLINE",
+                "default_pool_id": "ddb2b28f-89e9-45d3-a329-a359c3e39e4a",
+                "sni_container_refs": [
+                  "http://198.51.100.10:9311/v1/containers/a570068c-d295-4780-91d4-3046a325db51",
+                  "http://198.51.100.10:9311/v1/containers/aaebb31e-7761-4826-8cb4-2b829caca3ee"
+                ],
+                "l7policies": [
+                  {
+                    "id": "5e618272-339d-4a80-8d14-dbc093091bb1"
+                  }
+                ],
+                "name": "great_tls_listener",
+                "timeout_client_data": 50000,
+                "timeout_member_connect": 5000,
+                "timeout_member_data": 50000,
+                "timeout_tcp_inspect": 0,
+                "tags": ["test_tag"],
+                "client_ca_tls_container_ref": "http://198.51.100.10:9311/v1/containers/35649991-49f3-4625-81ce-2465fe8932e5",
+                "client_authentication": "MANDATORY",
+                "client_crl_container_ref": "http://198.51.100.10:9311/v1/containers/e222b065-b93b-4e2a-9a02-804b7a118c3c",
+                "allowed_cidrs": [
+                  "192.0.2.0/24",
+                  "198.51.100.0/24"
+                ],
+                "tls_ciphers": "ECDHE-RSA-AES256-GCM-SHA384:ECDHE-RSA-AES128-GCM-SHA256",
+                "tls_versions": ["TLSv1.2", "TLSv1.3"],
+                "alpn_protocols": ["http/1.1", "http/1.0"]
+              }
+            }
+            JSON
+            headers: {'Content-Type' => 'application/json'}
+          )
+    assert_instance_of(Yao::LoadBalancerListener, pool.listeners.first)
+    assert_equal("023f2e34-7806-443b-bfae-16c324569a3d", pool.listeners.first.id)
+    assert_equal("great_tls_listener", pool.listeners.first.name)
+    assert_requested(stub)
+
+    # https://docs.openstack.org/api-ref/load-balancer/v2/?expanded=show-member-details-detail,show-listener-details-detail,show-pool-details-detail,show-health-monitor-details-detail#show-health-monitor-details
+    stub = stub_request(:get, "http://endpoint.example.com:9876/v2.0/lbaas/healthmonitors/8ed3c5ac-6efa-420c-bedb-99ba14e58db5")
+          .to_return(
+            status: 200,
+            body: <<-JSON,
+            {
+              "healthmonitor": {
+                "project_id": "e3cd678b11784734bc366148aa37580e",
+                "name": "super-pool-health-monitor",
+                "admin_state_up": true,
+                "pools": [
+                  {
+                    "id": "4029d267-3983-4224-a3d0-afb3fe16a2cd"
+                  }
+                ],
+                "created_at": "2017-05-11T23:53:47",
+                "provisioning_status": "ACTIVE",
+                "updated_at": "2017-05-11T23:53:47",
+                "delay": 10,
+                "expected_codes": "200",
+                "max_retries": 1,
+                "http_method": "GET",
+                "timeout": 5,
+                "max_retries_down": 3,
+                "url_path": "/",
+                "type": "HTTP",
+                "id": "8ed3c5ac-6efa-420c-bedb-99ba14e58db5",
+                "operating_status": "ONLINE",
+                "tags": ["test_tag"],
+                "http_version": 1.0,
+                "domain_name": null
+              }
+            }
+            JSON
+            headers: {'Content-Type' => 'application/json'}
+          )
+    assert_instance_of(Yao::LoadBalancerHealthMonitor, pool.healthmonitor)
+    assert_equal("8ed3c5ac-6efa-420c-bedb-99ba14e58db5", pool.healthmonitor.id)
+    assert_equal("super-pool-health-monitor", pool.healthmonitor.name)
+    assert_requested(stub)
   end
 end