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.

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

Use ::core qualified imports instead of ::std inside tokio::test macro #5973

Merged
merged 1 commit into from
Sep 1, 2023

Conversation

complexspaces
Copy link
Contributor

Motivation

At work, we have a crate in our monorepo which is #![no_std] for build size reasons. However, we use tokio to test that its async functionality is functional in CI for simplicity and leave the other executor for the "real" usage of the library.

In a recent tokio update, we started to see this error when compiling its tests:

error[E0433]: failed to resolve: could not find `std` in the list of imported crates
   --> crypto/crate-name/src/lib.rs:556:5
    |
556 |     #[tokio::test]
    |     ^^^^^^^^^^^^^^ could not find `std` in the list of imported crates
    |
    = note: this error originates in the attribute macro `tokio::test` (in Nightly builds, run with -Z macro-backtrace for more info)

I was not immediately able to find which commit caused this, but you can observe the cause here:

quote! {
let body = async #body;
#crate_path::pin!(body);
let body: ::std::pin::Pin<&mut dyn ::std::future::Future<Output = #output_type>> = body;
}

You can reproduce the issue with this project:
[package]
name = "reproducer"
version = "0.1.0"
edition = "2021"

[dev-dependencies]
tokio = { version = "1", features = ["rt", "macros"] }
#![no_std]

async fn future_to_test() -> i32 {
    1
}

#[cfg(test)]
mod tests {
    use super::*;

    #[tokio::test]
    async fn test_future() {
        assert_eq!(future_to_test().await, 1);
    }
}

Solution

Given that that std::future and std::pin are re-exports of their core equivalents, I propose to qualify these imports inside the tokio::test macro with ::core instead of ::std for better compatibility. AFAIK this should not have any negative impacts for other users.

By making this change, a #![no_std] crate can continue to smoothly use tokio as a dev-dependency without any workarounds needed in the rest of the crate.

Copy link
Member

@taiki-e taiki-e left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks!

@taiki-e taiki-e merged commit 8b312ee into tokio-rs:master Sep 1, 2023
@taiki-e taiki-e added the A-tokio-macros Area: The tokio-macros crate label Sep 1, 2023
@complexspaces complexspaces deleted the no-std-test-compat branch September 2, 2023 08:43
Darksonn added a commit that referenced this pull request Oct 14, 2023
Darksonn added a commit that referenced this pull request Oct 14, 2023
kodiakhq bot pushed a commit to pdylanross/fatigue that referenced this pull request Nov 10, 2023
Bumps tokio from 1.33.0 to 1.34.0.

Release notes
Sourced from tokio's releases.

Tokio v1.34.0
Fixed

io: allow clear_readiness after io driver shutdown (#6067)
io: fix integer overflow in take (#6080)
io: fix I/O resource hang (#6134)
sync: fix broadcast::channel link (#6100)

Changed

macros: use ::core qualified imports instead of ::std inside tokio::test macro (#5973)

Added

fs: update cfg attr in fs::read_dir to include aix (#6075)
sync: add mpsc::Receiver::recv_many (#6010)
tokio: added vita target support (#6094)

#5973: tokio-rs/tokio#5973
#6067: tokio-rs/tokio#6067
#6080: tokio-rs/tokio#6080
#6134: tokio-rs/tokio#6134
#6100: tokio-rs/tokio#6100
#6075: tokio-rs/tokio#6075
#6010: tokio-rs/tokio#6010
#6094: tokio-rs/tokio#6094



Commits

49eb26f chore: prepare Tokio v1.34.0 release (#6138)
19d96c0 io: increase ScheduledIo tick resolution (#6135)
30b2eb1 io: fix possible I/O resource hang (#6134)
8ec3e0d metrics: update stats when unparking in multi-thread (#6131)
161ecec stream: fix typo in peekable docs (#6130)
61fcc3b time: remove cached elapsed value from driver state (#6097)
944024e chore: update rust-version to 1.63 in all crates (#6126)
65f861f stream: add StreamExt::peekable (#6095)
4c85801 ci: fix docs on latest nightly (#6120)
ed32cd1 task: add tests for tracing instrumentation of tasks (#6112)
Additional commits viewable in compare view




Dependabot will resolve any conflicts with this PR as long as you don't alter it yourself. You can also trigger a rebase manually by commenting @dependabot rebase.


Dependabot commands and options

You can trigger Dependabot actions by commenting on this PR:

@dependabot rebase will rebase this PR
@dependabot recreate will recreate this PR, overwriting any edits that have been made to it
@dependabot merge will merge this PR after your CI passes on it
@dependabot squash and merge will squash and merge this PR after your CI passes on it
@dependabot cancel merge will cancel a previously requested merge and block automerging
@dependabot reopen will reopen this PR if it is closed
@dependabot close will close this PR and stop Dependabot recreating it. You can achieve the same result by closing it manually
@dependabot show <dependency name> ignore conditions will show all of the ignore conditions of the specified dependency
@dependabot ignore this major version will close this PR and stop Dependabot creating any more for this major version (unless you reopen the PR or upgrade to it yourself)
@dependabot ignore this minor version will close this PR and stop Dependabot creating any more for this minor version (unless you reopen the PR or upgrade to it yourself)
@dependabot ignore this dependency will close this PR and stop Dependabot creating any more for this dependency (unless you reopen the PR or upgrade to it yourself)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
A-tokio-macros Area: The tokio-macros crate
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants