yao 0.19.0 → 0.20.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4995f4848c6b4d4fe74b39999648c0d1fe4cb473d086ea35017ad5d7611b07e3
-  data.tar.gz: 6fddaff2cd5e2118f7652559e7f3d3f36cceb03961c39c4e54d9cd940f6f733e
+  metadata.gz: 390b05f4ca044196755551231ee7f297900816c3742318bcc502b0376e70512a
+  data.tar.gz: 0a6bb49a598bb7667d488ce316280ed3504b5ab2c3e0f97da0019783a5f6a939
 SHA512:
-  metadata.gz: d3d72831ab303bac1453d3cfeda3e98f73554ebc3960d324cb4d701d4f15e59c0d90279c249e64bfc5b598e805b8f1b2647c21dbcf798845a38c8d7c9822ba76
-  data.tar.gz: 9c5b6ab144c089554c0c245ec93ecce895d14121447c7f70058cfa8e6e8682e71190a0c1d8776b89d6f0994183f40c8fd6df9de24e05a96ba162e88eac291c52
+  metadata.gz: 731688676c2b1b9d120ef76f67131de2b060a25b8e3c9cb0b1cbf138c6a58fe632220c7f02c87c58972ee51c40f0d902bca2e69d254cd9eecd427d3960a1740b
+  data.tar.gz: 63b4adfd5b841b0c4b99c262b8cc2235a980165c574db4b60dab8b39ba39b4b659b0d4761286e81a48e61f33a57821ba1167b1bd53ba35387fb6f1c0b37dc2cc

data/lib/yao/resources/compute_services.rb

@@ -21,6 +21,11 @@ module Yao::Resources
       status == 'disabled'
     end
 
+    # @return []
+    def delete
+      self.class.delete(id)
+    end
+
     class << self
       # @param host [String]
       # @param binary [String]

data/lib/yao/resources/network.rb

@@ -2,7 +2,7 @@ module Yao::Resources
   class Network < Base
     include ProjectAssociationable
 
-    friendly_attributes :name, :status, :shared, :subnets, :admin_state_up
+    friendly_attributes :name, :status, :shared, :admin_state_up
     map_attribute_to_attribute "provider:physical_network" => :physical_network
     map_attribute_to_attribute "provider:network_type"     => :type
     map_attribute_to_attribute "provider:segmentation_id"  => :segmentation_id
@@ -17,5 +17,10 @@ module Yao::Resources
     def ports
       @ports ||= Yao::Port.list(network_id: id)
     end
+
+    # @return [Array<Yao::Resources::Subnet>]
+    def subnets
+      @subnets ||= self['subnets'].map {|id| Yao::Subnet.new("id" => id)}
+    end
   end
 end

data/lib/yao/resources/networking_agents.rb

@@ -25,6 +25,11 @@ module Yao::Resources
       Time.parse(self["heartbeat_timestamp"])
     end
 
+    # @return []
+    def delete
+      self.class.delete(id)
+    end
+
     alias :state :admin_state_up
   end
 end

data/lib/yao/resources/restfully_accessible.rb

@@ -106,9 +106,8 @@ module Yao::Resources
         r = GET(url, query).body
         if r.is_a?(Hash)
           res.deep_merge!(r)
-          links = r.find {|k,_| k =~ /links/ }
-          if links && links.last.is_a?(Array) && next_link = links.last.find{|s| s["rel"] == "next" }
-            uri = URI.parse(next_link["href"])
+          if next_link = find_next_link(r)
+            uri = URI.parse(next_link)
             query = Hash[URI::decode_www_form(uri.query)] if uri.query
             next
           end
@@ -127,6 +126,16 @@ module Yao::Resources
     # @note .list is defined to keep backward compatibility and will be deprecated
     alias :list_detail :list
 
+    # @param response [Hash]
+    # @return [String]
+    def find_next_link(response)
+      if links = response.find {|k, v| k =~ /links/ && v.is_a?(Array) }&.last
+        links.find{|s| s["rel"] == "next" }&.fetch("href")
+      else
+        response["next"]
+      end
+    end
+
     # @param id_or_name_or_permalink [Stirng]
     # @param query [Hash]
     # @return [Yao::Resources::*]

