tests: use future::join instead of future::select (#2813)

* tests/av-store: use future::join instead of future::select

* tests/backing: use future::join instead of future::select

* tests/provisioner: use future::join instead of future::select

* tests/av-dist: use future::join instead of future::select

* tests/av-recovery: use future::join instead of future::select

* tests/bridge: use future::join instead of future::select

* tests/collator-protocol: use future::join instead of future::select

* tests/stmt-dist: use future::join instead of future::select

* fix tests

polkadot/node/core/av-store/src/tests.rs

@@ -49,9 +49,7 @@ const TEST_CONFIG: Config = Config {
 	col_meta: columns::META,
 };
 
-struct TestHarness {
-	virtual_overseer: test_helpers::TestSubsystemContextHandle<AvailabilityStoreMessage>,
-}
+type VirtualOverseer = test_helpers::TestSubsystemContextHandle<AvailabilityStoreMessage>;
 
 #[derive(Default)]
 struct TestCandidateBuilder {
@@ -140,10 +138,10 @@ impl Default for TestState {
 }
 
 
-fn test_harness<T: Future<Output=()>>(
+fn test_harness<T: Future<Output=VirtualOverseer>>(
 	state: TestState,
 	store: Arc<dyn KeyValueDB>,
-	test: impl FnOnce(TestHarness) -> T,
+	test: impl FnOnce(VirtualOverseer) -> T,
 ) {
 	let _ = env_logger::builder()
 		.is_test(true)
@@ -170,20 +168,24 @@ fn test_harness<T: Future<Output=()>>(
 
 	let subsystem = run(subsystem, context);
 
-	let test_fut = test(TestHarness {
-		virtual_overseer,
-	});
+	let test_fut = test(virtual_overseer);
 
 	futures::pin_mut!(test_fut);
 	futures::pin_mut!(subsystem);
 
-	executor::block_on(future::select(test_fut, subsystem));
+	executor::block_on(future::join(async move {
+		let mut overseer = test_fut.await;
+		overseer_signal(
+			&mut overseer,
+			OverseerSignal::Conclude,
+		).await;
+	}, subsystem));
 }
 
 const TIMEOUT: Duration = Duration::from_millis(100);
 
 async fn overseer_send(
-	overseer: &mut test_helpers::TestSubsystemContextHandle<AvailabilityStoreMessage>,
+	overseer: &mut VirtualOverseer,
 	msg: AvailabilityStoreMessage,
 ) {
 	tracing::trace!(meg = ?msg, "sending message");
@@ -195,7 +197,7 @@ async fn overseer_send(
 }
 
 async fn overseer_recv(
-	overseer: &mut test_helpers::TestSubsystemContextHandle<AvailabilityStoreMessage>,
+	overseer: &mut VirtualOverseer,
 ) -> AllMessages {
 	let msg = overseer_recv_with_timeout(overseer, TIMEOUT)
 		.await
@@ -207,7 +209,7 @@ async fn overseer_recv(
 }
 
 async fn overseer_recv_with_timeout(
-	overseer: &mut test_helpers::TestSubsystemContextHandle<AvailabilityStoreMessage>,
+	overseer: &mut VirtualOverseer,
 	timeout: Duration,
 ) -> Option<AllMessages> {
 	tracing::trace!("waiting for message...");
@@ -218,7 +220,7 @@ async fn overseer_recv_with_timeout(
 }
 
 async fn overseer_signal(
-	overseer: &mut test_helpers::TestSubsystemContextHandle<AvailabilityStoreMessage>,
+	overseer: &mut VirtualOverseer,
 	signal: OverseerSignal,
 ) {
 	overseer
@@ -247,8 +249,7 @@ fn candidate_included(receipt: CandidateReceipt) -> CandidateEvent {
 fn runtime_api_error_does_not_stop_the_subsystem() {
 	let store = Arc::new(kvdb_memorydb::create(columns::NUM_COLUMNS));
 
-	test_harness(TestState::default(), store, |test_harness| async move {
-		let TestHarness { mut virtual_overseer } = test_harness;
+	test_harness(TestState::default(), store, |mut virtual_overseer| async move {
 		let new_leaf = Hash::repeat_byte(0x01);
 
 		overseer_signal(
@@ -288,15 +289,14 @@ fn runtime_api_error_does_not_stop_the_subsystem() {
 		overseer_send(&mut virtual_overseer, query_chunk.into()).await;
 
 		assert!(rx.await.unwrap().is_none());
-
+		virtual_overseer
 	});
 }
 
 #[test]
 fn store_chunk_works() {
 	let store = Arc::new(kvdb_memorydb::create(columns::NUM_COLUMNS));
-	test_harness(TestState::default(), store.clone(), |test_harness| async move {
-		let TestHarness { mut virtual_overseer } = test_harness;
+	test_harness(TestState::default(), store.clone(), |mut virtual_overseer| async move {
 		let candidate_hash = CandidateHash(Hash::repeat_byte(33));
 		let validator_index = ValidatorIndex(5);
 		let n_validators = 10;
@@ -338,6 +338,7 @@ fn store_chunk_works() {
 		overseer_send(&mut virtual_overseer, query_chunk.into()).await;
 
 		assert_eq!(rx.await.unwrap().unwrap(), chunk);
+		virtual_overseer
 	});
 }
 
@@ -345,8 +346,7 @@ fn store_chunk_works() {
 #[test]
 fn store_chunk_does_nothing_if_no_entry_already() {
 	let store = Arc::new(kvdb_memorydb::create(columns::NUM_COLUMNS));
-	test_harness(TestState::default(), store.clone(), |test_harness| async move {
-		let TestHarness { mut virtual_overseer } = test_harness;
+	test_harness(TestState::default(), store.clone(), |mut virtual_overseer| async move {
 		let candidate_hash = CandidateHash(Hash::repeat_byte(33));
 		let validator_index = ValidatorIndex(5);
 
@@ -377,14 +377,14 @@ fn store_chunk_does_nothing_if_no_entry_already() {
 		overseer_send(&mut virtual_overseer, query_chunk.into()).await;
 
 		assert!(rx.await.unwrap().is_none());
+		virtual_overseer
 	});
 }
 
 #[test]
 fn query_chunk_checks_meta() {
 	let store = Arc::new(kvdb_memorydb::create(columns::NUM_COLUMNS));
-	test_harness(TestState::default(), store.clone(), |test_harness| async move {
-		let TestHarness { mut virtual_overseer } = test_harness;
+	test_harness(TestState::default(), store.clone(), |mut virtual_overseer| async move {
 		let candidate_hash = CandidateHash(Hash::repeat_byte(33));
 		let validator_index = ValidatorIndex(5);
 		let n_validators = 10;
@@ -422,6 +422,7 @@ fn query_chunk_checks_meta() {
 
 		overseer_send(&mut virtual_overseer, query_chunk.into()).await;
 		assert!(!rx.await.unwrap());
+		virtual_overseer
 	});
 }
 
@@ -429,8 +430,7 @@ fn query_chunk_checks_meta() {
 fn store_block_works() {
 	let store = Arc::new(kvdb_memorydb::create(columns::NUM_COLUMNS));
 	let test_state = TestState::default();
-	test_harness(test_state.clone(), store.clone(), |test_harness| async move {
-		let TestHarness { mut virtual_overseer } = test_harness;
+	test_harness(test_state.clone(), store.clone(), |mut virtual_overseer| async move {
 		let candidate_hash = CandidateHash(Hash::repeat_byte(1));
 		let validator_index = ValidatorIndex(5);
 		let n_validators = 10;
@@ -474,6 +474,7 @@ fn store_block_works() {
 		};
 
 		assert_eq!(chunk, expected_chunk);
+		virtual_overseer
 	});
 }
 
@@ -482,8 +483,7 @@ fn store_pov_and_query_chunk_works() {
 	let store = Arc::new(kvdb_memorydb::create(columns::NUM_COLUMNS));
 	let test_state = TestState::default();
 
-	test_harness(test_state.clone(), store.clone(), |test_harness| async move {
-		let TestHarness { mut virtual_overseer } = test_harness;
+	test_harness(test_state.clone(), store.clone(), |mut virtual_overseer| async move {
 		let candidate_hash = CandidateHash(Hash::repeat_byte(1));
 		let n_validators = 10;
 
@@ -516,6 +516,7 @@ fn store_pov_and_query_chunk_works() {
 
 			assert_eq!(chunk.chunk, chunks_expected[i as usize]);
 		}
+		virtual_overseer
 	});
 }
 
@@ -524,9 +525,7 @@ fn query_all_chunks_works() {
 	let store = Arc::new(kvdb_memorydb::create(columns::NUM_COLUMNS));
 	let test_state = TestState::default();
 
-	test_harness(test_state.clone(), store.clone(), |test_harness| async move {
-		let TestHarness { mut virtual_overseer } = test_harness;
-
+	test_harness(test_state.clone(), store.clone(), |mut virtual_overseer| async move {
 		// all chunks for hash 1.
 		// 1 chunk for hash 2.
 		// 0 chunks for hash 3.
@@ -608,6 +607,7 @@ fn query_all_chunks_works() {
 			virtual_overseer.send(FromOverseer::Communication { msg }).await;
 			assert_eq!(rx.await.unwrap().len(), 0);
 		}
+		virtual_overseer
 	});
 }
 
@@ -616,8 +616,7 @@ fn stored_but_not_included_data_is_pruned() {
 	let store = Arc::new(kvdb_memorydb::create(columns::NUM_COLUMNS));
 	let test_state = TestState::default();
 
-	test_harness(test_state.clone(), store.clone(), |test_harness| async move {
-		let TestHarness { mut virtual_overseer } = test_harness;
+	test_harness(test_state.clone(), store.clone(), |mut virtual_overseer| async move {
 		let candidate_hash = CandidateHash(Hash::repeat_byte(1));
 		let n_validators = 10;
 
@@ -655,6 +654,7 @@ fn stored_but_not_included_data_is_pruned() {
 
 		// The block was not included by this point so it should be pruned now.
 		assert!(query_available_data(&mut virtual_overseer, candidate_hash).await.is_none());
+		virtual_overseer
 	});
 }
 
@@ -663,8 +663,7 @@ fn stored_data_kept_until_finalized() {
 	let store = Arc::new(kvdb_memorydb::create(columns::NUM_COLUMNS));
 	let test_state = TestState::default();
 
-	test_harness(test_state.clone(), store.clone(), |test_harness| async move {
-		let TestHarness { mut virtual_overseer } = test_harness;
+	test_harness(test_state.clone(), store.clone(), |mut virtual_overseer| async move {
 		let n_validators = 10;
 
 		let pov = PoV {
@@ -760,6 +759,7 @@ fn stored_data_kept_until_finalized() {
 		assert!(
 			has_all_chunks(&mut virtual_overseer, candidate_hash, n_validators, false).await
 		);
+		virtual_overseer
 	});
 }
 
@@ -768,8 +768,7 @@ fn forkfullness_works() {
 	let store = Arc::new(kvdb_memorydb::create(columns::NUM_COLUMNS));
 	let test_state = TestState::default();
 
-	test_harness(test_state.clone(), store.clone(), |test_harness| async move {
-		let TestHarness { mut virtual_overseer } = test_harness;
+	test_harness(test_state.clone(), store.clone(), |mut virtual_overseer| async move {
 		let n_validators = 10;
 		let block_number_1 = 5;
 		let block_number_2 = 5;
@@ -930,11 +929,12 @@ fn forkfullness_works() {
 		assert!(
 			has_all_chunks(&mut virtual_overseer, candidate_2_hash, n_validators, false).await,
 		);
+		virtual_overseer
 	});
 }
 
 async fn query_available_data(
-	virtual_overseer: &mut test_helpers::TestSubsystemContextHandle<AvailabilityStoreMessage>,
+	virtual_overseer: &mut VirtualOverseer,
 	candidate_hash: CandidateHash,
 ) -> Option<AvailableData> {
 	let (tx, rx) = oneshot::channel();
@@ -946,7 +946,7 @@ async fn query_available_data(
 }
 
 async fn query_chunk(
-	virtual_overseer: &mut test_helpers::TestSubsystemContextHandle<AvailabilityStoreMessage>,
+	virtual_overseer: &mut VirtualOverseer,
 	candidate_hash: CandidateHash,
 	index: ValidatorIndex,
 ) -> Option<ErasureChunk> {
@@ -959,7 +959,7 @@ async fn query_chunk(
 }
 
 async fn has_all_chunks(
-	virtual_overseer: &mut test_helpers::TestSubsystemContextHandle<AvailabilityStoreMessage>,
+	virtual_overseer: &mut VirtualOverseer,
 	candidate_hash: CandidateHash,
 	n_validators: u32,
 	expect_present: bool,
@@ -973,7 +973,7 @@ async fn has_all_chunks(
 }
 
 async fn import_leaf(
-	virtual_overseer: &mut test_helpers::TestSubsystemContextHandle<AvailabilityStoreMessage>,
+	virtual_overseer: &mut VirtualOverseer,
 	parent_hash: Hash,
 	block_number: BlockNumber,
 	events: Vec<CandidateEvent>,