package consul import ( "os" "reflect" "sync" "testing" "time" "github.com/go-test/deep" "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" "github.com/hashicorp/vault/sdk/physical/inmem" sr "github.com/hashicorp/vault/serviceregistration" "github.com/hashicorp/vault/vault" ) type consulConf map[string]string func testConsulServiceRegistration(t *testing.T) *serviceRegistration { return testConsulServiceRegistrationConfig(t, &consulConf{}) } func testConsulServiceRegistrationConfig(t *testing.T, conf *consulConf) *serviceRegistration { logger := logging.NewVaultLogger(log.Debug) shutdownCh := make(chan struct{}) defer func() { close(shutdownCh) }() be, err := NewServiceRegistration(*conf, logger, sr.State{}, "") if err != nil { t.Fatalf("Expected Consul to initialize: %v", err) } if err := be.Run(shutdownCh, &sync.WaitGroup{}); err != nil { t.Fatal(err) } c, ok := be.(*serviceRegistration) if !ok { t.Fatalf("Expected serviceRegistration") } return c } // TestConsul_ServiceRegistration tests whether consul ServiceRegistration works func TestConsul_ServiceRegistration(t *testing.T) { // Prepare a docker-based consul instance cleanup, addr, token := consul.PrepareTestContainer(t, "") defer cleanup() // Create a consul client cfg := api.DefaultConfig() cfg.Address = addr cfg.Token = token client, err := api.NewClient(cfg) if err != nil { t.Fatal(err) } // waitForServices waits for the services in the Consul catalog to // reach an expected value, returning the delta if that doesn't happen in time. waitForServices := func(t *testing.T, expected map[string][]string) map[string][]string { t.Helper() // Wait for up to 10 seconds for i := 0; i < 10; i++ { services, _, err := client.Catalog().Services(nil) if err != nil { t.Fatal(err) } if diff := deep.Equal(services, expected); diff == nil { return services } time.Sleep(time.Second) } t.Fatalf("Catalog Services never reached expected state %v", expected) return nil } shutdownCh := make(chan struct{}) defer func() { close(shutdownCh) }() const redirectAddr = "http://127.0.0.1:8200" // Create a ServiceRegistration that points to our consul instance logger := logging.NewVaultLogger(log.Trace) sd, err := NewServiceRegistration(map[string]string{ "address": addr, "token": token, }, logger, sr.State{}, redirectAddr) if err != nil { t.Fatal(err) } if err := sd.Run(shutdownCh, &sync.WaitGroup{}); err != nil { t.Fatal(err) } // Create the core inm, err := inmem.NewInmemHA(nil, logger) if err != nil { t.Fatal(err) } inmha, err := inmem.NewInmemHA(nil, logger) if err != nil { t.Fatal(err) } core, err := vault.NewCore(&vault.CoreConfig{ ServiceRegistration: sd, Physical: inm, HAPhysical: inmha.(physical.HABackend), RedirectAddr: redirectAddr, DisableMlock: true, }) if err != nil { t.Fatal(err) } waitForServices(t, map[string][]string{ "consul": []string{}, "vault": []string{"standby"}, }) // Initialize and unseal the core keys, _ := vault.TestCoreInit(t, core) for _, key := range keys { if _, err := vault.TestCoreUnseal(core, vault.TestKeyCopy(key)); err != nil { t.Fatalf("unseal err: %s", err) } } if core.Sealed() { t.Fatal("should not be sealed") } // Wait for the core to become active vault.TestWaitActive(t, core) waitForServices(t, map[string][]string{ "consul": []string{}, "vault": []string{"active"}, }) } 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) shutdownCh := make(chan struct{}) defer func() { close(shutdownCh) }() be, err := NewServiceRegistration(consulConfig, logger, sr.State{}, "") if err != nil { t.Fatal(err) } if err := be.Run(shutdownCh, &sync.WaitGroup{}); err != nil { t.Fatal(err) } c, ok := be.(*serviceRegistration) 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 { shutdownCh := make(chan struct{}) logger := logging.NewVaultLogger(log.Debug) be, err := NewServiceRegistration(test.consulConfig, logger, sr.State{}, "") if err != nil { t.Fatalf("expected Consul to initialize: %v", err) } if err := be.Run(shutdownCh, &sync.WaitGroup{}); err != nil { t.Fatal(err) } c, ok := be.(*serviceRegistration) if !ok { t.Fatalf("Expected ConsulServiceRegistration") } 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") } } close(shutdownCh) } } func TestConsul_newConsulServiceRegistration(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 { shutdownCh := make(chan struct{}) logger := logging.NewVaultLogger(log.Debug) be, err := NewServiceRegistration(test.consulConfig, logger, sr.State{}, "") 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) } if err := be.Run(shutdownCh, &sync.WaitGroup{}); err != nil { t.Fatal(err) } c, ok := be.(*serviceRegistration) if !ok { t.Fatalf("Expected ConsulServiceRegistration: %s", test.name) } c.disableRegistration = true if c.disableRegistration == false { addr := os.Getenv("CONSUL_HTTP_ADDR") if addr == "" { continue } } if test.checkTimeout != c.checkTimeout { t.Errorf("bad: %v != %v", test.checkTimeout, c.checkTimeout) } if test.service != c.serviceName { t.Errorf("bad: %v != %v", test.service, c.serviceName) } // 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)) // } close(shutdownCh) } } 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 := testConsulServiceRegistration(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 := testConsulServiceRegistration(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_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 { shutdownCh := make(chan struct{}) be, err := NewServiceRegistration(consulConf{ "service": test.serviceName, }, logger, sr.State{}, "") 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) } if err := be.Run(shutdownCh, &sync.WaitGroup{}); err != nil { t.Fatal(err) } c, ok := be.(*serviceRegistration) if !ok { t.Fatalf("Expected serviceRegistration") } 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) } } }