diff --git a/Makefile b/Makefile index f6e4f7f..6abb685 100644 --- a/Makefile +++ b/Makefile @@ -14,6 +14,6 @@ lint: $(GOLANGCI_LINT) ##### linting ##### golangci-lint run -E golint -E gosec -E gofmt -test: +test: build ##### testing ##### go test $(testflags) -v -race ./... diff --git a/checks/dns_test.go b/checks/dns_test.go index d991b22..700bd90 100644 --- a/checks/dns_test.go +++ b/checks/dns_test.go @@ -25,7 +25,7 @@ func TestNewHostResolveCheck_noSuchHost(t *testing.T) { assert.Equal(t, "resolve.I-hope-there-is.no.such.host.com", check.Name(), "check name") - ctx, cancel := context.WithTimeout(context.Background(), 1*time.Second) + ctx, cancel := context.WithTimeout(context.Background(), 2*time.Second) defer cancel() details, err := check.Execute(ctx) diff --git a/go.mod b/go.mod index e6e7abd..fe5bb1f 100644 --- a/go.mod +++ b/go.mod @@ -6,5 +6,5 @@ require ( github.com/fortytw2/leaktest v1.3.0 github.com/pkg/errors v0.8.1 github.com/stretchr/objx v0.2.0 // indirect - github.com/stretchr/testify v1.4.0 + github.com/stretchr/testify v1.6.1 ) diff --git a/go.sum b/go.sum index 03835fe..88f2eec 100644 --- a/go.sum +++ b/go.sum @@ -1,21 +1,101 @@ +cloud.google.com/go v0.26.0/go.mod h1:aQUYkXzVsufM+DwF1aE+0xfcU+56JwCaLick0ClmMTw= +github.com/BurntSushi/toml v0.3.1/go.mod h1:xHWCNGjB5oqiDr8zfno3MHue2Ht5sIBksp03qcyfWMU= +github.com/census-instrumentation/opencensus-proto v0.2.1/go.mod h1:f6KPmirojxKA12rnyqOA5BBL4O983OfeGPqjHWSTneU= +github.com/client9/misspell v0.3.4/go.mod h1:qj6jICC3Q7zFZvVWo7KLAzC3yx5G7kyvSDkc90ppPyw= +github.com/cncf/udpa/go v0.0.0-20191209042840-269d4d468f6f/go.mod h1:M8M6+tZqaGXZJjfX53e64911xZQV5JYwmTeXPW+k8Sc= github.com/davecgh/go-spew v1.1.0 h1:ZDRjVQ15GmhC3fiQ8ni8+OwkZQO4DARzQgrnXU1Liz8= github.com/davecgh/go-spew v1.1.0/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38= github.com/davecgh/go-spew v1.1.1 h1:vj9j/u1bqnvCEfJOwUhtlOARqs3+rkHYY13jYWTU97c= github.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38= +github.com/envoyproxy/go-control-plane v0.9.0/go.mod h1:YTl/9mNaCwkRvm6d1a2C3ymFceY/DCBVvsKhRF0iEA4= +github.com/envoyproxy/go-control-plane v0.9.1-0.20191026205805-5f8ba28d4473/go.mod h1:YTl/9mNaCwkRvm6d1a2C3ymFceY/DCBVvsKhRF0iEA4= +github.com/envoyproxy/go-control-plane v0.9.4/go.mod h1:6rpuAdCZL397s3pYoYcLgu1mIlRU8Am5FuJP05cCM98= +github.com/envoyproxy/protoc-gen-validate v0.1.0/go.mod h1:iSmxcyjqTsJpI2R4NaDN7+kN2VEUnK/pcBlmesArF7c= github.com/fortytw2/leaktest v1.3.0 h1:u8491cBMTQ8ft8aeV+adlcytMZylmA5nnwwkRZjI8vw= github.com/fortytw2/leaktest v1.3.0/go.mod h1:jDsjWgpAGjm2CA7WthBh/CdZYEPF31XHquHwclZch5g= +github.com/golang/glog v0.0.0-20160126235308-23def4e6c14b/go.mod h1:SBH7ygxi8pfUlaOkMMuAQtPIUF8ecWP5IEl/CR7VP2Q= +github.com/golang/groupcache v0.0.0-20200121045136-8c9f03a8e57e/go.mod h1:cIg4eruTrX1D+g88fzRXU5OdNfaM+9IcxsU14FzY7Hc= +github.com/golang/mock v1.1.1/go.mod h1:oTYuIxOrZwtPieC+H1uAHpcLFnEyAGVDL/k47Jfbm0A= +github.com/golang/protobuf v1.2.0/go.mod h1:6lQm79b+lXiMfvg/cZm0SGofjICqVBUtrP5yJMmIC1U= +github.com/golang/protobuf v1.3.2/go.mod h1:6lQm79b+lXiMfvg/cZm0SGofjICqVBUtrP5yJMmIC1U= +github.com/golang/protobuf v1.4.0-rc.1/go.mod h1:ceaxUfeHdC40wWswd/P6IGgMaK3YpKi5j83Wpe3EHw8= +github.com/golang/protobuf v1.4.0-rc.1.0.20200221234624-67d41d38c208/go.mod h1:xKAWHe0F5eneWXFV3EuXVDTCmh+JuBKY0li0aMyXATA= +github.com/golang/protobuf v1.4.0-rc.2/go.mod h1:LlEzMj4AhA7rCAGe4KMBDvJI+AwstrUpVNzEA03Pprs= +github.com/golang/protobuf v1.4.0-rc.4.0.20200313231945-b860323f09d0/go.mod h1:WU3c8KckQ9AFe+yFwt9sWVRKCVIyN9cPHBJSNnbL67w= +github.com/golang/protobuf v1.4.0/go.mod h1:jodUvKwWbYaEsadDk5Fwe5c77LiNKVO9IDvqG2KuDX0= +github.com/golang/protobuf v1.4.1/go.mod h1:U8fpvMrcmy5pZrNK1lt4xCsGvpyWQ/VVv6QDs8UjoX8= +github.com/golang/protobuf v1.4.3/go.mod h1:oDoupMAO8OvCJWAcko0GGGIgR6R6ocIYbsSw735rRwI= +github.com/google/go-cmp v0.2.0/go.mod h1:oXzfMopK8JAjlY9xF4vHSVASa0yLyX7SntLO5aqRK0M= +github.com/google/go-cmp v0.3.0/go.mod h1:8QqcDgzrUqlUb/G2PQTWiueGozuR1884gddMywk6iLU= +github.com/google/go-cmp v0.3.1/go.mod h1:8QqcDgzrUqlUb/G2PQTWiueGozuR1884gddMywk6iLU= +github.com/google/go-cmp v0.4.0/go.mod h1:v8dTdLbMG2kIc/vJvl+f65V22dbkXbowE6jgT/gNBxE= +github.com/google/go-cmp v0.5.0/go.mod h1:v8dTdLbMG2kIc/vJvl+f65V22dbkXbowE6jgT/gNBxE= +github.com/google/go-cmp v0.5.3/go.mod h1:v8dTdLbMG2kIc/vJvl+f65V22dbkXbowE6jgT/gNBxE= +github.com/google/uuid v1.1.2/go.mod h1:TIyPZe4MgqvfeYDBFedMoGGpEw/LqOeaOT+nhxU+yHo= github.com/pkg/errors v0.8.1 h1:iURUrRGxPUNPdy5/HRSm+Yj6okJ6UtLINN0Q9M4+h3I= github.com/pkg/errors v0.8.1/go.mod h1:bwawxfHBFNV+L2hUp1rHADufV3IMtnDRdf1r5NINEl0= github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM= github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4= +github.com/prometheus/client_model v0.0.0-20190812154241-14fe0d1b01d4/go.mod h1:xMI15A0UPsDsEKsMN9yxemIoYk6Tm2C1GtYGdfGttqA= github.com/stretchr/objx v0.1.0 h1:4G4v2dO3VZwixGIRoQ5Lfboy6nUhCyYzaqnIAPPhYs4= github.com/stretchr/objx v0.1.0/go.mod h1:HFkY916IF+rwdDfMAkV7OtwuqBVzrE8GR6GFx+wExME= github.com/stretchr/objx v0.2.0 h1:Hbg2NidpLE8veEBkEZTL3CvlkUIVzuU9jDplZO54c48= github.com/stretchr/objx v0.2.0/go.mod h1:qt09Ya8vawLte6SNmTgCsAVtYtaKzEcn8ATUoHMkEqE= github.com/stretchr/testify v1.3.0/go.mod h1:M5WIy9Dh21IEIfnGCwXGc5bZfKNJtfHm1UVUgZn+9EI= -github.com/stretchr/testify v1.4.0 h1:2E4SXV/wtOkTonXsotYi4li6zVWxYlZuYNCXe9XRJyk= -github.com/stretchr/testify v1.4.0/go.mod h1:j7eGeouHqKxXV5pUuKE4zz7dFj8WfuZ+81PSLYec5m4= +github.com/stretchr/testify v1.6.1 h1:hDPOHmpOpP40lSULcqw7IrRb/u7w6RpDC9399XyoNd0= +github.com/stretchr/testify v1.6.1/go.mod h1:6Fq8oRcR53rry900zMqJjRRixrwX3KX962/h/Wwjteg= +go.opencensus.io v0.23.0 h1:gqCw0LfLxScz8irSi8exQc7fyQ0fKQU/qnC/X8+V/1M= +go.opencensus.io v0.23.0/go.mod h1:XItmlyltB5F7CS4xOC1DcqMoFqwtC6OG2xF7mCv7P7E= +golang.org/x/crypto v0.0.0-20190308221718-c2843e01d9a2/go.mod h1:djNgcEr1/C05ACkg1iLfiJU5Ep61QUkGW8qpdssI0+w= +golang.org/x/crypto v0.0.0-20200622213623-75b288015ac9/go.mod h1:LzIPMQfyMNhhGPhUkYOs5KpL4U8rLKemX1yGLhDgUto= +golang.org/x/exp v0.0.0-20190121172915-509febef88a4/go.mod h1:CJ0aWSM057203Lf6IL+f9T1iT9GByDxfZKAQTCR3kQA= +golang.org/x/lint v0.0.0-20181026193005-c67002cb31c3/go.mod h1:UVdnD1Gm6xHRNCYTkRU2/jEulfH38KcIWyp/GAMgvoE= +golang.org/x/lint v0.0.0-20190227174305-5b3e6a55c961/go.mod h1:wehouNa3lNwaWXcvxsM5YxQ5yQlVC4a0KAMCusXpPoU= +golang.org/x/lint v0.0.0-20190313153728-d0100b6bd8b3/go.mod h1:6SW0HCj/g11FgYtHlgUYUwCkIfeOF89ocIRzGO/8vkc= +golang.org/x/net v0.0.0-20180724234803-3673e40ba225/go.mod h1:mL1N/T3taQHkDXs73rZJwtUhF3w3ftmwwsq0BUmARs4= +golang.org/x/net v0.0.0-20180826012351-8a410e7b638d/go.mod h1:mL1N/T3taQHkDXs73rZJwtUhF3w3ftmwwsq0BUmARs4= +golang.org/x/net v0.0.0-20190213061140-3a22650c66bd/go.mod h1:mL1N/T3taQHkDXs73rZJwtUhF3w3ftmwwsq0BUmARs4= +golang.org/x/net v0.0.0-20190311183353-d8887717615a/go.mod h1:t9HGtf8HONx5eT2rtn7q6eTqICYqUVnKs3thJo3Qplg= +golang.org/x/net v0.0.0-20190404232315-eb5bcb51f2a3/go.mod h1:t9HGtf8HONx5eT2rtn7q6eTqICYqUVnKs3thJo3Qplg= +golang.org/x/net v0.0.0-20201110031124-69a78807bb2b/go.mod h1:sp8m0HH+o8qH0wwXwYZr8TS3Oi6o0r6Gce1SSxlDquU= +golang.org/x/oauth2 v0.0.0-20180821212333-d2e6202438be/go.mod h1:N/0e6XlmueqKjAGxoOufVs8QHGRruUQn6yWY3a++T0U= +golang.org/x/sync v0.0.0-20180314180146-1d60e4601c6f/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM= +golang.org/x/sync v0.0.0-20181108010431-42b317875d0f/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM= +golang.org/x/sync v0.0.0-20190423024810-112230192c58/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM= +golang.org/x/sys v0.0.0-20180830151530-49385e6e1522/go.mod h1:STP8DvDyc/dI5b8T5hshtkjS+E42TnysNCUPdjciGhY= +golang.org/x/sys v0.0.0-20190215142949-d0b11bdaac8a/go.mod h1:STP8DvDyc/dI5b8T5hshtkjS+E42TnysNCUPdjciGhY= +golang.org/x/sys v0.0.0-20190412213103-97732733099d/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= +golang.org/x/sys v0.0.0-20200930185726-fdedc70b468f/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= +golang.org/x/text v0.3.0/go.mod h1:NqM8EUOU14njkJ3fqMW+pc6Ldnwhi/IjpwHt7yyuwOQ= +golang.org/x/text v0.3.3/go.mod h1:5Zoc/QRtKVWzQhOtBMvqHzDpF6irO9z98xDceosuGiQ= +golang.org/x/tools v0.0.0-20180917221912-90fa682c2a6e/go.mod h1:n7NCudcB/nEzxVGmLbDWY5pfWTLqBcC2KZ6jyYvM4mQ= +golang.org/x/tools v0.0.0-20190114222345-bf090417da8b/go.mod h1:n7NCudcB/nEzxVGmLbDWY5pfWTLqBcC2KZ6jyYvM4mQ= +golang.org/x/tools v0.0.0-20190226205152-f727befe758c/go.mod h1:9Yl7xja0Znq3iFh3HoIrodX9oNMXvdceNzlUR8zjMvY= +golang.org/x/tools v0.0.0-20190311212946-11955173bddd/go.mod h1:LCzVGOaR6xXOjkQ3onu1FJEFr0SW1gC7cKk1uF8kGRs= +golang.org/x/tools v0.0.0-20190524140312-2c0ae7006135/go.mod h1:RgjU9mgBXZiqYHBnxXauZ1Gv1EHHAz9KjViQ78xBX0Q= +golang.org/x/xerrors v0.0.0-20191204190536-9bdfabe68543/go.mod h1:I/5z698sn9Ka8TeJc9MKroUUfqBBauWjQqLJ2OPfmY0= +google.golang.org/appengine v1.1.0/go.mod h1:EbEs0AVv82hx2wNQdGPgUI5lhzA/G0D9YwlJXL52JkM= +google.golang.org/appengine v1.4.0/go.mod h1:xpcJRLb0r/rnEns0DIKYYv+WjYCduHsrkT7/EB5XEv4= +google.golang.org/genproto v0.0.0-20180817151627-c66870c02cf8/go.mod h1:JiN7NxoALGmiZfu7CAH4rXhgtRTLTxftemlI0sWmxmc= +google.golang.org/genproto v0.0.0-20190819201941-24fa4b261c55/go.mod h1:DMBHOl98Agz4BDEuKkezgsaosCRResVns1a3J2ZsMNc= +google.golang.org/genproto v0.0.0-20200526211855-cb27e3aa2013/go.mod h1:NbSheEEYHJ7i3ixzK3sjbqSGDJWnxyFXZblF3eUsNvo= +google.golang.org/grpc v1.19.0/go.mod h1:mqu4LbDTu4XGKhr4mRzUsmM4RtVoemTSY81AxZiDr8c= +google.golang.org/grpc v1.23.0/go.mod h1:Y5yQAOtifL1yxbo5wqy6BxZv8vAUGQwXBOALyacEbxg= +google.golang.org/grpc v1.25.1/go.mod h1:c3i+UQWmh7LiEpx4sFZnkU36qjEYZ0imhYfXVyQciAY= +google.golang.org/grpc v1.27.0/go.mod h1:qbnxyOmOxrQa7FizSgH+ReBfzJrCY1pSN7KXBS8abTk= +google.golang.org/grpc v1.33.2/go.mod h1:JMHMWHQWaTccqQQlmk3MJZS+GWXOdAesneDmEnv2fbc= +google.golang.org/protobuf v0.0.0-20200109180630-ec00e32a8dfd/go.mod h1:DFci5gLYBciE7Vtevhsrf46CRTquxDuWsQurQQe4oz8= +google.golang.org/protobuf v0.0.0-20200221191635-4d8936d0db64/go.mod h1:kwYJMbMJ01Woi6D6+Kah6886xMZcty6N08ah7+eCXa0= +google.golang.org/protobuf v0.0.0-20200228230310-ab0ca4ff8a60/go.mod h1:cfTl7dwQJ+fmap5saPgwCLgHXTUD7jkjRqWcaiX5VyM= +google.golang.org/protobuf v1.20.1-0.20200309200217-e05f789c0967/go.mod h1:A+miEFZTKqfCUM6K7xSMQL9OKL/b6hQv+e19PK+JZNE= +google.golang.org/protobuf v1.21.0/go.mod h1:47Nbq4nVaFHyn7ilMalzfO3qCViNmqZ2kzikPIcrTAo= +google.golang.org/protobuf v1.22.0/go.mod h1:EGpADcykh3NcUnDUJcl1+ZksZNG86OlYog2l/sGQquU= +google.golang.org/protobuf v1.23.0/go.mod h1:EGpADcykh3NcUnDUJcl1+ZksZNG86OlYog2l/sGQquU= +google.golang.org/protobuf v1.23.1-0.20200526195155-81db48ad09cc/go.mod h1:EGpADcykh3NcUnDUJcl1+ZksZNG86OlYog2l/sGQquU= +google.golang.org/protobuf v1.25.0/go.mod h1:9JNX74DMeImyA3h4bdi1ymwjUzf21/xIlbajtzgsN7c= gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405 h1:yhCVgyC4o1eVCa2tZl7eS0r+SDo693bJlVdllGtEeKM= gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0= -gopkg.in/yaml.v2 v2.2.2 h1:ZCJp+EgiOT7lHqUV2J862kp8Qj64Jo6az82+3Td9dZw= -gopkg.in/yaml.v2 v2.2.2/go.mod h1:hI93XBmqTisBFMUTm0b8Fm+jr3Dg1NNxqwp+5A1VGuI= +gopkg.in/yaml.v3 v3.0.0-20200313102051-9f266ea9e77c h1:dUUwHk2QECo/6vqA44rthZ8ie2QXMNeKRTHCNY2nXvo= +gopkg.in/yaml.v3 v3.0.0-20200313102051-9f266ea9e77c/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM= +honnef.co/go/tools v0.0.0-20190102054323-c2f93a96b099/go.mod h1:rf3lG4BRIbNafJWhAfAdb/ePZxsR/4RtNHQocxwk9r4= +honnef.co/go/tools v0.0.0-20190523083050-ea95bdfd59fc/go.mod h1:rf3lG4BRIbNafJWhAfAdb/ePZxsR/4RtNHQocxwk9r4= diff --git a/health_test.go b/health_test.go index 9a6851a..d4e3485 100644 --- a/health_test.go +++ b/health_test.go @@ -14,6 +14,7 @@ import ( . "github.com/AppsFlyer/go-sundheit" "github.com/AppsFlyer/go-sundheit/checks" + "github.com/AppsFlyer/go-sundheit/test/helper" ) const ( @@ -55,7 +56,8 @@ func TestHealthWithBogusCheck(t *testing.T) { func TestRegisterDeregister(t *testing.T) { leaktest.Check(t) - h := New() + checkWaiter := helper.NewCheckWaiter() + h := New(WithCheckListeners(checkWaiter)) registerCheck(h, failingCheckName, false, false) registerCheck(h, passingCheckName, true, false) @@ -80,7 +82,7 @@ func TestRegisterDeregister(t *testing.T) { assert.Contains(t, initiallyPassingCheck.String(), "didn't run yet", "initial details") // await first execution - time.Sleep(50 * time.Millisecond) + assert.NoError(t, checkWaiter.AwaitChecksCompletion(failingCheckName, passingCheckName, initiallyPassingCheckName)) assert.False(t, h.IsHealthy(), "health after registration before first run with one failing check") results, healthy = h.Results() @@ -104,8 +106,8 @@ func TestRegisterDeregister(t *testing.T) { assert.Contains(t, initiallyPassingCheck.String(), "success", "details after execution") h.Deregister(failingCheckName) - // await check cleanup - time.Sleep(50 * time.Millisecond) + // await next check completion + assert.NoError(t, checkWaiter.AwaitChecksCompletion(passingCheckName, initiallyPassingCheckName)) assert.True(t, h.IsHealthy(), "health after failing checks deregistration") @@ -122,7 +124,8 @@ func TestRegisterDeregister(t *testing.T) { h.DeregisterAll() // await stop - time.Sleep(50 * time.Millisecond) + // TODO we need to add CheckListener.OnCheckDeregistered, then we can remove this sleep too + time.Sleep(20 * time.Millisecond) results, _ = h.Results() assert.Empty(t, results, "results after stop") } @@ -151,7 +154,7 @@ func registerCheck(h Health, name string, passing bool, initiallyPassing bool) { } func TestCheckListener(t *testing.T) { - + checkWaiter := helper.NewCheckWaiter() listenerMock := &checkListenerMock{} listenerMock.On("OnCheckRegistered", failingCheckName, mock.AnythingOfType("Result")).Return() listenerMock.On("OnCheckRegistered", passingCheckName, mock.AnythingOfType("Result")).Return() @@ -159,14 +162,14 @@ func TestCheckListener(t *testing.T) { listenerMock.On("OnCheckStarted", passingCheckName).Return() listenerMock.On("OnCheckCompleted", failingCheckName, mock.AnythingOfType("Result")).Return() listenerMock.On("OnCheckCompleted", passingCheckName, mock.AnythingOfType("Result")).Return() - h := New(WithCheckListeners(listenerMock)) + h := New(WithCheckListeners(listenerMock, checkWaiter)) registerCheck(h, failingCheckName, false, false) registerCheck(h, passingCheckName, true, false) defer h.DeregisterAll() // await first execution - time.Sleep(30 * time.Millisecond) + assert.NoError(t, checkWaiter.AwaitChecksCompletion(failingCheckName, passingCheckName)) listenerMock.AssertExpectations(t) @@ -187,22 +190,16 @@ func TestCheckListener(t *testing.T) { } func TestHealthListeners(t *testing.T) { - - listenerMock := &healthListenerMock{} - listenerMock.On( - "OnResultsUpdated", - mock.AnythingOfType("map[string]gosundheit.Result")). - Return().Times(2) + listenerMock := newHealthListenerMock() h := New(WithHealthListeners(listenerMock)) registerCheck(h, failingCheckName, false, false) - registerCheck(h, passingCheckName, true, false) defer h.DeregisterAll() - // await first execution - time.Sleep(30 * time.Millisecond) - - listenerMock.AssertExpectations(t) + res := <-listenerMock.completedChan + assert.Equal(t, "failed; i=1", res[failingCheckName].Details) + res = <-listenerMock.completedChan + assert.Equal(t, "failed; i=2", res[failingCheckName].Details) } func (l *checkListenerMock) getCompletedChecks() []completedCheck { @@ -240,9 +237,15 @@ func (l *checkListenerMock) OnCheckCompleted(name string, res Result) { } type healthListenerMock struct { - mock.Mock + completedChan chan map[string]Result +} + +func newHealthListenerMock() *healthListenerMock { + return &healthListenerMock{ + completedChan: make(chan map[string]Result), + } } -func (h *healthListenerMock) OnResultsUpdated(results map[string]Result) { - h.Called(results) +func (l *healthListenerMock) OnResultsUpdated(results map[string]Result) { + l.completedChan <- results } diff --git a/http/handler_test.go b/http/handler_test.go index c55720d..51a7d8e 100644 --- a/http/handler_test.go +++ b/http/handler_test.go @@ -13,9 +13,15 @@ import ( gosundheit "github.com/AppsFlyer/go-sundheit" "github.com/AppsFlyer/go-sundheit/checks" + "github.com/AppsFlyer/go-sundheit/test/helper" + "github.com/stretchr/testify/assert" ) +const ( + chkName = "check1" +) + func TestHandleHealthJSON_longFormatNoChecks(t *testing.T) { h := gosundheit.New() resp := execReq(h, true) @@ -35,10 +41,11 @@ func TestHandleHealthJSON_shortFormatNoChecks(t *testing.T) { } func TestHandleHealthJSON_longFormatPassingCheck(t *testing.T) { - h := gosundheit.New() + checkWaiter := helper.NewCheckWaiter() + h := gosundheit.New(gosundheit.WithCheckListeners(checkWaiter)) err := h.RegisterCheck( - createCheck("check1", true), + createCheck(chkName, true), createCheckOptions(10*time.Millisecond)..., ) if err != nil { @@ -62,7 +69,8 @@ func TestHandleHealthJSON_longFormatPassingCheck(t *testing.T) { } assert.Equal(t, &expectedResponse, respMsg, "body when no checks are registered") - time.Sleep(20 * time.Millisecond) + assert.NoError(t, checkWaiter.AwaitChecksCompletion(chkName)) + resp = execReq(h, true) assert.Equal(t, http.StatusOK, resp.StatusCode, "status before first run") @@ -77,10 +85,11 @@ func TestHandleHealthJSON_longFormatPassingCheck(t *testing.T) { } func TestHandleHealthJSON_shortFormatPassingCheck(t *testing.T) { - h := gosundheit.New() + checkWaiter := helper.NewCheckWaiter() + h := gosundheit.New(gosundheit.WithCheckListeners(checkWaiter)) err := h.RegisterCheck( - createCheck("check1", true), + createCheck(chkName, true), createCheckOptions(10*time.Millisecond)..., ) if err != nil { @@ -95,7 +104,7 @@ func TestHandleHealthJSON_shortFormatPassingCheck(t *testing.T) { expectedResponse := map[string]string{"check1": "FAIL"} assert.Equal(t, expectedResponse, respMsg, "body when no checks are registered") - time.Sleep(20 * time.Millisecond) + assert.NoError(t, checkWaiter.AwaitChecksCompletion(chkName)) resp = execReq(h, false) assert.Equal(t, http.StatusOK, resp.StatusCode, "status before first run") diff --git a/opencensus/go.mod b/opencensus/go.mod index da381b0..444790a 100644 --- a/opencensus/go.mod +++ b/opencensus/go.mod @@ -3,7 +3,7 @@ module github.com/AppsFlyer/go-sundheit/opencensus go 1.15 require ( - github.com/AppsFlyer/go-sundheit v0.3.0 + github.com/AppsFlyer/go-sundheit v0.4.0 github.com/pkg/errors v0.8.1 github.com/stretchr/testify v1.4.0 go.opencensus.io v0.22.1 diff --git a/opencensus/go.sum b/opencensus/go.sum index b2b2550..49542ad 100644 --- a/opencensus/go.sum +++ b/opencensus/go.sum @@ -1,6 +1,6 @@ cloud.google.com/go v0.26.0/go.mod h1:aQUYkXzVsufM+DwF1aE+0xfcU+56JwCaLick0ClmMTw= -github.com/AppsFlyer/go-sundheit v0.3.0 h1:fuDPHbilautZtPqRcFrGAeedmAUNGnvUu95+3fs4gZ0= -github.com/AppsFlyer/go-sundheit v0.3.0/go.mod h1:iZ8zWMS7idcvmqewf5mEymWWgoOiG/0WD4+aeh+heX4= +github.com/AppsFlyer/go-sundheit v0.4.0 h1:7ECd0YWaXJQ9LzdCFrpGxJVeAgXvNarN6uwxrJsh69A= +github.com/AppsFlyer/go-sundheit v0.4.0/go.mod h1:iZ8zWMS7idcvmqewf5mEymWWgoOiG/0WD4+aeh+heX4= github.com/BurntSushi/toml v0.3.1/go.mod h1:xHWCNGjB5oqiDr8zfno3MHue2Ht5sIBksp03qcyfWMU= github.com/client9/misspell v0.3.4/go.mod h1:qj6jICC3Q7zFZvVWo7KLAzC3yx5G7kyvSDkc90ppPyw= github.com/davecgh/go-spew v1.1.0/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38= diff --git a/opencensus/metrics_listener_test.go b/opencensus/metrics_listener_test.go index 4ba2fc0..c095af0 100644 --- a/opencensus/metrics_listener_test.go +++ b/opencensus/metrics_listener_test.go @@ -1,6 +1,7 @@ package opencensus import ( + "context" "fmt" "strings" "testing" @@ -136,15 +137,14 @@ func registerCheck(h gosundheit.Health, name string, passing bool, initiallyPass passing: passing, } - _ = h.RegisterCheck(&gosundheit.Config{ - Check: &checks.CustomCheck{ - CheckName: name, - CheckFunc: stub.run, - }, - InitialDelay: 20 * time.Millisecond, - ExecutionPeriod: 120 * time.Millisecond, - InitiallyPassing: initiallyPassing, - }) + _ = h.RegisterCheck(&checks.CustomCheck{ + CheckName: name, + CheckFunc: stub.run, + }, + gosundheit.InitialDelay(20*time.Millisecond), + gosundheit.ExecutionPeriod(120*time.Millisecond), + gosundheit.InitiallyPassing(initiallyPassing), + ) } type checkStub struct { @@ -152,7 +152,7 @@ type checkStub struct { passing bool } -func (c *checkStub) run() (details interface{}, err error) { +func (c *checkStub) run(_ context.Context) (details interface{}, err error) { c.counts++ if c.passing { return fmt.Sprintf("%s; i=%d", successMsg, c.counts), nil diff --git a/test/helper/check_waiter.go b/test/helper/check_waiter.go new file mode 100644 index 0000000..430d609 --- /dev/null +++ b/test/helper/check_waiter.go @@ -0,0 +1,60 @@ +package helper + +import ( + "fmt" + + gosundheit "github.com/AppsFlyer/go-sundheit" +) + +type CheckWaiter struct { + completedChan chan string +} + +func NewCheckWaiter() *CheckWaiter { + return &CheckWaiter{ + completedChan: make(chan string), + } +} + +func (c *CheckWaiter) OnCheckRegistered(_ string, _ gosundheit.Result) {} + +func (c *CheckWaiter) OnCheckStarted(_ string) {} + +func (c *CheckWaiter) OnCheckCompleted(name string, _ gosundheit.Result) { + c.completedChan <- name +} + +func (c *CheckWaiter) AwaitChecksCompletion(checkNames ...string) error { + if len(checkNames) == 0 { + return nil + } + + awaitingCompletion := make(map[string]int, len(checkNames)) + for _, c := range checkNames { + _, ok := awaitingCompletion[c] + if ok { + awaitingCompletion[c]++ + } else { + awaitingCompletion[c] = 1 + } + } + + for chkName := range c.completedChan { + fmt.Printf("check '%s' completed\n", chkName) + remainingCount, ok := awaitingCompletion[chkName] + if !ok { + return fmt.Errorf("unexpected check completed: %s", chkName) + } + if remainingCount == 1 { + delete(awaitingCompletion, chkName) + } else { + awaitingCompletion[chkName]-- + } + + if len(awaitingCompletion) == 0 { + break + } + } + + return nil +}