package integration import ( "bytes" "fmt" "io" "net/http" "os" "strings" "time" "github.com/go-check/check" "github.com/traefik/traefik/v3/integration/try" checker "github.com/vdemeester/shakers" ) // HealthCheck test suites. type HealthCheckSuite struct { BaseSuite whoami1IP string whoami2IP string whoami3IP string whoami4IP string } func (s *HealthCheckSuite) SetUpSuite(c *check.C) { s.createComposeProject(c, "healthcheck") s.composeUp(c) s.whoami1IP = s.getComposeServiceIP(c, "whoami1") s.whoami2IP = s.getComposeServiceIP(c, "whoami2") s.whoami3IP = s.getComposeServiceIP(c, "whoami3") s.whoami4IP = s.getComposeServiceIP(c, "whoami4") } func (s *HealthCheckSuite) TestSimpleConfiguration(c *check.C) { file := s.adaptFile(c, "fixtures/healthcheck/simple.toml", struct { Server1 string Server2 string }{s.whoami1IP, s.whoami2IP}) defer os.Remove(file) cmd, display := s.traefikCmd(withConfigFile(file)) defer display(c) err := cmd.Start() c.Assert(err, checker.IsNil) defer s.killCmd(cmd) // wait for traefik err = try.GetRequest("http://127.0.0.1:8080/api/rawdata", 60*time.Second, try.BodyContains("Host(`test.localhost`)")) c.Assert(err, checker.IsNil) frontendHealthReq, err := http.NewRequest(http.MethodGet, "http://127.0.0.1:8000/health", nil) c.Assert(err, checker.IsNil) frontendHealthReq.Host = "test.localhost" err = try.Request(frontendHealthReq, 500*time.Millisecond, try.StatusCodeIs(http.StatusOK)) c.Assert(err, checker.IsNil) // Fix all whoami health to 500 client := &http.Client{} whoamiHosts := []string{s.whoami1IP, s.whoami2IP} for _, whoami := range whoamiHosts { statusInternalServerErrorReq, err := http.NewRequest(http.MethodPost, "http://"+whoami+"/health", bytes.NewBuffer([]byte("500"))) c.Assert(err, checker.IsNil) _, err = client.Do(statusInternalServerErrorReq) c.Assert(err, checker.IsNil) } // Verify no backend service is available due to failing health checks err = try.Request(frontendHealthReq, 3*time.Second, try.StatusCodeIs(http.StatusServiceUnavailable)) c.Assert(err, checker.IsNil) // Change one whoami health to 200 statusOKReq1, err := http.NewRequest(http.MethodPost, "http://"+s.whoami1IP+"/health", bytes.NewBuffer([]byte("200"))) c.Assert(err, checker.IsNil) _, err = client.Do(statusOKReq1) c.Assert(err, checker.IsNil) // Verify frontend health : after err = try.Request(frontendHealthReq, 3*time.Second, try.StatusCodeIs(http.StatusOK)) c.Assert(err, checker.IsNil) frontendReq, err := http.NewRequest(http.MethodGet, "http://127.0.0.1:8000/", nil) c.Assert(err, checker.IsNil) frontendReq.Host = "test.localhost" // Check if whoami1 responds err = try.Request(frontendReq, 500*time.Millisecond, try.BodyContains(s.whoami1IP)) c.Assert(err, checker.IsNil) // Check if the service with bad health check (whoami2) never respond. err = try.Request(frontendReq, 2*time.Second, try.BodyContains(s.whoami2IP)) c.Assert(err, checker.NotNil) // TODO validate : run on 80 resp, err := http.Get("http://127.0.0.1:8000/") // Expected a 404 as we did not configure anything c.Assert(err, checker.IsNil) c.Assert(resp.StatusCode, checker.Equals, http.StatusNotFound) } func (s *HealthCheckSuite) TestMultipleEntrypoints(c *check.C) { file := s.adaptFile(c, "fixtures/healthcheck/multiple-entrypoints.toml", struct { Server1 string Server2 string }{s.whoami1IP, s.whoami2IP}) defer os.Remove(file) cmd, display := s.traefikCmd(withConfigFile(file)) defer display(c) err := cmd.Start() c.Assert(err, checker.IsNil) defer s.killCmd(cmd) // Wait for traefik err = try.GetRequest("http://localhost:8080/api/rawdata", 60*time.Second, try.BodyContains("Host(`test.localhost`)")) c.Assert(err, checker.IsNil) // Check entrypoint http1 frontendHealthReq, err := http.NewRequest(http.MethodGet, "http://127.0.0.1:8000/health", nil) c.Assert(err, checker.IsNil) frontendHealthReq.Host = "test.localhost" err = try.Request(frontendHealthReq, 500*time.Millisecond, try.StatusCodeIs(http.StatusOK)) c.Assert(err, checker.IsNil) // Check entrypoint http2 frontendHealthReq, err = http.NewRequest(http.MethodGet, "http://127.0.0.1:9000/health", nil) c.Assert(err, checker.IsNil) frontendHealthReq.Host = "test.localhost" err = try.Request(frontendHealthReq, 500*time.Millisecond, try.StatusCodeIs(http.StatusOK)) c.Assert(err, checker.IsNil) // Set the both whoami health to 500 client := &http.Client{} whoamiHosts := []string{s.whoami1IP, s.whoami2IP} for _, whoami := range whoamiHosts { statusInternalServerErrorReq, err := http.NewRequest(http.MethodPost, "http://"+whoami+"/health", bytes.NewBuffer([]byte("500"))) c.Assert(err, checker.IsNil) _, err = client.Do(statusInternalServerErrorReq) c.Assert(err, checker.IsNil) } // Verify no backend service is available due to failing health checks err = try.Request(frontendHealthReq, 5*time.Second, try.StatusCodeIs(http.StatusServiceUnavailable)) c.Assert(err, checker.IsNil) // reactivate the whoami2 statusInternalServerOkReq, err := http.NewRequest(http.MethodPost, "http://"+s.whoami2IP+"/health", bytes.NewBuffer([]byte("200"))) c.Assert(err, checker.IsNil) _, err = client.Do(statusInternalServerOkReq) c.Assert(err, checker.IsNil) frontend1Req, err := http.NewRequest(http.MethodGet, "http://127.0.0.1:8000/", nil) c.Assert(err, checker.IsNil) frontend1Req.Host = "test.localhost" frontend2Req, err := http.NewRequest(http.MethodGet, "http://127.0.0.1:9000/", nil) c.Assert(err, checker.IsNil) frontend2Req.Host = "test.localhost" // Check if whoami1 never responds err = try.Request(frontend2Req, 2*time.Second, try.BodyContains(s.whoami1IP)) c.Assert(err, checker.NotNil) // Check if whoami1 never responds err = try.Request(frontend1Req, 2*time.Second, try.BodyContains(s.whoami1IP)) c.Assert(err, checker.NotNil) } func (s *HealthCheckSuite) TestPortOverload(c *check.C) { // Set one whoami health to 200 client := &http.Client{} statusInternalServerErrorReq, err := http.NewRequest(http.MethodPost, "http://"+s.whoami1IP+"/health", bytes.NewBuffer([]byte("200"))) c.Assert(err, checker.IsNil) _, err = client.Do(statusInternalServerErrorReq) c.Assert(err, checker.IsNil) file := s.adaptFile(c, "fixtures/healthcheck/port_overload.toml", struct { Server1 string }{s.whoami1IP}) defer os.Remove(file) cmd, display := s.traefikCmd(withConfigFile(file)) defer display(c) err = cmd.Start() c.Assert(err, checker.IsNil) defer s.killCmd(cmd) // wait for traefik err = try.GetRequest("http://127.0.0.1:8080/api/rawdata", 10*time.Second, try.BodyContains("Host(`test.localhost`)")) c.Assert(err, checker.IsNil) frontendHealthReq, err := http.NewRequest(http.MethodGet, "http://127.0.0.1:8000/health", nil) c.Assert(err, checker.IsNil) frontendHealthReq.Host = "test.localhost" // We test bad gateway because we use an invalid port for the backend err = try.Request(frontendHealthReq, 500*time.Millisecond, try.StatusCodeIs(http.StatusBadGateway)) c.Assert(err, checker.IsNil) // Set one whoami health to 500 statusInternalServerErrorReq, err = http.NewRequest(http.MethodPost, "http://"+s.whoami1IP+"/health", bytes.NewBuffer([]byte("500"))) c.Assert(err, checker.IsNil) _, err = client.Do(statusInternalServerErrorReq) c.Assert(err, checker.IsNil) // Verify no backend service is available due to failing health checks err = try.Request(frontendHealthReq, 3*time.Second, try.StatusCodeIs(http.StatusServiceUnavailable)) c.Assert(err, checker.IsNil) } // Checks if all the loadbalancers created will correctly update the server status. func (s *HealthCheckSuite) TestMultipleRoutersOnSameService(c *check.C) { file := s.adaptFile(c, "fixtures/healthcheck/multiple-routers-one-same-service.toml", struct { Server1 string }{s.whoami1IP}) defer os.Remove(file) cmd, display := s.traefikCmd(withConfigFile(file)) defer display(c) err := cmd.Start() c.Assert(err, checker.IsNil) defer s.killCmd(cmd) // wait for traefik err = try.GetRequest("http://127.0.0.1:8080/api/rawdata", 60*time.Second, try.BodyContains("Host(`test.localhost`)")) c.Assert(err, checker.IsNil) // Set whoami health to 200 to be sure to start with the wanted status client := &http.Client{} statusOkReq, err := http.NewRequest(http.MethodPost, "http://"+s.whoami1IP+"/health", bytes.NewBuffer([]byte("200"))) c.Assert(err, checker.IsNil) _, err = client.Do(statusOkReq) c.Assert(err, checker.IsNil) // check healthcheck on web1 entrypoint healthReqWeb1, err := http.NewRequest(http.MethodGet, "http://127.0.0.1:8000/health", nil) c.Assert(err, checker.IsNil) healthReqWeb1.Host = "test.localhost" err = try.Request(healthReqWeb1, 1*time.Second, try.StatusCodeIs(http.StatusOK)) c.Assert(err, checker.IsNil) // check healthcheck on web2 entrypoint healthReqWeb2, err := http.NewRequest(http.MethodGet, "http://127.0.0.1:9000/health", nil) c.Assert(err, checker.IsNil) healthReqWeb2.Host = "test.localhost" err = try.Request(healthReqWeb2, 500*time.Millisecond, try.StatusCodeIs(http.StatusOK)) c.Assert(err, checker.IsNil) // Set whoami health to 500 statusInternalServerErrorReq, err := http.NewRequest(http.MethodPost, "http://"+s.whoami1IP+"/health", bytes.NewBuffer([]byte("500"))) c.Assert(err, checker.IsNil) _, err = client.Do(statusInternalServerErrorReq) c.Assert(err, checker.IsNil) // Verify no backend service is available due to failing health checks err = try.Request(healthReqWeb1, 3*time.Second, try.StatusCodeIs(http.StatusServiceUnavailable)) c.Assert(err, checker.IsNil) err = try.Request(healthReqWeb2, 3*time.Second, try.StatusCodeIs(http.StatusServiceUnavailable)) c.Assert(err, checker.IsNil) // Change one whoami health to 200 statusOKReq1, err := http.NewRequest(http.MethodPost, "http://"+s.whoami1IP+"/health", bytes.NewBuffer([]byte("200"))) c.Assert(err, checker.IsNil) _, err = client.Do(statusOKReq1) c.Assert(err, checker.IsNil) // Verify health check err = try.Request(healthReqWeb1, 3*time.Second, try.StatusCodeIs(http.StatusOK)) c.Assert(err, checker.IsNil) err = try.Request(healthReqWeb2, 3*time.Second, try.StatusCodeIs(http.StatusOK)) c.Assert(err, checker.IsNil) } func (s *HealthCheckSuite) TestPropagate(c *check.C) { file := s.adaptFile(c, "fixtures/healthcheck/propagate.toml", struct { Server1 string Server2 string Server3 string Server4 string }{s.whoami1IP, s.whoami2IP, s.whoami3IP, s.whoami4IP}) defer os.Remove(file) cmd, display := s.traefikCmd(withConfigFile(file)) defer display(c) err := cmd.Start() c.Assert(err, checker.IsNil) defer s.killCmd(cmd) // wait for traefik err = try.GetRequest("http://127.0.0.1:8080/api/rawdata", 60*time.Second, try.BodyContains("Host(`root.localhost`)")) c.Assert(err, checker.IsNil) rootReq, err := http.NewRequest(http.MethodGet, "http://127.0.0.1:8000", nil) c.Assert(err, checker.IsNil) rootReq.Host = "root.localhost" err = try.Request(rootReq, 500*time.Millisecond, try.StatusCodeIs(http.StatusOK)) c.Assert(err, checker.IsNil) // Bring whoami1 and whoami3 down client := http.Client{ Timeout: 10 * time.Second, } whoamiHosts := []string{s.whoami1IP, s.whoami3IP} for _, whoami := range whoamiHosts { statusInternalServerErrorReq, err := http.NewRequest(http.MethodPost, "http://"+whoami+"/health", bytes.NewBuffer([]byte("500"))) c.Assert(err, checker.IsNil) _, err = client.Do(statusInternalServerErrorReq) c.Assert(err, checker.IsNil) } try.Sleep(time.Second) want2 := `IP: ` + s.whoami2IP want4 := `IP: ` + s.whoami4IP // Verify load-balancing on root still works, and that we're getting an alternation between wsp2, and wsp4. reachedServers := make(map[string]int) for i := 0; i < 4; i++ { resp, err := client.Do(rootReq) c.Assert(err, checker.IsNil) body, err := io.ReadAll(resp.Body) c.Assert(err, checker.IsNil) if reachedServers[s.whoami4IP] > reachedServers[s.whoami2IP] { c.Assert(string(body), checker.Contains, want2) reachedServers[s.whoami2IP]++ continue } if reachedServers[s.whoami2IP] > reachedServers[s.whoami4IP] { c.Assert(string(body), checker.Contains, want4) reachedServers[s.whoami4IP]++ continue } // First iteration, so we can't tell whether it's going to be wsp2, or wsp4. if strings.Contains(string(body), `IP: `+s.whoami4IP) { reachedServers[s.whoami4IP]++ continue } if strings.Contains(string(body), `IP: `+s.whoami2IP) { reachedServers[s.whoami2IP]++ continue } } c.Assert(reachedServers[s.whoami2IP], checker.Equals, 2) c.Assert(reachedServers[s.whoami4IP], checker.Equals, 2) fooReq, err := http.NewRequest(http.MethodGet, "http://127.0.0.1:8000", nil) c.Assert(err, checker.IsNil) fooReq.Host = "foo.localhost" // Verify load-balancing on foo still works, and that we're getting wsp2, wsp2, wsp2, wsp2, etc. want := `IP: ` + s.whoami2IP for i := 0; i < 4; i++ { resp, err := client.Do(fooReq) c.Assert(err, checker.IsNil) body, err := io.ReadAll(resp.Body) c.Assert(err, checker.IsNil) c.Assert(string(body), checker.Contains, want) } barReq, err := http.NewRequest(http.MethodGet, "http://127.0.0.1:8000", nil) c.Assert(err, checker.IsNil) barReq.Host = "bar.localhost" // Verify load-balancing on bar still works, and that we're getting wsp2, wsp2, wsp2, wsp2, etc. want = `IP: ` + s.whoami2IP for i := 0; i < 4; i++ { resp, err := client.Do(barReq) c.Assert(err, checker.IsNil) body, err := io.ReadAll(resp.Body) c.Assert(err, checker.IsNil) c.Assert(string(body), checker.Contains, want) } // Bring whoami2 and whoami4 down whoamiHosts = []string{s.whoami2IP, s.whoami4IP} for _, whoami := range whoamiHosts { statusInternalServerErrorReq, err := http.NewRequest(http.MethodPost, "http://"+whoami+"/health", bytes.NewBuffer([]byte("500"))) c.Assert(err, checker.IsNil) _, err = client.Do(statusInternalServerErrorReq) c.Assert(err, checker.IsNil) } try.Sleep(time.Second) // Verify that everything is down, and that we get 503s everywhere. for i := 0; i < 2; i++ { resp, err := client.Do(rootReq) c.Assert(err, checker.IsNil) c.Assert(resp.StatusCode, checker.Equals, http.StatusServiceUnavailable) resp, err = client.Do(fooReq) c.Assert(err, checker.IsNil) c.Assert(resp.StatusCode, checker.Equals, http.StatusServiceUnavailable) resp, err = client.Do(barReq) c.Assert(err, checker.IsNil) c.Assert(resp.StatusCode, checker.Equals, http.StatusServiceUnavailable) } // Bring everything back up. whoamiHosts = []string{s.whoami1IP, s.whoami2IP, s.whoami3IP, s.whoami4IP} for _, whoami := range whoamiHosts { statusOKReq, err := http.NewRequest(http.MethodPost, "http://"+whoami+"/health", bytes.NewBuffer([]byte("200"))) c.Assert(err, checker.IsNil) _, err = client.Do(statusOKReq) c.Assert(err, checker.IsNil) } try.Sleep(time.Second) // Verify everything is up on root router. reachedServers = make(map[string]int) for i := 0; i < 4; i++ { resp, err := client.Do(rootReq) c.Assert(err, checker.IsNil) body, err := io.ReadAll(resp.Body) c.Assert(err, checker.IsNil) if strings.Contains(string(body), `IP: `+s.whoami1IP) { reachedServers[s.whoami1IP]++ continue } if strings.Contains(string(body), `IP: `+s.whoami2IP) { reachedServers[s.whoami2IP]++ continue } if strings.Contains(string(body), `IP: `+s.whoami3IP) { reachedServers[s.whoami3IP]++ continue } if strings.Contains(string(body), `IP: `+s.whoami4IP) { reachedServers[s.whoami4IP]++ continue } } c.Assert(reachedServers[s.whoami1IP], checker.Equals, 1) c.Assert(reachedServers[s.whoami2IP], checker.Equals, 1) c.Assert(reachedServers[s.whoami3IP], checker.Equals, 1) c.Assert(reachedServers[s.whoami4IP], checker.Equals, 1) // Verify everything is up on foo router. reachedServers = make(map[string]int) for i := 0; i < 4; i++ { resp, err := client.Do(fooReq) c.Assert(err, checker.IsNil) body, err := io.ReadAll(resp.Body) c.Assert(err, checker.IsNil) if strings.Contains(string(body), `IP: `+s.whoami1IP) { reachedServers[s.whoami1IP]++ continue } if strings.Contains(string(body), `IP: `+s.whoami2IP) { reachedServers[s.whoami2IP]++ continue } if strings.Contains(string(body), `IP: `+s.whoami3IP) { reachedServers[s.whoami3IP]++ continue } if strings.Contains(string(body), `IP: `+s.whoami4IP) { reachedServers[s.whoami4IP]++ continue } } c.Assert(reachedServers[s.whoami1IP], checker.Equals, 2) c.Assert(reachedServers[s.whoami2IP], checker.Equals, 1) c.Assert(reachedServers[s.whoami3IP], checker.Equals, 1) c.Assert(reachedServers[s.whoami4IP], checker.Equals, 0) // Verify everything is up on bar router. reachedServers = make(map[string]int) for i := 0; i < 4; i++ { resp, err := client.Do(barReq) c.Assert(err, checker.IsNil) body, err := io.ReadAll(resp.Body) c.Assert(err, checker.IsNil) if strings.Contains(string(body), `IP: `+s.whoami1IP) { reachedServers[s.whoami1IP]++ continue } if strings.Contains(string(body), `IP: `+s.whoami2IP) { reachedServers[s.whoami2IP]++ continue } if strings.Contains(string(body), `IP: `+s.whoami3IP) { reachedServers[s.whoami3IP]++ continue } if strings.Contains(string(body), `IP: `+s.whoami4IP) { reachedServers[s.whoami4IP]++ continue } } c.Assert(reachedServers[s.whoami1IP], checker.Equals, 2) c.Assert(reachedServers[s.whoami2IP], checker.Equals, 1) c.Assert(reachedServers[s.whoami3IP], checker.Equals, 1) c.Assert(reachedServers[s.whoami4IP], checker.Equals, 0) } func (s *HealthCheckSuite) TestPropagateNoHealthCheck(c *check.C) { file := s.adaptFile(c, "fixtures/healthcheck/propagate_no_healthcheck.toml", struct { Server1 string }{s.whoami1IP}) defer os.Remove(file) cmd, display := s.traefikCmd(withConfigFile(file)) defer display(c) err := cmd.Start() c.Assert(err, checker.IsNil) defer s.killCmd(cmd) // wait for traefik err = try.GetRequest("http://127.0.0.1:8080/api/rawdata", 60*time.Second, try.BodyContains("Host(`noop.localhost`)"), try.BodyNotContains("Host(`root.localhost`)")) c.Assert(err, checker.IsNil) rootReq, err := http.NewRequest(http.MethodGet, "http://127.0.0.1:8000", nil) c.Assert(err, checker.IsNil) rootReq.Host = "root.localhost" err = try.Request(rootReq, 500*time.Millisecond, try.StatusCodeIs(http.StatusNotFound)) c.Assert(err, checker.IsNil) } func (s *HealthCheckSuite) TestPropagateReload(c *check.C) { // Setup a WSP service without the healthcheck enabled (wsp-service1) withoutHealthCheck := s.adaptFile(c, "fixtures/healthcheck/reload_without_healthcheck.toml", struct { Server1 string Server2 string }{s.whoami1IP, s.whoami2IP}) defer os.Remove(withoutHealthCheck) withHealthCheck := s.adaptFile(c, "fixtures/healthcheck/reload_with_healthcheck.toml", struct { Server1 string Server2 string }{s.whoami1IP, s.whoami2IP}) defer os.Remove(withHealthCheck) cmd, display := s.traefikCmd(withConfigFile(withoutHealthCheck)) defer display(c) err := cmd.Start() c.Assert(err, checker.IsNil) defer s.killCmd(cmd) // wait for traefik err = try.GetRequest("http://127.0.0.1:8080/api/rawdata", 60*time.Second, try.BodyContains("Host(`root.localhost`)")) c.Assert(err, checker.IsNil) // Allow one of the underlying services on it to fail all servers HC (whoami2) client := http.Client{ Timeout: 10 * time.Second, } statusOKReq, err := http.NewRequest(http.MethodPost, "http://"+s.whoami2IP+"/health", bytes.NewBuffer([]byte("500"))) c.Assert(err, checker.IsNil) _, err = client.Do(statusOKReq) c.Assert(err, checker.IsNil) rootReq, err := http.NewRequest(http.MethodGet, "http://127.0.0.1:8000", nil) c.Assert(err, checker.IsNil) rootReq.Host = "root.localhost" // Check the failed service (whoami2) is getting requests, but answer 500 err = try.Request(rootReq, 500*time.Millisecond, try.StatusCodeIs(http.StatusServiceUnavailable)) c.Assert(err, checker.IsNil) // Enable the healthcheck on the root WSP (wsp-service1) and let Traefik reload the config fr1, err := os.OpenFile(withoutHealthCheck, os.O_APPEND|os.O_WRONLY, 0o644) c.Assert(fr1, checker.NotNil) c.Assert(err, checker.IsNil) err = fr1.Truncate(0) c.Assert(err, checker.IsNil) fr2, err := os.ReadFile(withHealthCheck) c.Assert(err, checker.IsNil) _, err = fmt.Fprint(fr1, string(fr2)) c.Assert(err, checker.IsNil) err = fr1.Close() c.Assert(err, checker.IsNil) try.Sleep(1 * time.Second) // Check the failed service (whoami2) is not getting requests wantIPs := []string{s.whoami1IP, s.whoami1IP, s.whoami1IP, s.whoami1IP} for _, ip := range wantIPs { want := "IP: " + ip resp, err := client.Do(rootReq) c.Assert(err, checker.IsNil) body, err := io.ReadAll(resp.Body) c.Assert(err, checker.IsNil) c.Assert(string(body), checker.Contains, want) } }