Add skips and comments for certain mutants

[ASuciuX]

Related issue #4587

List of PRs addressed:

• [x] #4412
• [x] #4414
• [x] #4527
• [x] #4530
• [x] #4556
• [x] #4560
• [x] #4561
• [x] #4575
• [x] #4576
• [x] #4578

[codecov[bot]]

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Project coverage is 83.18%. Comparing base (f9e9791) to head (dbacf43). Report is 9 commits behind head on next.

Additional details and impacted files

@@            Coverage Diff             @@
##             next    #4604      +/-   ##
==========================================
- Coverage   83.58%   83.18%   -0.41%     
==========================================
  Files         471      465       -6     
  Lines      337958   330892    -7066     
  Branches      317        0     -317     
==========================================
- Hits       282486   275248    -7238     
- Misses      55464    55644     +180     
+ Partials        8        0       -8     

Files	Coverage Δ
stackslib/src/burnchains/db.rs	80.64% <ø> (-0.02%)	:arrow_down:
stackslib/src/burnchains/mod.rs	82.64% <ø> (-0.09%)	:arrow_down:
stackslib/src/chainstate/burn/db/sortdb.rs	91.90% <ø> (-0.04%)	:arrow_down:
stackslib/src/chainstate/coordinator/mod.rs	62.06% <ø> (-2.63%)	:arrow_down:
stackslib/src/chainstate/stacks/boot/mod.rs	94.74% <ø> (-0.02%)	:arrow_down:
stackslib/src/chainstate/stacks/db/blocks.rs	89.84% <ø> (-0.24%)	:arrow_down:
stackslib/src/chainstate/stacks/miner.rs	81.43% <ø> (+0.27%)	:arrow_up:
stackslib/src/main.rs	0.06% <ø> (ø)
...-node/src/burnchains/bitcoin_regtest_controller.rs	87.54% <ø> (-0.64%)	:arrow_down:
testnet/stacks-node/src/config.rs	65.48% <ø> (-0.42%)	:arrow_down:
... and 3 more

... and 355 files with indirect coverage changes

---

Continue to review full report in Codecov by Sentry.

Legend - Click here to learn more Δ = absolute <relative> (impact), ø = not affected, ? = missing data Powered by Codecov. Last update f9e9791...dbacf43. Read the comment docs.

[ASuciuX]

This follows the same structure as https://github.com/stacks-network/stacks-core/pull/4593 which was previously merged. It includes the mutants for multiple PRs.

[ASuciuX]

I think the associated comments should be regular comments, not doc comments. cargo doc is great for figuring out how to use an API, and these comments don't help anyone actually use the functions

Those comments act as placeholders for missing tests, they should be reference for who wants to write the test cases that are in the comments and aren't treated by the functions. There should be something on the code to point to the specific missing cases so that a developer could know which test cases to add. Would it be enough to change them to simple comments instead of doc comments? Or do you think we should move them somewhere externally but also keep a short reference so that the cases can be seen when going to that external source. Also curious what that external source should be and how should I give access to the others to modify it if some of the tests are added.

[jbencin]

Would it be enough to change them to simple comments instead of doc comments?

This is fine by me. Although you should add a second reviewer on here for another opinion

[ASuciuX]

Would it be enough to change them to simple comments instead of doc comments?

This is fine by me. Although you should add a second reviewer on here for another opinion

I've added the blockchain team, but it treated your review in that behalf, so I'll add it again.

[ASuciuX]

@jbencin I've updated this to have regular comments

[ASuciuX]

As this is outdated and for next branch, I will move it to develop.

[ASuciuX]

Migrated the PR here https://github.com/stacks-network/stacks-core/pull/4790.