fog-brightbox 1.4.1 → 1.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7e91c9a644e0cd1ba3d41a180c1d03f5f6b4f30170838cc8119f694dd528737f
-  data.tar.gz: 51143d7150551695ea3027a75451c15760c0005b824df2aaeb56d1c73050db34
+  metadata.gz: cb1f5fab98014e9dda7db0f12f010f30e35277e6516151f3ebe4f1821c662dc3
+  data.tar.gz: e4bb7b22b9c9e398923ce253708acfb0dd4519b7511428973ced16e20ac77e69
 SHA512:
-  metadata.gz: 5eb27bf573f92cb3b3ecec889bf62c1ce072a8027e2734d8d4c5238590d6c9f4599388ef52bd6ac8e73b914fb4bf80639ff6a586646f3d06ea997b28903e40c8
-  data.tar.gz: 03a47f51347c021bbe3fafbaf1a9dc5d180d6a8995ab8ce18297234bda87aea965dc7f82b5377ba8d062b00ff76164292e420b623cf6b47aa2dc0c0e45d1da53
+  metadata.gz: 38c16b6810afe2ebb15edeedfff0732f54e34ccc0e8bb56af85efcbcf2d43c1776957dff2b0ca44afc5a1cbc7d6b7a98c015cb5feb95aea36c820ab0eada57fd
+  data.tar.gz: 86e0cd498b82639fd952f3a08c03c15d8e8f623391889c23f602e6a1d7177cbe714b5527d3940e404e902d8a2acbc3c2004de97113ff6823b8656d07a35736ee

data/CHANGELOG.md

@@ -1,3 +1,26 @@
+### 1.5.0 / 2022-06-09
+
+Changes:
+
+* Added support for `Volume` resources. These are dynamic, network attached
+  volumes. Servers with `nbs` (Network Block Storage) types can be created
+  from volumes. Additional volumes can be attached to a server. The volumes
+  can be quickly copied and resized.
+
+### 1.4.2 / 2022-06-09
+
+Bug fixes:
+
+* `Fog::Brightbox::Compute::ImageSelector#latest_ubuntu` was fixed to resolve
+  two bugs that prevented the latest version being found since Xenial:
+  * The filtering for `i686` was missing later release which are only available
+    as `x86_64` images following support being dropped upstream. The filter is
+    now swapped to only match 64bit releases.
+  * The reverse name sorting failed when the Ubuntu codenames returned to the
+    start of the alphabet so `xenial` (16.04) would appear above `bionic`
+    (18.04) or `jammy` (22.04). The names are now split and the version used
+    instead for the sorting.
+
 ### 1.4.1 / 2021-04-20
 
 Bug fixes:

data/lib/fog/brightbox/compute/image_selector.rb

@@ -29,11 +29,11 @@ module Fog
           @images.select do |img|
             img["official"] == true &&
               img["status"] == "available" &&
-              img["arch"] == "i686" &&
+              img["arch"] == "x86_64" &&
               img["name"] =~ /ubuntu/i
           end.sort do |a, b|
-            # Reverse sort so "raring" > "precise" and "13.10" > "13.04"
-            b["name"].downcase <=> a["name"].downcase
+            # Reverse sort so "22.10" > "22.04"
+            NameSorter.new(b["name"]).version <=> NameSorter.new(a["name"]).version
           end.first["id"]
         rescue StandardError
           nil
@@ -55,6 +55,31 @@ module Fog
         rescue StandardError
           nil
         end
+
+        class NameSorter
+          PATTERN = /\A(?<ubuntu>.*?)-(?<codename>.*?)-(?<version>[\d\.]*?)-(?<arch>.*?)/
+
+          def initialize(name)
+            @name = name
+            @matches = name.match(PATTERN)
+          end
+
+          def arch
+            @matches[:arch] || ""
+          end
+
+          def codename
+            @matches[:codename] || ""
+          end
+
+          def ubuntu?
+            @name.start_with?("ubuntu")
+          end
+
+          def version
+            @matches[:version] || ""
+          end
+        end
       end
     end
   end

data/lib/fog/brightbox/compute.rb

@@ -63,6 +63,8 @@ module Fog
       model :user
       collection :user_collaborations
       model :user_collaboration
+      collection :volumes
+      model :volume
 
       request_path "fog/brightbox/requests/compute"
       request :accept_user_collaboration
