mod.rs 10.2 KB
Newer Older
Shawn Tabrizi's avatar
Shawn Tabrizi committed
1
// Copyright 2018-2020 Parity Technologies (UK) Ltd.
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
// 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/>.

17
//! Tests for polkadot and validation network.
18

19
use std::collections::HashMap;
20
use super::{PolkadotProtocol, Status, Message, FullStatus};
21
use crate::validation::LeafWorkParams;
22

23
use polkadot_validation::GenericStatement;
24
use polkadot_primitives::{Block, Hash};
25
26
use polkadot_primitives::parachain::{
	CandidateReceipt, HeadData, PoVBlock, BlockData, CollatorId, ValidatorId,
27
	StructuredUnroutedIngress,
28
};
29
use sp_core::crypto::UncheckedInto;
30
use codec::Encode;
31
use sc_network::{
32
	PeerId, Context, ReputationChange, config::Roles, message::generic::ConsensusMessage,
33
	specialization::NetworkSpecialization,
34
};
35

36
use futures::executor::block_on;
37

38
mod validation;
39

40
41
#[derive(Default)]
struct TestContext {
42
43
	disabled: Vec<PeerId>,
	disconnected: Vec<PeerId>,
44
	reputations: HashMap<PeerId, i32>,
45
	messages: Vec<(PeerId, Vec<u8>)>,
46
47
48
}

impl Context<Block> for TestContext {
49
50
	fn report_peer(&mut self, peer: PeerId, reputation: ReputationChange) {
        let reputation = self.reputations.get(&peer).map_or(reputation.value, |v| v + reputation.value);
51
52
        self.reputations.insert(peer.clone(), reputation);

53
54
55
56
		match reputation {
			i if i < -100 => self.disabled.push(peer),
			i if i < 0 => self.disconnected.push(peer),
			_ => {}
57
		}
58
59
	}

60
	fn send_chain_specific(&mut self, who: PeerId, message: Vec<u8>) {
61
		self.messages.push((who, message))
62
	}
63
64

	fn disconnect_peer(&mut self, _who: PeerId) { }
65
66
67
}

impl TestContext {
68
	fn has_message(&self, to: PeerId, message: Message) -> bool {
69
		let encoded = message.encode();
70
71
72
		self.messages.iter().any(|&(ref peer, ref data)|
			peer == &to && data == &encoded
		)
73
74
75
	}
}

76
77
78
79
80
81
82
83
84
85
86
87
#[derive(Default)]
pub struct TestChainContext {
	pub known_map: HashMap<Hash, crate::gossip::Known>,
	pub ingress_roots: HashMap<Hash, Vec<Hash>>,
}

impl crate::gossip::ChainContext for TestChainContext {
	fn is_known(&self, block_hash: &Hash) -> Option<crate::gossip::Known> {
		self.known_map.get(block_hash).map(|x| x.clone())
	}

	fn leaf_unrouted_roots(&self, leaf: &Hash, with_queue_root: &mut dyn FnMut(&Hash))
Gavin Wood's avatar
Gavin Wood committed
88
		-> Result<(), sp_blockchain::Error>
89
90
91
92
93
94
95
96
97
	{
		for root in self.ingress_roots.get(leaf).into_iter().flat_map(|roots| roots) {
			with_queue_root(root)
		}

		Ok(())
	}
}

98
99
100
101
102
103
104
fn make_pov(block_data: Vec<u8>) -> PoVBlock {
	PoVBlock {
		block_data: BlockData(block_data),
		ingress: polkadot_primitives::parachain::ConsolidatedIngress(Vec::new()),
	}
}

105
fn make_status(status: &Status, roles: Roles) -> FullStatus {
106
107
	FullStatus {
		version: 1,
108
		min_supported_version: 1,
109
110
111
112
113
114
115
116
		roles,
		best_number: 0,
		best_hash: Default::default(),
		genesis_hash: Default::default(),
		chain_status: status.encode(),
	}
}

117
118
fn make_validation_leaf_work(parent_hash: Hash, local_key: ValidatorId) -> LeafWorkParams {
	LeafWorkParams {
119
120
121
122
		local_session_key: Some(local_key),
		parent_hash,
		authorities: Vec::new(),
	}
123
124
}

