From 304bdb33e13c7eef6e3c0f73acce789544811662 Mon Sep 17 00:00:00 2001 From: Markus Pettersson Date: Fri, 13 Dec 2024 15:14:21 +0100 Subject: [PATCH] Implement time sensitive tests for FDA check Add test for checking that the newly added timeout to the FDA check works as expected. --- talpid-core/Cargo.toml | 4 ++ talpid-core/src/split_tunnel/macos/process.rs | 65 ++++++++++++++++++- 2 files changed, 68 insertions(+), 1 deletion(-) diff --git a/talpid-core/Cargo.toml b/talpid-core/Cargo.toml index 7ec3fd20f288..0cc71a439950 100644 --- a/talpid-core/Cargo.toml +++ b/talpid-core/Cargo.toml @@ -103,3 +103,7 @@ features = [ [build-dependencies] tonic-build = { workspace = true, default-features = false, features = ["transport", "prost"] } + + +[dev-dependencies] +tokio = { workspace = true, features = [ "io-util", "test-util", "time" ] } diff --git a/talpid-core/src/split_tunnel/macos/process.rs b/talpid-core/src/split_tunnel/macos/process.rs index 49ae0fd740e1..c29958a0943f 100644 --- a/talpid-core/src/split_tunnel/macos/process.rs +++ b/talpid-core/src/split_tunnel/macos/process.rs @@ -553,8 +553,28 @@ fn check_os_version_support_inner(version: MacosVersion) -> Result<(), Error> { #[cfg(test)] mod test { - use super::{check_os_version_support_inner, parse_logger_status, NeedFda, MIN_OS_VERSION}; + use super::*; + + use std::time::Duration; use talpid_platform_metadata::MacosVersion; + use tokio::io::{simplex, AsyncWriteExt}; + + /// A mock-version of stdout. [SimplexStream] implements [AsyncRead], so it can be used to test + /// [parse_logger_status]. + fn output(msg: &'static str, lag: Duration) -> impl AsyncRead + Unpin + Send + 'static { + // Ensure that 'msg' contains a newline to prevent user errors + assert!( + msg.contains('\n'), + "Message does not contain a newline!! Make sure to add a newline to '{msg}'" + ); + let (stdout_read, mut stdout_write) = simplex(msg.as_bytes().len()); + // "print" to "stdout" after `duration`. + tokio::spawn(async move { + tokio::time::sleep(lag).await; + stdout_write.write_all(msg.as_bytes()).await.unwrap(); + }); + stdout_read + } #[test] fn test_min_os_version() { @@ -622,4 +642,47 @@ mod test { "expected 'NeedFda::No' on immediate exit", ); } + + /// Check that [parse_logger_status] returns within a reasonable timeframe. + /// "Reasonable" being within [EARLY_FAIL_TIMEOUT]. + #[tokio::test] + async fn test_parse_logger_status_responsive() { + tokio::time::pause(); + let start = tokio::time::Instant::now(); + let stdout = output("This will never be printed\n", Duration::MAX); + let stderr = output( + "ES_NEW_CLIENT_RESULT_ERR_NOT_PERMITTED\n", + EARLY_FAIL_TIMEOUT / 2, + ); + tokio::time::resume(); + + let need_fda = parse_logger_status(stdout, stderr).await; + + tokio::time::pause(); + + assert_eq!( + need_fda, + NeedFda::Yes, + "expected 'NeedFda::Yes' when ES_NEW_CLIENT_RESULT_ERR_NOT_PERMITTED was eventually printed to stderr" + ); + + // Assert that we did not spend more time waiting than we should + assert!(start.elapsed() < EARLY_FAIL_TIMEOUT); + } + + /// Check that [parse_logger_status] doesn't get stuck because nothing is ever output + /// to std{out,err}. + #[tokio::test] + async fn test_parse_logger_status_hogged() { + let stdout = output("This will never be printed\n", Duration::MAX); + let stderr = output("This will never be printed\n", Duration::MAX); + + let need_fda = parse_logger_status(stdout, stderr).await; + + assert_eq!( + need_fda, + NeedFda::No, + "expected 'NeedFda::No' when nothing was ever printed to stdout or stderr" + ); + } }