@@ -72,7 +74,9 @@ module Fog
       request :add_servers_server_group
       request :apply_to_firewall_policy
       request :accept_user_collaboration
+      request :attach_volume
       request :remove_firewall_policy
+      request :copy_volume
       request :create_api_client
       request :create_application
       request :create_cloud_ip
@@ -84,6 +88,7 @@ module Fog
       request :create_database_server
       request :create_server
       request :create_server_group
+      request :create_volume
       request :delete_api_client
       request :delete_application
       request :delete_cloud_ip
@@ -97,6 +102,8 @@ module Fog
       request :delete_server
       request :delete_server_group
       request :delete_user_collaboration
+      request :delete_volume
+      request :detach_volume
       request :get_account
       request :get_api_client
       request :get_application
@@ -117,6 +124,7 @@ module Fog
       request :get_server_type
       request :get_user
       request :get_user_collaboration
+      request :get_volume
       request :get_zone
       request :list_accounts
       request :list_api_clients
@@ -135,12 +143,14 @@ module Fog
       request :list_servers
       request :list_users
       request :list_user_collaborations
+      request :list_volumes
       request :list_zones
       request :lock_resource_database_server
       request :lock_resource_database_snapshot
       request :lock_resource_image
       request :lock_resource_load_balancer
       request :lock_resource_server
+      request :lock_resource_volume
       request :map_cloud_ip
       request :move_servers_server_group
       request :reboot_server
@@ -156,6 +166,7 @@ module Fog
       request :reset_secret_application
       request :reset_server
       request :resend_collaboration
+      request :resize_volume
       request :reject_user_collaboration
       request :shutdown_server
       request :snapshot_database_server
@@ -167,6 +178,7 @@ module Fog
       request :unlock_resource_image
       request :unlock_resource_load_balancer
       request :unlock_resource_server
+      request :unlock_resource_volume
       request :unmap_cloud_ip
       request :update_account
       request :update_api_client
@@ -182,6 +194,7 @@ module Fog
       request :update_server
       request :update_server_group
       request :update_user
+      request :update_volume
 
       # The Mock Service allows you to run a fake instance of the Service
       # which makes no real connections.

data/lib/fog/brightbox/models/compute/server.rb

@@ -7,6 +7,8 @@ module Fog
         include Fog::Brightbox::ModelHelper
         include Fog::Brightbox::Compute::ResourceLocking
 
+        attr_accessor :volume_id
+
         identity :id
         attribute :resource_type
         attribute :url
@@ -38,6 +40,7 @@ module Fog
         attribute :cloud_ips
         attribute :interfaces
         attribute :server_groups
+        attribute :volumes
         attribute :zone
         attribute :server_type
 
