Skip to content

grpctest: add test coverages of ExitIdle #8375

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 15 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
198 changes: 197 additions & 1 deletion internal/balancergroup/balancergroup_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -484,6 +484,67 @@ func (s) TestBalancerGroupBuildOptions(t *testing.T) {
}
}

func (s) TestBalancerGroup_UpdateClientConnState_AfterClose(t *testing.T) {
balancerName := t.Name()
exitIdleCh := make(chan struct{}, 1)

stub.Register(balancerName, stub.BalancerFuncs{
UpdateClientConnState: func(_ *stub.BalancerData, _ balancer.ClientConnState) error {
exitIdleCh <- struct{}{}
return nil
},
})

bg := New(Options{
CC: testutils.NewBalancerClientConn(t),
BuildOpts: balancer.BuildOptions{},
StateAggregator: nil,
Logger: nil,
})

bg.Add(testBalancerIDs[0], balancer.Get(balancerName))
bg.Close()

if err := bg.UpdateClientConnState(testBalancerIDs[0], balancer.ClientConnState{}); err != nil {
t.Fatalf("Expected nil error, got %v", err)
}

select {
case <-exitIdleCh:
t.Fatalf("UpdateClientConnState was called after BalancerGroup was closed")
case <-time.After(defaultTestShortTimeout):
}
}

func (s) TestBalancerGroup_ResolverError_AfterClose(t *testing.T) {
balancerName := t.Name()
exitIdleCh := make(chan struct{}, 1)

stub.Register(balancerName, stub.BalancerFuncs{
ResolverError: func(_ *stub.BalancerData, _ error) {
exitIdleCh <- struct{}{}
},
})

bg := New(Options{
CC: testutils.NewBalancerClientConn(t),
BuildOpts: balancer.BuildOptions{},
StateAggregator: nil,
Logger: nil,
})

bg.Add(testBalancerIDs[0], balancer.Get(balancerName))
bg.Close()

bg.ResolverError(errors.New("test error"))

select {
case <-exitIdleCh:
t.Fatalf("ResolverError was called on sub-balancer after BalancerGroup was closed")
case <-time.After(defaultTestShortTimeout):
}
}

func (s) TestBalancerExitIdleOne(t *testing.T) {
const balancerName = "stub-balancer-test-balancergroup-exit-idle-one"
exitIdleCh := make(chan struct{}, 1)
Expand All @@ -505,7 +566,7 @@ func (s) TestBalancerExitIdleOne(t *testing.T) {
builder := balancer.Get(balancerName)
bg.Add(testBalancerIDs[0], builder)

// Call ExitIdle on the child policy.
// Call ExitIdleOne on the child policy.
bg.ExitIdleOne(testBalancerIDs[0])
select {
case <-time.After(time.Second):
Expand All @@ -514,6 +575,60 @@ func (s) TestBalancerExitIdleOne(t *testing.T) {
}
}

func (s) TestBalancerGroup_ExitIdleOne_AfterClose(t *testing.T) {
balancerName := t.Name()
exitIdleCh := make(chan struct{})

stub.Register(balancerName, stub.BalancerFuncs{
ExitIdle: func(_ *stub.BalancerData) {
close(exitIdleCh)
},
})

bg := New(Options{
CC: testutils.NewBalancerClientConn(t),
BuildOpts: balancer.BuildOptions{},
StateAggregator: nil,
Logger: nil,
})

bg.Add(testBalancerIDs[0], balancer.Get(balancerName))
bg.Close()
bg.ExitIdleOne(testBalancerIDs[0])

select {
case <-time.After(defaultTestShortTimeout):
case <-exitIdleCh:
t.Fatalf("ExitIdleOne called ExitIdle on sub-balancer after BalancerGroup was closed")
}
}

func (s) TestBalancerGroup_ExitIdleOne_NonExistentID(t *testing.T) {
Copy link
Member

@eshitachandwani eshitachandwani Jun 6, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I am not sure how helpful this test is, maybe @arjan-bal or @easwars might be able to judge better.

balancerName := "stub-balancer-test-exit-idle-one-missing-id"
called := false

stub.Register(balancerName, stub.BalancerFuncs{
ExitIdle: func(_ *stub.BalancerData) {
called = true
},
})

bg := New(Options{
CC: testutils.NewBalancerClientConn(t),
BuildOpts: balancer.BuildOptions{},
StateAggregator: nil,
Logger: nil,
})
defer bg.Close()

bg.Add(testBalancerIDs[0], balancer.Get(balancerName))
bg.ExitIdleOne("non-existent-id")

if called {
t.Fatalf("ExitIdleOne called ExitIdle on wrong sub-balancer ID")
}
}

// TestBalancerGracefulSwitch tests the graceful switch functionality for a
// child of the balancer group. At first, the child is configured as a round
// robin load balancer, and thus should behave accordingly. The test then
Expand Down Expand Up @@ -639,3 +754,84 @@ func (s) TestBalancerGracefulSwitch(t *testing.T) {
}
}
}

