brightbox-cli 4.3.2 → 4.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c813c009698fa955e24ce5399a95d658f8e0f657881071fcea65a3349d958676
-  data.tar.gz: b7d1cfd6faf802ea27599226aedf2632b7d33dff89b4a018b26bd4587cc5069a
+  metadata.gz: 20cc19a7e6458988359a604fa90d67570b83c124b40c265a5f9beb0d3bc3a199
+  data.tar.gz: 98072a6ccd8ab0dcf4a3e3ac7f27ecf6982a7f3cf275b86e979aae0fc12461d8
 SHA512:
-  metadata.gz: ccd5f260951570479dacfbd428abb919a5ab35447d2699f05ff8552ba1c2fb0d3b27dfc9a749a3b0c9b0e4522d5a21b4bf13cecf5c13560798505548a10a9e4d
-  data.tar.gz: '051800a849a0b1f62b6351866e3daa687016b4cb2b6eb62aa0dc7c057fb73896c6bc23a30dc7e0c01b5a9b5fc92c25a7a723daa0245e16cb733c4d40b10de03d'
+  metadata.gz: 1c949f6d0679c9d72b7c7f61a6a0fd68b0669452911dde7da845a6f7e9a388c5b2a253ab0219bf6228faf4bc51ac6accfc559d714425c18499525d47b84ab73e
+  data.tar.gz: 7975e2d18399cc35bcd49f474657f6766e5d694bdbf70a1d49b79288edcbc9c07ea1d54b0757bd992ef08c517d4eef0e2a684e9ebf102f4718f3c72bc31368f9

data/CHANGELOG.md

@@ -1,3 +1,11 @@
+### 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)

data/Gemfile.lock

@@ -1,9 +1,9 @@
 PATH
   remote: .
   specs:
-    brightbox-cli (4.3.2)
+    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.1)
-    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/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.2".freeze unless defined?(Brightbox::VERSION)
+  VERSION = "4.4.0".freeze unless defined?(Brightbox::VERSION)
 end

data/lib/brightbox_cli.rb

@@ -53,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/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

data/spec/commands/configmaps/create_spec.rb

