muxers: Add test harness for StreamMuxer implementations (#2952)

libp2p · Oct 17, 2022 · 4d4833f · 4d4833f
1 parent 981d586
commit 4d4833f
Show file tree

Hide file tree

Showing 9 changed files with 426 additions and 305 deletions.
diff --git a/Cargo.toml b/Cargo.toml
@@ -152,6 +152,7 @@ members = [
     "misc/quickcheck-ext",
     "muxers/mplex",
     "muxers/yamux",
+    "muxers/test-harness",
     "protocols/dcutr",
     "protocols/autonat",
     "protocols/floodsub",

diff --git a/muxers/mplex/Cargo.toml b/muxers/mplex/Cargo.toml
@@ -23,11 +23,12 @@ smallvec = "1.6.1"
 unsigned-varint = { version = "0.7", features = ["asynchronous_codec"] }
 
 [dev-dependencies]
-async-std = "1.7.0"
+async-std = { version = "1.7.0", features = ["attributes"] }
 criterion = "0.4"
 env_logger = "0.9"
 futures = "0.3"
 libp2p = { path = "../..", features = ["full"] }
+libp2p-muxer-test-harness = { path = "../test-harness" }
 quickcheck = { package = "quickcheck-ext", path = "../../misc/quickcheck-ext" }
 
 [[bench]]

diff --git a/muxers/mplex/tests/async_write.rs b/muxers/mplex/tests/async_write.rs
diff --git a/muxers/mplex/tests/compliance.rs b/muxers/mplex/tests/compliance.rs
@@ -0,0 +1,28 @@
+use libp2p_mplex::MplexConfig;
+
+#[async_std::test]
+async fn close_implies_flush() {
+    let (alice, bob) =
+        libp2p_muxer_test_harness::connected_muxers_on_memory_transport::<MplexConfig, _, _>()
+            .await;
+
+    libp2p_muxer_test_harness::close_implies_flush(alice, bob).await;
+}
+
+#[async_std::test]
+async fn dialer_can_receive() {
+    let (alice, bob) =
+        libp2p_muxer_test_harness::connected_muxers_on_memory_transport::<MplexConfig, _, _>()
+            .await;
+
+    libp2p_muxer_test_harness::dialer_can_receive(alice, bob).await;
+}
+
+#[async_std::test]
+async fn read_after_close() {
+    let (alice, bob) =
+        libp2p_muxer_test_harness::connected_muxers_on_memory_transport::<MplexConfig, _, _>()
+            .await;
+
+    libp2p_muxer_test_harness::read_after_close(alice, bob).await;
+}
diff --git a/muxers/mplex/tests/two_peers.rs b/muxers/mplex/tests/two_peers.rs
diff --git a/muxers/test-harness/Cargo.toml b/muxers/test-harness/Cargo.toml
@@ -0,0 +1,14 @@
+[package]
+name = "libp2p-muxer-test-harness"
+version = "0.1.0"
+edition = "2021"
+publish = false
+license = "MIT"
+
+# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
+
+[dependencies]
+libp2p-core = { path = "../../core" }
+futures = "0.3.24"
+log = "0.4"
+futures-timer = "3.0.2"