Add new tests for JoinSet, JoinMap, TaskTracer and LocalRuntime #7609

FrancescoV1985 · 2025-09-11T12:23:27Z

Fixes: #7562

Motivation

Improve the test coverage of task containers on LocalRuntime

Solution

Added new tests for JoinSet, JoinMap, TaskTracer

…calRuntime. Fixes: tokio-rs#7562

tokio/tests/rt_local.rs

tokio/tests/task_join_set.rs

ADD-SP · 2025-09-25T13:43:38Z

Hi @FrancescoV1985 , any update on this PR?

FrancescoV1985 · 2025-09-25T17:32:35Z

Hi @FrancescoV1985 , any update on this PR?
Hi @ADD-SP
I have updated the code (see pm on discord)

ADD-SP

Could you try to reduce the duplicated code from test code? Also, Are the tests for TaskTracker in the scope of this PR?

ADD-SP · 2025-09-26T13:50:03Z

tokio/tests/task_join_set.rs

+            set.spawn_local_on(async move { *rc }, &local);
+        }
+
+        assert!(set.try_join_next().is_none());


Actually, since we are using the single thread runtime and there is no yield point here, the set.try_join_next() is always None, we should rewrite this test.

ADD-SP · 2025-09-26T14:00:10Z

tokio/tests/task_join_set.rs

