1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339
|
// Copyright 2022-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 (
"context"
"errors"
"fmt"
"net"
"net/url"
"os"
"strconv"
"strings"
"sync"
"testing"
"time"
"github.com/nats-io/nats-server/v2/server"
"github.com/nats-io/nats.go"
"github.com/nats-io/nats.go/jetstream"
natsserver "github.com/nats-io/nats-server/v2/test"
)
type jsServer struct {
*server.Server
myopts *server.Options
restart sync.Mutex
}
// Restart can be used to start again a server
// using the same listen address as before.
func (srv *jsServer) Restart() {
srv.restart.Lock()
defer srv.restart.Unlock()
srv.Server = natsserver.RunServer(srv.myopts)
}
// Dumb wait program to sync on callbacks, etc... Will timeout
func Wait(ch chan bool) error {
return WaitTime(ch, 5*time.Second)
}
// Wait for a chan with a timeout.
func WaitTime(ch chan bool, timeout time.Duration) error {
select {
case <-ch:
return nil
case <-time.After(timeout):
}
return errors.New("timeout")
}
////////////////////////////////////////////////////////////////////////////////
// Creating client connections
////////////////////////////////////////////////////////////////////////////////
// NewDefaultConnection
func NewDefaultConnection(t *testing.T) *nats.Conn {
return NewConnection(t, nats.DefaultPort)
}
// NewConnection forms connection on a given port.
func NewConnection(t *testing.T, port int) *nats.Conn {
url := fmt.Sprintf("nats://127.0.0.1:%d", port)
nc, err := nats.Connect(url)
if err != nil {
t.Fatalf("Failed to create default connection: %v\n", err)
return nil
}
return nc
}
////////////////////////////////////////////////////////////////////////////////
// Running nats server in separate Go routines
////////////////////////////////////////////////////////////////////////////////
// RunDefaultServer will run a server on the default port.
func RunDefaultServer() *server.Server {
return RunServerOnPort(nats.DefaultPort)
}
// RunServerOnPort will run a server on the given port.
func RunServerOnPort(port int) *server.Server {
opts := natsserver.DefaultTestOptions
opts.Port = port
opts.Cluster.Name = "testing"
return RunServerWithOptions(opts)
}
// RunServerWithOptions will run a server with the given options.
func RunServerWithOptions(opts server.Options) *server.Server {
return natsserver.RunServer(&opts)
}
// RunServerWithConfig will run a server with the given configuration file.
func RunServerWithConfig(configFile string) (*server.Server, *server.Options) {
return natsserver.RunServerWithConfig(configFile)
}
func RunBasicJetStreamServer() *server.Server {
opts := natsserver.DefaultTestOptions
opts.Port = -1
opts.JetStream = true
return RunServerWithOptions(opts)
}
func createConfFile(t *testing.T, content []byte) string {
t.Helper()
conf, err := os.CreateTemp("", "")
if err != nil {
t.Fatalf("Error creating conf file: %v", err)
}
fName := conf.Name()
if err := conf.Close(); err != nil {
t.Fatalf("Unexpected error: %v", err)
}
if err := os.WriteFile(fName, content, 0666); err != nil {
if err := os.Remove(fName); err != nil {
t.Fatalf("Unexpected error: %v", err)
}
t.Fatalf("Error writing conf file: %v", err)
}
return fName
}
func shutdownJSServerAndRemoveStorage(t *testing.T, s *server.Server) {
t.Helper()
var sd string
if config := s.JetStreamConfig(); config != nil {
sd = config.StoreDir
}
s.Shutdown()
if sd != "" {
if err := os.RemoveAll(sd); err != nil {
t.Fatalf("Unable to remove storage %q: %v", sd, err)
}
}
s.WaitForShutdown()
}
func setupJSClusterWithSize(t *testing.T, clusterName string, size int) []*jsServer {
t.Helper()
nodes := make([]*jsServer, size)
opts := make([]*server.Options, 0)
var activeListeners []net.Listener
getAddr := func(t *testing.T) (string, string, int) {
l, err := net.Listen("tcp", "127.0.0.1:0")
if err != nil {
t.Fatalf("Unexpected error: %v", err)
}
addr := l.Addr()
host := addr.(*net.TCPAddr).IP.String()
port := addr.(*net.TCPAddr).Port
time.Sleep(100 * time.Millisecond)
// we cannot close the listener immediately to avoid duplicate port binding
// the returned net.Listener has to be closed after all ports are drawn
activeListeners = append(activeListeners, l)
return addr.String(), host, port
}
routes := []string{}
for i := 0; i < size; i++ {
o := natsserver.DefaultTestOptions
o.JetStream = true
o.ServerName = fmt.Sprintf("NODE_%d", i)
tdir, err := os.MkdirTemp(os.TempDir(), fmt.Sprintf("%s_%s-", o.ServerName, clusterName))
if err != nil {
t.Fatal(err)
}
o.StoreDir = tdir
if size > 1 {
o.Cluster.Name = clusterName
_, host1, port1 := getAddr(t)
o.Host = host1
o.Port = port1
addr2, host2, port2 := getAddr(t)
o.Cluster.Host = host2
o.Cluster.Port = port2
o.Tags = []string{o.ServerName}
routes = append(routes, fmt.Sprintf("nats://%s", addr2))
}
opts = append(opts, &o)
}
// close all connections used to randomize ports
for _, l := range activeListeners {
l.Close()
}
if size > 1 {
routesStr := server.RoutesFromStr(strings.Join(routes, ","))
for i, o := range opts {
o.Routes = routesStr
nodes[i] = &jsServer{Server: natsserver.RunServer(o), myopts: o}
}
} else {
o := opts[0]
nodes[0] = &jsServer{Server: natsserver.RunServer(o), myopts: o}
}
// Wait until JS is ready.
srvA := nodes[0]
nc, err := nats.Connect(srvA.ClientURL())
if err != nil {
t.Error(err)
}
waitForJSReady(t, nc)
nc.Close()
return nodes
}
func waitForJSReady(t *testing.T, nc *nats.Conn) {
var err error
timeout := time.Now().Add(10 * time.Second)
for time.Now().Before(timeout) {
// Use a smaller MaxWait here since if it fails, we don't want
// to wait for too long since we are going to try again.
js, err := nc.JetStream(nats.MaxWait(250 * time.Millisecond))
if err != nil {
t.Fatal(err)
}
_, err = js.AccountInfo()
if err != nil {
continue
}
return
}
t.Fatalf("Timeout waiting for JS to be ready: %v", err)
}
func withJSClusterAndStream(t *testing.T, clusterName string, size int, stream jetstream.StreamConfig, tfn func(t *testing.T, subject string, srvs ...*jsServer)) {
t.Helper()
withJSCluster(t, clusterName, size, func(t *testing.T, nodes ...*jsServer) {
srvA := nodes[0]
nc, err := nats.Connect(srvA.ClientURL())
if err != nil {
t.Error(err)
}
defer nc.Close()
ctx, cancel := context.WithTimeout(context.Background(), 10*time.Second)
defer cancel()
jsm, err := jetstream.New(nc)
if err != nil {
t.Fatal(err)
}
CreateStream:
for {
select {
case <-ctx.Done():
if err != nil {
t.Fatalf("Unexpected error creating stream: %v", err)
}
t.Fatalf("Unable to create stream on cluster")
case <-time.After(500 * time.Millisecond):
_, err = jsm.AccountInfo(ctx)
if err != nil {
// Backoff for a bit until cluster and resources are ready.
time.Sleep(500 * time.Millisecond)
}
_, err = jsm.CreateStream(ctx, stream)
if err != nil {
continue CreateStream
}
break CreateStream
}
}
tfn(t, stream.Name, nodes...)
})
}
func withJSCluster(t *testing.T, clusterName string, size int, tfn func(t *testing.T, srvs ...*jsServer)) {
t.Helper()
nodes := setupJSClusterWithSize(t, clusterName, size)
defer func() {
// Ensure that they get shutdown and remove their state.
for _, node := range nodes {
node.restart.Lock()
shutdownJSServerAndRemoveStorage(t, node.Server)
node.restart.Unlock()
}
}()
tfn(t, nodes...)
}
func restartBasicJSServer(t *testing.T, s *server.Server) *server.Server {
opts := natsserver.DefaultTestOptions
clientURL, err := url.Parse(s.ClientURL())
if err != nil {
t.Fatalf("Unexpected error: %v", err)
}
port, err := strconv.Atoi(clientURL.Port())
if err != nil {
t.Fatalf("Unexpected error: %v", err)
}
opts.Port = port
opts.JetStream = true
opts.StoreDir = s.JetStreamConfig().StoreDir
s.Shutdown()
s.WaitForShutdown()
return RunServerWithOptions(opts)
}
func checkFor(t *testing.T, totalWait, sleepDur time.Duration, f func() error) {
t.Helper()
timeout := time.Now().Add(totalWait)
var err error
for time.Now().Before(timeout) {
err = f()
if err == nil {
return
}
time.Sleep(sleepDur)
}
if err != nil {
t.Fatal(err.Error())
}
}
|