CIRC-9872: Fix tests and default timeouts (#97)

* CIRC-9872: Fix tests and default timeouts * CIRC-9694: Improve PromQLResponse data values
circonus-labs · Feb 24, 2023 · 9fb88eb · 9fb88eb
1 parent 8270a7d
commit 9fb88eb
Show file tree

Hide file tree

Showing 26 changed files with 136 additions and 101 deletions.
diff --git a/ChangeLog.md b/ChangeLog.md
@@ -6,6 +6,13 @@ to [Semantic Versioning](http://semver.org/) rules.
 
 ## [Next Release]
 
+## [v1.13.1] - 2023-02-23
+
+* upd: Modifies the PromQLResponse and PromQLError types to support more types
+of PromQL data values.
+* upd: Updates unit tests and examples to use NewClient().
+* upd: Ensures default values are set for snowth client timeouts.
+
 ## [v1.13.0] - 2023-02-23
 
 * fix: Corrects a bug that could cause snowth client creation to fail if a
@@ -453,6 +460,7 @@ writing to histogram endpoints.
 any delay, once started. Created: 2019-03-12. Fixed: 2019-03-13.
 
 [Next Release]: https://github.com/circonus-labs/gosnowth
+[v1.13.1]: https://github.com/circonus-labs/gosnowth/releases/tag/v1.13.1
 [v1.13.0]: https://github.com/circonus-labs/gosnowth/releases/tag/v1.13.0
 [v1.12.5]: https://github.com/circonus-labs/gosnowth/releases/tag/v1.12.5
 [v1.12.4]: https://github.com/circonus-labs/gosnowth/releases/tag/v1.12.4

diff --git a/activity_test.go b/activity_test.go
@@ -53,7 +53,8 @@ func TestRebuildActivity(t *testing.T) {
 
 	defer ms.Close()
 
-	sc, err := NewSnowthClient(false, ms.URL)
+	sc, err := NewClient(context.Background(),
+		&Config{Servers: []string{ms.URL}})
 	if err != nil {
 		t.Fatal("Unable to create snowth client", err)
 	}

diff --git a/caql_test.go b/caql_test.go
@@ -1,6 +1,7 @@
 package gosnowth
 
 import (
+	"context"
 	"io"
 	"net/http"
 	"net/http/httptest"
@@ -86,7 +87,8 @@ func TestGetCAQLQuery(t *testing.T) {
 
 	defer ms.Close()
 
-	sc, err := NewSnowthClient(false, ms.URL)
+	sc, err := NewClient(context.Background(),
+		&Config{Servers: []string{ms.URL}})
 	if err != nil {
 		t.Fatal("Unable to create snowth client", err)
 	}

diff --git a/client.go b/client.go
@@ -143,6 +143,14 @@ type SnowthClient struct {
 func NewClient(ctx context.Context, cfg *Config,
 	logs ...Logger,
 ) (*SnowthClient, error) {
+	if cfg.Timeout == 0 {
+		cfg.Timeout = time.Second * 10
+	}
+
+	if cfg.DialTimeout == 0 {
+		cfg.DialTimeout = time.Millisecond * 500
+	}
+
 	client := &http.Client{
 		Timeout: cfg.Timeout,
 		Transport: &http.Transport{

diff --git a/client_test.go b/client_test.go
@@ -34,18 +34,6 @@ func TestSnowthNode(t *testing.T) {
 	}
 }
 
-func TestNewSnowthClient(t *testing.T) {
-	t.Parallel()
-
-	// crude test to ensure err is returned for invalid snowth url
-	badAddr := "foobar"
-
-	_, err := NewSnowthClient(false, badAddr)
-	if err == nil {
-		t.Errorf("Error not encountered on invalid snowth addr %v", badAddr)
-	}
-}
-
 func TestNewClientTimeout(t *testing.T) {
 	t.Parallel()
 
@@ -59,7 +47,7 @@ func TestNewClientTimeout(t *testing.T) {
 		t.Error("Error expected for new client timeout test")
 	}
 
-	if !strings.Contains(err.Error(), "context deadline exceeded") {
+	if !strings.Contains(err.Error(), "no snowth nodes could be activated") {
 		t.Errorf("Expected context error, got: %v", err.Error())
 	}
 }
@@ -95,7 +83,8 @@ func TestSnowthClientRequest(t *testing.T) {
 
 	defer ms.Close()
 
-	sc, err := NewSnowthClient(false, ms.URL)
+	sc, err := NewClient(context.Background(),
+		&Config{Servers: []string{ms.URL}})
 	if err != nil {
 		t.Fatal("Unable to create snowth client", err)
 	}
@@ -195,7 +184,8 @@ func TestSnowthClientDiscoverNodesWatch(t *testing.T) {
 
 	defer ms.Close()
 
-	sc, err := NewSnowthClient(true, ms.URL)
+	sc, err := NewClient(context.Background(),
+		&Config{Servers: []string{ms.URL}})
 	if err != nil {
 		t.Fatal("Unable to create snowth client", err)
 	}
@@ -324,7 +314,8 @@ func TestSnowthClientLog(t *testing.T) {
 
 	defer ms.Close()
 
-	sc, err := NewSnowthClient(true, ms.URL)
+	sc, err := NewClient(context.Background(),
+		&Config{Servers: []string{ms.URL}})
 	if err != nil {
 		t.Fatal("Unable to create snowth client", err)
 	}

diff --git a/common_test.go b/common_test.go
@@ -3,7 +3,6 @@ package gosnowth
 import (
 	"bytes"
 	"encoding/xml"
-	"fmt"
 	"io"
 	"net/http"
 	"net/url"
@@ -43,27 +42,6 @@ func TestResolveURL(t *testing.T) {
 	}
 }
 
-func TestMultiError(t *testing.T) {
-	t.Parallel()
-
-	me := newMultiError()
-	if me.HasError() {
-		t.Error("Should have no errors yet")
-	}
-
-	me.Add(fmt.Errorf("error 1"))
-	me.Add(fmt.Errorf("error 2"))
-	me.Add(nil)
-
-	if !me.HasError() {
-		t.Error("Should have errors")
-	}
-
-	if res, exp := me.Error(), "error 1; error 2"; res != exp {
-		t.Errorf("Expected result: %v, got: %v", exp, res)
-	}
-}
-
 func TestDecodeJSON(t *testing.T) {
 	t.Parallel()
 

diff --git a/examples/retrieval.go b/examples/retrieval.go
@@ -15,7 +15,6 @@ import (
 func ExampleReadNNT() {
 	// Create a new client.
 	cfg := gosnowth.NewConfig(SnowthServers...)
-	cfg.Discover = true
 
 	client, err := gosnowth.NewClient(context.Background(), cfg)
 	if err != nil {
@@ -61,7 +60,6 @@ func ExampleReadNNT() {
 func ExampleReadText() {
 	// Create a new client.
 	cfg := gosnowth.NewConfig(SnowthServers...)
-	cfg.Discover = true
 
 	client, err := gosnowth.NewClient(context.Background(), cfg)
 	if err != nil {
@@ -94,7 +92,8 @@ func ExampleFetchQuery() {
 		return
 	}
 
-	sc, err := gosnowth.NewSnowthClient(false, host)
+	sc, err := gosnowth.NewClient(context.Background(),
+		&gosnowth.Config{Servers: []string{host}})
 	if err != nil {
 		log.Fatal("Unable to create snowth client", err)
 	}
@@ -144,7 +143,8 @@ func ExampleFetchQueryMultiStream() {
 		return
 	}
 
-	sc, err := gosnowth.NewSnowthClient(false, host)
+	sc, err := gosnowth.NewClient(context.Background(),
+		&gosnowth.Config{Servers: []string{host}})
 	if err != nil {
 		log.Fatal("Unable to create snowth client", err)
 	}
@@ -182,7 +182,8 @@ func ExampleCAQLQuery() {
 		return
 	}
 
-	sc, err := gosnowth.NewSnowthClient(false, host)
+	sc, err := gosnowth.NewClient(context.Background(),
+		&gosnowth.Config{Servers: []string{host}})
 	if err != nil {
 		log.Fatal("Unable to create snowth client", err)
 	}
@@ -216,7 +217,8 @@ func ExampleGetCheckTags() {
 		return
 	}
 
-	sc, err := gosnowth.NewSnowthClient(false, host)
+	sc, err := gosnowth.NewClient(context.Background(),
+		&gosnowth.Config{Servers: []string{host}})
 	if err != nil {
 		log.Fatal("Unable to create snowth client", err)
 	}

diff --git a/examples/state.go b/examples/state.go
@@ -12,7 +12,6 @@ import (
 func ExampleGetNodeState() {
 	// Create a new client.
 	cfg := gosnowth.NewConfig(SnowthServers...)
-	cfg.Discover = true
 
 	client, err := gosnowth.NewClient(context.Background(), cfg)
 	if err != nil {
@@ -34,7 +33,6 @@ func ExampleGetNodeState() {
 func ExampleGetNodeGossip() {
 	// Create a new client.
 	cfg := gosnowth.NewConfig(SnowthServers...)
-	cfg.Discover = true
 
 	client, err := gosnowth.NewClient(context.Background(), cfg)
 	if err != nil {
@@ -56,7 +54,6 @@ func ExampleGetNodeGossip() {
 func ExampleGetTopology() {
 	// Create a new client.
 	cfg := gosnowth.NewConfig(SnowthServers...)
-	cfg.Discover = true
 
 	client, err := gosnowth.NewClient(context.Background(), cfg)
 	if err != nil {

diff --git a/examples/submission.go b/examples/submission.go
@@ -19,7 +19,6 @@ import (
 func ExampleSubmitText() {
 	// Create a new client.
 	cfg := gosnowth.NewConfig(SnowthServers...)
-	cfg.Discover = true
 
 	client, err := gosnowth.NewClient(context.Background(), cfg)
 	if err != nil {
@@ -43,7 +42,6 @@ func ExampleSubmitText() {
 func ExampleSubmitNNT() {
 	// Create a new client.
 	cfg := gosnowth.NewConfig(SnowthServers...)
-	cfg.Discover = true
 
 	client, err := gosnowth.NewClient(context.Background(), cfg)
 	if err != nil {
@@ -76,7 +74,6 @@ func ExampleSubmitNNT() {
 func ExampleSubmitHistogram() {
 	// Create a new client.
 	cfg := gosnowth.NewConfig(SnowthServers...)
-	cfg.Discover = true
 
 	client, err := gosnowth.NewClient(context.Background(), cfg)
 	if err != nil {
@@ -113,7 +110,8 @@ func ExampleWriteRawMetricList(b *testing.B) {
 		return
 	}
 
-	sc, err := gosnowth.NewSnowthClient(false, host)
+	sc, err := gosnowth.NewClient(context.Background(),
+		&gosnowth.Config{Servers: []string{host}})
 	if err != nil {
 		log.Fatal("Unable to create snowth client", err)
 	}
@@ -160,7 +158,8 @@ func ExampleBulkWriteRawMetricList(b *testing.B) {
 		return
 	}
 
-	sc, err := gosnowth.NewSnowthClient(false, host)
+	sc, err := gosnowth.NewClient(context.Background(),
+		&gosnowth.Config{Servers: []string{host}})
 	if err != nil {
 		log.Fatal("Unable to create snowth client", err)
 	}

diff --git a/fetch_test.go b/fetch_test.go
@@ -2,6 +2,7 @@ package gosnowth
 
 import (
 	"bytes"
+	"context"
 	"encoding/json"
 	"net/http"
 	"net/http/httptest"
@@ -115,7 +116,8 @@ func TestFetchQuery(t *testing.T) {
 
 	defer ms.Close()
 
-	sc, err := NewSnowthClient(false, ms.URL)
+	sc, err := NewClient(context.Background(),
+		&Config{Servers: []string{ms.URL}})
 	if err != nil {
 		t.Fatal("Unable to create snowth client", err)
 	}

diff --git a/gossip_test.go b/gossip_test.go
@@ -160,7 +160,8 @@ func TestGetGossipInfo(t *testing.T) {
 
 	defer ms.Close()
 
-	sc, err := NewSnowthClient(false, ms.URL)
+	sc, err := NewClient(context.Background(),
+		&Config{Servers: []string{ms.URL}})
 	if err != nil {
 		t.Fatal("Unable to create snowth client", err)
 	}

diff --git a/graphite_test.go b/graphite_test.go
@@ -1,6 +1,7 @@
 package gosnowth
 
 import (
+	"context"
 	"net/http"
 	"net/http/httptest"
 	"net/url"
@@ -62,7 +63,8 @@ func TestGraphiteFindMetrics(t *testing.T) {
 
 	defer ms.Close()
 
-	sc, err := NewSnowthClient(false, ms.URL)
+	sc, err := NewClient(context.Background(),
+		&Config{Servers: []string{ms.URL}})
 	if err != nil {
 		t.Fatal("Unable to create snowth client", err)
 	}
@@ -118,7 +120,8 @@ func TestGraphiteFindTags(t *testing.T) {
 
 	defer ms.Close()
 
-	sc, err := NewSnowthClient(false, ms.URL)
+	sc, err := NewClient(context.Background(),
+		&Config{Servers: []string{ms.URL}})
 	if err != nil {
 		t.Fatal("Unable to create snowth client", err)
 	}
@@ -174,7 +177,8 @@ func TestGraphiteGetDatapoints(t *testing.T) {
 
 	defer ms.Close()
 
-	sc, err := NewSnowthClient(false, ms.URL)
+	sc, err := NewClient(context.Background(),
+		&Config{Servers: []string{ms.URL}})
 	if err != nil {
 		t.Fatal("Unable to create snowth client", err)
 	}

diff --git a/histogram_test.go b/histogram_test.go
@@ -2,6 +2,7 @@ package gosnowth
 
 import (
 	"bytes"
+	"context"
 	"encoding/json"
 	"net/http"
 	"net/http/httptest"
@@ -112,7 +113,8 @@ func TestReadHistogramValues(t *testing.T) {
 
 	defer ms.Close()
 
-	sc, err := NewSnowthClient(false, ms.URL)
+	sc, err := NewClient(context.Background(),
+		&Config{Servers: []string{ms.URL}})
 	if err != nil {
 		t.Fatal("Unable to create snowth client", err)
 	}
@@ -199,7 +201,8 @@ func TestWriteHistogram(t *testing.T) {
 
 	defer ms.Close()
 
-	sc, err := NewSnowthClient(false, ms.URL)
+	sc, err := NewClient(context.Background(),
+		&Config{Servers: []string{ms.URL}})
 	if err != nil {
 		t.Fatal("Unable to create snowth client", err)
 	}