fuzz: add more coverage for `ScriptPubKeyMan` #30134

brunoerg commented at 8:39 PM on May 17, 2024: contributor

This PR adds more coverage for ScriptPubKeyMan:

Check GetKey and HasPrivKey after adding descriptor key.
Cover GetEndRange and GetKeyPoolSize.
Cover MarkUnusedAddresses with the scripts from ScriptPubKeys and GetMetadata with the destinations from them.

fuzz: add more coverage for `ScriptPubKeyMan` e3249f2111

DrahtBot commented at 8:39 PM on May 17, 2024: contributor

The following sections might be updated with supplementary metadata relevant to reviewers and maintainers.

Code Coverage

For detailed information about the code coverage, see the test coverage report.

Reviews

See the guideline for information on the review process.

Type	Reviewers
ACK	marcofleon, murchandamus

If your review is incorrectly listed, please react with 👎 to this comment and the bot will ignore it on the next update.

Conflicts

Reviewers, this pull request conflicts with the following ones:

#28333 (wallet: Construct ScriptPubKeyMans with all data rather than loaded progressively by achow101)

If you consider this pull request important, please also help to review the conflicting pull requests. Ideally, start with the one that should be merged first.

DrahtBot added the label Tests on May 17, 2024

in src/wallet/test/fuzz/scriptpubkeyman.cpp:35 in e6f89cc982 outdated

  30 | -#include <map>
  31 | -#include <memory>
  32 | -#include <optional>
  33 | -#include <string>
  34 | -#include <utility>
  35 | -#include <variant>

maflcko commented at 8:31 AM on May 18, 2024:

Can you explain this change?

wallet/test/fuzz/scriptpubkeyman.cpp should add these lines:
#include <assert.h>                        // for assert
#include <functional>                      // for function
#include <map>                             // for map
#include <memory>                          // for unique_ptr, shared_ptr, make_unique, __shared_ptr_access
#include <optional>                        // for optional, nullopt, nullopt_t
#include <unordered_set>                   // for unordered_set, _Node_iterator
#include <utility>                         // for pair, make_pair, move
#include <variant>                         // for get_if
#include "addresstype.h"                   // for PKHash, ExtractDestination, IsValidDestination, CTxDestination
#include "chain.h"                         // for CChain, CBlockIndex
#include "chainparams.h"                   // for SelectParams
#include "coins.h"                         // for Coin
#include "key.h"                           // for CKey, operator==
#include "primitives/transaction.h"        // for CMutableTransaction, TransactionSerParams, TX_WITH_WITNESS, COutPoint
#include "psbt.h"                          // for PartiallySignedTransaction, PrecomputePSBTData
#include "pubkey.h"                        // for CPubKey
#include "script/descriptor.h"             // for Descriptor, Parse
#include "script/interpreter.h"            // for PrecomputedTransactionData
#include "script/script.h"                 // for CScript
#include "script/signingprovider.h"        // for FlatSigningProvider
#include "sync.h"                          // for MaybeCheckNotHeld, LOCK, UniqueLock
#include "util/hasher.h"                   // for SaltedSipHasher
#include "util/result.h"                   // for Result
#include "util/strencodings.h"             // for string, char_traits, string_view
#include "util/translation.h"              // for bilingual_str
#include "wallet/types.h"                  // for isminetype

https://api.cirrus-ci.com/v1/task/5472392502312960/logs/ci.log

brunoerg commented at 9:02 AM on May 18, 2024:

Nevermind, just dropped this change.

brunoerg force-pushed on May 18, 2024

marcofleon commented at 2:21 PM on May 19, 2024: contributor

I generated a coverage report for the current ScriptPubKeyMan harness and for the updated harness in this PR.

Before: <img width="1175" alt="Screenshot 2024-05-19 at 6 18 27 AM" src="https://github.com/bitcoin/bitcoin/assets/95179662/28d115e6-c217-4c09-b332-914690dba6b0"> <img width="1175" alt="Screenshot 2024-05-19 at 6 18 37 AM" src="https://github.com/bitcoin/bitcoin/assets/95179662/1eff22e5-dfd1-4a52-a222-78c245a633e4">

After: <img width="1174" alt="Screenshot 2024-05-19 at 7 06 41 AM" src="https://github.com/bitcoin/bitcoin/assets/95179662/bfcc584f-f3aa-4822-a060-f67543a0e8dc"> <img width="1173" alt="Screenshot 2024-05-19 at 7 06 54 AM" src="https://github.com/bitcoin/bitcoin/assets/95179662/a865028b-5e10-4abd-9fca-74c927f80f19">

So more coverage in scriptpubkeyman.cpp but it seems less total coverage when running the indivdual harness. My question here is do the totals matter when fuzzing a single target. Because there are probably other harnesses that would hit those other files (other than scriptpubkeyman.cpp).

Basically, does total coverage only matter when generating a report from fuzzing all the targets?

brunoerg commented at 7:51 PM on May 19, 2024: contributor

I generated a coverage report for the current ScriptPubKeyMan harness and for the updated harness in this PR. @marcofleon It's good to mention how you run it. How many hours? From seed corpus (note that changes can invalidate it)?

marcofleon commented at 1:43 PM on May 20, 2024: contributor

Got it, thanks @brunoerg. I'll redo and get back to you then. I also realized I was looking at the wrong line in the coverage report. I should probably be looking at wallet/scriptpubkeyman.cpp not wallet/test/fuzz/scriptpubkeyman.cpp.

marcofleon commented at 2:58 PM on May 31, 2024: contributor

Tested ACK e3249f21111f1dd4beb66f10af933c34a36c30ac. I ran the updated harness for ~9 hours on an empty corpus, generated a coverage report, and checked that the new functions mentioned were hit. Coverage of scriptpubkeyman.cpp increased.

murchandamus commented at 8:16 PM on May 31, 2024: contributor

Tested ACK e3249f21111f1dd4beb66f10af933c34a36c30ac

I also fuzzed a bit: I ran a recent commit of the master branch and this PR’s e3249f21111f1dd4beb66f10af933c34a36c30ac against qa-assets:HEAD and then again after fuzzing about 12 CPU hours on top of qa-assets:HEAD.

	`qa-assets`	`qa-assets` + fuzzing
`master`	cov: 16525 ft: 96185	cov: 16874 ft: 104431
#30134: e3249f21111f1dd4beb66f10af933c34a36c30ac	cov: 17095 ft: 83926	cov: 17699 ft: 98966

This PR increases the coverage with the existing seeds and further improves even after light fuzzing.

fanquake merged this on Jun 3, 2024

fanquake closed this on Jun 3, 2024

bitcoin locked this on Jun 3, 2025