brightbox-cli 4.2.1 → 4.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b24f4292c151b1a916960e8a251c3928468ac915ee5f1fe139e8ef3a4d1e0a82
-  data.tar.gz: f7da261677380fd05cf1e4c3f73021db46c0b24b7da36a8e3820928ca96cfbe4
+  metadata.gz: a05097c67b080ccedd218b30d3e0923b4b1804c76ac5cbe5a76678b75d8f221e
+  data.tar.gz: 9c9076964ac3c57b48a7d4d55183e4c2c87214462e564823dc815d566d1f95ad
 SHA512:
-  metadata.gz: e8eed506ef89c92c2f85d0567fb3e1c8910c3705a209330025d2443ead0fc237bc210d9a5867d9dc92b8331ba9d10d03992640307fcdf5e00575f815af1a8984
-  data.tar.gz: 49ae72e6347419f04bdb4c2190a0dc7ca2dc5066eda0c831adfe80cf4cec7483be83a3b6feabb1de837827dc97bbe5e0cd891874875e19115a30a523ed9ac3b9
+  metadata.gz: 768f52b7d7eaed35b46d606f4699e23b2793f9ba0a00c86feaa0155cda89a55cc7a02e5f53268c554cd8731a0154bd1f5b37a0bdffb2f18c7cf852a97c353516
+  data.tar.gz: 5178134a5acd7146df5a1d4e127773d0e9b322e48a0495bc01eba5408c25e81cc4e7f3d08c45ee83332d84cd04e7e562f7d2f0778c1762182e9787b9451e5066

data/CHANGELOG.md

