Add raft scenarios for uncovered retirement and reconfiguration branches in raft.h
Maintainers usually reply within 1 day
Nobody has claimed this yet.
Assessment
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Newbie friendliness
- 38/100
- Issue type
- Feature
- Clarity
- Clearly specified
- Activity status
- Active
- Tech stack
- cpp
- Domain
- distributed-systems, testing-qa
Research direction
Start by reading src/consensus/raft/raft.h and the existing tests in tests/raft_scenarios/, especially scenarios added by #8433. Trace the three retirement, vote, and rollback branches and model the required multi-node interleavings. Done means scenarios cover all three branches and pass the CI trace validation against the TLA+ specification.
Written by the indexing model from the issue text.
Description
NOTE: This type of issue is reserved for the project team. If you are not a member of the team, please use either the bug or feature templates.
What is the motivation for this task
#8433 adds negative-path raft_test cases for src/consensus/aft/raft.h. Its description lists three retirement and reconfiguration interleavings that are reachable, but whose branches are still not covered by raft_test or raft_scenario_test:
commit(): a node whose retirement is Signed commits an index belowretirement_committable_idx, soidx >= retirement_committableis false.recv_propose_request_vote(): aProposeRequestVotereaches a node whose retirement is committed, so!is_retired_committed()is false.rollback(): a rollback removes every configuration, so the configuration rollback loop ends becauseconfigurationsis empty.
These need multi-node interleavings, so they are better written as scenarios in tests/raft_scenarios/, which CI also trace-validates against the TLA+ spec, than as more raft_test fixtures. This was raised in review of #8433 and deferred from it.
Dependencies
None blocking. Measuring the coverage gain is simplest once #8433 has merged.
Describe impact if task is not completed
These raft.h branches stay untested by the consensus unit and scenario tests, so a regression in them would not be caught there, and they keep counting as missed branches in raft.h coverage.
- Dominant language
- C++
- Stars
- 874
- Forks
- 263
- Avg merge
- 1d 14h
- Merged PRs (30d)
- 157
Getting set up
Starts the project's dev container in your browser, under your own GitHub account.
- No Dockerfile or Docker Compose file
- Has a pull request template
- Read the contributing guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from microsoft/CCF
-
Difficulty 5/5 Over a week Newbie friendliness 25/100
Maintainers usually reply within 1 day
-
Difficulty 5/5 Over a week Newbie friendliness 30/100
microsoft/CCF#8184 · 1 comment ·
Maintainers usually reply within 1 day
-
Encrypt private ledger data directly into serialised entriesPossibly taken @achamayou claimed this 8 days ago. Opencrypto enhancement performance
Difficulty 5/5 Over a week Newbie friendliness 42/100
microsoft/CCF#8169 · 1 reaction · 2 assignees ·
Maintainers usually reply within 1 day
-
Hybrid (classical crypto + PQ) TLS in CCFMay be free again A pull request for this issue was closed without being merged. Open
Difficulty 5/5 Over a week Newbie friendliness 25/100
Maintainers usually reply within 1 day
-
Difficulty 4/5 3-5 days Newbie friendliness 68/100
microsoft/CCF#8043 · 1 comment ·
Maintainers usually reply within 1 day
Similar issues
-
Difficulty 2/5 1-3 hours Newbie friendliness 85/100
objectionary/eo-graphs#80 ·
-
bug C/C++ code
Difficulty 1/5 Under an hour Newbie friendliness 78/100
webarkit/WebARKitLib#85 ·
Maintainers usually reply within 1 day
-
Difficulty 1/5 Under an hour Newbie friendliness 72/100
-
[request] vsg/1.1.16Openupstream update
Difficulty 2/5 1-3 hours Newbie friendliness 65/100
conan-io/conan-center-index#31142 ·
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 72/100