Introduce and use specialized `//@ ignore-auxiliary` for test support files instead of using `//@ ignore-test` #139967

jieyouxu · 2025-04-17T11:04:46Z

Summary

Add a semantically meaningful directive for ignoring test auxiliary files. This is for auxiliary files that participate in actual tests but should not be built by compiletest (i.e. these files are involved through mod xxx; or include!() or #[path = "xxx"], etc.).

Motivation

A specialized directive like //@ ignore-auxiliary makes it way easier to audit disabled tests via //@ ignore-test.

These support files cannot use the canonical auxiliary/ dir because they participate in module resolution or are included, or their relative paths can be important for test intention otherwise.

Follow-up to:

Remarks on remaining unconditionally disabled tests under `tests/`

After this PR, against commit 79a272c, only 14 remaining test files are disabled through //@ ignore-test:

Remaining `//@ ignore-test` files under `tests/`

tests/debuginfo/drop-locations.rs
4://@ ignore-test (broken, see #128971)

tests/rustdoc/macro-document-private-duplicate.rs
1://@ ignore-test (fails spuriously, see issue #89228)

tests/rustdoc/inline_cross/assoc-const-equality.rs
3://@ ignore-test (FIXME: #125092)

tests/ui/match/issue-27021.rs
7://@ ignore-test (#54987)

tests/ui/match/issue-26996.rs
7://@ ignore-test (#54987)

tests/ui/issues/issue-49298.rs
9://@ ignore-test (#54987)

tests/ui/issues/issue-59756.rs
2://@ ignore-test (rustfix needs multiple suggestions)

tests/ui/precondition-checks/write.rs
5://@ ignore-test (unimplemented)

tests/ui/precondition-checks/read.rs
5://@ ignore-test (unimplemented)

tests/ui/precondition-checks/write_bytes.rs
5://@ ignore-test (unimplemented)

tests/ui/explicit-tail-calls/drop-order.rs
2://@ ignore-test: tail calls are not implemented in rustc_codegen_ssa yet, so this causes 🧊

tests/ui/panics/panic-short-backtrace-windows-x86_64.rs
3://@ ignore-test (#92000)

tests/ui/json/json-bom-plus-crlf-multifile-aux.rs
3://@ ignore-test Not a test. Used by other tests

tests/ui/traits/next-solver/object-soundness-requires-generalization.rs
2://@ ignore-test (see #114196)

Of these, most are either unimplemented, or spurious, or known-broken. The outstanding one is tests/ui/json/json-bom-plus-crlf-multifile-aux.rs which I did not want to touch in this PR -- that aux file has load-bearing BOM and carriage returns and byte offset matters. I think those test files that require special encoding / BOM probably are better off as run-make tests. See #139968 for that aux file.

Review advice

Best reviewed commit-by-commit.
The directive name diverged from the most voted //@ auxiliary because I think that's easy to confuse with //@ aux-{crate,dir}.

r? compiler

This is for files that *participate* in actual tests but should not be built by `compiletest` (i.e. these files are involved through `mod xxx;` or `include!()` or `#[path = "xxx"]`, etc.). A specialized directive like `//@ ignore-auxiliary` makes it way easier to audit disabled tests via `//@ ignore-test`.

rustbot · 2025-04-17T11:04:55Z

The rustc-dev-guide subtree was changed. If this PR only touches the dev guide consider submitting a PR directly to rust-lang/rustc-dev-guide otherwise thank you for updating the dev guide with your changes.

cc @BoxyUwU, @jieyouxu, @Kobzol

jieyouxu · 2025-04-17T11:11:43Z

Rolling another compiler reviewer as lcnr got tripple-rolled.
r? compiler

jieyouxu · 2025-04-17T11:41:35Z

@rustbot author

rustbot · 2025-04-17T11:41:40Z

Reminder, once the PR becomes ready for a review, use @rustbot ready.

jieyouxu · 2025-04-17T13:31:32Z

@rustbot ready

jieyouxu · 2025-04-17T13:34:28Z

tests/ui/macros/auxiliary/macro-include-items-expr.rs

Remark: This directory already has compiletest-ignore-dir, so this aux file and tests/ui/macros/auxiliary/macro-include-items-item.rs has // ignore-test (note the lack of @) which are redundant and never ported during the // -> //@ migration.

jieyouxu · 2025-04-17T13:35:35Z

tests/ui/missing_non_modrs_mod/foo.rs

@@ -1,4 +1,3 @@
-//


Remark: removing this extra // caused a .stderr line number shift in tests/ui/missing_non_modrs_mod/missing_non_modrs_mod.stderr.

jieyouxu · 2025-04-17T13:36:01Z

tests/ui/modules/mod_file_aux.rs

@@ -1,4 +1,3 @@
-//@ run-pass


Remark: useless/misleading //@ run-pass in a few aux files that are //@ ignore-test (//@ ignore-auxiliary)

jieyouxu · 2025-04-17T13:37:27Z

tests/ui/directory_ownership/mod_file_not_owning_aux1.rs

Remark: I believe there used to be a test that used these, but somehow that test either got changed, moved or removed, and now these aux files are no longer used. I couldn't find the cause of this through git blame.

These seem to be the commits:

7f6b608

7b420cf

I found these by doing git log -- **/aux_file_name.rs to find the commit which introduced the file and associated test and then I repeated the same thing again with the actual test name to find the commit where it was removed.

jieyouxu · 2025-04-17T15:02:53Z

tests/debuginfo/drop-locations.rs

-//@ ignore-test: #128971
+
+// FIXME: stepping with "next" in a debugger skips past end-of-scope drops
+//@ ignore-test (broken, see #128971)


Remark: drive-by comment

wesleywiser · 2025-04-17T18:09:05Z

tests/ui/directory_ownership/mod_file_not_owning_aux1.rs

These seem to be the commits:

7f6b608

7b420cf

I found these by doing git log -- **/aux_file_name.rs to find the commit which introduced the file and associated test and then I repeated the same thing again with the actual test name to find the commit where it was removed.

wesleywiser · 2025-04-17T18:11:09Z

Thanks @jieyouxu!

@bors r+ rollup

bors · 2025-04-17T18:11:12Z

📌 Commit 6c5a481 has been approved by wesleywiser

It is now in the queue for this repository.

…iaskrgr Rollup of 8 pull requests Successful merges: - rust-lang#139351 (Autodiff batching2) - rust-lang#139483 (f*::NAN: guarantee that this is a quiet NaN) - rust-lang#139498 (Ignore zero-sized types in wasm future-compat warning) - rust-lang#139967 (Introduce and use specialized `//@ ignore-auxiliary` for test support files instead of using `//@ ignore-test`) - rust-lang#139969 (update libc) - rust-lang#139971 (Make C string merging test work on MIPS) - rust-lang#139974 (Change `InterpCx::instantiate*` function visibility to pub) - rust-lang#139977 (Fix drop handling in `hint::select_unpredictable`) r? `@ghost` `@rustbot` modify labels: rollup

Rollup merge of rust-lang#139967 - jieyouxu:auxiliary, r=wesleywiser Introduce and use specialized `//@ ignore-auxiliary` for test support files instead of using `//@ ignore-test` ### Summary Add a semantically meaningful directive for ignoring test *auxiliary* files. This is for auxiliary files that *participate* in actual tests but should not be built by `compiletest` (i.e. these files are involved through `mod xxx;` or `include!()` or `#[path = "xxx"]`, etc.). ### Motivation A specialized directive like `//@ ignore-auxiliary` makes it way easier to audit disabled tests via `//@ ignore-test`. - These support files cannot use the canonical `auxiliary/` dir because they participate in module resolution or are included, or their relative paths can be important for test intention otherwise. Follow-up to: - rust-lang#139705 - rust-lang#139783 - rust-lang#139740 See also discussions in: - [#t-compiler > Directive name for non-test aux files?](https://rust-lang.zulipchat.com/#narrow/channel/131828-t-compiler/topic/Directive.20name.20for.20non-test.20aux.20files.3F/with/512773817) - [#t-compiler > Handling disabled &rust-lang#96;//@ ignore-test&rust-lang#96; tests](https://rust-lang.zulipchat.com/#narrow/channel/131828-t-compiler/topic/Handling.20disabled.20.60.2F.2F.40.20ignore-test.60.20tests/with/512005974) - [#t-compiler/meetings > &rust-lang#91;steering&rust-lang#93; 2025-04-11 Dealing with disabled tests](https://rust-lang.zulipchat.com/#narrow/channel/238009-t-compiler.2Fmeetings/topic/.5Bsteering.5D.202025-04-11.20Dealing.20with.20disabled.20tests/with/511717981) ### Remarks on remaining unconditionally disabled tests under `tests/` After this PR, against commit 79a272c, only **14** remaining test files are disabled through `//@ ignore-test`: <details> <summary>Remaining `//@ ignore-test` files under `tests/`</summary> ``` tests/debuginfo/drop-locations.rs 4://@ ignore-test (broken, see rust-lang#128971) tests/rustdoc/macro-document-private-duplicate.rs 1://@ ignore-test (fails spuriously, see issue rust-lang#89228) tests/rustdoc/inline_cross/assoc-const-equality.rs 3://@ ignore-test (FIXME: rust-lang#125092) tests/ui/match/issue-27021.rs 7://@ ignore-test (rust-lang#54987) tests/ui/match/issue-26996.rs 7://@ ignore-test (rust-lang#54987) tests/ui/issues/issue-49298.rs 9://@ ignore-test (rust-lang#54987) tests/ui/issues/issue-59756.rs 2://@ ignore-test (rustfix needs multiple suggestions) tests/ui/precondition-checks/write.rs 5://@ ignore-test (unimplemented) tests/ui/precondition-checks/read.rs 5://@ ignore-test (unimplemented) tests/ui/precondition-checks/write_bytes.rs 5://@ ignore-test (unimplemented) tests/ui/explicit-tail-calls/drop-order.rs 2://@ ignore-test: tail calls are not implemented in rustc_codegen_ssa yet, so this causes 🧊 tests/ui/panics/panic-short-backtrace-windows-x86_64.rs 3://@ ignore-test (rust-lang#92000) tests/ui/json/json-bom-plus-crlf-multifile-aux.rs 3://@ ignore-test Not a test. Used by other tests tests/ui/traits/next-solver/object-soundness-requires-generalization.rs 2://@ ignore-test (see rust-lang#114196) ``` </details> Of these, most are either **unimplemented**, or **spurious**, or **known-broken**. The outstanding one is `tests/ui/json/json-bom-plus-crlf-multifile-aux.rs` which I did not want to touch in *this* PR -- that aux file has load-bearing BOM and carriage returns and byte offset matters. I think those test files that require special encoding / BOM probably are better off as `run-make` tests. See rust-lang#139968 for that aux file. ### Review advice - Best reviewed commit-by-commit. - The directive name diverged from the most voted `//@ auxiliary` because I think that's easy to confuse with `//@ aux-{crate,dir}`. r? compiler

jieyouxu added 3 commits April 17, 2025 18:52

tests: refine disable reason for tests/debuginfo/drop-locations.rs

d1178fa

rustc-dev-guide: document //@ ignore-auxiliary

6bbee33

rustbot assigned lcnr Apr 17, 2025

rustbot assigned wesleywiser and unassigned lcnr Apr 17, 2025

jieyouxu mentioned this pull request Apr 17, 2025

Consider converting tests/ui/json/json-bom-plus-crlf-multifile-aux.rs-associated tests into a run-make tests #139968

Open

This comment has been minimized.

Sign in to view

rustbot added S-waiting-on-author Status: This is awaiting some action (such as code changes or more information) from the author. and removed S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. labels Apr 17, 2025

jieyouxu added 2 commits April 17, 2025 19:45

tests: use //@ ignore-auxiliary with backlinked primary test file

89cac55

tests: remove unused auxiliaries under tests/ui/directory_ownership/

6c5a481

jieyouxu force-pushed the auxiliary branch from 4cfc996 to 6c5a481 Compare April 17, 2025 11:45

jieyouxu closed this Apr 17, 2025

jieyouxu reopened this Apr 17, 2025

rustbot added S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. and removed S-waiting-on-author Status: This is awaiting some action (such as code changes or more information) from the author. labels Apr 17, 2025

jieyouxu commented Apr 17, 2025

View reviewed changes

jieyouxu mentioned this pull request Apr 17, 2025

compiletest: consider rejecting conditional test execution directives being used together with unconditional test disabling directives #139970

Open

jieyouxu commented Apr 17, 2025

View reviewed changes

wesleywiser approved these changes Apr 17, 2025

View reviewed changes

bors added S-waiting-on-bors Status: Waiting on bors to run and complete tests. Bors will change the label on completion. and removed S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. labels Apr 17, 2025

matthiaskrgr mentioned this pull request Apr 17, 2025

Rollup of 8 pull requests #139992

Merged

bors merged commit 026d56b into rust-lang:master Apr 18, 2025
6 checks passed

rustbot added this to the 1.88.0 milestone Apr 18, 2025

jieyouxu deleted the auxiliary branch April 18, 2025 04:40

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Introduce and use specialized `//@ ignore-auxiliary` for test support files instead of using `//@ ignore-test` #139967

Introduce and use specialized `//@ ignore-auxiliary` for test support files instead of using `//@ ignore-test` #139967

jieyouxu commented Apr 17, 2025 •

edited

Loading

rustbot commented Apr 17, 2025

jieyouxu commented Apr 17, 2025

This comment has been minimized.

jieyouxu commented Apr 17, 2025

rustbot commented Apr 17, 2025

jieyouxu commented Apr 17, 2025

jieyouxu Apr 17, 2025

jieyouxu Apr 17, 2025 •

edited

Loading

jieyouxu Apr 17, 2025

jieyouxu Apr 17, 2025 •

edited

Loading

wesleywiser Apr 17, 2025 •

edited

Loading

jieyouxu Apr 17, 2025

wesleywiser Apr 17, 2025 •

edited

Loading

wesleywiser commented Apr 17, 2025

bors commented Apr 17, 2025

Introduce and use specialized //@ ignore-auxiliary for test support files instead of using //@ ignore-test #139967

Introduce and use specialized //@ ignore-auxiliary for test support files instead of using //@ ignore-test #139967

Conversation

jieyouxu commented Apr 17, 2025 • edited Loading

Summary

Motivation

Remarks on remaining unconditionally disabled tests under tests/

Review advice

rustbot commented Apr 17, 2025

jieyouxu commented Apr 17, 2025

This comment has been minimized.

jieyouxu commented Apr 17, 2025

rustbot commented Apr 17, 2025

jieyouxu commented Apr 17, 2025

jieyouxu Apr 17, 2025

Choose a reason for hiding this comment

jieyouxu Apr 17, 2025 • edited Loading

Choose a reason for hiding this comment

jieyouxu Apr 17, 2025

Choose a reason for hiding this comment

jieyouxu Apr 17, 2025 • edited Loading

Choose a reason for hiding this comment

wesleywiser Apr 17, 2025 • edited Loading

Choose a reason for hiding this comment

jieyouxu Apr 17, 2025

Choose a reason for hiding this comment

wesleywiser Apr 17, 2025 • edited Loading

Choose a reason for hiding this comment

wesleywiser commented Apr 17, 2025

bors commented Apr 17, 2025

Introduce and use specialized `//@ ignore-auxiliary` for test support files instead of using `//@ ignore-test` #139967

Introduce and use specialized `//@ ignore-auxiliary` for test support files instead of using `//@ ignore-test` #139967

jieyouxu commented Apr 17, 2025 •

edited

Loading

Remarks on remaining unconditionally disabled tests under `tests/`

jieyouxu Apr 17, 2025 •

edited

Loading

jieyouxu Apr 17, 2025 •

edited

Loading

wesleywiser Apr 17, 2025 •

edited

Loading

wesleywiser Apr 17, 2025 •

edited

Loading