brightbox-cli 5.0.0.alpha → 5.0.0.rc1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4acdda82f537081ebb5cb73f47463dcb76aa4d13903ef59df37e9c7159e6bcef
-  data.tar.gz: 653ee68c860f906a56daa9c859fcd62b625bcaa32f2c7610fdd62ea57513544e
+  metadata.gz: 1c8cd88f1d668182fcc07ad7ac31d8a3935bcf079321908ec56a364e59e0fe43
+  data.tar.gz: 4b5ae117508d213f075adebf4c70996e95001abe39a6e9de0769232d29f5d3c5
 SHA512:
-  metadata.gz: 64289163116f1e986cad76c3794870c7fe28ac5d2a96ad7cf433ad3bf4fb4f8cb4445930dbddd13d7e9a803df1497940df47877689a3cee5fac5f50561b3f99d
-  data.tar.gz: 793e0f20d1b18450a7024272a6eebb1b61e470c250e3dee740c7251c963b63914fd38ee48af2ae113a27d4046f251320267fece5b8cdd4d298222524aeb46d64
+  metadata.gz: 8b50ffa28cbb39bd012b39de3233ad1e6e29190723e2ed83f1239525c04bdbaa1927b7b26d528246fdbd5d9f6185ed08d88807ab58e7fd970b6dcadf65139b28
+  data.tar.gz: 022e0c725cc12e5d2db5178100f7434a9c52de94eb8330a88688238c9183944b1199016f75d9a868568498a37258bf13d3032b5e9fb3a357198b1605e117503e

data/.github/workflows/ruby.yml

@@ -22,7 +22,8 @@ jobs:
       fail-fast: false
       matrix:
         ruby: ["2.7", "3.0", "3.1", "3.2", "3.3"]
-
+    env:
+      DEBUG: "true"
     steps:
     - uses: actions/checkout@v3
     - name: Set up Ruby ${{ matrix.ruby }}

data/CHANGELOG.md