125
fn on_message(protocol: &mut PolkadotProtocol, ctx: &mut TestContext, from: PeerId, message: Message) {
126
	let encoded = message.encode();
127
	protocol.on_message(ctx, from, encoded);
128
129
130
131
}

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

134
135
	let peer_a = PeerId::random();
	let peer_b = PeerId::random();
136
	let parent_hash = [0; 32].into();
Gav Wood's avatar
Gav Wood committed
137
	let local_key: ValidatorId = [1; 32].unchecked_into();
138

139
	let validator_status = Status { collating_for: None };
Gav Wood's avatar
Gav Wood committed
140
	let collator_status = Status { collating_for: Some(([2; 32].unchecked_into(), 5.into())) };
141
142
143

	{
		let mut ctx = TestContext::default();
144
		protocol.on_connect(&mut ctx, peer_a.clone(), make_status(&validator_status, Roles::AUTHORITY));
145
146
147
148
149
		assert!(ctx.messages.is_empty());
	}

	{
		let mut ctx = TestContext::default();
150
151
		let params = make_validation_leaf_work(parent_hash, local_key.clone());
		protocol.new_validation_leaf_work(&mut ctx, params);
152
		assert!(ctx.has_message(peer_a, Message::ValidatorId(local_key.clone())));
153
154
155
156
	}

	{
		let mut ctx = TestContext::default();
157
		protocol.on_connect(&mut ctx, peer_b.clone(), make_status(&collator_status, Roles::NONE));
158
		assert!(ctx.has_message(peer_b.clone(), Message::ValidatorId(local_key)));
159
160
161
162
163
	}
}

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

166
167
	let peer_a = PeerId::random();
	let peer_b = PeerId::random();
168
	let parent_hash = [0; 32].into();
Gav Wood's avatar
Gav Wood committed
169
	let local_key: ValidatorId = [1; 32].unchecked_into();
170
171
172
173
174

	let block_data = BlockData(vec![1, 2, 3, 4]);
	let block_data_hash = block_data.hash();
	let candidate_receipt = CandidateReceipt {
		parachain_index: 5.into(),
Gav Wood's avatar
Gav Wood committed
175
		collator: [255; 32].unchecked_into(),
176
		head_data: HeadData(vec![9, 9, 9]),
Gav Wood's avatar
Gav Wood committed
177
		signature: Default::default(),
178
179
180
		egress_queue_roots: Vec::new(),
		fees: 1_000_000,
		block_data_hash,
181
		upward_messages: Vec::new(),
182
		erasure_root: [1u8; 32].into(),
183
184
185
	};

	let candidate_hash = candidate_receipt.hash();
Gav Wood's avatar
Gav Wood committed
186
187
	let a_key: ValidatorId = [3; 32].unchecked_into();
	let b_key: ValidatorId = [4; 32].unchecked_into();
188
189
190

	let status = Status { collating_for: None };

191
192
	let params = make_validation_leaf_work(parent_hash, local_key.clone());
	let session = protocol.new_validation_leaf_work(&mut TestContext::default(), params);
193
	let knowledge = session.knowledge();
194

Gav Wood's avatar
Gav Wood committed
195
	knowledge.lock().note_statement(a_key.clone(), &GenericStatement::Valid(candidate_hash));
196
	let canon_roots = StructuredUnroutedIngress(Vec::new());
197
198
199
200
201
202
	let recv = protocol.fetch_pov_block(
		&mut TestContext::default(),
		&candidate_receipt,
		parent_hash,
		canon_roots,
	);
203
204
205
206

	// connect peer A
	{
		let mut ctx = TestContext::default();
207
		protocol.on_connect(&mut ctx, peer_a.clone(), make_status(&status, Roles::AUTHORITY));
208
		assert!(ctx.has_message(peer_a.clone(), Message::ValidatorId(local_key)));
209
210
211
212
213
	}

	// peer A gives session key and gets asked for data.
	{
		let mut ctx = TestContext::default();
214
		on_message(&mut protocol, &mut ctx, peer_a.clone(), Message::ValidatorId(a_key.clone()));
215
		assert!(protocol.validators.contains_key(&a_key));
216
		assert!(ctx.has_message(peer_a.clone(), Message::RequestPovBlock(1, parent_hash, candidate_hash)));
217
218
	}

Gav Wood's avatar
Gav Wood committed
219
	knowledge.lock().note_statement(b_key.clone(), &GenericStatement::Valid(candidate_hash));
