brightbox-cli 4.3.1 → 4.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a05097c67b080ccedd218b30d3e0923b4b1804c76ac5cbe5a76678b75d8f221e
-  data.tar.gz: 9c9076964ac3c57b48a7d4d55183e4c2c87214462e564823dc815d566d1f95ad
+  metadata.gz: 20cc19a7e6458988359a604fa90d67570b83c124b40c265a5f9beb0d3bc3a199
+  data.tar.gz: 98072a6ccd8ab0dcf4a3e3ac7f27ecf6982a7f3cf275b86e979aae0fc12461d8
 SHA512:
-  metadata.gz: 768f52b7d7eaed35b46d606f4699e23b2793f9ba0a00c86feaa0155cda89a55cc7a02e5f53268c554cd8731a0154bd1f5b37a0bdffb2f18c7cf852a97c353516
-  data.tar.gz: 5178134a5acd7146df5a1d4e127773d0e9b322e48a0495bc01eba5408c25e81cc4e7f3d08c45ee83332d84cd04e7e562f7d2f0778c1762182e9787b9451e5066
+  metadata.gz: 1c949f6d0679c9d72b7c7f61a6a0fd68b0669452911dde7da845a6f7e9a388c5b2a253ab0219bf6228faf4bc51ac6accfc559d714425c18499525d47b84ab73e
+  data.tar.gz: 7975e2d18399cc35bcd49f474657f6766e5d694bdbf70a1d49b79288edcbc9c07ea1d54b0757bd992ef08c517d4eef0e2a684e9ebf102f4718f3c72bc31368f9

data/CHANGELOG.md