data/lib/yao/resources/server_migrate.rb

@@ -0,0 +1,15 @@
+module Yao::Resources
+  class ServerMigrate < Base
+    friendly_attributes :dest_compute, :dest_host, :dest_node, :instance_uuid, :new_instance_type_id, :old_instance_type_id,
+                        :source_compute, :source_node, :status, :migration_type, :uuid, :user_id, :project_id
+    map_attributes_to_time :created_at, :updated_at
+
+    self.service        = "compute"
+    self.resource_name  = "migrations"
+    self.resources_name = "os-migrations"
+
+    def server
+      @server ||= Yao::Server.get(self["instance_uuid"])
+    end
+  end
+end

data/lib/yao/resources/volume.rb

@@ -10,6 +10,10 @@ module Yao::Resources
     map_attribute_to_attribute 'os-vol-host-attr:host' => :host
     map_attribute_to_attribute 'os-vol-tenant-attr:tenant_id' => :tenant_id
 
+    map_attributes_to_time :created_at, :updated_at
+    alias :created :created_at
+    alias :updated :updated_at
+
     self.service        = "volumev3"
     self.resource_name  = "volume"
     self.resources_name = "volumes"

data/lib/yao/resources/volume_services.rb

@@ -0,0 +1,76 @@
+module Yao::Resources
+  class VolumeServices < Base
+
+    friendly_attributes :binary, :disabled_reason, :host, :state, :status,
+                        :frozen, :zone, :cluster, :replication_status,
+                        :active_backend_id, :backed_state
+    map_attributes_to_time :updated_at
+
+    self.service        = "volumev3"
+    self.resource_name  = "os-service"
+    self.resources_name = "os-services"
+
+    # return true if ComputeServices is enabled
+    # @return [Bool]
+    def enabled?
+      status == 'enabled'
+    end
+
+    # return true if ComputeServices is disabled
+    # @return [Bool]
+    def disabled?
+      status == 'disabled'
+    end
+
+    def enable
+      self.class.enable(host, binary)
+    end
+
+    def disable(reason = nil)
+      self.class.disable(host, binary, reason)
+    end
+
+    class << self
+      # @param host [String]
+      # @param binary [String]
+      # @return [Hash]
+      def enable(host, binary)
+        params = {
+          "host" => host,
+          "binary" => binary,
+        }
+        put("enable", params)
+      end
+
+      # @param host [String]
+      # @param binary [String]
+      # @param resason [String]
+      # @return [Hash]
+      def disable(host, binary, reason = nil)
+        params = {
+          "host" => host,
+          "binary" => binary,
+        }
+        if reason
+          params["disabled_reason"] = reason
+          put("disable-log-reason", params)
+        else
+          put("disable", params)
+        end
+      end
+
+      private
+
+      # @param path [String]
+      # @param  params [Hash]
+      # @return [Hash]
+      def put(path, params)
+        res = PUT(create_url(path), params) do |req|
+          req.body = params.to_json
+          req.headers['Content-Type'] = 'application/json'
+        end
+        res.body
+      end
+    end
+  end
+end

data/lib/yao/resources.rb

@@ -8,6 +8,7 @@ module Yao
 
     autoload :Server,                    "yao/resources/server"
     autoload :ServerGroup,               "yao/resources/server_group"
+    autoload :ServerMigrate,             "yao/resources/server_migrate"
     autoload :Flavor,                    "yao/resources/flavor"
     autoload :Image,                     "yao/resources/image"
     autoload :SecurityGroup,             "yao/resources/security_group"
@@ -33,6 +34,7 @@ module Yao
     autoload :Role,                      "yao/resources/role"
     autoload :RoleAssignment,            "yao/resources/role_assignment"
     autoload :Volume,                    "yao/resources/volume"
+    autoload :VolumeServices,            "yao/resources/volume_services"
     autoload :VolumeType,                "yao/resources/volume_type"
     autoload :ComputeServices,           "yao/resources/compute_services"
     autoload :Project,                   "yao/resources/project"

data/lib/yao/version.rb

@@ -1,3 +1,3 @@
 module Yao
