mirror of
				https://github.com/optim-enterprises-bv/vault.git
				synced 2025-10-31 18:48:08 +00:00 
			
		
		
		
	 3379eaa1cf
			
		
	
	3379eaa1cf
	
	
	
		
			
			* CLI: Add ability to display ListResponseWithInfos
The Vault Server API includes a ListResponseWithInfo call, allowing LIST
responses to contain additional information about their keys. This is in
a key=value mapping format (both for each key, to get the additional
metadata, as well as within each metadata).
Expand the `vault list` CLI command with a `-detailed` flag (and env var
VAULT_DETAILED_LISTS) to print this additional metadata. This looks
roughly like the following:
    $ vault list -detailed pki/issuers
    Keys                                    issuer_name
    ----                                    -----------
    0cba84d7-bbbe-836a-4ff6-a11b31dc0fb7    n/a
    35dfb02d-0cdb-3d35-ee64-d0cd6568c6b0    n/a
    382fad1e-e99c-9c54-e147-bb1faa8033d3    n/a
    8bb4a793-2ad9-460c-9fa8-574c84a981f7    n/a
    8bd231d7-20e2-f21f-ae1a-7aa3319715e7    n/a
    9425d51f-cb81-426d-d6ad-5147d092094e    n/a
    ae679732-b497-ab0d-3220-806a2b9d81ed    n/a
    c5a44a1f-2ae4-2140-3acf-74b2609448cc    utf8
    d41d2419-efce-0e36-c96b-e91179a24dc1    something
Signed-off-by: Alexander Scheel <alex.scheel@hashicorp.com>
* Allow detailed printing of LIST responses in JSON
When using the JSON formatter, only the absolute list of keys were
returned. Reuse the `-detailed` flag value for the `-format=json` list
response printer, allowing us to show the complete API response returned
by Vault.
This returns something like the following:
    {
      "request_id": "e9a25dcd-b67a-97d7-0f08-3670918ef3ff",
      "lease_id": "",
      "lease_duration": 0,
      "renewable": false,
      "data": {
        "key_info": {
          "0cba84d7-bbbe-836a-4ff6-a11b31dc0fb7": {
            "issuer_name": ""
          },
          "35dfb02d-0cdb-3d35-ee64-d0cd6568c6b0": {
            "issuer_name": ""
          },
          "382fad1e-e99c-9c54-e147-bb1faa8033d3": {
            "issuer_name": ""
          },
          "8bb4a793-2ad9-460c-9fa8-574c84a981f7": {
            "issuer_name": ""
          },
          "8bd231d7-20e2-f21f-ae1a-7aa3319715e7": {
            "issuer_name": ""
          },
          "9425d51f-cb81-426d-d6ad-5147d092094e": {
            "issuer_name": ""
          },
          "ae679732-b497-ab0d-3220-806a2b9d81ed": {
            "issuer_name": ""
          },
          "c5a44a1f-2ae4-2140-3acf-74b2609448cc": {
            "issuer_name": "utf8"
          },
          "d41d2419-efce-0e36-c96b-e91179a24dc1": {
            "issuer_name": "something"
          }
        },
        "keys": [
          "0cba84d7-bbbe-836a-4ff6-a11b31dc0fb7",
          "35dfb02d-0cdb-3d35-ee64-d0cd6568c6b0",
          "382fad1e-e99c-9c54-e147-bb1faa8033d3",
          "8bb4a793-2ad9-460c-9fa8-574c84a981f7",
          "8bd231d7-20e2-f21f-ae1a-7aa3319715e7",
          "9425d51f-cb81-426d-d6ad-5147d092094e",
          "ae679732-b497-ab0d-3220-806a2b9d81ed",
          "c5a44a1f-2ae4-2140-3acf-74b2609448cc",
          "d41d2419-efce-0e36-c96b-e91179a24dc1"
        ]
      },
      "warnings": null
    }
