Create first unit test.
[rapid-gossip-sync-server] / src / tests / mod.rs
1 //! Multi-module tests that use database fixtures
2
3 use std::cell::RefCell;
4 use std::sync::Arc;
5 use std::time::{SystemTime, UNIX_EPOCH};
6 use bitcoin::{BlockHash, Network};
7 use bitcoin::secp256k1::ecdsa::Signature;
8 use bitcoin::secp256k1::{Secp256k1, SecretKey};
9 use bitcoin::hashes::Hash;
10 use bitcoin::hashes::hex::ToHex;
11 use bitcoin::hashes::sha256d::Hash as Sha256dHash;
12 use lightning::ln::features::ChannelFeatures;
13 use lightning::ln::msgs::{ChannelAnnouncement, ChannelUpdate, UnsignedChannelAnnouncement, UnsignedChannelUpdate};
14 use lightning::routing::gossip::{NetworkGraph, NodeId};
15 use lightning::util::ser::Writeable;
16 use lightning_rapid_gossip_sync::RapidGossipSync;
17 use crate::{config, serialize_delta};
18 use crate::persistence::GossipPersister;
19 use crate::types::{GossipMessage, tests::TestLogger};
20
21 const CLIENT_BACKDATE_INTERVAL: u32 = 3600 * 24 * 7; // client backdates RGS by a week
22
23 thread_local! {
24         static DB_TEST_SCHEMA: RefCell<Option<String>> = RefCell::new(None);
25 }
26
27 fn blank_signature() -> Signature {
28         Signature::from_compact(&[0u8; 64]).unwrap()
29 }
30
31 fn genesis_hash() -> BlockHash {
32         bitcoin::blockdata::constants::genesis_block(Network::Bitcoin).block_hash()
33 }
34
35 fn current_time() -> u32 {
36         SystemTime::now().duration_since(UNIX_EPOCH).expect("Time must be > 1970").as_secs() as u32
37 }
38
39 pub(crate) fn db_test_schema() -> String {
40         DB_TEST_SCHEMA.with(|suffix_reference| {
41                 let mut suffix_option = suffix_reference.borrow_mut();
42                 match suffix_option.as_ref() {
43                         None => {
44                                 let current_time = SystemTime::now();
45                                 let unix_time = current_time.duration_since(UNIX_EPOCH).expect("Time went backwards");
46                                 let timestamp_seconds = unix_time.as_secs();
47                                 let timestamp_nanos = unix_time.as_nanos();
48                                 let preimage = format!("{}", timestamp_nanos);
49                                 let suffix = Sha256dHash::hash(preimage.as_bytes()).into_inner().to_hex();
50                                 // the schema must start with a letter
51                                 let schema = format!("test_{}_{}", timestamp_seconds, suffix);
52                                 suffix_option.replace(schema.clone());
53                                 schema
54                         }
55                         Some(suffix) => {
56                                 suffix.clone()
57                         }
58                 }
59         })
60 }
61
62 fn generate_announcement(short_channel_id: u64) -> ChannelAnnouncement {
63         let secp_context = Secp256k1::new();
64
65         let random_private_key_1 = SecretKey::from_slice(&[1; 32]).unwrap();
66         let random_public_key_1 = random_private_key_1.public_key(&secp_context);
67         let node_id_1 = NodeId::from_pubkey(&random_public_key_1);
68
69         let random_private_key_2 = SecretKey::from_slice(&[2; 32]).unwrap();
70         let random_public_key_2 = random_private_key_2.public_key(&secp_context);
71         let node_id_2 = NodeId::from_pubkey(&random_public_key_2);
72
73         let announcement = UnsignedChannelAnnouncement {
74                 features: ChannelFeatures::empty(),
75                 chain_hash: genesis_hash(),
76                 short_channel_id,
77                 node_id_1,
78                 node_id_2,
79                 bitcoin_key_1: node_id_1,
80                 bitcoin_key_2: node_id_2,
81                 excess_data: vec![],
82         };
83
84         let msg_hash = bitcoin::secp256k1::Message::from_slice(&Sha256dHash::hash(&announcement.encode()[..])[..]).unwrap();
85         let node_signature_1 = secp_context.sign_ecdsa(&msg_hash, &random_private_key_1);
86         let node_signature_2 = secp_context.sign_ecdsa(&msg_hash, &random_private_key_2);
87
88         ChannelAnnouncement {
89                 node_signature_1,
90                 node_signature_2,
91                 bitcoin_signature_1: node_signature_1,
92                 bitcoin_signature_2: node_signature_2,
93                 contents: announcement,
94         }
95 }
96
97 fn generate_update(scid: u64, direction: bool, timestamp: u32, expiry_delta: u16, min_msat: u64, max_msat: u64, base_msat: u32, fee_rate: u32) -> ChannelUpdate {
98         let flag_mask = if direction { 1 } else { 0 };
99         ChannelUpdate {
100                 signature: blank_signature(),
101                 contents: UnsignedChannelUpdate {
102                         chain_hash: genesis_hash(),
103                         short_channel_id: scid,
104                         timestamp,
105                         flags: 0 | flag_mask,
106                         cltv_expiry_delta: expiry_delta,
107                         htlc_minimum_msat: min_msat,
108                         htlc_maximum_msat: max_msat,
109                         fee_base_msat: base_msat,
110                         fee_proportional_millionths: fee_rate,
111                         excess_data: vec![],
112                 },
113         }
114 }
115
116 async fn clean_test_db() {
117         let client = crate::connect_to_db().await;
118         let schema = db_test_schema();
119         client.execute(&format!("DROP SCHEMA IF EXISTS {} CASCADE", schema), &[]).await.unwrap();
120 }
121
122 #[tokio::test]
123 async fn test_trivial_setup() {
124         let logger = Arc::new(TestLogger::new());
125         let network_graph = NetworkGraph::new(Network::Bitcoin, logger.clone());
126         let network_graph_arc = Arc::new(network_graph);
127         let (mut persister, receiver) = GossipPersister::new(network_graph_arc.clone(), logger.clone());
128
129         let short_channel_id = 1;
130         let timestamp = current_time() - 10;
131         println!("timestamp: {}", timestamp);
132
133         { // seed the db
134                 let announcement = generate_announcement(short_channel_id);
135                 let update_1 = generate_update(short_channel_id, false, timestamp, 0, 0, 0, 5, 0);
136                 let update_2 = generate_update(short_channel_id, true, timestamp, 0, 0, 0, 10, 0);
137
138                 network_graph_arc.update_channel_from_announcement_no_lookup(&announcement).unwrap();
139                 network_graph_arc.update_channel_unsigned(&update_1.contents).unwrap();
140                 network_graph_arc.update_channel_unsigned(&update_2.contents).unwrap();
141
142                 receiver.send(GossipMessage::ChannelAnnouncement(announcement)).await.unwrap();
143                 receiver.send(GossipMessage::ChannelUpdate(update_1)).await.unwrap();
144                 receiver.send(GossipMessage::ChannelUpdate(update_2)).await.unwrap();
145                 drop(receiver);
146                 persister.persist_gossip().await;
147         }
148
149         let serialization = serialize_delta(network_graph_arc.clone(), 0, logger.clone()).await;
150         logger.assert_log_contains("rapid_gossip_sync_server", "announcement channel count: 1", 1);
151         clean_test_db().await;
152
153         let channel_count = network_graph_arc.read_only().channels().len();
154
155         assert_eq!(channel_count, 1);
156         assert_eq!(serialization.message_count, 3);
157         assert_eq!(serialization.announcement_count, 1);
158         assert_eq!(serialization.update_count, 2);
159
160         let client_graph = NetworkGraph::new(Network::Bitcoin, logger.clone());
161         let client_graph_arc = Arc::new(client_graph);
162         let rgs = RapidGossipSync::new(client_graph_arc.clone(), logger.clone());
163         let update_result = rgs.update_network_graph(&serialization.data).unwrap();
164         println!("update result: {}", update_result);
165         // the update result must be a multiple of our snapshot granularity
166         assert_eq!(update_result % config::snapshot_generation_interval(), 0);
167         assert!(update_result < timestamp);
168
169         let timestamp_delta = timestamp - update_result;
170         println!("timestamp delta: {}", timestamp_delta);
171         assert!(timestamp_delta < config::snapshot_generation_interval());
172
173         let readonly_graph = client_graph_arc.read_only();
174         let channels = readonly_graph.channels();
175         let client_channel_count = channels.len();
176         assert_eq!(client_channel_count, 1);
177
178         let first_channel = channels.get(&short_channel_id).unwrap();
179         assert!(&first_channel.announcement_message.is_none());
180         assert_eq!(first_channel.one_to_two.as_ref().unwrap().fees.base_msat, 5);
181         assert_eq!(first_channel.two_to_one.as_ref().unwrap().fees.base_msat, 10);
182         let last_update_seen_a = first_channel.one_to_two.as_ref().unwrap().last_update;
183         let last_update_seen_b = first_channel.two_to_one.as_ref().unwrap().last_update;
184         println!("last update a: {}", last_update_seen_a);
185         println!("last update b: {}", last_update_seen_b);
186         assert_eq!(last_update_seen_a, update_result - CLIENT_BACKDATE_INTERVAL);
187         assert_eq!(last_update_seen_b, update_result - CLIENT_BACKDATE_INTERVAL);
188 }