tests.rs 9.55 KB
Newer Older
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
// Copyright 2018 Parity Technologies (UK) Ltd.
// This file is part of Polkadot.

// Polkadot is free software: you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.

// Polkadot is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
// GNU General Public License for more details.

// You should have received a copy of the GNU General Public License
// along with Polkadot.  If not, see <http://www.gnu.org/licenses/>.

//! Tests for polkadot and consensus network.

19
20
use super::{PolkadotProtocol, Status, Message, FullStatus};
use consensus::{CurrentConsensus, Knowledge};
21
22
23

use parking_lot::Mutex;
use polkadot_consensus::GenericStatement;
24
use polkadot_primitives::{Block, SessionKey};
25
use polkadot_primitives::parachain::{CandidateReceipt, HeadData, BlockData};
26
use substrate_primitives::H512;
Arkadiy Paronyan's avatar
Arkadiy Paronyan committed
27
use codec::Encode;
28
29
30
31
32
use substrate_network::{
	Severity, NodeIndex, PeerInfo, ClientHandle, Context, config::Roles,
	message::Message as SubstrateMessage, specialization::NetworkSpecialization,
	generic_message::Message as GenericMessage
};
33
34
35
36
37
38

use std::sync::Arc;
use futures::Future;

#[derive(Default)]
struct TestContext {
Gav Wood's avatar
Gav Wood committed
39
40
41
	disabled: Vec<NodeIndex>,
	disconnected: Vec<NodeIndex>,
	messages: Vec<(NodeIndex, SubstrateMessage<Block>)>,
42
43
44
45
46
47
48
}

impl Context<Block> for TestContext {
	fn client(&self) -> &ClientHandle<Block> {
		unimplemented!()
	}

Gav Wood's avatar
Gav Wood committed
49
	fn report_peer(&mut self, peer: NodeIndex, reason: Severity) {
50
51
52
53
		match reason {
			Severity::Bad(_) => self.disabled.push(peer),
			_ => self.disconnected.push(peer),
		}
54
55
	}

Gav Wood's avatar
Gav Wood committed
56
	fn peer_info(&self, _peer: NodeIndex) -> Option<PeerInfo<Block>> {
57
58
59
		unimplemented!()
	}

Gav Wood's avatar
Gav Wood committed
60
61
	fn send_message(&mut self, who: NodeIndex, data: SubstrateMessage<Block>) {
		self.messages.push((who, data))
62
63
64
65
	}
}

impl TestContext {
Gav Wood's avatar
Gav Wood committed
66
	fn has_message(&self, to: NodeIndex, message: Message) -> bool {
67
68
		use substrate_network::generic_message::Message as GenericMessage;

69
		let encoded = message.encode();
70
71
72
73
74
75
76
		self.messages.iter().any(|&(ref peer, ref msg)| match msg {
			GenericMessage::ChainSpecific(ref data) => peer == &to && data == &encoded,
			_ => false,
		})
	}
}

77
fn make_status(status: &Status, roles: Roles) -> FullStatus {
78
79
80
81
82
83
84
85
86
87
	FullStatus {
		version: 1,
		roles,
		best_number: 0,
		best_hash: Default::default(),
		genesis_hash: Default::default(),
		chain_status: status.encode(),
	}
}

88
fn make_consensus(local_key: SessionKey) -> (CurrentConsensus, Arc<Mutex<Knowledge>>) {
89
	let knowledge = Arc::new(Mutex::new(Knowledge::new()));
90
	let c = CurrentConsensus::new(knowledge.clone(), local_key);
91
92
93
94

	(c, knowledge)
}

Gav Wood's avatar
Gav Wood committed
95
fn on_message(protocol: &mut PolkadotProtocol, ctx: &mut TestContext, from: NodeIndex, message: Message) {
96
	let encoded = message.encode();
97
	protocol.on_message(ctx, from, &mut Some(GenericMessage::ChainSpecific(encoded)));
98
99
100
101
}

