Expand unit tests to cover premature struct return value deallocation detection.

Author: arik-so

ci/LDKSwift/Tests/LDKSwiftTests/HumanObjectPeerTestInstance.swift

@@ -19,6 +19,7 @@ public class HumanObjectPeerTestInstance {
 //
         public var useFilter: Bool = false
         public var useRouter: Bool = false
+        public var useWrappedSignerProvider: Bool = false
         public var shouldRecipientRejectPayment: Bool = false
         public var ephemeralNetworkGraphForScorer: Bool = false
         public var reserializedProbabilisticScorer: Bool = false
@@ -31,7 +32,7 @@ public class HumanObjectPeerTestInstance {
         // public var use_nio_peer_handler: Bool = false;
 
         private class func listCustomizeableProperties() -> [String] {
-            return ["useFilter", "useRouter", "shouldRecipientRejectPayment", "ephemeralNetworkGraphForScorer", "reserializedProbabilisticScorer"]
+            return ["useFilter", "useRouter", "useWrappedSignerProvider", "shouldRecipientRejectPayment", "ephemeralNetworkGraphForScorer", "reserializedProbabilisticScorer"]
         }
 
         public class func combinationCount() -> UInt {
@@ -57,6 +58,7 @@ public class HumanObjectPeerTestInstance {
         let monitors: [String: ChannelMonitor]
         private(set) var filter: Filter?
         private(set) var explicitKeysManager: KeysManager!
+        private(set) var wrappedSignerProvider: SignerProvider?
         private(set) var router: GossipSync!
         private(set) var channelManager: ChannelManager!
         private(set) var peerManager: PeerManager!
@@ -288,10 +290,15 @@ public class HumanObjectPeerTestInstance {
             let keysManager = KeysManager(seed: keySeed, startingTimeSecs: timestamp_seconds, startingTimeNanos: timestamp_nanos)
             self.explicitKeysManager = keysManager
 
+            if master.configuration.useWrappedSignerProvider {
+                let keysManager = WrappedSignerProviderTests.MyKeysManager(seed: keySeed, startingTimeSecs: timestamp_seconds, startingTimeNanos: timestamp_nanos)
+                self.wrappedSignerProvider = keysManager.signerProvider;
+            }
+
             if master.configuration.useRouter {
                 let networkGraph = NetworkGraph(network: .Regtest, logger: self.logger)
                 self.router = GossipSync.initWithP2P(a: P2PGossipSync(networkGraph: networkGraph, utxoLookup: nil, logger: self.logger))
-            }else{
+            } else {
                 self.router = GossipSync.none()
             }
         }
@@ -317,18 +324,20 @@ public class HumanObjectPeerTestInstance {
                 }
                 let score = probabalisticScorer.asScore()
                 let multiThreadedScorer = MultiThreadedLockableScore(score: score)
-                
+
+                let signerProvider = master.configuration.useWrappedSignerProvider ? self.wrappedSignerProvider! : self.explicitKeysManager.asSignerProvider()
                 let constructionParameters = ChannelManagerConstructionParameters(
                     config: UserConfig.initWithDefault(),
                     entropySource: self.explicitKeysManager.asEntropySource(),
                     nodeSigner: self.explicitKeysManager.asNodeSigner(),
-                    signerProvider: self.explicitKeysManager.asSignerProvider(),
+                    signerProvider: signerProvider,
                     feeEstimator: self.feeEstimator,
                     chainMonitor: self.chainMonitor!,
                     txBroadcaster: self.txBroadcaster,
                     logger: self.logger,
                     scorer: multiThreadedScorer
                 )
+
                 self.constructor = ChannelManagerConstructor(network: .Bitcoin, currentBlockchainTipHash: [UInt8](repeating: 0, count: 32), currentBlockchainTipHeight: 0, netGraph: graph, params: constructionParameters)
 
                 self.constructor?.chainSyncCompleted(persister: TestChannelManagerPersister(master: self))
@@ -345,7 +354,7 @@ public class HumanObjectPeerTestInstance {
             do {
                 // channel manager constructor is mandatory
                 let graph = NetworkGraph(network: .Bitcoin, logger: self.logger)
-                
+
                 let constructionParameters = ChannelManagerConstructionParameters(
                     config: UserConfig.initWithDefault(),
                     entropySource: self.explicitKeysManager.asEntropySource(),

ci/LDKSwift/Tests/LDKSwiftTests/LDKSwiftTests.swift

@@ -475,10 +475,13 @@ class LDKSwiftTests: XCTestCase {
             config.useRouter = (i & (1 << 2)) != 0
             print("useRouter: \(config.useRouter)")
 
-            config.ephemeralNetworkGraphForScorer = (i & (1 << 3)) != 0
+            config.useWrappedSignerProvider = (i & (1 << 3)) != 0
+            print("useWrappedSignerProvider: \(config.useWrappedSignerProvider)")
+            
+            config.ephemeralNetworkGraphForScorer = (i & (1 << 4)) != 0
             print("ephemeralNetworkGraphForScorer: \(config.ephemeralNetworkGraphForScorer)")
 
-            config.reserializedProbabilisticScorer = (i & (1 << 4)) != 0
+            config.reserializedProbabilisticScorer = (i & (1 << 5)) != 0
             print("reserializedProbabilisticScorer: \(config.reserializedProbabilisticScorer)")
 
             let instance = HumanObjectPeerTestInstance(configuration: config)

ci/LDKSwift/Tests/LDKSwiftTests/WrappedSignerProviderTests.swift

@@ -60,7 +60,9 @@ class WrappedSignerProviderTests: XCTestCase {
         let reversedGenesisHashHex = "6fe28c0ab6f1b372c1a6a246ae63f74f931e8365e15a089c68d6190000000000"
         let reversedGenesisHash = LDKSwiftTests.hexStringToBytes(hexString: reversedGenesisHashHex)!
         let latestBlockHash = reversedGenesisHash
-        let channelManager = ChannelManagerConstructor(network: network, currentBlockchainTipHash: latestBlockHash, currentBlockchainTipHeight: 0, netGraph: netGraph, params: channelManagerConstructionParameters)
+        let channelManagerConstructor = ChannelManagerConstructor(network: network, currentBlockchainTipHash: latestBlockHash, currentBlockchainTipHeight: 0, netGraph: netGraph, params: channelManagerConstructionParameters)
+        
+        let channelManager = channelManagerConstructor.channelManager
     }
 
     class MyKeysManager {
@@ -83,60 +85,66 @@ class WrappedSignerProviderTests: XCTestCase {
     class MyNodeSigner: NodeSigner {
         var myKeysManager: MyKeysManager?
         override func ecdh(recipient: Bindings.Recipient, otherKey: [UInt8], tweak: [UInt8]?) -> Bindings.Result_SharedSecretNoneZ {
-            print("Getting ecdh")
+            print("entering wrapper: ecdh()")
             return myKeysManager!.keysManager.asNodeSigner().ecdh(recipient: recipient, otherKey: otherKey, tweak: tweak)
         }
 
         override func getNodeId(recipient: Bindings.Recipient) -> Bindings.Result_PublicKeyNoneZ {
-            print("Getting getNodeId")
-            let nodeIdOption = myKeysManager!.keysManager.asNodeSigner().getNodeId(recipient: recipient)
-            let nodeId = nodeIdOption.getValue()!
-            return .initWithOk(o: nodeId)
+            print("entering wrapper: getNodeId()")
+            let nodeId = myKeysManager!.keysManager.asNodeSigner().getNodeId(recipient: recipient)
+            return nodeId
         }
 
         override func getInboundPaymentKeyMaterial() -> [UInt8] {
-            print("Getting getInboundPaymentKeyMaterial")
+            print("entering wrapper: getInboundPaymentKeyMaterial()")
             return myKeysManager!.keysManager.asNodeSigner().getInboundPaymentKeyMaterial()
         }
 
         override func signGossipMessage(msg: Bindings.UnsignedGossipMessage) -> Bindings.Result_SignatureNoneZ {
-            print("Getting signGossipMessage")
+            print("entering wrapper: signGossipMessage()")
             return myKeysManager!.keysManager.asNodeSigner().signGossipMessage(msg: msg)
         }
 
         override func signInvoice(hrpBytes: [UInt8], invoiceData: [UInt8], recipient: Bindings.Recipient) -> Bindings.Result_RecoverableSignatureNoneZ {
-            print("Getting signInvoice")
+            print("entering wrapper: signInvoice()")
             return myKeysManager!.keysManager.asNodeSigner().signInvoice(hrpBytes: hrpBytes, invoiceData: invoiceData, recipient: recipient)
         }
     }
 
     class MyEntropySource: EntropySource {
         var myKeysManager: MyKeysManager?
         override func getSecureRandomBytes() -> [UInt8] {
-            print("Getting getSecureRandomBytes")
+            print("entering wrapper: getSecureRandomBytes()")
             return myKeysManager!.keysManager.asEntropySource().getSecureRandomBytes()
         }
     }
 
     class MySignerProvider: SignerProvider {
         var myKeysManager: MyKeysManager?
         override func deriveChannelSigner(channelValueSatoshis: UInt64, channelKeysId: [UInt8]) -> Bindings.WriteableEcdsaChannelSigner {
+            print("entering wrapper: deriveChannelSigner()")
             return myKeysManager!.keysManager.asSignerProvider().deriveChannelSigner(channelValueSatoshis: channelValueSatoshis, channelKeysId: channelKeysId)
         }
 
         override func generateChannelKeysId(inbound: Bool, channelValueSatoshis: UInt64, userChannelId: [UInt8]) -> [UInt8] {
+            print("entering wrapper: generateChannelKeysId()")
             return myKeysManager!.keysManager.asSignerProvider().generateChannelKeysId(inbound: inbound, channelValueSatoshis: channelValueSatoshis, userChannelId: userChannelId)
         }
 
         override func readChanSigner(reader: [UInt8]) -> Bindings.Result_WriteableEcdsaChannelSignerDecodeErrorZ {
+            print("entering wrapper: readChanSigner()")
             return myKeysManager!.keysManager.asSignerProvider().readChanSigner(reader: reader)
         }
 
         override func getDestinationScript() -> [UInt8] {
+            print("entering wrapper: getDestinationScript()")
             return myKeysManager!.keysManager.asSignerProvider().getDestinationScript()
         }
 
-        override func getShutdownScriptpubkey() -> Bindings.ShutdownScript {return myKeysManager!.keysManager.asSignerProvider().getShutdownScriptpubkey()
+        override func getShutdownScriptpubkey() -> Bindings.ShutdownScript {
+            print("entering wrapper: getShutdownScriptpubkey()")
+            let scriptPubkey = myKeysManager!.keysManager.asSignerProvider().getShutdownScriptpubkey()
+            return scriptPubkey
         }
     }