@@ -1,3 +1,23 @@
+### v4.3.1 / 2023-01-11
+
+[Full Changelog](https://github.com/brightbox/brightbox-cli/compare/v4.3.0...v4.3.1)
+
+Bug fixes:
+
+* Fix `help` output crashing when encountering Array in locale file.
+
+### v4.3.0 / 2023-01-11
+
+[Full Changelog](https://github.com/brightbox/brightbox-cli/compare/v4.2.1...v4.3.0)
+
+Enhancements:
+
+* Adds `volumes` subcommand for Volume management.
+
+Changes:
+
+* Update `fog-brightbox` to `v1.7.0`
+
 ### v4.2.1 / 2022-11-16
 
 [Full Changelog](https://github.com/brightbox/brightbox-cli/compare/v4.2.0...v4.2.1)
@@ -11,7 +31,7 @@ Bug fixes:
 
 [Full Changelog](https://github.com/brightbox/brightbox-cli/compare/v4.1.0...v4.2.0)
 
-Changes:
+Enhancements:
 
 * Adds three new, mutually exclusive options to `images create` to specify
   different sources:
@@ -24,7 +44,7 @@ Changes:
 
 [Full Changelog](https://github.com/brightbox/brightbox-cli/compare/v4.0.0...v4.1.0)
 
-Changes:
+Enhancements:
 
 * Adds `volume-size` to `servers create` to allow passing of arbitrary sizes for
   network based storage types.

data/Gemfile.lock

@@ -1,9 +1,9 @@
 PATH
   remote: .
   specs:
-    brightbox-cli (4.2.1)
+    brightbox-cli (4.3.1)
       dry-inflector (= 0.2.0)
-      fog-brightbox (>= 1.8.0)
+      fog-brightbox (>= 1.9.1)
       fog-core (< 2.0)
       gli (~> 2.21)
       highline (~> 2.0)
@@ -25,8 +25,8 @@ GEM
       rexml
     diff-lcs (1.5.0)
     dry-inflector (0.2.0)
-    excon (0.94.0)
-    fog-brightbox (1.8.0)
+    excon (0.97.0)
+    fog-brightbox (1.9.1)
       dry-inflector
       fog-core (>= 1.45, < 3.0)
       fog-json
@@ -40,7 +40,7 @@ GEM
     formatador (0.3.0)
     gli (2.21.0)
     hashdiff (1.0.1)
-    highline (2.0.3)
+    highline (2.1.0)
     hirb (0.7.3)
     i18n (1.10.0)
       concurrent-ruby (~> 1.0)

data/brightbox-cli.gemspec

@@ -21,7 +21,7 @@ Gem::Specification.new do |s|
   s.executables   = `git ls-files -- bin/*`.split("\n").map { |f| File.basename(f) }
   s.require_paths = ["lib"]
 
-  s.add_dependency "fog-brightbox", ">= 1.8.0"
+  s.add_dependency "fog-brightbox", ">= 1.9.1"
   s.add_dependency "fog-core", "< 2.0"
   s.add_dependency "gli", "~> 2.21"
   s.add_dependency "highline", "~> 2.0"

data/lib/brightbox-cli/commands/volumes/attach.rb

@@ -0,0 +1,36 @@
+module Brightbox
+  command [:volumes] do |cmd|
+    cmd.desc I18n.t("volumes.attach.desc")
+    cmd.arg_name I18n.t("volumes.attach.args")
+
+    cmd.command [:attach] do |c|
+      c.desc I18n.t("volumes.options.boot")
+      c.default_value false
+      c.switch [:boot], negatable: true
+
+      c.action do |global_options, options, args|
+        vol_id = args.shift
+
+        if vol_id.nil? || !vol_id.start_with?("vol-")
+          raise I18n.t("volumes.args.specify_one_id_first")
+        end
+
+        srv_id = args.shift
+
+        if srv_id.nil? || !srv_id.start_with?("srv-")
+          raise I18n.t("volumes.attach.specify_server_id_second")
+        end
+
+        boot_flag = options[:boot]
+
+        volume = Volume.find(vol_id)
+
+        info I18n.t("volumes.attach.acting", volume: volume)
+        volume.attach(server: srv_id, boot: boot_flag)
+        volume.reload
+
+        render_table([volume], global_options)
+      end
+    end
+  end
+end

data/lib/brightbox-cli/commands/volumes/copy.rb

@@ -0,0 +1,45 @@
+module Brightbox
+  command [:volumes] do |cmd|
+    cmd.desc I18n.t("volumes.copy.desc")
+    cmd.arg_name I18n.t("volumes.args.one")
+
+    cmd.command [:copy] do |c|
+      c.desc I18n.t("options.description.desc")
+      c.flag %i[d description]
+
+      c.desc I18n.t("volumes.options.delete_with_server")
+      c.default_value false
+      c.switch ["delete-with-server"], negatable: true
+
+      c.desc I18n.t("options.name.desc")
+      c.flag %i[n name]
+
+      c.desc I18n.t("volumes.options.serial")
+      c.flag [:serial]
+
+      c.action do |global_options, options, args|
+        vol_id = args.shift
+
+        if vol_id.nil? || !vol_id.start_with?("vol-")
+          raise I18n.t("volumes.args.specify_one_id_first")
+        end
+
+        params = {
+          delete_with_server: options["delete-with-server"]
+        }
+        params[:description] = options[:description] if options[:description]
+        params[:name] = options[:name] if options[:name]
+        params[:serial] = options[:serial] if options[:serial]
+
+        volume = Volume.find(vol_id)
+
+        unless params.empty?
+          info I18n.t("volumes.copy.acting", volume: volume)
+          volume.copy(params)
+        end
+
+        render_table([volume], global_options)
+      end
+    end
+  end
+end

data/lib/brightbox-cli/commands/volumes/create.rb

@@ -0,0 +1,63 @@
+module Brightbox
+  command [:volumes] do |cmd|
+    cmd.desc I18n.t("volumes.create.desc")
+
+    cmd.command [:create] do |c|
+      c.desc I18n.t("options.description.desc")
+      c.flag %i[d description]
+
+      c.desc I18n.t("volumes.options.delete_with_server")
+      c.default_value false
+      c.switch ["delete-with-server"], negatable: true
+
+      c.desc I18n.t("volumes.options.encrypted")
+      c.switch %i[e encrypted], negatable: true
+
+      c.desc I18n.t("volumes.options.fs_label")
+      c.flag ["fs-label"]
+
+      c.desc I18n.t("volumes.options.fs_type")
+      c.flag ["fs-type"]
+
+      c.desc I18n.t("volumes.options.image")
+      c.flag %i[i image]
+
+      c.desc I18n.t("options.name.desc")
+      c.flag %i[n name]
+
+      c.desc I18n.t("volumes.options.serial")
+      c.flag [:serial]
+
+      c.desc I18n.t("volumes.options.size")
+      c.flag %i[s size]
+
+      c.action do |global_options, options, _args|
+        if options[:image].nil? && options[:"fs-type"].nil?
+          raise I18n.t("volumes.create.image_or_type_required")
+        end
+
+        if !options[:image].nil? && !options[:"fs-type"].nil?
+          raise I18n.t("volumes.create.either_image_or_type")
+        end
+
+        params = {
+          delete_with_server: options[:"delete-with-server"],
+          encrypted: options[:encrypted]
+        }
+
+        params[:filesystem_label] = options[:"fs-label"] if options[:"fs-label"]
+        params[:filesystem_type] = options[:"fs-type"] if options[:"fs-type"]
+        params[:image_id] = options[:image] if options[:image]
+
+        params[:description] = options[:description] if options[:description]
+        params[:name] = options[:name] if options[:name]
+        params[:serial] = options[:serial] if options[:serial]
+        params[:size] = options[:size] if options[:size]
+
+        info I18n.t("volumes.create.acting")
+        volume = Volume.create(params)
+        render_table([volume], global_options)
+      end
+    end
+  end
+end

data/lib/brightbox-cli/commands/volumes/destroy.rb

@@ -0,0 +1,26 @@
+module Brightbox
+  command [:volumes] do |cmd|
+    cmd.desc I18n.t("volumes.destroy.desc")
+    cmd.arg_name I18n.t("volumes.args.many")
+
+    cmd.command [:destroy] do |c|
+      c.action do |_global_options, _options, args|
+        raise I18n.t("volumes.args.specify_many_ids") if args.empty?
+
+        volumes = Volume.find_or_call(args) do |id|
+          raise I18n.t("volumes.args.unknown_id", volume: volume)
+        end
+
+        volumes.each do |volume|
+          info I18n.t("volumes.destroy.acting", volume: volume)
+
+          begin
+            volume.destroy
+          rescue Brightbox::Api::Conflict
+            error "Could not destroy #{id}"
+          end
+        end
+      end
+    end
+  end
+end

data/lib/brightbox-cli/commands/volumes/detach.rb

@@ -0,0 +1,23 @@
+module Brightbox
+  command [:volumes] do |cmd|
+    cmd.desc I18n.t("volumes.detach.desc")
+    cmd.arg_name I18n.t("volumes.args.many")
+
+    cmd.command [:detach] do |c|
+      c.action do |global_options, _options, args|
+        raise I18n.t("volumes.args.specify_many_ids") if args.empty?
+
+        volumes = Volume.find_or_call(args) do |volume|
+          raise I18n.t("volumes.args.unknown_id", volume: volume)
+        end
+
+        volumes.each do |volume|
+          info I18n.t("volumes.detach.acting", volume: volume)
+          volume.detach
+        end
+
+        render_table(volumes, global_options)
+      end
+    end
+  end
+end

data/lib/brightbox-cli/commands/volumes/list.rb

@@ -0,0 +1,16 @@
+module Brightbox
+  command [:volumes] do |cmd|
+    cmd.default_command :list
+
+    cmd.desc I18n.t("volumes.list.desc")
+    cmd.arg_name I18n.t("volumes.args.optional")
+
+    cmd.command [:list] do |c|
+      c.action do |global_options, _options, args|
+        volumes = Volume.find_all_or_warn(args)
+
+        render_table(volumes, global_options)
+      end
+    end
+  end
+end

data/lib/brightbox-cli/commands/volumes/locking.rb

@@ -0,0 +1,39 @@
+module Brightbox
+  command [:volumes] do |cmd|
+    cmd.desc I18n.t("volumes.lock.desc")
+    cmd.arg_name I18n.t("volumes.args.many")
+
+    cmd.command [:lock] do |c|
+      c.action do |_global_options, _options, args|
+        raise I18n.t("volumes.args.specify_many_ids") if args.empty?
+
+        volumes = Volume.find_or_call(args) do |volume|
+          raise I18n.t("volumes.args.unknown_id", volume: volume)
+        end
+
+        volumes.each do |volume|
+          info I18n.t("volumes.lock.acting", volume: volume)
+          volume.lock!
+        end
+      end
+    end
+
+    cmd.desc I18n.t("volumes.unlock.desc")
+    cmd.arg_name I18n.t("volumes.args.many")
+
+    cmd.command [:unlock] do |c|
+      c.action do |_global_options, _options, args|
+        raise I18n.t("volumes.args.specify_many_ids") if args.empty?
+
+        volumes = Volume.find_or_call(args) do |volume|
+          raise I18n.t("volumes.args.unknown_id", volume: volume)
+        end
+
+        volumes.each do |volume|
+          info I18n.t("volumes.unlock.acting", volume: volume)
+          volume.unlock!
+        end
+      end
+    end
+  end
+end

data/lib/brightbox-cli/commands/volumes/resize.rb

@@ -0,0 +1,36 @@
+module Brightbox
+  command [:volumes] do |cmd|
+    cmd.desc I18n.t("volumes.resize.desc")
+    cmd.arg_name I18n.t("volumes.args.one")
+
+    cmd.command [:resize] do |c|
+      c.desc I18n.t("volumes.options.size")
+      c.flag %i[s size]
+
+      c.action do |global_options, options, args|
+        vol_id = args.shift
+
+        if vol_id.nil? || !vol_id.start_with?("vol-")
+          raise I18n.t("volumes.args.specify_one_id_first")
+        end
+
+        if options[:size].nil?
+          raise I18n.t("volumes.resize.size_option_needed")
+        end
+
+        new_size = options[:size].to_i
+
+        volume = Volume.find(vol_id)
+        old_size = volume.size
+
+        info I18n.t("volumes.resize.acting", volume: volume)
+        volume.resize(
+          from: old_size,
+          to: new_size
+        )
+
+        render_table([volume], global_options)
+      end
+    end
+  end
+end

data/lib/brightbox-cli/commands/volumes/show.rb

@@ -0,0 +1,18 @@
+module Brightbox
+  command [:volumes] do |cmd|
+    cmd.desc I18n.t("volumes.show.desc")
+    cmd.arg_name I18n.t("volumes.args.optional")
+
+    cmd.command [:show] do |c|
+      c.action do |global_options, _options, args|
+        volumes = Volume.find_all_or_warn(args)
+
+        table_opts = global_options.merge(
+          :vertical => true,
+          :fields => Volume.detailed_fields
+        )
+        render_table(volumes, table_opts)
+      end
+    end
+  end
+end

data/lib/brightbox-cli/commands/volumes/update.rb

@@ -0,0 +1,50 @@
+module Brightbox
+  command [:volumes] do |cmd|
+    cmd.desc I18n.t("volumes.update.desc")
+    cmd.arg_name I18n.t("volumes.args.one")
+
+    cmd.command [:update] do |c|
+      c.desc I18n.t("options.description.desc")
+      c.flag %i[d description]
+
+      c.desc I18n.t("volumes.options.delete_with_server")
+      c.default_value :ignore # So we can discard unless deliberately passed
+      c.switch ["delete-with-server"], negatable: true
+
+      c.desc I18n.t("options.name.desc")
+      c.flag %i[n name]
+
+      c.desc I18n.t("volumes.options.serial")
+      c.flag [:serial]
+
+      c.action do |global_options, options, args|
+        vol_id = args.shift
+
+        if vol_id.nil? || !vol_id.start_with?("vol-")
+          raise I18n.t("volumes.args.specify_one_id_first")
+        end
+
+        params = {}
+
+        # Switches will always appear in the options so we need a non-boolean
+        # setting to determine if the user did not add it to their command
+        unless options["delete-with-server"] == :ignore
+          params[:delete_with_server] = options["delete-with-server"]
+        end
+
+        params[:description] = options[:description] if options[:description]
+        params[:name] = options[:name] if options[:name]
+        params[:serial] = options[:serial] if options[:serial]
+
+        volume = Volume.find(vol_id)
+
+        unless params.empty?
+          info I18n.t("volumes.update.acting", volume: volume)
+          volume.update(params)
+        end
+
+        render_table([volume], global_options)
+      end
+    end
+  end
+end

data/lib/brightbox-cli/detailed_server.rb

@@ -31,9 +31,21 @@ module Brightbox
         row_attributes[:server_groups] = server_groups.map { |sg| sg["id"] }.join(", ")
       end
 
+      row_attributes[:volumes] = volume_ids if volumes
+
       row_attributes
     end
 
+    def volume_ids
+      volumes.map do |vol|
+        if vol["boot"] == true
+          "*#{vol['id']}*"
+        else
+          vol["id"]
+        end
+      end.join(", ")
+    end
+
     def self.default_field_order
       %i[
         id
@@ -65,6 +77,7 @@ module Brightbox
         cloud_ipv6s
         snapshots
         server_groups
+        volumes
       ]
     end
   end

data/lib/brightbox-cli/version.rb

@@ -1,3 +1,3 @@
 module Brightbox
-  VERSION = "4.2.1".freeze unless defined?(Brightbox::VERSION)
+  VERSION = "4.3.1".freeze unless defined?(Brightbox::VERSION)
 end

data/lib/brightbox-cli/volume.rb

@@ -0,0 +1,81 @@
+module Brightbox
+  class Volume < Api
+    def self.require_account?; true; end
+
+    def self.all
+      conn.volumes
+    end
+
+    def self.create(options)
+      new(conn.volumes.create(options))
+    end
+
+    def self.get(id)
+      conn.volumes.get(id)
+    end
+
+    def self.default_field_order
+      %i[
+        id
+        type
+        size
+        status
+        server
+        boot
+        name
+      ]
+    end
+
+    def self.detailed_fields
+      %i[
+        id
+        name
+        description
+        type
+        size
+        status
+        created_at
+        encrypted
+        serial
+        locked
+        filesystem_label
+        filesystem_type
+        image
+        source
+        source_type
+        server
+        boot
+        delete_with_server
+        zone
+      ]
+    end
+
+    def attach(server:, boot: false)
+      self.class.conn.attach_volume(id, server: server, boot: boot)
+      reload
+      self
+    end
+
+    def attributes
+      a = fog_model.attributes
+      a[:id] = fog_model.id
+      a[:image] = image_id
+      a[:locked] = locked?
+      a[:server] = server_id
+      a[:status] = state
+      a[:type] = storage_type
+      a[:zone] = zone_id
+      a
+    end
+
+    def to_row
+      attributes
+    end
+
+    def update(options)
+      self.class.conn.update_volume(id, options)
+      reload
+      self
+    end
+  end
+end

data/lib/brightbox_cli.rb

@@ -56,6 +56,7 @@ module Brightbox
   autoload :DatabaseType, File.expand_path("brightbox-cli/database_type", __dir__)
   autoload :DatabaseServer, File.expand_path("brightbox-cli/database_server", __dir__)
   autoload :DatabaseSnapshot, File.expand_path("brightbox-cli/database_snapshot", __dir__)
+  autoload :Volume, File.expand_path("brightbox-cli/volume", __dir__)
   autoload :Token, File.expand_path("brightbox-cli/token", __dir__)
 
   module Config

data/locales/en.yml

@@ -155,7 +155,7 @@ en:
     reboot:
       desc: Reboot servers (OS reboot issued)
     reset:
-      desc: Reset servers (Hardward reset issued)
+      desc: Reset servers (Hardware reset issued)
     show:
       desc: Show servers
     shutdown:
@@ -245,3 +245,59 @@ en:
       desc: Show users
     update:
       desc: Update a user
+  volumes:
+    desc: Manage an account's volumes
+    args:
+      one: <volume>
+      optional: "[<volume>...]"
+      many: <volume>...
+      specify_one_id_first: You must specify the volume ID as the first argument
+      specify_many_ids: You must specify volume IDs as arguments
+      unknown_id: Couldn't find %{volume}
+    options:
+      boot: Set this volume as boot volume on server
+      delete_with_server: Set volume to be deleted with a server if attached
+      encrypted: Encrypt the volume
+      fs_label: Filesystem label, visible from within some OS
+      fs_type: Filesystem type to use to create blank volume
+      image: Create volume from existing Image ID
+      serial: Customisable serial number for volume
+      size: Volume size in MB
+    attach:
+      desc: Attach a volume to an existing server
+      args: <volume> <server>
+      specify_server_id_second: "You must specify the server ID to attach to as the second argument"
+      acting: Attaching %{volume}
+    copy:
+      desc: Create a new volume from an existing one
+      acting: Copying %{volume}
+    create:
+      desc: Create a new volume
+      acting: Creating volume
+      image_or_type_required: An 'image' or 'fs-type' option must be passed
+      either_image_or_type: An 'image' and 'fs-type' can not be passed together
+    destroy:
+      desc: Destroy one or more volumes
+      acting: Destroying %{volume}
+    detach:
+      desc: Detach a volume from a server
+      acting: Detaching %{volume}
+    list:
+      desc: List all volumes or limit using passed IDs
+    lock:
+      desc: Lock volumes
+      acting: Locking %{volume}
+    resize:
+      desc: Resize a volume
+      size_option_needed: A 'size' option is required
+      acting: Resizing %{volume}
+    show:
+      desc: Show details about multiple volumes
+    unlock:
+      desc: Unlock volumes
+      acting: Unlocking %{volume}
+    update:
+      desc: Update a volume
+      acting: Updating %{volume}
+
+