Files
nats.go/test/conn_test.go
Piotr Piotrowski 94fa0cb994 Deprecate encoded connections (#1674)
Signed-off-by: Piotr Piotrowski <piotr@synadia.com>
2024-07-23 16:46:25 +02:00

3148 lines
81 KiB
Go

// Copyright 2012-2023 The NATS Authors
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
package test
import (
"bufio"
"bytes"
"crypto/tls"
"crypto/x509"
"errors"
"fmt"
"net"
"os"
"path/filepath"
"runtime"
"strconv"
"strings"
"sync"
"sync/atomic"
"testing"
"time"
"github.com/nats-io/nats-server/v2/server"
"github.com/nats-io/nats-server/v2/test"
"github.com/nats-io/nats.go"
)
func TestDefaultConnection(t *testing.T) {
s := RunDefaultServer()
defer s.Shutdown()
nc := NewDefaultConnection(t)
nc.Close()
}
func TestConnectionStatus(t *testing.T) {
s := RunDefaultServer()
defer s.Shutdown()
nc := NewDefaultConnection(t)
defer nc.Close()
if nc.Status() != nats.CONNECTED || nc.Status().String() != "CONNECTED" {
t.Fatal("Should have status set to CONNECTED")
}
if !nc.IsConnected() {
t.Fatal("Should have status set to CONNECTED")
}
nc.Close()
if nc.Status() != nats.CLOSED || nc.Status().String() != "CLOSED" {
t.Fatal("Should have status set to CLOSED")
}
if !nc.IsClosed() {
t.Fatal("Should have status set to CLOSED")
}
}
func TestConnClosedCB(t *testing.T) {
s := RunDefaultServer()
defer s.Shutdown()
ch := make(chan bool)
o := nats.GetDefaultOptions()
o.Url = nats.DefaultURL
o.ClosedCB = func(_ *nats.Conn) {
ch <- true
}
nc, err := o.Connect()
if err != nil {
t.Fatalf("Should have connected ok: %v", err)
}
nc.Close()
if e := Wait(ch); e != nil {
t.Fatalf("Closed callback not triggered\n")
}
}
func TestCloseDisconnectedErrCB(t *testing.T) {
s := RunDefaultServer()
defer s.Shutdown()
ch := make(chan bool)
o := nats.GetDefaultOptions()
o.Url = nats.DefaultURL
o.AllowReconnect = false
o.DisconnectedErrCB = func(_ *nats.Conn, _ error) {
ch <- true
}
nc, err := o.Connect()
if err != nil {
t.Fatalf("Should have connected ok: %v", err)
}
nc.Close()
if e := Wait(ch); e != nil {
t.Fatal("Disconnected callback not triggered")
}
}
func TestServerStopDisconnectedErrCB(t *testing.T) {
s := RunDefaultServer()
defer s.Shutdown()
ch := make(chan bool)
o := nats.GetDefaultOptions()
o.Url = nats.DefaultURL
o.AllowReconnect = false
o.DisconnectedErrCB = func(nc *nats.Conn, _ error) {
ch <- true
}
nc, err := o.Connect()
if err != nil {
t.Fatalf("Should have connected ok: %v", err)
}
defer nc.Close()
s.Shutdown()
if e := Wait(ch); e != nil {
t.Fatalf("Disconnected callback not triggered\n")
}
}
func TestServerSecureConnections(t *testing.T) {
s, opts := RunServerWithConfig("./configs/tls.conf")
defer s.Shutdown()
endpoint := fmt.Sprintf("%s:%d", opts.Host, opts.Port)
secureURL := fmt.Sprintf("nats://%s:%s@%s/", opts.Username, opts.Password, endpoint)
// Make sure this succeeds
nc, err := nats.Connect(secureURL, nats.Secure(), nats.RootCAs("./configs/certs/ca.pem"))
if err != nil {
t.Fatalf("Failed to create secure (TLS) connection: %v", err)
}
defer nc.Close()
omsg := []byte("Hello World")
checkRecv := make(chan bool)
received := 0
nc.Subscribe("foo", func(m *nats.Msg) {
received++
if !bytes.Equal(m.Data, omsg) {
t.Fatal("Message received does not match")
}
checkRecv <- true
})
err = nc.Publish("foo", omsg)
if err != nil {
t.Fatalf("Failed to publish on secure (TLS) connection: %v", err)
}
nc.Flush()
state, err := nc.TLSConnectionState()
if err != nil {
t.Fatalf("Expected connection state: %v", err)
}
if !state.HandshakeComplete {
t.Fatalf("Expected valid connection state")
}
if err := Wait(checkRecv); err != nil {
t.Fatal("Failed receiving message")
}
nc.Close()
// Server required, but not specified in Connect(), should switch automatically
nc, err = nats.Connect(secureURL, nats.RootCAs("./configs/certs/ca.pem"))
if err != nil {
t.Fatalf("Failed to create secure (TLS) connection: %v", err)
}
nc.Close()
// Test flag mismatch
// Wanted but not available..
ds := RunDefaultServer()
defer ds.Shutdown()
nc, err = nats.Connect(nats.DefaultURL, nats.Secure(), nats.RootCAs("./configs/certs/ca.pem"))
if err == nil || nc != nil || err != nats.ErrSecureConnWanted {
if nc != nil {
nc.Close()
}
t.Fatalf("Should have failed to create connection: %v", err)
}
// Let's be more TLS correct and verify servername, endpoint etc.
// Now do more advanced checking, verifying servername and using rootCA.
// Setup our own TLSConfig using RootCA from our self signed cert.
rootPEM, err := os.ReadFile("./configs/certs/ca.pem")
if err != nil || rootPEM == nil {
t.Fatalf("failed to read root certificate")
}
pool := x509.NewCertPool()
ok := pool.AppendCertsFromPEM([]byte(rootPEM))
if !ok {
t.Fatal("failed to parse root certificate")
}
tls1 := &tls.Config{
ServerName: opts.Host,
RootCAs: pool,
MinVersion: tls.VersionTLS12,
}
nc, err = nats.Connect(secureURL, nats.Secure(tls1), nats.RootCAs("./configs/certs/ca.pem"))
if err != nil {
t.Fatalf("Got an error on Connect with Secure Options: %+v\n", err)
}
defer nc.Close()
tls2 := &tls.Config{
ServerName: "OtherHostName",
RootCAs: pool,
MinVersion: tls.VersionTLS12,
}
nc2, err := nats.Connect(secureURL, nats.Secure(tls1, tls2))
if err == nil {
nc2.Close()
t.Fatal("Was expecting an error!")
}
}
func TestClientTLSConfig(t *testing.T) {
s, opts := RunServerWithConfig("./configs/tlsverify.conf")
defer s.Shutdown()
endpoint := fmt.Sprintf("%s:%d", opts.Host, opts.Port)
secureURL := fmt.Sprintf("nats://%s", endpoint)
// Make sure this fails
nc, err := nats.Connect(secureURL, nats.Secure())
if err == nil {
nc.Close()
t.Fatal("Should have failed (TLS) connection without client certificate")
}
cert, err := os.ReadFile("./configs/certs/client-cert.pem")
if err != nil {
t.Fatal("Failed to read client certificate")
}
key, err := os.ReadFile("./configs/certs/client-key.pem")
if err != nil {
t.Fatal("Failed to read client key")
}
rootCAs, err := os.ReadFile("./configs/certs/ca.pem")
if err != nil {
t.Fatal("Failed to read root CAs")
}
certCB := func() (tls.Certificate, error) {
cert, err := tls.X509KeyPair(cert, key)
if err != nil {
return tls.Certificate{}, fmt.Errorf("nats: error loading client certificate: %w", err)
}
cert.Leaf, err = x509.ParseCertificate(cert.Certificate[0])
if err != nil {
return tls.Certificate{}, fmt.Errorf("nats: error parsing client certificate: %w", err)
}
return cert, nil
}
caCB := func() (*x509.CertPool, error) {
pool := x509.NewCertPool()
ok := pool.AppendCertsFromPEM(rootCAs)
if !ok {
return nil, fmt.Errorf("nats: failed to parse root certificate from")
}
return pool, nil
}
// Check parameters validity
_, err = nats.Connect(secureURL, nats.ClientTLSConfig(nil, nil))
if !errors.Is(err, nats.ErrClientCertOrRootCAsRequired) {
t.Fatalf("Expected error %q, got %q", nats.ErrClientCertOrRootCAsRequired, err)
}
certErr := &tls.CertificateVerificationError{}
// Should fail because of missing CA
_, err = nats.Connect(secureURL,
nats.ClientCert("./configs/certs/client-cert.pem", "./configs/certs/client-key.pem"))
if ok := errors.As(err, &certErr); !ok {
t.Fatalf("Expected error %q, got %q", nats.ErrClientCertOrRootCAsRequired, err)
}
// Should fail because of missing certificate
_, err = nats.Connect(secureURL,
nats.ClientTLSConfig(nil, caCB))
if !strings.Contains(err.Error(), "bad certificate") && !strings.Contains(err.Error(), "certificate required") {
t.Fatalf("Expected missing certificate error; got: %s", err)
}
nc, err = nats.Connect(secureURL,
nats.ClientTLSConfig(certCB, caCB))
if err != nil {
t.Fatalf("Failed to create (TLS) connection: %v", err)
}
defer nc.Close()
omsg := []byte("Hello!")
checkRecv := make(chan bool)
received := 0
nc.Subscribe("foo", func(m *nats.Msg) {
received++
if !bytes.Equal(m.Data, omsg) {
t.Fatal("Message received does not match")
}
checkRecv <- true
})
err = nc.Publish("foo", omsg)
if err != nil {
t.Fatalf("Failed to publish on secure (TLS) connection: %v", err)
}
nc.Flush()
if err := Wait(checkRecv); err != nil {
t.Fatal("Failed to receive message")
}
}
func TestClientCertificate(t *testing.T) {
s, opts := RunServerWithConfig("./configs/tlsverify.conf")
defer s.Shutdown()
endpoint := fmt.Sprintf("%s:%d", opts.Host, opts.Port)
secureURL := fmt.Sprintf("nats://%s", endpoint)
// Make sure this fails
nc, err := nats.Connect(secureURL, nats.Secure())
if err == nil {
nc.Close()
t.Fatal("Should have failed (TLS) connection without client certificate")
}
// Check parameters validity
nc, err = nats.Connect(secureURL, nats.ClientCert("", ""))
if err == nil {
nc.Close()
t.Fatal("Should have failed due to invalid parameters")
}
// Should fail because wrong key
nc, err = nats.Connect(secureURL,
nats.ClientCert("./configs/certs/client-cert.pem", "./configs/certs/key.pem"))
if err == nil {
nc.Close()
t.Fatal("Should have failed due to invalid key")
}
// Should fail because no CA
nc, err = nats.Connect(secureURL,
nats.ClientCert("./configs/certs/client-cert.pem", "./configs/certs/client-key.pem"))
if err == nil {
nc.Close()
t.Fatal("Should have failed due to missing ca")
}
nc, err = nats.Connect(secureURL,
nats.RootCAs("./configs/certs/ca.pem"),
nats.ClientCert("./configs/certs/client-cert.pem", "./configs/certs/client-key.pem"))
if err != nil {
t.Fatalf("Failed to create (TLS) connection: %v", err)
}
defer nc.Close()
omsg := []byte("Hello!")
checkRecv := make(chan bool)
received := 0
nc.Subscribe("foo", func(m *nats.Msg) {
received++
if !bytes.Equal(m.Data, omsg) {
t.Fatal("Message received does not match")
}
checkRecv <- true
})
err = nc.Publish("foo", omsg)
if err != nil {
t.Fatalf("Failed to publish on secure (TLS) connection: %v", err)
}
nc.Flush()
if err := Wait(checkRecv); err != nil {
t.Fatal("Failed to receive message")
}
}
func TestClientCertificateReloadOnServerRestart(t *testing.T) {
copyFiles := func(t *testing.T, cpFiles map[string]string) {
for from, to := range cpFiles {
content, err := os.ReadFile(from)
if err != nil {
t.Fatalf("Error reading file: %s", err)
}
if err := os.WriteFile(to, content, 0640); err != nil {
t.Fatalf("Error writing file: %s", err)
}
}
}
s, opts := RunServerWithConfig("./configs/tlsverify.conf")
defer s.Shutdown()
endpoint := fmt.Sprintf("%s:%d", opts.Host, opts.Port)
secureURL := fmt.Sprintf("nats://%s", endpoint)
tmpCertDir := t.TempDir()
certFile := filepath.Join(tmpCertDir, "client-cert.pem")
keyFile := filepath.Join(tmpCertDir, "client-key.pem")
caFile := filepath.Join(tmpCertDir, "ca.pem")
// copy valid cert files to tmp dir
filesToCopy := map[string]string{
"./configs/certs/client-cert.pem": certFile,
"./configs/certs/client-key.pem": keyFile,
"./configs/certs/ca.pem": caFile,
}
copyFiles(t, filesToCopy)
dcChan, rcChan, errChan := make(chan bool, 1), make(chan bool, 1), make(chan error, 1)
nc, err := nats.Connect(secureURL,
nats.RootCAs(caFile),
nats.ClientCert(certFile, keyFile),
nats.ReconnectWait(100*time.Millisecond),
nats.ErrorHandler(func(_ *nats.Conn, _ *nats.Subscription, err error) {
errChan <- err
}),
nats.DisconnectErrHandler(func(_ *nats.Conn, _ error) {
dcChan <- true
}),
nats.ReconnectHandler(func(_ *nats.Conn) {
rcChan <- true
}),
)
if err != nil {
t.Fatalf("Failed to create (TLS) connection: %v", err)
}
defer nc.Close()
// overwrite client certificate files with invalid ones, those
// should be loaded on server restart
filesToCopy = map[string]string{
"./configs/certs/client-cert-invalid.pem": certFile,
"./configs/certs/client-key-invalid.pem": keyFile,
}
copyFiles(t, filesToCopy)
// restart server
s.Shutdown()
s, _ = RunServerWithConfig("./configs/tlsverify.conf")
defer s.Shutdown()
// wait for disconnected signal
if err := Wait(dcChan); err != nil {
t.Fatal("Failed to receive disconnect signal")
}
// wait for reconnection error (bad certificate)
select {
case err := <-errChan:
if !strings.Contains(err.Error(), "bad certificate") && !strings.Contains(err.Error(), "certificate required") {
t.Fatalf("Expected bad certificate error; got: %s", err)
}
case <-time.After(5 * time.Second):
t.Fatalf("Timeout waiting for reconnect error")
}
// overwrite cert files with valid ones again,
// so that subsequent reconnect attempt should succeed
// when cert files are reloaded
filesToCopy = map[string]string{
"./configs/certs/client-cert.pem": certFile,
"./configs/certs/client-key.pem": keyFile,
}
copyFiles(t, filesToCopy)
// wait for reconnect signal
if err := Wait(rcChan); err != nil {
t.Fatal("Failed to receive reconnect signal")
}
// pub-sub test message to make sure connection is OK
omsg := []byte("Hello!")
checkRecv := make(chan bool)
received := 0
nc.Subscribe("foo", func(m *nats.Msg) {
received++
if !bytes.Equal(m.Data, omsg) {
t.Fatal("Message received does not match")
}
checkRecv <- true
})
err = nc.Publish("foo", omsg)
if err != nil {
t.Fatalf("Failed to publish on secure (TLS) connection: %v", err)
}
nc.Flush()
if err := Wait(checkRecv); err != nil {
t.Fatal("Failed to receive message")
}
}
func TestServerTLSHintConnections(t *testing.T) {
s, opts := RunServerWithConfig("./configs/tls.conf")
defer s.Shutdown()
endpoint := fmt.Sprintf("%s:%d", opts.Host, opts.Port)
secureURL := fmt.Sprintf("tls://%s:%s@%s/", opts.Username, opts.Password, endpoint)
nc, err := nats.Connect(secureURL, nats.RootCAs("./configs/certs/badca.pem"))
if err == nil {
nc.Close()
t.Fatal("Expected an error from bad RootCA file")
}
nc, err = nats.Connect(secureURL, nats.RootCAs("./configs/certs/ca.pem"))
if err != nil {
t.Fatalf("Failed to create secure (TLS) connection: %v", err)
}
defer nc.Close()
}
func TestClosedConnections(t *testing.T) {
s := RunDefaultServer()
defer s.Shutdown()
nc := NewDefaultConnection(t)
defer nc.Close()
sub, _ := nc.SubscribeSync("foo")
if sub == nil {
t.Fatal("Failed to create valid subscription")
}
// Test all API endpoints do the right thing with a closed connection.
nc.Close()
if err := nc.Publish("foo", nil); err != nats.ErrConnectionClosed {
t.Fatalf("Publish on closed conn did not fail properly: %v\n", err)
}
if err := nc.PublishMsg(&nats.Msg{Subject: "foo"}); err != nats.ErrConnectionClosed {
t.Fatalf("PublishMsg on closed conn did not fail properly: %v\n", err)
}
if err := nc.Flush(); err != nats.ErrConnectionClosed {
t.Fatalf("Flush on closed conn did not fail properly: %v\n", err)
}
_, err := nc.Subscribe("foo", nil)
if err != nats.ErrConnectionClosed {
t.Fatalf("Subscribe on closed conn did not fail properly: %v\n", err)
}
_, err = nc.SubscribeSync("foo")
if err != nats.ErrConnectionClosed {
t.Fatalf("SubscribeSync on closed conn did not fail properly: %v\n", err)
}
_, err = nc.QueueSubscribe("foo", "bar", nil)
if err != nats.ErrConnectionClosed {
t.Fatalf("QueueSubscribe on closed conn did not fail properly: %v\n", err)
}
_, err = nc.Request("foo", []byte("help"), 10*time.Millisecond)
if err != nats.ErrConnectionClosed {
t.Fatalf("Request on closed conn did not fail properly: %v\n", err)
}
if _, err = sub.NextMsg(10); err != nats.ErrConnectionClosed {
t.Fatalf("NextMessage on closed conn did not fail properly: %v\n", err)
}
if err = sub.Unsubscribe(); err != nats.ErrConnectionClosed {
t.Fatalf("Unsubscribe on closed conn did not fail properly: %v\n", err)
}
}
func TestErrOnConnectAndDeadlock(t *testing.T) {
// We will hand run a fake server that will timeout and not return a proper
// INFO proto. This is to test that we do not deadlock. Issue #18
l, e := net.Listen("tcp", ":0")
if e != nil {
t.Fatal("Could not listen on an ephemeral port")
}
tl := l.(*net.TCPListener)
defer tl.Close()
addr := tl.Addr().(*net.TCPAddr)
errCh := make(chan error, 1)
go func() {
conn, err := l.Accept()
if err != nil {
errCh <- fmt.Errorf("error accepting client connection: %v", err)
return
}
errCh <- nil
defer conn.Close()
// Send back a mal-formed INFO.
conn.Write([]byte("INFOZ \r\n"))
}()
go func() {
natsURL := fmt.Sprintf("nats://127.0.0.1:%d/", addr.Port)
nc, err := nats.Connect(natsURL)
if err == nil {
nc.Close()
errCh <- fmt.Errorf("expected bad INFO err, got none")
return
}
errCh <- nil
}()
// Setup a timer to watch for deadlock
select {
case e := <-errCh:
if e != nil {
t.Fatal(e.Error())
}
case <-time.After(time.Second):
t.Fatalf("Connect took too long, deadlock?")
}
}
func TestMoreErrOnConnect(t *testing.T) {
l, e := net.Listen("tcp", "127.0.0.1:0")
if e != nil {
t.Fatal("Could not listen on an ephemeral port")
}
tl := l.(*net.TCPListener)
defer tl.Close()
addr := tl.Addr().(*net.TCPAddr)
done := make(chan bool)
case1 := make(chan bool)
case2 := make(chan bool)
case3 := make(chan bool)
case4 := make(chan bool)
errCh := make(chan error, 5)
go func() {
for i := 0; i < 5; i++ {
conn, err := l.Accept()
if err != nil {
errCh <- fmt.Errorf("error accepting client connection: %v", err)
return
}
switch i {
case 0:
// Send back a partial INFO and close the connection.
conn.Write([]byte("INFO"))
case 1:
// Send just INFO
conn.Write([]byte("INFO\r\n"))
// Stick around a bit
<-case1
case 2:
info := fmt.Sprintf("INFO {\"server_id\":\"foobar\",\"host\":\"%s\",\"port\":%d,\"auth_required\":false,\"tls_required\":false,\"max_payload\":1048576}\r\n", addr.IP, addr.Port)
// Send complete INFO
conn.Write([]byte(info))
// Read connect and ping commands sent from the client
br := bufio.NewReaderSize(conn, 1024)
if _, err := br.ReadString('\n'); err != nil {
errCh <- fmt.Errorf("expected CONNECT from client, got: %s", err)
return
}
if _, err := br.ReadString('\n'); err != nil {
errCh <- fmt.Errorf("expected PING from client, got: %s", err)
return
}
// Client expect +OK, send it but then something else than PONG
conn.Write([]byte("+OK\r\n"))
// Stick around a bit
<-case2
case 3:
info := fmt.Sprintf("INFO {\"server_id\":\"foobar\",\"host\":\"%s\",\"port\":%d,\"auth_required\":false,\"tls_required\":false,\"max_payload\":1048576}\r\n", addr.IP, addr.Port)
// Send complete INFO
conn.Write([]byte(info))
// Read connect and ping commands sent from the client
br := bufio.NewReaderSize(conn, 1024)
if _, err := br.ReadString('\n'); err != nil {
errCh <- fmt.Errorf("expected CONNECT from client, got: %s", err)
return
}
if _, err := br.ReadString('\n'); err != nil {
errCh <- fmt.Errorf("expected PING from client, got: %s", err)
return
}
// Client expect +OK, send it but then something else than PONG
conn.Write([]byte("+OK\r\nXXX\r\n"))
// Stick around a bit
<-case3
case 4:
info := "INFO {'x'}\r\n"
// Send INFO with JSON marshall error
conn.Write([]byte(info))
// Stick around a bit
<-case4
}
conn.Close()
}
// Hang around until asked to quit
<-done
}()
natsURL := fmt.Sprintf("nats://127.0.0.1:%d", addr.Port)
if nc, err := nats.Connect(natsURL, nats.Timeout(20*time.Millisecond)); err == nil {
nc.Close()
t.Fatal("Expected error, got none")
}
if nc, err := nats.Connect(natsURL, nats.Timeout(20*time.Millisecond)); err == nil {
close(case1)
nc.Close()
t.Fatal("Expected error, got none")
}
close(case1)
opts := nats.GetDefaultOptions()
opts.Servers = []string{natsURL}
opts.Timeout = 20 * time.Millisecond
opts.Verbose = true
if nc, err := opts.Connect(); err == nil {
close(case2)
nc.Close()
t.Fatal("Expected error, got none")
}
close(case2)
if nc, err := opts.Connect(); err == nil {
close(case3)
nc.Close()
t.Fatal("Expected error, got none")
}
close(case3)
if nc, err := opts.Connect(); err == nil {
close(case4)
nc.Close()
t.Fatal("Expected error, got none")
}
close(case4)
close(done)
checkErrChannel(t, errCh)
}
func TestErrOnMaxPayloadLimit(t *testing.T) {
expectedMaxPayload := int64(10)
serverInfo := "INFO {\"server_id\":\"foobar\",\"host\":\"%s\",\"port\":%d,\"auth_required\":false,\"tls_required\":false,\"max_payload\":%d}\r\n"
l, e := net.Listen("tcp", "127.0.0.1:0")
if e != nil {
t.Fatal("Could not listen on an ephemeral port")
}
tl := l.(*net.TCPListener)
defer tl.Close()
addr := tl.Addr().(*net.TCPAddr)
// Send back an INFO message with custom max payload size on connect.
var conn net.Conn
var err error
errCh := make(chan error, 1)
go func() {
conn, err = l.Accept()
if err != nil {
errCh <- fmt.Errorf("error accepting client connection: %v", err)
return
}
defer conn.Close()
info := fmt.Sprintf(serverInfo, addr.IP, addr.Port, expectedMaxPayload)
conn.Write([]byte(info))
// Read connect and ping commands sent from the client
line := make([]byte, 111)
_, err := conn.Read(line)
if err != nil {
errCh <- fmt.Errorf("expected CONNECT and PING from client, got: %s", err)
return
}
conn.Write([]byte("PONG\r\n"))
// Hang around a bit to not err on EOF in client.
time.Sleep(250 * time.Millisecond)
}()
// Wait for server mock to start
time.Sleep(100 * time.Millisecond)
natsURL := fmt.Sprintf("nats://%s:%d", addr.IP, addr.Port)
opts := nats.GetDefaultOptions()
opts.Servers = []string{natsURL}
nc, err := opts.Connect()
if err != nil {
t.Fatalf("Expected INFO message with custom max payload, got: %s", err)
}
defer nc.Close()
got := nc.MaxPayload()
if got != expectedMaxPayload {
t.Fatalf("Expected MaxPayload to be %d, got: %d", expectedMaxPayload, got)
}
err = nc.Publish("hello", []byte("hello world"))
if err != nats.ErrMaxPayload {
t.Fatalf("Expected to fail trying to send more than max payload, got: %s", err)
}
err = nc.Publish("hello", []byte("a"))
if err != nil {
t.Fatalf("Expected to succeed trying to send less than max payload, got: %s", err)
}
checkErrChannel(t, errCh)
}
func TestConnectVerbose(t *testing.T) {
s := RunDefaultServer()
defer s.Shutdown()
o := nats.GetDefaultOptions()
o.Verbose = true
nc, err := o.Connect()
if err != nil {
t.Fatalf("Should have connected ok: %v", err)
}
nc.Close()
}
func getStacks(all bool) string {
var (
stacks []byte
stacksSize = 10000
n int
)
for {
stacks = make([]byte, stacksSize)
n = runtime.Stack(stacks, all)
if n == stacksSize {
stacksSize *= 2
continue
}
break
}
return string(stacks[:n])
}
func isRunningInAsyncCBDispatcher() error {
strStacks := getStacks(false)
if strings.Contains(strStacks, "asyncCBDispatcher") {
return nil
}
return fmt.Errorf("callback not executed from dispatcher:\n %s", strStacks)
}
func isAsyncDispatcherRunning() bool {
strStacks := getStacks(true)
return strings.Contains(strStacks, "asyncCBDispatcher")
}
func TestCallbacksOrder(t *testing.T) {
authS, authSOpts := RunServerWithConfig("./configs/tls.conf")
defer authS.Shutdown()
s := RunDefaultServer()
defer s.Shutdown()
firstDisconnect := true
var connTime, dtime1, dtime2, rtime, atime1, atime2, ctime time.Time
cbErrors := make(chan error, 20)
connected := make(chan bool)
reconnected := make(chan bool)
closed := make(chan bool)
asyncErr := make(chan bool, 2)
recvCh := make(chan bool, 2)
recvCh1 := make(chan bool)
recvCh2 := make(chan bool)
connCh := func(nc *nats.Conn) {
if err := isRunningInAsyncCBDispatcher(); err != nil {
cbErrors <- err
connected <- true
return
}
time.Sleep(50 * time.Millisecond)
connTime = time.Now()
connected <- true
}
dch := func(nc *nats.Conn) {
if err := isRunningInAsyncCBDispatcher(); err != nil {
cbErrors <- err
return
}
time.Sleep(100 * time.Millisecond)
if firstDisconnect {
firstDisconnect = false
dtime1 = time.Now()
} else {
dtime2 = time.Now()
}
}
rch := func(nc *nats.Conn) {
if err := isRunningInAsyncCBDispatcher(); err != nil {
cbErrors <- err
reconnected <- true
return
}
time.Sleep(50 * time.Millisecond)
rtime = time.Now()
reconnected <- true
}
ech := func(nc *nats.Conn, sub *nats.Subscription, err error) {
if err := isRunningInAsyncCBDispatcher(); err != nil {
cbErrors <- err
asyncErr <- true
return
}
if sub.Subject == "foo" {
time.Sleep(20 * time.Millisecond)
atime1 = time.Now()
} else {
atime2 = time.Now()
}
asyncErr <- true
}
cch := func(nc *nats.Conn) {
if err := isRunningInAsyncCBDispatcher(); err != nil {
cbErrors <- err
closed <- true
return
}
ctime = time.Now()
closed <- true
}
url := net.JoinHostPort(authSOpts.Host, strconv.Itoa(authSOpts.Port))
url = "nats://" + url + "," + nats.DefaultURL
nc, err := nats.Connect(url,
nats.ConnectHandler(connCh),
nats.DisconnectHandler(dch),
nats.ReconnectHandler(rch),
nats.ClosedHandler(cch),
nats.ErrorHandler(ech),
nats.ReconnectWait(50*time.Millisecond),
nats.ReconnectJitter(0, 0),
nats.DontRandomize())
if err != nil {
t.Fatalf("Unable to connect: %v\n", err)
}
defer nc.Close()
// Wait for notification on connection established
err = Wait(connected)
if err != nil {
t.Fatal("Did not get the connected callback")
}
ncp, err := nats.Connect(nats.DefaultURL,
nats.ReconnectWait(50*time.Millisecond))
if err != nil {
t.Fatalf("Unable to connect: %v\n", err)
}
defer ncp.Close()
// Wait to make sure that if we have closed (incorrectly) the
// asyncCBDispatcher during the connect process, this is caught here.
time.Sleep(time.Second)
s.Shutdown()
s = RunDefaultServer()
defer s.Shutdown()
if err := Wait(reconnected); err != nil {
t.Fatal("Did not get the reconnected callback")
}
var sub1, sub2 *nats.Subscription
recv := func(m *nats.Msg) {
// Signal that one message is received
recvCh <- true
// We will now block
if m.Subject == "foo" {
<-recvCh1
} else {
<-recvCh2
}
m.Sub.Unsubscribe()
}
sub1, err = nc.Subscribe("foo", recv)
if err != nil {
t.Fatalf("Unable to create subscription: %v\n", err)
}
sub1.SetPendingLimits(1, 100000)
sub2, err = nc.Subscribe("bar", recv)
if err != nil {
t.Fatalf("Unable to create subscription: %v\n", err)
}
sub2.SetPendingLimits(1, 100000)
nc.Flush()
ncp.Publish("foo", []byte("test"))
ncp.Publish("bar", []byte("test"))
ncp.Flush()
// Wait notification that message were received
err = Wait(recvCh)
if err == nil {
err = Wait(recvCh)
}
if err != nil {
t.Fatal("Did not receive message")
}
for i := 0; i < 2; i++ {
ncp.Publish("foo", []byte("test"))
ncp.Publish("bar", []byte("test"))
}
ncp.Flush()
if err := Wait(asyncErr); err != nil {
t.Fatal("Did not get the async callback")
}
if err := Wait(asyncErr); err != nil {
t.Fatal("Did not get the async callback")
}
close(recvCh1)
close(recvCh2)
nc.Close()
if err := Wait(closed); err != nil {
t.Fatal("Did not get the close callback")
}
if len(cbErrors) > 0 {
t.Fatalf("%v", <-cbErrors)
}
if (connTime == time.Time{}) || (dtime1 == time.Time{}) || (dtime2 == time.Time{}) || (rtime == time.Time{}) || (atime1 == time.Time{}) || (atime2 == time.Time{}) || (ctime == time.Time{}) {
t.Fatalf("Some callbacks did not fire:\n%v\n%v\n%v\n%v\n%v\n%v", dtime1, rtime, atime1, atime2, dtime2, ctime)
}
if dtime1.Before(connTime) || rtime.Before(dtime1) || dtime2.Before(rtime) || atime2.Before(atime1) || ctime.Before(atime2) {
t.Fatalf("Wrong callback order:\n%v\n%v\n%v\n%v\n%v\n%v\n%v", connTime, dtime1, rtime, atime1, atime2, dtime2, ctime)
}
// Close the other connection
ncp.Close()
// Check that the go routine is gone. Allow plenty of time
// to avoid flappers.
timeout := time.Now().Add(5 * time.Second)
for time.Now().Before(timeout) {
if !isAsyncDispatcherRunning() {
// Good, we are done!
return
}
time.Sleep(50 * time.Millisecond)
}
t.Fatalf("The async callback dispatcher(s) should have stopped")
}
func TestConnectHandler(t *testing.T) {
handler := func(ch chan bool) func(*nats.Conn) {
return func(*nats.Conn) {
ch <- true
}
}
t.Run("with RetryOnFailedConnect, connection established", func(t *testing.T) {
s := RunDefaultServer()
defer s.Shutdown()
connected := make(chan bool)
reconnected := make(chan bool)
nc, err := nats.Connect(nats.DefaultURL,
nats.ConnectHandler(handler(connected)),
nats.ReconnectHandler(handler(reconnected)),
nats.RetryOnFailedConnect(true))
if err != nil {
t.Fatalf("Unexpected error: %v", err)
}
defer nc.Close()
if err = Wait(connected); err != nil {
t.Fatal("Timeout waiting for connect handler")
}
if err = WaitTime(reconnected, 100*time.Millisecond); err == nil {
t.Fatal("Reconnect handler should not have been invoked")
}
})
t.Run("with RetryOnFailedConnect, connection failed", func(t *testing.T) {
connected := make(chan bool)
reconnected := make(chan bool)
nc, err := nats.Connect(nats.DefaultURL,
nats.ConnectHandler(handler(connected)),
nats.ReconnectHandler(handler(reconnected)),
nats.RetryOnFailedConnect(true))
if err != nil {
t.Fatalf("Unexpected error: %v", err)
}
defer nc.Close()
if err = WaitTime(connected, 100*time.Millisecond); err == nil {
t.Fatal("Connected handler should not have been invoked")
}
if err = WaitTime(reconnected, 100*time.Millisecond); err == nil {
t.Fatal("Reconnect handler should not have been invoked")
}
})
t.Run("no RetryOnFailedConnect, connection established", func(t *testing.T) {
s := RunDefaultServer()
defer s.Shutdown()
connected := make(chan bool)
reconnected := make(chan bool)
nc, err := nats.Connect(nats.DefaultURL,
nats.ConnectHandler(handler(connected)),
nats.ReconnectHandler(handler(reconnected)))
if err != nil {
t.Fatalf("Unexpected error: %v", err)
}
defer nc.Close()
if err = Wait(connected); err != nil {
t.Fatal("Timeout waiting for connect handler")
}
if err = WaitTime(reconnected, 100*time.Millisecond); err == nil {
t.Fatal("Reconnect handler should not have been invoked")
}
})
t.Run("no RetryOnFailedConnect, connection failed", func(t *testing.T) {
connected := make(chan bool)
reconnected := make(chan bool)
_, err := nats.Connect(nats.DefaultURL,
nats.ConnectHandler(handler(connected)),
nats.ReconnectHandler(handler(reconnected)))
if err == nil {
t.Fatalf("Expected error on connect, got nil")
}
if err = WaitTime(connected, 100*time.Millisecond); err == nil {
t.Fatal("Connected handler should not have been invoked")
}
if err = WaitTime(reconnected, 100*time.Millisecond); err == nil {
t.Fatal("Reconnect handler should not have been invoked")
}
})
t.Run("with RetryOnFailedConnect, initial connection failed, reconnect successful", func(t *testing.T) {
connected := make(chan bool)
reconnected := make(chan bool)
nc, err := nats.Connect(nats.DefaultURL,
nats.ConnectHandler(handler(connected)),
nats.ReconnectHandler(handler(reconnected)),
nats.RetryOnFailedConnect(true),
nats.ReconnectWait(100*time.Millisecond))
if err != nil {
t.Fatalf("Expected error on connect, got nil")
}
defer nc.Close()
s := RunDefaultServer()
defer s.Shutdown()
if err != nil {
t.Fatalf("Expected error on connect, got nil")
}
if err = Wait(connected); err != nil {
t.Fatal("Timeout waiting for reconnect handler")
}
if err = WaitTime(reconnected, 100*time.Millisecond); err == nil {
t.Fatal("Reconnect handler should not have been invoked")
}
})
t.Run("with RetryOnFailedConnect, initial connection successful, server restart", func(t *testing.T) {
connected := make(chan bool)
reconnected := make(chan bool)
s := RunDefaultServer()
defer s.Shutdown()
nc, err := nats.Connect(nats.DefaultURL,
nats.ConnectHandler(handler(connected)),
nats.ReconnectHandler(handler(reconnected)),
nats.RetryOnFailedConnect(true),
nats.ReconnectWait(100*time.Millisecond))
if err != nil {
t.Fatalf("Unexpected error: %v", err)
}
defer nc.Close()
if err != nil {
t.Fatalf("Unexpected error: %v", err)
}
if err = Wait(connected); err != nil {
t.Fatal("Timeout waiting for connect handler")
}
if err = WaitTime(reconnected, 100*time.Millisecond); err == nil {
t.Fatal("Reconnect handler should not have been invoked")
}
s.Shutdown()
s = RunDefaultServer()
defer s.Shutdown()
if err = Wait(reconnected); err != nil {
t.Fatal("Timeout waiting for reconnect handler")
}
if err = WaitTime(connected, 100*time.Millisecond); err == nil {
t.Fatal("Connected handler should not have been invoked")
}
})
}
func TestFlushReleaseOnClose(t *testing.T) {
serverInfo := "INFO {\"server_id\":\"foobar\",\"host\":\"%s\",\"port\":%d,\"auth_required\":false,\"tls_required\":false,\"max_payload\":1048576}\r\n"
l, e := net.Listen("tcp", "127.0.0.1:0")
if e != nil {
t.Fatal("Could not listen on an ephemeral port")
}
tl := l.(*net.TCPListener)
defer tl.Close()
addr := tl.Addr().(*net.TCPAddr)
done := make(chan bool)
errCh := make(chan error, 1)
go func() {
conn, err := l.Accept()
if err != nil {
errCh <- fmt.Errorf("error accepting client connection: %v", err)
return
}
defer conn.Close()
info := fmt.Sprintf(serverInfo, addr.IP, addr.Port)
conn.Write([]byte(info))
// Read connect and ping commands sent from the client
br := bufio.NewReaderSize(conn, 1024)
if _, err := br.ReadString('\n'); err != nil {
errCh <- fmt.Errorf("expected CONNECT from client, got: %s", err)
return
}
if _, err := br.ReadString('\n'); err != nil {
errCh <- fmt.Errorf("expected PING from client, got: %s", err)
return
}
conn.Write([]byte("PONG\r\n"))
// Hang around until asked to quit
<-done
}()
// Wait for server mock to start
time.Sleep(100 * time.Millisecond)
natsURL := fmt.Sprintf("nats://%s:%d", addr.IP, addr.Port)
opts := nats.GetDefaultOptions()
opts.AllowReconnect = false
opts.Servers = []string{natsURL}
nc, err := opts.Connect()
if err != nil {
t.Fatalf("Expected INFO message with custom max payload, got: %s", err)
}
defer nc.Close()
// First try a FlushTimeout() and make sure we timeout
if err := nc.FlushTimeout(50 * time.Millisecond); err == nil || err != nats.ErrTimeout {
t.Fatalf("Expected a timeout error, got: %v", err)
}
go func() {
time.Sleep(50 * time.Millisecond)
nc.Close()
}()
if err := nc.Flush(); err == nil {
t.Fatal("Expected error on Flush() released by Close()")
}
close(done)
checkErrChannel(t, errCh)
}
func TestMaxPendingOut(t *testing.T) {
serverInfo := "INFO {\"server_id\":\"foobar\",\"host\":\"%s\",\"port\":%d,\"auth_required\":false,\"tls_required\":false,\"max_payload\":1048576}\r\n"
l, e := net.Listen("tcp", "127.0.0.1:0")
if e != nil {
t.Fatal("Could not listen on an ephemeral port")
}
tl := l.(*net.TCPListener)
defer tl.Close()
addr := tl.Addr().(*net.TCPAddr)
done := make(chan bool)
cch := make(chan bool)
errCh := make(chan error, 1)
go func() {
conn, err := l.Accept()
if err != nil {
errCh <- fmt.Errorf("error accepting client connection: %v", err)
return
}
defer conn.Close()
info := fmt.Sprintf(serverInfo, addr.IP, addr.Port)
conn.Write([]byte(info))
// Read connect and ping commands sent from the client
br := bufio.NewReaderSize(conn, 1024)
if _, err := br.ReadString('\n'); err != nil {
errCh <- fmt.Errorf("expected CONNECT from client, got: %s", err)
return
}
if _, err := br.ReadString('\n'); err != nil {
errCh <- fmt.Errorf("expected PING from client, got: %s", err)
return
}
conn.Write([]byte("PONG\r\n"))
// Hang around until asked to quit
<-done
}()
// Wait for server mock to start
time.Sleep(100 * time.Millisecond)
natsURL := fmt.Sprintf("nats://%s:%d", addr.IP, addr.Port)
opts := nats.GetDefaultOptions()
opts.PingInterval = 20 * time.Millisecond
opts.MaxPingsOut = 2
opts.AllowReconnect = false
opts.ClosedCB = func(_ *nats.Conn) { cch <- true }
opts.Servers = []string{natsURL}
nc, err := opts.Connect()
if err != nil {
t.Fatalf("Expected INFO message with custom max payload, got: %s", err)
}
defer nc.Close()
// After 60 ms, we should have closed the connection
time.Sleep(100 * time.Millisecond)
if err := Wait(cch); err != nil {
t.Fatal("Failed to get ClosedCB")
}
if nc.LastError() != nats.ErrStaleConnection {
t.Fatalf("Expected to get %v, got %v", nats.ErrStaleConnection, nc.LastError())
}
close(done)
checkErrChannel(t, errCh)
}
func TestErrInReadLoop(t *testing.T) {
serverInfo := "INFO {\"server_id\":\"foobar\",\"host\":\"%s\",\"port\":%d,\"auth_required\":false,\"tls_required\":false,\"max_payload\":1048576}\r\n"
l, e := net.Listen("tcp", "127.0.0.1:0")
if e != nil {
t.Fatal("Could not listen on an ephemeral port")
}
tl := l.(*net.TCPListener)
defer tl.Close()
addr := tl.Addr().(*net.TCPAddr)
done := make(chan bool)
cch := make(chan bool)
errCh := make(chan error, 1)
go func() {
conn, err := l.Accept()
if err != nil {
errCh <- fmt.Errorf("error accepting client connection: %v", err)
return
}
defer conn.Close()
info := fmt.Sprintf(serverInfo, addr.IP, addr.Port)
conn.Write([]byte(info))
// Read connect and ping commands sent from the client
br := bufio.NewReaderSize(conn, 1024)
if _, err := br.ReadString('\n'); err != nil {
errCh <- fmt.Errorf("expected CONNECT from client, got: %s", err)
return
}
if _, err := br.ReadString('\n'); err != nil {
errCh <- fmt.Errorf("expected PING from client, got: %s", err)
return
}
conn.Write([]byte("PONG\r\n"))
// Read (and ignore) the SUB from the client
if _, err := br.ReadString('\n'); err != nil {
errCh <- fmt.Errorf("expected SUB from client, got: %s", err)
return
}
// Send something that should make the subscriber fail.
conn.Write([]byte("Ivan"))
// Hang around until asked to quit
<-done
}()
// Wait for server mock to start
time.Sleep(100 * time.Millisecond)
natsURL := fmt.Sprintf("nats://%s:%d", addr.IP, addr.Port)
opts := nats.GetDefaultOptions()
opts.AllowReconnect = false
opts.ClosedCB = func(_ *nats.Conn) { cch <- true }
opts.Servers = []string{natsURL}
nc, err := opts.Connect()
if err != nil {
t.Fatalf("Expected INFO message with custom max payload, got: %s", err)
}
defer nc.Close()
received := int64(0)
nc.Subscribe("foo", func(_ *nats.Msg) {
atomic.AddInt64(&received, 1)
})
if err := Wait(cch); err != nil {
t.Fatal("Failed to get ClosedCB")
}
recv := int(atomic.LoadInt64(&received))
if recv != 0 {
t.Fatalf("Should not have received messages, got: %d", recv)
}
close(done)
checkErrChannel(t, errCh)
}
func TestErrStaleConnection(t *testing.T) {
serverInfo := "INFO {\"server_id\":\"foobar\",\"host\":\"%s\",\"port\":%d,\"auth_required\":false,\"tls_required\":false,\"max_payload\":1048576}\r\n"
l, e := net.Listen("tcp", "127.0.0.1:0")
if e != nil {
t.Fatal("Could not listen on an ephemeral port")
}
tl := l.(*net.TCPListener)
defer tl.Close()
addr := tl.Addr().(*net.TCPAddr)
done := make(chan bool)
dch := make(chan bool)
rch := make(chan bool)
cch := make(chan bool)
sch := make(chan bool)
firstDisconnect := true
errCh := make(chan error, 1)
go func() {
for i := 0; i < 2; i++ {
conn, err := l.Accept()
if err != nil {
errCh <- fmt.Errorf("error accepting client connection: %v", err)
return
}
defer conn.Close()
info := fmt.Sprintf(serverInfo, addr.IP, addr.Port)
conn.Write([]byte(info))
// Read connect and ping commands sent from the client
br := bufio.NewReaderSize(conn, 1024)
if _, err := br.ReadString('\n'); err != nil {
errCh <- fmt.Errorf("expected CONNECT from client, got: %s", err)
return
}
if _, err := br.ReadString('\n'); err != nil {
errCh <- fmt.Errorf("expected PING from client, got: %s", err)
return
}
conn.Write([]byte("PONG\r\n"))
if i == 0 {
// Wait a tiny, and simulate a Stale Connection
time.Sleep(50 * time.Millisecond)
conn.Write([]byte("-ERR 'Stale Connection'\r\n"))
// The client should try to reconnect. When getting the
// disconnected callback, it will close this channel.
<-sch
// Close the connection and go back to accept the new
// connection.
conn.Close()
} else {
// Hang around a bit
<-done
}
}
}()
// Wait for server mock to start
time.Sleep(100 * time.Millisecond)
natsURL := fmt.Sprintf("nats://%s:%d", addr.IP, addr.Port)
opts := nats.GetDefaultOptions()
opts.AllowReconnect = true
opts.DisconnectedErrCB = func(_ *nats.Conn, _ error) {
// Interested only in the first disconnect cb
if firstDisconnect {
firstDisconnect = false
close(sch)
dch <- true
}
}
opts.ReconnectedCB = func(_ *nats.Conn) { rch <- true }
opts.ClosedCB = func(_ *nats.Conn) { cch <- true }
opts.ReconnectWait = 20 * time.Millisecond
nats.ReconnectJitter(0, 0)(&opts)
opts.MaxReconnect = 100
opts.Servers = []string{natsURL}
nc, err := opts.Connect()
if err != nil {
t.Fatalf("Expected INFO message with custom max payload, got: %s", err)
}
defer nc.Close()
// We should first gets disconnected
if err := Wait(dch); err != nil {
t.Fatal("Failed to get DisconnectedErrCB")
}
// Then reconneted..
if err := Wait(rch); err != nil {
t.Fatal("Failed to get ReconnectedCB")
}
// Now close the connection
nc.Close()
// We should get the closed cb
if err := Wait(cch); err != nil {
t.Fatal("Failed to get ClosedCB")
}
close(done)
checkErrChannel(t, errCh)
}
func TestServerErrorClosesConnection(t *testing.T) {
serverInfo := "INFO {\"server_id\":\"foobar\",\"host\":\"%s\",\"port\":%d,\"auth_required\":false,\"tls_required\":false,\"max_payload\":1048576}\r\n"
l, e := net.Listen("tcp", "127.0.0.1:0")
if e != nil {
t.Fatal("Could not listen on an ephemeral port")
}
tl := l.(*net.TCPListener)
defer tl.Close()
addr := tl.Addr().(*net.TCPAddr)
done := make(chan bool)
dch := make(chan bool)
cch := make(chan bool)
serverSentError := "Any Error"
reconnected := int64(0)
errCh := make(chan error, 1)
go func() {
conn, err := l.Accept()
if err != nil {
errCh <- fmt.Errorf("error accepting client connection: %v", err)
return
}
defer conn.Close()
info := fmt.Sprintf(serverInfo, addr.IP, addr.Port)
conn.Write([]byte(info))
// Read connect and ping commands sent from the client
br := bufio.NewReaderSize(conn, 1024)
if _, err := br.ReadString('\n'); err != nil {
errCh <- fmt.Errorf("expected CONNECT from client, got: %s", err)
return
}
if _, err := br.ReadString('\n'); err != nil {
errCh <- fmt.Errorf("expected PING from client, got: %s", err)
return
}
conn.Write([]byte("PONG\r\n"))
// Wait a tiny, and simulate a Stale Connection
time.Sleep(50 * time.Millisecond)
conn.Write([]byte("-ERR '" + serverSentError + "'\r\n"))
// Hang around a bit
<-done
}()
// Wait for server mock to start
time.Sleep(100 * time.Millisecond)
natsURL := fmt.Sprintf("nats://%s:%d", addr.IP, addr.Port)
opts := nats.GetDefaultOptions()
opts.AllowReconnect = true
opts.DisconnectedErrCB = func(_ *nats.Conn, _ error) { dch <- true }
opts.ReconnectedCB = func(_ *nats.Conn) { atomic.AddInt64(&reconnected, 1) }
opts.ClosedCB = func(_ *nats.Conn) { cch <- true }
opts.ReconnectWait = 20 * time.Millisecond
nats.ReconnectJitter(0, 0)(&opts)
opts.MaxReconnect = 100
opts.Servers = []string{natsURL}
nc, err := opts.Connect()
if err != nil {
t.Fatalf("Expected INFO message with custom max payload, got: %s", err)
}
defer nc.Close()
// The server sends an error that should cause the client to simply close
// the connection.
// We should first gets disconnected
if err := Wait(dch); err != nil {
t.Fatal("Failed to get DisconnectedErrCB")
}
// We should get the closed cb
if err := Wait(cch); err != nil {
t.Fatal("Failed to get ClosedCB")
}
// We should not have been reconnected
if atomic.LoadInt64(&reconnected) != 0 {
t.Fatal("ReconnectedCB should not have been invoked")
}
// Check LastError(), it should be "nats: <server error in lower case>"
lastErr := nc.LastError().Error()
expectedErr := "nats: " + serverSentError
if lastErr != expectedErr {
t.Fatalf("Expected error: '%v', got '%v'", expectedErr, lastErr)
}
close(done)
checkErrChannel(t, errCh)
}
func TestUseDefaultTimeout(t *testing.T) {
s := RunDefaultServer()
defer s.Shutdown()
opts := &nats.Options{
Servers: []string{nats.DefaultURL},
}
nc, err := opts.Connect()
if err != nil {
t.Fatalf("Unexpected error on connect: %v", err)
}
defer nc.Close()
if nc.Opts.Timeout != nats.DefaultTimeout {
t.Fatalf("Expected Timeout to be set to %v, got %v", nats.DefaultTimeout, nc.Opts.Timeout)
}
}
func TestLastErrorNoRace(t *testing.T) {
s := RunDefaultServer()
defer s.Shutdown()
// Access LastError in disconnection and closed handlers to make sure
// that there is no race. It is possible in some cases that
// nc.LastError() returns a non nil error. We don't care here about the
// returned value.
dch := func(c *nats.Conn) {
c.LastError()
}
closedCh := make(chan struct{})
cch := func(c *nats.Conn) {
c.LastError()
closedCh <- struct{}{}
}
nc, err := nats.Connect(nats.DefaultURL,
nats.DisconnectHandler(dch),
nats.ClosedHandler(cch),
nats.MaxReconnects(-1),
nats.ReconnectWait(5*time.Millisecond),
nats.ReconnectJitter(0, 0))
if err != nil {
t.Fatalf("Unable to connect: %v\n", err)
}
defer nc.Close()
// Restart the server several times to trigger a reconnection.
for i := 0; i < 10; i++ {
s.Shutdown()
time.Sleep(10 * time.Millisecond)
s = RunDefaultServer()
}
nc.Close()
s.Shutdown()
select {
case <-closedCh:
case <-time.After(5 * time.Second):
t.Fatal("Timeout waiting for the closed callback")
}
}
type customDialer struct {
ch chan bool
}
func (cd *customDialer) Dial(network, address string) (net.Conn, error) {
cd.ch <- true
return nil, fmt.Errorf("on purpose")
}
func TestUseCustomDialer(t *testing.T) {
s := RunDefaultServer()
defer s.Shutdown()
dialer := &net.Dialer{
Timeout: 10 * time.Second,
FallbackDelay: -1,
}
opts := &nats.Options{
Servers: []string{nats.DefaultURL},
Dialer: dialer,
}
nc, err := opts.Connect()
if err != nil {
t.Fatalf("Unexpected error on connect: %v", err)
}
defer nc.Close()
if nc.Opts.Dialer != dialer {
t.Fatalf("Expected Dialer to be set to %v, got %v", dialer, nc.Opts.Dialer)
}
// Should be possible to set via variadic func based Option setter
dialer2 := &net.Dialer{
Timeout: 5 * time.Second,
FallbackDelay: -1,
}
nc2, err := nats.Connect(nats.DefaultURL, nats.Dialer(dialer2))
if err != nil {
t.Fatalf("Unexpected error on connect: %v", err)
}
defer nc2.Close()
if nc2.Opts.Dialer.FallbackDelay > 0 {
t.Fatalf("Expected for dialer to be customized to disable dual stack support")
}
// By default, dialer still uses the DefaultTimeout
nc3, err := nats.Connect(nats.DefaultURL)
if err != nil {
t.Fatalf("Unexpected error on connect: %v", err)
}
defer nc3.Close()
if nc3.Opts.Dialer.Timeout != nats.DefaultTimeout {
t.Fatalf("Expected Dialer.Timeout to be set to %v, got %v", nats.DefaultTimeout, nc.Opts.Dialer.Timeout)
}
// Create custom dialer that return error on Dial().
cdialer := &customDialer{ch: make(chan bool, 10)}
// When both Dialer and CustomDialer are set, CustomDialer
// should take precedence. That means that the connection
// should fail for these two set of options.
options := []*nats.Options{
{Dialer: dialer, CustomDialer: cdialer},
{CustomDialer: cdialer},
}
for _, o := range options {
o.Servers = []string{nats.DefaultURL}
nc, err := o.Connect()
// As of now, Connect() would not return the actual dialer error,
// instead it returns "no server available for connections".
// So use go channel to ensure that custom dialer's Dial() method
// was invoked.
if err == nil {
if nc != nil {
nc.Close()
}
t.Fatal("Expected error, got none")
}
if err := Wait(cdialer.ch); err != nil {
t.Fatal("Did not get our notification")
}
}
// Same with variadic
foptions := [][]nats.Option{
{nats.Dialer(dialer), nats.SetCustomDialer(cdialer)},
{nats.SetCustomDialer(cdialer)},
}
for _, fos := range foptions {
nc, err := nats.Connect(nats.DefaultURL, fos...)
if err == nil {
if nc != nil {
nc.Close()
}
t.Fatal("Expected error, got none")
}
if err := Wait(cdialer.ch); err != nil {
t.Fatal("Did not get our notification")
}
}
}
func TestDefaultOptionsDialer(t *testing.T) {
s := RunDefaultServer()
defer s.Shutdown()
opts1 := nats.GetDefaultOptions()
opts2 := nats.GetDefaultOptions()
nc1, err := opts1.Connect()
if err != nil {
t.Fatalf("Unexpected error on connect: %v", err)
}
defer nc1.Close()
nc2, err := opts2.Connect()
if err != nil {
t.Fatalf("Unexpected error on connect: %v", err)
}
defer nc2.Close()
if nc1.Opts.Dialer == nc2.Opts.Dialer {
t.Fatalf("Expected each connection to have its own dialer")
}
}
type lowWriteBufferDialer struct{}
func (d *lowWriteBufferDialer) Dial(network, address string) (net.Conn, error) {
c, err := net.Dial(network, address)
if err != nil {
return nil, err
}
c.(*net.TCPConn).SetWriteBuffer(100)
return c, nil
}
func TestCustomFlusherTimeout(t *testing.T) {
if runtime.GOOS == "windows" {
t.SkipNow()
}
s := RunDefaultServer()
defer s.Shutdown()
// Reasonably large flusher timeout will not induce errors
// when we can flush fast
nc1, err := nats.Connect(nats.DefaultURL, nats.FlusherTimeout(10*time.Second))
if err != nil {
t.Fatalf("Expected to be able to connect, got: %s", err)
}
doneCh := make(chan struct{}, 1)
// We want to have a payload size that is big enough so that after
// few publish, the socket buffer will be full and produce the timeout.
// Since we try to produce the error in the flusher and not the publish
// call itself, use a size that is a bit less than the internal
// buffer used by the library.
payloadBytes := make([]byte, 32*1024-200)
errCh := make(chan error, 1)
wg := sync.WaitGroup{}
wg.Add(2)
go func() {
defer wg.Done()
for {
select {
case <-time.After(200 * time.Millisecond):
err := nc1.Publish("hello", payloadBytes)
if err != nil {
errCh <- err
return
}
case <-doneCh:
return
}
}
}()
defer nc1.Close()
l, e := net.Listen("tcp", "127.0.0.1:0")
if e != nil {
t.Fatal("Could not listen on an ephemeral port")
}
tl := l.(*net.TCPListener)
defer tl.Close()
addr := tl.Addr().(*net.TCPAddr)
fsDoneCh := make(chan struct{}, 1)
fsErrCh := make(chan error, 1)
go func() {
defer wg.Done()
serverInfo := "INFO {\"server_id\":\"foobar\",\"host\":\"%s\",\"port\":%d,\"auth_required\":false,\"tls_required\":false,\"max_payload\":%d}\r\n"
conn, err := l.Accept()
if err != nil {
fsErrCh <- err
return
}
defer conn.Close()
// Make it small on purpose
if err := conn.(*net.TCPConn).SetReadBuffer(1024); err != nil {
fsErrCh <- err
return
}
info := fmt.Sprintf(serverInfo, addr.IP, addr.Port, 1024*1024)
conn.Write([]byte(info))
// Read connect and ping commands sent from the client
line := make([]byte, 100)
_, err = conn.Read(line)
if err != nil {
fsErrCh <- fmt.Errorf("Expected CONNECT and PING from client, got: %v", err)
return
}
conn.Write([]byte("PONG\r\n"))
// Don't consume anything at this point and wait to be notified
// that we are done.
<-fsDoneCh
fsErrCh <- nil
}()
nc2, err := nats.Connect(
// URL to fake server
fmt.Sprintf("nats://127.0.0.1:%d", addr.Port),
// Use custom dialer so we can set write buffer to low value
nats.SetCustomDialer(&lowWriteBufferDialer{}),
// Use short flusher timeout to trigger the error
nats.FlusherTimeout(15*time.Millisecond),
// Make sure the library does not close connection due
// to pings for this test.
nats.PingInterval(20*time.Second),
// No reconnect
nats.NoReconnect(),
// Notify when connection lost
nats.ClosedHandler(func(_ *nats.Conn) {
doneCh <- struct{}{}
}),
// Use error handler to silence the stderr output
nats.ErrorHandler(func(_ *nats.Conn, _ *nats.Subscription, _ error) {
}))
if err != nil {
t.Fatalf("Expected to be able to connect, got: %s", err)
}
defer nc2.Close()
var (
pubErr error
nc2Err error
tm = time.NewTimer(5 * time.Second)
)
forLoop:
for {
select {
case <-time.After(100 * time.Millisecond):
// We are trying to get the flusher to report the error, but it
// is possible that the Publish() call itself flushes and we don't
// want to fail the test for that.
pubErr = nc2.Publish("world", payloadBytes)
nc2Err = nc2.LastError()
if nc2Err != nil {
break forLoop
}
case <-tm.C:
// We got an error, but not from flusher. Don't fail yet. Will check
// if this is a timeout error as expected.
if pubErr != nil {
break forLoop
}
t.Fatalf("Timeout publishing messages")
}
}
// Notify fake server that it can stop
close(fsDoneCh)
// Wait for go routines to end
wg.Wait()
// Make sure there were no error in the fake server
if err := <-fsErrCh; err != nil {
t.Fatalf("Fake server reported: %v", err)
}
// One of those two are guaranteed to be set.
err = nc2Err
if err == nil {
err = pubErr
}
// Check that error is a timeout error as expected.
ope, ok := err.(*net.OpError)
if !ok {
t.Fatalf("expected a net.Error, got %v", err)
}
if !ope.Timeout() {
t.Fatalf("expected a timeout, got %v", err)
}
if ope.Op != "write" {
t.Fatalf("expected a write error, got %v", err)
}
// Check that there is no error from nc1
select {
case e := <-errCh:
t.Fatal(e)
default:
}
}
func TestNewServers(t *testing.T) {
s1Opts := test.DefaultTestOptions
s1Opts.Host = "127.0.0.1"
s1Opts.Port = 4222
s1Opts.Cluster.Host = "127.0.0.1"
s1Opts.Cluster.Port = 6222
s1 := test.RunServer(&s1Opts)
defer s1.Shutdown()
s2Opts := test.DefaultTestOptions
s2Opts.Host = "127.0.0.1"
s2Opts.Port = 4223
s2Opts.Port = s1Opts.Port + 1
s2Opts.Cluster.Host = "127.0.0.1"
s2Opts.Cluster.Port = 6223
s2Opts.Routes = server.RoutesFromStr("nats://127.0.0.1:6222")
s2 := test.RunServer(&s2Opts)
defer s2.Shutdown()
ch := make(chan bool)
cb := func(_ *nats.Conn) {
ch <- true
}
url := fmt.Sprintf("nats://%s:%d", s1Opts.Host, s1Opts.Port)
nc1, err := nats.Connect(url, nats.DiscoveredServersHandler(cb))
if err != nil {
t.Fatalf("Error on connect: %v", err)
}
defer nc1.Close()
nc2, err := nats.Connect(url)
if err != nil {
t.Fatalf("Error on connect: %v", err)
}
defer nc2.Close()
nc2.SetDiscoveredServersHandler(cb)
opts := nats.GetDefaultOptions()
opts.Url = nats.DefaultURL
opts.DiscoveredServersCB = cb
nc3, err := opts.Connect()
if err != nil {
t.Fatalf("Error on connect: %v", err)
}
defer nc3.Close()
// Make sure that handler is not invoked on initial connect.
select {
case <-ch:
t.Fatalf("Handler should not have been invoked")
case <-time.After(500 * time.Millisecond):
}
// Start a new server.
s3Opts := test.DefaultTestOptions
s1Opts.Host = "127.0.0.1"
s1Opts.Port = 4224
s3Opts.Port = s2Opts.Port + 1
s3Opts.Cluster.Host = "127.0.0.1"
s3Opts.Cluster.Port = 6224
s3Opts.Routes = server.RoutesFromStr("nats://127.0.0.1:6222")
s3 := test.RunServer(&s3Opts)
defer s3.Shutdown()
// The callbacks should have been invoked
if err := Wait(ch); err != nil {
t.Fatal("Did not get our callback")
}
if err := Wait(ch); err != nil {
t.Fatal("Did not get our callback")
}
if err := Wait(ch); err != nil {
t.Fatal("Did not get our callback")
}
}
func TestBarrier(t *testing.T) {
s := RunDefaultServer()
defer s.Shutdown()
nc := NewDefaultConnection(t)
defer nc.Close()
pubMsgs := int32(0)
ch := make(chan bool, 1)
sub1, err := nc.Subscribe("pub", func(_ *nats.Msg) {
atomic.AddInt32(&pubMsgs, 1)
time.Sleep(250 * time.Millisecond)
})
if err != nil {
t.Fatalf("Error on subscribe: %v", err)
}
sub2, err := nc.Subscribe("close", func(_ *nats.Msg) {
// The "close" message was sent/received lat, but
// because we are dealing with different subscriptions,
// which are dispatched by different dispatchers, and
// because the "pub" subscription is delayed, this
// callback is likely to be invoked before the sub1's
// second callback is invoked. Using the Barrier call
// here will ensure that the given function will be invoked
// after the preceding messages have been dispatched.
nc.Barrier(func() {
res := atomic.LoadInt32(&pubMsgs) == 2
ch <- res
})
})
if err != nil {
t.Fatalf("Error on subscribe: %v", err)
}
// Send 2 "pub" messages followed by a "close" message
for i := 0; i < 2; i++ {
if err := nc.Publish("pub", []byte("pub msg")); err != nil {
t.Fatalf("Error on publish: %v", err)
}
}
if err := nc.Publish("close", []byte("closing")); err != nil {
t.Fatalf("Error on publish: %v", err)
}
select {
case ok := <-ch:
if !ok {
t.Fatal("The barrier function was invoked before the second message")
}
case <-time.After(2 * time.Second):
t.Fatal("Waited for too long...")
}
// Remove all subs
sub1.Unsubscribe()
sub2.Unsubscribe()
// Barrier should be invoked in place. Since we use buffered channel
// we are ok.
nc.Barrier(func() { ch <- true })
if err := Wait(ch); err != nil {
t.Fatal("Barrier function was not invoked")
}
if _, err := nc.Subscribe("foo", func(m *nats.Msg) {
// To check that the Barrier() function works if the subscription
// is unsubscribed after the call was made, sleep a bit here.
time.Sleep(250 * time.Millisecond)
m.Sub.Unsubscribe()
}); err != nil {
t.Fatalf("Error on subscribe: %v", err)
}
if err := nc.Publish("foo", []byte("hello")); err != nil {
t.Fatalf("Error on publish: %v", err)
}
// We need to Flush here to make sure that message has been received
// and posted to subscription's internal queue before calling Barrier.
if err := nc.Flush(); err != nil {
t.Fatalf("Error on flush: %v", err)
}
nc.Barrier(func() { ch <- true })
if err := Wait(ch); err != nil {
t.Fatal("Barrier function was not invoked")
}
// Test with AutoUnsubscribe now...
sub1, err = nc.Subscribe("foo", func(m *nats.Msg) {
// Since we auto-unsubscribe with 1, there should not be another
// invocation of this callback, but the Barrier should still be
// invoked.
nc.Barrier(func() { ch <- true })
})
if err != nil {
t.Fatalf("Error on subscribe: %v", err)
}
sub1.AutoUnsubscribe(1)
// Send 2 messages and flush
for i := 0; i < 2; i++ {
if err := nc.Publish("foo", []byte("hello")); err != nil {
t.Fatalf("Error on publish: %v", err)
}
}
if err := nc.Flush(); err != nil {
t.Fatalf("Error on flush: %v", err)
}
// Check barrier was invoked
if err := Wait(ch); err != nil {
t.Fatal("Barrier function was not invoked")
}
// Check that Barrier only affects asynchronous subscriptions
sub1, err = nc.Subscribe("foo", func(m *nats.Msg) {
nc.Barrier(func() { ch <- true })
})
if err != nil {
t.Fatalf("Error on subscribe: %v", err)
}
syncSub, err := nc.SubscribeSync("foo")
if err != nil {
t.Fatalf("Error on subscribe: %v", err)
}
msgChan := make(chan *nats.Msg, 1)
chanSub, err := nc.ChanSubscribe("foo", msgChan)
if err != nil {
t.Fatalf("Error on subscribe: %v", err)
}
if err := nc.Publish("foo", []byte("hello")); err != nil {
t.Fatalf("Error on publish: %v", err)
}
if err := nc.Flush(); err != nil {
t.Fatalf("Error on flush: %v", err)
}
// Check barrier was invoked even if we did not yet consume
// from the 2 other type of subscriptions
if err := Wait(ch); err != nil {
t.Fatal("Barrier function was not invoked")
}
if _, err := syncSub.NextMsg(time.Second); err != nil {
t.Fatalf("Sync sub did not receive the message")
}
select {
case <-msgChan:
case <-time.After(time.Second):
t.Fatal("Chan sub did not receive the message")
}
chanSub.Unsubscribe()
syncSub.Unsubscribe()
sub1.Unsubscribe()
atomic.StoreInt32(&pubMsgs, 0)
// Check barrier does not prevent new messages to be delivered.
sub1, err = nc.Subscribe("foo", func(_ *nats.Msg) {
if pm := atomic.AddInt32(&pubMsgs, 1); pm == 1 {
nc.Barrier(func() {
nc.Publish("foo", []byte("second"))
nc.Flush()
})
} else if pm == 2 {
ch <- true
}
})
if err != nil {
t.Fatalf("Error on subscribe: %v", err)
}
if err := nc.Publish("foo", []byte("first")); err != nil {
t.Fatalf("Error on publish: %v", err)
}
if err := Wait(ch); err != nil {
t.Fatal("Barrier function was not invoked")
}
sub1.Unsubscribe()
// Check that barrier works if called before connection
// is closed.
if _, err := nc.Subscribe("bar", func(_ *nats.Msg) {
nc.Barrier(func() { ch <- true })
nc.Close()
}); err != nil {
t.Fatalf("Error on subscribe: %v", err)
}
if err := nc.Publish("bar", []byte("hello")); err != nil {
t.Fatalf("Error on publish: %v", err)
}
// This could fail if the connection is closed before we get
// here.
nc.Flush()
if err := Wait(ch); err != nil {
t.Fatal("Barrier function was not invoked")
}
// Finally, check that if connection is closed, Barrier returns
// an error.
if err := nc.Barrier(func() { ch <- true }); err != nats.ErrConnectionClosed {
t.Fatalf("Expected error %v, got %v", nats.ErrConnectionClosed, err)
}
// Check that one can call connection methods from Barrier
// when there is no async subscriptions
nc = NewDefaultConnection(t)
defer nc.Close()
if err := nc.Barrier(func() {
ch <- nc.TLSRequired()
}); err != nil {
t.Fatalf("Error on Barrier: %v", err)
}
if err := Wait(ch); err != nil {
t.Fatal("Barrier was blocked")
}
}
func TestReceiveInfoRightAfterFirstPong(t *testing.T) {
l, err := net.Listen("tcp", "127.0.0.1:0")
if err != nil {
t.Fatalf("Error on listen: %v", err)
}
tl := l.(*net.TCPListener)
defer tl.Close()
addr := tl.Addr().(*net.TCPAddr)
wg := sync.WaitGroup{}
wg.Add(1)
go func() {
defer wg.Done()
c, err := tl.Accept()
if err != nil {
return
}
defer c.Close()
// Send the initial INFO
c.Write([]byte("INFO {}\r\n"))
buf := make([]byte, 0, 100)
b := make([]byte, 100)
for {
n, err := c.Read(b)
if err != nil {
return
}
buf = append(buf, b[:n]...)
if bytes.Contains(buf, []byte("PING\r\n")) {
break
}
}
// Send PONG and following INFO in one go (or at least try).
// The processing of PONG in sendConnect() should leave the
// rest for the readLoop to process.
c.Write([]byte(fmt.Sprintf("PONG\r\nINFO {\"connect_urls\":[\"127.0.0.1:%d\", \"me:1\"]}\r\n", addr.Port)))
// Wait for client to disconnect
for {
if _, err := c.Read(buf); err != nil {
return
}
}
}()
nc, err := nats.Connect(fmt.Sprintf("nats://127.0.0.1:%d", addr.Port))
if err != nil {
t.Fatalf("Error on connect: %v", err)
}
defer nc.Close()
var (
ds []string
timeout = time.Now().Add(2 * time.Second)
ok = false
)
for time.Now().Before(timeout) {
ds = nc.DiscoveredServers()
if len(ds) == 1 && ds[0] == "nats://me:1" {
ok = true
break
}
time.Sleep(50 * time.Millisecond)
}
nc.Close()
wg.Wait()
if !ok {
t.Fatalf("Unexpected discovered servers: %v", ds)
}
}
func TestReceiveInfoWithEmptyConnectURLs(t *testing.T) {
ready := make(chan error, 2)
ch := make(chan bool, 1)
wg := sync.WaitGroup{}
wg.Add(1)
go func() {
defer wg.Done()
ports := []int{4222, 4223}
for i := 0; i < 2; i++ {
l, err := net.Listen("tcp", fmt.Sprintf("127.0.0.1:%d", ports[i]))
if err != nil {
ready <- fmt.Errorf("error on listen: %v", err)
return
}
tl := l.(*net.TCPListener)
defer tl.Close()
ready <- nil
c, err := tl.Accept()
if err != nil {
return
}
defer c.Close()
// Send the initial INFO
c.Write([]byte(fmt.Sprintf("INFO {\"server_id\":\"server%d\"}\r\n", (i + 1))))
buf := make([]byte, 0, 100)
b := make([]byte, 100)
for {
n, err := c.Read(b)
if err != nil {
return
}
buf = append(buf, b[:n]...)
if bytes.Contains(buf, []byte("PING\r\n")) {
break
}
}
if i == 0 {
// Send PONG and following INFO in one go (or at least try).
// The processing of PONG in sendConnect() should leave the
// rest for the readLoop to process.
c.Write([]byte("PONG\r\nINFO {\"server_id\":\"server1\",\"connect_urls\":[\"127.0.0.1:4222\", \"127.0.0.1:4223\", \"127.0.0.1:4224\"]}\r\n"))
// Wait for the notification
<-ch
// Close the connection in our side and go back into accept
c.Close()
} else {
// Send no connect ULRs (as if this was an older server that could in some cases
// send an empty array)
c.Write([]byte("PONG\r\nINFO {\"server_id\":\"server2\"}\r\n"))
// Wait for client to disconnect
for {
if _, err := c.Read(buf); err != nil {
return
}
}
}
}
}()
// Wait for listener to be up and running
e := <-ready
if e != nil {
t.Fatal(e.Error())
}
rch := make(chan bool)
nc, err := nats.Connect("nats://127.0.0.1:4222",
nats.ReconnectWait(50*time.Millisecond),
nats.ReconnectJitter(0, 0),
nats.ReconnectHandler(func(_ *nats.Conn) {
rch <- true
}))
if err != nil {
t.Fatalf("Error on connect: %v", err)
}
defer nc.Close()
var (
ds []string
timeout = time.Now().Add(2 * time.Second)
ok = false
)
for time.Now().Before(timeout) {
ds = nc.DiscoveredServers()
if len(ds) == 2 {
if (ds[0] == "nats://127.0.0.1:4223" && ds[1] == "nats://127.0.0.1:4224") ||
(ds[0] == "nats://127.0.0.1:4224" && ds[1] == "nats://127.0.0.1:4223") {
ok = true
break
}
}
time.Sleep(50 * time.Millisecond)
}
if !ok {
t.Fatalf("Unexpected discovered servers: %v", ds)
}
// Make the server close our connection
ch <- true
// Wait for the reconnect
if err := Wait(rch); err != nil {
t.Fatal("Did not reconnect")
}
// Discovered servers should still contain nats://me:1
ds = nc.DiscoveredServers()
if len(ds) != 2 ||
!((ds[0] == "nats://127.0.0.1:4223" && ds[1] == "nats://127.0.0.1:4224") ||
(ds[0] == "nats://127.0.0.1:4224" && ds[1] == "nats://127.0.0.1:4223")) {
t.Fatalf("Unexpected discovered servers list: %v", ds)
}
nc.Close()
wg.Wait()
}
func TestConnectWithSimplifiedURLs(t *testing.T) {
urls := []string{
"nats://127.0.0.1:4222",
"nats://127.0.0.1:",
"nats://127.0.0.1",
"127.0.0.1:",
"127.0.0.1",
}
connect := func(t *testing.T, url string, useRootCA bool) {
t.Helper()
var opt nats.Option
if useRootCA {
opt = nats.RootCAs("./configs/certs/ca.pem")
}
nc, err := nats.Connect(url, opt)
if err != nil {
t.Fatalf("URL %q expected to connect, got %v", url, err)
}
nc.Close()
}
// Start a server that listens on default port 4222.
s := RunDefaultServer()
defer s.Shutdown()
// Try for every connection in the urls array.
for _, u := range urls {
connect(t, u, false)
}
s.Shutdown()
// Use this to build the options for us...
s, opts := RunServerWithConfig("configs/tls.conf")
s.Shutdown()
// Now change listen port to 4222 and remove auth
opts.Port = 4222
opts.Username = ""
opts.Password = ""
// and restart the server
s = RunServerWithOptions(opts)
defer s.Shutdown()
// Test again against a server that wants TLS and check
// that we automatically switch to Secure.
for _, u := range urls {
connect(t, u, true)
}
}
func TestNilOpts(t *testing.T) {
s := RunDefaultServer()
defer s.Shutdown()
// Test a single nil option
var o1, o2, o3 nats.Option
nc, err := nats.Connect(nats.DefaultURL, o1)
if err != nil {
t.Fatalf("Unexpected error with one nil option: %v", err)
}
nc.Close()
// Test nil, opt, nil
o2 = nats.ReconnectBufSize(2222)
nc, err = nats.Connect(nats.DefaultURL, o1, o2, o3)
if err != nil {
t.Fatalf("Unexpected error with multiple nil options: %v", err)
}
defer nc.Close()
// check that the opt was set
if nc.Opts.ReconnectBufSize != 2222 {
t.Fatal("Unexpected error: option not set.")
}
}
func TestGetClientID(t *testing.T) {
if serverVersionAtLeast(1, 2, 0) != nil {
t.SkipNow()
}
optsA := test.DefaultTestOptions
optsA.Port = -1
optsA.Cluster.Port = -1
optsA.Cluster.Name = "test"
srvA := RunServerWithOptions(&optsA)
defer srvA.Shutdown()
ch := make(chan bool, 1)
nc1, err := nats.Connect(srvA.ClientURL(),
nats.DiscoveredServersHandler(func(_ *nats.Conn) {
ch <- true
}),
nats.ReconnectHandler(func(_ *nats.Conn) {
ch <- true
}))
if err != nil {
t.Fatalf("Error on connect: %v", err)
}
defer nc1.Close()
cid, err := nc1.GetClientID()
if err != nil {
t.Fatalf("Error getting CID: %v", err)
}
if cid == 0 {
t.Fatal("Unexpected cid value, make sure server is 1.2.0+")
}
// Start a second server and verify that async INFO contains client ID
optsB := test.DefaultTestOptions
optsB.Port = -1
optsB.Cluster.Port = -1
optsB.Cluster.Name = "test"
optsB.Routes = server.RoutesFromStr(fmt.Sprintf("nats://127.0.0.1:%d", srvA.ClusterAddr().Port))
srvB := RunServerWithOptions(&optsB)
defer srvB.Shutdown()
// Wait for the discovered callback to fire
if err := Wait(ch); err != nil {
t.Fatal("Did not fire the discovered callback")
}
// Now check CID should be valid and same as before
newCID, err := nc1.GetClientID()
if err != nil {
t.Fatalf("Error getting CID: %v", err)
}
if newCID != cid {
t.Fatalf("Expected CID to be %v, got %v", cid, newCID)
}
// Create a client to server B
nc2, err := nats.Connect(srvB.ClientURL())
if err != nil {
t.Fatalf("Error on connect: %v", err)
}
defer nc2.Close()
// Stop server A, nc1 will reconnect to B, and should have different CID
srvA.Shutdown()
// Wait for nc1 to reconnect
if err := Wait(ch); err != nil {
t.Fatal("Did not reconnect")
}
newCID, err = nc1.GetClientID()
if err != nil {
t.Fatalf("Error getting CID: %v", err)
}
if newCID == 0 {
t.Fatal("Unexpected cid value, make sure server is 1.2.0+")
}
if newCID == cid {
t.Fatalf("Expected different CID since server already had a client")
}
nc1.Close()
newCID, err = nc1.GetClientID()
if err == nil {
t.Fatalf("Expected error, got none")
}
if newCID != 0 {
t.Fatalf("Expected 0 on connection closed, got %v", newCID)
}
// Stop clients and remaining server
nc1.Close()
nc2.Close()
srvB.Shutdown()
// Now have dummy server that returns no CID and check we get expected error.
l, e := net.Listen("tcp", "127.0.0.1:0")
if e != nil {
t.Fatal("Could not listen on an ephemeral port")
}
tl := l.(*net.TCPListener)
defer tl.Close()
addr := tl.Addr().(*net.TCPAddr)
wg := sync.WaitGroup{}
wg.Add(1)
errCh := make(chan error, 1)
go func() {
defer wg.Done()
conn, err := l.Accept()
if err != nil {
errCh <- fmt.Errorf("error accepting client connection: %v", err)
return
}
defer conn.Close()
info := fmt.Sprintf("INFO {\"server_id\":\"foobar\",\"host\":\"%s\",\"port\":%d,\"auth_required\":false,\"tls_required\":false,\"max_payload\":1048576}\r\n", addr.IP, addr.Port)
conn.Write([]byte(info))
// Read connect and ping commands sent from the client
line := make([]byte, 256)
_, err = conn.Read(line)
if err != nil {
errCh <- fmt.Errorf("expected CONNECT and PING from client, got: %s", err)
return
}
conn.Write([]byte("PONG\r\n"))
// Now wait to be notified that we can finish
<-ch
}()
nc, err := nats.Connect(fmt.Sprintf("nats://127.0.0.1:%d", addr.Port))
if err != nil {
t.Fatalf("Error on connect: %v", err)
}
defer nc.Close()
if cid, err := nc.GetClientID(); err != nats.ErrClientIDNotSupported || cid != 0 {
t.Fatalf("Expected err=%v and cid=0, got err=%v and cid=%v", nats.ErrClientIDNotSupported, err, cid)
}
// Release fake server
nc.Close()
ch <- true
wg.Wait()
checkErrChannel(t, errCh)
}
func TestTLSDontSkipVerify(t *testing.T) {
s, opts := RunServerWithConfig("./configs/tls_noip_a.conf")
defer s.Shutdown()
// Connect with nats:// prefix to a server that requires TLS.
// The library will automatically switch to TLS, but we should
// not skip hostname verification.
sURL := fmt.Sprintf("nats://derek:porkchop@127.0.0.1:%d", opts.Port)
nc, err := nats.Connect(sURL, nats.RootCAs("./configs/certs/ca.pem"))
// Verify that error is about hostname verification
if err == nil || !strings.Contains(err.Error(), "IP SAN") {
if nc != nil {
nc.Close()
}
t.Fatalf("Expected error about hostname verification, got %v", err)
}
// Check that we can override skip verify by providing our own TLS Config.
nc, err = nats.Connect(sURL, nats.RootCAs("./configs/certs/ca.pem"),
nats.Secure(&tls.Config{InsecureSkipVerify: true}))
if err != nil {
t.Fatalf("Error on connect: %v", err)
}
nc.Close()
// Now change the URL to include hostname and verify that using
// nats:// scheme does work.
sURL = fmt.Sprintf("nats://derek:porkchop@%s:%d", opts.Host, opts.Port)
nc, err = nats.Connect(sURL, nats.RootCAs("./configs/certs/ca.pem"))
if err != nil {
t.Fatalf("Error on connect: %v", err)
}
nc.Close()
}
func TestRetryOnFailedConnect(t *testing.T) {
nc, err := nats.Connect(nats.DefaultURL)
if err == nil {
nc.Close()
t.Fatal("Expected error, did not get one")
}
reconnectedCh := make(chan bool, 1)
connectedCh := make(chan bool, 1)
dch := make(chan bool, 1)
nc, err = nats.Connect(nats.DefaultURL,
nats.RetryOnFailedConnect(true),
nats.MaxReconnects(-1),
nats.ReconnectWait(15*time.Millisecond),
nats.DisconnectErrHandler(func(_ *nats.Conn, _ error) {
dch <- true
}),
nats.ConnectHandler(func(_ *nats.Conn) {
connectedCh <- true
}),
nats.ReconnectHandler(func(_ *nats.Conn) {
reconnectedCh <- true
}),
nats.NoCallbacksAfterClientClose())
if err != nil {
t.Fatalf("Unexpected error: %v", err)
}
sub, err := nc.SubscribeSync("foo")
if err != nil {
t.Fatalf("Error on subscribe: %v", err)
}
if err := nc.Publish("foo", []byte("msg")); err != nil {
t.Fatalf("Error on publish: %v", err)
}
for i := 0; i < 2; i++ {
// Start server now
s := RunDefaultServer()
defer s.Shutdown()
switch i {
case 0:
select {
case <-connectedCh:
case <-time.After(2 * time.Second):
t.Fatal("Should have connected")
}
case 1:
select {
case <-reconnectedCh:
case <-time.After(2 * time.Second):
t.Fatal("Should have reconnected")
}
}
// Now make sure that the pub worked and sub worked.
// We should receive the message we have published.
if _, err := sub.NextMsg(time.Second); err != nil {
t.Fatalf("Iter=%v - did not receive message: %v", i, err)
}
// Check that normal disconnect/reconnect works as expected
s.Shutdown()
select {
case <-dch:
case <-time.After(time.Second):
t.Fatal("Should have been disconnected")
}
if i == 0 {
if err := nc.Publish("foo", []byte("msg")); err != nil {
t.Fatalf("Iter=%v - error on publish: %v", i, err)
}
}
}
nc.Close()
// Try again but this time we will restart a server with u/p and auth should fail.
closedCh := make(chan bool, 1)
nc, err = nats.Connect(nats.DefaultURL,
nats.RetryOnFailedConnect(true),
nats.MaxReconnects(-1),
nats.ReconnectWait(15*time.Millisecond),
nats.ReconnectHandler(func(_ *nats.Conn) {
reconnectedCh <- true
}),
nats.ClosedHandler(func(_ *nats.Conn) {
closedCh <- true
}))
if err != nil {
t.Fatalf("Unexpected error: %v", err)
}
defer nc.Close()
o := test.DefaultTestOptions
o.Host = "127.0.0.1"
o.Port = 4222
o.Username = "user"
o.Password = "password"
s := RunServerWithOptions(&o)
defer s.Shutdown()
select {
case <-closedCh:
case <-time.After(2 * time.Second):
t.Fatal("Should have stopped trying to connect due to auth failure")
}
// Make sure that we did not get the (re)connected CB
select {
case <-reconnectedCh:
t.Fatal("(re)connected callback should not have been invoked")
default:
}
}
func TestRetryOnFailedConnectWithTLSError(t *testing.T) {
opts := test.DefaultTestOptions
opts.Port = 4222
tc := &server.TLSConfigOpts{
CertFile: "./configs/certs/server.pem",
KeyFile: "./configs/certs/key.pem",
CaFile: "./configs/certs/ca.pem",
}
var err error
if opts.TLSConfig, err = server.GenTLSConfig(tc); err != nil {
t.Fatalf("Can't build TLCConfig: %v", err)
}
opts.TLSTimeout = 0.0001
s := RunServerWithOptions(&opts)
defer s.Shutdown()
connectedCh := make(chan bool, 1)
nc, err := nats.Connect(nats.DefaultURL,
nats.Secure(&tls.Config{InsecureSkipVerify: true}),
nats.RetryOnFailedConnect(true),
nats.MaxReconnects(-1),
nats.ReconnectWait(15*time.Millisecond),
nats.ConnectHandler(func(_ *nats.Conn) {
connectedCh <- true
}),
nats.NoCallbacksAfterClientClose())
if err != nil {
t.Fatalf("Unexpected error: %v", err)
}
defer nc.Close()
// Wait for several failed attempts
time.Sleep(100 * time.Millisecond)
// Replace tls timeout to a reasonable value.
s.Shutdown()
opts.TLSTimeout = 2.0
s = RunServerWithOptions(&opts)
defer s.Shutdown()
select {
case <-connectedCh:
case <-time.After(time.Second):
t.Fatal("Should have connected")
}
}
func TestConnStatusChangedEvents(t *testing.T) {
t.Run("default events", func(t *testing.T) {
s := RunDefaultServer()
nc, err := nats.Connect(s.ClientURL())
if err != nil {
t.Fatalf("Unexpected error: %s", err)
}
statusCh := nc.StatusChanged()
defer close(statusCh)
newStatus := make(chan nats.Status, 10)
// non-blocking channel, so we need to be constantly listening
go func() {
for {
s, ok := <-statusCh
if !ok {
return
}
newStatus <- s
}
}()
time.Sleep(50 * time.Millisecond)
s.Shutdown()
WaitOnChannel(t, newStatus, nats.RECONNECTING)
s = RunDefaultServer()
defer s.Shutdown()
WaitOnChannel(t, newStatus, nats.CONNECTED)
nc.Close()
WaitOnChannel(t, newStatus, nats.CLOSED)
select {
case s := <-newStatus:
t.Fatalf("Unexpected status received: %s", s)
case <-time.After(100 * time.Millisecond):
}
})
t.Run("custom event only", func(t *testing.T) {
s := RunDefaultServer()
nc, err := nats.Connect(s.ClientURL())
if err != nil {
t.Fatalf("Unexpected error: %s", err)
}
statusCh := nc.StatusChanged(nats.CLOSED)
defer close(statusCh)
newStatus := make(chan nats.Status, 10)
// non-blocking channel, so we need to be constantly listening
go func() {
for {
s, ok := <-statusCh
if !ok {
return
}
newStatus <- s
}
}()
time.Sleep(50 * time.Millisecond)
s.Shutdown()
s = RunDefaultServer()
defer s.Shutdown()
nc.Close()
WaitOnChannel(t, newStatus, nats.CLOSED)
select {
case s := <-newStatus:
t.Fatalf("Unexpected status received: %s", s)
case <-time.After(100 * time.Millisecond):
}
})
t.Run("do not block on channel if it's not used", func(t *testing.T) {
s := RunDefaultServer()
nc, err := nats.Connect(s.ClientURL())
if err != nil {
t.Fatalf("Unexpected error: %s", err)
}
defer nc.Close()
// do not use the returned channel, client should never block
_ = nc.StatusChanged()
s.Shutdown()
s = RunDefaultServer()
defer s.Shutdown()
if err := nc.Publish("foo", []byte("msg")); err != nil {
t.Fatalf("Unexpected error: %v", err)
}
time.Sleep(100 * time.Millisecond)
})
}
func TestTLSHandshakeFirst(t *testing.T) {
s, opts := RunServerWithConfig("./configs/tls.conf")
defer s.Shutdown()
secureURL := fmt.Sprintf("tls://derek:porkchop@localhost:%d", opts.Port)
nc, err := nats.Connect(secureURL,
nats.RootCAs("./configs/certs/ca.pem"),
nats.TLSHandshakeFirst())
if err == nil || !strings.Contains(err.Error(), "TLS handshake") {
if err == nil {
nc.Close()
}
t.Fatalf("Expected error about not being a TLS handshake, got %v", err)
}
tc := &server.TLSConfigOpts{
CertFile: "./configs/certs/server.pem",
KeyFile: "./configs/certs/key.pem",
}
tlsConf, err := server.GenTLSConfig(tc)
if err != nil {
t.Fatalf("Can't build TLCConfig: %v", err)
}
tlsConf.ServerName = "localhost"
// Start a mockup server that will do the TLS handshake first
// and then send the INFO protocol.
l, e := net.Listen("tcp", ":0")
if e != nil {
t.Fatal("Could not listen on an ephemeral port")
}
tl := l.(*net.TCPListener)
defer tl.Close()
addr := tl.Addr().(*net.TCPAddr)
errCh := make(chan error, 1)
doneCh := make(chan struct{})
wg := sync.WaitGroup{}
wg.Add(1)
go func() {
defer wg.Done()
conn, err := l.Accept()
if err != nil {
errCh <- fmt.Errorf("error accepting client connection: %v", err)
return
}
defer conn.Close()
// Do the TLS handshake now.
conn = tls.Server(conn, tlsConf)
tlsconn := conn.(*tls.Conn)
if err := tlsconn.Handshake(); err != nil {
errCh <- fmt.Errorf("Server error during handshake: %v", err)
return
}
// Send back the INFO
info := fmt.Sprintf("INFO {\"server_id\":\"foobar\",\"host\":\"localhost\",\"port\":%d,\"auth_required\":false,\"tls_required\":true,\"tls_available\":true,\"tls_verify\":true,\"max_payload\":1048576}\r\n", addr.Port)
tlsconn.Write([]byte(info))
// Read connect and ping commands sent from the client
line := make([]byte, 256)
_, err = tlsconn.Read(line)
if err != nil {
errCh <- fmt.Errorf("expected CONNECT and PING from client, got: %s", err)
return
}
tlsconn.Write([]byte("PONG\r\n"))
// Wait for the signal that client is ok
<-doneCh
// Server is done now.
errCh <- nil
}()
time.Sleep(100 * time.Millisecond)
secureURL = fmt.Sprintf("tls://derek:porkchop@localhost:%d", addr.Port)
nc, err = nats.Connect(secureURL,
nats.RootCAs("./configs/certs/ca.pem"),
nats.TLSHandshakeFirst())
if err != nil {
wg.Wait()
e := <-errCh
t.Fatalf("Unexpected error: %v (server error=%s)", err, e.Error())
}
state, err := nc.TLSConnectionState()
if err != nil {
t.Fatalf("Expected connection state: %v", err)
}
if !state.HandshakeComplete {
t.Fatalf("Expected valid connection state")
}
nc.Close()
close(doneCh)
wg.Wait()
select {
case e := <-errCh:
if e != nil {
t.Fatalf("Error from server: %v", err)
}
case <-time.After(2 * time.Second):
t.Fatal("Server did not exit")
}
}