yao 0.13.2 → 0.15.0

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

@@ -7,6 +7,7 @@ module Yao
         base.friendly_attributes :tenant_id
       end
 
+      # @return [Yao::Resources::Tenant]
       def tenant
         @tenant ||= Yao::Tenant.find(project_id || tenant_id)
       end

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,23 @@
+require 'yao/resources/volume_action'
+
 module Yao::Resources
   class Volume < Base
-    friendly_attributes :name, :size, :volume_type
+    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

@@ -4,6 +4,7 @@ module Yao
     require "yao/resources/tenant_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.2"
+  VERSION = "0.15.0"
 end

data/test/yao/resources/test_base.rb

@@ -12,4 +12,15 @@ 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
+
 end

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_project.rb

@@ -1,9 +1,4 @@
 class TestProject < TestYaoResource
-  def setup
-    super
-    Yao.default_client.admin_pool["identity"] = Yao::Client.gen_client("https://example.com:12345/v2.0")
-  end
-
   # https://docs.openstack.org/api-ref/identity/v3/?expanded=list-projects-detail#projects
   def test_project
     params = {
@@ -254,4 +249,48 @@ class TestProject < TestYaoResource
     assert_instance_of(Array, project.servers)
     assert_requested(stub)
   end
-end
+
+  def test_server_usage
+    stub = stub_request(:get, "https://example.com:12345/os-simple-tenant-usage/0123456789abcdef0123456789abcdef")
+      .to_return(
+         status: 200,
+         body: <<-JSON,
+        {
+            "tenant_usage": {
+                "total_memory_mb_usage": 1024
+            }
+        }
+        JSON
+        headers: {'Content-Type' => 'application/json'}
+      )
+
+    project = Yao::Project::new("id" => "0123456789abcdef0123456789abcdef")
+    usage = project.server_usage
+    assert_equal(1024, usage["total_memory_mb_usage"])
+  end
+
+  def test_role_assignment
+    project_id = 'aaaa166533fd49f3b11b1cdce2430000'
+    stub = stub_request(:get, "https://example.com:12345/role_assignments?scope.project.id=#{project_id}").
+      to_return(
+        status: 200,
+        body: <<-JSON,
+        {
+          "role_assignments": [{
+            "scope": {
+              "project": {
+                "id": "aaaa166533fd49f3b11b1cdce2430000"
+              }
+            }
+          }]
+        }
+        JSON
+        headers: {'Content-Type' => 'application/json'}
+      )
+
+    project = Yao::Project.new('id' => project_id)
+    role_assignment = project.role_assignment
+    assert_equal('aaaa166533fd49f3b11b1cdce2430000', role_assignment.first.scope['project']['id'])
+    assert_requested(stub)
+  end
+end

data/test/yao/resources/test_role_assignment.rb

@@ -32,8 +32,105 @@ class TestRoleAssignment < TestYaoResource
     assert_equal("313233", role_assignment.user.id)
   end
 
+  def test_list
+    stub = stub_request(:get, "https://example.com:12345/role_assignments").
+      to_return(
+        status: 200,
+        body: <<-JSON,
+        {
+          "role_assignments": [{
+            "scope": {
+              "project": {
+                "id": "aaaa166533fd49f3b11b1cdce2430000"
+              }
+            }
+          }]
+        }
+        JSON
+        headers: {'Content-Type' => 'application/json'}
+      )
+    role_assignment = Yao::RoleAssignment.list
+    assert_equal('aaaa166533fd49f3b11b1cdce2430000', role_assignment.first.scope['project']['id'])
+    assert_requested(stub)
+  end
+
+  def test_get_user
+    user_id = '123456'
+    stub = stub_request(:get, "https://example.com:12345/role_assignments?user.id=#{user_id}").
+      to_return(
+        status: 200,
+        body: <<-JSON,
+        {
+          "role_assignments": [{
+            "scope": {
+              "project": {
+                "id": "aaaa166533fd49f3b11b1cdce2430000"
+              }
+            }
+          }]
+        }
+        JSON
+        headers: {'Content-Type' => 'application/json'}
+      )
+
+    user = Yao::User.new('id' => user_id)
+    role_assignment = Yao::RoleAssignment.get(user: user)
+    assert_equal('aaaa166533fd49f3b11b1cdce2430000', role_assignment.first.scope['project']['id'])
+    assert_requested(stub)
+  end
+
+  def test_get_project
+    project_id = 'aaaa166533fd49f3b11b1cdce2430000'
+    stub = stub_request(:get, "https://example.com:12345/role_assignments?scope.project.id=#{project_id}").
+      to_return(
+        status: 200,
+        body: <<-JSON,
+        {
+          "role_assignments": [{
+            "scope": {
+              "project": {
+                "id": "aaaa166533fd49f3b11b1cdce2430000"
+              }
+            }
+          }]
+        }
+        JSON
+        headers: {'Content-Type' => 'application/json'}
+      )
+
+    project = Yao::Project.new('id' => project_id)
+    role_assignment = Yao::RoleAssignment.get(project: project)
+    assert_equal('aaaa166533fd49f3b11b1cdce2430000', role_assignment.first.scope['project']['id'])
+    assert_requested(stub)
+  end
+
+  def test_get_tenant
+    tenant_id = 'aaaa166533fd49f3b11b1cdce2430000'
+    stub = stub_request(:get, "https://example.com:12345/role_assignments?scope.project.id=#{tenant_id}").
+      to_return(
+        status: 200,
+        body: <<-JSON,
+        {
+          "role_assignments": [{
+            "scope": {
+              "project": {
+                "id": "aaaa166533fd49f3b11b1cdce2430000"
+              }
+            }
+          }]
+        }
+        JSON
+        headers: {'Content-Type' => 'application/json'}
+      )
+
+    tenant = Yao::Project.new('id' => tenant_id)
+    role_assignment = Yao::RoleAssignment.get(tenant: tenant)
+    assert_equal('aaaa166533fd49f3b11b1cdce2430000', role_assignment.first.scope['project']['id'])
+    assert_requested(stub)
+  end
+
   def test_project
-    stub = stub_request(:get, "http://example.com:12345/tenants/456789").
+    stub = stub_request(:get, "https://example.com:12345/tenants/456789").
       to_return(
         status: 200,
         body: <<-JSON,

data/test/yao/resources/test_server_group.rb

@@ -20,4 +20,4 @@ class TestServerGroup < TestYaoResource
     assert_equal("6f70656e737461636b20342065766572", sg.project_id)
     assert_equal("fake", sg.user_id)
   end
-end
+end

data/test/yao/resources/test_user.rb

@@ -1,16 +1,43 @@
 class TestUser < TestYaoResource
-  def test_sg_attributes
+  def test_user
     params = {
+      "id" => '1234567890',
       "name" => "test_user",
       "email" => "test-user@example.com",
       "password" => "passw0rd"
     }
 
     user = Yao::User.new(params)
+    assert_equal("1234567890", user.id)
     assert_equal("test_user", user.name)
     assert_equal("test-user@example.com", user.email)
   end
 
+  def test_role_assignment
+    user_id = '123456'
+    stub = stub_request(:get, "https://example.com:12345/role_assignments?user.id=#{user_id}").
+      to_return(
+        status: 200,
+        body: <<-JSON,
+        {
+          "role_assignments": [{
+            "scope": {
+              "project": {
+                "id": "aaaa166533fd49f3b11b1cdce2430000"
+              }
+            }
+          }]
+        }
+        JSON
+        headers: {'Content-Type' => 'application/json'}
+      )
+
+    user = Yao::User.new('id' => user_id)
+    role_assignment = user.role_assignment
+    assert_equal('aaaa166533fd49f3b11b1cdce2430000', role_assignment.first.scope['project']['id'])
+    assert_requested(stub)
+  end
+
   sub_test_case 'with keystone v2.0' do
     def setup
       super

data/test/yao/resources/test_volume.rb

@@ -1,13 +1,35 @@
 class TestVolume < TestYaoResource
   def test_volume
     params = {
+        'attachments' => [],
+        'availability_zone' => 'test',
+        'bootable' => true,
+        'encrypted' => false,
+        'metadata' => {},
+        'multiattach' => false,
         'name' => 'cinder',
-        'size' => 10
+        'replication_status' => 'disabled',
+        'size' => 10,
+        'snapshot_id' => nil,
+        'status' => 'available',
+        'user_id' => 'aaaa166533fd49f3b11b1cdce2430000',
+        'volume_type' => 'test'
     }
 
     volume = Yao::Volume.new(params)
+    assert_equal(volume.attachments, [])
+    assert_equal(volume.availability_zone, 'test')
+    assert_equal(volume.bootable, true)
+    assert_equal(volume.encrypted, false)
+    assert_equal(volume.metadata, {})
+    assert_equal(volume.multiattach, false)
     assert_equal(volume.name, 'cinder')
+    assert_equal(volume.replication_status, 'disabled')
     assert_equal(volume.size, 10)
+    assert_equal(volume.snapshot_id, nil)
+    assert_equal(volume.user_id, 'aaaa166533fd49f3b11b1cdce2430000')
+    assert_equal(volume.volume_type, 'test')
+    assert_equal(volume.type, 'test')
   end
 
   def test_list
@@ -39,4 +61,41 @@ class TestVolume < TestYaoResource
   def test_list_detail
     assert_equal(Yao::Volume.method(:list), Yao::Volume.method(:list_detail))
   end
+
+  def stub_action_request(id, body)
+    # https://docs.openstack.org/api-ref/block-storage/v3/index.html?expanded=list-accessible-volumes-with-details-detail,reset-a-volume-s-statuses-detail#reset-a-volume-s-statuses
+    stub_request(:post, "https://example.com:12345/volumes/#{id}/action").
+      with(
+      body: body,
+      headers: {
+          'Accept'=>'application/json',
+          'Accept-Encoding'=>'gzip;q=1.0,deflate;q=0.6,identity;q=0.3',
+          'Content-Type'=>'application/json',
+          'User-Agent'=>"Yao/#{Yao::VERSION} Faraday/#{Faraday::VERSION}"
+      }).
+      to_return(
+        status: 202,
+        body: '',
+        headers: {'Content-Type' => 'application/json'}
+      )
+  end
+
+  def test_set_status
+    volume_id = '00000000-0000-0000-0000-000000000000'
+
+    stub = stub_action_request(volume_id, {'os-reset_status': {'status': 'error'}})
+    Yao::Volume.set_status(volume_id, 'error')
+    assert_requested(stub)
+  end
+
+  def test_set_status_on_instance
+    volume_id = '00000000-0000-0000-0000-000000000000'
+    stub = stub_action_request(volume_id, {'os-reset_status': {'status': 'error'}})
+    params = {
+      'id' => volume_id,
+    }
+    volume = Yao::Volume.new(params)
+    volume.status = 'error'
+    assert_requested(stub)
+  end
 end

data/test/yao/test_client.rb

@@ -51,7 +51,6 @@ class TestClient < Test::Unit::TestCase
       Faraday::Request::ReadOnly,
       Faraday::Response::OSErrorDetector,
       FaradayMiddleware::ParseJson,
-      Faraday::Response::Logger,
       Faraday::Response::OSDumper
     ]
     assert { cli.builder.handlers == handlers }
@@ -64,6 +63,7 @@ class TestClient < Test::Unit::TestCase
   end
 
   def test_cert_key
+    stub(Yao.config).ca_cert { File.expand_path("../../fixtures/dummy.pem", __FILE__) }
     stub(Yao.config).client_cert { File.expand_path("../../fixtures/dummy.pem", __FILE__) }
     stub(Yao.config).client_key  { File.expand_path("../../fixtures/dummy.key", __FILE__) }
     stub(OpenSSL::X509::Certificate).new { "DummyCert" }
@@ -71,6 +71,7 @@ class TestClient < Test::Unit::TestCase
 
     cli = Yao::Client.gen_client("http://cool-api.example.com:12345/v3.0")
     ssl = cli.ssl
+    assert { ssl[:ca_file] == File.expand_path("../../fixtures/dummy.pem", __FILE__) }
     assert { ssl[:client_cert] == "DummyCert" }
     assert { ssl[:client_key] == "DummyKey" }
   end

data/yao.gemspec

@@ -19,6 +19,6 @@ Gem::Specification.new do |spec|
 
   spec.add_dependency "json"
   spec.add_dependency "deep_merge"
-  spec.add_dependency "faraday", "~> 1.0.1"
+  spec.add_dependency "faraday", "~> 1.8.0"
   spec.add_dependency "faraday_middleware"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: yao
 version: !ruby/object:Gem::Version
-  version: 0.13.2
+  version: 0.15.0
 platform: ruby
 authors:
 - Uchio, KONDO
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-07-16 00:00:00.000000000 Z
+date: 2021-12-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
@@ -44,14 +44,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.0.1
+        version: 1.8.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.0.1
+        version: 1.8.0
 - !ruby/object:Gem::Dependency
   name: faraday_middleware
   requirement: !ruby/object:Gem::Requirement
@@ -74,6 +74,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".github/workflows/macos.yml"
+- ".github/workflows/rubocop.yml"
 - ".github/workflows/ubuntu-rvm.yml"
 - ".github/workflows/ubuntu.yml"
 - ".gitignore"
@@ -131,11 +132,13 @@ files:
 - lib/yao/resources/security_group_rule.rb
 - lib/yao/resources/server.rb
 - lib/yao/resources/server_group.rb
+- lib/yao/resources/server_usage_associationable.rb
 - lib/yao/resources/subnet.rb
 - lib/yao/resources/tenant.rb
 - lib/yao/resources/tenant_associationable.rb
 - lib/yao/resources/user.rb
 - lib/yao/resources/volume.rb
+- lib/yao/resources/volume_action.rb
 - lib/yao/resources/volume_type.rb
 - lib/yao/setup.rb
 - lib/yao/token.rb
@@ -213,7 +216,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.6
+rubygems_version: 3.2.32
 signing_key:
 specification_version: 4
 summary: Yet Another OpenStack API Wrapper that rocks!!