|
| 1 | +//go:build !ci |
| 2 | + |
| 3 | +// use a tag prefixed with "!". Such tag ensures that the default behaviour of this test would be to be built/run even when the go toolchain (go test) doesn't specify any tag filter. |
| 4 | +package conductor |
| 5 | + |
| 6 | +import ( |
| 7 | + "context" |
| 8 | + "fmt" |
| 9 | + "strings" |
| 10 | + "testing" |
| 11 | + "time" |
| 12 | + |
| 13 | + "github.com/ethereum-optimism/optimism/op-conductor/consensus" |
| 14 | + "github.com/ethereum-optimism/optimism/op-devstack/devtest" |
| 15 | + "github.com/ethereum-optimism/optimism/op-devstack/dsl" |
| 16 | + "github.com/ethereum-optimism/optimism/op-devstack/presets" |
| 17 | + "github.com/ethereum-optimism/optimism/op-devstack/stack" |
| 18 | + "github.com/ethereum-optimism/optimism/op-service/testlog" |
| 19 | + "github.com/ethereum/go-ethereum/log" |
| 20 | + "github.com/stretchr/testify/require" |
| 21 | +) |
| 22 | + |
| 23 | +type conductorWithInfo struct { |
| 24 | + *dsl.Conductor |
| 25 | + info consensus.ServerInfo |
| 26 | +} |
| 27 | + |
| 28 | +// TestConductorLeadershipTransfer checks if the leadership transfer works correctly on the conductors |
| 29 | +func TestConductorLeadershipTransfer(gt *testing.T) { |
| 30 | + t := devtest.SerialT(gt) |
| 31 | + logger := testlog.Logger(t, log.LevelInfo).With("Test", "TestConductorLeadershipTransfer") |
| 32 | + |
| 33 | + sys := presets.NewMinimalWithConductors(t) |
| 34 | + tracer := t.Tracer() |
| 35 | + ctx := t.Ctx() |
| 36 | + logger.Info("Started Conductor Leadership Transfer test") |
| 37 | + |
| 38 | + ctx, span := tracer.Start(ctx, "test chains") |
| 39 | + defer span.End() |
| 40 | + |
| 41 | + ctx, cancel := context.WithTimeout(ctx, 30*time.Second) |
| 42 | + defer cancel() |
| 43 | + |
| 44 | + // Test all L2 chains in the system |
| 45 | + for l2Chain, conductors := range sys.ConductorSets { |
| 46 | + chainId := l2Chain.String() |
| 47 | + |
| 48 | + _, span = tracer.Start(ctx, fmt.Sprintf("test chain %s", chainId)) |
| 49 | + defer span.End() |
| 50 | + |
| 51 | + membership := conductors[0].FetchClusterMembership() |
| 52 | + require.Equal(t, len(membership.Servers), len(conductors), "cluster membership does not match the number of conductors", "chainId", chainId) |
| 53 | + |
| 54 | + idToConductor := make(map[string]conductorWithInfo) |
| 55 | + for _, conductor := range conductors { |
| 56 | + conductorId := strings.TrimPrefix(conductor.String(), stack.ConductorKind.String()+"-") |
| 57 | + idToConductor[conductorId] = conductorWithInfo{conductor, consensus.ServerInfo{}} |
| 58 | + } |
| 59 | + for _, memberInfo := range membership.Servers { |
| 60 | + conductor, ok := idToConductor[memberInfo.ID] |
| 61 | + require.True(t, ok, "unknown conductor in cluster membership", "unknown conductor id", memberInfo.ID, "chainId", chainId) |
| 62 | + conductor.info = memberInfo |
| 63 | + idToConductor[memberInfo.ID] = conductor |
| 64 | + } |
| 65 | + |
| 66 | + leaderInfo, err := conductors[0].Escape().RpcAPI().LeaderWithID(ctx) |
| 67 | + require.NoError(t, err, "failed to get current conductor info", "chainId", chainId) |
| 68 | + |
| 69 | + leaderConductor := idToConductor[leaderInfo.ID] |
| 70 | + |
| 71 | + voters := []conductorWithInfo{leaderConductor} |
| 72 | + for _, member := range membership.Servers { |
| 73 | + if member.ID == leaderInfo.ID || member.Suffrage == consensus.Nonvoter { |
| 74 | + continue |
| 75 | + } |
| 76 | + |
| 77 | + voters = append(voters, idToConductor[member.ID]) |
| 78 | + } |
| 79 | + |
| 80 | + if len(voters) == 1 { |
| 81 | + t.Skip("only one voter found in the cluster, skipping leadership transfer test") |
| 82 | + continue |
| 83 | + } |
| 84 | + |
| 85 | + t.Run(fmt.Sprintf("L2_Chain_%s", chainId), func(tt devtest.T) { |
| 86 | + numOfLeadershipTransfers := len(voters) |
| 87 | + for i := 0; i < numOfLeadershipTransfers; i++ { |
| 88 | + // the modulo operation is used to wrap around the list of voters whenever i or i+1 becomes >= len(voters) |
| 89 | + oldLeaderIndex, newLeaderIndex := i%len(voters), (i+1)%len(voters) |
| 90 | + oldLeader, newLeader := voters[oldLeaderIndex], voters[newLeaderIndex] |
| 91 | + |
| 92 | + time.Sleep(3 * time.Second) |
| 93 | + |
| 94 | + testTransferLeadershipAndCheck(t, oldLeader, newLeader) |
| 95 | + } |
| 96 | + }) |
| 97 | + } |
| 98 | +} |
| 99 | + |
| 100 | +// testTransferLeadershipAndCheck tests conductor's leadership transfer from one leader to another |
| 101 | +func testTransferLeadershipAndCheck(t devtest.T, oldLeader, targetLeader conductorWithInfo) { |
| 102 | + |
| 103 | + t.Run(fmt.Sprintf("Conductor_%s_to_%s", oldLeader, targetLeader), func(tt devtest.T) { |
| 104 | + // ensure that the current and target leader are healthy and unpaused before transferring leadership |
| 105 | + require.True(tt, oldLeader.FetchSequencerHealthy(), "current leader's sequencer is not healthy, id", oldLeader) |
| 106 | + require.True(tt, targetLeader.FetchSequencerHealthy(), "target leader's sequencer is not healthy, id", targetLeader) |
| 107 | + require.False(tt, oldLeader.FetchPaused(), "current leader's sequencer is paused, id", oldLeader) |
| 108 | + require.False(tt, targetLeader.FetchPaused(), "target leader's sequencer is paused, id", targetLeader) |
| 109 | + |
| 110 | + // ensure that the current leader is the leader before transferring leadership |
| 111 | + require.True(tt, oldLeader.IsLeader(), "current leader was not found to be the leader") |
| 112 | + require.False(tt, targetLeader.IsLeader(), "target leader was already found to be the leader") |
| 113 | + |
| 114 | + oldLeader.TransferLeadershipTo(targetLeader.info) |
| 115 | + |
| 116 | + require.Eventually( |
| 117 | + tt, |
| 118 | + func() bool { return targetLeader.IsLeader() }, |
| 119 | + 5*time.Second, 1*time.Second, "target leader was not found to be the leader", |
| 120 | + ) |
| 121 | + |
| 122 | + require.False(tt, oldLeader.IsLeader(), "old leader was still found to be the leader") |
| 123 | + |
| 124 | + // sometimes leadership transfer can cause a very brief period of unhealthiness, |
| 125 | + // but eventually, they should be healthy again |
| 126 | + require.Eventually( |
| 127 | + tt, |
| 128 | + func() bool { return oldLeader.FetchSequencerHealthy() && targetLeader.FetchSequencerHealthy() }, |
| 129 | + 3*time.Second, 1*time.Second, "at least one of the sequencers was found to be unhealthy", |
| 130 | + ) |
| 131 | + }) |
| 132 | +} |
0 commit comments