+// Tasks are queued with `spawn_local_on` **before** the `LocalSet` is
+// running, then executed once the `LocalSet` is started.
+#[tokio::test(flavor = "current_thread")]
+async fn spawn_local_on_on_started_localset() {


What's the difference between this test and spawn_local_on_local_runtime?

The difference is that in spawn_local_on_local_runtime I am using LocalSet inside LocalRunTime as the comment says "// Drive a LocalSet on top of a LocalRuntime ". I leave it to you whether to consider one of them redundant...

tokio/tests/task_join_set.rs

FrancescoV1985 · 2025-09-26T15:01:28Z

Could you try to reduce the duplicated code from test code? Also, Are the tests for TaskTracker in the scope of this PR?

I committed the tests for TaskTracker. I still need to add comments and double check. I will pm you for some clarifications..

ADD-SP

Please sync changes from the base branch to fix the CI failures.

ADD-SP · 2025-10-08T05:53:55Z

tokio/tests/task_join_set.rs

Currently, the test combinations looks complicated and hard to understand.

spawn_local_local_runtime

spawn_local_on_local_runtime

shutdown_spawn_local_local_runtime

drop_spawn_local_local_runtime

......

Could you try to make it more clear? For example, grouping tests using mod.

mod spawn_local { mod local_runtime { } mod local_set { } } mod spawn_local_on { mod local_runtime { } mod local_set { } }

Concerning TaskTracker, I am considering to simplify some tests...Please be patient

ADD-SP

Since the mod name has already indicated the scope, we can improve the test name, also change the comments.

Feel free to re-write the suggested changes.

ADD-SP · 2025-10-08T12:54:22Z

tokio/tests/task_join_set.rs

+        // `JoinSet::spawn_local`, and wait for every task to finish.
+        #[cfg(tokio_unstable)]
+        #[test]
+        fn spawn_local_local_runtime() {


Suggested change

fn spawn_local_local_runtime() {

fn spawn_then_join_next() {

ADD-SP · 2025-10-08T12:55:29Z

tokio/tests/task_join_set.rs

+        // inserted with `JoinSet::spawn_local`.
+        #[cfg(tokio_unstable)]
+        #[test]
+        fn shutdown_spawn_local_local_runtime() {


Suggested change

fn shutdown_spawn_local_local_runtime() {

fn spawn_then_shutdown() {

ADD-SP · 2025-10-08T12:55:52Z

tokio/tests/task_join_set.rs

+        // added with `JoinSet::spawn_local`.
+        #[cfg(tokio_unstable)]
+        #[test]
+        fn drop_spawn_local_local_runtime() {


Suggested change

fn drop_spawn_local_local_runtime() {

fn spawn_then_drop() {

ADD-SP · 2025-10-08T12:56:06Z

tokio/tests/task_join_set.rs

+        // Every task is spawned with `spawn_local` **inside** the `LocalSet`
+        // that is currently running.
+        #[tokio::test(flavor = "current_thread")]
+        async fn spawn_local_running_localset() {


Suggested change

async fn spawn_local_running_localset() {

async fn spawn_then_join_next() {

ADD-SP · 2025-10-08T12:56:17Z

tokio/tests/task_join_set.rs

+        // Shutdown a `JoinSet` that was populated with `spawn_local`
+        // must abort all still-running tasks.
+        #[tokio::test(flavor = "current_thread")]
+        async fn shutdown_spawn_local_localset() {


Suggested change

async fn shutdown_spawn_local_localset() {

async fn spawn_then_shutdown() {

ADD-SP · 2025-10-08T13:08:57Z

tokio/tests/task_join_set.rs

+        // Shutdown a `JoinSet` that was populated with `spawn_local`
+        // must abort all still-running tasks.


Suggested change

// Shutdown a `JoinSet` that was populated with `spawn_local`

// must abort all still-running tasks.

/// Spawn several pending-forever tasks, and then shutdown the [`JoinSet`].

ADD-SP · 2025-10-08T13:11:13Z

tokio/tests/task_join_set.rs

+        // Dropping a `JoinSet` that was populated with `spawn_local`
+        // must abort all still-running tasks.


Suggested change

// Dropping a `JoinSet` that was populated with `spawn_local`

// must abort all still-running tasks.

/// Spawn several pending-forever tasks, and then drop the [`JoinSet`].

ADD-SP · 2025-10-08T13:11:46Z

tokio/tests/task_join_set.rs

+        // Drive a `LocalSet` on top of a `LocalRuntime` and verify that tasks
+        // queued with `JoinSet::spawn_local_on` run to completion only after
+        // the `LocalSet` starts.


Suggested change

// Drive a `LocalSet` on top of a `LocalRuntime` and verify that tasks

// queued with `JoinSet::spawn_local_on` run to completion only after

// the `LocalSet` starts.

/// Spawn several tasks, and then join all tasks.

ADD-SP · 2025-10-08T13:12:05Z

tokio/tests/task_join_set.rs

+        // JoinSet::spawn_local on a LocalSet.
+        // Tasks are queued with `spawn_local_on` **before** the `LocalSet` is
+        // running, then executed once the `LocalSet` is started.


Suggested change

// JoinSet::spawn_local on a LocalSet.

// Tasks are queued with `spawn_local_on` **before** the `LocalSet` is

// running, then executed once the `LocalSet` is started.

/// Spawn several tasks, and then join all tasks.

ADD-SP · 2025-10-08T13:13:02Z

tokio/tests/task_join_set.rs

+        // Calling `JoinSet::shutdown` on a set whose tasks were queued with
+        // `spawn_local_on` must abort all of them once the `LocalSet` is driven.


Suggested change

// Calling `JoinSet::shutdown` on a set whose tasks were queued with

// `spawn_local_on` must abort all of them once the `LocalSet` is driven.

/// Spawn several pending-forever tasks, and then shutdown the [`JoinSet`].

FrancescoV1985 added 2 commits September 11, 2025 10:48

Add new tests for JoinSet::spawn_local/JoinSet::spawn_local_on and Lo…

9b09c4f

…calRuntime. Fixes: tokio-rs#7562

ignore new test in rt_local for wasm target family

2a07d7f

ADD-SP added A-tokio-util Area: The tokio-util crate C-maintenance Category: PRs that clean code up or issues documenting cleanup. A-tokio Area: The main tokio crate M-task Module: tokio/task labels Sep 15, 2025

ADD-SP reviewed Sep 15, 2025

View reviewed changes

tokio/tests/rt_local.rs Show resolved Hide resolved

tokio/tests/task_join_set.rs Outdated Show resolved Hide resolved

tokio/tests/task_join_set.rs Outdated Show resolved Hide resolved

ADD-SP added the S-waiting-on-author Status: awaiting some action (such as code changes) from the PR or issue author. label Sep 15, 2025

updated rt_local.rs and task_join_set.rs according to review's comments

2a8deed

FrancescoV1985 added 2 commits September 26, 2025 10:29

add tests for JoinMap in task_join_map.rs

ebe940e

add missing configuration attribute in task_join_map.rs

12f4713

ADD-SP reviewed Sep 26, 2025

View reviewed changes

FrancescoV1985 added 2 commits September 26, 2025 16:58

add tests for TaskTracker in task_tracker.rs

13c211a

add tests for TaskTracker in task_tracker.rs

c69a37a

refactored new JoinSet tests to eliminate duplicated code

22511fe

ADD-SP reviewed Oct 7, 2025

View reviewed changes

FrancescoV1985 and others added 4 commits October 7, 2025 13:40

Merge branch 'tokio-rs:master' into issue-7562-fix

7556da8

refactored new JoinMap tests to eliminate duplicated code

de05b54

improved formatting for new JoinMap tests

288abdc

improved formatting (2) for new JoinMap tests

d9feec0

ADD-SP removed the S-waiting-on-author Status: awaiting some action (such as code changes) from the PR or issue author. label Oct 8, 2025

ADD-SP reviewed Oct 8, 2025

View reviewed changes

ADD-SP added the S-waiting-on-author Status: awaiting some action (such as code changes) from the PR or issue author. label Oct 8, 2025

FrancescoV1985 added 2 commits October 8, 2025 14:03

regrouped new tests for JoinSet and JoinMap thorugh 'mod'

cd21d97

fixed warning during compilation

c7cf4e1

ADD-SP reviewed Oct 8, 2025

View reviewed changes

	fn shutdown_spawn_local_local_runtime() {
	fn spawn_then_shutdown() {

	async fn spawn_local_running_localset() {
	async fn spawn_then_join_next() {

	async fn shutdown_spawn_local_localset() {
	async fn spawn_then_shutdown() {

		// Shutdown a `JoinSet` that was populated with `spawn_local`
		// must abort all still-running tasks.

	// Shutdown a `JoinSet` that was populated with `spawn_local`
	// must abort all still-running tasks.
	/// Spawn several pending-forever tasks, and then shutdown the [`JoinSet`].

		// Dropping a `JoinSet` that was populated with `spawn_local`
		// must abort all still-running tasks.

		// Calling `JoinSet::shutdown` on a set whose tasks were queued with
		// `spawn_local_on` must abort all of them once the `LocalSet` is driven.

Uh oh!

Add new tests for JoinSet, JoinMap, TaskTracer and LocalRuntime #7609

Are you sure you want to change the base?

Add new tests for JoinSet, JoinMap, TaskTracer and LocalRuntime #7609

Uh oh!

Conversation

FrancescoV1985 commented Sep 11, 2025

Motivation

Solution

Uh oh!

Uh oh!

Uh oh!

Uh oh!

ADD-SP commented Sep 25, 2025

Uh oh!

FrancescoV1985 commented Sep 25, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

ADD-SP left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

FrancescoV1985 commented Sep 26, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

ADD-SP left a comment

Choose a reason for hiding this comment

Uh oh!

ADD-SP Oct 8, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

ADD-SP left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

FrancescoV1985 commented Sep 25, 2025 •

edited

Loading

FrancescoV1985 commented Sep 26, 2025 •

edited

Loading

ADD-SP Oct 8, 2025 •

edited

Loading