@@ -0,0 +1,257 @@
+require "spec_helper"
+
+describe "brightbox configmaps create" do
+  let(:output) { FauxIO.new { Brightbox.run(argv) } }
+  let(:stdout) { output.stdout }
+  let(:stderr) { output.stderr }
+
+  let(:token) { SecureRandom.hex }
+
+  before do
+    config_from_contents(API_CLIENT_CONFIG_CONTENTS)
+
+    stub_request(:post, "http://api.brightbox.localhost/token")
+      .to_return(status: 200, body: JSON.dump(access_token: token))
+
+    Brightbox.config.reauthenticate
+  end
+
+  context "without options" do
+    let(:argv) { %w[configmaps create] }
+
+    it "does not error" do
+      expect { output }.to_not raise_error
+
+      expect(stderr).to match("Config map data is required as 'data' option")
+
+      expect(stdout).to eq("")
+    end
+  end
+
+  context "with 'name' and 'data'" do
+    let(:argv) { ["configmaps", "create", "--name", "tester", "--data", payload] }
+    let(:payload) { { key: "value" }.to_json }
+
+    before do
+      stub_request(:post, "http://api.brightbox.localhost/1.0/config_maps")
+        .with(headers: { "Content-Type" => "application/json" },
+              query: hash_including(account_id: "acc-12345"),
+              body: {
+                name: "tester",
+                data: {
+                  key: "value"
+                }
+              })
+        .to_return(
+          status: 200,
+          body: {
+            id: "cfg-lk342",
+            name: "tester",
+            data: {
+              key: "value"
+            }
+          }.to_json
+        )
+    end
+
+    it "does not error" do
+      expect { output }.to_not raise_error
+
+      expect(stderr).not_to match("ERROR")
+
+      aggregate_failures do
+        expect(stdout).to match("id.*name")
+
+        expect(stdout).to match("cfg-lk342")
+      end
+    end
+  end
+
+  context "with 'data'" do
+    let(:argv) { ["configmaps", "create", "--data", payload] }
+    let(:payload) { { key: "value" }.to_json }
+
+    before do
+      stub_request(:post, "http://api.brightbox.localhost/1.0/config_maps")
+        .with(headers: { "Content-Type" => "application/json" },
+              query: hash_including(account_id: "acc-12345"),
+              body: {
+                data: {
+                  key: "value"
+                }
+              }.to_json)
+        .to_return(
+          status: 200,
+          body: {
+            id: "cfg-lk342",
+            data: {
+              key: "value"
+            }
+          }.to_json
+        )
+    end
+
+    it "does not error" do
+      expect { output }.to_not raise_error
+
+      expect(stderr).not_to match("ERROR")
+
+      aggregate_failures do
+        expect(stdout).to match("id.*name")
+
+        expect(stdout).to match("cfg-lk342")
+      end
+    end
+
+    context "with invalid update" do
+      let(:payload) { "Not JSON!" }
+
+      it "does not error" do
+        expect { output }.to_not raise_error
+
+        expect(stderr).to eq("ERROR: Config map data was not valid JSON\n")
+
+        expect(stdout).to eq("")
+      end
+    end
+  end
+
+  context "with new map from 'data-file'" do
+    context "when filename is used" do
+      let(:argv) { ["configmaps", "create", "--data-file", data_file.path] }
+      let(:data_file) { Tempfile.open("config_map_test_data") }
+
+      around do |example|
+        data_file.write(payload)
+        data_file.close
+
+        example.run
+
+        data_file.unlink
+      end
+
+      context "with valid update" do
+        let(:payload) { { new_key: "new setting" }.to_json }
+
+        before do
+          stub_request(:post, "http://api.brightbox.localhost/1.0/config_maps")
+            .with(query: hash_including(account_id: "acc-12345"),
+                  body: {
+                    data: {
+                      new_key: "new setting"
+                    }
+                  })
+            .to_return(
+              status: 200,
+              body: {
+                id: "cfg-s432l",
+                name: "",
+                data: {
+                  new_key: "new setting"
+                }
+              }.to_json
+            )
+        end
+
+        it "does not error" do
+          expect { output }.to_not raise_error
+
+          expect(stderr).to eq("Creating config map\n")
+
+          aggregate_failures do
+            expect(stdout).to match("cfg-s432l")
+          end
+        end
+
+        context "with invalid update" do
+          let(:payload) { "Not JSON!" }
+
+          it "does not error" do
+            expect { output }.to_not raise_error
+
+            expect(stderr).to eq("ERROR: Config map data was not valid JSON\n")
+
+            expect(stdout).to eq("")
+          end
+        end
+      end
+    end
+  end
+
+  context "when '-' is used for STDIN" do
+    let(:argv) { ["configmaps", "create", "--data-file", "-", "cfg-stdin"] }
+
+    before do
+      stdin_data = StringIO.new
+      stdin_data.puts(payload)
+      stdin_data.rewind
+
+      $stdin = stdin_data
+    end
+
+    after do
+      $stdin = STDIN
+    end
+
+    context "with valid update" do
+      let(:payload) { { use_stdin: true }.to_json }
+
+      before do
+        stub_request(:post, "http://api.brightbox.localhost/1.0/config_maps")
+          .with(query: hash_including(account_id: "acc-12345"),
+                body: {
+                  data: {
+                    use_stdin: true
+                  }
+                })
+          .to_return(
+            status: 200,
+            body: {
+              id: "cfg-mj53s",
+              name: "",
+              data: {
+                use_stdin: true
+              }
+            }.to_json
+          )
+      end
+
+      it "does not error" do
+        expect { output }.to_not raise_error
+
+        expect(stderr).to eq("Creating config map\n")
+
+        aggregate_failures do
+          expect(stdout).to match("cfg-mj53s")
+        end
+      end
+
+      context "with invalid update" do
+        let(:payload) { "Not JSON!" }
+
+        it "does not error" do
+          expect { output }.to_not raise_error
+
+          expect(stderr).to eq("ERROR: Config map data was not valid JSON\n")
+
+          expect(stdout).to eq("")
+        end
+      end
+    end
+  end
+
+  context "with mutually exclusive data options" do
+    let(:argv) { ["configmaps", "create", "--data", payload, "--data-file", "-"] }
+    let(:payload) { { new_key: "new value" }.to_json }
+
+    context "with invalid update" do
+      it "does not error" do
+        expect { output }.to_not raise_error
+
+        expect(stderr).to eq("ERROR: Config map data can only be passed by either 'data' or 'data-file'\n")
+
+        expect(stdout).to eq("")
+      end
+    end
+  end
+end