@@ -181,7 +184,6 @@ module Fog
           raise Fog::Errors::Error.new("Resaving an existing object may create a duplicate") if persisted?
           requires :image_id
           options = {
-            :image => image_id,
             :name => name,
             :zone => zone_id,
             :user_data => user_data,
@@ -192,6 +194,12 @@ module Fog
           options.merge!(:cloud_ip => cloud_ip) unless cloud_ip.nil? || cloud_ip == ""
           options.merge!(:disk_encrypted => disk_encrypted) if disk_encrypted
 
+          if volume_id
+            options.merge!(:volumes => [:volume => volume_id])
+          else
+            options.merge!(:image => image_id)
+          end
+
           data = service.create_server(options)
           merge_attributes(data)
           true

data/lib/fog/brightbox/models/compute/volume.rb

@@ -0,0 +1,152 @@
+module Fog
+  module Brightbox
+    class Compute
+      class Volume < Fog::Brightbox::Model
+        include Fog::Brightbox::Compute::ResourceLocking
+
+        identity :id
+        attribute :url
+        attribute :resource_type
+
+        attribute :name
+        attribute :state, :aliases => "status"
+
+        attribute :description
+        attribute :filesystem_label
+        attribute :filesystem_type
+        attribute :serial
+        attribute :size
+        attribute :source
+        attribute :source_type
+        attribute :storage_type
+
+        attribute :boot
+        attribute :delete_with_server
+        attribute :encrypted
+
+        # Times
+        attribute :created_at, :type => :time
+        attribute :updated_at, :type => :time
+        attribute :deleted_at, :type => :time
+
+        # Links
+        attribute :account_id, :aliases => "account", :squash => "id"
+        attribute :image_id, :aliases => "image", :squash => "id"
+        attribute :server_id, :aliases => "server", :squash => "id"
+
+        def attach(server)
+          requires :identity
+          data = service.attach_volume(identity, server: server.id)
+          merge_attributes(data)
+          true
+        end
+
+        def attached?
+          state == "attached"
+        end
+
+        # @param [Hash] options
+        # @option options [Boolean] :delete_with_server Set +true+ the volume will be removed if attached to a server that is deleted
+        # @option options [String] :description
+        # @option options [String] :name
+        # @option options [String] :serial
+        #
+        # @return [Fog::Compute::Volume] a new model for the copy
+        def copy(options = {})
+          requires :identity
+          data = service.copy_volume(identity, options)
+          service.volumes.new(data)
+        end
+
+        def creating?
+          state == "creating"
+        end
+
+        def deleted?
+          state == "deleted"
+        end
+
+        def deleting?
+          state == "deleting"
+        end
+
+        def detach
+          requires :identity
+          data = service.detach_volume(identity)
+          merge_attributes(data)
+          true
+        end
+
+        def detached?
+          state == "detached"
+        end
+
+        def failed?
+          state == "failed"
+        end
+
+        def finished?
+          deleted? || failed?
+        end
+
+        def ready?
+          attached? || detached?
+        end
+
+        # @param [Hash] options
+        # @option options [Integer] :to The new size in MiB to change the volume to
+        def resize(options)
+          requires :identity
+
+          # The API requires the old "from" size to avoid acting on stale data
+          # We can merge this and if the API rejects the request, the model was out of sync
+          options.merge!(:from => size)
+
+          data = service.resize_volume(identity, options)
+          merge_attributes(data)
+          true
+        end
+
+        def save
+          if persisted?
+            options = {
+              :delete_with_server => delete_with_server,
+              :description => description,
+              :name => name,
+              :serial => serial
+            }.delete_if { |_k, v| v.nil? || v == "" }
+
+            data = service.update_volume(identity, options)
+          else
+            raise Fog::Errors::Error.new("'image_id' and 'filesystem_type' are mutually exclusive") if image_id && filesystem_type
+            raise Fog::Errors::Error.new("'image_id' or 'filesystem_type' is required") unless image_id || filesystem_type
+
+            options = {
+              :delete_with_server => delete_with_server,
+              :description => description,
+              :filesystem_label => filesystem_label,
+              :filesystem_type => filesystem_type,
+              :name => name,
+              :serial => serial,
+              :size => size
+            }.delete_if { |_k, v| v.nil? || v == "" }
+
+            options.merge!(:image => image_id) unless image_id.nil? || image_id == ""
+
+            data = service.create_volume(options)
+          end
+
+          merge_attributes(data)
+          true
+        end
+
+        def destroy
+          requires :identity
+          data = service.delete_volume(identity)
+          merge_attributes(data)
+          true
+        end
+      end
+    end
+  end
+end

data/lib/fog/brightbox/models/compute/volumes.rb

@@ -0,0 +1,23 @@
+require "fog/brightbox/models/compute/volume"
+
+module Fog
+  module Brightbox
+    class Compute
+      class Volumes < Fog::Collection
+        model Fog::Brightbox::Compute::Volume
+
+        def all
+          data = service.list_volumes
+          load(data)
+        end
+
+        def get(identifier)
+          data = service.get_volume(identifier)
+          new(data)
+        rescue Excon::Errors::NotFound
+          nil
+        end
+      end
+    end
+  end
+end

data/lib/fog/brightbox/requests/compute/attach_volume.rb

@@ -0,0 +1,23 @@
+module Fog
+  module Brightbox
+    class Compute
+      class Real
+        # Attach a detached server to a nominated server
+        #
+        # @param [String] identifier Unique reference to identify the resource
+        # @param [Hash] options
+        # @option options [Boolean] :nested passed through with the API request. When true nested resources are expanded.
+        # @option options [String] :server The identifier of the server
+        # @option options [Boolean] :boot Set +true+ to attach as boot volume. Only when server is stopped
+        #
+        # @return [Hash] if successful Hash version of JSON object
+        # @return [NilClass] if no options were passed
+        #
+        def attach_volume(identifier, options)
+          return nil if identifier.nil? || identifier == ""
+          wrapped_request("post", "/1.0/volumes/#{identifier}/attach", [202], options)
+        end
+      end
+    end
+  end
+end

data/lib/fog/brightbox/requests/compute/copy_volume.rb

@@ -0,0 +1,25 @@
+module Fog
+  module Brightbox
+    class Compute
+      class Real
+        # Copy a volume and create a new one
+        #
+        # @param [String] identifier Unique reference to identify the resource
+        # @param [Hash] options
+        # @option options [Boolean] :nested passed through with the API request. When true nested resources are expanded.
+        # @option options [Boolean] :delete_with_server Set +true+ the volume will be removed if attached to a server that is deleted
+        # @option options [String] :description
+        # @option options [String] :name
+        # @option options [String] :serial
+        #
+        # @return [Hash] if successful Hash version of JSON object
+        # @return [NilClass] if no options were passed
+        #
+        def copy_volume(identifier, options)
+          return nil if identifier.nil? || identifier == ""
+          wrapped_request("post", "/1.0/volumes/#{identifier}/copy", [202], options)
+        end
+      end
+    end
+  end
+end

data/lib/fog/brightbox/requests/compute/create_volume.rb

@@ -0,0 +1,25 @@
+module Fog
+  module Brightbox
+    class Compute
+      class Real
+        # Create a new volume
+        #
+        # @param [String] identifier Unique reference to identify the resource
+        # @param [Hash] options
+        # @option options [Boolean] :nested passed through with the API request. When true nested resources are expanded.
+        # @option options [Boolean] :delete_with_server Set +true+ the volume will be removed if attached to a server that is deleted
+        # @option options [String] :description
+        # @option options [String] :name
+        # @option options [String] :serial
+        #
+        # @return [Hash] if successful Hash version of JSON object
+        # @return [NilClass] if no options were passed
+        #
+        def create_volume(options)
+          return nil if options.empty? || options.nil?
+          wrapped_request("post", "/1.0/volumes", [202], options)
+        end
+      end
+    end
+  end
+end

data/lib/fog/brightbox/requests/compute/delete_volume.rb

@@ -0,0 +1,20 @@
+module Fog
+  module Brightbox
+    class Compute
+      class Real
+        # Destroy the volume and free up the resources.
+        #
+        # @param [String] identifier Unique reference to identify the resource
+        # @param [Hash] options
+        # @option options [Boolean] :nested passed through with the API request. When true nested resources are expanded.
+        #
+        # @return [Hash] if successful Hash version of JSON object
+        #
+        def delete_volume(identifier, options = {})
+          return nil if identifier.nil? || identifier == ""
+          wrapped_request("delete", "/1.0/volumes/#{identifier}", [202], options)
+        end
+      end
+    end
+  end
+end

data/lib/fog/brightbox/requests/compute/detach_volume.rb

@@ -0,0 +1,21 @@
+module Fog
+  module Brightbox
+    class Compute
+      class Real
+        # Detach the volume from its server
+        #
+        # @param [String] identifier Unique reference to identify the resource
+        # @param [Hash] options
+        # @option options [Boolean] :nested passed through with the API request. When true nested resources are expanded.
+        #
+        # @return [Hash] if successful Hash version of JSON object
+        # @return [NilClass] if no options were passed
+        #
+        def detach_volume(identifier, options = {})
+          return nil if identifier.nil? || identifier == ""
+          wrapped_request("post", "/1.0/volumes/#{identifier}/detach", [202], options)
+        end
+      end
+    end
+  end
+end

data/lib/fog/brightbox/requests/compute/get_volume.rb

@@ -0,0 +1,20 @@
+module Fog
+  module Brightbox
+    class Compute
+      class Real
+        # Get full details of the volume.
+        #
+        # @param [String] identifier Unique reference to identify the resource
+        # @param [Hash] options
+        # @option options [Boolean] :nested passed through with the API request. When true nested resources are expanded.
+        #
+        # @return [Hash] if successful Hash version of JSON object
+        #
+        def get_volume(identifier, options = {})
+          return nil if identifier.nil? || identifier == ""
+          wrapped_request("get", "/1.0/volumes/#{identifier}", [200], options)
+        end
+      end
+    end
+  end
+end

data/lib/fog/brightbox/requests/compute/list_volumes.rb

@@ -0,0 +1,18 @@
+module Fog
+  module Brightbox
+    class Compute
+      class Real
+        # Lists summary details of volumes available for use by the Account
+        #
+        # @param [Hash] options
+        # @option options [Boolean] :nested passed through with the API request. When true nested resources are expanded.
+        #
+        # @return [Hash] if successful Hash version of JSON object
+        #
+        def list_volumes(options = {})
+          wrapped_request("get", "/1.0/volumes", [200], options)
+        end
+      end
+    end
+  end
+end

data/lib/fog/brightbox/requests/compute/lock_resource_volume.rb

@@ -0,0 +1,18 @@
+module Fog
+  module Brightbox
+    class Compute
+      class Real
+        # @param [String] identifier Unique reference to identify the resource
+        # @param [Hash] options
+        # @option options [Boolean] :nested passed through with the API request. When true nested resources are expanded.
+        #
+        # @return [Hash] if successful Hash version of JSON object
+        #
+        def lock_resource_volume(identifier, options = {})
+          return nil if identifier.nil? || identifier == ""
+          wrapped_request("put", "/1.0/volumes/#{identifier}/lock_resource", [200], options)
+        end
+      end
+    end
+  end
+end

data/lib/fog/brightbox/requests/compute/resize_volume.rb

@@ -0,0 +1,26 @@
+module Fog
+  module Brightbox
+    class Compute
+      class Real
+        # Resize a volume, currently limited to expanding volumes.
+        #
+        # Partitions will need to be expanded within the OS.
+        #
+        # @param [String] identifier Unique reference to identify the resource
+        # @param [Hash] options
+        # @option options [Boolean] :nested passed through with the API request. When true nested resources are expanded.
+        # @option options [Integer] :from The original size (in MiB) to act as a preflight check to prevent duplicate requests
+        # @option options [Integer] :to The new size in MiB to change the volume to
+        #
+        # @return [Hash] if successful Hash version of JSON object
+        # @return [NilClass] if no options were passed
+        #
+        def resize_volume(identifier, options)
+          return nil if identifier.nil? || identifier == ""
+          return nil if options.empty? || options.nil?
+          wrapped_request("post", "/1.0/volumes/#{identifier}/resize", [202], options)
+        end
+      end
+    end
+  end
+end

data/lib/fog/brightbox/requests/compute/unlock_resource_volume.rb

@@ -0,0 +1,18 @@
+module Fog
+  module Brightbox
+    class Compute
+      class Real
+        # @param [String] identifier Unique reference to identify the resource
+        # @param [Hash] options
+        # @option options [Boolean] :nested passed through with the API request. When true nested resources are expanded.
+        #
+        # @return [Hash] if successful Hash version of JSON object
+        #
+        def unlock_resource_volume(identifier, options = {})
+          return nil if identifier.nil? || identifier == ""
+          wrapped_request("put", "/1.0/volumes/#{identifier}/unlock_resource", [200], options)
+        end
+      end
+    end
+  end
+end

data/lib/fog/brightbox/requests/compute/update_volume.rb

@@ -0,0 +1,26 @@
+module Fog
+  module Brightbox
+    class Compute
+      class Real
+        # Update some volume attributes.
+        #
+        # @param [String] identifier Unique reference to identify the resource
+        # @param [Hash] options
+        # @option options [Boolean] :nested passed through with the API request. When true nested resources are expanded.
+        # @option options [Boolean] :delete_with_server Set +true+ the volume will be removed if attached to a server that is deleted
+        # @option options [String] :description
+        # @option options [String] :name
+        # @option options [String] :serial
+        #
+        # @return [Hash] if successful Hash version of JSON object
+        # @return [NilClass] if no options were passed
+        #
+        def update_volume(identifier, options)
+          return nil if identifier.nil? || identifier == ""
+          return nil if options.empty? || options.nil?
+          wrapped_request("put", "/1.0/volumes/#{identifier}", [202], options)
+        end
+      end
+    end
+  end
+end

data/lib/fog/brightbox/version.rb

@@ -1,5 +1,5 @@
 module Fog
   module Brightbox
-    VERSION = "1.4.1"
+    VERSION = "1.5.0"
   end
 end