-  VERSION = "0.19.0"
+  VERSION = "0.20.0"
 end

data/test/support/restfully_accesible_stub.rb

@@ -51,6 +51,29 @@ module RestfullyAccessibleStub
       )
   end
 
+  def stub_put_request(url, body, response = {})
+    stub_request(:put,url)
+      .with(
+        headers: request_headers.merge({'Content-Type' => 'application/json'}),
+        body: body.to_json,
+      ).to_return(
+        status: 200,
+        headers: {'Content-Type' => 'application/json'},
+        body: response.to_json
+      )
+  end
+
+  def stub_delete_request(url, response = {})
+    stub_request(:delete,url)
+      .with(
+        headers: request_headers
+      ).to_return(
+        status: 200,
+        headers: {'Content-Type' => 'application/json'},
+        body: response.to_json
+      )
+  end
+
   def request_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}"}
   end

data/test/yao/resources/test_compute_services.rb

@@ -1,4 +1,5 @@
 class TestComputeServices < TestYaoResource
+  include RestfullyAccessibleStub
 
   def test_compute_services
 
@@ -127,4 +128,11 @@ class TestComputeServices < TestYaoResource
 
     assert_requested stub
   end
+
+  def test_delete
+    stub = stub_delete_request("https://example.com:12345/os-services/test-id")
+    compute_service = Yao::ComputeServices.new({"id" => "test-id"})
+    assert_equal({}, compute_service.delete)
+    assert_requested(stub)
+  end
 end

data/test/yao/resources/test_network.rb

@@ -14,7 +14,7 @@ class TestNetwork < TestYaoResource
       "router:external" => false,
       "shared" => false,
       "status" => "ACTIVE",
-      "subnets" => [],
+      "subnets" => ["52822b63-eb89-496d-9509-f91473b9d85d"],
       "tenant_id" => "c05140b3dc7c4555afff9fab6b58edc2",
       "project_id" => "c05140b3dc7c4555afff9fab6b58edc2",
     }
@@ -28,13 +28,15 @@ class TestNetwork < TestYaoResource
     assert_equal(false, network.shared)
     assert_equal(false, network.shared?)
     assert_equal("c05140b3dc7c4555afff9fab6b58edc2", network.tenant_id)
-    assert_equal([], network.subnets)
     assert_equal(true, network.admin_state_up)
 
     #map_attribute_to_attribute
     assert_equal("physnet1", network.physical_network)
     assert_equal("vlan", network.type)
     assert_equal(1000, network.segmentation_id)
+
+    assert_equal(Yao::Subnet, network.subnets.first.class)
+    assert_equal("52822b63-eb89-496d-9509-f91473b9d85d", network.subnets.first.id)
   end
 
   def test_project

data/test/yao/resources/test_networking_agents.rb

@@ -1,4 +1,5 @@
 class TestNetworkingAgents < TestYaoResource
+  include RestfullyAccessibleStub
 
   def test_networking_agents
 
@@ -81,4 +82,11 @@ class TestNetworkingAgents < TestYaoResource
     assert_equal(Time.parse("2017-09-12 19:35:38"), agent.created_at)
     assert_equal(Time.parse("2017-09-12 19:35:38"), agent.started_at)
   end
+
+  def test_delete
+    stub = stub_delete_request("https://example.com:12345/agents/test-id")
+    agents = Yao::NetworkingAgents.new({"id" => "test-id"})
+    assert_equal({}, agents.delete)
+    assert_requested(stub)
+  end
 end

data/test/yao/resources/test_server_migrate.rb

