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
|
// Copyright 2016 Google LLC. All Rights Reserved.
//
// 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 log
import (
"context"
"fmt"
"testing"
"time"
"github.com/golang/mock/gomock"
"github.com/google/go-cmp/cmp"
"github.com/google/trillian"
"github.com/google/trillian/extension"
"github.com/google/trillian/quota"
"github.com/google/trillian/storage"
stestonly "github.com/google/trillian/storage/testonly"
"github.com/google/trillian/storage/tree"
"github.com/google/trillian/testonly"
"github.com/google/trillian/types"
"github.com/google/trillian/util/clock"
"github.com/transparency-dev/merkle/compact"
"github.com/transparency-dev/merkle/rfc6962"
"google.golang.org/protobuf/proto"
)
// Arbitrary time for use in tests
var fakeTimeSource = clock.NewFake(fakeTime)
// We use a size zero tree for testing, Merkle tree state restore is tested elsewhere
var (
leaf0Hash = rfc6962.DefaultHasher.HashLeaf([]byte{})
testLeaf0 = &trillian.LogLeaf{
MerkleLeafHash: leaf0Hash,
LeafValue: nil,
ExtraData: nil,
LeafIndex: 0,
}
)
var testLeaf0Updated = &trillian.LogLeaf{
MerkleLeafHash: testonly.MustDecodeBase64("bjQLnP+zepicpUTmu3gKLHiQHT+zNzh2hRGjBhevoB0="),
LeafValue: nil,
ExtraData: nil,
LeafIndex: 0,
IntegrateTimestamp: testonly.MustToTimestampProto(fakeTime),
}
var (
testRoot0 = &types.LogRootV1{
TreeSize: 0,
RootHash: []byte{},
}
testRoot0Bytes, _ = testRoot0.MarshalBinary()
testSignedRoot0 = &trillian.SignedLogRoot{LogRoot: testRoot0Bytes}
updatedNodes0 = []tree.Node{{ID: compact.NewNodeID(0, 0), Hash: testonly.MustDecodeBase64("bjQLnP+zepicpUTmu3gKLHiQHT+zNzh2hRGjBhevoB0=")}}
updatedRoot = &types.LogRootV1{
TimestampNanos: uint64(fakeTime.UnixNano()),
RootHash: []byte{110, 52, 11, 156, 255, 179, 122, 152, 156, 165, 68, 230, 187, 120, 10, 44, 120, 144, 29, 63, 179, 55, 56, 118, 133, 17, 163, 6, 23, 175, 160, 29},
TreeSize: 1,
}
updatedRootBytes, _ = updatedRoot.MarshalBinary()
updatedSignedRoot = &trillian.SignedLogRoot{LogRoot: updatedRootBytes}
)
var zeroDuration = 0 * time.Second
func TestSequencerManagerSingleLogNoLeaves(t *testing.T) {
ctx := context.Background()
mockCtrl := gomock.NewController(t)
defer mockCtrl.Finish()
logID := stestonly.LogTree.GetTreeId()
mockAdminTx := storage.NewMockReadOnlyAdminTX(mockCtrl)
mockAdmin := &stestonly.FakeAdminStorage{ReadOnlyTX: []storage.ReadOnlyAdminTX{mockAdminTx}}
mockTx := storage.NewMockLogTreeTX(mockCtrl)
fakeStorage := &stestonly.FakeLogStorage{TX: mockTx}
mockTx.EXPECT().Commit(gomock.Any()).Return(nil)
mockTx.EXPECT().Close().Return(nil)
mockTx.EXPECT().LatestSignedLogRoot(gomock.Any()).Return(testSignedRoot0, nil)
mockTx.EXPECT().DequeueLeaves(gomock.Any(), 50, fakeTime).Return([]*trillian.LogLeaf{}, nil)
mockAdminTx.EXPECT().GetTree(gomock.Any(), logID).Return(stestonly.LogTree, nil)
mockAdminTx.EXPECT().Commit().Return(nil)
mockAdminTx.EXPECT().Close().Return(nil)
registry := extension.Registry{
AdminStorage: mockAdmin,
LogStorage: fakeStorage,
QuotaManager: quota.Noop(),
}
sm := NewSequencerManager(registry, zeroDuration)
if _, err := sm.ExecutePass(ctx, logID, createTestInfo(registry)); err != nil {
t.Error(err)
}
}
func TestSequencerManagerCachesSigners(t *testing.T) {
ctx := context.Background()
mockCtrl := gomock.NewController(t)
defer mockCtrl.Finish()
logID := stestonly.LogTree.GetTreeId()
mockAdminTx := storage.NewMockReadOnlyAdminTX(mockCtrl)
mockAdmin := &stestonly.FakeAdminStorage{}
mockTx := storage.NewMockLogTreeTX(mockCtrl)
fakeStorage := &stestonly.FakeLogStorage{}
registry := extension.Registry{
AdminStorage: mockAdmin,
LogStorage: fakeStorage,
QuotaManager: quota.Noop(),
}
sm := NewSequencerManager(registry, zeroDuration)
// Expect two sequencing passes.
for i := 0; i < 2; i++ {
mockAdmin.ReadOnlyTX = []storage.ReadOnlyAdminTX{mockAdminTx}
gomock.InOrder(
mockAdminTx.EXPECT().GetTree(gomock.Any(), logID).Return(stestonly.LogTree, nil),
mockAdminTx.EXPECT().Commit().Return(nil),
mockAdminTx.EXPECT().Close().Return(nil),
)
fakeStorage.TX = mockTx
gomock.InOrder(
mockTx.EXPECT().LatestSignedLogRoot(gomock.Any()).Return(testSignedRoot0, nil),
mockTx.EXPECT().DequeueLeaves(gomock.Any(), 50, fakeTime).Return([]*trillian.LogLeaf{}, nil),
mockTx.EXPECT().Commit(gomock.Any()).Return(nil),
mockTx.EXPECT().Close().Return(nil),
)
if _, err := sm.ExecutePass(ctx, logID, createTestInfo(registry)); err != nil {
t.Fatal(err)
}
}
}
func TestSequencerManagerSingleLogOneLeaf(t *testing.T) {
ctx := context.Background()
mockCtrl := gomock.NewController(t)
defer mockCtrl.Finish()
logID := stestonly.LogTree.GetTreeId()
mockAdminTx := storage.NewMockReadOnlyAdminTX(mockCtrl)
mockAdmin := &stestonly.FakeAdminStorage{ReadOnlyTX: []storage.ReadOnlyAdminTX{mockAdminTx}}
mockTx := storage.NewMockLogTreeTX(mockCtrl)
fakeStorage := &stestonly.FakeLogStorage{TX: mockTx}
// Set up enough mockery to be able to sequence. We don't test all the error paths
// through sequencer as other tests cover this
mockTx.EXPECT().Commit(gomock.Any()).Return(nil)
mockTx.EXPECT().Close().Return(nil)
mockTx.EXPECT().DequeueLeaves(gomock.Any(), 50, fakeTime).Return([]*trillian.LogLeaf{testLeaf0}, nil)
mockTx.EXPECT().LatestSignedLogRoot(gomock.Any()).Return(testSignedRoot0, nil)
mockTx.EXPECT().UpdateSequencedLeaves(gomock.Any(), cmpMatcher{[]*trillian.LogLeaf{testLeaf0Updated}}).Return(nil)
mockTx.EXPECT().SetMerkleNodes(gomock.Any(), updatedNodes0).Return(nil)
mockTx.EXPECT().StoreSignedLogRoot(gomock.Any(), cmpMatcher{updatedSignedRoot}).Return(nil)
mockAdminTx.EXPECT().GetTree(gomock.Any(), logID).Return(stestonly.LogTree, nil)
mockAdminTx.EXPECT().Commit().Return(nil)
mockAdminTx.EXPECT().Close().Return(nil)
registry := extension.Registry{
AdminStorage: mockAdmin,
LogStorage: fakeStorage,
QuotaManager: quota.Noop(),
}
sm := NewSequencerManager(registry, zeroDuration)
if _, err := sm.ExecutePass(ctx, logID, createTestInfo(registry)); err != nil {
t.Error(err)
}
}
// cmpMatcher is a custom gomock.Matcher that uses cmp.Equal combined with a
// cmp.Comparer that knows how to properly compare proto.Message types.
type cmpMatcher struct{ want interface{} }
func (m cmpMatcher) Matches(got interface{}) bool {
return cmp.Equal(got, m.want, cmp.Comparer(proto.Equal))
}
func (m cmpMatcher) String() string {
return fmt.Sprintf("equals %v", m.want)
}
func TestSequencerManagerGuardWindow(t *testing.T) {
ctx := context.Background()
mockCtrl := gomock.NewController(t)
defer mockCtrl.Finish()
logID := stestonly.LogTree.GetTreeId()
mockAdminTx := storage.NewMockReadOnlyAdminTX(mockCtrl)
mockAdmin := &stestonly.FakeAdminStorage{ReadOnlyTX: []storage.ReadOnlyAdminTX{mockAdminTx}}
mockTx := storage.NewMockLogTreeTX(mockCtrl)
fakeStorage := &stestonly.FakeLogStorage{TX: mockTx}
mockTx.EXPECT().Commit(gomock.Any()).Return(nil)
mockTx.EXPECT().Close().Return(nil)
mockTx.EXPECT().LatestSignedLogRoot(gomock.Any()).Return(testSignedRoot0, nil)
// Expect a 5 second guard window to be passed from manager -> sequencer -> storage
mockTx.EXPECT().DequeueLeaves(gomock.Any(), 50, fakeTime.Add(-time.Second*5)).Return([]*trillian.LogLeaf{}, nil)
mockAdminTx.EXPECT().GetTree(gomock.Any(), logID).Return(stestonly.LogTree, nil)
mockAdminTx.EXPECT().Commit().Return(nil)
mockAdminTx.EXPECT().Close().Return(nil)
registry := extension.Registry{
AdminStorage: mockAdmin,
LogStorage: fakeStorage,
QuotaManager: quota.Noop(),
}
sm := NewSequencerManager(registry, time.Second*5)
if _, err := sm.ExecutePass(ctx, logID, createTestInfo(registry)); err != nil {
t.Error(err)
}
}
func createTestInfo(registry extension.Registry) *OperationInfo {
// Set sign interval to 100 years so it won't trigger a root expiry signing unless overridden
return &OperationInfo{
Registry: registry,
BatchSize: 50,
RunInterval: time.Second,
TimeSource: fakeTimeSource,
}
}
|
