brightbox-cli 4.8.0 → 5.0.0.rc1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1957aedb76eb618990c1deca7846319433ce2cc3b88ed2f4b3eac0b4aca3b3c0
-  data.tar.gz: b7a83328c30eb76699b880cb8a6a356cf61bf3e362c19c50b1f8c4dcbbc17c6d
+  metadata.gz: 1c8cd88f1d668182fcc07ad7ac31d8a3935bcf079321908ec56a364e59e0fe43
+  data.tar.gz: 4b5ae117508d213f075adebf4c70996e95001abe39a6e9de0769232d29f5d3c5
 SHA512:
-  metadata.gz: 1a2a3316ce568a85d06eea928b5382d0a9a0b2737e2e14c01940a2f2071f8cd10d5c7a25c4f3af2878d5d453c98d70b1bfb50a6fa92b46ed7c5ca4f075fb844f
-  data.tar.gz: 3cd77f4748d94aea53ac8685268228f112aef95e9c8b9a8aca00692d67dc10e92948fa5acef2c696cf6ce08c58920ded07a1167e3933fcc4faf9e2736c480903
+  metadata.gz: 8b50ffa28cbb39bd012b39de3233ad1e6e29190723e2ed83f1239525c04bdbaa1927b7b26d528246fdbd5d9f6185ed08d88807ab58e7fd970b6dcadf65139b28
+  data.tar.gz: 022e0c725cc12e5d2db5178100f7434a9c52de94eb8330a88688238c9183944b1199016f75d9a868568498a37258bf13d3032b5e9fb3a357198b1605e117503e

data/.github/workflows/ruby.yml

@@ -19,9 +19,11 @@ jobs:
     runs-on: ubuntu-latest
 
     strategy:
+      fail-fast: false
       matrix:
-        ruby: ["2.5", "2.6", "2.7", "3.0", "3.1", "3.2", "3.3"]
-
+        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 }}
@@ -30,6 +32,8 @@ jobs:
       uses: ruby/setup-ruby@v1
       with:
         ruby-version: ${{ matrix.ruby }}
+    - name: Install Bundler
+      run: gem install bundler -v $(grep -A 1 "BUNDLED WITH" Gemfile.lock | tail -n 1 | awk '{print $1}')
     - name: Install dependencies
       run: bundle install
     - name: Run tests

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,9 +1,8 @@
 PATH
   remote: .
   specs:
-    brightbox-cli (4.8.0)
-      dry-inflector (= 0.2.0)
-      fog-brightbox (>= 1.11.0)
+    brightbox-cli (5.0.0.rc1)
+      fog-brightbox (>= 1.12.0)
       fog-core (< 2.0)
       gli (~> 2.21)
       highline (~> 2.0)
@@ -24,9 +23,10 @@ GEM
     crack (0.4.5)
       rexml
     diff-lcs (1.5.0)
-    dry-inflector (0.2.0)
+    docile (1.4.1)
+    dry-inflector (1.1.0)
     excon (0.112.0)
-    fog-brightbox (1.11.0)
+    fog-brightbox (1.12.0)
       dry-inflector
       fog-core (>= 1.45, < 3.0)
       fog-json
@@ -38,18 +38,18 @@ GEM
       fog-core
       multi_json (~> 1.10)
     formatador (0.3.0)
-    gli (2.21.5)
+    gli (2.22.0)
     hashdiff (1.0.1)
     highline (2.1.0)
     hirb (0.7.3)
     i18n (1.10.0)
       concurrent-ruby (~> 1.0)
-    logger (1.6.1)
+    logger (1.6.2)
     method_source (1.0.0)
     mime-types (3.6.0)
       logger
       mime-types-data (~> 3.2015)
-    mime-types-data (3.2024.1001)
+    mime-types-data (3.2024.1203)
     mocha (1.14.0)
     multi_json (1.15.0)
     parallel (1.22.1)
@@ -65,7 +65,7 @@ GEM
     rainbow (3.1.1)
     rake (13.0.6)
     regexp_parser (2.5.0)
-    rexml (3.2.5)
+    rexml (3.3.9)
     rspec (3.11.0)
       rspec-core (~> 3.11.0)
       rspec-expectations (~> 3.11.0)
@@ -95,6 +95,12 @@ GEM
     rubocop-rspec (2.10.0)
       rubocop (~> 1.19)
     ruby-progressbar (1.11.0)
+    simplecov (0.22.0)
+      docile (~> 1.1)
+      simplecov-html (~> 0.11)
+      simplecov_json_formatter (~> 0.1)
+    simplecov-html (0.13.1)
+    simplecov_json_formatter (0.1.4)
     slop (3.6.0)
     unicode-display_width (2.1.0)
     vcr (2.9.3)
@@ -115,8 +121,9 @@ DEPENDENCIES
   rubocop
   rubocop-rake
   rubocop-rspec