@@ -0,0 +1,33 @@
+class TestServerGroup < TestYaoResource
+  def test_server_group
+    # https://docs.openstack.org/api-ref/compute/?expanded=list-migrations-detail#list-migrations
+    params = {
+      "created_at" => "2012-10-29T13:42:02.000000",
+      "dest_compute" => "compute2",
+      "dest_host" => "1.2.3.4",
+      "dest_node" => "node2",
+      "id" => 1234,
+      "instance_uuid" => "8600d31b-d1a1-4632-b2ff-45c2be1a70ff",
+      "new_instance_type_id" => 2,
+      "old_instance_type_id" => 1,
+      "source_compute" => "compute1",
+      "source_node" => "node1",
+      "status" => "done",
+      "updated_at" => "2012-10-29T13:42:02.000000"
+    }
+
+    migrate = Yao::ServerMigrate.new(params)
+    assert_equal(Time.parse("2012-10-29T13:42:02.000000"), migrate.created_at)
+    assert_equal("compute2", migrate.dest_compute)
+    assert_equal("1.2.3.4", migrate.dest_host)
+    assert_equal("node2", migrate.dest_node)
+    assert_equal(1234, migrate.id)
+    assert_equal("8600d31b-d1a1-4632-b2ff-45c2be1a70ff", migrate.instance_uuid)
+    assert_equal(2, migrate.new_instance_type_id)
+    assert_equal(1, migrate.old_instance_type_id)
+    assert_equal("compute1", migrate.source_compute)
+    assert_equal("node1", migrate.source_node)
+    assert_equal("done", migrate.status)
+    assert_equal(Time.parse("2012-10-29T13:42:02.000000"), migrate.updated_at)
+  end
+end

data/test/yao/resources/test_volume.rb

@@ -13,7 +13,9 @@ class TestVolume < TestYaoResource
         'snapshot_id' => nil,
         'status' => 'available',
         'user_id' => 'aaaa166533fd49f3b11b1cdce2430000',
-        'volume_type' => 'test'
+        'volume_type' => 'test',
+        'created_at' => '2018-11-28T06:25:15.288987',
+        'updated_at' => '2019-11-28T06:25:15.288987'
     }
 
     volume = Yao::Volume.new(params)
@@ -30,6 +32,10 @@ class TestVolume < TestYaoResource
     assert_equal(volume.user_id, 'aaaa166533fd49f3b11b1cdce2430000')
     assert_equal(volume.volume_type, 'test')
     assert_equal(volume.type, 'test')
+    assert_equal(Time.parse('2018-11-28T06:25:15.288987'), volume.created_at)
+    assert_equal(Time.parse('2018-11-28T06:25:15.288987'), volume.created)
+    assert_equal(Time.parse('2019-11-28T06:25:15.288987'), volume.updated_at)
+    assert_equal(Time.parse('2019-11-28T06:25:15.288987'), volume.updated)
   end
 
   def test_list

data/test/yao/resources/test_volume_services.rb

