Add test suite and minor refinements to the utility subsystem

Cargo.toml

@@ -52,7 +52,6 @@ members = [
 	"node/service",
 	"node/core/backing",
 	"node/subsystem",
-	"node/test-helpers/subsystem",
 	"node/test-service",
 
 	"parachain/test-parachains",

node/core/backing/Cargo.toml

@@ -22,5 +22,5 @@ bitvec = { version = "0.17.4", default-features = false, features = ["alloc"] }
 sp-core = { git = "https://github.com/paritytech/substrate", branch = "master" }
 sp-keyring = { git = "https://github.com/paritytech/substrate", branch = "master" }
 futures = { version = "0.3.5", features = ["thread-pool"] }
-subsystem-test = { package = "polkadot-subsystem-test-helpers", path = "../../test-helpers/subsystem" }
 assert_matches = "1.3.0"
+polkadot-subsystem = { package = "polkadot-node-subsystem", path = "../../subsystem", features = [ "test-helpers" ] }

node/core/backing/src/lib.rs

@@ -745,7 +745,7 @@ where
 
 	/// Run this subsystem
 	pub async fn run(ctx: Context, keystore: KeyStorePtr, spawner: Spawner) {
-		<Manager<Spawner, Context>>::run(ctx, keystore, spawner).await
+		<Manager<Spawner, Context>>::run(ctx, keystore, spawner, None).await
 	}
 }
 
