allow functional tests to be used externally with a dynamic signer factory by devrandom · Pull Request #3016 · lightningdevkit/rust-lightning

devrandom · 2024-04-24T12:09:20Z

codecov-commenter · 2024-04-24T13:31:37Z

Codecov Report

Attention: Patch coverage is 81.54206% with 79 lines in your changes missing coverage. Please review.

Project coverage is 88.56%. Comparing base (6cf270d) to head (21098e6).

Files with missing lines	Patch %	Lines
lightning-macros/src/lib.rs	45.45%	41 Missing and 1 partial ⚠️
lightning/src/util/dyn_signer.rs	68.62%	16 Missing ⚠️
lightning/src/util/test_channel_signer.rs	7.14%	13 Missing ⚠️
lightning/src/util/test_utils.rs	85.71%	3 Missing ⚠️
lightning/src/events/mod.rs	50.00%	2 Missing ⚠️
lightning/src/ln/onion_utils.rs	66.66%	2 Missing ⚠️
lightning/src/util/mut_global.rs	96.66%	1 Missing ⚠️

Additional details and impacted files

@@ Coverage Diff @@## main #3016 +/- ##
==========================================
- Coverage 88.61% 88.56% -0.06% 
==========================================
Files 149 152 +3 Lines 117091 117270 +179 Branches 117091 117270 +179 ==========================================
+ Hits 103765 103863 +98 - Misses 10817 10889 +72 - Partials 2509 2518 +9

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

devrandom · 2024-09-24T21:32:31Z

one more idea. it would be nice to collect all the tests of a file into a static array. this would require one of the following to automatically collect the array:

putting the functional tests inside mod {}
or, using the inventory or linkme crates as a dev dependency
~~or, using lazy_static, but we'll need a second macro, e.g. xtest_collect and compile error if it's forgotten will be a bit confusing~~ this doesn't work because of constness requirements

TheBlueMatt · 2025-02-28T15:54:25Z

Ugh sorry this needs rebase after #3604. Should clean a few things up nicely though.

devrandom · 2025-03-01T03:11:34Z

no problem, rebase done

TheBlueMatt

Okay, one last comment now that its been rebased, then I'm happy to land this 🎉

We want to allow functional tests to be run by other project, allowing them to replace components, such as the signer.

Can be used for specifying dynamic components for tests, such as the signer.

DynSigner provides an abstraction for specifying an external signer for functional tests.

Also, introduce TestSignerFactory, a factory for dynamic signers and ext-functional-test-demo crate for testing this machinery.

devrandom · 2025-03-04T01:03:46Z

fixed rustfmt nit

TheBlueMatt

Gonna go ahead and land this, but there's a few things we'll need to clean up in a followup.

TheBlueMatt · 2025-03-04T15:52:36Z

 	///
 	/// LDK will not automatically retry this payment, though it may be manually re-sent after an
 	/// [`Event::PaymentFailed`] is generated.
+	#[cfg(any(test, feature = "_test_utils"))]


Looks like this wasn't removed.

TheBlueMatt · 2025-03-04T15:53:13Z

 	/// could not return a signature immediately.