+  simplecov
   vcr (~> 2.5)
   webmock
 
 BUNDLED WITH
-   2.2.33
+   2.4.22

data/brightbox-cli.gemspec

@@ -14,14 +14,14 @@ Gem::Specification.new do |s|
   s.license     = "MIT"
   s.metadata['rubygems_mfa_required'] = 'true'
 
-  s.required_ruby_version = ">= 2.5"
+  s.required_ruby_version = ">= 2.7"
 
   s.files         = `git ls-files`.split("\n") + `find lib/brightbox-cli/vendor`.split("\n")
   s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
   s.executables   = `git ls-files -- bin/*`.split("\n").map { |f| File.basename(f) }
   s.require_paths = ["lib"]
 
-  s.add_dependency "fog-brightbox", ">= 1.11.0"
+  s.add_dependency "fog-brightbox", ">= 1.12.0"
   s.add_dependency "fog-core", "< 2.0"
   s.add_dependency "gli", "~> 2.21"
   s.add_dependency "highline", "~> 2.0"
@@ -30,11 +30,6 @@ Gem::Specification.new do |s|
   s.add_dependency "mime-types", "~> 3.0"
   s.add_dependency "multi_json", "~> 1.11"
 
-  # Indirect dependency
-  # 0.3 drops support for Ruby < 2.7
-  # 0.2.1 drops support for Ruby < 2.6
-  s.add_dependency "dry-inflector", "= 0.2.0"
-
   s.add_development_dependency "mocha"
   s.add_development_dependency "pry-remote"
   s.add_development_dependency "rake"
@@ -42,6 +37,7 @@ Gem::Specification.new do |s|
   s.add_development_dependency "rubocop"
   s.add_development_dependency "rubocop-rake"
   s.add_development_dependency "rubocop-rspec"
+  s.add_development_dependency "simplecov"
   s.add_development_dependency "vcr", "~> 2.5"
   s.add_development_dependency "webmock"
 end

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/cloudips/unmap.rb

@@ -1,6 +1,6 @@
 module Brightbox
   command [:cloudips] do |cmd|
-    cmd.desc I18n.t("cloudips.map.desc")
+    cmd.desc I18n.t("cloudips.unmap.desc")
     cmd.arg_name "cloudip-id..."
     cmd.command [:unmap] do |c|
       c.action do |global_options, _options, args|

data/lib/brightbox-cli/commands/firewall/policies_apply.rb

@@ -1,6 +1,6 @@
 module Brightbox
   desc I18n.t("firewall.policies.desc")
-  command [:"firewall-policies"] do |cmd|
+  command ["firewall-policies", "firewall-policy"] do |cmd|
     cmd.desc I18n.t("firewall.policies.apply.desc")
     cmd.arg_name "firewall-policy-id server-group-id"
     cmd.command [:apply] do |c|

data/lib/brightbox-cli/commands/firewall/policies_create.rb

@@ -1,5 +1,5 @@
 module Brightbox
-  command [:"firewall-policies"] do |cmd|
+  command ["firewall-policies", "firewall-policy"] do |cmd|
     cmd.desc I18n.t("firewall.policies.create.desc")
     cmd.arg_name "[server-group-id...]"
     cmd.command [:create] do |c|

data/lib/brightbox-cli/commands/firewall/policies_destroy.rb

@@ -1,5 +1,5 @@
 module Brightbox
-  command [:"firewall-policies"] do |cmd|
+  command ["firewall-policies", "firewall-policy"] do |cmd|
     cmd.desc I18n.t("firewall.policies.destroy.desc")
     cmd.arg_name "[firewall-policy-id...]"
     cmd.command [:destroy] do |c|

data/lib/brightbox-cli/commands/firewall/policies_list.rb

@@ -1,5 +1,5 @@
 module Brightbox
-  command [:"firewall-policies"] do |cmd|
+  command ["firewall-policies", "firewall-policy"] do |cmd|
     cmd.default_command :list
 
     cmd.desc I18n.t("firewall.policies.list.desc")

data/lib/brightbox-cli/commands/firewall/policies_remove.rb

@@ -1,5 +1,5 @@
 module Brightbox
-  command [:"firewall-policies"] do |cmd|
+  command ["firewall-policies", "firewall-policy"] do |cmd|
     cmd.desc I18n.t("firewall.policies.remove.desc")
     cmd.arg_name "firewall-policy-id server-group-id"
     cmd.command [:remove] do |c|

data/lib/brightbox-cli/commands/firewall/policies_show.rb

@@ -1,5 +1,5 @@
 module Brightbox
-  command [:"firewall-policies"] do |cmd|
+  command ["firewall-policies", "firewall-policy"] do |cmd|
     cmd.desc I18n.t("firewall.policies.show.desc")
     cmd.arg_name "firewall-policy-id"
     cmd.command [:show] do |c|