@@ -1,3 +1,34 @@
+### v4.4.0 / 2023-01-26
+
+[Full Changelog](https://github.com/brightbox/brightbox-cli/compare/v4.3.2...v4.4.0)
+
+Enhancements:
+
+* Added `configmaps` subcommand for manage config management.
+
+### v4.3.2 / 2023-01-12
+
+[Full Changelog](https://github.com/brightbox/brightbox-cli/compare/v4.3.1...v4.3.2)
+
+Bug fixes:
+
+* Declared top level help for `volumes` subcommand.
+* Fix `volumes update --delete-with-server` switch.
+* Fix `lbs update --sslv3` switch.
+* Fix `servers update --compatibility-mode` switch.
+
+Changes:
+
+* Added a `ignore_default` option to GLI DSL, by monkey patching, to prevent
+  unexpected switches from interfering with API calls. In some cases it was
+  impossible to determine if `--feature` or `--no-feature` had been used in the
+  command OR added as a default in GLI. This meant `update` commands would always
+  send `feature: false` in API requests even when updating names and other fields.
+  This could clear setting unexpectedly due to the behaviour.
+* Test `servers create --compatibility-mode` switch.
+* Test `cloudips update --delete-reverse-dns` switch.
+* Test `sql instances --remove-snapshots-schedule` switch.
+
 ### v4.3.1 / 2023-01-11
 
 [Full Changelog](https://github.com/brightbox/brightbox-cli/compare/v4.3.0...v4.3.1)

data/Gemfile.lock

@@ -1,9 +1,9 @@
 PATH
   remote: .
   specs:
-    brightbox-cli (4.3.1)
+    brightbox-cli (4.4.0)
       dry-inflector (= 0.2.0)
-      fog-brightbox (>= 1.9.1)
+      fog-brightbox (>= 1.10.0)
       fog-core (< 2.0)
       gli (~> 2.21)
       highline (~> 2.0)
@@ -20,13 +20,13 @@ GEM
     ast (2.4.2)
     builder (3.2.4)
     coderay (1.1.3)
-    concurrent-ruby (1.1.10)
+    concurrent-ruby (1.2.0)
     crack (0.4.5)
       rexml
     diff-lcs (1.5.0)
     dry-inflector (0.2.0)
-    excon (0.97.0)
-    fog-brightbox (1.9.1)
+    excon (0.97.2)
+    fog-brightbox (1.10.0)
       dry-inflector
       fog-core (>= 1.45, < 3.0)
       fog-json

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.9.1"
+  s.add_dependency "fog-brightbox", ">= 1.10.0"
   s.add_dependency "fog-core", "< 2.0"
   s.add_dependency "gli", "~> 2.21"
   s.add_dependency "highline", "~> 2.0"

data/lib/brightbox-cli/commands/configmaps.rb

@@ -0,0 +1,183 @@
+module Brightbox
+  desc I18n.t("configmaps.desc")
+  command [:configmaps] do |cmd|
+    cmd.default_command :list
+
+    cmd.desc I18n.t("configmaps.create.desc")
+    cmd.arg_name I18n.t("configmaps.args.one")
+    cmd.command [:create] do |c|
+      c.desc I18n.t("options.name.desc")
+      c.flag %i[n name]
+
+      c.desc I18n.t("configmaps.options.data_string")
+      c.flag %i[d data]
+
+      c.desc I18n.t("configmaps.options.data_file")
+      c.flag [:"data-file"]
+
+      c.action do |global_options, options, _args|
+        map_data = parse_configmap_data_options(options)
+
+        raise I18n.t("configmaps.create.data_required") if map_data.nil?
+
+        # Attempt to parse data as JSON but do not update
+        begin
+          JSON.parse(map_data)
+        rescue StandardError
+          raise I18n.t("configmaps.options.bad_data")
+        end
+
+        params = {
+          data: map_data
+        }
+        params[:name] = options[:name] if options[:name]
+
+        info I18n.t("configmaps.create.acting")
+        config_map = ConfigMap.create(params)
+
+        render_table([config_map], global_options)
+      end
+    end
+
+    cmd.desc I18n.t("configmaps.destroy.desc")
+    cmd.arg_name I18n.t("configmaps.args.many")
+    cmd.command [:destroy] do |c|
+      c.action do |_global_options, _options, args|
+        raise I18n.t("configmaps.args.specify_many_ids") if args.empty?
+
+        config_maps = ConfigMap.find_or_call(args) do |id|
+          raise I18n.t("configmaps.args.unknown_id", config_map: id)
+        end
+
+        config_maps.each do |config_map|
+          info I18n.t("configmaps.destroy.acting", config_map: config_map)
+
+          begin
+            config_map.destroy
+          rescue Brightbox::Api::Conflict
+            error I18n.t("configmaps.destroy.failed", config_map: id)
+          end
+        end
+      end
+    end
+
+    cmd.desc I18n.t("configmaps.list.desc")
+    cmd.arg_name I18n.t("configmaps.args.optional")
+    cmd.command [:list] do |c|
+      c.action do |global_options, _options, args|
+        config_maps = ConfigMap.find_all_or_warn(args)
+
+        render_table(config_maps, global_options)
+      end
+    end
+
+    cmd.desc I18n.t("configmaps.show.desc")
+    cmd.arg_name I18n.t("configmaps.args.optional")
+    cmd.command [:show] do |c|
+      c.desc I18n.t("configmaps.options.data_output")
+      c.switch [:data], negatable: false, default: false
+
+      c.desc I18n.t("configmaps.options.data_format")
+      c.flag [:format]
+
+      c.action do |global_options, options, args|
+        if options[:data]
+          unless args.length == 1
+            raise I18n.t("configmaps.options.data_args")
+          end
+
+          cfg_id = args[0]
+
+          if cfg_id.nil? || !cfg_id.start_with?("cfg-")
+            raise I18n.t("configmaps.args.specify_one_id_first")
+          end
+
+          config_map = ConfigMap.find(cfg_id)
+          data(config_map.format_data(options[:format] || "json"))
+        else
+          if options[:format] && !options[:data]
+            raise I18n.t("configmaps.options.format_no_data")
+          end
+
+          config_maps = ConfigMap.find_all_or_warn(args)
+
+          table_opts = global_options.merge(
+            vertical: true
+          )
+          render_table(config_maps, table_opts)
+        end
+      end
+    end
+
+    cmd.desc I18n.t("configmaps.update.desc")
+    cmd.arg_name I18n.t("configmaps.args.one")
+    cmd.command [:update] do |c|
+      c.desc I18n.t("options.name.desc")
+      c.flag %i[n name]
+
+      c.desc I18n.t("configmaps.options.data_string")
+      c.flag %i[d data]
+
+      c.desc I18n.t("configmaps.options.data_file")
+      c.flag [:"data-file"]
+
+      c.action do |global_options, options, args|
+        cfg_id = args[0]
+
+        if cfg_id.nil? || !cfg_id.start_with?("cfg-")
+          raise I18n.t("configmaps.args.specify_one_id_first")
+        end
+
+        params = {}
+        params[:name] = options[:name] if options[:name]
+
+        map_data = parse_configmap_data_options(options)
+
+        if map_data
+          begin
+            map_data = JSON.parse(map_data)
+          rescue StandardError
+            raise I18n.t("configmaps.options.bad_data")
+          end
+
+          params[:data] = map_data
+        end
+
+        config_map = ConfigMap.find(cfg_id)
+
+        unless params.empty?
+          info I18n.t("configmaps.update.acting", config_map: config_map)
+          config_map.update(params)
+        end
+
+        render_table([config_map], global_options)
+      end
+    end
+  end
+
+  def parse_configmap_data_options(options)
+    if options[:data] && options[:"data-file"]
+      raise I18n.t("configmaps.options.multiple_data")
+    end
+
+    map_data = options[:data]
+    data_filename = options[:"data-file"]
+
+    if data_filename
+      file_handler = lambda do |file|
+        map_data = file.read
+      end
+
+      if data_filename == "-"
+        file_handler[$stdin]
+      else
+        File.open(data_filename, "r", &file_handler)
+      end
+
+      raise map_data.inspect if map_data.nil? || map_data == ""
+    end
+
+    map_data
+  end
+  module_function :parse_configmap_data_options
+end

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

@@ -50,7 +50,7 @@ module Brightbox
       c.switch ["remove-ssl"], :negatable => false
 
       c.desc "Enable SSL v3 support"
-      c.switch ["sslv3"]
+      c.switch ["sslv3"], ignore_default: true
 
       c.action do |global_options, options, args|
         lb_id = args.shift

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

@@ -28,7 +28,6 @@ module Brightbox
       c.switch %i[e base64], :negatable => true
 
       c.desc "Enable encryption at rest for disk"
-      c.default_value false
       c.switch ["disk-encrypted"], :negatable => false
 
       c.desc "Server groups to place server in - comma delimited list"

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

@@ -17,7 +17,7 @@ module Brightbox
       c.switch %i[e base64], :negatable => true
 
       c.desc "Use compatibility mode"
-      c.switch [:"compatibility-mode"], :negatable => true
+      c.switch [:"compatibility-mode"], ignore_default: true
 
       c.desc "Server groups to place server in - comma delimited list"
       c.flag [:g, "server-groups"]

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

@@ -1,4 +1,5 @@
 module Brightbox
+  desc I18n.t("volumes.desc")
   command [:volumes] do |cmd|
     cmd.desc I18n.t("volumes.attach.desc")
     cmd.arg_name I18n.t("volumes.attach.args")

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

@@ -8,8 +8,7 @@ module Brightbox
       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.switch [:"delete-with-server"], ignore_default: true
 
       c.desc I18n.t("options.name.desc")
       c.flag %i[n name]
@@ -28,8 +27,8 @@ module Brightbox
 
         # 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"]
+        unless options[:"delete-with-server"].nil?
+          params[:delete_with_server] = options[:"delete-with-server"]
         end
 
         params[:description] = options[:description] if options[:description]

data/lib/brightbox-cli/config_map.rb

@@ -0,0 +1,53 @@
+module Brightbox
+  class ConfigMap < Api
+    def self.require_account?; true; end
+
+    def self.all
+      conn.config_maps
+    end
+
+    def self.create(options)
+      new(conn.config_maps.create(options))
+    end
+
+    def self.get(id)
+      conn.config_maps.get(id)
+    end
+
+    def self.default_field_order
+      %i[id name]
+    end
+
+    def self.detailed_fields
+      %i[
+        id
+        name
+      ]
+    end
+
+    def format_data(format)
+      case format.to_sym
+      when :text
+        attributes[:data].map do |key, value|
+          "#{key.to_s.rjust(16)}: #{value}"
+        end.join("\n")
+      else
+        JSON.dump(data)
+      end
+    end
+
+    def to_row
+      {
+        id: attributes[:id],
+        name: attributes[:name],
+        data: attributes[:data]
+      }
+    end
+
+    def update(options)
+      self.class.conn.update_config_map(id, options)
+      reload
+      self
+    end
+  end
+end

data/lib/brightbox-cli/version.rb

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

data/lib/brightbox_cli.rb

@@ -23,6 +23,7 @@ end
 require "multi_json"
 require "date"
 require "gli"
+require "gli_patches"
 require "i18n"
 require "fog/brightbox"
 
@@ -52,6 +53,7 @@ module Brightbox
   autoload :FirewallRule, File.expand_path("brightbox-cli/firewall_rule", __dir__)
   autoload :FirewallRules, File.expand_path("brightbox-cli/firewall_rules", __dir__)
   autoload :Collaboration, File.expand_path("brightbox-cli/collaboration", __dir__)
+  autoload :ConfigMap, File.expand_path("brightbox-cli/config_map", __dir__)
   autoload :UserCollaboration, File.expand_path("brightbox-cli/user_collaboration", __dir__)
   autoload :DatabaseType, File.expand_path("brightbox-cli/database_type", __dir__)
   autoload :DatabaseServer, File.expand_path("brightbox-cli/database_server", __dir__)

data/lib/gli_patches.rb

@@ -0,0 +1,50 @@
+require "gli/dsl"
+require "gli/command_line_option"
+require "gli/option_parser_factory"
+
+module GLI
+  module DSL
+    def extract_options(names)
+      options = {}
+      options = names.pop if names.last.kind_of? Hash
+      options = {
+        :desc => @next_desc,
+        :long_desc => @next_long_desc,
+        :default_value => @next_default_value,
+        :ignore_default => @ignore_default,
+        :arg_name => @next_arg_name
+      }.merge(options)
+    end
+  end
+
+  class CommandLineOption
+    def initialize(names, options = {})
+      # Disable returning a default for this option (needed for boolean updates)
+      # which should NOT be sent unless added by the user
+      @ignore_default = !!options[:ignore_default]
+
+      super(names, options[:desc], options[:long_desc])
+      @default_value = options[:default_value]
+    end
+
+    def ignore_default?
+      @ignore_default
+    end
+  end
+
+  class OptionParserFactory
+    private
+
+    def set_defaults(options_by_name,options_hash)
+      options_by_name.values.each do |option|
+        option.names_and_aliases.each do |option_name|
+          [option_name,option_name.to_sym].each do |name|
+            next if option.ignore_default?
+
+            options_hash[name] = option.default_value if options_hash[name].nil?
+          end
+        end
+      end
+    end
+  end
+end

data/locales/en.yml

@@ -51,6 +51,39 @@ en:
       desc: Remove an API client from config
     user_add:
       desc: Add new user credentials to config
+  configmaps:
+    desc: Manage config maps
+    args:
+      one: <configmap>
+      optional: "[<configmap>...]"
+      many: <configmap>...
+      specify_one_id_first: You must specify the config map ID as the first argument
+      specify_many_ids: You must specify config map IDs as arguments
+      unknown_id: Couldn't find %{config_map}
+    options:
+      data_args: You can only access data for a single config map at a time
+      data_file: A path to a file contain a JSON object containing key/values, or '-' for STDIO
+      data_string: String representing a valid JSON object
+      data_output: Return the config map data key/values
+      data_format: "Format to return 'data' in: 'json' (default) or 'text'"
+      format_no_data: The 'format' option can only be used with 'data'
+      bad_data: Config map data was not valid JSON
+      multiple_data: Config map data can only be passed by either 'data' or 'data-file'
+    create:
+      desc: Create a config map
+      acting: Creating config map
+      data_required: Config map data is required as 'data' option
+    destroy:
+      desc: Destroy config maps
+      acting: Destroying %{config_map}
+      failed: Failed to destroy %{config_map}
+    list:
+      desc: List config maps
+    show:
+      desc: Show config maps
+    update:
+      desc: Update a config map
+      acting: Updating %{config_map}
   firewall:
     policies:
       desc: Manage firewall policies