Skip to content

Commit dd245a8

Browse files
committed
adding general test notes
Signed-off-by: Atanas Atanasov <a.v.atanasov98@gmail.com>
1 parent f75748c commit dd245a8

File tree

1 file changed

+33
-2
lines changed

1 file changed

+33
-2
lines changed

docs/test-plan/files-historic-persistence-e2e-test-plan.md

Lines changed: 33 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@ logic. Essentially, this test plan describes the intended behavior of the
4343
blockNumber `0000000000000001234` resides would be same as the path for block
4444
with blockNumber `0000000000000001235`, as they both belong to the same batch
4545
(1000-1999). An example path for that zip file could be:
46-
`/historic/000/000/000/000/000/1000s.zip` if the batch size is 1000.
46+
`/blocks/000/000/000/000/000/1000s.zip` if the batch size is 1000.
4747
- **Files Historic Root Path**: This is the root path (configurable) where all
4848
blocks will be archived. Generally, the stored blocks are long-lived as this
4949
type of persistence is used for long-term storage of blocks.
@@ -60,7 +60,38 @@ logic. Essentially, this test plan describes the intended behavior of the
6060

6161
## Test Scenarios
6262

63-
TBD
63+
> _**NOTE**: for the purpose of the below test definitions, we will have the
64+
> following root definition (this could be configured to be different, but
65+
> whatever is configured is of no relevance to the outcome of the tests, simply
66+
> we need a reference point so an example could be shown):_
67+
> `Files Historic Root`: `/blocks`
68+
>
69+
> _**NOTE**: the trie structure for `Files Recent Root` is resolving
70+
> all the digits of a `long` (max. 19 digits). We have three digits per node
71+
> or directory. Based on archive size, the max. depth of directories vary. After
72+
> we have reached our max. depth, we will then have an arbitrary number of zip
73+
> files, each named with the batch's start number suffixed with `s.zip`.
74+
> As an example, if we have a batch size of 1000, we will have the following
75+
> resolutions:
76+
> </br>
77+
> `/blocks/000/000/000/000/000/0000s.zip` (first thousand 0-999)
78+
> </br>
79+
> `/blocks/000/000/000/000/000/1000s.zip` (second thousand 1000-1999)
80+
> </br>
81+
> etc._
82+
>
83+
> _**NOTE**: assume that for each test the configured batch size is `10` in
84+
> order to have a more manageable environment. An example resolution for a
85+
> zip would be:
86+
> </b>
87+
> `/blocks/000/000/000/000/000/00/00s.zip` (first ten 0-9)
88+
> `/blocks/000/000/000/000/000/00/10s.zip` (second ten 10-19)
89+
> </b>
90+
> etc._
91+
>
92+
> _**NOTE**: assume that the Block-Node under test is configured to have the
93+
> compression algorithm set to `ZStandard` so the file extension for an archived
94+
> block will be `.blk.zstd`_
6495
6596
| Test Case ID | Test Name | Implemented (Y/N) |
6697
|----------------------------------:|:----------|:-----------------:|

0 commit comments

Comments
 (0)