#[test]
fn sends_session_key() {
102
	let mut protocol = PolkadotProtocol::new(None);
103
104
105
106
107
108

	let peer_a = 1;
	let peer_b = 2;
	let parent_hash = [0; 32].into();
	let local_key = [1; 32].into();

109
110
	let validator_status = Status { collating_for: None };
	let collator_status = Status { collating_for: Some(([2; 32].into(), 5.into())) };
111
112
113

	{
		let mut ctx = TestContext::default();
114
		protocol.on_connect(&mut ctx, peer_a, make_status(&validator_status, Roles::AUTHORITY));
115
116
117
118
119
		assert!(ctx.messages.is_empty());
	}

	{
		let mut ctx = TestContext::default();
120
121
		let (consensus, _knowledge) = make_consensus(local_key);
		protocol.new_consensus(&mut ctx, parent_hash, consensus);
122
		assert!(ctx.has_message(peer_a, Message::SessionKey(local_key)));
123
124
125
126
	}

	{
		let mut ctx = TestContext::default();
127
		protocol.on_connect(&mut ctx, peer_b, make_status(&collator_status, Roles::NONE));
128
		assert!(ctx.has_message(peer_b, Message::SessionKey(local_key)));
129
130
131
132
133
	}
}

#[test]
fn fetches_from_those_with_knowledge() {
134
	let mut protocol = PolkadotProtocol::new(None);
135
136
137
138
139
140
141
142
143
144
145
146

	let peer_a = 1;
	let peer_b = 2;
	let parent_hash = [0; 32].into();
	let local_key = [1; 32].into();

	let block_data = BlockData(vec![1, 2, 3, 4]);
	let block_data_hash = block_data.hash();
	let candidate_receipt = CandidateReceipt {
		parachain_index: 5.into(),
		collator: [255; 32].into(),
		head_data: HeadData(vec![9, 9, 9]),
147
		signature: H512::from([1; 64]).into(),
148
149
150
151
152
153
154
155
156
157
158
159
		balance_uploads: Vec::new(),
		egress_queue_roots: Vec::new(),
		fees: 1_000_000,
		block_data_hash,
	};

	let candidate_hash = candidate_receipt.hash();
	let a_key = [3; 32].into();
	let b_key = [4; 32].into();

	let status = Status { collating_for: None };

160
161
	let (consensus, knowledge) = make_consensus(local_key);
	protocol.new_consensus(&mut TestContext::default(), parent_hash, consensus);
162
163
164
165
166
167
168

	knowledge.lock().note_statement(a_key, &GenericStatement::Valid(candidate_hash));
	let recv = protocol.fetch_block_data(&mut TestContext::default(), &candidate_receipt, parent_hash);

	// connect peer A
	{
		let mut ctx = TestContext::default();
169
		protocol.on_connect(&mut ctx, peer_a, make_status(&status, Roles::AUTHORITY));
170
		assert!(ctx.has_message(peer_a, Message::SessionKey(local_key)));
171
172
173
174
175
	}

	// peer A gives session key and gets asked for data.
	{
		let mut ctx = TestContext::default();
176
177
		on_message(&mut protocol, &mut ctx, peer_a, Message::SessionKey(a_key));
		assert!(protocol.validators.contains_key(&a_key));
178
		assert!(ctx.has_message(peer_a, Message::RequestBlockData(1, parent_hash, candidate_hash)));
179
180
181
182
183
184
185
	}

	knowledge.lock().note_statement(b_key, &GenericStatement::Valid(candidate_hash));

	// peer B connects and sends session key. request already assigned to A
	{
		let mut ctx = TestContext::default();
186
		protocol.on_connect(&mut ctx, peer_b, make_status(&status, Roles::AUTHORITY));
187
		on_message(&mut protocol, &mut ctx, peer_b, Message::SessionKey(b_key));
188
		assert!(!ctx.has_message(peer_b, Message::RequestBlockData(2, parent_hash, candidate_hash)));
189
190
191
192
193
194
195

	}

	// peer A disconnects, triggering reassignment
	{
		let mut ctx = TestContext::default();
		protocol.on_disconnect(&mut ctx, peer_a);
196
		assert!(!protocol.validators.contains_key(&a_key));
197
		assert!(ctx.has_message(peer_b, Message::RequestBlockData(2, parent_hash, candidate_hash)));
198
199
200
201
202
203
204
205
206
207
	}

	// peer B comes back with block data.
	{
		let mut ctx = TestContext::default();
		on_message(&mut protocol, &mut ctx, peer_b, Message::BlockData(2, Some(block_data.clone())));
		drop(protocol);
		assert_eq!(recv.wait().unwrap(), block_data);
	}
}
208

209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
#[test]
fn fetches_available_block_data() {
	let mut protocol = PolkadotProtocol::new(None);

	let peer_a = 1;
	let parent_hash = [0; 32].into();

	let block_data = BlockData(vec![1, 2, 3, 4]);
	let block_data_hash = block_data.hash();
	let para_id = 5.into();
	let candidate_receipt = CandidateReceipt {
		parachain_index: para_id,
		collator: [255; 32].into(),
		head_data: HeadData(vec![9, 9, 9]),
		signature: H512::from([1; 64]).into(),
		balance_uploads: Vec::new(),
		egress_queue_roots: Vec::new(),
		fees: 1_000_000,
		block_data_hash,
	};

	let candidate_hash = candidate_receipt.hash();
	let av_store = ::av_store::Store::new_in_memory();

	let status = Status { collating_for: None };

	protocol.register_availability_store(av_store.clone());

	av_store.make_available(::av_store::Data {
		relay_parent: parent_hash,
		parachain_id: para_id,
		candidate_hash,
		block_data: block_data.clone(),
		extrinsic: None,
	}).unwrap();

	// connect peer A
	{
		let mut ctx = TestContext::default();
		protocol.on_connect(&mut ctx, peer_a, make_status(&status, Roles::FULL));
	}

	// peer A asks for historic block data and gets response
	{
		let mut ctx = TestContext::default();
		on_message(&mut protocol, &mut ctx, peer_a, Message::RequestBlockData(1, parent_hash, candidate_hash));
		assert!(ctx.has_message(peer_a, Message::BlockData(1, Some(block_data))));
	}
}

259
260
#[test]
fn remove_bad_collator() {
261
	let mut protocol = PolkadotProtocol::new(None);
262

Gav Wood's avatar
Gav Wood committed
263
	let who = 1;
264
265
266
267
268
269
	let account_id = [2; 32].into();

	let status = Status { collating_for: Some((account_id, 5.into())) };

	{
		let mut ctx = TestContext::default();
Gav Wood's avatar
Gav Wood committed
270
		protocol.on_connect(&mut ctx, who, make_status(&status, Roles::NONE));
271
272
273
274
275
	}

	{
		let mut ctx = TestContext::default();
		protocol.disconnect_bad_collator(&mut ctx, account_id);
Gav Wood's avatar
Gav Wood committed
276
		assert!(ctx.disabled.contains(&who));
277
278
	}
}
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324

#[test]
fn many_session_keys() {
	let mut protocol = PolkadotProtocol::new(None);

	let parent_a = [1; 32].into();
	let parent_b = [2; 32].into();

	let local_key_a = [3; 32].into();
	let local_key_b = [4; 32].into();

	let (consensus_a, _knowledge_a) = make_consensus(local_key_a);
	let (consensus_b, _knowledge_b) = make_consensus(local_key_b);

	protocol.new_consensus(&mut TestContext::default(), parent_a, consensus_a);
	protocol.new_consensus(&mut TestContext::default(), parent_b, consensus_b);

	assert_eq!(protocol.live_consensus.recent_keys(), &[local_key_a, local_key_b]);

	let peer_a = 1;

	// when connecting a peer, we should get both those keys.
	{
		let mut ctx = TestContext::default();

		let status = Status { collating_for: None };
		protocol.on_connect(&mut ctx, peer_a, make_status(&status, Roles::AUTHORITY));

		assert!(ctx.has_message(peer_a, Message::SessionKey(local_key_a)));
		assert!(ctx.has_message(peer_a, Message::SessionKey(local_key_b)));
	}

	let peer_b = 2;

	protocol.remove_consensus(&parent_a);

	{
		let mut ctx = TestContext::default();

		let status = Status { collating_for: None };
		protocol.on_connect(&mut ctx, peer_b, make_status(&status, Roles::AUTHORITY));

		assert!(!ctx.has_message(peer_b, Message::SessionKey(local_key_a)));
		assert!(ctx.has_message(peer_b, Message::SessionKey(local_key_b)));
	}
}