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 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418
|
package amqp
import (
"context"
"fmt"
"testing"
"time"
"github.com/Azure/go-amqp/internal/bitmap"
"github.com/Azure/go-amqp/internal/encoding"
"github.com/Azure/go-amqp/internal/fake"
"github.com/Azure/go-amqp/internal/frames"
"github.com/Azure/go-amqp/internal/queue"
"github.com/Azure/go-amqp/internal/test"
"github.com/stretchr/testify/require"
)
func TestLinkFlowThatNeedsToReplenishCredits(t *testing.T) {
for times := 0; times < 100; times++ {
l := newTestLink(t)
l.l.linkCredit = 2
waitForCredit := make(chan struct{})
go l.mux(receiverTestHooks{
MuxStart: func() {
<-waitForCredit
},
})
err := l.IssueCredit(1)
require.Error(t, err, "issueCredit can only be used with receiver links using manual credit management")
// we've consumed half of the maximum credit we're allowed to have - reflow!
l.l.linkCredit = 1
l.unsettledMessages = map[string]struct{}{}
close(waitForCredit)
l.onSettlement(1)
ctx, cancel := context.WithTimeout(context.Background(), 1*time.Second)
Loop:
for {
// the first flow frame we receive isn't always the one with the updated credit.
// to avoid the race, we continue to receive frames until we get the flow frame
// with the correct value, a wrong frame, or the context expires.
select {
case txFrame := <-l.l.session.tx:
switch frame := txFrame.FrameBody.(type) {
case *frames.PerformFlow:
require.False(t, frame.Drain)
// replenished credits: l.receiver.maxCredit-uint32(l.countUnsettled())
if *frame.LinkCredit == 2 {
break Loop
}
default:
require.Fail(t, fmt.Sprintf("Unexpected frame was transferred: %+v", txFrame))
}
case <-ctx.Done():
t.Fatal(ctx.Err())
}
}
cancel()
closeTestLink(&l.l)
<-l.l.done
}
}
func TestLinkFlowWithZeroCredits(t *testing.T) {
l := newTestLink(t)
muxSem := test.NewMuxSemaphore(0)
go l.mux(receiverTestHooks{
MuxSelect: func() {
muxSem.OnLoop()
},
})
defer closeTestLink(&l.l)
err := l.IssueCredit(1)
require.Error(t, err, "issueCredit can only be used with receiver links using manual credit management")
muxSem.Wait()
// and flow goes through the non-manual credit path
require.EqualValues(t, 0, l.l.linkCredit, "No link credits have been added")
l.l.linkCredit = 0
l.unsettledMessages = map[string]struct{}{
"hello": {},
"hello2": {},
}
muxSem.Release(0)
select {
case l.receiverReady <- struct{}{}:
// woke up mux
default:
t.Fatal("failed to wake up mux")
}
muxSem.Wait()
require.Zero(t, l.l.linkCredit)
muxSem.Release(-1)
}
func TestLinkFlowWithManualCreditor(t *testing.T) {
l := newTestLink(t)
l.autoSendFlow = false
l.l.linkCredit = 1
go l.mux(receiverTestHooks{})
defer closeTestLink(&l.l)
require.NoError(t, l.IssueCredit(100))
// flow happens immmediately in 'mux'
txFrame := <-l.l.session.tx
switch frame := txFrame.FrameBody.(type) {
case *frames.PerformFlow:
require.False(t, frame.Drain)
require.EqualValues(t, 100+1, *frame.LinkCredit)
default:
require.Fail(t, fmt.Sprintf("Unexpected frame was transferred: %+v", txFrame))
}
}
func TestLinkFlowWithManualCreditorAndNoFlowNeeded(t *testing.T) {
l := newTestLink(t)
l.autoSendFlow = false
l.l.linkCredit = 1
go l.mux(receiverTestHooks{})
defer closeTestLink(&l.l)
select {
case l.receiverReady <- struct{}{}:
// woke up mux
default:
t.Fatal("failed to wake up mux")
}
// flow happens immmediately in 'mux'
select {
case fr := <-l.l.session.tx: // there won't be a flow this time.
require.Failf(t, "No flow frame would be needed since no link credits were added and drain was not requested", "Frame was %+v", fr)
case <-time.After(time.Second * 2):
// this is the expected case since no frame will be sent.
}
}
func TestMuxFlowHandlesDrainProperly(t *testing.T) {
l := newTestLink(t)
l.autoSendFlow = false
l.l.linkCredit = 101
// simulate what our 'drain' call to muxFlow would look like
// when draining
require.NoError(t, l.muxFlow(0, true))
require.EqualValues(t, 101, l.l.linkCredit, "credits are untouched when draining")
// when doing a non-drain flow we update the linkCredit to our new link credit total.
require.NoError(t, l.muxFlow(501, false))
require.EqualValues(t, 501, l.l.linkCredit, "credits are untouched when draining")
}
func newTestLink(t *testing.T) *Receiver {
fakeConn := fake.NewNetConn(receiverFrameHandlerNoUnhandled(0, ReceiverSettleModeFirst))
ctx, cancel := context.WithTimeout(context.Background(), 1*time.Second)
conn, err := NewConn(ctx, fakeConn, nil)
require.NoError(t, err)
cancel()
// we don't need a functioning Conn for tests that use newTestLink, just a non-nil one that can be Close()'ed
// TODO: convert these tests to use a fake
err = conn.Close()
require.NoError(t, err)
l := &Receiver{
l: link{
source: &frames.Source{},
// adding just enough so the debug() print will still work...
// debug(1, "FLOW Link Mux half: source: %s, inflight: %d, credit: %d, deliveryCount: %d, messages: %d, unsettled: %d, maxCredit : %d, settleMode: %s", l.source.Address, l.receiver.inFlight.len(), l.l.linkCredit, l.deliveryCount, len(l.messages), l.countUnsettled(), l.receiver.maxCredit, l.receiverSettleMode.String())
done: make(chan struct{}),
session: &Session{
tx: make(chan frameBodyEnvelope, 100),
done: make(chan struct{}),
conn: conn,
outputHandles: bitmap.New(32),
},
rxQ: queue.NewHolder(queue.New[frames.FrameBody](100)),
close: make(chan struct{}),
},
autoSendFlow: true,
inFlight: inFlight{},
receiverReady: make(chan struct{}, 1),
}
l.messagesQ = queue.NewHolder(queue.New[Message](100))
return l
}
func closeTestLink(l *link) {
close(l.close)
q := l.rxQ.Acquire()
q.Enqueue(&frames.PerformDetach{Handle: l.outputHandle, Closed: true})
l.rxQ.Release(q)
}
func TestNewSendingLink(t *testing.T) {
const (
name = "mysender"
targetAddr = "target"
)
tests := []struct {
label string
opts SenderOptions
validate func(t *testing.T, l *Sender)
}{
{
label: "default options",
validate: func(t *testing.T, l *Sender) {
require.Empty(t, l.l.target.Capabilities)
require.Equal(t, DurabilityNone, l.l.source.Durable)
require.False(t, l.l.dynamicAddr)
require.Empty(t, l.l.source.ExpiryPolicy)
require.Zero(t, l.l.source.Timeout)
require.NotEmpty(t, l.l.key.name)
require.Empty(t, l.l.properties)
require.Nil(t, l.l.senderSettleMode)
require.Nil(t, l.l.receiverSettleMode)
require.Equal(t, targetAddr, l.l.target.Address)
},
},
{
label: "with options",
opts: SenderOptions{
Capabilities: []string{"foo", "bar"},
Durability: DurabilityUnsettledState,
DynamicAddress: true,
ExpiryPolicy: ExpiryPolicyLinkDetach,
ExpiryTimeout: 5,
Name: name,
Properties: map[string]any{
"property": 123,
},
RequestedReceiverSettleMode: ReceiverSettleModeFirst.Ptr(),
SettlementMode: SenderSettleModeSettled.Ptr(),
},
validate: func(t *testing.T, l *Sender) {
require.Equal(t, encoding.MultiSymbol{"foo", "bar"}, l.l.source.Capabilities)
require.Equal(t, DurabilityUnsettledState, l.l.source.Durable)
require.True(t, l.l.dynamicAddr)
require.Equal(t, ExpiryPolicyLinkDetach, l.l.source.ExpiryPolicy)
require.Equal(t, uint32(5), l.l.source.Timeout)
require.Equal(t, name, l.l.key.name)
require.Equal(t, map[encoding.Symbol]any{
"property": 123,
}, l.l.properties)
require.NotNil(t, l.l.senderSettleMode)
require.Equal(t, SenderSettleModeSettled, *l.l.senderSettleMode)
require.NotNil(t, l.l.receiverSettleMode)
require.Equal(t, ReceiverSettleModeFirst, *l.l.receiverSettleMode)
require.Empty(t, l.l.target.Address)
},
},
}
for _, tt := range tests {
t.Run(tt.label, func(t *testing.T) {
got, err := newSender(targetAddr, &Session{}, &tt.opts)
require.NoError(t, err)
require.NotNil(t, got)
tt.validate(t, got)
})
}
}
func TestNewReceivingLink(t *testing.T) {
const (
name = "myreceiver"
sourceAddr = "source"
)
// skip validating any fields on l.receiver as they are
// populated in Session.NewReceiver()
tests := []struct {
label string
opts ReceiverOptions
validate func(t *testing.T, l *Receiver)
wantSource *frames.Source
wantTarget *frames.Target
wantProperties map[encoding.Symbol]any
}{
{
label: "default options",
validate: func(t *testing.T, l *Receiver) {
//require.False(t, l.receiver.batching)
//require.Equal(t, defaultLinkBatchMaxAge, l.receiver.batchMaxAge)
require.Empty(t, l.l.target.Capabilities)
//require.Equal(t, defaultLinkCredit, l.receiver.maxCredit)
require.Equal(t, DurabilityNone, l.l.target.Durable)
require.False(t, l.l.dynamicAddr)
require.Empty(t, l.l.target.ExpiryPolicy)
require.Zero(t, l.l.target.Timeout)
require.Empty(t, l.l.source.Filter)
//require.Nil(t, l.receiver.manualCreditor)
require.Zero(t, l.l.maxMessageSize)
require.NotEmpty(t, l.l.key.name)
require.Empty(t, l.l.properties)
require.Nil(t, l.l.senderSettleMode)
require.Nil(t, l.l.receiverSettleMode)
require.Equal(t, sourceAddr, l.l.source.Address)
},
},
{
label: "with options",
opts: ReceiverOptions{
//Batching: true,
//BatchMaxAge: 1 * time.Minute,
Capabilities: []string{"foo", "bar"},
//Credit: 32,
Durability: DurabilityConfiguration,
DynamicAddress: true,
ExpiryPolicy: ExpiryPolicyNever,
ExpiryTimeout: 3,
Filters: []LinkFilter{
NewSelectorFilter("amqp.annotation.x-opt-offset > '100'"),
NewLinkFilter("com.microsoft:session-filter", 0x00000137000000C, "123"),
},
//ManualCredits: true,
MaxMessageSize: 1024,
Name: name,
Properties: map[string]any{
"property": 123,
},
RequestedSenderSettleMode: SenderSettleModeMixed.Ptr(),
SettlementMode: ReceiverSettleModeSecond.Ptr(),
},
validate: func(t *testing.T, l *Receiver) {
//require.True(t, l.receiver.batching)
//require.Equal(t, 1*time.Minute, l.receiver.batchMaxAge)
require.Equal(t, encoding.MultiSymbol{"foo", "bar"}, l.l.target.Capabilities)
//require.Equal(t, uint32(32), l.receiver.maxCredit)
require.Equal(t, DurabilityConfiguration, l.l.target.Durable)
require.True(t, l.l.dynamicAddr)
require.Equal(t, ExpiryPolicyNever, l.l.target.ExpiryPolicy)
require.Equal(t, uint32(3), l.l.target.Timeout)
require.Equal(t, encoding.Filter{
selectorFilter: &encoding.DescribedType{
Descriptor: selectorFilterCode,
Value: "amqp.annotation.x-opt-offset > '100'",
},
"com.microsoft:session-filter": &encoding.DescribedType{
Descriptor: uint64(0x00000137000000C),
Value: "123",
},
}, l.l.source.Filter)
//require.NotNil(t, l.receiver.manualCreditor)
require.Equal(t, uint64(1024), l.l.maxMessageSize)
require.Equal(t, name, l.l.key.name)
require.Equal(t, map[encoding.Symbol]any{
"property": 123,
}, l.l.properties)
require.NotNil(t, l.l.senderSettleMode)
require.Equal(t, SenderSettleModeMixed, *l.l.senderSettleMode)
require.NotNil(t, l.l.receiverSettleMode)
require.Equal(t, ReceiverSettleModeSecond, *l.l.receiverSettleMode)
require.Empty(t, l.l.source.Address)
},
},
}
for _, tt := range tests {
t.Run(tt.label, func(t *testing.T) {
got, err := newReceiver(sourceAddr, &Session{}, &tt.opts)
require.NoError(t, err)
require.NotNil(t, got)
tt.validate(t, got)
})
}
}
func TestSessionFlowDisablesTransfer(t *testing.T) {
t.Skip("TODO: finish for link testing")
nextIncomingID := uint32(0)
netConn := fake.NewNetConn(senderFrameHandlerNoUnhandled(0, SenderSettleModeUnsettled))
ctx, cancel := context.WithTimeout(context.Background(), 100*time.Millisecond)
client, err := NewConn(ctx, netConn, nil)
cancel()
require.NoError(t, err)
ctx, cancel = context.WithTimeout(context.Background(), 100*time.Millisecond)
session, err := client.NewSession(ctx, nil)
cancel()
require.NoError(t, err)
b, err := fake.EncodeFrame(frames.TypeAMQP, 0, &frames.PerformFlow{
NextIncomingID: &nextIncomingID,
IncomingWindow: 0,
OutgoingWindow: 100,
NextOutgoingID: 1,
})
require.NoError(t, err)
netConn.SendFrame(b)
ctx, cancel = context.WithTimeout(context.Background(), 100*time.Millisecond)
err = session.Close(ctx)
cancel()
require.NoError(t, err)
require.NoError(t, client.Close())
}
// TODO: echo flow frame
|