Skip to content

Add documentations for tests in json #557

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.

Sign up for GitHub

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

Merged
GalRogozinski merged 23 commits into from
Jul 23, 2025
Merged

Add documentations for tests in json #557

Show file tree
Hide file tree
Changes from 9 commits
Commits
Show all changes
23 commits
Select commit Hold shift + click to select a range
e24a63d
add test type name for types package tests'
alan-ssvlabs Jun 24, 2025
f7f11ab
fix bug in two tests
alan-ssvlabs Jun 24, 2025
1814998
add types for qbft tests
alan-ssvlabs Jun 25, 2025
40acef0
add test types for ssv tests
alan-ssvlabs Jun 26, 2025
ca0a2b1
add documentations for types test
alan-ssvlabs Jun 26, 2025
552e9cb
add docs for qbft tests
alan-ssvlabs Jun 27, 2025
a7c07b2
add docs for ssv tests
alan-ssvlabs Jun 27, 2025
12d965b
remove josn omitempty
alan-ssvlabs Jun 27, 2025
ada6ca4
add descriptions for each test type
alan-ssvlabs Jun 27, 2025
aab64da
merge with main
alan-ssvlabs Jul 9, 2025
ac636bd
add prepare message back in two tests
alan-ssvlabs Jul 9, 2025
68969ff
fix omitempty problem
alan-ssvlabs Jul 10, 2025
12a1eaf
fix omitempty problem in valcheck test
alan-ssvlabs Jul 10, 2025
b58a927
add docs for missing tests
alan-ssvlabs Jul 11, 2025
49ac837
Merge branch 'main' into test_docs
GalRogozinski Jul 17, 2025
82354a5
move types test doc to a separate file
alan-ssvlabs Jul 22, 2025
69502a7
move qbft test doc to one file for
alan-ssvlabs Jul 22, 2025
597bcea
move ssv test doc to a separate file
alan-ssvlabs Jul 22, 2025
cfc810c
regenerate tests
alan-ssvlabs Jul 22, 2025
b390cc0
merge with main
alan-ssvlabs Jul 22, 2025
c8bd44d
bug fix
alan-ssvlabs Jul 22, 2025
f393c98
bug fix
alan-ssvlabs Jul 22, 2025
bde0c1a
remove println
alan-ssvlabs Jul 23, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
2 changes: 1 addition & 1 deletion qbft/messages_encoding.go
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion qbft/spectest/all_tests.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -132,7 +132,7 @@ var AllTests = []tests.TestF{
proposal.NotPreparedPreviouslyJustification,
proposal.PreparedPreviouslyJustification,
proposal.DifferentJustifications,
proposal.JustificationsNotHeighest,
proposal.JustificationsNotHighest,
proposal.DuplicateMsg,
proposal.DuplicateMsgDifferentRoot,
proposal.FirstRoundJustification,
Expand Down
2 changes: 2 additions & 0 deletions .../generate/state_comparison/tests_CreateMsgSpecTest/qbft create message create commit.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
{
"Name": "create commit",
"Type": "Message creation: validation of consensus message construction and encoding",
"Documentation": "Test creating a commit message for QBFT consensus.",
"Value": [
1,
2,
Expand Down
2 changes: 2 additions & 0 deletions ...generate/state_comparison/tests_CreateMsgSpecTest/qbft create message create prepare.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
{
"Name": "create prepare",
"Type": "Message creation: validation of consensus message construction and encoding",
"Documentation": "Test creating a prepare message for QBFT consensus.",
"Value": [
1,
2,
Expand Down
2 changes: 2 additions & 0 deletions .../tests_CreateMsgSpecTest/qbft create message create proposal not previously prepared.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
{
"Name": "create proposal not previously prepared",
"Type": "Message creation: validation of consensus message construction and encoding",
"Documentation": "Test creating a proposal message for non-first round when not previously prepared, with round change justifications.",
"Value": [
1,
2,
Expand Down
2 changes: 2 additions & 0 deletions ...ison/tests_CreateMsgSpecTest/qbft create message create proposal previously prepared.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
{
"Name": "create proposal previously prepared",
"Type": "Message creation: validation of consensus message construction and encoding",
"Documentation": "Test creating a proposal message when previously prepared with round change and prepare justifications.",
"Value": [
1,
2,
Expand Down
2 changes: 2 additions & 0 deletions ...enerate/state_comparison/tests_CreateMsgSpecTest/qbft create message create proposal.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
{
"Name": "create proposal",
"Type": "Message creation: validation of consensus message construction and encoding",
"Documentation": "Test creating a proposal message when not previously prepared.",
"Value": [
1,
2,
Expand Down
10 changes: 6 additions & 4 deletions ...ts_CreateMsgSpecTest/qbft create message create round change no justification quorum.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,10 +1,12 @@
{
"Name": "create round change no justification quorum",
"Type": "Message creation: validation of consensus message construction and encoding",
"Documentation": "Test creating a round change message that was previously prepared but failed to extract a justification quorum, resulting in an unjustified round change.",
"Value": [
0,
0,
0,
0,
1,
2,
3,
4,
0,
0,
0,
Expand Down
2 changes: 2 additions & 0 deletions .../tests_CreateMsgSpecTest/qbft create message create round change previously prepared.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
{
"Name": "create round change previously prepared",
"Type": "Message creation: validation of consensus message construction and encoding",
"Documentation": "Test creating a round change message when previously prepared with justifications.",
"Value": [
1,
2,
Expand Down
2 changes: 2 additions & 0 deletions ...ate/state_comparison/tests_CreateMsgSpecTest/qbft create message create round change.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
{
"Name": "create round change",
"Type": "Message creation: validation of consensus message construction and encoding",
"Documentation": "Test creating a round change message when not previously prepared.",
"Value": [
1,
2,
Expand Down
121 changes: 1 addition & 120 deletions ...rocessingSpecTest/qbft message processing duplicate prepare msg justification quorum.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -326,126 +326,7 @@
}
},
"PrepareContainer": {
"Msgs": {
"2": [
{
"SignedMessage": {
"Signatures": [
"Y/8iTrzszSrCJ1FCVwsmHgCheHG5pHA0NowMfsT7bf2WXznzCIgHL6Swvl/AohfqQ1/qGXvR97bft+haaR6UfhRk/RlcRZT3AR3ssfyqzFVm1q0MIhS+FJFmNDpO8uFnk87wFzXiGUgdnEZRm36kI+Rlld/xQnURvpswhiKK0RUJrlW0gYvls0LWX/fOIbiifFsI6SmGfH5CD482JjrFPyy5SDaOR62Q+s4vWtIzNVL4WaUZAMyv2fewi/Pz4JSoDYUfXXdTvU8G6NpfQPit4G87EBLHXAuHWDtW8asc7T7EELqYq0TU0m4sqXiXZpJFGXuQX211C2/4xgHqFKaTYQ=="
],
"OperatorIDs": [
1
],
"SSVMessage": {
"MsgType": 0,
"MsgID": [
1,
2,
3,
4,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0
],
"Data": "AQAAAAAAAAAAAAAAAAAAAAIAAAAAAAAATAAAAL6Vb7ffTvN1MWgtWIMgCE/JFMPw/tM1Jj5bRAYubCm0AAAAAAAAAACEAAAAhAAAAAECAwQAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA"
},
"FullData": null
},
"QBFTMessage": {
"MsgType": 1,
"Height": 0,
"Round": 2,
"Identifier": "AQIDBAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA=",
"Root": [
190,
149,
111,
183,
223,
78,
243,
117,
49,
104,
45,
88,
131,
32,
8,
79,
201,
20,
195,
240,
254,
211,
53,
38,
62,
91,
68,
6,
46,
108,
41,
180
],
"DataRound": 0,
"RoundChangeJustification": [],
"PrepareJustification": []
}
}
]
}
"Msgs": {}
},
"CommitContainer": {
"Msgs": {}
Expand Down
121 changes: 1 addition & 120 deletions ...ingSpecTest/qbft message processing duplicate rc msg justification (prepared) quorum.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -326,126 +326,7 @@
}
},
"PrepareContainer": {
"Msgs": {
"2": [
{
"SignedMessage": {
"Signatures": [
"Y/8iTrzszSrCJ1FCVwsmHgCheHG5pHA0NowMfsT7bf2WXznzCIgHL6Swvl/AohfqQ1/qGXvR97bft+haaR6UfhRk/RlcRZT3AR3ssfyqzFVm1q0MIhS+FJFmNDpO8uFnk87wFzXiGUgdnEZRm36kI+Rlld/xQnURvpswhiKK0RUJrlW0gYvls0LWX/fOIbiifFsI6SmGfH5CD482JjrFPyy5SDaOR62Q+s4vWtIzNVL4WaUZAMyv2fewi/Pz4JSoDYUfXXdTvU8G6NpfQPit4G87EBLHXAuHWDtW8asc7T7EELqYq0TU0m4sqXiXZpJFGXuQX211C2/4xgHqFKaTYQ=="
],
"OperatorIDs": [
1
],
"SSVMessage": {
"MsgType": 0,
"MsgID": [
1,
2,
3,
4,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0
],
"Data": "AQAAAAAAAAAAAAAAAAAAAAIAAAAAAAAATAAAAL6Vb7ffTvN1MWgtWIMgCE/JFMPw/tM1Jj5bRAYubCm0AAAAAAAAAACEAAAAhAAAAAECAwQAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA"
},
"FullData": null
},
"QBFTMessage": {
"MsgType": 1,
"Height": 0,
"Round": 2,
"Identifier": "AQIDBAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA=",
"Root": [
190,
149,
111,
183,
223,
78,
243,
117,
49,
104,
45,
88,
131,
32,
8,
79,
201,
20,
195,
240,
254,
211,
53,
38,
62,
91,
68,
6,
46,
108,
41,
180
],
"DataRound": 0,
"RoundChangeJustification": [],
"PrepareJustification": []
}
}
]
}
"Msgs": {}
},
"CommitContainer": {
"Msgs": {}
Expand Down
2 changes: 2 additions & 0 deletions ...e/state_comparison/tests_MsgSpecTest/qbft message SSZ marshalling of signed messaged.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
{
"Name": "SSZ marshalling of signed messaged",
"Type": "QBFT message validation: testing message encoding, decoding, and structural integrity",
"Documentation": "Test valid SSZ marshaling of a signed QBFT message with justifications.",
"Messages": [
{
"Signatures": [
Expand Down
2 changes: 2 additions & 0 deletions ...st/generate/state_comparison/tests_MsgSpecTest/qbft message commit data nil or len 0.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
{
"Name": "commit data nil or len 0",
"Type": "QBFT message validation: testing message encoding, decoding, and structural integrity",
"Documentation": "Test encoding of commit data for QBFT message validation.",
"Messages": [
{
"Signatures": [
Expand Down
2 changes: 2 additions & 0 deletions .../spectest/generate/state_comparison/tests_MsgSpecTest/qbft message duplicate signers.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
{
"Name": "duplicate signers",
"Type": "QBFT message validation: testing message encoding, decoding, and structural integrity",
"Documentation": "Test signed message with duplicate signers, expecting validation error.",
"Messages": [
{
"Signatures": [
Expand Down
2 changes: 2 additions & 0 deletions qbft/spectest/generate/state_comparison/tests_MsgSpecTest/qbft message get root.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
{
"Name": "get root",
"Type": "QBFT message validation: testing message encoding, decoding, and structural integrity",
"Documentation": "Test GetRoot method on signed QBFT message with justifications.",
"Messages": [
{
"Signatures": [
Expand Down
2 changes: 2 additions & 0 deletions ...test/generate/state_comparison/tests_MsgSpecTest/qbft message invalid hash data root.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
{
"Name": "invalid hash data root",
"Type": "QBFT message validation: testing message encoding, decoding, and structural integrity",
"Documentation": "Test an invalid hash data root for QBFT message validation.",
"Messages": [
{
"Signatures": [
Expand Down
2 changes: 2 additions & 0 deletions ...omparison/tests_MsgSpecTest/qbft message invalid prepare justification unmarshalling.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
{
"Name": "invalid prepare justification unmarshalling",
"Type": "QBFT message validation: testing message encoding, decoding, and structural integrity",
"Documentation": "Test unmarshalling invalid prepare justifications, expecting validation error during message validation.",
"Messages": [
{
"Signatures": [
Expand Down
Loading