yao 0.13.1 → 0.14.0

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

@@ -10,11 +10,13 @@ module Yao::Resources
     self.admin          = true
 
     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.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.1"
+  VERSION = "0.14.0"
 end

data/test/support/restfully_accesible_stub.rb

@@ -41,6 +41,6 @@ module RestfullyAccessibleStub
   end
 
   def request_headers
-    {'Accept'=>'application/json', 'Accept-Encoding'=>'gzip;q=1.0,deflate;q=0.6,identity;q=0.3', 'User-Agent'=>"Faraday v#{Faraday::VERSION}"}
+    {'Accept'=>'application/json', 'Accept-Encoding'=>'gzip;q=1.0,deflate;q=0.6,identity;q=0.3', 'User-Agent'=>"Yao/#{Yao::VERSION} Faraday/#{Faraday::VERSION}"}
   end
 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_hypervisor.rb

@@ -80,7 +80,7 @@ class TestHypervisor < TestYaoResource
 
   def test_list
     stub = stub_request(:get, "https://example.com:12345/os-hypervisors/detail")
-      .with(headers: {'Accept'=>'application/json', 'Accept-Encoding'=>'gzip;q=1.0,deflate;q=0.6,identity;q=0.3', 'User-Agent'=>"Faraday v#{Faraday::VERSION}"})
+      .with(headers: {'Accept'=>'application/json', 'Accept-Encoding'=>'gzip;q=1.0,deflate;q=0.6,identity;q=0.3', 'User-Agent'=>"Yao/#{Yao::VERSION} Faraday/#{Faraday::VERSION}"})
       .to_return(
         status: 200,
         body: <<-JSON,
@@ -105,7 +105,7 @@ class TestHypervisor < TestYaoResource
 
   def test_statistics
     stub = stub_request(:get, "https://example.com:12345/os-hypervisors/statistics")
-      .with(headers: {'Accept'=>'application/json', 'Accept-Encoding'=>'gzip;q=1.0,deflate;q=0.6,identity;q=0.3', 'User-Agent'=>"Faraday v#{Faraday::VERSION}"})
+      .with(headers: {'Accept'=>'application/json', 'Accept-Encoding'=>'gzip;q=1.0,deflate;q=0.6,identity;q=0.3', 'User-Agent'=>"Yao/#{Yao::VERSION} Faraday/#{Faraday::VERSION}"})
       .to_return(
         status: 200,
         body: <<-JSON,
@@ -137,7 +137,7 @@ class TestHypervisor < TestYaoResource
 
   def test_uptime
     stub = stub_request(:get, "https://example.com:12345/os-hypervisors/1/uptime")
-      .with(headers: {'Accept'=>'application/json', 'Accept-Encoding'=>'gzip;q=1.0,deflate;q=0.6,identity;q=0.3', 'User-Agent'=>"Faraday v#{Faraday::VERSION}"})
+      .with(headers: {'Accept'=>'application/json', 'Accept-Encoding'=>'gzip;q=1.0,deflate;q=0.6,identity;q=0.3', 'User-Agent'=>"Yao/#{Yao::VERSION} Faraday/#{Faraday::VERSION}"})
       .to_return(
         status: 200,
         body: <<-JSON,

data/test/yao/resources/test_image.rb

@@ -41,11 +41,102 @@ class TestImage < TestYaoResource
 
   end
 
-  def test_resource_from_json
+  def test_empty_image
+    image = Yao::Server.new("image"=>"").image
+    assert_equal(image, nil)
+  end
 
-    image = Yao::Resources::Image.send(:resource_from_json, @@params)
-    check_image(image)
-    
+  def test_to_hash
+    server = Yao::Resources::Server.new(
+      "OS-DCF:diskConfig" => "AUTO",
+      "OS-EXT-AZ:availability_zone" => "nova",
+      "OS-EXT-SRV-ATTR:host" => "compute",
+      "OS-EXT-SRV-ATTR:hostname" => "new-server-test",
+      "OS-EXT-SRV-ATTR:hypervisor_hostname" => "fake-mini",
+      "OS-EXT-SRV-ATTR:instance_name" => "instance-00000001",
+      "OS-EXT-SRV-ATTR:kernel_id" => "",
+      "OS-EXT-SRV-ATTR:launch_index" => 0,
+      "OS-EXT-SRV-ATTR:ramdisk_id" => "",
+      "OS-EXT-SRV-ATTR:reservation_id" => "r-l0i0clt2",
+      "OS-EXT-SRV-ATTR:root_device_name" => "/dev/sda",
+      "OS-EXT-SRV-ATTR:user_data" => "IyEvYmluL2Jhc2gKL2Jpbi9zdQplY2hvICJJIGFtIGluIHlvdSEiCg==",
+      "OS-EXT-STS:power_state" => 1,
+      "OS-EXT-STS:task_state" => nil,
+      "OS-EXT-STS:vm_state" => "active",
+      "OS-SRV-USG:launched_at" => "2019-04-23T15:19:15.317839",
+      "OS-SRV-USG:terminated_at" => nil,
+      "accessIPv4" => "1.2.3.4",
+      "accessIPv6" => "80fe::",
+      "addresses" => {
+        "private" => [
+          {
+            "OS-EXT-IPS-MAC:mac_addr" => "aa:bb:cc:dd:ee:ff",
+            "OS-EXT-IPS:type" => "fixed",
+            "addr" => "192.168.0.3",
+            "version" => 4
+          }
+        ]
+      },
+      "config_drive" => "",
+      "created" => "2019-04-23T15:19:14Z",
+      "description" => nil,
+      "flavor" => {
+        "disk" => 1,
+        "ephemeral" => 0,
+        "extra_specs" => {},
+        "original_name" => "m1.tiny",
+        "ram" => 512,
+        "swap" => 0,
+        "vcpus" => 1
+      },
+      "hostId" => "2091634baaccdc4c5a1d57069c833e402921df696b7f970791b12ec6",
+      "host_status" => "UP",
+      "id" => "2ce4c5b3-2866-4972-93ce-77a2ea46a7f9",
+      "image" => {
+        "id" => "70a599e0-31e7-49b7-b260-868f441e862b",
+        "links" => [
+          {
+            "href" => "http://openstack.example.com/6f70656e737461636b20342065766572/images/70a599e0-31e7-49b7-b260-868f441e862b",
+            "rel" => "bookmark"
+          }
+        ]
+      },
+      "key_name" => nil,
+      "links" => [
+        {
+          "href" => "http://openstack.example.com/v2.1/6f70656e737461636b20342065766572/servers/2ce4c5b3-2866-4972-93ce-77a2ea46a7f9",
+          "rel" => "self"
+        },
+        {
+          "href" => "http://openstack.example.com/6f70656e737461636b20342065766572/servers/2ce4c5b3-2866-4972-93ce-77a2ea46a7f9",
+          "rel" => "bookmark"
+        }
+      ],
+      "locked" => true,
+      "locked_reason" => "I don't want to work",
+      "metadata" => {
+        "My Server Name" => "Apache1"
+      },
+      "name" => "new-server-test",
+      "os-extended-volumes:volumes_attached" => [],
+      "progress" => 0,
+      "security_groups" => [
+        {
+          "name" => "default"
+        }
+      ],
+      "status" => "ACTIVE",
+      "tags" => [],
+      "tenant_id" => "6f70656e737461636b20342065766572",
+      "trusted_image_certificates" => nil,
+      "updated" => "2019-04-23T15:19:15Z",
+      "user_id" => "fake"
+    )
+
+    assert_equal(server.image.to_hash, server['image__Yao::Resources::Image'].to_hash)
+
+    image = Yao::Resources::Image.new(@@params)
+    assert_equal(image.to_hash, @@params)
   end
 
   private

data/test/yao/resources/test_project.rb

@@ -254,4 +254,23 @@ 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
+end

data/test/yao/resources/test_server.rb

@@ -162,6 +162,46 @@ class TestServer < TestYaoResource
     assert_requested(stub)
   end
 
+  def test_paging
+    stub = stub_request(:get, "https://example.com:12345/servers/detail")
+      .to_return(
+        status: 200,
+        body: <<-JSON,
+        {
+          "servers_links":[
+             {
+                "href":"https://example.com:12345/servers/detail",
+                "rel":"next"
+             }
+          ],
+          "servers": [{
+            "id": "dummy1"
+          }]
+        }
+        JSON
+        headers: {'Content-Type' => 'application/json'}
+      ).times(1).then
+      .to_return(
+        status: 200,
+        body: <<-JSON,
+        {
+          "servers": [{
+            "id": "dummy2"
+          }]
+        }
+        JSON
+        headers: {'Content-Type' => 'application/json'}
+      ).times(1)
+
+    servers = Yao::Server.list
+    assert_instance_of(Array, servers)
+    assert_instance_of(Yao::Server, servers.first)
+    assert_equal('dummy1', servers.first.id)
+    assert_equal('dummy2', servers.last.id)
+
+    assert_requested(stub, times: 2)
+  end
+
   def test_list_detail
     assert_equal(Yao::Server.method(:list), Yao::Server.method(:list_detail))
   end

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

@@ -14,6 +14,7 @@ class TestClient < Test::Unit::TestCase
     handlers = [
       Faraday::Request::Accept,
       Faraday::Request::UrlEncoded,
+      Faraday::Request::UserAgent,
       Faraday::Request::ReadOnly,
       Faraday::Response::OSErrorDetector,
       FaradayMiddleware::ParseJson
@@ -28,6 +29,7 @@ class TestClient < Test::Unit::TestCase
     handlers = [
       Faraday::Request::Accept,
       Faraday::Request::UrlEncoded,
+      Faraday::Request::UserAgent,
       Faraday::Request::OSToken,
       Faraday::Request::ReadOnly,
       Faraday::Response::OSErrorDetector,
@@ -45,10 +47,10 @@ class TestClient < Test::Unit::TestCase
     handlers = [
       Faraday::Request::Accept,
       Faraday::Request::UrlEncoded,
+      Faraday::Request::UserAgent,
       Faraday::Request::ReadOnly,
       Faraday::Response::OSErrorDetector,
       FaradayMiddleware::ParseJson,
-      Faraday::Response::Logger,
       Faraday::Response::OSDumper
     ]
     assert { cli.builder.handlers == handlers }
@@ -61,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" }
@@ -68,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

@@ -18,6 +18,7 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   spec.add_dependency "json"
-  spec.add_dependency "faraday", "~> 1.0.1"
+  spec.add_dependency "deep_merge"
+  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.1
+  version: 0.14.0
 platform: ruby
 authors:
 - Uchio, KONDO
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-04-22 00:00:00.000000000 Z
+date: 2021-12-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
@@ -24,20 +24,34 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: deep_merge
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: faraday
   requirement: !ruby/object:Gem::Requirement
     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
@@ -60,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"
@@ -117,6 +132,7 @@ 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
@@ -184,7 +200,7 @@ homepage: https://github.com/yaocloud/yao
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -199,8 +215,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
-signing_key: 
+rubygems_version: 3.2.32
+signing_key:
 specification_version: 4
 summary: Yet Another OpenStack API Wrapper that rocks!!
 test_files: