Update path-help command
This commit is contained in:
Seth Vargo
parent
19caaafe13
commit
85e5c33352
|
|
@ -4,73 +4,103 @@ import (
|
|||
"fmt"
|
||||
"strings"
|
||||
|
||||
"github.com/hashicorp/vault/meta"
|
||||
"github.com/mitchellh/cli"
|
||||
"github.com/posener/complete"
|
||||
)
|
||||
|
||||
// Ensure we are implementing the right interfaces.
|
||||
var _ cli.Command = (*PathHelpCommand)(nil)
|
||||
var _ cli.CommandAutocomplete = (*PathHelpCommand)(nil)
|
||||
|
||||
var pathHelpVaultSealedMessage = strings.TrimSpace(`
|
||||
Error: Vault is sealed.
|
||||
|
||||
The "path-help" command requires the Vault to be unsealed so that the mount
|
||||
points of the secret backends are known.
|
||||
`)
|
||||
|
||||
// PathHelpCommand is a Command that lists the mounts.
|
||||
type PathHelpCommand struct {
|
||||
meta.Meta
|
||||
}
|
||||
|
||||
func (c *PathHelpCommand) Run(args []string) int {
|
||||
flags := c.Meta.FlagSet("help", meta.FlagSetDefault)
|
||||
flags.Usage = func() { c.Ui.Error(c.Help()) }
|
||||
if err := flags.Parse(args); err != nil {
|
||||
return 1
|
||||
}
|
||||
|
||||
args = flags.Args()
|
||||
if len(args) != 1 {
|
||||
flags.Usage()
|
||||
c.Ui.Error("\nhelp expects a single argument")
|
||||
return 1
|
||||
}
|
||||
|
||||
path := args[0]
|
||||
|
||||
client, err := c.Client()
|
||||
if err != nil {
|
||||
c.Ui.Error(fmt.Sprintf(
|
||||
"Error initializing client: %s", err))
|
||||
return 2
|
||||
}
|
||||
|
||||
help, err := client.Help(path)
|
||||
if err != nil {
|
||||
if strings.Contains(err.Error(), "Vault is sealed") {
|
||||
c.Ui.Error(`Error: Vault is sealed.
|
||||
|
||||
The path-help command requires the vault to be unsealed so that
|
||||
mount points of secret backends are known.`)
|
||||
} else {
|
||||
c.Ui.Error(fmt.Sprintf(
|
||||
"Error reading help: %s", err))
|
||||
}
|
||||
return 1
|
||||
}
|
||||
|
||||
c.Ui.Output(help.Help)
|
||||
return 0
|
||||
*BaseCommand
|
||||
}
|
||||
|
||||
func (c *PathHelpCommand) Synopsis() string {
|
||||
return "Look up the help for a path"
|
||||
return "Retrieves API help for paths"
|
||||
}
|
||||
|
||||
func (c *PathHelpCommand) Help() string {
|
||||
helpText := `
|
||||
Usage: vault path-help [options] path
|
||||
|
||||
Look up the help for a path.
|
||||
Retrieves API help for paths. All endpoints in Vault provide built-in help
|
||||
in markdown format. This includes system paths, secret paths, and credential
|
||||
providers.
|
||||
|
||||
All endpoints in Vault from system paths, secret paths, and credential
|
||||
providers provide built-in help. This command looks up and outputs that
|
||||
help.
|
||||
A backend must be mounted before help is available:
|
||||
|
||||
The command requires that the vault be unsealed, because otherwise
|
||||
the mount points of the backends are unknown.
|
||||
$ vault mount database
|
||||
$ vault path-help database/
|
||||
|
||||
The response object will return additional paths to retrieve help:
|
||||
|
||||
$ vault path-help database/roles/
|
||||
|
||||
Each backend produces different help output. For additional information,
|
||||
please view the online documentation.
|
||||
|
||||
` + c.Flags().Help()
|
||||
|
||||
General Options:
|
||||
` + meta.GeneralOptionsUsage()
|
||||
return strings.TrimSpace(helpText)
|
||||
}
|
||||
|
||||
func (c *PathHelpCommand) Flags() *FlagSets {
|
||||
return c.flagSet(FlagSetHTTP)
|
||||
}
|
||||
|
||||
func (c *PathHelpCommand) AutocompleteArgs() complete.Predictor {
|
||||
return complete.PredictAnything // TODO: programatic way to invoke help
|
||||
}
|
||||
|
||||
func (c *PathHelpCommand) AutocompleteFlags() complete.Flags {
|
||||
return c.Flags().Completions()
|
||||
}
|
||||
|
||||
func (c *PathHelpCommand) Run(args []string) int {
|
||||
f := c.Flags()
|
||||
|
||||
if err := f.Parse(args); err != nil {
|
||||
c.UI.Error(err.Error())
|
||||
return 1
|
||||
}
|
||||
|
||||
args = f.Args()
|
||||
path, kvs, err := extractPath(args)
|
||||
if err != nil {
|
||||
c.UI.Error(err.Error())
|
||||
return 1
|
||||
}
|
||||
|
||||
if len(kvs) > 0 {
|
||||
c.UI.Error(fmt.Sprintf("Too many arguments (expected 1, got %d)", len(args)))
|
||||
return 1
|
||||
}
|
||||
|
||||
client, err := c.Client()
|
||||
if err != nil {
|
||||
c.UI.Error(err.Error())
|
||||
return 2
|
||||
}
|
||||
|
||||
help, err := client.Help(path)
|
||||
if err != nil {
|
||||
if strings.Contains(err.Error(), "Vault is sealed") {
|
||||
c.UI.Error(pathHelpVaultSealedMessage)
|
||||
} else {
|
||||
c.UI.Error(fmt.Sprintf("Error retrieving help: %s", err))
|
||||
}
|
||||
return 2
|
||||
}
|
||||
|
||||
c.UI.Output(help.Help)
|
||||
return 0
|
||||
}
|
||||
|
|
|
|||
|
|
@ -1,32 +1,115 @@
|
|||
package command
|
||||
|
||||
import (
|
||||
"strings"
|
||||
"testing"
|
||||
|
||||
"github.com/hashicorp/vault/http"
|
||||
"github.com/hashicorp/vault/meta"
|
||||
"github.com/hashicorp/vault/vault"
|
||||
"github.com/mitchellh/cli"
|
||||
)
|
||||
|
||||
func TestHelp(t *testing.T) {
|
||||
core, _, token := vault.TestCoreUnsealed(t)
|
||||
ln, addr := http.TestServer(t, core)
|
||||
defer ln.Close()
|
||||
func testPathHelpCommand(tb testing.TB) (*cli.MockUi, *PathHelpCommand) {
|
||||
tb.Helper()
|
||||
|
||||
ui := new(cli.MockUi)
|
||||
c := &PathHelpCommand{
|
||||
Meta: meta.Meta{
|
||||
ClientToken: token,
|
||||
Ui: ui,
|
||||
ui := cli.NewMockUi()
|
||||
return ui, &PathHelpCommand{
|
||||
BaseCommand: &BaseCommand{
|
||||
UI: ui,
|
||||
},
|
||||
}
|
||||
}
|
||||
|
||||
func TestPathHelpCommand_Run(t *testing.T) {
|
||||
t.Parallel()
|
||||
|
||||
cases := []struct {
|
||||
name string
|
||||
args []string
|
||||
out string
|
||||
code int
|
||||
}{
|
||||
{
|
||||
"empty",
|
||||
nil,
|
||||
"Missing PATH!",
|
||||
1,
|
||||
},
|
||||
{
|
||||
"slash",
|
||||
[]string{"/"},
|
||||
"Missing PATH!",
|
||||
1,
|
||||
},
|
||||
{
|
||||
"not_found",
|
||||
[]string{"nope/not/once/never"},
|
||||
"",
|
||||
2,
|
||||
},
|
||||
{
|
||||
"generic",
|
||||
[]string{"secret/"},
|
||||
"The generic backend",
|
||||
0,
|
||||
},
|
||||
{
|
||||
"sys",
|
||||
[]string{"sys/mounts"},
|
||||
"currently mounted backends",
|
||||
0,
|
||||
},
|
||||
}
|
||||
|
||||
args := []string{
|
||||
"-address", addr,
|
||||
"sys/mounts",
|
||||
}
|
||||
if code := c.Run(args); code != 0 {
|
||||
t.Fatalf("bad: %d\n\n%s", code, ui.ErrorWriter.String())
|
||||
for _, tc := range cases {
|
||||
tc := tc
|
||||
|
||||
t.Run(tc.name, func(t *testing.T) {
|
||||
t.Parallel()
|
||||
|
||||
client, closer := testVaultServer(t)
|
||||
defer closer()
|
||||
|
||||
ui, cmd := testPathHelpCommand(t)
|
||||
cmd.client = client
|
||||
|
||||
code := cmd.Run(tc.args)
|
||||
if code != tc.code {
|
||||
t.Errorf("expected %d to be %d", code, tc.code)
|
||||
}
|
||||
|
||||
combined := ui.OutputWriter.String() + ui.ErrorWriter.String()
|
||||
if !strings.Contains(combined, tc.out) {
|
||||
t.Errorf("expected %q to contain %q", combined, tc.out)
|
||||
}
|
||||
})
|
||||
}
|
||||
|
||||
t.Run("communication_failure", func(t *testing.T) {
|
||||
t.Parallel()
|
||||
|
||||
client, closer := testVaultServerBad(t)
|
||||
defer closer()
|
||||
|
||||
ui, cmd := testPathHelpCommand(t)
|
||||
cmd.client = client
|
||||
|
||||
code := cmd.Run([]string{
|
||||
"sys/mounts",
|
||||
})
|
||||
if exp := 2; code != exp {
|
||||
t.Errorf("expected %d to be %d", code, exp)
|
||||
}
|
||||
|
||||
expected := "Error retrieving help: "
|
||||
combined := ui.OutputWriter.String() + ui.ErrorWriter.String()
|
||||
if !strings.Contains(combined, expected) {
|
||||
t.Errorf("expected %q to contain %q", combined, expected)
|
||||
}
|
||||
})
|
||||
|
||||
t.Run("no_tabs", func(t *testing.T) {
|
||||
t.Parallel()
|
||||
|
||||
_, cmd := testPathHelpCommand(t)
|
||||
assertNoTabs(t, cmd)
|
||||
})
|
||||
}
|
||||
|
|
|
|||
Loading…
Reference in New Issue