func (s) TestBalancerExitIdle_All(t *testing.T) {
balancerOne := "stub-balancer-test-balancer-group-exit-idle-one"
balancerTwo := "stub-balancer-test-balancer-group-exit-idle-two"
balancerThree := "stub-balancer-test-balancer-group-exit-idle-three"

balancerNames := []string{balancerOne, balancerTwo, balancerThree}
testIDs := []string{testBalancerIDs[0], testBalancerIDs[1], testBalancerIDs[2]}

exitIdleCh := make(chan string, len(balancerNames))

for _, name := range balancerNames {
stub.Register(name, stub.BalancerFuncs{
ExitIdle: func(_ *stub.BalancerData) {
exitIdleCh <- name
},
})
}

cc := testutils.NewBalancerClientConn(t)
bg := New(Options{
CC: cc,
BuildOpts: balancer.BuildOptions{},
StateAggregator: nil,
Logger: nil,
})
defer bg.Close()

bg.Add(testIDs[0], balancer.Get(balancerOne))
bg.Add(testIDs[1], balancer.Get(balancerTwo))
bg.Add(testIDs[2], balancer.Get(balancerThree))

bg.ExitIdle()

called := make(map[string]bool)
for i := 0; i < len(balancerNames); i++ {
select {
case name := <-exitIdleCh:
if called[name] {
t.Fatalf("ExitIdle was called multiple times for sub-balancer %q", name)
}
called[name] = true
case <-time.After(defaultTestTimeout):
var balancers []string
for _, name := range balancerNames {
if !called[name] {
balancers = append(balancers, name)
}
}
t.Fatalf("Timeout waiting for ExitIdle. Missing calls from: %v", balancers)
}
}
}

func (s) TestBalancerGroup_ExitIdle_AfterClose(t *testing.T) {
balancerName := "stub-balancer-test-balancer-group-exit-idle-after-close"
exitIdleCh := make(chan struct{})

stub.Register(balancerName, stub.BalancerFuncs{
ExitIdle: func(_ *stub.BalancerData) {
close(exitIdleCh)
},
})

bg := New(Options{
CC: testutils.NewBalancerClientConn(t),
BuildOpts: balancer.BuildOptions{},
StateAggregator: nil,
Logger: nil,
})

bg.Add(testBalancerIDs[0], balancer.Get(balancerName))
bg.Close()
bg.ExitIdle()

select {
case <-exitIdleCh:
t.Fatalf("ExitIdle was called on sub-balancer even after BalancerGroup was closed")
case <-time.After(defaultTestShortTimeout):
}
}
1 change: 1 addition & 0 deletions xds/server_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,7 @@ import (

"github.com/google/go-cmp/cmp"
"github.com/google/uuid"

"google.golang.org/grpc"
"google.golang.org/grpc/connectivity"
"google.golang.org/grpc/credentials/insecure"
Expand Down
Loading