Signed-off-by: Alexander Scheel <alex.scheel@hashicorp.com>
* Add changelog
Signed-off-by: Alexander Scheel <alex.scheel@hashicorp.com>
* Use field on UI rather than secret.Data
Signed-off-by: Alexander Scheel <alex.scheel@hashicorp.com>
* Only include headers from visitable key_infos
Certain API endpoints return data from non-visitable key_infos, by
virtue of using a hand-rolled response. Limit our headers to those
from visitable key_infos. This means we won't return entire columns with
n/a entries, if no key matches the key_info key that includes that
header.
Signed-off-by: Alexander Scheel <alex.scheel@hashicorp.com>
* Use setupEnv sourced detailed info
Signed-off-by: Alexander Scheel <alex.scheel@hashicorp.com>
* Fix changelog environment variable
Signed-off-by: Alexander Scheel <alex.scheel@hashicorp.com>
* Fix broken tests using setupEnv
Signed-off-by: Alexander Scheel <alex.scheel@hashicorp.com>
		
	
		
			
				
	
	
		
			187 lines
		
	
	
		
			3.8 KiB
		
	
	
	
		
			Go
		
	
	
	
	
	
			
		
		
	
	
			187 lines
		
	
	
		
			3.8 KiB
		
	
	
	
		
			Go
		
	
	
	
	
	
| package command
 | |
| 
 | |
| import (
 | |
| 	"bytes"
 | |
| 	"encoding/json"
 | |
| 	"io/ioutil"
 | |
| 	"os"
 | |
| 	"strings"
 | |
| 	"testing"
 | |
| 
 | |
| 	"github.com/mitchellh/cli"
 | |
| )
 | |
| 
 | |
| func testOperatorUnsealCommand(tb testing.TB) (*cli.MockUi, *OperatorUnsealCommand) {
 | |
| 	tb.Helper()
 | |
| 
 | |
| 	ui := cli.NewMockUi()
 | |
| 	return ui, &OperatorUnsealCommand{
 | |
| 		BaseCommand: &BaseCommand{
 | |
| 			UI: ui,
 | |
| 		},
 | |
| 	}
 | |
| }
 | |
| 
 | |