@@ -1,3 +1,63 @@
+### v5.0.0.rc1 / 2024-12-20
+
+[Full Changelog](https://github.com/brightbox/brightbox-cli/compare/v4.8.0...v5.0.0.rc1)
+
+Backwards incompatible changes:
+
+* Drop support for Ruby versions older than 2.7
+* Update `Gemfile.lock` to use Bundler 2.4.22
+* When ENV `HOME` is not set, the working directory is used for configs
+  rather than `/.brightbox` to fix issues with containers
+
+Enhancements:
+
+* Added support for ACME certificates
+* `brightbox lbs create` and `update` accepts `--acme-domains` with CSV
+  domains to request them to be setup on the load balancer
+* `brightbox lbs show` outputs ACME related fields
+  * `acme_domains` - domains requested to be present
+  * `acme_cert_expires` - when the ACME certificate in no longer valid
+  * `acme_cert_fingerprint` - the fingerprint of the ACME certificate
+  * `acme_cert_issued_at` - when the ACME certificate was issued
+  * `acme_cert_subjects` - domain present on ACME certificate
+* `brightbox firewall-policy` is now an alias for `firewall-policies`
+
+Changes:
+
+* `brightbox images` will now report an deprecated and private image as
+  "private" rather than "deprecated"
+* Update `fog-brightbox` to `v1.12.0`
+* Numerous dependency gems updated
+* Expanded debugging output
+* `Brightbox::Api#attributes` attempts to transform and make attributes
+  indifferent to String or Symbol keys as that has introduced numerous
+  issues over the years. Fog only converts the top level of keys from
+  Strings to Symbols resulting in mismatched keys throughout
+* Refactored all models `#attributes` and `#to_row` methods to use the
+  above with more involved testing
+
+Bug fixes:
+
+* `brightbox lbs create` no longer requires at least one node to balance
+  which was outdated client side validation long removed from the API
+* `brightbox lbs create` should now recognise the `--buffer-size` option
+* `brightbox lbs update` converts `buffer-size` to integer before sending
+* `brightbox cloudips unmap` incorrectly used the "map" description in
+  the help output. This is now fixed
+
+Testing:
+
+* Update CI testing matrix from Ruby 2.7 up to 3.3
+* Ensure bundler version declared in `Gemfile.lock` is used by CI tests
+* CI setting completes all builds rather than cancelling on one fail
+* CI testing includes `DEBUG` ENV settings
+* Tests updated to not "fail" when `DEBUG` output is included upsetting
+  matches to expected output in numerous cases
+* Simplecov has been introduced and configured to prevent a drop in
+  test coverage.
+* Temporary testing config directories are removed explicitly to prevent
+  config bleeding in some test scenarios
+
 ### v4.8.0 / 2024-10-23
 
 [Full Changelog](https://github.com/brightbox/brightbox-cli/compare/v4.7.0...v4.8.0)

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    brightbox-cli (5.0.0.alpha)
+    brightbox-cli (5.0.0.rc1)
       fog-brightbox (>= 1.12.0)
       fog-core (< 2.0)
       gli (~> 2.21)

data/lib/brightbox-cli/accounts.rb

@@ -13,7 +13,11 @@ module Brightbox
     end
 
     def to_row
-      attributes.merge(:ram_free => ram_free, :cloud_ip_limit => cloud_ip_limit, :lb_limit => lb_limit)
+      attributes.to_h.merge(
+        :ram_free => ram_free,
+        :cloud_ip_limit => cloud_ip_limit,
+        :lb_limit => lb_limit
+      )
     end
 
     def self.all

data/lib/brightbox-cli/api.rb

@@ -52,6 +52,16 @@ module Brightbox
       Brightbox.config.cache_id(@id) if Brightbox.config.respond_to?(:cache_id)
     end
 
+    def attributes
+      fog_attributes
+    end
+
+    # Returns the transformed attributes from the fog model with a
+    # wrapper to allow access using either String or Symbol keys.
+    def fog_attributes
+      IndifferentAccessHash.new(deep_symbolize(fog_model.attributes))
+    end
+
     def fog_model
       @fog_model ||= self.class.find(@id)
     end
@@ -62,6 +72,10 @@ module Brightbox
       false
     end
 
+    def to_row
+      attributes.to_h
+    end
+
     def to_s
       @id
     end
@@ -165,7 +179,7 @@ module Brightbox
       if value
         value
       else
-        Brightbox.config.cache_id id
+        Brightbox.config.cache_id id if Brightbox.config.respond_to?(:cache_id)
         @cache[id] = get(id)
       end
     end
@@ -192,5 +206,24 @@ module Brightbox
 
       fog_model.created_at.strftime("%Y-%m-%d")
     end
+
+    private
+
+    # Recursively converts all keys in a hash to symbols to ensure
+    # consistent access.
+    def deep_symbolize(hash)
+      return hash unless hash.respond_to?(:each_with_object)
+
+      hash.each_with_object({}) do |(k, v), result|
+        result[k.to_sym] = case v
+                           when Hash
+                             deep_symbolize(v)
+                           when Array
+                             v.map { |i| i.is_a?(Hash) ? deep_symbolize(i) : i }
+                           else
+                             v
+                           end
+      end
+    end
   end
 end

data/lib/brightbox-cli/cloud_ips.rb

@@ -33,15 +33,15 @@ module Brightbox
     end
 
     def attributes
-      a = fog_model.attributes
-      a[:destination] = destination_id
-      a
+      fog_attributes.tap do |attrs|
+        attrs[:destination] = destination_id
+      end
     end
 
     def to_row
-      o = attributes
-      o[:port_translators] = translators(o)
-      o
+      attributes.merge(
+        port_translators: translators(attributes),
+      ).to_h
     end
 
     def mapped?

data/lib/brightbox-cli/collaboration.rb

@@ -31,14 +31,10 @@ module Brightbox
 
     attr_reader :id
 
-    def attributes
-      fog_model.attributes
-    end
-
     def to_row
-      row_attributes = attributes
-      row_attributes[:name] = invitee_name
-      row_attributes
+      attributes.merge(
+        name: invitee_name
+      ).to_h
     end
 
     def invitee_name

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

@@ -61,8 +61,6 @@ module Brightbox
       c.switch ["sslv3"]
 
       c.action do |global_options, options, args|
-        raise "You must specify which servers to balance connections to" if args.empty?
-
         listeners = options[:l].split(",").map do |l|
           inport, outport, protocol, timeout = l.split ":"
           raise "listener '#{l}' is invalid" if inport.nil? || outport.nil? || protocol.nil?

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

@@ -17,6 +17,10 @@ module Brightbox
             deleted_at
             policy
             acme_domains
+            acme_cert_subjects
+            acme_cert_fingerprint
+            acme_cert_expires_at
+            acme_cert_issued_at
             ssl_minimum_version
             ssl_issuer
             ssl_subject

data/lib/brightbox-cli/config.rb

@@ -91,11 +91,17 @@ module Brightbox
     def debug_tokens
       return unless ENV["DEBUG"]
 
-      debug "Access token: #{access_token} (#{cached_access_token})"
-      if using_application?
-        debug "Refresh token: #{refresh_token} (#{cached_refresh_token}))"
+      if client_name
+        debug "Client: #{client_name}"
+
+        debug "Access token: #{access_token} (#{cached_access_token})"
+        if using_application?
+          debug "Refresh token: #{refresh_token} (#{cached_refresh_token}))"
+        else
+          debug "Refresh token: <NOT EXPECTED FOR CLIENT>"
+        end
       else
-        debug "Refresh token: <NOT EXPECTED FOR CLIENT>"
+        debug "No client selected"
       end
     end
 

data/lib/brightbox-cli/database_server.rb

@@ -70,34 +70,34 @@ module Brightbox
     end
 
     def type_identifier
-      return unless fog_model.attributes.key?("database_server_type")
+      return unless fog_attributes.key?("database_server_type")
 
-      fog_model.attributes["database_server_type"]["id"]
+      fog_attributes["database_server_type"]["id"]
     end
 
     def zone_handle
-      return unless fog_model.attributes.key?("zone")
+      return unless fog_attributes.key?("zone")
 
-      fog_model.attributes["zone"]["handle"]
+      fog_attributes["zone"]["handle"]
     end
 
     def to_row
-      a = fog_model.attributes
-      a[:status] = fog_model.state
-      a[:locked] = locked?
-      a[:type] = type_identifier
-      a[:db_engine] = engine_version
-      a[:engine] = database_engine
-      a[:version] = database_version
-      a[:maintenance_weekday] = maintenance_weekday
-      a[:maintenance_hour] = maintenance_hour
-      a[:maintenance_window] = maintenance_window
-      a[:zone] = zone_handle
-      a[:created_on] = created_on
-      a[:allow_access] = allow_access
-      a[:cloud_ip_ids] = cloud_ip_ids
-      a[:cloud_ips] = cloud_ip_addresses
-      a
+      attributes.merge(
+        status: fog_model.state,
+        locked: locked?,
+        type: type_identifier,
+        db_engine: engine_version,
+        engine: database_engine,
+        version: database_version,
+        maintenance_weekday: maintenance_weekday,
+        maintenance_hour: maintenance_hour,
+        maintenance_window: maintenance_window,
+        zone: zone_handle,
+        created_on: created_on,
+        allow_access: allow_access,
+        cloud_ip_ids: cloud_ip_ids,
+        cloud_ips: cloud_ip_addresses
+      )
     end
 
     def engine_version

data/lib/brightbox-cli/database_snapshot.rb

@@ -27,11 +27,11 @@ module Brightbox
     end
 
     def to_row
-      a = fog_model.attributes
-      a[:status] = fog_model.state
-      a[:locked] = locked?
-      a[:created_on] = fog_model.created_at.strftime("%Y-%m-%d")
-      a
+      fog_attributes.merge(
+        status: fog_model.state,
+        locked: locked?,
+        created_on: fog_model.created_at.strftime("%Y-%m-%d")
+      )
     end
   end
 end

data/lib/brightbox-cli/database_type.rb

@@ -3,10 +3,10 @@ module Brightbox
     def self.require_account?; true; end
 
     def attributes
-      o = fog_model.attributes
-      o[:ram] = ram
-      o[:disk] = disk
-      o
+      fog_attributes.tap do |attrs|
+        attrs[:ram] = ram
+        attrs[:disk] = disk
+      end
     end
 
     def ram
@@ -17,10 +17,6 @@ module Brightbox
       fog_model.disk.to_i
     end
 
-    def to_row
-      attributes
-    end
-
     def self.all
       conn.database_types
     end

data/lib/brightbox-cli/detailed_server.rb

@@ -1,40 +1,38 @@
 module Brightbox
   class DetailedServer < Server
     def to_row
-      row_attributes = attributes
+      attributes.tap do |attrs|
+        attrs[:compatibility_mode] = attrs["compatibility_mode"]
 
-      row_attributes[:compatibility_mode] = row_attributes["compatibility_mode"]
-
-      if server_type
-        row_attributes[:type] = server_type["id"]
-        row_attributes[:type_handle] = server_type["handle"]
-        row_attributes[:type_name] = server_type["name"]
-        row_attributes[:ram] = server_type["ram"]
-        row_attributes[:cores] = server_type["cores"]
-        row_attributes[:disk] = server_type["disk_size"].to_i
-      end
-
-      if image
-        row_attributes[:image_name] = image.name
-        row_attributes[:arch] = image.arch
-        row_attributes[:image_username] = image.username
-      end
+        if server_type
+          attrs[:type] = server_type["id"]
+          attrs[:type_handle] = server_type["handle"]
+          attrs[:type_name] = server_type["name"]
+          attrs[:ram] = server_type["ram"]
+          attrs[:cores] = server_type["cores"]
+          attrs[:disk] = server_type["disk_size"].to_i
+        end
 
-      row_attributes[:private_ips] = interfaces.map { |i| i["ipv4_address"] }.join(", ")
-      row_attributes[:ipv6_address] = interfaces.map { |i| i["ipv6_address"] }.join(", ")
+        if image
+          attrs[:image_name] = image.name
+          attrs[:arch] = image.arch
+          attrs[:image_username] = image.username
+        end
 
-      row_attributes[:cloud_ip_ids] = cloud_ips.map { |i| i["id"] }.join(", ")
-      row_attributes[:cloud_ipv4s] = cloud_ips.map { |i| i["public_ipv4"] }.join(", ")
-      row_attributes[:cloud_ipv6s] = cloud_ips.map { |i| i["public_ipv6"] }.join(", ")
-      row_attributes[:snapshots] = snapshots.map { |i| i["id"] }.join(", ")
+        attrs[:private_ips] = interfaces.map { |i| i["ipv4_address"] }.join(", ")
+        attrs[:ipv6_address] = interfaces.map { |i| i["ipv6_address"] }.join(", ")
 
-      if server_groups
-        row_attributes[:server_groups] = server_groups.map { |sg| sg["id"] }.join(", ")
-      end
+        attrs[:cloud_ip_ids] = cloud_ips.map { |i| i["id"] }.join(", ")
+        attrs[:cloud_ipv4s] = cloud_ips.map { |i| i["public_ipv4"] }.join(", ")
+        attrs[:cloud_ipv6s] = cloud_ips.map { |i| i["public_ipv6"] }.join(", ")
+        attrs[:snapshots] = snapshots.map { |i| i["id"] }.join(", ")
 
-      row_attributes[:volumes] = volume_ids if volumes
+        if server_groups
+          attrs[:server_groups] = server_groups.map { |sg| sg["id"] }.join(", ")
+        end
 
-      row_attributes
+        attrs[:volumes] = volume_ids if volumes
+      end.to_h
     end
 
     def volume_ids

data/lib/brightbox-cli/detailed_server_group.rb

@@ -1,9 +1,9 @@
 module Brightbox
   class DetailedServerGroup < ServerGroup
     def to_row
-      row_attributes = super
+      row_attributes = attributes
       row_attributes[:firewall_policy] = firewall_policy && firewall_policy.id
-      row_attributes
+      row_attributes.to_h
     end
 
     def self.default_field_order

data/lib/brightbox-cli/firewall_policy.rb

@@ -15,15 +15,11 @@ module Brightbox
     end
 
     def attributes
-      t = fog_model.attributes
-      t[:name] = name
-      t[:description] = description
-      t[:server_group] = server_group_id
-      t
-    end
-
-    def to_row
-      attributes
+      fog_attributes.tap do |attrs|
+        attrs[:name] = name
+        attrs[:description] = description
+        attrs[:server_group] = server_group_id
+      end
     end
 
     def self.default_field_order

data/lib/brightbox-cli/firewall_rule.rb

@@ -19,24 +19,23 @@ module Brightbox
     end
 
     def attributes
-      t = @attributes || fog_model.attributes
-      t[:sport] = t[:source_port]
-      t[:dport] = t[:destination_port]
-      t[:firewall_policy] = t[:firewall_policy_id]
-      t[:icmp_type] = t[:icmp_type_name]
-      t
-    end
-
-    def to_row
-      attrs = attributes.dup
-      %i[protocol source sport destination dport icmp_type].each do |key|
-        attrs[key] = attributes[key] || "-"
+      (@attributes || fog_attributes).tap do |attrs|
+        attrs[:sport] = attrs[:source_port]
+        attrs[:dport] = attrs[:destination_port]
+        attrs[:firewall_policy] = attrs[:firewall_policy_id]
+        attrs[:icmp_type] = attrs[:icmp_type_name]
       end
-      attrs
     end
 
-    def ret_val(attributes, key)
-      attributes[key] || "-"
+    def to_row
+      attributes.merge(
+        protocol: attributes[:protocol] || "-",
+        source: attributes[:source] || "-",
+        sport: attributes[:sport] || "-",
+        destination: attributes[:destination] || "-",
+        dport: attributes[:dport] || "-",
+        icmp_type: attributes[:icmp_type] || "-"
+      )
     end
 
     def self.default_field_order

data/lib/brightbox-cli/images.rb

@@ -16,7 +16,7 @@ module Brightbox
     end
 
     def self.default_field_order
-      %i[id owner type created_on status size arch name]
+      %i[id owner type created_on status size name]
     end
 
     # Filter out images that are not of the right type, account or status if the option is passed
@@ -68,31 +68,32 @@ module Brightbox
     end
 
     def status
-      if fog_model.attributes[:status] == "available"
+      if fog_attributes[:status] == "available"
         public? ? "public" : "private"
+      elsif fog_attributes[:status] == "deprecated"
+        public? ? "deprecated" : "private"
       else
-        fog_model.attributes[:status]
+        fog_attributes[:status]
       end
     end
 
     def to_row
-      o = fog_model.attributes
-      o[:id] = fog_model.id
-      o[:status] = status
-      o[:locked] = locked?
-      o[:username] = username
-      o[:arch] = arch
-      o[:name] = name.to_s
-      o[:owner] = owner_id
-      o[:owner] = "brightbox" if official
-      o[:type] = type
-      o[:created_at] = created_at
-      o[:created_on] = created_on
-      o[:description] = description if description
-      o[:licence_name] = licence_name
-      o[:size] = virtual_size
-      o[:min_ram] = min_ram
-      o
+      fog_attributes.merge(
+        id: fog_model.id,
+        status: status,
+        locked: locked?,
+        username: username,
+        arch: arch,
+        name: name.to_s + " (#{arch})",
+        owner: official ? "brightbox" : owner_id,
+        type: type,
+        created_at: created_at,
+        created_on: created_on,
+        description: description,
+        licence_name: licence_name,
+        size: virtual_size,
+        min_ram: min_ram
+      )
     end
 
     def public?
@@ -100,7 +101,7 @@ module Brightbox
     end
 
     def status_sort_code
-      case fog_model.attributes[:status]
+      case fog_attributes[:status]
       when "available"
         (public? ? 1 : 2)
       when "deprecated"

data/lib/brightbox-cli/indifferent_access_hash.rb

@@ -0,0 +1,50 @@
+# A simpler wrapper to allows either String or Symbol keys to be used
+# when accessing attributes since fog applies a change on the top
+# level resulting in a mix of both which has introduced issues.
+class IndifferentAccessHash
+  def initialize(hash)
+    @hash = hash
+  end
+
+  # @param key [String, Symbol] the key to look up
+  # @return [Object] the value of the key
+  def [](key)
+    value = @hash[key.to_s] || @hash[key.to_sym]
+    wrap(value)
+  end
+
+  # @param key [String, Symbol] the key to set
+  # @param value [Object] the value to set
+  # @return [Object] the value of the key
+  def []=(key, value)
+    @hash[key.to_sym] = value
+  end
+
+  # @param other [Object] the object to compare
+  # @return [Object] the result of the comparison
+  def ==(other)
+    @hash == (other.is_a?(IndifferentAccessHash) ? other.to_h : other)
+  end
+
+  def method_missing(method, *args, &block)
+    @hash.send(method, *args, &block)
+  end
+
+  def to_h
+    @hash
+  end
+
+  private
+
+  # This is to handle nested hashes to avoid the original issue again
+  def wrap(value)
+    case value
+    when Hash
+      IndifferentAccessHash.new(value)
+    when Array
+      value.map { |v| wrap(v) }
+    else
+      value
+    end
+  end
+end