-	#[cfg(test)]
-	pub fn enable_channel_signer_op(&self, peer_id: &PublicKey, chan_id: &ChannelId, signer_op: SignerOp) {
+ pub fn enable_channel_signer_op(&self, peer_id: &PublicKey, chan_id: &ChannelId, signer_op: SignerOp) {


Here and the next method down have indentation issues now.

TheBlueMatt · 2025-03-04T15:54:04Z

- error_code,
- #[cfg(test)]
- error_data, .. } => {
+ error_code,


Oops, weird indentation here too.

TheBlueMatt · 2025-03-04T15:56:23Z

 // This is a regression test for https://github.com/lightningdevkit/rust-lightning/issues/3537.
-#[test]
+#[xtest(feature = "_externalize_tests")]
 fn test_multiple_package_conflicts() {


Missing pub here

TheBlueMatt · 2025-03-04T15:57:19Z

 }

-fn do_test_static_spendable_outputs_justice_tx_revoked_commitment_tx(split_tx: bool) {
+pub fn do_test_static_spendable_outputs_justice_tx_revoked_commitment_tx(split_tx: bool) {


Doesn't need to be pub here.

TheBlueMatt · 2025-03-04T15:59:29Z


-#[test]
+#[xtest(feature = "_externalize_tests")]
 fn test_nondust_htlc_excess_fees_are_dust() {


Missing pub

TheBlueMatt · 2025-03-04T16:04:09Z


-#[test]
+#[xtest(feature = "_externalize_tests")]
 fn test_funding_signed_event() {


Missing pub

Trivial #3016 followups

devrandom commented Apr 24, 2024
View reviewed changes

Comment threadmut-global/src/lib.rs Outdated

devrandom force-pushed the 2024-04-ext-test branch from 1a142e1 to 4077bc2Compare April 24, 2024 14:39

tnull reviewed Apr 24, 2024
View reviewed changes

Comment threadext-test-macro/Cargo.toml Outdated

devrandom force-pushed the 2024-04-ext-test branch from 4077bc2 to 3a1986cCompare April 24, 2024 15:32

devrandom commented Apr 24, 2024
View reviewed changes

Comment threadlightning/src/sign/mod.rs Outdated

devrandom commented Apr 24, 2024
View reviewed changes

Comment threadlightning/src/sign/mod.rs Outdated

devrandom commented Apr 24, 2024
View reviewed changes

Comment threadlightning/src/util/mut_global.rs Outdated

devrandom force-pushed the 2024-04-ext-test branch 2 times, most recently from 9d4e233 to f341a0cCompare April 25, 2024 09:02

devrandom commented Apr 25, 2024
View reviewed changes

Comment threadlightning/src/util/dyn_signer.rs Outdated

devrandom force-pushed the 2024-04-ext-test branch 6 times, most recently from 87aadef to 4efd374Compare April 26, 2024 08:19

devrandom marked this pull request as ready for review April 26, 2024 08:20

devrandom force-pushed the 2024-04-ext-test branch 3 times, most recently from 3c454d0 to ef8f13dCompare April 27, 2024 11:39

TheBlueMatt reviewed May 8, 2024
View reviewed changes

devrandom force-pushed the 2024-04-ext-test branch 5 times, most recently from fd35254 to 2e2df96Compare September 24, 2024 20:34

devrandom force-pushed the 2024-04-ext-test branch 2 times, most recently from 84abf70 to 0a29d64Compare September 25, 2024 12:32

devrandom force-pushed the 2024-04-ext-test branch from 6879363 to dceae89Compare February 26, 2025 17:22

TheBlueMatt reviewed Feb 26, 2025
View reviewed changes

devrandom force-pushed the 2024-04-ext-test branch 2 times, most recently from f987683 to dfda072Compare February 27, 2025 00:12

devrandom force-pushed the 2024-04-ext-test branch 2 times, most recently from 0734677 to fecc6c2Compare March 1, 2025 03:11

devrandom force-pushed the 2024-04-ext-test branch 2 times, most recently from 6223c18 to 8db5ba6Compare March 1, 2025 03:41

TheBlueMatt reviewed Mar 3, 2025
View reviewed changes

Comment threadlightning/src/util/test_utils.rs Outdated

devrandom force-pushed the 2024-04-ext-test branch from 8db5ba6 to 120270cCompare March 3, 2025 19:24

wpaulino reviewed Mar 3, 2025
View reviewed changes

Comment threadlightning/src/util/mut_global.rs
Comment threadlightning/src/util/dyn_signer.rs Outdated
Comment threadlightning/src/util/dyn_signer.rs Outdated
Comment threadlightning/src/util/dyn_signer.rs Outdated

devrandom added 2 commits March 3, 2025 21:26

Introduce xtest macro for externally-visible tests
adf2f68
We want to allow functional tests to be run by other project, allowing them to replace components, such as the signer.

Add a MutGlobal utility
60222d0
Can be used for specifying dynamic components for tests, such as the signer.

devrandom force-pushed the 2024-04-ext-test branch from 120270c to bec117aCompare March 3, 2025 20:26

wpaulino previously approved these changes Mar 3, 2025
View reviewed changes

devrandom added 3 commits March 4, 2025 02:03

Introduce DynSigner, a dynamically dispatched signer
17cd6e3
DynSigner provides an abstraction for specifying an external signer for functional tests.

Expose functional tests under _externalize_tests feature flag
e41e756
Also, introduce TestSignerFactory, a factory for dynamic signers and ext-functional-test-demo crate for testing this machinery.

Run externalized tests in CI
9d8a91a

devrandom dismissed wpaulino’s stale review via 9d8a91aMarch 4, 2025 01:03

devrandom force-pushed the 2024-04-ext-test branch from bec117a to 9d8a91aCompare March 4, 2025 01:03

wpaulino approved these changes Mar 4, 2025
View reviewed changes

TheBlueMatt approved these changes Mar 4, 2025
View reviewed changes

TheBlueMatt merged commit df68774 into lightningdevkit:mainMar 4, 2025

devrandom added a commit to lightning-signer/rust-lightning that referenced this pull request Mar 4, 2025
Fix nits fromlightningdevkit#3016
abee659

TheBlueMatt added a commit that referenced this pull request Mar 4, 2025
Merge pull request#3643from TheBlueMatt/2025-03-3016-followups
7188d5b
Trivial #3016 followups

This was referenced Mar 5, 2025
[Early Draft][Splicing] Partial, perform interactive transaction negotiation for new funding #3444
Closed
[Splicing] Partial, handle splice_init & splice_ack messages #3407
Merged

Uh oh!

Conversation

devrandom commented Apr 24, 2024• edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

codecov-commenter commented Apr 24, 2024• edited by codecov BotLoading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

devrandom commented Sep 24, 2024• edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

TheBlueMatt commented Feb 28, 2025

Uh oh!

devrandom commented Mar 1, 2025

Uh oh!

TheBlueMatt left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

devrandom commented Mar 4, 2025

Uh oh!

TheBlueMatt left a comment

Choose a reason for hiding this comment

Uh oh!

TheBlueMattMar 4, 2025

Choose a reason for hiding this comment

Uh oh!

TheBlueMattMar 4, 2025

Choose a reason for hiding this comment

Uh oh!

TheBlueMattMar 4, 2025

Choose a reason for hiding this comment

Uh oh!

TheBlueMattMar 4, 2025

Choose a reason for hiding this comment

Uh oh!

TheBlueMattMar 4, 2025

Choose a reason for hiding this comment

Uh oh!

TheBlueMattMar 4, 2025

Choose a reason for hiding this comment

Uh oh!

TheBlueMattMar 4, 2025

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

devrandom commented Apr 24, 2024•
edited
Loading

codecov-commenter commented Apr 24, 2024•
edited by codecov Bot
Loading

devrandom commented Sep 24, 2024•
edited
Loading