Added tests for TLS

Author: thrawn01

Makefile

@@ -1,17 +1,20 @@
 GOLANGCI_LINT = $(GOPATH)/bin/golangci-lint
-GOLANGCI_LINT_VERSION = 1.56.2
+GOLANGCI_LINT_VERSION = v1.61.0
 
 $(GOLANGCI_LINT): ## Download Go linter
 	curl -sfL https://raw.githubusercontent.com/golangci/golangci-lint/master/install.sh | sh -s -- -b $(GOPATH)/bin $(GOLANGCI_LINT_VERSION)
 
-.PHONY: validate
-validate: lint test
+.PHONY: ci
+ci: tidy lint test
 	go mod tidy && git diff --exit-code
 
 .PHONY: lint
 lint: $(GOLANGCI_LINT) ## Run Go linter
 	$(GOLANGCI_LINT) run -v ./...
-	#$(GOLANGCI_LINT) run -v -c .golangci.yml ./...
+
+.PHONY: tidy
+tidy:
+	go mod tidy && git diff --exit-code
 
 .PHONY: test
 test:

cluster/cluster_test.go

@@ -33,8 +33,7 @@ func TestStartMultipleInstances(t *testing.T) {
 
 	assert.Equal(t, 2, len(cluster.ListPeers()))
 	assert.Equal(t, 2, len(cluster.ListDaemons()))
-	err = cluster.Shutdown(context.Background())
-	require.NoError(t, err)
+	require.NoError(t, cluster.Shutdown(context.Background()))
 }
 
 func TestRestart(t *testing.T) {
@@ -45,8 +44,7 @@ func TestRestart(t *testing.T) {
 	assert.Equal(t, 2, len(cluster.ListDaemons()))
 	err = cluster.Restart(context.Background())
 	require.NoError(t, err)
-	err = cluster.Shutdown(context.Background())
-	require.NoError(t, err)
+	require.NoError(t, cluster.Shutdown(context.Background()))
 }
 
 func TestStartOneInstance(t *testing.T) {
@@ -55,8 +53,7 @@ func TestStartOneInstance(t *testing.T) {
 
 	assert.Equal(t, 1, len(cluster.ListPeers()))
 	assert.Equal(t, 1, len(cluster.ListDaemons()))
-	err = cluster.Shutdown(context.Background())
-	require.NoError(t, err)
+	require.NoError(t, cluster.Shutdown(context.Background()))
 }
 
 func TestStartMultipleDaemons(t *testing.T) {
@@ -74,13 +71,13 @@ func TestStartMultipleDaemons(t *testing.T) {
 	assert.Contains(t, daemons[1].ListenAddress(), ":2222")
 	assert.Contains(t, cluster.DaemonAt(0).ListenAddress(), ":1111")
 	assert.Contains(t, cluster.DaemonAt(1).ListenAddress(), ":2222")
-	err = cluster.Shutdown(context.Background())
-	require.NoError(t, err)
+	require.NoError(t, cluster.Shutdown(context.Background()))
 }
 
 func TestStartWithInvalidPeer(t *testing.T) {
 	err := cluster.StartWith(context.Background(), []peer.Info{{Address: "1111"}}, groupcache.Options{})
 	assert.Error(t, err)
 	assert.Nil(t, cluster.ListPeers())
 	assert.Nil(t, cluster.ListDaemons())
+	require.NoError(t, cluster.Shutdown(context.Background()))
 }

cmd/server/main.go

@@ -62,7 +62,7 @@ func main() {
 	defer cancel()
 	err := i.SetPeers(ctx, peers)
 	if err != nil {
-		log.Fatalf(err.Error())
+		log.Fatal(err.Error())
 	}
 
 	group, err := i.NewGroup("cache1", 64<<20, groupcache.GetterFunc(
@@ -81,7 +81,7 @@ func main() {
 		},
 	))
 	if err != nil {
-		log.Fatalf(err.Error())
+		log.Fatal(err.Error())
 	}
 
 	mux := http.NewServeMux()

go.mod

@@ -1,11 +1,14 @@
 module github.com/groupcache/groupcache-go/v3
 
-go 1.21
+go 1.21.7
+
+toolchain go1.23.1
 
 require (
+	github.com/kapetan-io/tackle v0.10.0
 	github.com/maypok86/otter v1.2.0
 	github.com/segmentio/fasthash v1.0.3
-	github.com/stretchr/testify v1.8.1
+	github.com/stretchr/testify v1.9.0
 	golang.org/x/net v0.22.0
 	google.golang.org/protobuf v1.28.1
 )

go.sum

@@ -1,4 +1,3 @@
-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/dolthub/maphash v0.1.0 h1:bsQ7JsF4FkkWyrP3oCnFJgrCUAFbFf3kOl4L/QxPDyQ=
@@ -8,19 +7,16 @@ github.com/gammazero/deque v0.2.1/go.mod h1:LFroj8x4cMYCukHJDbxFCkT+r9AndaJnFMuZ
 github.com/golang/protobuf v1.5.0/go.mod h1:FsONVRAS9T7sI+LIUmWTfcYkHO4aIWwzhcaSAoJOfIk=
 github.com/google/go-cmp v0.5.5 h1:Khx7svrCpmxxtHBq5j2mp/xVjsi8hQMfNLvJFAlrGgU=
 github.com/google/go-cmp v0.5.5/go.mod h1:v8dTdLbMG2kIc/vJvl+f65V22dbkXbowE6jgT/gNBxE=
+github.com/kapetan-io/tackle v0.10.0 h1:EsNnlIYE8eoGxZhNyI1m91cDGGVDNsOru25V811MS00=
+github.com/kapetan-io/tackle v0.10.0/go.mod h1:E7MpdJUog4MvyKkWtQyX8UjFe5tL4SHQ44ZGk+zDBM8=
 github.com/maypok86/otter v1.2.0 h1:djwBBNpp9+dyzBTY0zscIG+pyAQVXRRRMbzztf8iJ4U=
 github.com/maypok86/otter v1.2.0/go.mod h1:mKLfoI7v1HOmQMwFgX4QkRk23mX6ge3RDvjdHOWG4R4=
 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/segmentio/fasthash v1.0.3 h1:EI9+KE1EwvMLBWwjpRDc+fEM+prwxDYbslddQGtrmhM=
 github.com/segmentio/fasthash v1.0.3/go.mod h1:waKX8l2N8yckOgmSsXJi7x1ZfdKZ4x7KRMzBtS3oedY=
-github.com/stretchr/objx v0.1.0/go.mod h1:HFkY916IF+rwdDfMAkV7OtwuqBVzrE8GR6GFx+wExME=
-github.com/stretchr/objx v0.4.0/go.mod h1:YvHI0jy2hoMjB+UWwv71VJQ9isScKT/TqJzVSSt89Yw=
-github.com/stretchr/objx v0.5.0/go.mod h1:Yh+to48EsGEfYuaHDzXPcE3xhTkx73EhmCGUpEOglKo=
-github.com/stretchr/testify v1.7.1/go.mod h1:6Fq8oRcR53rry900zMqJjRRixrwX3KX962/h/Wwjteg=
-github.com/stretchr/testify v1.8.0/go.mod h1:yNjHg4UonilssWZ8iaSj1OCr/vHnekPRkoO+kdMU+MU=
-github.com/stretchr/testify v1.8.1 h1:w7B6lhMri9wdJUVmEZPGGhZzrYTPvgJArz7wNPgYKsk=
-github.com/stretchr/testify v1.8.1/go.mod h1:w2LPCIKwWwSfY2zedu0+kehJoqGctiVI29o6fzry7u4=
+github.com/stretchr/testify v1.9.0 h1:HtqpIVDClZ4nwg75+f6Lvsy/wHu+3BoSGCbBAcpTsTg=
+github.com/stretchr/testify v1.9.0/go.mod h1:r2ic/lqez/lEtzL7wO/rwa5dbSLXVDPFyf8C91i36aY=
 golang.org/x/net v0.22.0 h1:9sGLhx7iRIHEiX0oAJ3MRZMUCElJgy7Br1nO+AMN3Tc=
 golang.org/x/net v0.22.0/go.mod h1:JKghWKKOSdJwpW2GEx0Ja7fmaKnMsbu+MWVZTokSYmg=
 golang.org/x/xerrors v0.0.0-20191204190536-9bdfabe68543/go.mod h1:I/5z698sn9Ka8TeJc9MKroUUfqBBauWjQqLJ2OPfmY0=
@@ -31,6 +27,5 @@ google.golang.org/protobuf v1.28.1 h1:d0NfwRgPtno5B1Wa6L2DAG+KivqkdutMf1UhdNx175
 google.golang.org/protobuf v1.28.1/go.mod h1:HV8QOd/L58Z+nl8r43ehVNZIU/HEI6OcFqwMG9pJV4I=
 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.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=

transport/http_transport_test.go

@@ -57,19 +57,17 @@ func TestHttpTransport(t *testing.T) {
 			Logger: slog.New(slog.NewTextHandler(io.Discard, nil)),
 		}),
 	}))