@@ -895,13 +895,13 @@ mod tests {
 	}
 
 	struct TestHarness {
-		virtual_overseer: subsystem_test::TestSubsystemContextHandle<CandidateBackingMessage>,
+		virtual_overseer: polkadot_subsystem::test_helpers::TestSubsystemContextHandle<CandidateBackingMessage>,
 	}
 
 	fn test_harness<T: Future<Output=()>>(keystore: KeyStorePtr, test: impl FnOnce(TestHarness) -> T) {
 		let pool = sp_core::testing::SpawnBlockingExecutor::new();
 
-		let (context, virtual_overseer) = subsystem_test::make_subsystem_context(pool.clone());
+		let (context, virtual_overseer) = polkadot_subsystem::test_helpers::make_subsystem_context(pool.clone());
 
 		let subsystem = CandidateBackingSubsystem::run(context, keystore, pool.clone());
 
@@ -959,7 +959,7 @@ mod tests {
 
 	// Tests that the subsystem performs actions that are requied on startup.
 	async fn test_startup(
-		virtual_overseer: &mut subsystem_test::TestSubsystemContextHandle<CandidateBackingMessage>,
+		virtual_overseer: &mut polkadot_subsystem::test_helpers::TestSubsystemContextHandle<CandidateBackingMessage>,
 		test_state: &TestState,
 	) {
 		// Start work on some new parent.

node/network/bridge/Cargo.toml

@@ -18,6 +18,5 @@ polkadot-subsystem = { package = "polkadot-node-subsystem", path = "../../subsys
 
 [dev-dependencies]
 parking_lot = "0.10.0"
-subsystem-test = { package = "polkadot-subsystem-test-helpers", path = "../../test-helpers/subsystem" }
 assert_matches = "1.3.0"
 sp-core = { git = "https://github.com/paritytech/substrate", branch = "master" }

node/network/bridge/src/lib.rs

@@ -531,7 +531,7 @@ mod tests {
 	use assert_matches::assert_matches;
 
 	use polkadot_subsystem::messages::{StatementDistributionMessage, BitfieldDistributionMessage};
-	use subsystem_test::{SingleItemSink, SingleItemStream};
+	use polkadot_subsystem::test_helpers::{SingleItemSink, SingleItemStream};
 
 	// The subsystem's view of the network - only supports a single call to `event_stream`.
 	struct TestNetwork {
@@ -550,7 +550,7 @@ mod tests {
 		TestNetwork,
 		TestNetworkHandle,
 	) {
-		let (net_tx, net_rx) = subsystem_test::single_item_sink();
+		let (net_tx, net_rx) = polkadot_subsystem::test_helpers::single_item_sink();
 		let (action_tx, action_rx) = mpsc::unbounded();
 
 		(
@@ -631,13 +631,13 @@ mod tests {
 
 	struct TestHarness {
 		network_handle: TestNetworkHandle,
-		virtual_overseer: subsystem_test::TestSubsystemContextHandle<NetworkBridgeMessage>,
+		virtual_overseer: polkadot_subsystem::test_helpers::TestSubsystemContextHandle<NetworkBridgeMessage>,
 	}
 
 	fn test_harness<T: Future<Output=()>>(test: impl FnOnce(TestHarness) -> T) {
 		let pool = sp_core::testing::SpawnBlockingExecutor::new();
 		let (network, network_handle) = new_test_network();
-		let (context, virtual_overseer) = subsystem_test::make_subsystem_context(pool);
+		let (context, virtual_overseer) = polkadot_subsystem::test_helpers::make_subsystem_context(pool);
 
 		let network_bridge = run_network(
 			network,

node/network/pov-distribution/Cargo.toml

@@ -18,6 +18,6 @@ polkadot-subsystem = { package = "polkadot-node-subsystem", path = "../../subsys
 
 [dev-dependencies]
 parking_lot = "0.10.0"
-subsystem-test = { package = "polkadot-subsystem-test-helpers", path = "../../test-helpers/subsystem" }
 assert_matches = "1.3.0"
 sp-core = { git = "https://github.com/paritytech/substrate", branch = "master" }
+polkadot-subsystem = { package = "polkadot-node-subsystem", path = "../../subsystem", features = [ "test-helpers" ] }

node/network/pov-distribution/src/lib.rs

@@ -620,7 +620,7 @@ mod tests {
 		};
 
 		let pool = sp_core::testing::SpawnBlockingExecutor::new();
-		let (mut ctx, mut handle) = subsystem_test::make_subsystem_context(pool);
+		let (mut ctx, mut handle) = polkadot_subsystem::test_helpers::make_subsystem_context(pool);
 		let mut descriptor = CandidateDescriptor::default();
 		descriptor.pov_hash = pov_hash;
 
@@ -700,7 +700,7 @@ mod tests {
 		};
 
 		let pool = sp_core::testing::SpawnBlockingExecutor::new();
-		let (mut ctx, mut handle) = subsystem_test::make_subsystem_context(pool);
+		let (mut ctx, mut handle) = polkadot_subsystem::test_helpers::make_subsystem_context(pool);
 		let mut descriptor = CandidateDescriptor::default();
 		descriptor.pov_hash = pov_hash;
 
@@ -778,7 +778,7 @@ mod tests {
 		};
 
 		let pool = sp_core::testing::SpawnBlockingExecutor::new();
-		let (mut ctx, mut handle) = subsystem_test::make_subsystem_context(pool);
+		let (mut ctx, mut handle) = polkadot_subsystem::test_helpers::make_subsystem_context(pool);
 
 		executor::block_on(async move {
 			handle_network_update(
@@ -850,7 +850,7 @@ mod tests {
 		};
 
 		let pool = sp_core::testing::SpawnBlockingExecutor::new();
-		let (mut ctx, mut handle) = subsystem_test::make_subsystem_context(pool);
+		let (mut ctx, mut handle) = polkadot_subsystem::test_helpers::make_subsystem_context(pool);
 
 		executor::block_on(async move {
 			// Peer A answers our request before peer B.
@@ -938,7 +938,7 @@ mod tests {
 		};
 
 		let pool = sp_core::testing::SpawnBlockingExecutor::new();
-		let (mut ctx, mut handle) = subsystem_test::make_subsystem_context(pool);
+		let (mut ctx, mut handle) = polkadot_subsystem::test_helpers::make_subsystem_context(pool);
 
 		executor::block_on(async move {
 			// Peer A answers our request: right relay parent, awaited hash, wrong PoV.
@@ -1001,7 +1001,7 @@ mod tests {
 		};
 
 		let pool = sp_core::testing::SpawnBlockingExecutor::new();
-		let (mut ctx, mut handle) = subsystem_test::make_subsystem_context(pool);
+		let (mut ctx, mut handle) = polkadot_subsystem::test_helpers::make_subsystem_context(pool);
 
 		executor::block_on(async move {
 			// Peer A answers our request: right relay parent, awaited hash, wrong PoV.
@@ -1062,7 +1062,7 @@ mod tests {
 		};
 
 		let pool = sp_core::testing::SpawnBlockingExecutor::new();
-		let (mut ctx, mut handle) = subsystem_test::make_subsystem_context(pool);
+		let (mut ctx, mut handle) = polkadot_subsystem::test_helpers::make_subsystem_context(pool);
 
 		executor::block_on(async move {
 			// Peer A answers our request: right relay parent, awaited hash, wrong PoV.
@@ -1120,7 +1120,7 @@ mod tests {
 		};
 
 		let pool = sp_core::testing::SpawnBlockingExecutor::new();
-		let (mut ctx, mut handle) = subsystem_test::make_subsystem_context(pool);
+		let (mut ctx, mut handle) = polkadot_subsystem::test_helpers::make_subsystem_context(pool);
 
 		executor::block_on(async move {
 			let max_plausibly_awaited = n_validators * 2;
@@ -1205,7 +1205,7 @@ mod tests {
 		};
 
 		let pool = sp_core::testing::SpawnBlockingExecutor::new();
-		let (mut ctx, mut handle) = subsystem_test::make_subsystem_context(pool);
+		let (mut ctx, mut handle) = polkadot_subsystem::test_helpers::make_subsystem_context(pool);
 
 		executor::block_on(async move {
 			let pov_hash = make_pov(vec![1, 2, 3]).hash();
@@ -1267,7 +1267,7 @@ mod tests {
 		};
 
 		let pool = sp_core::testing::SpawnBlockingExecutor::new();
-		let (mut ctx, mut handle) = subsystem_test::make_subsystem_context(pool);
+		let (mut ctx, mut handle) = polkadot_subsystem::test_helpers::make_subsystem_context(pool);
 
 		executor::block_on(async move {
 			let pov_hash = make_pov(vec![1, 2, 3]).hash();
@@ -1344,7 +1344,7 @@ mod tests {
 		};
 
 		let pool = sp_core::testing::SpawnBlockingExecutor::new();
-		let (mut ctx, mut handle) = subsystem_test::make_subsystem_context(pool);
+		let (mut ctx, mut handle) = polkadot_subsystem::test_helpers::make_subsystem_context(pool);
 
 		executor::block_on(async move {
 			handle_network_update(
@@ -1427,7 +1427,7 @@ mod tests {
 		};
 
 		let pool = sp_core::testing::SpawnBlockingExecutor::new();
-		let (mut ctx, mut handle) = subsystem_test::make_subsystem_context(pool);
+		let (mut ctx, mut handle) = polkadot_subsystem::test_helpers::make_subsystem_context(pool);
 
 		executor::block_on(async move {
 			handle_network_update(

node/network/statement-distribution/Cargo.toml

@@ -21,7 +21,7 @@ indexmap = "1.4.0"
 
 [dev-dependencies]
 parking_lot = "0.10.0"
-subsystem-test = { package = "polkadot-subsystem-test-helpers", path = "../../test-helpers/subsystem" }
+polkadot-subsystem = { package = "polkadot-node-subsystem", path = "../../subsystem", features = ["test-helpers"] }
 assert_matches = "1.3.0"
 sp-keyring = { git = "https://github.com/paritytech/substrate", branch = "master" }
 sp-core = { git = "https://github.com/paritytech/substrate", branch = "master" }

node/network/statement-distribution/src/lib.rs

@@ -1213,7 +1213,7 @@ mod tests {
 		};
 
 		let pool = sp_core::testing::SpawnBlockingExecutor::new();
-		let (mut ctx, mut handle) = subsystem_test::make_subsystem_context(pool);
+		let (mut ctx, mut handle) = polkadot_subsystem::test_helpers::make_subsystem_context(pool);
 		let peer = PeerId::random();
 
 		executor::block_on(async move {
@@ -1305,7 +1305,7 @@ mod tests {
 		].into_iter().collect();
 
 		let pool = sp_core::testing::SpawnBlockingExecutor::new();
-		let (mut ctx, mut handle) = subsystem_test::make_subsystem_context(pool);
+		let (mut ctx, mut handle) = polkadot_subsystem::test_helpers::make_subsystem_context(pool);
 
 		executor::block_on(async move {
 			let statement = {

node/subsystem/Cargo.toml

@@ -13,10 +13,20 @@ futures-timer = "3.0.2"
 keystore = { package = "sc-keystore", git = "https://github.com/paritytech/substrate", branch = "master" }
 log = "0.4.8"
 parity-scale-codec = "1.3.0"
+parking_lot = { version = "0.10.0", optional = true }
 pin-project = "0.4.22"
 polkadot-node-primitives = { path = "../primitives" }
 polkadot-primitives = { path = "../../primitives" }
 polkadot-statement-table = { path = "../../statement-table" }
 sc-network = { git = "https://github.com/paritytech/substrate", branch = "master" }
 sp-core = { git = "https://github.com/paritytech/substrate", branch = "master" }
 streamunordered = "0.5.1"
+
+[dev-dependencies]
+assert_matches = "1.3.0"
+async-trait = "0.1"
+futures = { version = "0.3.5", features = ["thread-pool"] }
+parking_lot = "0.10.0"
+
+[features]
+test-helpers = [ "parking_lot" ]

node/subsystem/src/lib.rs

@@ -35,6 +35,8 @@ use crate::messages::AllMessages;
 
 pub mod messages;
 pub mod util;
+#[cfg(any(test, feature = "test-helpers"))]
+pub mod test_helpers;
 
 /// Signals sent by an overseer to a subsystem.
 #[derive(PartialEq, Clone, Debug)]
@@ -71,7 +73,7 @@ pub enum FromOverseer<M> {
 ///   * Subsystems dying when they are not expected to
 ///   * Subsystems not dying when they are told to die
 ///   * etc.
-#[derive(Debug)]
+#[derive(Debug, PartialEq, Eq)]
 pub struct SubsystemError;
 
 impl From<mpsc::SendError> for SubsystemError {

node/subsystem/src/messages.rs

@@ -408,4 +408,10 @@ pub enum AllMessages {
 	AvailabilityStore(AvailabilityStoreMessage),
 	/// Message for the network bridge subsystem.
 	NetworkBridge(NetworkBridgeMessage),
+	/// Test message
+	///
+	/// This variant is only valid while testing, but makes the process of testing the
+	/// subsystem job manager much simpler.
+	#[cfg(test)]
+	Test(String),
 }

node/test-helpers/subsystem/src/lib.rs → node/subsystem/src/test_helpers.rs

@@ -16,8 +16,8 @@
 
 //! Utilities for testing subsystems.
 
-use polkadot_subsystem::{SubsystemContext, FromOverseer, SubsystemResult, SubsystemError};
-use polkadot_subsystem::messages::AllMessages;
+use crate::{SubsystemContext, FromOverseer, SubsystemResult, SubsystemError};
+use crate::messages::AllMessages;
 
 use futures::prelude::*;
 use futures::channel::mpsc;