package consul import ( "context" "fmt" "math/rand" "os" "reflect" "strings" "sync" "testing" "time" "github.com/hashicorp/consul/api" log "github.com/hashicorp/go-hclog" "github.com/hashicorp/vault/helper/testhelpers/consul" "github.com/hashicorp/vault/sdk/helper/logging" "github.com/hashicorp/vault/sdk/helper/strutil" "github.com/hashicorp/vault/sdk/physical" ) type consulConf map[string]string var ( addrCount int = 0 ) func testConsulBackend(t *testing.T) *ConsulBackend { return testConsulBackendConfig(t, &consulConf{}) } func testConsulBackendConfig(t *testing.T, conf *consulConf) *ConsulBackend { logger := logging.NewVaultLogger(log.Debug) be, err := NewConsulBackend(*conf, logger) if err != nil { t.Fatalf("Expected Consul to initialize: %v", err) } c, ok := be.(*ConsulBackend) if !ok { t.Fatalf("Expected ConsulBackend") } return c } func testConsul_testConsulBackend(t *testing.T) { c := testConsulBackend(t) if c == nil { t.Fatalf("bad") } } func testActiveFunc(activePct float64) physical.ActiveFunction { return func() bool { var active bool standbyProb := rand.Float64() if standbyProb > activePct { active = true } return active } } func testSealedFunc(sealedPct float64) physical.SealedFunction { return func() bool { var sealed bool unsealedProb := rand.Float64() if unsealedProb > sealedPct { sealed = true } return sealed } } func testPerformanceStandbyFunc(perfPct float64) physical.PerformanceStandbyFunction { return func() bool { var ps bool unsealedProb := rand.Float64() if unsealedProb > perfPct { ps = true } return ps } } func TestConsul_ServiceTags(t *testing.T) { consulConfig := map[string]string{ "path": "seaTech/", "service": "astronomy", "service_tags": "deadbeef, cafeefac, deadc0de, feedface", "redirect_addr": "http://127.0.0.2:8200", "check_timeout": "6s", "address": "127.0.0.2", "scheme": "https", "token": "deadbeef-cafeefac-deadc0de-feedface", "max_parallel": "4", "disable_registration": "false", } logger := logging.NewVaultLogger(log.Debug) be, err := NewConsulBackend(consulConfig, logger) if err != nil { t.Fatal(err) } c, ok := be.(*ConsulBackend) if !ok { t.Fatalf("failed to create physical Consul backend") } expected := []string{"deadbeef", "cafeefac", "deadc0de", "feedface"} actual := c.fetchServiceTags(false, false) if !strutil.EquivalentSlices(actual, append(expected, "standby")) { t.Fatalf("bad: expected:%s actual:%s", append(expected, "standby"), actual) } actual = c.fetchServiceTags(true, false) if !strutil.EquivalentSlices(actual, append(expected, "active")) { t.Fatalf("bad: expected:%s actual:%s", append(expected, "active"), actual) } actual = c.fetchServiceTags(false, true) if !strutil.EquivalentSlices(actual, append(expected, "performance-standby")) { t.Fatalf("bad: expected:%s actual:%s", append(expected, "performance-standby"), actual) } actual = c.fetchServiceTags(true, true) if !strutil.EquivalentSlices(actual, append(expected, "performance-standby")) { t.Fatalf("bad: expected:%s actual:%s", append(expected, "performance-standby"), actual) } } func TestConsul_ServiceAddress(t *testing.T) { tests := []struct { consulConfig map[string]string serviceAddrNil bool }{ { consulConfig: map[string]string{ "service_address": "", }, }, { consulConfig: map[string]string{ "service_address": "vault.example.com", }, }, { serviceAddrNil: true, }, } for _, test := range tests { logger := logging.NewVaultLogger(log.Debug) be, err := NewConsulBackend(test.consulConfig, logger) if err != nil { t.Fatalf("expected Consul to initialize: %v", err) } c, ok := be.(*ConsulBackend) if !ok { t.Fatalf("Expected ConsulBackend") } if test.serviceAddrNil { if c.serviceAddress != nil { t.Fatalf("expected service address to be nil") } } else { if c.serviceAddress == nil { t.Fatalf("did not expect service address to be nil") } } } } func TestConsul_newConsulBackend(t *testing.T) { tests := []struct { name string consulConfig map[string]string fail bool redirectAddr string checkTimeout time.Duration path string service string address string scheme string token string max_parallel int disableReg bool consistencyMode string }{ { name: "Valid default config", consulConfig: map[string]string{}, checkTimeout: 5 * time.Second, redirectAddr: "http://127.0.0.1:8200", path: "vault/", service: "vault", address: "127.0.0.1:8500", scheme: "http", token: "", max_parallel: 4, disableReg: false, consistencyMode: "default", }, { name: "Valid modified config", consulConfig: map[string]string{ "path": "seaTech/", "service": "astronomy", "redirect_addr": "http://127.0.0.2:8200", "check_timeout": "6s", "address": "127.0.0.2", "scheme": "https", "token": "deadbeef-cafeefac-deadc0de-feedface", "max_parallel": "4", "disable_registration": "false", "consistency_mode": "strong", }, checkTimeout: 6 * time.Second, path: "seaTech/", service: "astronomy", redirectAddr: "http://127.0.0.2:8200", address: "127.0.0.2", scheme: "https", token: "deadbeef-cafeefac-deadc0de-feedface", max_parallel: 4, consistencyMode: "strong", }, { name: "Unix socket", consulConfig: map[string]string{ "address": "unix:///tmp/.consul.http.sock", }, address: "/tmp/.consul.http.sock", scheme: "http", // Default, not overridden? // Defaults checkTimeout: 5 * time.Second, redirectAddr: "http://127.0.0.1:8200", path: "vault/", service: "vault", token: "", max_parallel: 4, disableReg: false, consistencyMode: "default", }, { name: "Scheme in address", consulConfig: map[string]string{ "address": "https://127.0.0.2:5000", }, address: "127.0.0.2:5000", scheme: "https", // Defaults checkTimeout: 5 * time.Second, redirectAddr: "http://127.0.0.1:8200", path: "vault/", service: "vault", token: "", max_parallel: 4, disableReg: false, consistencyMode: "default", }, { name: "check timeout too short", fail: true, consulConfig: map[string]string{ "check_timeout": "99ms", }, }, } for _, test := range tests { logger := logging.NewVaultLogger(log.Debug) be, err := NewConsulBackend(test.consulConfig, logger) if test.fail { if err == nil { t.Fatalf(`Expected config "%s" to fail`, test.name) } else { continue } } else if !test.fail && err != nil { t.Fatalf("Expected config %s to not fail: %v", test.name, err) } c, ok := be.(*ConsulBackend) if !ok { t.Fatalf("Expected ConsulBackend: %s", test.name) } c.disableRegistration = true if c.disableRegistration == false { addr := os.Getenv("CONSUL_HTTP_ADDR") if addr == "" { continue } } var shutdownCh physical.ShutdownChannel waitGroup := &sync.WaitGroup{} if err := c.RunServiceDiscovery(waitGroup, shutdownCh, test.redirectAddr, testActiveFunc(0.5), testSealedFunc(0.5), testPerformanceStandbyFunc(0.5)); err != nil { t.Fatalf("bad: %v", err) } if test.checkTimeout != c.checkTimeout { t.Errorf("bad: %v != %v", test.checkTimeout, c.checkTimeout) } if test.path != c.path { t.Errorf("bad: %s %v != %v", test.name, test.path, c.path) } if test.service != c.serviceName { t.Errorf("bad: %v != %v", test.service, c.serviceName) } if test.consistencyMode != c.consistencyMode { t.Errorf("bad consistency_mode value: %v != %v", test.consistencyMode, c.consistencyMode) } // The configuration stored in the Consul "client" object is not exported, so // we either have to skip validating it, or add a method to export it, or use reflection. consulConfig := reflect.Indirect(reflect.ValueOf(c.client)).FieldByName("config") consulConfigScheme := consulConfig.FieldByName("Scheme").String() consulConfigAddress := consulConfig.FieldByName("Address").String() if test.scheme != consulConfigScheme { t.Errorf("bad scheme value: %v != %v", test.scheme, consulConfigScheme) } if test.address != consulConfigAddress { t.Errorf("bad address value: %v != %v", test.address, consulConfigAddress) } // FIXME(sean@): Unable to test max_parallel // if test.max_parallel != cap(c.permitPool) { // t.Errorf("bad: %v != %v", test.max_parallel, cap(c.permitPool)) // } } } func TestConsul_serviceTags(t *testing.T) { tests := []struct { active bool perfStandby bool tags []string }{ { active: true, perfStandby: false, tags: []string{"active"}, }, { active: false, perfStandby: false, tags: []string{"standby"}, }, { active: false, perfStandby: true, tags: []string{"performance-standby"}, }, { active: true, perfStandby: true, tags: []string{"performance-standby"}, }, } c := testConsulBackend(t) for _, test := range tests { tags := c.fetchServiceTags(test.active, test.perfStandby) if !reflect.DeepEqual(tags[:], test.tags[:]) { t.Errorf("Bad %v: %v %v", test.active, tags, test.tags) } } } func TestConsul_setRedirectAddr(t *testing.T) { tests := []struct { addr string host string port int64 pass bool }{ { addr: "http://127.0.0.1:8200/", host: "127.0.0.1", port: 8200, pass: true, }, { addr: "http://127.0.0.1:8200", host: "127.0.0.1", port: 8200, pass: true, }, { addr: "https://127.0.0.1:8200", host: "127.0.0.1", port: 8200, pass: true, }, { addr: "unix:///tmp/.vault.addr.sock", host: "/tmp/.vault.addr.sock", port: -1, pass: true, }, { addr: "127.0.0.1:8200", pass: false, }, { addr: "127.0.0.1", pass: false, }, } for _, test := range tests { c := testConsulBackend(t) err := c.setRedirectAddr(test.addr) if test.pass { if err != nil { t.Fatalf("bad: %v", err) } } else { if err == nil { t.Fatalf("bad, expected fail") } else { continue } } if c.redirectHost != test.host { t.Fatalf("bad: %v != %v", c.redirectHost, test.host) } if c.redirectPort != test.port { t.Fatalf("bad: %v != %v", c.redirectPort, test.port) } } } func TestConsul_NotifyActiveStateChange(t *testing.T) { c := testConsulBackend(t) if err := c.NotifyActiveStateChange(); err != nil { t.Fatalf("bad: %v", err) } } func TestConsul_NotifySealedStateChange(t *testing.T) { c := testConsulBackend(t) if err := c.NotifySealedStateChange(); err != nil { t.Fatalf("bad: %v", err) } } func TestConsul_serviceID(t *testing.T) { tests := []struct { name string redirectAddr string serviceName string expected string valid bool }{ { name: "valid host w/o slash", redirectAddr: "http://127.0.0.1:8200", serviceName: "sea-tech-astronomy", expected: "sea-tech-astronomy:127.0.0.1:8200", valid: true, }, { name: "valid host w/ slash", redirectAddr: "http://127.0.0.1:8200/", serviceName: "sea-tech-astronomy", expected: "sea-tech-astronomy:127.0.0.1:8200", valid: true, }, { name: "valid https host w/ slash", redirectAddr: "https://127.0.0.1:8200/", serviceName: "sea-tech-astronomy", expected: "sea-tech-astronomy:127.0.0.1:8200", valid: true, }, { name: "invalid host name", redirectAddr: "https://127.0.0.1:8200/", serviceName: "sea_tech_astronomy", expected: "", valid: false, }, } logger := logging.NewVaultLogger(log.Debug) for _, test := range tests { be, err := NewConsulBackend(consulConf{ "service": test.serviceName, }, logger) if !test.valid { if err == nil { t.Fatalf("expected an error initializing for name %q", test.serviceName) } continue } if test.valid && err != nil { t.Fatalf("expected Consul to initialize: %v", err) } c, ok := be.(*ConsulBackend) if !ok { t.Fatalf("Expected ConsulBackend") } if err := c.setRedirectAddr(test.redirectAddr); err != nil { t.Fatalf("bad: %s %v", test.name, err) } serviceID := c.serviceID() if serviceID != test.expected { t.Fatalf("bad: %v != %v", serviceID, test.expected) } } } func TestConsulBackend(t *testing.T) { consulToken := os.Getenv("CONSUL_HTTP_TOKEN") addr := os.Getenv("CONSUL_HTTP_ADDR") if addr == "" { cleanup, connURL, token := consul.PrepareTestContainer(t, "1.4.4") defer cleanup() addr, consulToken = connURL, token } conf := api.DefaultConfig() conf.Address = addr conf.Token = consulToken client, err := api.NewClient(conf) if err != nil { t.Fatalf("err: %v", err) } randPath := fmt.Sprintf("vault-%d/", time.Now().Unix()) defer func() { client.KV().DeleteTree(randPath, nil) }() logger := logging.NewVaultLogger(log.Debug) b, err := NewConsulBackend(map[string]string{ "address": conf.Address, "path": randPath, "max_parallel": "256", "token": conf.Token, }, logger) if err != nil { t.Fatalf("err: %s", err) } physical.ExerciseBackend(t, b) physical.ExerciseBackend_ListPrefix(t, b) } func TestConsul_TooLarge(t *testing.T) { consulToken := os.Getenv("CONSUL_HTTP_TOKEN") addr := os.Getenv("CONSUL_HTTP_ADDR") if addr == "" { cleanup, connURL, token := consul.PrepareTestContainer(t, "1.4.4") defer cleanup() addr, consulToken = connURL, token } conf := api.DefaultConfig() conf.Address = addr conf.Token = consulToken client, err := api.NewClient(conf) if err != nil { t.Fatalf("err: %v", err) } randPath := fmt.Sprintf("vault-%d/", time.Now().Unix()) defer func() { client.KV().DeleteTree(randPath, nil) }() logger := logging.NewVaultLogger(log.Debug) b, err := NewConsulBackend(map[string]string{ "address": conf.Address, "path": randPath, "max_parallel": "256", "token": conf.Token, }, logger) if err != nil { t.Fatalf("err: %s", err) } zeros := make([]byte, 600000, 600000) n, err := rand.Read(zeros) if n != 600000 { t.Fatalf("expected 500k zeros, read %d", n) } if err != nil { t.Fatal(err) } err = b.Put(context.Background(), &physical.Entry{ Key: "foo", Value: zeros, }) if err == nil { t.Fatal("expected error") } if !strings.Contains(err.Error(), physical.ErrValueTooLarge) { t.Fatalf("expected value too large error, got %v", err) } err = b.(physical.Transactional).Transaction(context.Background(), []*physical.TxnEntry{ { Operation: physical.PutOperation, Entry: &physical.Entry{ Key: "foo", Value: zeros, }, }, }) if err == nil { t.Fatal("expected error") } if !strings.Contains(err.Error(), physical.ErrValueTooLarge) { t.Fatalf("expected value too large error, got %v", err) } } func TestConsulHABackend(t *testing.T) { consulToken := os.Getenv("CONSUL_HTTP_TOKEN") addr := os.Getenv("CONSUL_HTTP_ADDR") if addr == "" { cleanup, connURL, token := consul.PrepareTestContainer(t, "1.4.4") defer cleanup() addr, consulToken = connURL, token } conf := api.DefaultConfig() conf.Address = addr conf.Token = consulToken client, err := api.NewClient(conf) if err != nil { t.Fatalf("err: %v", err) } randPath := fmt.Sprintf("vault-%d/", time.Now().Unix()) defer func() { client.KV().DeleteTree(randPath, nil) }() logger := logging.NewVaultLogger(log.Debug) config := map[string]string{ "address": conf.Address, "path": randPath, "max_parallel": "-1", "token": conf.Token, } b, err := NewConsulBackend(config, logger) if err != nil { t.Fatalf("err: %s", err) } b2, err := NewConsulBackend(config, logger) if err != nil { t.Fatalf("err: %s", err) } physical.ExerciseHABackend(t, b.(physical.HABackend), b2.(physical.HABackend)) detect, ok := b.(physical.RedirectDetect) if !ok { t.Fatalf("consul does not implement RedirectDetect") } host, err := detect.DetectHostAddr() if err != nil { t.Fatalf("err: %s", err) } if host == "" { t.Fatalf("bad addr: %v", host) } }