Skip to content

Conversation

vasild
Copy link
Contributor

@vasild vasild commented Jan 4, 2023

Add unit tests that write data to a mocked socket and inspect what CConnman/PeerManager have written back to the socket, or check the internal state to verify that the behavior is as expected.

This is now possible, after most of #21878 has been merged - we don't do any syscalls (e.g. connect(), recv()) from the high level code and using a mocked socket allows testing the entire networking stack without opening actual network connections.

@DrahtBot
Copy link
Contributor

DrahtBot commented Jan 4, 2023

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

Code Coverage & Benchmarks

For details see: https://corecheck.dev/bitcoin/bitcoin/pulls/26812.

Reviews

See the guideline for information on the review process.

Type Reviewers
Concept ACK Sjors
Stale ACK jonatack

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:

  • #33300 (fuzz: compact block harness by Crypt-iQ)
  • #33210 (fuzz: enhance wallet_fees by mocking mempool stuff by brunoerg)
  • #33191 (net: Provide block templates to peers on request by ajtowns)
  • #32747 (Introduce SockMan ("lite"): low-level socket handling for HTTP by pinheadmz)
  • #32724 (Musig2 tests by w0xlt)

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 DrahtBot added the Tests label Jan 4, 2023
@vasild
Copy link
Contributor Author

vasild commented Jan 12, 2023

9b7e9dad27...daee83c1c5: optimize the fuzz test a bit

@vasild
Copy link
Contributor Author

vasild commented Feb 9, 2023

32ab679f54...7c591c868d: rebase due to conflicts

@vasild
Copy link
Contributor Author

vasild commented Feb 20, 2023

7c591c868d...a81fe4ff9b: rebase and put the fuzz tests in fuzz/process_message.cpp instead of in a new file, as suggested.

@maflcko
Copy link
Member

maflcko commented Oct 11, 2024

Wrt "how useful is this": the first part of this PR (also isolated in #30205) is already used in Sv2Transport tests.

I followed the links but only found a closed pull requests: #30332 (comment)

I think it is easy to say that something will be used in the future, but I think it would be easier if the framework commits were added with non-redundant tests at the same time.

ryanofsky added a commit that referenced this pull request Feb 10, 2025
…nd/or CNetMessages

b448b01 test: add a mocked Sock that allows inspecting what has been Send() to it (Vasil Dimov)
f186414 test: put the generic parts from StaticContentsSock into a separate class (Vasil Dimov)
4b58d55 test: move the implementation of StaticContentsSock to .cpp (Vasil Dimov)

Pull request description:

  Put the generic parts from `StaticContentsSock` into a separate class `ZeroSock` so that they can be reused in other mocked `Sock` implementations.

  Add a new `DynSock` whose `Recv()` and `Send()` methods can be controlled after the object is created. To achieve that, the caller/creator of `DynSock` provides to its constructor two pipes (FIFOs) - recv-pipe and send-pipe. Whatever data is written to recv-pipe is later received by `DynSock::Recv()` method and whatever data is written to the socket using `DynSock::Send()` can later be found in the send-pipe. For convenience there are also two methods to send and receive `CNetMessage`s.

  ---

  This is used in #26812 (first two commits from that PR).
  Extracting as a separate PR suggested here: #30043 (comment).

ACKs for top commit:
  Sjors:
    re-ACK b448b01
  jonatack:
    re-ACK b448b01
  pinheadmz:
    ACK b448b01

Tree-SHA512: 4a36f038192ec4ef63366cbe1a38ae70e7e015630c9f7c44926b756b20ab8c08138acae41801f23b30f6629c7059c1f81e001806e86584ff1bf1fa5b44d9caec
@vasild
Copy link
Contributor Author

vasild commented Feb 11, 2025

752fbab26a...53d2c8e0e2: rebase due to conflicts

This PR is now smaller because part of it was merged via #30205, thanks!

@vasild
Copy link
Contributor Author

vasild commented Mar 20, 2025

53d2c8e0e2...c1c6a056a0: rebase due to conflicts

@DrahtBot
Copy link
Contributor

🚧 At least one of the CI tasks failed.
Task tidy: https://github.com/bitcoin/bitcoin/runs/39128326309
LLM reason (✨ experimental): clang-tidy reported explicit errors due to deprecated headers in net_msg_tests.cpp, causing the CI to fail.

Hints

Try to run the tests locally, according to the documentation. However, a CI failure may still
happen due to a number of reasons, for example:

  • Possibly due to a silent merge conflict (the changes in this pull request being
    incompatible with the current code in the target branch). If so, make sure to rebase on the latest
    commit of the target branch.

  • A sanitizer issue, which can only be found by compiling with the sanitizer and running the
    affected test.

  • An intermittent issue.

Leave a comment here, if you need help tracking down a confusing failure.

@vasild
Copy link
Contributor Author

vasild commented Jun 13, 2025

c1c6a056a0...bfe72353c0: rebase and silence a new tidy error about headers - assert.h vs cassert

Throwing an exception from the destructor of a class is a bad practice
because the destructor will be called when an object of that type is
alive on the stack and another exception is thrown, which will result
in "exception during the exception". This would terminate the program
without any messages.

Instead print the message to the standard error output and call
`std::abort()`.
Extend `DebugLogHelper::~DebugLogHelper()` to be able to
optionally wait for messages, possibly logged from another thread, to
arrive before performing the final check.
…anager

Add tests that use a mocked socket to similate network IO and cover the
full `CConnman`, `PeerManager` and the interaction between them.
@vasild
Copy link
Contributor Author

vasild commented Sep 2, 2025

bfe72353c0...5d7b70161d: rebase due to conflicts

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

8 participants