-
Notifications
You must be signed in to change notification settings - Fork 167
/
VersionedLDBAVLStorageSpecification.scala
373 lines (279 loc) · 12.6 KB
/
VersionedLDBAVLStorageSpecification.scala
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
package scorex.crypto.authds.avltree.batch
import com.google.common.primitives.Longs
import org.scalacheck.{Arbitrary, Gen}
import org.scalatest.Assertion
import org.scalatest.matchers.should.Matchers
import org.scalatest.propspec.AnyPropSpec
import org.scalatestplus.scalacheck.ScalaCheckPropertyChecks
import scorex.core.serialization.{ManifestSerializer, SubtreeSerializer}
import scorex.crypto.authds.avltree.batch.helpers.TestHelper
import scorex.crypto.authds.{ADDigest, ADKey, ADValue, SerializedAdProof}
import scorex.util.encode.Base16
import scorex.crypto.hash.{Blake2b256, Digest32}
import scorex.db.{LDBFactory, LDBVersionedStore}
import scorex.util.ByteArrayBuilder
import scorex.util.serialization.VLQByteBufferWriter
import scorex.utils.{Random => RandomBytes}
import scala.concurrent.ExecutionContext.Implicits.global
import scala.concurrent.duration._
import scala.concurrent.{Await, Future}
import scala.util.{Success, Try}
class VersionedLDBAVLStorageSpecification
extends AnyPropSpec
with ScalaCheckPropertyChecks
with Matchers
with TestHelper {
override protected val KL = 32
override protected val VL = 8
def kvGen: Gen[(ADKey, ADValue)] = for {
key <- Gen.listOfN(KL, Arbitrary.arbitrary[Byte]).map(_.toArray) suchThat
(k => !(k sameElements Array.fill(KL)(-1: Byte)) && !(k sameElements Array.fill(KL)(0: Byte)) && k.length == KL)
value <- Gen.listOfN(VL, Arbitrary.arbitrary[Byte]).map(_.toArray)
} yield (ADKey @@ key, ADValue @@ value)
/**
* List of all test cases
*/
val rollbackTest: PERSISTENT_PROVER => Unit = { prover: PERSISTENT_PROVER =>
def ops(s: Int, e: Int): Unit = (s until e).foreach { i =>
prover.performOneOperation(Insert(ADKey @@ Blake2b256("k" + i).take(KL),
ADValue @@ Blake2b256("v" + i).take(VL)))
}
ops(0, 100)
prover.generateProofAndUpdateStorage()
val digest = prover.digest
val digest58String = digest.toBase58
ops(100, 200)
prover.generateProofAndUpdateStorage()
prover.digest.toBase58 should not equal digest58String
prover.rollback(digest)
prover.digest.toBase58 shouldEqual digest58String
prover.checkTree(true)
}
// Read-only access to some elements in parallel should not affect modifications application
val parallelReadTest: PERSISTENT_PROVER => Try[Unit] = {
def performModifications(prover: PERSISTENT_PROVER, inserts: Seq[Insert]) = {
inserts.foldLeft[Try[Option[ADValue]]](Success(None)) { case (t, m) =>
t.flatMap(_ => prover.performOneOperation(m))
}.get
prover.generateProofAndUpdateStorage()
}
def startParallelReads(prover: PERSISTENT_PROVER) = {
Future {
def loop(): Unit = {
Thread.sleep(10)
Try(prover.digest)
loop()
}
loop()
}
}
prover: PERSISTENT_PROVER =>
val pairs = (1 to 10000).map(_ => kvGen.sample.get)
pairs.foreach(p => prover.performOneOperation(Insert(p._1, p._2)))
prover.generateProofAndUpdateStorage
val blocks: Seq[Seq[Insert]] = (0 until 10).map(_ => (0 until 10).flatMap(_ => kvGen.sample)
.map(kv => Insert(kv._1, kv._2)))
val parallelReadsFuture = startParallelReads(prover)
// apply blocks
blocks.foldLeft(prover.digest) { (startRoot, block) =>
prover.digest shouldEqual startRoot
performModifications(prover, block)
prover.rollback(startRoot)
Base16.encode(prover.digest) shouldBe Base16.encode(startRoot)
performModifications(prover, block)
prover.digest
}
Try(Await.result(parallelReadsFuture, 0.millis))
}
// Test similar to blockchain workflow - generate proofs for some modifications, rollback, apply modifications
val blockchainWorkflowTest: PERSISTENT_PROVER => SerializedAdProof = { prover: PERSISTENT_PROVER =>
def metadata(modId: Array[Byte], stateRoot: ADDigest): Seq[(Array[Byte], Array[Byte])] = {
val idStateDigestIdxElem: (Array[Byte], Array[Byte]) = modId -> stateRoot
val stateDigestIdIdxElem = Blake2b256(stateRoot) -> modId
val bestVersion = Blake2b256("best state version") -> modId
Seq(idStateDigestIdxElem, stateDigestIdIdxElem, bestVersion)
}
def intToKey(i: Int, seed: Int = 0): ADKey = ADKey @@ Blake2b256(s"key-$i-$seed").take(KL)
def intToValue(i: Int, seed: Int = 0): ADValue = ADValue @@ Blake2b256(s"val-$i-$seed").take(VL)
val initialElementsSize = 10000
val initialElements = (0 until initialElementsSize).map(i => Insert(intToKey(i), intToValue(i)))
initialElements.foreach(op => prover.performOneOperation(op).get)
prover.generateProofAndUpdateStorage
val toInsert: Seq[Insert] = (0 until 1000) map { i =>
Insert(intToKey(i, 1), intToValue(i, 1))
}
val toRemove: Seq[Remove] = initialElements.take(1000).map(_.key).map(i => Remove(i))
val mods: Seq[Modification] = toInsert ++ toRemove
val nonMod = prover.avlProver.generateProofForOperations(mods).get
mods.foldLeft[Try[Option[ADValue]]](Success(None)) { case (t, m) =>
t.flatMap(_ => {
prover.performOneOperation(m)
})
}.get
val md = metadata(Blake2b256(nonMod._1 ++ nonMod._2), nonMod._2)
prover.generateProofAndUpdateStorage(md)
}
val basicTest: (PERSISTENT_PROVER, STORAGE) => Unit = { (prover: PERSISTENT_PROVER, storage: STORAGE) =>
var digest = prover.digest
def oneMod(aKey: ADKey, aValue: ADValue): Unit = {
prover.digest shouldBe digest
val m = Insert(aKey, aValue)
prover.performOneOperation(m)
val pf = prover.generateProofAndUpdateStorage()
val verifier = createVerifier(digest, pf)
verifier.performOneOperation(m).isSuccess shouldBe true
prover.digest.toBase58 should not equal digest.toBase58
prover.digest.toBase58 shouldEqual verifier.digest.get.toBase58
prover.rollback(digest).get
prover.checkTree(true)
prover.digest shouldBe digest
prover.performOneOperation(m)
val pf2 = prover.generateProofAndUpdateStorage()
pf shouldBe pf2
prover.checkTree(true)
val verifier2 = createVerifier(digest, pf2)
verifier2.performOneOperation(m).isSuccess shouldBe true
digest = prover.digest
}
(1 to 100).foreach { _ =>
val (aKey, aValue) = kvGen.sample.get
oneMod(aKey, aValue)
}
val prover2 = createPersistentProver(storage)
prover2.digest.toBase58 shouldEqual prover.digest.toBase58
prover2.checkTree(postProof = true)
}
val rollbackVersionsTest: (PERSISTENT_PROVER, STORAGE) => Assertion = { (prover: PERSISTENT_PROVER, storage: STORAGE) =>
(0L until 50L).foreach { long =>
val insert = Insert(ADKey @@ RandomBytes.randomBytes(32),
ADValue @@ Longs.toByteArray(long))
prover.performOneOperation(insert)
prover.generateProofAndUpdateStorage()
prover.digest
}
noException should be thrownBy storage.rollbackVersions.foreach(v => prover.rollback(v).get)
}
def testAddInfoSaving(createStore: Int => LDBVersionedStore): Assertion = {
val store = createStore(1000)
val storage = createVersionedStorage(store)
val prover = createPersistentProver(storage)
val insert1 = Insert(ADKey @@ RandomBytes.randomBytes(32), ADValue @@ Longs.toByteArray(1L))
val insert2 = Insert(ADKey @@ RandomBytes.randomBytes(32), ADValue @@ Longs.toByteArray(2L))
val insert3 = Insert(ADKey @@ RandomBytes.randomBytes(32), ADValue @@ Longs.toByteArray(3L))
val insert4 = Insert(ADKey @@ RandomBytes.randomBytes(32), ADValue @@ Longs.toByteArray(4L))
val insert5 = Insert(ADKey @@ RandomBytes.randomBytes(32), ADValue @@ Longs.toByteArray(5L))
val addInfo1 = RandomBytes.randomBytes(32) -> Longs.toByteArray(6L)
val addInfo2 = RandomBytes.randomBytes(32) -> Longs.toByteArray(7L)
prover.performOneOperation(insert1)
prover.generateProofAndUpdateStorage()
val digest1 = prover.digest
prover.performOneOperation(insert2)
prover.performOneOperation(insert3)
prover.generateProofAndUpdateStorage(Seq(addInfo1))
val digest2 = prover.digest
prover.performOneOperation(insert4)
prover.performOneOperation(insert5)
prover.generateProofAndUpdateStorage(Seq(addInfo2))
store.get(addInfo1._1) shouldBe defined
store.get(addInfo2._1) shouldBe defined
storage.rollback(digest2).get
store.get(addInfo1._1) shouldBe defined
store.get(addInfo2._1) shouldBe None
storage.rollback(digest1).get
store.get(addInfo1._1) shouldBe None
store.get(addInfo2._1) shouldBe None
}
def removeFromLargerSetSingleRandomElementTest(createStore: Int => LDBVersionedStore): Unit = {
val minSetSize = 10000
val maxSetSize = 200000
forAll(Gen.choose(minSetSize, maxSetSize), Arbitrary.arbBool.arbitrary) { case (cnt, generateProof) =>
whenever(cnt > minSetSize) {
val store = createStore(0).ensuring(_.lastVersionID.isEmpty)
val t = Try {
var keys = IndexedSeq[ADKey]()
val p = new BatchAVLProver[Digest32, HF](KL, Some(VL))
(1 to cnt) foreach { _ =>
val key = ADKey @@ RandomBytes.randomBytes(KL)
val value = ADValue @@ RandomBytes.randomBytes(VL)
keys = key +: keys
p.performOneOperation(Insert(key, value)).isSuccess shouldBe true
p.unauthenticatedLookup(key).isDefined shouldBe true
}
if (generateProof) p.generateProof()
val storage = createVersionedStorage(store)
assert(storage.isEmpty)
val prover = createPersistentProver(storage, p)
val keyPosition = scala.util.Random.nextInt(keys.length)
val rndKey = keys(keyPosition)
prover.unauthenticatedLookup(rndKey).isDefined shouldBe true
val removalResult = prover.performOneOperation(Remove(rndKey))
removalResult.isSuccess shouldBe true
if (keyPosition > 0) {
prover.performOneOperation(Remove(keys.head)).isSuccess shouldBe true
}
keys = keys.tail.filterNot(_.sameElements(rndKey))
val shuffledKeys = scala.util.Random.shuffle(keys)
shuffledKeys.foreach { k =>
prover.performOneOperation(Remove(k)).isSuccess shouldBe true
}
}
store.close()
t.get
}
}
}
/**
* All checks are being made with both underlying LevelDB versioned storage implementation
*/
property("Persistence AVL batch prover - parallel read-write") {
val prover = createPersistentProver()
parallelReadTest(prover)
}
property("Persistence AVL batch prover - blockchain workflow") {
val prover = createPersistentProver()
blockchainWorkflowTest(prover)
}
property("Persistence AVL batch prover - rollback") {
val prover = createPersistentProver()
rollbackTest(prover)
}
property("Persistence AVL batch prover - basic test") {
val store = createVersionedStore()
val storage = createVersionedStorage(store)
val prover = createPersistentProver(storage)
basicTest(prover, storage)
}
property("Persistence AVL batch prover - rollback version") {
val store = createVersionedStore(1000)
val storage = createVersionedStorage(store)
val prover = createPersistentProver(storage)
rollbackVersionsTest(prover, storage)
}
property("Persistence AVL batch prover - remove single random element from a large set") {
removeFromLargerSetSingleRandomElementTest(createVersionedStore _)
}
property("Persistence AVL batch prover - save additional info") {
testAddInfoSaving(createVersionedStore _)
}
property("dumping snapshot") {
val manifestDepth: Byte = 6
val manifestSerializer = new ManifestSerializer(manifestDepth)
val prover = createPersistentProver()
blockchainWorkflowTest(prover)
val storage = prover.storage.asInstanceOf[VersionedLDBAVLStorage]
val store = LDBFactory.createKvDb(getRandomTempDir.getAbsolutePath)
val rootNodeLabel = storage.dumpSnapshot(store, manifestDepth, prover.digest.dropRight(1)).get
rootNodeLabel.sameElements(prover.digest.dropRight(1)) shouldBe true
val manifestBytes = store.get(rootNodeLabel).get
val manifest = manifestSerializer.parseBytesTry(manifestBytes).get
val writer = new VLQByteBufferWriter(new ByteArrayBuilder())
manifestSerializer.serialize(prover.prover().topNode, prover.prover().rootNodeHeight.toByte, writer)
val altManifestBytes = writer.result().toBytes
manifestBytes.sameElements(altManifestBytes) shouldBe true
val subtreeIds = manifest.subtreesIds
subtreeIds.foreach { sid =>
val chunkBytes = store.get(sid).get
SubtreeSerializer.parseBytesTry(chunkBytes).get.id.sameElements(sid) shouldBe true
}
}
}