Skip to content

Commit efff908

Browse files
ata-nasata-nas
committed
template definition updates
Signed-off-by: Atanas Atanasov <a.v.atanasov98@gmail.com>
1 parent e367100 commit efff908

File tree

2 files changed

+34
-30
lines changed

2 files changed

+34
-30
lines changed

‎docs/test-plan/persistence/files-recent-persistence-e2e-test-plan.md

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -98,12 +98,12 @@ logic. Essentially, this test plan describes the intended behavior of the
9898
verified. It will then publish a persistence notification to the internal
9999
messaging system.
100100

101-
#### Expected Behaviour
101+
#### Requirements
102102

103103
It is expected that the Block-Node will respond with an acknowledgement to the
104104
publisher's request in this situation.
105105

106-
#### Requirements
106+
#### Preconditions
107107

108108
A publisher that is able to stream to the Block-Node under test.
109109

@@ -132,11 +132,11 @@ N/A
132132
`Files Recent Persistence` will persist a block after it has been received and
133133
verified.
134134

135-
#### Expected Behaviour
135+
#### Requirements
136136

137137
It is expected that a regular file is written at the properly resolved location.
138138

139-
#### Requirements
139+
#### Preconditions
140140

141141
A publisher that is able to stream to the Block-Node under test.
142142

@@ -166,12 +166,12 @@ N/A
166166
`Files Recent Persistence` will persist a block after it has been received and
167167
verified.
168168

169-
#### Expected Behaviour
169+
#### Requirements
170170

171171
It is expected that a regular file is written at the properly resolved location
172172
and the content of the file is the same as the original block streamed.
173173

174-
#### Requirements
174+
#### Preconditions
175175

176176
A publisher that is able to stream to the Block-Node under test.
177177

@@ -202,12 +202,12 @@ N/A
202202
`Files Recent Persistence` will persist a block after it has been received and
203203
verified.
204204

205-
#### Expected Behaviour
205+
#### Requirements
206206

207207
It is expected that the Block-Node will return and EndOfStream with
208208
PERSISTENCE_FAILED if an IO failure occurs during write.
209209

210-
#### Requirements
210+
#### Preconditions
211211

212212
A publisher that is able to stream to the Block-Node under test. A way to
213213
simulate an IO issue for the resolved block.
@@ -237,13 +237,13 @@ N/A
237237
`Files Recent Persistence` will persist a block after it has been received and
238238
verified.
239239

240-
#### Expected Behaviour
240+
#### Requirements
241241

242242
It is expected that all data potentially written to the filesystem is cleaned if
243243
an IO failure occurs during write. No files or data related to the current block
244244
must be present after such failure.
245245

246-
#### Requirements
246+
#### Preconditions
247247

248248
A publisher that is able to stream to the Block-Node under test. A way to
249249
simulate an IO issue for the resolved block.
@@ -275,12 +275,12 @@ N/A
275275
`Files Recent Persistence` will persist a block after it has been received and
276276
verified.
277277

278-
#### Expected Behaviour
278+
#### Requirements
279279

280280
It is expected that after the persistence of the given block is successful, the
281281
block will be accessible via the node's public API.
282282

283-
#### Requirements
283+
#### Preconditions
284284

285285
A publisher that is able to stream to the Block-Node under test. A client that
286286
can call the public APIs to read the block (i.e. `getBlock`). Client receives
@@ -314,7 +314,7 @@ verified. If the received and verified block's resolved path already exists,
314314
no matter what the reason is, it must be overwritten with the received block's
315315
data.
316316

317-
#### Expected Behaviour
317+
#### Requirements
318318

319319
It is expected that when the Block-Node receives the next in sequence block and
320320
then verifies it, the `Files Recent Persistence` will attempt to persist it at
@@ -325,7 +325,7 @@ persisted and acknowledged), but that is outside the scope of the
325325
`Files Recent Persistence`. As long as data comes in to the
326326
`Files Recent Persistence` it will be persisted at the resolved path.
327327

328-
#### Requirements
328+
#### Preconditions
329329

330330
A publisher that is able to stream to the Block-Node under test. A regular file
331331
exists at the resolved location of the block under test with some arbitrary test
@@ -360,13 +360,13 @@ N/A
360360
`Files Recent Persistence` will persist a block after it has been received and
361361
verified.
362362

363-
#### Expected Behaviour
363+
#### Requirements
364364

365365
It is expected that a regular file is written at the properly resolved location
366366
for each block streamed. It is expected that an Acknowledgement is returned to
367367
the publisher for each block streamed when everything is successful.
368368

369-
#### Requirements
369+
#### Preconditions
370370

371371
A publisher that is able to stream to the Block-Node under test.
372372

‎docs/test-plan/template.md

Lines changed: 18 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -25,27 +25,27 @@ Basic Functionality Test 1
2525

2626
#### Scenario Description
2727

28-
<!-- Verify the basic functionality of the feature. -->
28+
<!-- Describe the scenario of the test. -->
2929

30-
#### Expected Behaviour
30+
#### Requirements
3131

32-
<!-- The feature should perform its primary function without errors. -->
32+
<!-- What are the requirement(s) that the test should . -->
3333

34-
#### Requirements
34+
#### Preconditions
3535

36-
<!-- What are the prerequisite requirements that will allow us to run the test? -->
36+
<!-- What are the preconditions that will allow us to run the test? -->
3737

3838
#### Input
3939

40-
<!-- Valid input data. -->
40+
<!-- What is the input of the test? -->
4141

4242
#### Output
4343

44-
<!-- The feature should return the expected result without any errors. -->
44+
<!-- What output/result is expected to be produced at the end of the test? -->
4545

4646
#### Other
4747

48-
<!-- More information, it could change the title (Other) as well, this is a placeholder for anything that needs to be added, it can also be deleted if not needed. -->
48+
<!-- Additional information, if applicable -->
4949

5050
---
5151

@@ -57,22 +57,26 @@ Basic Functionality Test 2
5757

5858
#### Scenario Description
5959

60-
<!-- Verify the basic functionality of the feature. -->
60+
<!-- Describe the scenario of the test. -->
61+
62+
#### Requirements
63+
64+
<!-- What are the requirement(s) that the test should . -->
6165

62-
#### Expected Behaviour
66+
#### Preconditions
6367

64-
<!-- The feature should perform its primary function without errors. -->
68+
<!-- What are the preconditions that will allow us to run the test? -->
6569

6670
#### Input
6771

68-
<!-- Valid input data. -->
72+
<!-- What is the input of the test? -->
6973

7074
#### Output
7175

72-
<!-- The feature should return the expected result without any errors. -->
76+
<!-- What output/result is expected to be produced at the end of the test? -->
7377

7478
#### Other
7579

76-
<!-- More information, it could change the title (Other) as well, this is a placeholder for anything that needs to be added, it can also be deleted if not needed. -->
80+
<!-- Additional information, if applicable -->
7781

7882
---

0 commit comments

Comments
 (0)