| func TestOperatorUnsealCommand_Run(t *testing.T) {
 | |
| 	t.Parallel()
 | |
| 
 | |
| 	t.Run("error_non_terminal", func(t *testing.T) {
 | |
| 		t.Parallel()
 | |
| 
 | |
| 		client, closer := testVaultServer(t)
 | |
| 		defer closer()
 | |
| 
 | |
| 		ui, cmd := testOperatorUnsealCommand(t)
 | |
| 		cmd.client = client
 | |
| 		cmd.testOutput = ioutil.Discard
 | |
| 
 | |
| 		code := cmd.Run(nil)
 | |
| 		if exp := 1; code != exp {
 | |
| 			t.Errorf("expected %d to be %d", code, exp)
 | |
| 		}
 | |
| 
 | |
| 		expected := "is not a terminal"
 | |
| 		combined := ui.OutputWriter.String() + ui.ErrorWriter.String()
 | |
| 		if !strings.Contains(combined, expected) {
 | |
| 			t.Errorf("expected %q to contain %q", combined, expected)
 | |
| 		}
 | |
| 	})
 | |
| 
 | |
| 	t.Run("reset", func(t *testing.T) {
 | |
| 		t.Parallel()
 | |
| 
 | |
| 		client, keys, closer := testVaultServerUnseal(t)
 | |
| 		defer closer()
 | |
| 
 | |
| 		// Seal so we can unseal
 | |
| 		if err := client.Sys().Seal(); err != nil {
 | |
| 			t.Fatal(err)
 | |
| 		}
 | |
| 
 | |
| 		// Enter an unseal key
 | |
| 		if _, err := client.Sys().Unseal(keys[0]); err != nil {
 | |
| 			t.Fatal(err)
 | |
| 		}
 | |
| 
 | |
| 		ui, cmd := testOperatorUnsealCommand(t)
 | |
| 		cmd.client = client
 | |
| 		cmd.testOutput = ioutil.Discard
 | |
| 
 | |
| 		// Reset and check output
 | |
| 		code := cmd.Run([]string{
 | |
| 			"-reset",
 | |
| 		})
 | |
| 		if exp := 0; code != exp {
 | |
| 			t.Errorf("expected %d to be %d", code, exp)
 | |
| 		}
 | |
| 		expected := "0/3"
 | |
| 		combined := ui.OutputWriter.String() + ui.ErrorWriter.String()
 | |
| 		if !strings.Contains(combined, expected) {
 | |
| 			t.Errorf("expected %q to contain %q", combined, expected)
 | |
| 		}
 | |
| 	})
 | |
| 
 | |
| 	t.Run("full", func(t *testing.T) {
 | |
| 		t.Parallel()
 | |
| 
 | |
| 		client, keys, closer := testVaultServerUnseal(t)
 | |
| 		defer closer()
 | |
| 
 | |
| 		// Seal so we can unseal
 | |
| 		if err := client.Sys().Seal(); err != nil {
 | |
| 			t.Fatal(err)
 | |
| 		}
 | |
| 
 | |
| 		for _, key := range keys {
 | |
| 			ui, cmd := testOperatorUnsealCommand(t)
 | |
| 			cmd.client = client
 | |
| 			cmd.testOutput = ioutil.Discard
 | |
| 
 | |
| 			// Reset and check output
 | |
| 			code := cmd.Run([]string{
 | |
| 				key,
 | |
| 			})
 | |
| 			if exp := 0; code != exp {
 | |
| 				t.Errorf("expected %d to be %d: %s", code, exp, ui.ErrorWriter.String())
 | |
| 			}
 | |
| 		}
 | |
| 
 | |
| 		status, err := client.Sys().SealStatus()
 | |
| 		if err != nil {
 | |
| 			t.Fatal(err)
 | |
| 		}
 | |
| 		if status.Sealed {
 | |
| 			t.Error("expected unsealed")
 | |
| 		}
 | |
| 	})
 | |
| 
 | |
| 	t.Run("communication_failure", func(t *testing.T) {
 | |
| 		t.Parallel()
 | |
| 
 | |
| 		client, closer := testVaultServerBad(t)
 | |
| 		defer closer()
 | |
| 
 | |
| 		ui, cmd := testOperatorUnsealCommand(t)
 | |
| 		cmd.client = client
 | |
| 
 | |
| 		code := cmd.Run([]string{
 | |
| 			"abcd",
 | |
| 		})
 | |
| 		if exp := 2; code != exp {
 | |
| 			t.Errorf("expected %d to be %d", code, exp)
 | |
| 		}
 | |
| 
 | |
| 		expected := "Error unsealing: "
 | |
| 		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 := testOperatorUnsealCommand(t)
 | |
| 		assertNoTabs(t, cmd)
 | |
| 	})
 | |
| }
 | |
| 
 | |
| func TestOperatorUnsealCommand_Format(t *testing.T) {
 | |
| 	defer func() {
 | |
| 		os.Setenv(EnvVaultCLINoColor, "")
 | |
| 	}()
 | |
| 
 | |
| 	client, keys, closer := testVaultServerUnseal(t)
 | |
| 	defer closer()
 | |
| 
 | |
| 	// Seal so we can unseal
 | |
| 	if err := client.Sys().Seal(); err != nil {
 | |
| 		t.Fatal(err)
 | |
| 	}
 | |
| 
 | |
| 	stdout := bytes.NewBuffer(nil)
 | |
| 	stderr := bytes.NewBuffer(nil)
 | |
| 	runOpts := &RunOptions{
 | |
| 		Stdout: stdout,
 | |
| 		Stderr: stderr,
 | |
| 		Client: client,
 | |
| 	}
 | |
| 
 | |
| 	args, format, _, _, _ := setupEnv([]string{"operator", "unseal", "-format", "json"})
 | |
| 	if format != "json" {
 | |
| 		t.Fatalf("expected %q, got %q", "json", format)
 | |
| 	}
 | |
| 
 | |
| 	// Unseal with one key
 | |
| 	code := RunCustom(append(args, []string{
 | |
| 		keys[0],
 | |
| 	}...), runOpts)
 | |
| 	if exp := 0; code != exp {
 | |
| 		t.Errorf("expected %d to be %d: %s", code, exp, stderr.String())
 | |
| 	}
 | |
| 
 | |
| 	if !json.Valid(stdout.Bytes()) {
 | |
| 		t.Error("expected output to be valid JSON")
 | |
| 	}
 | |
| }
 |