chore: add tests on watcher (#5)

Author: MattKetmo

go.mod

@@ -8,6 +8,7 @@ require (
 	github.com/prometheus/client_golang v1.16.0
 	github.com/shopspring/decimal v1.3.1
 	github.com/sirupsen/logrus v1.9.0
+	github.com/stretchr/testify v1.8.4
 	github.com/urfave/cli/v2 v2.25.7
 	golang.org/x/sync v0.3.0
 )
@@ -16,16 +17,20 @@ require (
 	github.com/beorn7/perks v1.0.1 // indirect
 	github.com/cespare/xxhash/v2 v2.2.0 // indirect
 	github.com/cpuguy83/go-md2man/v2 v2.0.2 // indirect
+	github.com/davecgh/go-spew v1.1.1 // indirect
 	github.com/golang/protobuf v1.5.3 // indirect
+	github.com/kr/text v0.2.0 // indirect
 	github.com/mattn/go-colorable v0.1.13 // indirect
 	github.com/mattn/go-isatty v0.0.19 // indirect
 	github.com/matttproud/golang_protobuf_extensions v1.0.4 // indirect
+	github.com/pmezard/go-difflib v1.0.0 // indirect
 	github.com/prometheus/client_model v0.3.0 // indirect
 	github.com/prometheus/common v0.42.0 // indirect
 	github.com/prometheus/procfs v0.10.1 // indirect
+	github.com/rogpeppe/go-internal v1.11.0 // indirect
 	github.com/russross/blackfriday/v2 v2.1.0 // indirect
-	github.com/stretchr/testify v1.8.4 // indirect
 	github.com/xrash/smetrics v0.0.0-20201216005158-039620a65673 // indirect
 	golang.org/x/sys v0.12.0 // indirect
 	google.golang.org/protobuf v1.31.0 // indirect
+	gopkg.in/yaml.v3 v3.0.1 // indirect
 )

go.sum

@@ -6,6 +6,7 @@ github.com/cespare/xxhash/v2 v2.2.0 h1:DC2CZ1Ep5Y4k3ZQ899DldepgrayRUGE6BBZ/cd9Cj
 github.com/cespare/xxhash/v2 v2.2.0/go.mod h1:VGX0DQ3Q6kWi7AoAeZDth3/j3BFtOZR5XLFGgcrjCOs=
 github.com/cpuguy83/go-md2man/v2 v2.0.2 h1:p1EgwI/C7NhT0JmVkwCD2ZBK8j4aeHQX2pMHHBfMQ6w=
 github.com/cpuguy83/go-md2man/v2 v2.0.2/go.mod h1:tgQtvFlXSQOSOSIRvRPT7W67SCa46tRHOmNcaadrF8o=
+github.com/creack/pty v1.1.9/go.mod h1:oKZEueFk5CKHvIhNR5MUki03XCEU+Q6VDXinZuGJ33E=
 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=
@@ -18,6 +19,9 @@ github.com/golang/protobuf v1.5.3 h1:KhyjKVUg7Usr/dYsdSqoFveMYd5ko72D+zANwlG1mmg
 github.com/golang/protobuf v1.5.3/go.mod h1:XVQd3VNwM+JqD3oG2Ue2ip4fOMUkwXdXDdiuN0vRsmY=
 github.com/google/go-cmp v0.5.5/go.mod h1:v8dTdLbMG2kIc/vJvl+f65V22dbkXbowE6jgT/gNBxE=
 github.com/google/go-cmp v0.5.9 h1:O2Tfq5qg4qc4AmwVlvv0oLiVAGB7enBSJ2x2DqQFi38=
+github.com/kr/pretty v0.3.1 h1:flRD4NNwYAUpkphVc1HcthR4KEIFJ65n8Mw5qdRn3LE=
+github.com/kr/text v0.2.0 h1:5Nx0Ya0ZqY2ygV366QzturHI13Jq95ApcVaJBhpS+AY=
+github.com/kr/text v0.2.0/go.mod h1:eLer722TekiGuMkidMxC/pM04lWEeraHUUmBw8l2grE=
 github.com/mattn/go-colorable v0.1.13 h1:fFA4WZxdEF4tXPZVKMLwD8oUnCTTo08duU7wxecdEvA=
 github.com/mattn/go-colorable v0.1.13/go.mod h1:7S9/ev0klgBDR4GtXTXX8a3vIGJpMovkB8vQcUbaXHg=
 github.com/mattn/go-isatty v0.0.16/go.mod h1:kYGgaQfpe5nmfYZH+SKPsOc2e4SrIfOl2e/yFXSvRLM=
@@ -35,6 +39,8 @@ github.com/prometheus/common v0.42.0 h1:EKsfXEYo4JpWMHH5cg+KOUWeuJSov1Id8zGR8eeI
 github.com/prometheus/common v0.42.0/go.mod h1:xBwqVerjNdUDjgODMpudtOMwlOwf2SaTr1yjz4b7Zbc=
 github.com/prometheus/procfs v0.10.1 h1:kYK1Va/YMlutzCGazswoHKo//tZVlFpKYh+PymziUAg=
 github.com/prometheus/procfs v0.10.1/go.mod h1:nwNm2aOCAYw8uTR/9bWRREkZFxAUcWzPHWJq+XBB/FM=
+github.com/rogpeppe/go-internal v1.11.0 h1:cWPaGQEPrBb5/AsnsZesgZZ9yb1OQ+GOISoDNXVBh4M=
+github.com/rogpeppe/go-internal v1.11.0/go.mod h1:ddIwULY96R17DhadqLgMfk9H9tvdUzkipdSkR5nkCZA=
 github.com/russross/blackfriday/v2 v2.1.0 h1:JIOH55/0cWyOuilr9/qlrm0BSXldqnqwMsf35Ld67mk=
 github.com/russross/blackfriday/v2 v2.1.0/go.mod h1:+Rmxgy9KzJVeS9/2gXHxylqXiyQDYRxCVz55jmeOWTM=
 github.com/shopspring/decimal v1.3.1 h1:2Usl1nmF/WZucqkFZhnfFYxxxu8LG21F6nPQBE5gKV8=
@@ -63,5 +69,7 @@ google.golang.org/protobuf v1.26.0/go.mod h1:9q0QmTI4eRPtz6boOQmLYwt+qCgq0jsYwAQ
 google.golang.org/protobuf v1.31.0 h1:g0LDEJHgrBl9N9r17Ru3sqWhkIx2NB67okBHPwC7hs8=
 google.golang.org/protobuf v1.31.0/go.mod h1:HV8QOd/L58Z+nl8r43ehVNZIU/HEI6OcFqwMG9pJV4I=
 gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0=
+gopkg.in/check.v1 v1.0.0-20201130134442-10cb98267c6c h1:Hei/4ADfdWqJk1ZMxUNpqntNwaWcugrBjAiHlqqRiVk=
 gopkg.in/yaml.v3 v3.0.0-20200313102051-9f266ea9e77c/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM=
 gopkg.in/yaml.v3 v3.0.1 h1:fxVm/GzAzEWqLHuvctI91KS9hhNmmWOoWu0XTYJS7CA=
+gopkg.in/yaml.v3 v3.0.1/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM=

pkg/app/run.go

@@ -2,7 +2,6 @@ package app
 
 import (
 	"context"
-	"net/http"
 	"os"
 	"os/signal"
 	"syscall"
@@ -56,10 +55,13 @@ func RunFunc(cCtx *cli.Context) error {
 	// Validator Watcher
 	//
 	logrus.Infof("connecting to node %s", node)
+
+	client := near.NewClient(node)
+
 	registry := prometheus.NewRegistry()
 	metrics := metrics.New(namespace)
 	metrics.Register(registry)
-	client := near.NewClient(node, &http.Client{})
+
 	watcher := watcher.New(client, metrics, &watcher.Config{
 		Writer:          os.Stdout,
 		TrackedAccounts: validators,
@@ -73,9 +75,7 @@ func RunFunc(cCtx *cli.Context) error {
 	// HTTP server
 	//
 	logrus.Infof("starting HTTP server on %s", httpAddr)
-	readyProbe := func() bool {
-		return !watcher.IsSyncing()
-	}
+	readyProbe := watcher.IsSynced
 	httpServer := NewHTTPServer(
 		httpAddr,
 		WithReadyProbe(readyProbe),

pkg/metrics/metrics.go

@@ -14,7 +14,7 @@ type Metrics struct {
 	NextValidatorStake      *prometheus.GaugeVec
 	PrevEpochKickout        *prometheus.GaugeVec
 	ProtocolVersion         prometheus.Gauge
-	SeatPriceDesc           prometheus.Gauge
+	SeatPrice               prometheus.Gauge
 	SyncingDesc             prometheus.Gauge
 	ValidatorExpectedBlocks *prometheus.GaugeVec
 	ValidatorExpectedChunks *prometheus.GaugeVec
@@ -65,14 +65,14 @@ func New(namespace string) *Metrics {
 			Namespace: namespace,
 			Name:      "prev_epoch_kickout",
 			Help:      "Near previous epoch kicked out validators"},
-			[]string{"account_id", "public_key", "epoch_start_height", "tracked"},
+			[]string{"account_id", "reason", "epoch_start_height", "tracked"},
 		),
 		ProtocolVersion: prometheus.NewGauge(prometheus.GaugeOpts{
 			Namespace: namespace,
 			Name:      "protocol_version",
 			Help:      "Current protocol version deployed to the blockchain",
 		}),
-		SeatPriceDesc: prometheus.NewGauge(prometheus.GaugeOpts{
+		SeatPrice: prometheus.NewGauge(prometheus.GaugeOpts{
 			Namespace: namespace,
 			Name:      "seat_price",
 			Help:      "Validator seat price",
@@ -145,7 +145,7 @@ func (m *Metrics) Register(reg prometheus.Registerer) {
 	reg.MustRegister(m.NextValidatorStake)
 	reg.MustRegister(m.PrevEpochKickout)
 	reg.MustRegister(m.ProtocolVersion)
-	reg.MustRegister(m.SeatPriceDesc)
+	reg.MustRegister(m.SeatPrice)
 	reg.MustRegister(m.SyncingDesc)
 	reg.MustRegister(m.ValidatorExpectedBlocks)
 	reg.MustRegister(m.ValidatorExpectedChunks)

pkg/metrics/utils.go

@@ -1,8 +1,16 @@
 package metrics
 
+import "hash/fnv"
+
 func BoolToFloat64(b bool) float64 {
 	if b {
 		return 1
 	}
 	return 0
 }
+
+func StringToFloat64(s string) float64 {
+	h := fnv.New32a()
+	h.Write([]byte(s))
+	return float64(h.Sum32())
+}

pkg/metrics/utils_test.go

@@ -0,0 +1,16 @@
+package metrics
+
+import (
+	"testing"
+
+	"github.com/stretchr/testify/assert"
+)
+
+func TestBoolToFloat64(t *testing.T) {
+	assert.Equal(t, float64(1), BoolToFloat64(true))
+	assert.Equal(t, float64(0), BoolToFloat64(false))
+}
+
+func TestStringToFloat64(t *testing.T) {
+	assert.NotEqual(t, float64(0), StringToFloat64("foobar"))
+}

pkg/near/client.go

@@ -38,11 +38,25 @@ type Response struct {
 	} `json:"error"`
 }
 
-func NewClient(endpoint string, httpClient *http.Client) *Client {
-	return &Client{
+type Option func(*Client)
+
+func WithHTTPClient(httpClient *http.Client) Option {
+	return func(c *Client) {
+		c.httpClient = httpClient
+	}
+}
+
+func NewClient(endpoint string, options ...Option) *Client {
+	client := &Client{
 		Endpoint:   endpoint,
-		httpClient: httpClient,
+		httpClient: &http.Client{},
 	}
+
+	for _, option := range options {
+		option(client)
+	}
+
+	return client
 }
 
 func (c *Client) Request(ctx context.Context, method string, params interface{}) (*Response, error) {

pkg/near/testutils/server.go

@@ -0,0 +1,23 @@
+package testutils
+
+import (
+	"net/http"
+	"net/http/httptest"
+)
+
+type ExpectedResponse struct {
+	StatusCode int
+	Body       []byte
+}
+
+func (r *ExpectedResponse) ExpectResponse(statusCode int, body string) {
+	r.StatusCode = statusCode
+	r.Body = []byte(body)
+}
+
+func NewServer(resp *ExpectedResponse) *httptest.Server {
+	return httptest.NewServer(http.HandlerFunc(func(res http.ResponseWriter, req *http.Request) {
+		res.WriteHeader(resp.StatusCode)
+		res.Write(resp.Body)
+	}))
+}

pkg/watcher/utils.go

@@ -2,38 +2,9 @@ package watcher
 
 import (
 	"fmt"
-	"hash/fnv"
-	"strconv"
 	"strings"
 )
 
-func GetStakeFromString(s string) float64 {
-	if len(s) == 1 {
-		return 0
-	}
-	l := len(s) - 19 - 5
-	v, err := strconv.ParseFloat(s[0:l], 64)
-	if err != nil {
-		fmt.Println(err)
-	}
-	return float64(v)
-}
-
-func GetFloatFromString(s string) float64 {
-	v, err := strconv.ParseFloat(s, 64)
-	if err != nil {
-		fmt.Println(err)
-		return 0
-	}
-	return v
-}
-
-func HashString(s string) uint32 {
-	h := fnv.New32a()
-	h.Write([]byte(s))
-	return h.Sum32()
-}
-
 func prettyPrintFloat(f float64) string {
 	if f == float64(int(f)) {
 		return fmt.Sprintf("%.0f", f)

pkg/watcher/utils_test.go

@@ -0,0 +1,18 @@
+package watcher
+
+import (
+	"testing"
+
+	"github.com/stretchr/testify/assert"
+)
+
+func TestPrettyPrintFloat(t *testing.T) {
+	assert.Equal(t, "100", prettyPrintFloat(100))
+	assert.Equal(t, "99.42", prettyPrintFloat(99.42098176))
+}
+
+func TestPrettyPrintAccountID(t *testing.T) {
+	assert.Equal(t, "foo", prettyPrintAccountID("foo.poolv1.near"))
+	assert.Equal(t, "foo", prettyPrintAccountID("foo.pool.near"))
+	assert.Equal(t, "foo", prettyPrintAccountID("foo.pool.f863973.m0"))
+}