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
package driver
import (
"errors"
"testing"
"github.com/stretchr/testify/require"
"github.com/ethereum/go-ethereum/log"
"github.com/ethereum-optimism/optimism/op-node/rollup"
"github.com/ethereum-optimism/optimism/op-node/rollup/derive"
"github.com/ethereum-optimism/optimism/op-node/rollup/engine"
"github.com/ethereum-optimism/optimism/op-service/eth"
"github.com/ethereum-optimism/optimism/op-service/testlog"
"github.com/ethereum-optimism/optimism/op-service/testutils"
)
func TestProgramDeriver(t *testing.T) {
newProgram := func(t *testing.T, target uint64) (*ProgramDeriver, *testutils.MockEmitter) {
m := &testutils.MockEmitter{}
logger := testlog.Logger(t, log.LevelInfo)
prog := &ProgramDeriver{
logger: logger,
Emitter: m,
targetBlockNum: target,
}
return prog, m
}
// step 0 assumption: engine performs reset upon ResetEngineRequestEvent.
// step 1: engine completes reset
t.Run("engine reset confirmed", func(t *testing.T) {
p, m := newProgram(t, 1000)
m.ExpectOnce(derive.ConfirmPipelineResetEvent{})
m.ExpectOnce(engine.PendingSafeRequestEvent{})
p.OnEvent(engine.EngineResetConfirmedEvent{})
m.AssertExpectations(t)
require.False(t, p.closing)
require.NoError(t, p.result)
require.False(t, p.closing)
require.NoError(t, p.result)
})
// step 2: more derivation work, triggered when pending safe data is published
t.Run("pending safe update", func(t *testing.T) {
p, m := newProgram(t, 1000)
ref := eth.L2BlockRef{Number: 123}
m.ExpectOnce(derive.PipelineStepEvent{PendingSafe: ref})
p.OnEvent(engine.PendingSafeUpdateEvent{PendingSafe: ref})
m.AssertExpectations(t)
require.False(t, p.closing)
require.NoError(t, p.result)
})
// step 3: if no attributes are generated, loop back to derive more.
t.Run("deriver more", func(t *testing.T) {
p, m := newProgram(t, 1000)
m.ExpectOnce(engine.PendingSafeRequestEvent{})
p.OnEvent(derive.DeriverMoreEvent{})
m.AssertExpectations(t)
require.False(t, p.closing)
require.NoError(t, p.result)
})
// step 4: if attributes are derived, pass them to the engine.
t.Run("derived attributes", func(t *testing.T) {
p, m := newProgram(t, 1000)
attrib := &derive.AttributesWithParent{Parent: eth.L2BlockRef{Number: 123}}
m.ExpectOnce(derive.ConfirmReceivedAttributesEvent{})
m.ExpectOnce(engine.BuildStartEvent{Attributes: attrib})
p.OnEvent(derive.DerivedAttributesEvent{Attributes: attrib})
m.AssertExpectations(t)
require.False(t, p.closing)
require.NoError(t, p.result)
})
// step 5: if attributes were invalid, continue with derivation for new attributes.
t.Run("invalid payload", func(t *testing.T) {
p, m := newProgram(t, 1000)
m.ExpectOnce(engine.PendingSafeRequestEvent{})
p.OnEvent(engine.InvalidPayloadAttributesEvent{Attributes: &derive.AttributesWithParent{}})
m.AssertExpectations(t)
require.False(t, p.closing)
require.NoError(t, p.result)
})
// step 6: if attributes were valid, we may have reached the target.
// Or back to step 2 (PendingSafeUpdateEvent)
t.Run("forkchoice update", func(t *testing.T) {
t.Run("surpassed", func(t *testing.T) {
p, m := newProgram(t, 42)
p.OnEvent(engine.ForkchoiceUpdateEvent{SafeL2Head: eth.L2BlockRef{Number: 42 + 1}})
m.AssertExpectations(t)
require.True(t, p.closing)
require.NoError(t, p.result)
})
t.Run("completed", func(t *testing.T) {
p, m := newProgram(t, 42)
p.OnEvent(engine.ForkchoiceUpdateEvent{SafeL2Head: eth.L2BlockRef{Number: 42}})
m.AssertExpectations(t)
require.True(t, p.closing)
require.NoError(t, p.result)
})
t.Run("incomplete", func(t *testing.T) {
p, m := newProgram(t, 42)
p.OnEvent(engine.ForkchoiceUpdateEvent{SafeL2Head: eth.L2BlockRef{Number: 42 - 1}})
m.AssertExpectations(t)
require.False(t, p.closing)
require.NoError(t, p.result)
})
})
// on exhaustion of input data: stop without error
t.Run("deriver idle", func(t *testing.T) {
p, m := newProgram(t, 1000)
p.OnEvent(derive.DeriverIdleEvent{})
m.AssertExpectations(t)
require.True(t, p.closing)
require.Nil(t, p.result)
})
// on inconsistent chain data: stop with error
t.Run("reset event", func(t *testing.T) {
p, m := newProgram(t, 1000)
p.OnEvent(rollup.ResetEvent{Err: errors.New("reset test err")})
m.AssertExpectations(t)
require.True(t, p.closing)
require.NotNil(t, p.result)
})
// on L1 temporary error: stop with error
t.Run("L1 temporary error event", func(t *testing.T) {
p, m := newProgram(t, 1000)
p.OnEvent(rollup.L1TemporaryErrorEvent{Err: errors.New("temp test err")})
m.AssertExpectations(t)
require.True(t, p.closing)
require.NotNil(t, p.result)
})
// on engine temporary error: continue derivation (because legacy, not all connection related)
t.Run("engine temp error event", func(t *testing.T) {
p, m := newProgram(t, 1000)
m.ExpectOnce(engine.PendingSafeRequestEvent{})
p.OnEvent(rollup.EngineTemporaryErrorEvent{Err: errors.New("temp test err")})
m.AssertExpectations(t)
require.False(t, p.closing)
require.NoError(t, p.result)
})
// on critical error: stop
t.Run("critical error event", func(t *testing.T) {
p, m := newProgram(t, 1000)
p.OnEvent(rollup.ResetEvent{Err: errors.New("crit test err")})
m.AssertExpectations(t)
require.True(t, p.closing)
require.NotNil(t, p.result)
})
t.Run("unknown event", func(t *testing.T) {
p, m := newProgram(t, 1000)
p.OnEvent(TestEvent{})
m.AssertExpectations(t)
require.False(t, p.closing)
require.NoError(t, p.result)
})
}
type TestEvent struct{}
func (ev TestEvent) String() string {
return "test-event"
}