Vault Agent Template follow-ups (#7739)
* Vault Agent Template: parse templates (#7540) * add template config parsing, but it's wrong b/c it's not using mapstructure * parsing consul templates in agent config * add additional test to configuration parsing, to cover basics * another test fixture, rework simple test into table * refactor into table test * rename test * remove flattenKeys and add other test fixture * Update command/agent/config/config.go Co-Authored-By: Jim Kalafut <jkalafut@hashicorp.com> * return the decode error instead of swallowing it * Update command/agent/config/config_test.go Co-Authored-By: Jim Kalafut <jkalafut@hashicorp.com> * go mod tidy * change error checking style * Add agent template doc * TemplateServer: render secrets with Consul Template (#7621) * add template config parsing, but it's wrong b/c it's not using mapstructure * parsing consul templates in agent config * add additional test to configuration parsing, to cover basics * another test fixture, rework simple test into table * refactor into table test * rename test * remove flattenKeys and add other test fixture * add template package * WIP: add runner * fix panic, actually copy templates, etc * rework how the config.Vault is created and enable reading from the environment * this was supposed to be a part of the prior commit * move/add methods to testhelpers for converting some values to pointers * use new methods in testhelpers * add an unblock channel to block agent until a template has been rendered * add note * unblock if there are no templates * cleanups * go mod tidy * remove dead code * simple test to starT * add simple, empty templates test * Update package doc, error logs, and add missing close() on channel * update code comment to be clear what I'm referring to * have template.NewServer return a (<- chan) type, even though it's a normal chan, as a better practice to enforce reading only * Update command/agent.go Co-Authored-By: Jim Kalafut <jkalafut@hashicorp.com> * update with test * Add README and doc.go to the command/agent directory (#7503) * Add README and doc.go to the command/agent directory * Add link to website * address feedback for agent.go * updated with feedback from Calvin * Rework template.Server to export the unblock channel, and remove it from the NewServer function * apply feedback from Nick * fix/restructure rendering test * Add pointerutil package for converting types to their pointers * Remove pointer helper methods; use sdk/helper/pointerutil instead * update newRunnerConfig to use pointerutil and empty strings * only wait for unblock if template server is initialized * update test structure * some test cleanup * follow up tests * remove debugging, fix issue in replacing runner config * need to handle first render/token * Simplify the blocking logic to support exit after auth * fix channel name * expand TestAgent_Template to include multiple scenarios * cleanup * test cleanups after feedback
This commit is contained in:
parent
f5719b9fee
commit
d0aa3ba053
|
@ -29,7 +29,6 @@ import (
|
|||
"github.com/hashicorp/vault/command/agent/auth/jwt"
|
||||
"github.com/hashicorp/vault/command/agent/auth/kubernetes"
|
||||
"github.com/hashicorp/vault/command/agent/cache"
|
||||
"github.com/hashicorp/vault/command/agent/config"
|
||||
agentConfig "github.com/hashicorp/vault/command/agent/config"
|
||||
"github.com/hashicorp/vault/command/agent/sink"
|
||||
"github.com/hashicorp/vault/command/agent/sink/file"
|
||||
|
@ -223,12 +222,14 @@ func (c *AgentCommand) Run(args []string) int {
|
|||
if config.Vault == nil {
|
||||
config.Vault = new(agentConfig.Vault)
|
||||
}
|
||||
|
||||
c.setStringFlag(f, config.Vault.Address, &StringVar{
|
||||
Name: flagNameAddress,
|
||||
Target: &c.flagAddress,
|
||||
Default: "https://127.0.0.1:8200",
|
||||
EnvVar: api.EnvVaultAddress,
|
||||
})
|
||||
|
||||
c.setStringFlag(f, config.Vault.CACert, &StringVar{
|
||||
Name: flagNameCACert,
|
||||
Target: &c.flagCACert,
|
||||
|
@ -507,8 +508,7 @@ func (c *AgentCommand) Run(args []string) int {
|
|||
// TODO: implement support for SIGHUP reloading of configuration
|
||||
// signal.Notify(c.signalCh)
|
||||
|
||||
var ssDoneCh, ahDoneCh, tsDoneCh, unblockCh chan struct{}
|
||||
var ts *template.Server
|
||||
var ssDoneCh, ahDoneCh, tsDoneCh chan struct{}
|
||||
// Start auto-auth and sink servers
|
||||
if method != nil {
|
||||
enableTokenCh := len(config.Templates) > 0
|
||||
|
@ -528,16 +528,13 @@ func (c *AgentCommand) Run(args []string) int {
|
|||
})
|
||||
ssDoneCh = ss.DoneCh
|
||||
|
||||
// create an independent vault configuration for Consul Template to use
|
||||
vaultConfig := c.setupTemplateConfig()
|
||||
ts = template.NewServer(&template.ServerConfig{
|
||||
ts := template.NewServer(&template.ServerConfig{
|
||||
Logger: c.logger.Named("template.server"),
|
||||
VaultConf: vaultConfig,
|
||||
VaultConf: config.Vault,
|
||||
Namespace: namespace,
|
||||
ExitAfterAuth: config.ExitAfterAuth,
|
||||
})
|
||||
tsDoneCh = ts.DoneCh
|
||||
unblockCh = ts.UnblockCh
|
||||
|
||||
go ah.Run(ctx, method)
|
||||
go ss.Run(ctx, ah.OutputCh, sinks)
|
||||
|
@ -572,19 +569,14 @@ func (c *AgentCommand) Run(args []string) int {
|
|||
}
|
||||
}()
|
||||
|
||||
// If the template server is running and we've assinged the Unblock channel,
|
||||
// wait for the template to render
|
||||
if unblockCh != nil {
|
||||
select {
|
||||
case <-ctx.Done():
|
||||
case <-ts.UnblockCh:
|
||||
}
|
||||
}
|
||||
|
||||
select {
|
||||
case <-ssDoneCh:
|
||||
// This will happen if we exit-on-auth
|
||||
c.logger.Info("sinks finished, exiting")
|
||||
// allow any templates to be rendered
|
||||
if tsDoneCh != nil {
|
||||
<-tsDoneCh
|
||||
}
|
||||
case <-c.ShutdownCh:
|
||||
c.UI.Output("==> Vault agent shutdown triggered")
|
||||
cancelFunc()
|
||||
|
@ -697,21 +689,3 @@ func (c *AgentCommand) removePidFile(pidPath string) error {
|
|||
}
|
||||
return os.Remove(pidPath)
|
||||
}
|
||||
|
||||
// setupTemplateConfig creates a config.Vault struct for use by Consul Template.
|
||||
// Consul Template does not currently allow us to pass in a configured API
|
||||
// client, unlike the AuthHandler and SinkServer that reuse the client created
|
||||
// in this Run() method. Here we build a config.Vault struct for use by the
|
||||
// Template Server that matches the configuration used to create the client
|
||||
// (c.client), but in a struct of type config.Vault so that Consul Template can
|
||||
// create it's own api client internally.
|
||||
func (c *AgentCommand) setupTemplateConfig() *config.Vault {
|
||||
return &config.Vault{
|
||||
Address: c.flagAddress,
|
||||
CACert: c.flagCACert,
|
||||
CAPath: c.flagCAPath,
|
||||
ClientCert: c.flagClientCert,
|
||||
ClientKey: c.flagClientKey,
|
||||
TLSSkipVerify: c.flagTLSSkipVerify,
|
||||
}
|
||||
}
|
||||
|
|
|
@ -29,9 +29,6 @@ type ServerConfig struct {
|
|||
|
||||
// Server manages the Consul Template Runner which renders templates
|
||||
type Server struct {
|
||||
// UnblockCh is used to block until a template is rendered
|
||||
UnblockCh chan struct{}
|
||||
|
||||
// config holds the ServerConfig used to create it. It's passed along in other
|
||||
// methods
|
||||
config *ServerConfig
|
||||
|
@ -42,7 +39,6 @@ type Server struct {
|
|||
// Templates holds the parsed Consul Templates
|
||||
Templates []*ctconfig.TemplateConfig
|
||||
|
||||
// TODO: remove donech?
|
||||
DoneCh chan struct{}
|
||||
logger hclog.Logger
|
||||
exitAfterAuth bool
|
||||
|
@ -53,7 +49,6 @@ func NewServer(conf *ServerConfig) *Server {
|
|||
ts := Server{
|
||||
DoneCh: make(chan struct{}),
|
||||
logger: conf.Logger,
|
||||
UnblockCh: make(chan struct{}),
|
||||
config: conf,
|
||||
exitAfterAuth: conf.ExitAfterAuth,
|
||||
}
|
||||
|
@ -66,6 +61,7 @@ func NewServer(conf *ServerConfig) *Server {
|
|||
func (ts *Server) Run(ctx context.Context, incoming chan string, templates []*ctconfig.TemplateConfig) {
|
||||
latestToken := new(string)
|
||||
ts.logger.Info("starting template server")
|
||||
// defer the closing of the DoneCh
|
||||
defer func() {
|
||||
ts.logger.Info("template server stopped")
|
||||
close(ts.DoneCh)
|
||||
|
@ -75,11 +71,9 @@ func (ts *Server) Run(ctx context.Context, incoming chan string, templates []*ct
|
|||
panic("incoming channel is nil")
|
||||
}
|
||||
|
||||
// If there are no templates, close the UnblockCh
|
||||
// If there are no templates, return
|
||||
if len(templates) == 0 {
|
||||
// nothing to do
|
||||
ts.logger.Info("no templates found")
|
||||
close(ts.UnblockCh)
|
||||
return
|
||||
}
|
||||
|
||||
|
@ -88,7 +82,6 @@ func (ts *Server) Run(ctx context.Context, incoming chan string, templates []*ct
|
|||
var runnerConfig *ctconfig.Config
|
||||
if runnerConfig = newRunnerConfig(ts.config, templates); runnerConfig == nil {
|
||||
ts.logger.Error("template server failed to generate runner config")
|
||||
close(ts.UnblockCh)
|
||||
return
|
||||
}
|
||||
|
||||
|
@ -96,15 +89,13 @@ func (ts *Server) Run(ctx context.Context, incoming chan string, templates []*ct
|
|||
ts.runner, err = manager.NewRunner(runnerConfig, false)
|
||||
if err != nil {
|
||||
ts.logger.Error("template server failed to create", "error", err)
|
||||
close(ts.UnblockCh)
|
||||
return
|
||||
}
|
||||
|
||||
for {
|
||||
select {
|
||||
case <-ctx.Done():
|
||||
ts.runner.StopImmediately()
|
||||
ts.runner = nil
|
||||
ts.runner.Stop()
|
||||
return
|
||||
|
||||
case token := <-incoming:
|
||||
|
@ -117,28 +108,26 @@ func (ts *Server) Run(ctx context.Context, incoming chan string, templates []*ct
|
|||
Token: latestToken,
|
||||
},
|
||||
}
|
||||
runnerConfig.Merge(&ctv)
|
||||
runnerConfig.Finalize()
|
||||
runnerConfig = runnerConfig.Merge(&ctv)
|
||||
var runnerErr error
|
||||
ts.runner, runnerErr = manager.NewRunner(runnerConfig, false)
|
||||
if runnerErr != nil {
|
||||
ts.logger.Error("template server failed with new Vault token", "error", runnerErr)
|
||||
continue
|
||||
} else {
|
||||
go ts.runner.Start()
|
||||
}
|
||||
go ts.runner.Start()
|
||||
}
|
||||
case err := <-ts.runner.ErrCh:
|
||||
ts.logger.Error("template server error", "error", err.Error())
|
||||
close(ts.UnblockCh)
|
||||
return
|
||||
case <-ts.runner.TemplateRenderedCh():
|
||||
// A template has been rendered, unblock
|
||||
if ts.exitAfterAuth {
|
||||
// if we want to exit after auth, go ahead and shut down the runner
|
||||
// if we want to exit after auth, go ahead and shut down the runner and
|
||||
// return. The deferred closing of the DoneCh will allow agent to
|
||||
// continue with closing down
|
||||
ts.runner.Stop()
|
||||
return
|
||||
}
|
||||
close(ts.UnblockCh)
|
||||
}
|
||||
}
|
||||
}
|
||||
|
|
|
@ -24,9 +24,6 @@ func TestNewServer(t *testing.T) {
|
|||
if server == nil {
|
||||
t.Fatal("nil server returned")
|
||||
}
|
||||
if server.UnblockCh == nil {
|
||||
t.Fatal("nil blocking channel returned")
|
||||
}
|
||||
}
|
||||
|
||||
func TestServerRun(t *testing.T) {
|
||||
|
@ -39,18 +36,6 @@ func TestServerRun(t *testing.T) {
|
|||
t.Fatal(err)
|
||||
}
|
||||
|
||||
testCases := map[string]struct {
|
||||
templates []*ctconfig.TemplateConfig
|
||||
}{
|
||||
"basic": {
|
||||
templates: []*ctconfig.TemplateConfig{
|
||||
&ctconfig.TemplateConfig{
|
||||
Contents: pointerutil.StringPtr(templateContents),
|
||||
},
|
||||
},
|
||||
},
|
||||
}
|
||||
|
||||
// secretRender is a simple struct that represents the secret we render to
|
||||
// disk. It's used to unmarshal the file contents and test against
|
||||
type secretRender struct {
|
||||
|
@ -59,20 +44,80 @@ func TestServerRun(t *testing.T) {
|
|||
Version string `json:"version"`
|
||||
}
|
||||
|
||||
type templateTest struct {
|
||||
template *ctconfig.TemplateConfig
|
||||
}
|
||||
|
||||
testCases := map[string]struct {
|
||||
templateMap map[string]*templateTest
|
||||
}{
|
||||
"simple": {
|
||||
templateMap: map[string]*templateTest{
|
||||
"render_01": &templateTest{
|
||||
template: &ctconfig.TemplateConfig{
|
||||
Contents: pointerutil.StringPtr(templateContents),
|
||||
},
|
||||
},
|
||||
},
|
||||
},
|
||||
"multiple": {
|
||||
templateMap: map[string]*templateTest{
|
||||
"render_01": &templateTest{
|
||||
template: &ctconfig.TemplateConfig{
|
||||
Contents: pointerutil.StringPtr(templateContents),
|
||||
},
|
||||
},
|
||||
"render_02": &templateTest{
|
||||
template: &ctconfig.TemplateConfig{
|
||||
Contents: pointerutil.StringPtr(templateContents),
|
||||
},
|
||||
},
|
||||
"render_03": &templateTest{
|
||||
template: &ctconfig.TemplateConfig{
|
||||
Contents: pointerutil.StringPtr(templateContents),
|
||||
},
|
||||
},
|
||||
"render_04": &templateTest{
|
||||
template: &ctconfig.TemplateConfig{
|
||||
Contents: pointerutil.StringPtr(templateContents),
|
||||
},
|
||||
},
|
||||
"render_05": &templateTest{
|
||||
template: &ctconfig.TemplateConfig{
|
||||
Contents: pointerutil.StringPtr(templateContents),
|
||||
},
|
||||
},
|
||||
"render_06": &templateTest{
|
||||
template: &ctconfig.TemplateConfig{
|
||||
Contents: pointerutil.StringPtr(templateContents),
|
||||
},
|
||||
},
|
||||
"render_07": &templateTest{
|
||||
template: &ctconfig.TemplateConfig{
|
||||
Contents: pointerutil.StringPtr(templateContents),
|
||||
},
|
||||
},
|
||||
},
|
||||
},
|
||||
}
|
||||
|
||||
for name, tc := range testCases {
|
||||
t.Run(name, func(t *testing.T) {
|
||||
templateTokenCh := make(chan string, 1)
|
||||
for i, template := range tc.templates {
|
||||
dstFile := fmt.Sprintf("%s/render_%d.txt", tmpDir, i)
|
||||
template.Destination = pointerutil.StringPtr(dstFile)
|
||||
var templatesToRender []*ctconfig.TemplateConfig
|
||||
for fileName, templateTest := range tc.templateMap {
|
||||
dstFile := fmt.Sprintf("%s/%s", tmpDir, fileName)
|
||||
templateTest.template.Destination = pointerutil.StringPtr(dstFile)
|
||||
templatesToRender = append(templatesToRender, templateTest.template)
|
||||
}
|
||||
|
||||
ctx, cancelFunc := context.WithCancel(context.Background())
|
||||
ctx := context.Background()
|
||||
sc := ServerConfig{
|
||||
Logger: logging.NewVaultLogger(hclog.Trace),
|
||||
VaultConf: &config.Vault{
|
||||
Address: ts.URL,
|
||||
},
|
||||
ExitAfterAuth: true,
|
||||
}
|
||||
|
||||
var server *Server
|
||||
|
@ -80,26 +125,17 @@ func TestServerRun(t *testing.T) {
|
|||
if ts == nil {
|
||||
t.Fatal("nil server returned")
|
||||
}
|
||||
if server.UnblockCh == nil {
|
||||
t.Fatal("nil blocking channel returned")
|
||||
}
|
||||
|
||||
go server.Run(ctx, templateTokenCh, tc.templates)
|
||||
go server.Run(ctx, templateTokenCh, templatesToRender)
|
||||
|
||||
// send a dummy value to trigger the internal Runner to query for secret
|
||||
// info
|
||||
templateTokenCh <- "test"
|
||||
|
||||
select {
|
||||
case <-ctx.Done():
|
||||
case <-server.UnblockCh:
|
||||
}
|
||||
|
||||
// cancel to clean things up
|
||||
cancelFunc()
|
||||
<-server.DoneCh
|
||||
|
||||
// verify test file exists and has the content we're looking for
|
||||
for _, template := range tc.templates {
|
||||
var fileCount int
|
||||
for _, template := range templatesToRender {
|
||||
if template.Destination == nil {
|
||||
t.Fatal("nil template destination")
|
||||
}
|
||||
|
@ -107,6 +143,7 @@ func TestServerRun(t *testing.T) {
|
|||
if err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
fileCount++
|
||||
|
||||
secret := secretRender{}
|
||||
if err := json.Unmarshal(content, &secret); err != nil {
|
||||
|
@ -116,6 +153,9 @@ func TestServerRun(t *testing.T) {
|
|||
t.Fatalf("secret didn't match: %#v", secret)
|
||||
}
|
||||
}
|
||||
if fileCount != len(templatesToRender) {
|
||||
t.Fatalf("mismatch file to template: (%d) / (%d)", fileCount, len(templatesToRender))
|
||||
}
|
||||
})
|
||||
}
|
||||
}
|
||||
|
|
|
@ -7,12 +7,14 @@ import (
|
|||
"net/http"
|
||||
"os"
|
||||
"reflect"
|
||||
"strings"
|
||||
"sync"
|
||||
"testing"
|
||||
"time"
|
||||
|
||||
hclog "github.com/hashicorp/go-hclog"
|
||||
vaultjwt "github.com/hashicorp/vault-plugin-auth-jwt"
|
||||
logicalKv "github.com/hashicorp/vault-plugin-secrets-kv"
|
||||
"github.com/hashicorp/vault/api"
|
||||
credAppRole "github.com/hashicorp/vault/builtin/credential/approle"
|
||||
"github.com/hashicorp/vault/command/agent"
|
||||
|
@ -312,8 +314,6 @@ func TestExitAfterAuth(t *testing.T) {
|
|||
}
|
||||
|
||||
config := `
|
||||
exit_after_auth = true
|
||||
|
||||
auto_auth {
|
||||
method {
|
||||
type = "jwt"
|
||||
|
@ -380,32 +380,6 @@ auto_auth {
|
|||
|
||||
func TestAgent_RequireRequestHeader(t *testing.T) {
|
||||
|
||||
// request issues HTTP requests.
|
||||
request := func(client *api.Client, req *api.Request, expectedStatusCode int) map[string]interface{} {
|
||||
resp, err := client.RawRequest(req)
|
||||
if err != nil {
|
||||
t.Fatalf("err: %s", err)
|
||||
}
|
||||
if resp.StatusCode != expectedStatusCode {
|
||||
t.Fatalf("expected status code %d, not %d", expectedStatusCode, resp.StatusCode)
|
||||
}
|
||||
|
||||
bytes, err := ioutil.ReadAll(resp.Body)
|
||||
if err != nil {
|
||||
t.Fatalf("err: %s", err)
|
||||
}
|
||||
if len(bytes) == 0 {
|
||||
return nil
|
||||
}
|
||||
|
||||
var body map[string]interface{}
|
||||
err = json.Unmarshal(bytes, &body)
|
||||
if err != nil {
|
||||
t.Fatalf("err: %s", err)
|
||||
}
|
||||
return body
|
||||
}
|
||||
|
||||
// makeTempFile creates a temp file and populates it.
|
||||
makeTempFile := func(name, contents string) string {
|
||||
f, err := ioutil.TempFile("", name)
|
||||
|
@ -466,7 +440,7 @@ func TestAgent_RequireRequestHeader(t *testing.T) {
|
|||
req.BodyBytes = []byte(`{
|
||||
"type": "approle"
|
||||
}`)
|
||||
request(serverClient, req, 204)
|
||||
request(t, serverClient, req, 204)
|
||||
|
||||
// Create a named role
|
||||
req = serverClient.NewRequest("PUT", "/v1/auth/approle/role/test-role")
|
||||
|
@ -477,17 +451,17 @@ func TestAgent_RequireRequestHeader(t *testing.T) {
|
|||
"token_num_uses": "10",
|
||||
"token_ttl": "1m"
|
||||
}`)
|
||||
request(serverClient, req, 204)
|
||||
request(t, serverClient, req, 204)
|
||||
|
||||
// Fetch the RoleID of the named role
|
||||
req = serverClient.NewRequest("GET", "/v1/auth/approle/role/test-role/role-id")
|
||||
body := request(serverClient, req, 200)
|
||||
body := request(t, serverClient, req, 200)
|
||||
data := body["data"].(map[string]interface{})
|
||||
roleID := data["role_id"].(string)
|
||||
|
||||
// Get a SecretID issued against the named role
|
||||
req = serverClient.NewRequest("PUT", "/v1/auth/approle/role/test-role/secret-id")
|
||||
body = request(serverClient, req, 200)
|
||||
body = request(t, serverClient, req, 200)
|
||||
data = body["data"].(map[string]interface{})
|
||||
secretID := data["secret_id"].(string)
|
||||
|
||||
|
@ -579,13 +553,13 @@ listener "tcp" {
|
|||
// 'require_request_header', with the header missing from the request.
|
||||
agentClient := newApiClient("http://127.0.0.1:8101", false)
|
||||
req = agentClient.NewRequest("GET", "/v1/sys/health")
|
||||
request(agentClient, req, 200)
|
||||
request(t, agentClient, req, 200)
|
||||
|
||||
// Test against a listener configuration that sets 'require_request_header'
|
||||
// to 'false', with the header missing from the request.
|
||||
agentClient = newApiClient("http://127.0.0.1:8102", false)
|
||||
req = agentClient.NewRequest("GET", "/v1/sys/health")
|
||||
request(agentClient, req, 200)
|
||||
request(t, agentClient, req, 200)
|
||||
|
||||
// Test against a listener configuration that sets 'require_request_header'
|
||||
// to 'true', with the header missing from the request.
|
||||
|
@ -618,5 +592,297 @@ listener "tcp" {
|
|||
// to 'true', with the proper header present in the request.
|
||||
agentClient = newApiClient("http://127.0.0.1:8103", true)
|
||||
req = agentClient.NewRequest("GET", "/v1/sys/health")
|
||||
request(agentClient, req, 200)
|
||||
request(t, agentClient, req, 200)
|
||||
}
|
||||
|
||||
// TestAgent_Template tests rendering templates
|
||||
func TestAgent_Template(t *testing.T) {
|
||||
//----------------------------------------------------
|
||||
// Pre-test setup
|
||||
//----------------------------------------------------
|
||||
// makeTempFile creates a temp file and populates it.
|
||||
makeTempFile := func(name, contents string) string {
|
||||
f, err := ioutil.TempFile("", name)
|
||||
if err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
path := f.Name()
|
||||
f.WriteString(contents)
|
||||
f.Close()
|
||||
return path
|
||||
}
|
||||
|
||||
//----------------------------------------------------
|
||||
// Start the server and agent
|
||||
//----------------------------------------------------
|
||||
logger := logging.NewVaultLogger(hclog.Trace)
|
||||
cluster := vault.NewTestCluster(t,
|
||||
&vault.CoreConfig{
|
||||
Logger: logger,
|
||||
CredentialBackends: map[string]logical.Factory{
|
||||
"approle": credAppRole.Factory,
|
||||
},
|
||||
LogicalBackends: map[string]logical.Factory{
|
||||
"kv": logicalKv.Factory,
|
||||
},
|
||||
},
|
||||
&vault.TestClusterOptions{
|
||||
HandlerFunc: vaulthttp.Handler,
|
||||
})
|
||||
cluster.Start()
|
||||
defer cluster.Cleanup()
|
||||
|
||||
vault.TestWaitActive(t, cluster.Cores[0].Core)
|
||||
serverClient := cluster.Cores[0].Client
|
||||
|
||||
// Enable the approle auth method
|
||||
req := serverClient.NewRequest("POST", "/v1/sys/auth/approle")
|
||||
req.BodyBytes = []byte(`{
|
||||
"type": "approle"
|
||||
}`)
|
||||
request(t, serverClient, req, 204)
|
||||
|
||||
// give test-role permissions to read the kv secret
|
||||
req = serverClient.NewRequest("PUT", "/v1/sys/policy/myapp-read")
|
||||
req.BodyBytes = []byte(`{
|
||||
"policy": "path \"secret/*\" { capabilities = [\"read\", \"list\"] }"
|
||||
}`)
|
||||
request(t, serverClient, req, 204)
|
||||
|
||||
// Create a named role
|
||||
req = serverClient.NewRequest("PUT", "/v1/auth/approle/role/test-role")
|
||||
req.BodyBytes = []byte(`{
|
||||
"token_ttl": "5m",
|
||||
"token_policies":"default,myapp-read",
|
||||
"policies":"default,myapp-read"
|
||||
}`)
|
||||
request(t, serverClient, req, 204)
|
||||
|
||||
// Fetch the RoleID of the named role
|
||||
req = serverClient.NewRequest("GET", "/v1/auth/approle/role/test-role/role-id")
|
||||
body := request(t, serverClient, req, 200)
|
||||
data := body["data"].(map[string]interface{})
|
||||
roleID := data["role_id"].(string)
|
||||
|
||||
// Get a SecretID issued against the named role
|
||||
req = serverClient.NewRequest("PUT", "/v1/auth/approle/role/test-role/secret-id")
|
||||
body = request(t, serverClient, req, 200)
|
||||
data = body["data"].(map[string]interface{})
|
||||
secretID := data["secret_id"].(string)
|
||||
|
||||
// Write the RoleID and SecretID to temp files
|
||||
roleIDPath := makeTempFile("role_id.txt", roleID+"\n")
|
||||
secretIDPath := makeTempFile("secret_id.txt", secretID+"\n")
|
||||
defer os.Remove(roleIDPath)
|
||||
defer os.Remove(secretIDPath)
|
||||
|
||||
// setup the kv secrets
|
||||
req = serverClient.NewRequest("POST", "/v1/sys/mounts/secret/tune")
|
||||
req.BodyBytes = []byte(`{
|
||||
"options": {"version": "2"}
|
||||
}`)
|
||||
request(t, serverClient, req, 200)
|
||||
|
||||
// populate a secret
|
||||
req = serverClient.NewRequest("POST", "/v1/secret/data/myapp")
|
||||
req.BodyBytes = []byte(`{
|
||||
"data": {
|
||||
"username": "bar",
|
||||
"password": "zap"
|
||||
}
|
||||
}`)
|
||||
request(t, serverClient, req, 200)
|
||||
|
||||
// Get a temp file path we can use for the sink
|
||||
sinkPath := makeTempFile("sink.txt", "")
|
||||
defer os.Remove(sinkPath)
|
||||
|
||||
// make a temp directory to hold renders. Each test will create a temp dir
|
||||
// inside this one
|
||||
tmpDirRoot, err := ioutil.TempDir("", "agent-test-renders")
|
||||
if err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
defer os.RemoveAll(tmpDirRoot)
|
||||
|
||||
// start test cases here
|
||||
testCases := map[string]struct {
|
||||
templateCount int
|
||||
exitAfterAuth bool
|
||||
}{
|
||||
"zero": {},
|
||||
"zero-with-exit": {
|
||||
exitAfterAuth: true,
|
||||
},
|
||||
"one": {
|
||||
templateCount: 1,
|
||||
},
|
||||
"one_exit": {
|
||||
templateCount: 1,
|
||||
exitAfterAuth: true,
|
||||
},
|
||||
"many": {
|
||||
templateCount: 15,
|
||||
},
|
||||
"many_exit": {
|
||||
templateCount: 15,
|
||||
exitAfterAuth: true,
|
||||
},
|
||||
}
|
||||
|
||||
for tcname, tc := range testCases {
|
||||
t.Run(tcname, func(t *testing.T) {
|
||||
// make some template files
|
||||
var templatePaths []string
|
||||
for i := 0; i < tc.templateCount; i++ {
|
||||
path := makeTempFile(fmt.Sprintf("render_%d", i), templateContents)
|
||||
templatePaths = append(templatePaths, path)
|
||||
}
|
||||
|
||||
// create temp dir for this test run
|
||||
tmpDir, err := ioutil.TempDir(tmpDirRoot, tcname)
|
||||
if err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
|
||||
// build up the template config to be added to the Agent config.hcl file
|
||||
var templateConfigStrings []string
|
||||
for i, t := range templatePaths {
|
||||
index := fmt.Sprintf("render_%d.json", i)
|
||||
s := fmt.Sprintf(templateConfigString, t, tmpDir, index)
|
||||
templateConfigStrings = append(templateConfigStrings, s)
|
||||
}
|
||||
|
||||
// Create a config file
|
||||
config := `
|
||||
vault {
|
||||
address = "%s"
|
||||
tls_skip_verify = true
|
||||
}
|
||||
|
||||
auto_auth {
|
||||
method "approle" {
|
||||
mount_path = "auth/approle"
|
||||
config = {
|
||||
role_id_file_path = "%s"
|
||||
secret_id_file_path = "%s"
|
||||
remove_secret_id_file_after_reading = false
|
||||
}
|
||||
}
|
||||
|
||||
sink "file" {
|
||||
config = {
|
||||
path = "%s"
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
%s
|
||||
|
||||
%s
|
||||
`
|
||||
|
||||
// conditionally set the exit_after_auth flag
|
||||
exitAfterAuth := ""
|
||||
if tc.exitAfterAuth {
|
||||
exitAfterAuth = "exit_after_auth = true"
|
||||
}
|
||||
|
||||
// flatten the template configs
|
||||
templateConfig := strings.Join(templateConfigStrings, " ")
|
||||
|
||||
config = fmt.Sprintf(config, serverClient.Address(), roleIDPath, secretIDPath, sinkPath, templateConfig, exitAfterAuth)
|
||||
configPath := makeTempFile("config.hcl", config)
|
||||
defer os.Remove(configPath)
|
||||
|
||||
// Start the agent
|
||||
ui, cmd := testAgentCommand(t, logger)
|
||||
cmd.client = serverClient
|
||||
cmd.startedCh = make(chan struct{})
|
||||
|
||||
wg := &sync.WaitGroup{}
|
||||
wg.Add(1)
|
||||
go func() {
|
||||
code := cmd.Run([]string{"-config", configPath})
|
||||
if code != 0 {
|
||||
t.Errorf("non-zero return code when running agent: %d", code)
|
||||
t.Logf("STDOUT from agent:\n%s", ui.OutputWriter.String())
|
||||
t.Logf("STDERR from agent:\n%s", ui.ErrorWriter.String())
|
||||
}
|
||||
wg.Done()
|
||||
}()
|
||||
|
||||
select {
|
||||
case <-cmd.startedCh:
|
||||
case <-time.After(5 * time.Second):
|
||||
t.Errorf("timeout")
|
||||
}
|
||||
|
||||
// if using exit_after_auth, then the command will have returned at the
|
||||
// end and no longer be running. If we are not using exit_after_auth, then
|
||||
// we need to shut down the command
|
||||
if !tc.exitAfterAuth {
|
||||
// We need to sleep to give Agent time to render the templates. Without this
|
||||
// sleep, the test will attempt to read the temp dir before Agent has had time
|
||||
// to render and will likely fail the test
|
||||
time.Sleep(5 * time.Second)
|
||||
cmd.ShutdownCh <- struct{}{}
|
||||
}
|
||||
wg.Wait()
|
||||
|
||||
//----------------------------------------------------
|
||||
// Perform the tests
|
||||
//----------------------------------------------------
|
||||
|
||||
files, err := ioutil.ReadDir(tmpDir)
|
||||
if err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
|
||||
if len(files) != len(templatePaths) {
|
||||
t.Fatalf("expected (%d) templates, got (%d)", len(templatePaths), len(files))
|
||||
}
|
||||
})
|
||||
}
|
||||
}
|
||||
|
||||
var templateContents = `{{ with secret "secret/myapp"}}
|
||||
{
|
||||
{{ if .Data.data.username}}"username":"{{ .Data.data.username}}",{{ end }}
|
||||
{{ if .Data.data.password }}"password":"{{ .Data.data.password }}",{{ end }}
|
||||
{{ if .Data.metadata.version}}"version":"{{ .Data.metadata.version }}"{{ end }}
|
||||
}
|
||||
{{ end }}`
|
||||
|
||||
var templateConfigString = `
|
||||
template {
|
||||
source = "%s"
|
||||
destination = "%s/%s"
|
||||
}
|
||||
`
|
||||
|
||||
// request issues HTTP requests.
|
||||
func request(t *testing.T, client *api.Client, req *api.Request, expectedStatusCode int) map[string]interface{} {
|
||||
resp, err := client.RawRequest(req)
|
||||
if err != nil {
|
||||
t.Fatalf("err: %s", err)
|
||||
}
|
||||
if resp.StatusCode != expectedStatusCode {
|
||||
t.Fatalf("expected status code %d, not %d", expectedStatusCode, resp.StatusCode)
|
||||
}
|
||||
|
||||
bytes, err := ioutil.ReadAll(resp.Body)
|
||||
if err != nil {
|
||||
t.Fatalf("err: %s", err)
|
||||
}
|
||||
if len(bytes) == 0 {
|
||||
return nil
|
||||
}
|
||||
|
||||
var body map[string]interface{}
|
||||
err = json.Unmarshal(bytes, &body)
|
||||
if err != nil {
|
||||
t.Fatalf("err: %s", err)
|
||||
}
|
||||
return body
|
||||
}
|
||||
|
|
Loading…
Reference in New Issue