@@ -0,0 +1,116 @@
+class TestVolumeServices < TestYaoResource
+  include RestfullyAccessibleStub
+
+  def test_volume_services
+    # https://docs.openstack.org/api-ref/block-storage/v3/index.html?expanded=list-all-cinder-services-detail#list-all-cinder-services
+    params = JSON.parse(<<~JSON)
+    {
+        "status": "enabled",
+        "binary": "cinder-scheduler",
+        "zone": "nova",
+        "state": "up",
+        "updated_at": "2017-06-29T05:50:35.000000",
+        "host": "devstack",
+        "disabled_reason": null
+    }
+    JSON
+
+    service = Yao::VolumeServices.new(params)
+    assert_equal('enabled', service.status)
+    assert_equal('cinder-scheduler', service.binary)
+    assert_equal('nova', service.zone)
+    assert_equal('up', service.state)
+    assert_equal(Time.parse('2017-06-29T05:50:35.000000'), service.updated_at)
+    assert_equal('devstack', service.host)
+    assert_equal(nil, service.disabled_reason)
+  end
+
+  def test_enabled
+    service = Yao::VolumeServices.new({'status' => 'enabled'})
+    assert_equal(true, service.enabled?)
+  end
+
+  def test_disabled
+    service = Yao::VolumeServices.new({'status' => 'enabled'})
+    assert_equal(false, service.disabled?)
+  end
+
+  def stub_enable_request
+    body = {
+      "host" => "test-host",
+      "binary" => "test-binary",
+    }
+    response = { "disabled" => false }
+    stub_put_request('https://example.com:12345/os-services/enable', body, response)
+  end
+
+  def test_enable
+    stub = stub_enable_request
+    service = Yao::VolumeServices.new({
+      "host" => "test-host",
+      "binary" => "test-binary",
+    })
+    response = service.enable
+    assert_equal(false, response['disabled'])
+    assert_requested(stub)
+  end
+
+  def test_self_enable
+    stub = stub_enable_request
+    response = Yao::VolumeServices.enable('test-host', 'test-binary')
+    assert_equal(false, response['disabled'])
+    assert_requested(stub)
+  end
+
+  def stub_disable_request(reason = nil)
+    body = {
+      "host" => "test-host",
+      "binary" => "test-binary",
+    }
+    response = { "disabled" => true }
+    if reason
+      body["disabled_reason"] = reason
+      response["disabled_reason"] = reason
+      stub_put_request('https://example.com:12345/os-services/disable-log-reason', body, response)
+    else
+      stub_put_request('https://example.com:12345/os-services/disable', body, response)
+    end
+  end
+
+  def test_disable
+    stub = stub_disable_request
+    service = Yao::VolumeServices.new({
+      "host" => "test-host",
+      "binary" => "test-binary",
+    })
+    response = service.disable
+    assert_equal(true, response['disabled'])
+    assert_requested(stub)
+  end
+
+  def test_disable_reason
+    stub = stub_disable_request('test-reason')
+    service = Yao::VolumeServices.new({
+      "host" => "test-host",
+      "binary" => "test-binary",
+    })
+    response = service.disable('test-reason')
+    assert_equal(true, response['disabled'])
+    assert_equal('test-reason', response['disabled_reason'])
+    assert_requested(stub)
+  end
+
+  def test_self_disable
+    stub = stub_disable_request
+    response = Yao::VolumeServices.disable('test-host', 'test-binary')
+    assert_equal(true, response['disabled'])
+    assert_requested(stub)
+  end
+
+  def test_self_disable_reason
+    stub = stub_disable_request('test-reason')
+    response = Yao::VolumeServices.disable('test-host', 'test-binary', 'test-reason')
+    assert_equal(true, response['disabled'])
+    assert_requested(stub)
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: yao
 version: !ruby/object:Gem::Version
-  version: 0.19.0
+  version: 0.20.0
 platform: ruby
 authors:
 - Uchio, KONDO
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-05-12 00:00:00.000000000 Z
+date: 2023-03-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
@@ -133,12 +133,14 @@ files:
 - lib/yao/resources/security_group_rule.rb
 - lib/yao/resources/server.rb
 - lib/yao/resources/server_group.rb
+- lib/yao/resources/server_migrate.rb
 - lib/yao/resources/server_usage_associationable.rb
 - lib/yao/resources/subnet.rb
 - lib/yao/resources/tenant.rb
 - lib/yao/resources/user.rb
 - lib/yao/resources/volume.rb
 - lib/yao/resources/volume_action.rb
+- lib/yao/resources/volume_services.rb
 - lib/yao/resources/volume_type.rb
 - lib/yao/setup.rb
 - lib/yao/token.rb
@@ -182,9 +184,11 @@ files:
 - test/yao/resources/test_security_group_rule.rb
 - test/yao/resources/test_server.rb
 - test/yao/resources/test_server_group.rb
+- test/yao/resources/test_server_migrate.rb
 - test/yao/resources/test_subnet.rb
 - test/yao/resources/test_user.rb
 - test/yao/resources/test_volume.rb
+- test/yao/resources/test_volume_services.rb
 - test/yao/resources/test_volume_type.rb
 - test/yao/test_auth.rb
 - test/yao/test_authv3.rb
@@ -216,7 +220,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.7
+rubygems_version: 3.4.6
 signing_key:
 specification_version: 4
 summary: Yet Another OpenStack API Wrapper that rocks!!
@@ -259,9 +263,11 @@ test_files:
 - test/yao/resources/test_security_group_rule.rb
 - test/yao/resources/test_server.rb
 - test/yao/resources/test_server_group.rb
+- test/yao/resources/test_server_migrate.rb
 - test/yao/resources/test_subnet.rb
 - test/yao/resources/test_user.rb
 - test/yao/resources/test_volume.rb
+- test/yao/resources/test_volume_services.rb
 - test/yao/resources/test_volume_type.rb
 - test/yao/test_auth.rb
 - test/yao/test_authv3.rb