Auto merge of #148160 - Zalathar:paths, r=<try>

(DRAFT) compiletest: Split `TestPaths` into `RootTestPaths` and `TestOrAuxPaths`.

try-job: x86_64-msvc-1
try-job: i686-msvc-1
try-job: x86_64-mingw-1
try-job: test-various
try-job: armhf-gnu
try-job: aarch64-apple

Author: rust-bors[bot]

src/tools/compiletest/src/common.rs

@@ -1106,7 +1106,7 @@ fn query_rustc_output(config: &Config, args: &[&str], envs: HashMap<String, Stri
 
 /// Path information for a single test file.
 #[derive(Debug, Clone)]
-pub(crate) struct TestPaths {
+pub(crate) struct RootTestPaths {
     /// Full path to the test file.
     ///
     /// For example:
@@ -1131,9 +1131,28 @@ pub(crate) struct TestPaths {
     pub(crate) relative_dir: Utf8PathBuf,
 }
 
+impl RootTestPaths {
+    pub(crate) fn clone_to_test_or_aux_paths(&self) -> TestOrAuxPaths {
+        let Self { file, relative_dir } = self;
+        let file = file.clone();
+        let relative_dir = relative_dir.clone();
+        TestOrAuxPaths { file, relative_dir }
+    }
+}
+
+/// For unfortunate historical reasons, this contains either paths for a single
+/// test file, or paths for a single auxiliary source file.
+#[derive(Debug, Clone)]
+pub(crate) struct TestOrAuxPaths {
+    /// See `TestPaths::file`.
+    pub(crate) file: Utf8PathBuf,
+    /// See `TestPaths::relative_dir`.
+    pub(crate) relative_dir: Utf8PathBuf,
+}
+
 /// Used by `ui` tests to generate things like `foo.stderr` from `foo.rs`.
 pub fn expected_output_path(
-    testpaths: &TestPaths,
+    testpaths: &RootTestPaths,
     revision: Option<&str>,
     compare_mode: &Option<CompareMode>,
     kind: &str,
@@ -1195,7 +1214,7 @@ pub fn output_relative_path(config: &Config, relative_dir: &Utf8Path) -> Utf8Pat
 /// Generates a unique name for the test, such as `testname.revision.mode`.
 pub fn output_testname_unique(
     config: &Config,
-    testpaths: &TestPaths,
+    testpaths: &RootTestPaths,
     revision: Option<&str>,
 ) -> Utf8PathBuf {
     let mode = config.compare_mode.as_ref().map_or("", |m| m.to_str());
@@ -1212,7 +1231,7 @@ pub fn output_testname_unique(
 ///   /path/to/build/host-tuple/test/ui/relative/testname.revision.mode/
 pub fn output_base_dir(
     config: &Config,
-    testpaths: &TestPaths,
+    testpaths: &RootTestPaths,
     revision: Option<&str>,
 ) -> Utf8PathBuf {
     output_relative_path(config, &testpaths.relative_dir)
@@ -1224,7 +1243,7 @@ pub fn output_base_dir(
 ///   /path/to/build/host-tuple/test/ui/relative/testname.revision.mode/testname
 pub fn output_base_name(
     config: &Config,
-    testpaths: &TestPaths,
+    testpaths: &RootTestPaths,
     revision: Option<&str>,
 ) -> Utf8PathBuf {
     output_base_dir(config, testpaths, revision).join(testpaths.file.file_stem().unwrap())
@@ -1234,7 +1253,7 @@ pub fn output_base_name(
 ///   /path/to/build/host-tuple/test/ui/relative/testname.mode/testname.inc
 pub fn incremental_dir(
     config: &Config,
-    testpaths: &TestPaths,
+    testpaths: &RootTestPaths,
     revision: Option<&str>,
 ) -> Utf8PathBuf {
     output_base_name(config, testpaths, revision).with_extension("inc")

src/tools/compiletest/src/executor.rs

@@ -14,7 +14,7 @@ use std::{env, hint, mem, panic, thread};
 
 use camino::Utf8PathBuf;
 
-use crate::common::{Config, TestPaths};
+use crate::common::{Config, RootTestPaths};
 use crate::output_capture::{self, ConsoleOut};
 use crate::panic_hook;
 
@@ -125,7 +125,7 @@ struct TestThreadArgs {
     id: TestId,
 
     config: Arc<Config>,
-    testpaths: TestPaths,
+    testpaths: RootTestPaths,
     revision: Option<String>,
     should_fail: ShouldFail,
 
@@ -328,7 +328,7 @@ fn get_concurrency() -> usize {
 pub(crate) struct CollectedTest {
     pub(crate) desc: CollectedTestDesc,
     pub(crate) config: Arc<Config>,
-    pub(crate) testpaths: TestPaths,
+    pub(crate) testpaths: RootTestPaths,
     pub(crate) revision: Option<String>,
 }
 

src/tools/compiletest/src/lib.rs

@@ -38,8 +38,8 @@ use walkdir::WalkDir;
 
 use self::directives::{EarlyProps, make_test_description};
 use crate::common::{
-    CodegenBackend, CompareMode, Config, Debugger, PassMode, TestMode, TestPaths, UI_EXTENSIONS,
-    expected_output_path, output_base_dir, output_relative_path,
+    CodegenBackend, CompareMode, Config, Debugger, PassMode, RootTestPaths, TestMode,
+    UI_EXTENSIONS, expected_output_path, output_base_dir, output_relative_path,
 };
 use crate::directives::{AuxProps, DirectivesCache, FileDirectives};
 use crate::edition::parse_edition;
@@ -773,7 +773,7 @@ fn collect_tests_from_dir(
     if cx.config.mode == TestMode::RunMake {
         let mut collector = TestCollector::new();
         if dir.join("rmake.rs").exists() {
-            let paths = TestPaths {
+            let paths = RootTestPaths {
                 file: dir.to_path_buf(),
                 relative_dir: relative_dir_path.parent().unwrap().to_path_buf(),
             };
@@ -814,8 +814,10 @@ fn collect_tests_from_dir(
                 let rel_test_path = relative_dir_path.join(file_path.file_stem().unwrap());
                 collector.found_path_stems.insert(rel_test_path);
 
-                let paths =
-                    TestPaths { file: file_path, relative_dir: relative_dir_path.to_path_buf() };
+                let paths = RootTestPaths {
+                    file: file_path,
+                    relative_dir: relative_dir_path.to_path_buf(),
+                };
                 make_test(cx, &mut collector, &paths);
             } else if file_path.is_dir() {
                 // Recurse to find more tests in a subdirectory.
@@ -852,7 +854,7 @@ fn is_test(file_name: &str) -> bool {
 
 /// For a single test file, creates one or more test structures (one per revision) that can be
 /// handed over to the executor to run, possibly in parallel.
-fn make_test(cx: &TestCollectorCx, collector: &mut TestCollector, testpaths: &TestPaths) {
+fn make_test(cx: &TestCollectorCx, collector: &mut TestCollector, testpaths: &RootTestPaths) {
     // For run-make tests, each "test file" is actually a _directory_ containing an `rmake.rs`. But
     // for the purposes of directive parsing, we want to look at that recipe file, not the directory
     // itself.
@@ -929,7 +931,11 @@ fn make_test(cx: &TestCollectorCx, collector: &mut TestCollector, testpaths: &Te
 
 /// The path of the `stamp` file that gets created or updated whenever a
 /// particular test completes successfully.
-fn stamp_file_path(config: &Config, testpaths: &TestPaths, revision: Option<&str>) -> Utf8PathBuf {
+fn stamp_file_path(
+    config: &Config,
+    testpaths: &RootTestPaths,
+    revision: Option<&str>,
+) -> Utf8PathBuf {
     output_base_dir(config, testpaths, revision).join("stamp")
 }
 
@@ -939,7 +945,7 @@ fn stamp_file_path(config: &Config, testpaths: &TestPaths, revision: Option<&str
 /// (Might be inaccurate in some cases.)
 fn files_related_to_test(
     config: &Config,
-    testpaths: &TestPaths,
+    testpaths: &RootTestPaths,
     aux_props: &AuxProps,
     revision: Option<&str>,
 ) -> Vec<Utf8PathBuf> {
@@ -985,7 +991,7 @@ fn files_related_to_test(
 /// flag can be used to ignore up-to-date checking and always re-run tests.)
 fn is_up_to_date(
     cx: &TestCollectorCx,
-    testpaths: &TestPaths,
+    testpaths: &RootTestPaths,
     aux_props: &AuxProps,
     revision: Option<&str>,
 ) -> bool {
@@ -1061,7 +1067,7 @@ impl Stamp {
 /// Creates a name for this test/revision that can be handed over to the executor.
 fn make_test_name_and_filterable_path(
     config: &Config,
-    testpaths: &TestPaths,
+    testpaths: &RootTestPaths,
     revision: Option<&str>,
 ) -> (String, Utf8PathBuf) {
     // Print the name of the file, relative to the sources root.