rustdoc source tests fail when remap-debuginfo is enabled

[jyn514]

Code

#![crate_name = "foo"]

// This test ensures that the [src] link is present on traits items.

//@ has foo/trait.Iterator.html '//*[@id="method.zip"]//a[@class="src"]' "Source"
pub use std::iter::Iterator;

Reproduction Steps

./x t --stage 1 tests/rustdoc/{source-code-pages/src-links-auto-impls.rs,ensure-src-link.rs}

Expected Outcome

Test should pass.

Actual Output

failures:

---- [rustdoc] tests/rustdoc/source-code-pages/src-links-auto-impls.rs stdout ----
------python3.13 stdout------------------------------

------python3.13 stderr------------------------------
9: has check failed
        `XPATH PATTERN` did not match
        //@ has - '//*[@id="impl-Any-for-T"]//a[@class="src rightside"]' 'Source'

Encountered 1 errors

---- [rustdoc] tests/rustdoc/ensure-src-link.rs stdout ----
------python3.13 stdout------------------------------

------python3.13 stderr------------------------------
5: has check failed
	`XPATH PATTERN` did not match
	//@ has foo/trait.Iterator.html '//*[@id="method.zip"]//a[@class="src"]' "Source"

Encountered 1 errors

Version

cec7008

Additional Details

bootstrap.toml:

profile = "compiler"
change-id = "ignore"

[build]
profiler = true
description = "by Ferrous Systems"

[llvm]
download-ci-llvm = true

[rust]
remap-debuginfo = true
channel = "beta"
lld = true
deny-warnings = false
debug-assertions = true
debug-assertions-std = true
new-symbol-mangling = true

[jyn514]

probably related to #149709, cc @Urgau

[jyn514]

it's a little concerning to me that rustdoc never gets tested with remap-debuginfo enabled ... to the best of my knowledge all distributed artifacts have it enabled :/

[Urgau]

We had a incident this past week about nightly std docs no longer having the "Source" link, #t-rustdoc > ✔ source links missing for nightly std docs, that seems related to the failure you're describing here.

It was fixed by #150172. Is the failure fixed if you apply that PR to your branch?

[jyn514]

it sure does, thank you!

it's still a little concerning to me that there's only a single test for remap-path-prefix, which as you've discovered is really quite fragile. i would love for CI to enable remap-debuginfo whenever it runs rustdoc tests.

[Urgau]

I agree, it's surprising that the rustdoc test suite in never run with remap-debuginfo.

@GuillaumeGomez any objection to running the rustdoc test suite in dist builder?

@Kobzol any idea what we need to do to run the rustdoc test suite in dist builder?

[Kobzol]

Do you want to use remap-debuginfo when running rustdoc tests, in general? Or run rustdoc tests with this option only in the x64 dist runner tests that run post PGO/BOLT optimizations?

[Urgau]

I would like for the rustdoc test suite to be run (at all) in a dist job.

As far as I can see the tests/rustdoc tests are not run in dist-x86_64-linux, see https://triage.rust-lang.org/gha-logs/rust-lang/rust/58726140992.

The rust.remap-debuginfo is automatically set for dist jobs.

rust/src/ci/run.sh

Line 119 in 04813e4

RUST_CONFIGURE_ARGS="$RUST_CONFIGURE_ARGS --set rust.remap-debuginfo"

[Kobzol]

I think I remember there were some issues with global dependencies that were required for the rustdoc tests were missing on the dist runners. But maybe that improved since the last time. I'll try it.