mirror of
https://github.com/status-im/consul.git
synced 2025-02-13 06:06:40 +00:00
a49711b8bf
This patch refactors the commands that use the mitchellh/cli library to populate the command line flag set in both the Run() and the Help() method. Earlier versions of the mitchellh/cli library relied on the Run() method to populuate the flagset for generating the usage screen. This has changed in later versions and was previously solved with a small monkey patch to the library to restore the old behavior. However, this makes upgrading the library difficult since the patch has to be restored every time. This patch addresses this by moving the command line flags into an initFlags() method where appropriate and also moving all variables for the flags from the Run() method into the command itself. Fixes #3536
107 lines
2.3 KiB
Go
107 lines
2.3 KiB
Go
package command
|
|
|
|
import (
|
|
"encoding/base64"
|
|
"encoding/json"
|
|
"fmt"
|
|
|
|
"github.com/hashicorp/consul/api"
|
|
)
|
|
|
|
// KVExportCommand is a Command implementation that is used to export
|
|
// a KV tree as JSON
|
|
type KVExportCommand struct {
|
|
BaseCommand
|
|
}
|
|
|
|
func (c *KVExportCommand) Synopsis() string {
|
|
return "Exports a tree from the KV store as JSON"
|
|
}
|
|
|
|
func (c *KVExportCommand) Help() string {
|
|
c.InitFlagSet()
|
|
return c.HelpCommand(`
|
|
Usage: consul kv export [KEY_OR_PREFIX]
|
|
|
|
Retrieves key-value pairs for the given prefix from Consul's key-value store,
|
|
and writes a JSON representation to stdout. This can be used with the command
|
|
"consul kv import" to move entire trees between Consul clusters.
|
|
|
|
$ consul kv export vault
|
|
|
|
For a full list of options and examples, please see the Consul documentation.
|
|
|
|
`)
|
|
}
|
|
|
|
func (c *KVExportCommand) Run(args []string) int {
|
|
c.InitFlagSet()
|
|
if err := c.FlagSet.Parse(args); err != nil {
|
|
return 1
|
|
}
|
|
|
|
key := ""
|
|
// Check for arg validation
|
|
args = c.FlagSet.Args()
|
|
switch len(args) {
|
|
case 0:
|
|
key = ""
|
|
case 1:
|
|
key = args[0]
|
|
default:
|
|
c.UI.Error(fmt.Sprintf("Too many arguments (expected 1, got %d)", len(args)))
|
|
return 1
|
|
}
|
|
|
|
// This is just a "nice" thing to do. Since pairs cannot start with a /, but
|
|
// users will likely put "/" or "/foo", lets go ahead and strip that for them
|
|
// here.
|
|
if len(key) > 0 && key[0] == '/' {
|
|
key = key[1:]
|
|
}
|
|
|
|
// Create and test the HTTP client
|
|
client, err := c.HTTPClient()
|
|
if err != nil {
|
|
c.UI.Error(fmt.Sprintf("Error connecting to Consul agent: %s", err))
|
|
return 1
|
|
}
|
|
|
|
pairs, _, err := client.KV().List(key, &api.QueryOptions{
|
|
AllowStale: c.HTTPStale(),
|
|
})
|
|
if err != nil {
|
|
c.UI.Error(fmt.Sprintf("Error querying Consul agent: %s", err))
|
|
return 1
|
|
}
|
|
|
|
exported := make([]*kvExportEntry, len(pairs))
|
|
for i, pair := range pairs {
|
|
exported[i] = toExportEntry(pair)
|
|
}
|
|
|
|
marshaled, err := json.MarshalIndent(exported, "", "\t")
|
|
if err != nil {
|
|
c.UI.Error(fmt.Sprintf("Error exporting KV data: %s", err))
|
|
return 1
|
|
}
|
|
|
|
c.UI.Info(string(marshaled))
|
|
|
|
return 0
|
|
}
|
|
|
|
type kvExportEntry struct {
|
|
Key string `json:"key"`
|
|
Flags uint64 `json:"flags"`
|
|
Value string `json:"value"`
|
|
}
|
|
|
|
func toExportEntry(pair *api.KVPair) *kvExportEntry {
|
|
return &kvExportEntry{
|
|
Key: pair.Key,
|
|
Flags: pair.Flags,
|
|
Value: base64.StdEncoding.EncodeToString(pair.Value),
|
|
}
|
|
}
|