data/lib/brightbox-cli/commands/firewall/policies_update.rb

@@ -1,5 +1,5 @@
 module Brightbox
-  command [:"firewall-policies"] do |cmd|
+  command ["firewall-policies", "firewall-policy"] do |cmd|
     cmd.desc I18n.t("firewall.policies.update.desc")
     cmd.arg_name "firewall-policy-id"
     cmd.command [:update] do |c|

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

@@ -32,18 +32,21 @@ module Brightbox
       c.default_value "/"
       c.flag [:s, "hc-request"]
 
-      c.desc "Healthcheck interval"
+      c.desc "Health check interval"
       c.default_value "5000"
       c.flag [:e, "hc-interval"]
 
-      c.desc "Healthcheck threshold up. Number of successful healthchecks for the node to be considered up."
+      c.desc "Health check threshold up. Number of successful health checks for the node to be considered up."
       c.default_value "3"
       c.flag [:u, "hc-up"]
 
-      c.desc "Healthcheck threshold down. Number of failed healthchecks for the node to be considered down."
+      c.desc "Health check threshold down. Number of failed health checks for the node to be considered down."
       c.default_value "3"
       c.flag [:d, "hc-down"]
 
+      c.desc "ACME domains"
+      c.flag ["acme_domains"]
+
       c.desc "Filepath to the SSL certificate file to use."
       c.flag ["ssl-cert"]
 
@@ -58,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?
@@ -78,6 +79,14 @@ module Brightbox
           options[:y] = listeners.first[:protocol]
         end
 
+        if options[:b]
+          options[:b] = options[:b].to_i
+        end
+
+        if options["acme_domains"]
+          options["acme_domains"] = options["acme_domains"].split(",")
+        end
+
         hc_arg_lookup = {
           :k => :port,
           :y => :type,
@@ -96,7 +105,7 @@ module Brightbox
           end
         end
 
-        # SSL argumens
+        # SSL arguments
         ssl_cert_path = options["ssl-cert"]
         ssl_key_path = options["ssl-key"]
 
@@ -113,16 +122,19 @@ module Brightbox
 
         msg = "Creating a new load balancer"
         info msg
-        lb = LoadBalancer.create(:policy => options[:policy],
-                                 :name => options[:n],
-                                 :buffer_size => options[:b],
-                                 :healthcheck => healthcheck,
-                                 :listeners => listeners,
-                                 :certificate_pem => ssl_cert,
-                                 :certificate_private_key => ssl_key,
-                                 :ssl_minimum_version => options["ssl-min-ver"],
-                                 :sslv3 => options["sslv3"],
-                                 :nodes => nodes)
+        lb = LoadBalancer.create(
+          domains: options["acme_domains"],
+          buffer_size: options[:b],
+          certificate_pem: ssl_cert,
+          certificate_private_key: ssl_key,
+          healthcheck: healthcheck,
+          listeners: listeners,
+          name: options[:n],
+          nodes: nodes,
+          policy: options[:policy],
+          ssl_minimum_version: options["ssl-min-ver"],
+          sslv3: options["sslv3"]
+        )
         render_table([lb], global_options)
       end
     end

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

@@ -16,6 +16,11 @@ module Brightbox
             created_at
             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/commands/lbs/update.rb

@@ -37,6 +37,9 @@ module Brightbox
       c.desc "Healthcheck threshold down. Number of failed healthchecks for the node to be considered down."
       c.flag [:d, "hc-down"]
 
+      c.desc "ACME domains"
+      c.flag ["acme_domains"]
+
       c.desc "Filepath to the SSL certificate file to use."
       c.flag ["ssl-cert"]
 
@@ -100,10 +103,10 @@ module Brightbox
         end
 
         if options[:b]
-          lbopts[:buffer_size] = options[:b]
+          lbopts[:buffer_size] = options[:b].to_i
         end
 
-        # SSL argumens
+        # SSL arguments
         ssl_cert_path = options["ssl-cert"]
         ssl_key_path = options["ssl-key"]
         remove_ssl = options["remove-ssl"]
@@ -132,6 +135,10 @@ module Brightbox
           lbopts[:ssl_minimum_version] = options["ssl-min-ver"]
         end
 
+        if options["acme_domains"]
+          lbopts[:domains] = options["acme_domains"].split(",")
+        end
+
         lbopts.nilify_blanks
 
         lb = LoadBalancer.find lb_id

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
 
@@ -112,7 +118,8 @@ module Brightbox
     private
 
     def default_config_dir
-      File.join(ENV.fetch("HOME", nil), ".brightbox")
+      config_dir = ENV.fetch("HOME", nil) || Dir.pwd
+      File.join(config_dir, ".brightbox")
     end
 
     def configured?

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