+	defer func() { _ = cluster.Shutdown(context.Background()) }()
 
-	newGetter := func(idx int) groupcache.Getter {
-		return groupcache.GetterFunc(func(ctx context.Context, key string, dest transport.Sink) error {
-			if _, err := http.Get(ts.URL); err != nil {
-				t.Logf("HTTP request from getter failed with '%s'", err)
-			}
-			return dest.SetString(strconv.Itoa(idx)+":"+key, time.Time{})
-		})
-	}
-
-	// Create a group for each instance in the cluster
+	// Create a group on each instance in the cluster
 	for idx, d := range cluster.ListDaemons() {
-		_, err := d.GetInstance().NewGroup(groupName, 1<<20, newGetter(idx))
+		_, err := d.GetInstance().NewGroup(groupName, 1<<20,
+			groupcache.GetterFunc(func(ctx context.Context, key string, dest transport.Sink) error {
+				if _, err := http.Get(ts.URL); err != nil {
+					t.Logf("HTTP request from getter failed with '%s'", err)
+				}
+				return dest.SetString(strconv.Itoa(idx)+":"+key, time.Time{})
+			}))
 		require.NoError(t, err)
 	}
 

transport/tls_test.go

@@ -0,0 +1,94 @@
+package transport_test
+
+import (
+	"context"
+	"fmt"
+	"github.com/groupcache/groupcache-go/v3"
+	"github.com/groupcache/groupcache-go/v3/cluster"
+	"github.com/groupcache/groupcache-go/v3/transport"
+	"github.com/groupcache/groupcache-go/v3/transport/pb"
+	"github.com/kapetan-io/tackle/autotls"
+	"github.com/stretchr/testify/assert"
+	"github.com/stretchr/testify/require"
+	"io"
+	"log/slog"
+	"net/http"
+	"net/http/httptest"
+	"strconv"
+	"strings"
+	"testing"
+	"time"
+)
+
+func TestTLS(t *testing.T) {
+	ctx, cancel := context.WithTimeout(context.Background(), time.Second*30)
+	defer cancel()
+
+	// AutoGenerate TLS certs
+	conf := autotls.Config{AutoTLS: true}
+	require.NoError(t, autotls.Setup(&conf))
+
+	// Start a 2 node cluster with TLS
+	err := cluster.Start(context.Background(), 2,
+		groupcache.Options{
+			Transport: transport.NewHttpTransport(transport.HttpTransportOptions{
+				TLSConfig: conf.ServerTLS,
+				Client: &http.Client{
+					Transport: &http.Transport{
+						TLSClientConfig: conf.ClientTLS,
+					},
+				},
+			}),
+			Logger: slog.New(slog.NewTextHandler(io.Discard, nil)),
+		})
+	require.NoError(t, err)
+
+	assert.Equal(t, 2, len(cluster.ListPeers()))
+	assert.Equal(t, 2, len(cluster.ListDaemons()))
+
+	// Start a http server to count the number of non cached hits
+	var serverHits int
+	ts := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
+		_, _ = fmt.Fprintln(w, "Hello")
+		serverHits++
+	}))
+	defer ts.Close()
+
+	// Create a group on each instance in the cluster
+	for idx, d := range cluster.ListDaemons() {
+		_, err := d.GetInstance().NewGroup(groupName, 1<<20,
+			groupcache.GetterFunc(func(ctx context.Context, key string, dest transport.Sink) error {
+				if _, err := http.Get(ts.URL); err != nil {
+					t.Logf("HTTP request from getter failed with '%s'", err)
+				}
+				return dest.SetString(strconv.Itoa(idx)+":"+key, time.Time{})
+			}))
+		require.NoError(t, err)
+	}
+
+	// Create new transport with the client TLS config
+	tr := transport.NewHttpTransport(transport.HttpTransportOptions{
+		TLSConfig: conf.ServerTLS,
+		Client: &http.Client{
+			Transport: &http.Transport{
+				TLSClientConfig: conf.ClientTLS,
+			},
+		},
+	})
+
+	// Create a new client to the first peer in the cluster
+	c, err := tr.NewClient(ctx, cluster.PeerAt(0))
+	require.NoError(t, err)
+
+	// Each new key should result in a new hit to the test server
+	for _, key := range testKeys(100) {
+		var resp pb.GetResponse
+		require.NoError(t, getRequest(ctx, c, groupName, key, &resp))
+
+		// The value should be in the format `instance:key`
+		assert.True(t, strings.HasSuffix(string(resp.Value), ":"+key))
+	}
+	assert.Equal(t, 100, serverHits)
+
+	require.NoError(t, cluster.Shutdown(context.Background()))
+}