_ Git - rust-lightning/blob - lightning/src/util/test_utils.rs

   1 // This file is Copyright its original authors, visible in version control
   2 // history.
   3 //
   4 // This file is licensed under the Apache License, Version 2.0 <LICENSE-APACHE
   5 // or http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
   6 // <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your option.
   7 // You may not use this file except in accordance with one or both of these
   8 // licenses.
   9
  10 use chain;
  11 use chain::WatchedOutput;
  12 use chain::chaininterface;
  13 use chain::chaininterface::ConfirmationTarget;
  14 use chain::chainmonitor;
  15 use chain::chainmonitor::MonitorUpdateId;
  16 use chain::channelmonitor;
  17 use chain::channelmonitor::MonitorEvent;
  18 use chain::transaction::OutPoint;
  19 use chain::keysinterface;
  20 use ln::features::{ChannelFeatures, InitFeatures};
  21 use ln::msgs;
  22 use ln::msgs::OptionalField;
  23 use ln::script::ShutdownScript;
  24 use routing::scoring::ScorerUsingTime;
  25 use routing::scoring::time::Eternity;
  26 use util::enforcing_trait_impls::{EnforcingSigner, EnforcementState};
  27 use util::events;
  28 use util::logger::{Logger, Level, Record};
  29 use util::ser::{Readable, ReadableArgs, Writer, Writeable};
  30
  31 use bitcoin::blockdata::constants::genesis_block;
  32 use bitcoin::blockdata::transaction::{Transaction, TxOut};
  33 use bitcoin::blockdata::script::{Builder, Script};
  34 use bitcoin::blockdata::opcodes;
  35 use bitcoin::blockdata::block::BlockHeader;
  36 use bitcoin::network::constants::Network;
  37 use bitcoin::hash_types::{BlockHash, Txid};
  38
  39 use bitcoin::secp256k1::{SecretKey, PublicKey, Secp256k1, Signature};
  40 use bitcoin::secp256k1::recovery::RecoverableSignature;
  41
  42 use regex;
  43
  44 use io;
  45 use prelude::*;
  46 use core::time::Duration;
  47 use sync::{Mutex, Arc};
  48 use core::sync::atomic::{AtomicBool, AtomicUsize, Ordering};
  49 use core::{cmp, mem};
  50 use chain::keysinterface::InMemorySigner;
  51
  52 pub struct TestVecWriter(pub Vec<u8>);
  53 impl Writer for TestVecWriter {
  54         fn write_all(&mut self, buf: &[u8]) -> Result<(), io::Error> {
  55                 self.0.extend_from_slice(buf);
  56                 Ok(())
  57         }
  58 }
  59
  60 pub struct TestFeeEstimator {
  61         pub sat_per_kw: Mutex<u32>,
  62 }
  63 impl chaininterface::FeeEstimator for TestFeeEstimator {
  64         fn get_est_sat_per_1000_weight(&self, _confirmation_target: ConfirmationTarget) -> u32 {
  65                 *self.sat_per_kw.lock().unwrap()
  66         }
  67 }
  68
  69 pub struct OnlyReadsKeysInterface {}
  70 impl keysinterface::KeysInterface for OnlyReadsKeysInterface {
  71         type Signer = EnforcingSigner;
  72
  73         fn get_node_secret(&self) -> SecretKey { unreachable!(); }
  74         fn get_destination_script(&self) -> Script { unreachable!(); }
  75         fn get_shutdown_scriptpubkey(&self) -> ShutdownScript { unreachable!(); }
  76         fn get_channel_signer(&self, _inbound: bool, _channel_value_satoshis: u64) -> EnforcingSigner { unreachable!(); }
  77         fn get_secure_random_bytes(&self) -> [u8; 32] { [0; 32] }
  78
  79         fn read_chan_signer(&self, mut reader: &[u8]) -> Result<Self::Signer, msgs::DecodeError> {
  80                 let inner: InMemorySigner = Readable::read(&mut reader)?;
  81                 let state = Arc::new(Mutex::new(EnforcementState::new()));
  82
  83                 Ok(EnforcingSigner::new_with_revoked(
  84                         inner,
  85                         state,
  86                         false
  87                 ))
  88         }
  89         fn sign_invoice(&self, _invoice_preimage: Vec<u8>) -> Result<RecoverableSignature, ()> { unreachable!(); }
  90 }
  91
  92 pub struct TestChainMonitor<'a> {
  93         pub added_monitors: Mutex<Vec<(OutPoint, channelmonitor::ChannelMonitor<EnforcingSigner>)>>,
  94         pub latest_monitor_update_id: Mutex<HashMap<[u8; 32], (OutPoint, u64, MonitorUpdateId)>>,
  95         pub chain_monitor: chainmonitor::ChainMonitor<EnforcingSigner, &'a TestChainSource, &'a chaininterface::BroadcasterInterface, &'a TestFeeEstimator, &'a TestLogger, &'a chainmonitor::Persist<EnforcingSigner>>,
  96         pub keys_manager: &'a TestKeysInterface,
  97         /// If this is set to Some(), the next update_channel call (not watch_channel) must be a
  98         /// ChannelForceClosed event for the given channel_id with should_broadcast set to the given
  99         /// boolean.
 100         pub expect_channel_force_closed: Mutex<Option<([u8; 32], bool)>>,
 101 }
 102 impl<'a> TestChainMonitor<'a> {
 103         pub fn new(chain_source: Option<&'a TestChainSource>, broadcaster: &'a chaininterface::BroadcasterInterface, logger: &'a TestLogger, fee_estimator: &'a TestFeeEstimator, persister: &'a chainmonitor::Persist<EnforcingSigner>, keys_manager: &'a TestKeysInterface) -> Self {
 104                 Self {
 105                         added_monitors: Mutex::new(Vec::new()),
 106                         latest_monitor_update_id: Mutex::new(HashMap::new()),
 107                         chain_monitor: chainmonitor::ChainMonitor::new(chain_source, broadcaster, logger, fee_estimator, persister),
 108                         keys_manager,
 109                         expect_channel_force_closed: Mutex::new(None),
 110                 }
 111         }
 112 }
 113 impl<'a> chain::Watch<EnforcingSigner> for TestChainMonitor<'a> {
 114         fn watch_channel(&self, funding_txo: OutPoint, monitor: channelmonitor::ChannelMonitor<EnforcingSigner>) -> Result<(), chain::ChannelMonitorUpdateErr> {
 115                 // At every point where we get a monitor update, we should be able to send a useful monitor
 116                 // to a watchtower and disk...
 117                 let mut w = TestVecWriter(Vec::new());
 118                 monitor.write(&mut w).unwrap();
 119                 let new_monitor = <(BlockHash, channelmonitor::ChannelMonitor<EnforcingSigner>)>::read(
 120                         &mut io::Cursor::new(&w.0), self.keys_manager).unwrap().1;
 121                 assert!(new_monitor == monitor);
 122                 self.latest_monitor_update_id.lock().unwrap().insert(funding_txo.to_channel_id(),
 123                         (funding_txo, monitor.get_latest_update_id(), MonitorUpdateId::from_new_monitor(&monitor)));
 124                 self.added_monitors.lock().unwrap().push((funding_txo, monitor));
 125                 self.chain_monitor.watch_channel(funding_txo, new_monitor)
 126         }
 127
 128         fn update_channel(&self, funding_txo: OutPoint, update: channelmonitor::ChannelMonitorUpdate) -> Result<(), chain::ChannelMonitorUpdateErr> {
 129                 // Every monitor update should survive roundtrip
 130                 let mut w = TestVecWriter(Vec::new());
 131                 update.write(&mut w).unwrap();
 132                 assert!(channelmonitor::ChannelMonitorUpdate::read(
 133                                 &mut io::Cursor::new(&w.0)).unwrap() == update);
 134
 135                 if let Some(exp) = self.expect_channel_force_closed.lock().unwrap().take() {
 136                         assert_eq!(funding_txo.to_channel_id(), exp.0);
 137                         assert_eq!(update.updates.len(), 1);
 138                         if let channelmonitor::ChannelMonitorUpdateStep::ChannelForceClosed { should_broadcast } = update.updates[0] {
 139                                 assert_eq!(should_broadcast, exp.1);
 140                         } else { panic!(); }
 141                 }
 142
 143                 self.latest_monitor_update_id.lock().unwrap().insert(funding_txo.to_channel_id(),
 144                         (funding_txo, update.update_id, MonitorUpdateId::from_monitor_update(&update)));
 145                 let update_res = self.chain_monitor.update_channel(funding_txo, update);
 146                 // At every point where we get a monitor update, we should be able to send a useful monitor
 147                 // to a watchtower and disk...
 148                 let monitor = self.chain_monitor.get_monitor(funding_txo).unwrap();
 149                 w.0.clear();
 150                 monitor.write(&mut w).unwrap();
 151                 let new_monitor = <(BlockHash, channelmonitor::ChannelMonitor<EnforcingSigner>)>::read(
 152                         &mut io::Cursor::new(&w.0), self.keys_manager).unwrap().1;
 153                 assert!(new_monitor == *monitor);
 154                 self.added_monitors.lock().unwrap().push((funding_txo, new_monitor));
 155                 update_res
 156         }
 157
 158         fn release_pending_monitor_events(&self) -> Vec<MonitorEvent> {
 159                 return self.chain_monitor.release_pending_monitor_events();
 160         }
 161 }
 162
 163 pub struct TestPersister {
 164         pub update_ret: Mutex<Result<(), chain::ChannelMonitorUpdateErr>>,
 165         /// If this is set to Some(), after the next return, we'll always return this until update_ret
 166         /// is changed:
 167         pub next_update_ret: Mutex<Option<Result<(), chain::ChannelMonitorUpdateErr>>>,
 168         /// When we get an update_persisted_channel call with no ChannelMonitorUpdate, we insert the
 169         /// MonitorUpdateId here.
 170         pub chain_sync_monitor_persistences: Mutex<HashMap<OutPoint, HashSet<MonitorUpdateId>>>,
 171 }
 172 impl TestPersister {
 173         pub fn new() -> Self {
 174                 Self {
 175                         update_ret: Mutex::new(Ok(())),
 176                         next_update_ret: Mutex::new(None),
 177                         chain_sync_monitor_persistences: Mutex::new(HashMap::new()),
 178                 }
 179         }
 180
 181         pub fn set_update_ret(&self, ret: Result<(), chain::ChannelMonitorUpdateErr>) {
 182                 *self.update_ret.lock().unwrap() = ret;
 183         }
 184
 185         pub fn set_next_update_ret(&self, next_ret: Option<Result<(), chain::ChannelMonitorUpdateErr>>) {
 186                 *self.next_update_ret.lock().unwrap() = next_ret;
 187         }
 188 }
 189 impl<Signer: keysinterface::Sign> chainmonitor::Persist<Signer> for TestPersister {
 190         fn persist_new_channel(&self, _funding_txo: OutPoint, _data: &channelmonitor::ChannelMonitor<Signer>, _id: MonitorUpdateId) -> Result<(), chain::ChannelMonitorUpdateErr> {
 191                 let ret = self.update_ret.lock().unwrap().clone();
 192                 if let Some(next_ret) = self.next_update_ret.lock().unwrap().take() {
 193                         *self.update_ret.lock().unwrap() = next_ret;
 194                 }
 195                 ret
 196         }
 197
 198         fn update_persisted_channel(&self, funding_txo: OutPoint, update: &Option<channelmonitor::ChannelMonitorUpdate>, _data: &channelmonitor::ChannelMonitor<Signer>, update_id: MonitorUpdateId) -> Result<(), chain::ChannelMonitorUpdateErr> {
 199                 let ret = self.update_ret.lock().unwrap().clone();
 200                 if let Some(next_ret) = self.next_update_ret.lock().unwrap().take() {
 201                         *self.update_ret.lock().unwrap() = next_ret;
 202                 }
 203                 if update.is_none() {
 204                         self.chain_sync_monitor_persistences.lock().unwrap().entry(funding_txo).or_insert(HashSet::new()).insert(update_id);
 205                 }
 206                 ret
 207         }
 208 }
 209
 210 pub struct TestBroadcaster {
 211         pub txn_broadcasted: Mutex<Vec<Transaction>>,
 212         pub blocks: Arc<Mutex<Vec<(BlockHeader, u32)>>>,
 213 }
 214 impl chaininterface::BroadcasterInterface for TestBroadcaster {
 215         fn broadcast_transaction(&self, tx: &Transaction) {
 216                 assert!(tx.lock_time < 1_500_000_000);
 217                 if tx.lock_time > self.blocks.lock().unwrap().len() as u32 + 1 && tx.lock_time < 500_000_000 {
 218                         for inp in tx.input.iter() {
 219                                 if inp.sequence != 0xffffffff {
 220                                         panic!("We should never broadcast a transaction before its locktime ({})!", tx.lock_time);
 221                                 }
 222                         }
 223                 }
 224                 self.txn_broadcasted.lock().unwrap().push(tx.clone());
 225         }
 226 }
 227
 228 pub struct TestChannelMessageHandler {
 229         pub pending_events: Mutex<Vec<events::MessageSendEvent>>,
 230 }
 231
 232 impl TestChannelMessageHandler {
 233         pub fn new() -> Self {
 234                 TestChannelMessageHandler {
 235                         pending_events: Mutex::new(Vec::new()),
 236                 }
 237         }
 238 }
 239
 240 impl msgs::ChannelMessageHandler for TestChannelMessageHandler {
 241         fn handle_open_channel(&self, _their_node_id: &PublicKey, _their_features: InitFeatures, _msg: &msgs::OpenChannel) {}
 242         fn handle_accept_channel(&self, _their_node_id: &PublicKey, _their_features: InitFeatures, _msg: &msgs::AcceptChannel) {}
 243         fn handle_funding_created(&self, _their_node_id: &PublicKey, _msg: &msgs::FundingCreated) {}
 244         fn handle_funding_signed(&self, _their_node_id: &PublicKey, _msg: &msgs::FundingSigned) {}
 245         fn handle_funding_locked(&self, _their_node_id: &PublicKey, _msg: &msgs::FundingLocked) {}
 246         fn handle_shutdown(&self, _their_node_id: &PublicKey, _their_features: &InitFeatures, _msg: &msgs::Shutdown) {}
 247         fn handle_closing_signed(&self, _their_node_id: &PublicKey, _msg: &msgs::ClosingSigned) {}
 248         fn handle_update_add_htlc(&self, _their_node_id: &PublicKey, _msg: &msgs::UpdateAddHTLC) {}
 249         fn handle_update_fulfill_htlc(&self, _their_node_id: &PublicKey, _msg: &msgs::UpdateFulfillHTLC) {}
 250         fn handle_update_fail_htlc(&self, _their_node_id: &PublicKey, _msg: &msgs::UpdateFailHTLC) {}
 251         fn handle_update_fail_malformed_htlc(&self, _their_node_id: &PublicKey, _msg: &msgs::UpdateFailMalformedHTLC) {}
 252         fn handle_commitment_signed(&self, _their_node_id: &PublicKey, _msg: &msgs::CommitmentSigned) {}
 253         fn handle_revoke_and_ack(&self, _their_node_id: &PublicKey, _msg: &msgs::RevokeAndACK) {}
 254         fn handle_update_fee(&self, _their_node_id: &PublicKey, _msg: &msgs::UpdateFee) {}
 255         fn handle_channel_update(&self, _their_node_id: &PublicKey, _msg: &msgs::ChannelUpdate) {}
 256         fn handle_announcement_signatures(&self, _their_node_id: &PublicKey, _msg: &msgs::AnnouncementSignatures) {}
 257         fn handle_channel_reestablish(&self, _their_node_id: &PublicKey, _msg: &msgs::ChannelReestablish) {}
 258         fn peer_disconnected(&self, _their_node_id: &PublicKey, _no_connection_possible: bool) {}
 259         fn peer_connected(&self, _their_node_id: &PublicKey, _msg: &msgs::Init) {}
 260         fn handle_error(&self, _their_node_id: &PublicKey, _msg: &msgs::ErrorMessage) {}
 261 }
 262
 263 impl events::MessageSendEventsProvider for TestChannelMessageHandler {
 264         fn get_and_clear_pending_msg_events(&self) -> Vec<events::MessageSendEvent> {
 265                 let mut pending_events = self.pending_events.lock().unwrap();
 266                 let mut ret = Vec::new();
 267                 mem::swap(&mut ret, &mut *pending_events);
 268                 ret
 269         }
 270 }
 271
 272 fn get_dummy_channel_announcement(short_chan_id: u64) -> msgs::ChannelAnnouncement {
 273         use bitcoin::secp256k1::ffi::Signature as FFISignature;
 274         let secp_ctx = Secp256k1::new();
 275         let network = Network::Testnet;
 276         let node_1_privkey = SecretKey::from_slice(&[42; 32]).unwrap();
 277         let node_2_privkey = SecretKey::from_slice(&[41; 32]).unwrap();
 278         let node_1_btckey = SecretKey::from_slice(&[40; 32]).unwrap();
 279         let node_2_btckey = SecretKey::from_slice(&[39; 32]).unwrap();
 280         let unsigned_ann = msgs::UnsignedChannelAnnouncement {
 281                 features: ChannelFeatures::known(),
 282                 chain_hash: genesis_block(network).header.block_hash(),
 283                 short_channel_id: short_chan_id,
 284                 node_id_1: PublicKey::from_secret_key(&secp_ctx, &node_1_privkey),
 285                 node_id_2: PublicKey::from_secret_key(&secp_ctx, &node_2_privkey),
 286                 bitcoin_key_1: PublicKey::from_secret_key(&secp_ctx, &node_1_btckey),
 287                 bitcoin_key_2: PublicKey::from_secret_key(&secp_ctx, &node_2_btckey),
 288                 excess_data: Vec::new(),
 289         };
 290
 291         unsafe {
 292                 msgs::ChannelAnnouncement {
 293                         node_signature_1: Signature::from(FFISignature::new()),
 294                         node_signature_2: Signature::from(FFISignature::new()),
 295                         bitcoin_signature_1: Signature::from(FFISignature::new()),
 296                         bitcoin_signature_2: Signature::from(FFISignature::new()),
 297                         contents: unsigned_ann,
 298                 }
 299         }
 300 }
 301
 302 fn get_dummy_channel_update(short_chan_id: u64) -> msgs::ChannelUpdate {
 303         use bitcoin::secp256k1::ffi::Signature as FFISignature;
 304         let network = Network::Testnet;
 305         msgs::ChannelUpdate {
 306                 signature: Signature::from(unsafe { FFISignature::new() }),
 307                 contents: msgs::UnsignedChannelUpdate {
 308                         chain_hash: genesis_block(network).header.block_hash(),
 309                         short_channel_id: short_chan_id,
 310                         timestamp: 0,
 311                         flags: 0,
 312                         cltv_expiry_delta: 0,
 313                         htlc_minimum_msat: 0,
 314                         htlc_maximum_msat: OptionalField::Absent,
 315                         fee_base_msat: 0,
 316                         fee_proportional_millionths: 0,
 317                         excess_data: vec![],
 318                 }
 319         }
 320 }
 321
 322 pub struct TestRoutingMessageHandler {
 323         pub chan_upds_recvd: AtomicUsize,
 324         pub chan_anns_recvd: AtomicUsize,
 325         pub request_full_sync: AtomicBool,
 326 }
 327
 328 impl TestRoutingMessageHandler {
 329         pub fn new() -> Self {
 330                 TestRoutingMessageHandler {
 331                         chan_upds_recvd: AtomicUsize::new(0),
 332                         chan_anns_recvd: AtomicUsize::new(0),
 333                         request_full_sync: AtomicBool::new(false),
 334                 }
 335         }
 336 }
 337 impl msgs::RoutingMessageHandler for TestRoutingMessageHandler {
 338         fn handle_node_announcement(&self, _msg: &msgs::NodeAnnouncement) -> Result<bool, msgs::LightningError> {
 339                 Err(msgs::LightningError { err: "".to_owned(), action: msgs::ErrorAction::IgnoreError })
 340         }
 341         fn handle_channel_announcement(&self, _msg: &msgs::ChannelAnnouncement) -> Result<bool, msgs::LightningError> {
 342                 self.chan_anns_recvd.fetch_add(1, Ordering::AcqRel);
 343                 Err(msgs::LightningError { err: "".to_owned(), action: msgs::ErrorAction::IgnoreError })
 344         }
 345         fn handle_channel_update(&self, _msg: &msgs::ChannelUpdate) -> Result<bool, msgs::LightningError> {
 346                 self.chan_upds_recvd.fetch_add(1, Ordering::AcqRel);
 347                 Err(msgs::LightningError { err: "".to_owned(), action: msgs::ErrorAction::IgnoreError })
 348         }
 349         fn get_next_channel_announcements(&self, starting_point: u64, batch_amount: u8) -> Vec<(msgs::ChannelAnnouncement, Option<msgs::ChannelUpdate>, Option<msgs::ChannelUpdate>)> {
 350                 let mut chan_anns = Vec::new();
 351                 const TOTAL_UPDS: u64 = 50;
 352                 let end: u64 = cmp::min(starting_point + batch_amount as u64, TOTAL_UPDS);
 353                 for i in starting_point..end {
 354                         let chan_upd_1 = get_dummy_channel_update(i);
 355                         let chan_upd_2 = get_dummy_channel_update(i);
 356                         let chan_ann = get_dummy_channel_announcement(i);
 357
 358                         chan_anns.push((chan_ann, Some(chan_upd_1), Some(chan_upd_2)));
 359                 }
 360
 361                 chan_anns
 362         }
 363
 364         fn get_next_node_announcements(&self, _starting_point: Option<&PublicKey>, _batch_amount: u8) -> Vec<msgs::NodeAnnouncement> {
 365                 Vec::new()
 366         }
 367
 368         fn sync_routing_table(&self, _their_node_id: &PublicKey, _init_msg: &msgs::Init) {}
 369
 370         fn handle_reply_channel_range(&self, _their_node_id: &PublicKey, _msg: msgs::ReplyChannelRange) -> Result<(), msgs::LightningError> {
 371                 Ok(())
 372         }
 373
 374         fn handle_reply_short_channel_ids_end(&self, _their_node_id: &PublicKey, _msg: msgs::ReplyShortChannelIdsEnd) -> Result<(), msgs::LightningError> {
 375                 Ok(())
 376         }
 377
 378         fn handle_query_channel_range(&self, _their_node_id: &PublicKey, _msg: msgs::QueryChannelRange) -> Result<(), msgs::LightningError> {
 379                 Ok(())
 380         }
 381
 382         fn handle_query_short_channel_ids(&self, _their_node_id: &PublicKey, _msg: msgs::QueryShortChannelIds) -> Result<(), msgs::LightningError> {
 383                 Ok(())
 384         }
 385 }
 386
 387 impl events::MessageSendEventsProvider for TestRoutingMessageHandler {
 388         fn get_and_clear_pending_msg_events(&self) -> Vec<events::MessageSendEvent> {
 389                 vec![]
 390         }
 391 }
 392
 393 pub struct TestLogger {
 394         level: Level,
 395         id: String,
 396         pub lines: Mutex<HashMap<(String, String), usize>>,
 397 }
 398
 399 impl TestLogger {
 400         pub fn new() -> TestLogger {
 401                 Self::with_id("".to_owned())
 402         }
 403         pub fn with_id(id: String) -> TestLogger {
 404                 TestLogger {
 405                         level: Level::Trace,
 406                         id,
 407                         lines: Mutex::new(HashMap::new())
 408                 }
 409         }
 410         pub fn enable(&mut self, level: Level) {
 411                 self.level = level;
 412         }
 413         pub fn assert_log(&self, module: String, line: String, count: usize) {
 414                 let log_entries = self.lines.lock().unwrap();
 415                 assert_eq!(log_entries.get(&(module, line)), Some(&count));
 416         }
 417
 418         /// Search for the number of occurrence of the logged lines which
 419         /// 1. belongs to the specified module and
 420         /// 2. contains `line` in it.
 421         /// And asserts if the number of occurrences is the same with the given `count`
 422         pub fn assert_log_contains(&self, module: String, line: String, count: usize) {
 423                 let log_entries = self.lines.lock().unwrap();
 424                 let l: usize = log_entries.iter().filter(|&(&(ref m, ref l), _c)| {
 425                         m == &module && l.contains(line.as_str())
 426                 }).map(|(_, c) | { c }).sum();
 427                 assert_eq!(l, count)
 428         }
 429
 430     /// Search for the number of occurrences of logged lines which
 431     /// 1. belong to the specified module and
 432     /// 2. match the given regex pattern.
 433     /// Assert that the number of occurrences equals the given `count`
 434         pub fn assert_log_regex(&self, module: String, pattern: regex::Regex, count: usize) {
 435                 let log_entries = self.lines.lock().unwrap();
 436                 let l: usize = log_entries.iter().filter(|&(&(ref m, ref l), _c)| {
 437                         m == &module && pattern.is_match(&l)
 438                 }).map(|(_, c) | { c }).sum();
 439                 assert_eq!(l, count)
 440         }
 441 }
 442
 443 impl Logger for TestLogger {
 444         fn log(&self, record: &Record) {
 445                 *self.lines.lock().unwrap().entry((record.module_path.to_string(), format!("{}", record.args))).or_insert(0) += 1;
 446                 if record.level >= self.level {
 447                         println!("{:<5} {} [{} : {}, {}] {}", record.level.to_string(), self.id, record.module_path, record.file, record.line, record.args);
 448                 }
 449         }
 450 }
 451
 452 pub struct TestKeysInterface {
 453         pub backing: keysinterface::KeysManager,
 454         pub override_session_priv: Mutex<Option<[u8; 32]>>,
 455         pub override_channel_id_priv: Mutex<Option<[u8; 32]>>,
 456         pub disable_revocation_policy_check: bool,
 457         enforcement_states: Mutex<HashMap<[u8;32], Arc<Mutex<EnforcementState>>>>,
 458         expectations: Mutex<Option<VecDeque<OnGetShutdownScriptpubkey>>>,
 459 }
 460
 461 impl keysinterface::KeysInterface for TestKeysInterface {
 462         type Signer = EnforcingSigner;
 463
 464         fn get_node_secret(&self) -> SecretKey { self.backing.get_node_secret() }
 465         fn get_destination_script(&self) -> Script { self.backing.get_destination_script() }
 466
 467         fn get_shutdown_scriptpubkey(&self) -> ShutdownScript {
 468                 match &mut *self.expectations.lock().unwrap() {
 469                         None => self.backing.get_shutdown_scriptpubkey(),
 470                         Some(expectations) => match expectations.pop_front() {
 471                                 None => panic!("Unexpected get_shutdown_scriptpubkey"),
 472                                 Some(expectation) => expectation.returns,
 473                         },
 474                 }
 475         }
 476
 477         fn get_channel_signer(&self, inbound: bool, channel_value_satoshis: u64) -> EnforcingSigner {
 478                 let keys = self.backing.get_channel_signer(inbound, channel_value_satoshis);
 479                 let state = self.make_enforcement_state_cell(keys.commitment_seed);
 480                 EnforcingSigner::new_with_revoked(keys, state, self.disable_revocation_policy_check)
 481         }
 482
 483         fn get_secure_random_bytes(&self) -> [u8; 32] {
 484                 let override_channel_id = self.override_channel_id_priv.lock().unwrap();
 485                 let override_session_key = self.override_session_priv.lock().unwrap();
 486                 if override_channel_id.is_some() && override_session_key.is_some() {
 487                         panic!("We don't know which override key to use!");
 488                 }
 489                 if let Some(key) = &*override_channel_id {
 490                         return *key;
 491                 }
 492                 if let Some(key) = &*override_session_key {
 493                         return *key;
 494                 }
 495                 self.backing.get_secure_random_bytes()
 496         }
 497
 498         fn read_chan_signer(&self, buffer: &[u8]) -> Result<Self::Signer, msgs::DecodeError> {
 499                 let mut reader = io::Cursor::new(buffer);
 500
 501                 let inner: InMemorySigner = Readable::read(&mut reader)?;
 502                 let state = self.make_enforcement_state_cell(inner.commitment_seed);
 503
 504                 Ok(EnforcingSigner::new_with_revoked(
 505                         inner,
 506                         state,
 507                         self.disable_revocation_policy_check
 508                 ))
 509         }
 510
 511         fn sign_invoice(&self, invoice_preimage: Vec<u8>) -> Result<RecoverableSignature, ()> {
 512                 self.backing.sign_invoice(invoice_preimage)
 513         }
 514 }
 515
 516 impl TestKeysInterface {
 517         pub fn new(seed: &[u8; 32], network: Network) -> Self {
 518                 let now = Duration::from_secs(genesis_block(network).header.time as u64);
 519                 Self {
 520                         backing: keysinterface::KeysManager::new(seed, now.as_secs(), now.subsec_nanos()),
 521                         override_session_priv: Mutex::new(None),
 522                         override_channel_id_priv: Mutex::new(None),
 523                         disable_revocation_policy_check: false,
 524                         enforcement_states: Mutex::new(HashMap::new()),
 525                         expectations: Mutex::new(None),
 526                 }
 527         }
 528
 529         /// Sets an expectation that [`keysinterface::KeysInterface::get_shutdown_scriptpubkey`] is
 530         /// called.
 531         pub fn expect(&self, expectation: OnGetShutdownScriptpubkey) -> &Self {
 532                 self.expectations.lock().unwrap()
 533                         .get_or_insert_with(|| VecDeque::new())
 534                         .push_back(expectation);
 535                 self
 536         }
 537
 538         pub fn derive_channel_keys(&self, channel_value_satoshis: u64, id: &[u8; 32]) -> EnforcingSigner {
 539                 let keys = self.backing.derive_channel_keys(channel_value_satoshis, id);
 540                 let state = self.make_enforcement_state_cell(keys.commitment_seed);
 541                 EnforcingSigner::new_with_revoked(keys, state, self.disable_revocation_policy_check)
 542         }
 543
 544         fn make_enforcement_state_cell(&self, commitment_seed: [u8; 32]) -> Arc<Mutex<EnforcementState>> {
 545                 let mut states = self.enforcement_states.lock().unwrap();
 546                 if !states.contains_key(&commitment_seed) {
 547                         let state = EnforcementState::new();
 548                         states.insert(commitment_seed, Arc::new(Mutex::new(state)));
 549                 }
 550                 let cell = states.get(&commitment_seed).unwrap();
 551                 Arc::clone(cell)
 552         }
 553 }
 554
 555 impl Drop for TestKeysInterface {
 556         fn drop(&mut self) {
 557                 if std::thread::panicking() {
 558                         return;
 559                 }
 560
 561                 if let Some(expectations) = &*self.expectations.lock().unwrap() {
 562                         if !expectations.is_empty() {
 563                                 panic!("Unsatisfied expectations: {:?}", expectations);
 564                         }
 565                 }
 566         }
 567 }
 568
 569 /// An expectation that [`keysinterface::KeysInterface::get_shutdown_scriptpubkey`] was called and
 570 /// returns a [`ShutdownScript`].
 571 pub struct OnGetShutdownScriptpubkey {
 572         /// A shutdown script used to close a channel.
 573         pub returns: ShutdownScript,
 574 }
 575
 576 impl core::fmt::Debug for OnGetShutdownScriptpubkey {
 577         fn fmt(&self, f: &mut core::fmt::Formatter<'_>) -> core::fmt::Result {
 578                 f.debug_struct("OnGetShutdownScriptpubkey").finish()
 579         }
 580 }
 581
 582 pub struct TestChainSource {
 583         pub genesis_hash: BlockHash,
 584         pub utxo_ret: Mutex<Result<TxOut, chain::AccessError>>,
 585         pub watched_txn: Mutex<HashSet<(Txid, Script)>>,
 586         pub watched_outputs: Mutex<HashSet<(OutPoint, Script)>>,
 587         expectations: Mutex<Option<VecDeque<OnRegisterOutput>>>,
 588 }
 589
 590 impl TestChainSource {
 591         pub fn new(network: Network) -> Self {
 592                 let script_pubkey = Builder::new().push_opcode(opcodes::OP_TRUE).into_script();
 593                 Self {
 594                         genesis_hash: genesis_block(network).block_hash(),
 595                         utxo_ret: Mutex::new(Ok(TxOut { value: u64::max_value(), script_pubkey })),
 596                         watched_txn: Mutex::new(HashSet::new()),
 597                         watched_outputs: Mutex::new(HashSet::new()),
 598                         expectations: Mutex::new(None),
 599                 }
 600         }
 601
 602         /// Sets an expectation that [`chain::Filter::register_output`] is called.
 603         pub fn expect(&self, expectation: OnRegisterOutput) -> &Self {
 604                 self.expectations.lock().unwrap()
 605                         .get_or_insert_with(|| VecDeque::new())
 606                         .push_back(expectation);
 607                 self
 608         }
 609 }
 610
 611 impl chain::Access for TestChainSource {
 612         fn get_utxo(&self, genesis_hash: &BlockHash, _short_channel_id: u64) -> Result<TxOut, chain::AccessError> {
 613                 if self.genesis_hash != *genesis_hash {
 614                         return Err(chain::AccessError::UnknownChain);
 615                 }
 616
 617                 self.utxo_ret.lock().unwrap().clone()
 618         }
 619 }
 620
 621 impl chain::Filter for TestChainSource {
 622         fn register_tx(&self, txid: &Txid, script_pubkey: &Script) {
 623                 self.watched_txn.lock().unwrap().insert((*txid, script_pubkey.clone()));
 624         }
 625
 626         fn register_output(&self, output: WatchedOutput) -> Option<(usize, Transaction)> {
 627                 let dependent_tx = match &mut *self.expectations.lock().unwrap() {
 628                         None => None,
 629                         Some(expectations) => match expectations.pop_front() {
 630                                 None => {
 631                                         panic!("Unexpected register_output: {:?}",
 632                                                 (output.outpoint, output.script_pubkey));
 633                                 },
 634                                 Some(expectation) => {
 635                                         assert_eq!(output.outpoint, expectation.outpoint());
 636                                         assert_eq!(&output.script_pubkey, expectation.script_pubkey());
 637                                         expectation.returns
 638                                 },
 639                         },
 640                 };
 641
 642                 self.watched_outputs.lock().unwrap().insert((output.outpoint, output.script_pubkey));
 643                 dependent_tx
 644         }
 645 }
 646
 647 impl Drop for TestChainSource {
 648         fn drop(&mut self) {
 649                 if std::thread::panicking() {
 650                         return;
 651                 }
 652
 653                 if let Some(expectations) = &*self.expectations.lock().unwrap() {
 654                         if !expectations.is_empty() {
 655                                 panic!("Unsatisfied expectations: {:?}", expectations);
 656                         }
 657                 }
 658         }
 659 }
 660
 661 /// An expectation that [`chain::Filter::register_output`] was called with a transaction output and
 662 /// returns an optional dependent transaction that spends the output in the same block.
 663 pub struct OnRegisterOutput {
 664         /// The transaction output to register.
 665         pub with: TxOutReference,
 666
 667         /// A dependent transaction spending the output along with its position in the block.
 668         pub returns: Option<(usize, Transaction)>,
 669 }
 670
 671 /// A transaction output as identified by an index into a transaction's output list.
 672 pub struct TxOutReference(pub Transaction, pub usize);
 673
 674 impl OnRegisterOutput {
 675         fn outpoint(&self) -> OutPoint {
 676                 let txid = self.with.0.txid();
 677                 let index = self.with.1 as u16;
 678                 OutPoint { txid, index }
 679         }
 680
 681         fn script_pubkey(&self) -> &Script {
 682                 let index = self.with.1;
 683                 &self.with.0.output[index].script_pubkey
 684         }
 685 }
 686
 687 impl core::fmt::Debug for OnRegisterOutput {
 688         fn fmt(&self, f: &mut core::fmt::Formatter<'_>) -> core::fmt::Result {
 689                 f.debug_struct("OnRegisterOutput")
 690                         .field("outpoint", &self.outpoint())
 691                         .field("script_pubkey", self.script_pubkey())
 692                         .finish()
 693         }
 694 }
 695
 696 /// A scorer useful in testing, when the passage of time isn't a concern.
 697 pub type TestScorer = ScorerUsingTime<Eternity>;