Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

test(subscriber): prefer sleep over yield_now in tests #475

Merged
merged 3 commits into from
Oct 25, 2023
Merged

test(subscriber): prefer sleep over yield_now in tests #475

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
8b1ecf2
test(subscriber): prefer `sleep` over `yield_now` in tests
hds Oct 11, 2023
396a114
Merge branch 'main' into hds/console-test-prefer-sleep
hds Oct 19, 2023
bc786ce
clarify why we're using sleep instead of yield_now
hds Oct 19, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
38 changes: 20 additions & 18 deletions console-subscriber/tests/framework.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@

use std::time::Duration;

use futures::future;
use tokio::{task, time::sleep};

mod support;
Expand All @@ -18,9 +19,7 @@ fn expect_present() {
.match_default_name()
.expect_present();

let future = async {
sleep(Duration::ZERO).await;
};
let future = future::ready(());

assert_task(expected_task, future);
}
Expand All @@ -32,9 +31,7 @@ fn expect_present() {
fn fail_no_expectations() {
let expected_task = ExpectedTask::default().match_default_name();

let future = async {
sleep(Duration::ZERO).await;
};
let future = future::ready(());

assert_task(expected_task, future);
}
Expand All @@ -43,9 +40,7 @@ fn fail_no_expectations() {
fn wakes() {
let expected_task = ExpectedTask::default().match_default_name().expect_wakes(1);

let future = async {
sleep(Duration::ZERO).await;
};
let future = async { yield_to_runtime().await };

assert_task(expected_task, future);
}
Expand All @@ -57,9 +52,7 @@ fn wakes() {
fn fail_wakes() {
let expected_task = ExpectedTask::default().match_default_name().expect_wakes(5);

let future = async {
sleep(Duration::ZERO).await;
};
let future = async { yield_to_runtime().await };

assert_task(expected_task, future);
}
Expand All @@ -85,6 +78,7 @@ fn fail_self_wake() {
.expect_self_wakes(1);

let future = async {
// `sleep` doesn't result in a self wake
sleep(Duration::ZERO).await;
};

Expand All @@ -100,7 +94,7 @@ fn test_spawned_task() {
let future = async {
task::Builder::new()
.name("another-name")
.spawn(async { task::yield_now().await })
.spawn(async { yield_to_runtime().await })
};

assert_task(expected_task, future);
Expand All @@ -113,7 +107,7 @@ fn test_spawned_task() {
fn fail_wrong_task_name() {
let expected_task = ExpectedTask::default().match_name("wrong-name".into());

let future = async { task::yield_now().await };
let future = async { yield_to_runtime().await };

assert_task(expected_task, future);
}
Expand All @@ -132,11 +126,11 @@ fn multiple_tasks() {
let future = async {
let task1 = task::Builder::new()
.name("task-1")
.spawn(async { task::yield_now().await })
.spawn(async { yield_to_runtime().await })
.unwrap();
let task2 = task::Builder::new()
.name("task-2")
.spawn(async { task::yield_now().await })
.spawn(async { yield_to_runtime().await })
.unwrap();

tokio::try_join! {
Expand Down Expand Up @@ -166,11 +160,11 @@ fn fail_1_of_2_expected_tasks() {
let future = async {
let task1 = task::Builder::new()
.name("task-1")
.spawn(async { task::yield_now().await })
.spawn(async { yield_to_runtime().await })
.unwrap();
let task2 = task::Builder::new()
.name("task-2")
.spawn(async { task::yield_now().await })
.spawn(async { yield_to_runtime().await })
.unwrap();

tokio::try_join! {
Expand All @@ -182,3 +176,11 @@ fn fail_1_of_2_expected_tasks() {

assert_tasks(expected_tasks, future);
}

async fn yield_to_runtime() {
// There is a race condition that can occur when tests are run in parallel,
// caused by tokio-rs/tracing#2743. It tends to cause test failures only
// when the test relies on a wake coming from `tokio::task::yield_now()`.
// For this reason, we prefer a zero-duration sleep.
sleep(Duration::ZERO).await;
}