Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

doc: add TP#001 for Big Blocks #55

Merged
merged 7 commits into from
Aug 29, 2022
Merged

Conversation

Bidon15
Copy link
Member

@Bidon15 Bidon15 commented Aug 26, 2022

Test Plan covers big blocks epic.
Rendered:

  • Test Plan : link to view
  • Test Cases are embedded inside the plan

Closes #1 #6
Ref: celestiaorg/celestia-node#7 celestiaorg/celestia-node#602

@Bidon15 Bidon15 marked this pull request as ready for review August 26, 2022 11:40
@Bidon15 Bidon15 changed the title doc: add TP#001 with 1st test case doc: add TP#001 for Big Blocks Aug 26, 2022
@Bidon15 Bidon15 self-assigned this Aug 26, 2022
Copy link
Member

@Wondertan Wondertan left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Cool. I like the taken documentation approach.

A few comments:

  • Syncing and dasing from the network perspective are the same. What for full Nodes is block syncing for light nodes is block dasing. This means that tc-002 == tc-004 and tc-003 == tc-005. So we can keep -das- cases only for lights and -sync only for fulls(right now, both sync and das cases mention Full/Light node types) or combine equal tests into one.
  • There is a lot of common text between tests that feels too repetitive, but this might be just me, and it might a good thing for such test docs.

@Bidon15
Copy link
Member Author

Bidon15 commented Aug 29, 2022

Cool. I like the taken documentation approach.

A few comments:

  • Syncing and dasing from the network perspective are the same. What for full Nodes is block syncing for light nodes is block dasing. This means that tc-002 == tc-004 and tc-003 == tc-005. So we can keep -das- cases only for lights and -sync only for fulls(right now, both sync and das cases mention Full/Light node types) or combine equal tests into one.
  • There is a lot of common text between tests that feels too repetitive, but this might be just me, and it might a good thing for such test docs.

Thanks for the review!

Ok. Then I'll redo cases tc -> 002 004 003 005 to be specific to either Full or Light

Yes. The general idea of test-case is to as atomic as possible from a description pov. Having dependencies between tests (both execution and text desc) is a bad design choice

Bidon15 and others added 2 commits August 29, 2022 16:16
Co-authored-by: Hlib Kanunnikov <hlibwondertan@gmail.com>
Co-authored-by: Hlib Kanunnikov <hlibwondertan@gmail.com>
Copy link
Member

@Wondertan Wondertan left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Great job! Thanks

@Bidon15 Bidon15 merged commit 8d7d3a3 into celestiaorg:main Aug 29, 2022
@Bidon15 Bidon15 deleted the test_plan_001 branch August 29, 2022 16:31
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

docs: Test-case creation docs: create a kick-off test plan
3 participants