220
221
222
223

	// peer B connects and sends session key. request already assigned to A
	{
		let mut ctx = TestContext::default();
224
		protocol.on_connect(&mut ctx, peer_b.clone(), make_status(&status, Roles::AUTHORITY));
225
		on_message(&mut protocol, &mut ctx, peer_b.clone(), Message::ValidatorId(b_key.clone()));
226
		assert!(!ctx.has_message(peer_b.clone(), Message::RequestPovBlock(2, parent_hash, candidate_hash)));
227
228
229
230
231
232

	}

	// peer A disconnects, triggering reassignment
	{
		let mut ctx = TestContext::default();
233
		protocol.on_disconnect(&mut ctx, peer_a.clone());
234
		assert!(!protocol.validators.contains_key(&a_key));
235
		assert!(ctx.has_message(peer_b.clone(), Message::RequestPovBlock(2, parent_hash, candidate_hash)));
236
237
238
239
240
	}

	// peer B comes back with block data.
	{
		let mut ctx = TestContext::default();
241
242
		let pov_block = make_pov(block_data.0);
		on_message(&mut protocol, &mut ctx, peer_b, Message::PovBlock(2, Some(pov_block.clone())));
243
		drop(protocol);
244
		assert_eq!(block_on(recv).unwrap(), pov_block);
245
246
	}
}
247
248
249

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

252
	let who = PeerId::random();
Gav Wood's avatar
Gav Wood committed
253
	let collator_id: CollatorId = [2; 32].unchecked_into();
254

Gav Wood's avatar
Gav Wood committed
255
	let status = Status { collating_for: Some((collator_id.clone(), 5.into())) };
256
257
258

	{
		let mut ctx = TestContext::default();
259
		protocol.on_connect(&mut ctx, who.clone(), make_status(&status, Roles::NONE));
260
261
262
263
	}

	{
		let mut ctx = TestContext::default();
Gav Wood's avatar
Gav Wood committed
264
		protocol.disconnect_bad_collator(&mut ctx, collator_id);
Gav Wood's avatar
Gav Wood committed
265
		assert!(ctx.disabled.contains(&who));
266
267
	}
}
268

269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
#[test]
fn kick_collator() {
    let mut protocol = PolkadotProtocol::new(None);

    let who = PeerId::random();
    let collator_id: CollatorId = [2; 32].unchecked_into();

    let mut ctx = TestContext::default();
    let status = Status { collating_for: Some((collator_id.clone(), 5.into())) };
    protocol.on_connect(&mut ctx, who.clone(), make_status(&status, Roles::NONE));
    assert!(!ctx.disconnected.contains(&who));

    protocol.on_connect(&mut ctx, who.clone(), make_status(&status, Roles::NONE));
    assert!(ctx.disconnected.contains(&who));
}

285
286
287
288
289
290
291
#[test]
fn many_session_keys() {
	let mut protocol = PolkadotProtocol::new(None);

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

Gav Wood's avatar
Gav Wood committed
292
293
	let local_key_a: ValidatorId = [3; 32].unchecked_into();
	let local_key_b: ValidatorId = [4; 32].unchecked_into();
294

295
296
	let params_a = make_validation_leaf_work(parent_a, local_key_a.clone());
	let params_b = make_validation_leaf_work(parent_b, local_key_b.clone());
297

298
299
	protocol.new_validation_leaf_work(&mut TestContext::default(), params_a);
	protocol.new_validation_leaf_work(&mut TestContext::default(), params_b);
300

301
	assert_eq!(protocol.live_validation_leaves.recent_keys(), &[local_key_a.clone(), local_key_b.clone()]);
302

303
	let peer_a = PeerId::random();
304
305
306
307
308
309

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

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

312
313
		assert!(ctx.has_message(peer_a.clone(), Message::ValidatorId(local_key_a.clone())));
		assert!(ctx.has_message(peer_a, Message::ValidatorId(local_key_b.clone())));
314
315
	}

316
	let peer_b = PeerId::random();
317

318
	assert!(protocol.remove_validation_session(parent_a));
319
320
321
322
323

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

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

326
327
		assert!(!ctx.has_message(peer_b.clone(), Message::ValidatorId(local_key_a.clone())));
		assert!(ctx.has_message(peer_b, Message::ValidatorId(local_key_b.clone())));
328
329
	}
}