working on compiletest, fixing document testpaths bug

Author: EtomicBomb

src/tools/compiletest/src/command-list.rs

@@ -9,6 +9,7 @@ const KNOWN_DIRECTIVE_NAMES: &[&str] = &[
     "aux-codegen-backend",
     "aux-crate",
     "build-aux-docs",
+    "unique-doc-aux-dir",
     "build-fail",
     "build-pass",
     "check-fail",
@@ -18,6 +19,7 @@ const KNOWN_DIRECTIVE_NAMES: &[&str] = &[
     "check-test-line-numbers-match",
     "compare-output-lines-by-subset",
     "compile-flags",
+    "doc-flags",
     "dont-check-compiler-stderr",
     "dont-check-compiler-stdout",
     "dont-check-failure-status",

src/tools/compiletest/src/common.rs

@@ -187,10 +187,6 @@ pub struct Config {
     /// The rustdoc executable.
     pub rustdoc_path: Option<PathBuf>,
 
-    /// for rustdoc: whether to write intermediate cross-crate information to crate root
-    /// for auxiliary crates
-    pub aux_write_doc_cci: bool,
-
     /// The coverage-dump executable.
     pub coverage_dump_path: Option<PathBuf>,
 

src/tools/compiletest/src/header.rs

@@ -96,6 +96,8 @@ pub struct TestProps {
     pub compile_flags: Vec<String>,
     // Extra flags to pass when the compiled code is run (such as --bench)
     pub run_flags: Vec<String>,
+    /// Extra flags to pass to rustdoc but not the compiler.
+    pub doc_flags: Vec<String>,
     // If present, the name of a file that this test should match when
     // pretty-printed
     pub pp_exact: Option<PathBuf>,
@@ -123,6 +125,8 @@ pub struct TestProps {
     pub unset_exec_env: Vec<String>,
     // Build documentation for all specified aux-builds as well
     pub build_aux_docs: bool,
+    // Build the documentation for each crate in a unique output directory
+    pub unique_doc_aux_dir: bool,
     // Flag to force a crate to be built with the host architecture
     pub force_host: bool,
     // Check stdout for error-pattern output as well as stderr
@@ -221,8 +225,10 @@ mod directives {
     pub const REGEX_ERROR_PATTERN: &'static str = "regex-error-pattern";
     pub const COMPILE_FLAGS: &'static str = "compile-flags";
     pub const RUN_FLAGS: &'static str = "run-flags";
+    pub const DOC_FLAGS: &'static str = "doc-flags";
     pub const SHOULD_ICE: &'static str = "should-ice";
     pub const BUILD_AUX_DOCS: &'static str = "build-aux-docs";
+    pub const UNIQUE_DOC_OUT_DIR: &'static str = "unique-doc-aux-dir";
     pub const FORCE_HOST: &'static str = "force-host";
     pub const CHECK_STDOUT: &'static str = "check-stdout";
     pub const CHECK_RUN_RESULTS: &'static str = "check-run-results";
@@ -268,6 +274,7 @@ impl TestProps {
             regex_error_patterns: vec![],
             compile_flags: vec![],
             run_flags: vec![],
+            doc_flags: vec![],
             pp_exact: None,
             aux_builds: vec![],
             aux_bins: vec![],
@@ -282,6 +289,7 @@ impl TestProps {
             exec_env: vec![],
             unset_exec_env: vec![],
             build_aux_docs: false,
+            unique_doc_aux_dir: false,
             force_host: false,
             check_stdout: false,
             check_run_results: false,
@@ -378,6 +386,13 @@ impl TestProps {
                         |r| r,
                     );
 
+                    config.push_name_value_directive(
+                        ln,
+                        DOC_FLAGS,
+                        &mut self.doc_flags,
+                        |r| r,
+                    );
+
                     fn split_flags(flags: &str) -> Vec<String> {
                         // Individual flags can be single-quoted to preserve spaces; see
                         // <https://github.com/rust-lang/rust/pull/115948/commits/957c5db6>.
@@ -415,6 +430,8 @@ impl TestProps {
 
                     config.set_name_directive(ln, SHOULD_ICE, &mut self.should_ice);
                     config.set_name_directive(ln, BUILD_AUX_DOCS, &mut self.build_aux_docs);
+                    config.set_name_directive(ln, UNIQUE_DOC_OUT_DIR, &mut self.unique_doc_aux_dir);
+
                     config.set_name_directive(ln, FORCE_HOST, &mut self.force_host);
                     config.set_name_directive(ln, CHECK_STDOUT, &mut self.check_stdout);
                     config.set_name_directive(ln, CHECK_RUN_RESULTS, &mut self.check_run_results);

src/tools/compiletest/src/lib.rs

@@ -81,7 +81,6 @@ pub fn parse_config(args: Vec<String>) -> Config {
         .optopt("", "run", "whether to execute run-* tests", "auto | always | never")
         .optflag("", "ignored", "run tests marked as ignored")
         .optflag("", "with-debug-assertions", "whether to run tests with `ignore-debug` header")
-        .optflag("", "aux-write-doc-cci", "whether to write cci for auxiliary crates")
         .optmulti(
             "",
             "skip",
@@ -250,7 +249,6 @@ pub fn parse_config(args: Vec<String>) -> Config {
         debugger: None,
         run_ignored,
         with_debug_assertions,
-        aux_write_doc_cci: matches.opt_present("aux-write-doc-cci"),
         filters: matches.free.clone(),
         skip: matches.opt_strs("skip"),
         filter_exact: matches.opt_present("exact"),

src/tools/compiletest/src/runtest.rs

@@ -1595,20 +1595,10 @@ impl<'test> TestCx<'test> {
     }
 
     /// aux: whether we are building the aux docs or main docs
-    fn document(&self, out_dir: &Path, info_json: Option<&Path>) -> ProcRes {
-        /// Path to give to --include-info-json and --write-info-json
-        fn info_path(cx: &TestCx<'_>, rel_ab: &str) -> PathBuf {
-            cx.output_base_dir().parent().unwrap().parent().unwrap()
-                .join("doc.parts")
-                .join(rel_ab.trim_end_matches(".rs").replace("-", "_"))
-                .join("crate-info.json")
-        }
-
-        let mut include_flags = Vec::default();
-
+    fn document(&self, out_dir: &Path) -> ProcRes {
         if self.props.build_aux_docs {
             for rel_ab in &self.props.aux_builds {
-                let aux_testpaths = self.compute_aux_test_paths(&self.testpaths, rel_ab);
+                let aux_testpaths = self.compute_aux_test_paths(dbg!(&self.testpaths), dbg!(rel_ab));
                 let aux_props =
                     self.props.from_aux_file(&aux_testpaths.file, self.revision, self.config);
                 let aux_cx = TestCx {
@@ -1617,11 +1607,14 @@ impl<'test> TestCx<'test> {
                     testpaths: &aux_testpaths,
                     revision: self.revision,
                 };
-                let info_json = info_path(&aux_cx, rel_ab);
-                include_flags.push(format!("--include-info-json={}", info_json.display()));
                 // Create the directory for the stdout/stderr files.
                 create_dir_all(aux_cx.output_base_dir()).unwrap();
-                let auxres = aux_cx.document(out_dir, Some(&info_json));
+                let out_dir = if aux_props.unique_doc_aux_dir {
+                    out_dir.join("docs").join(rel_ab.trim_end_matches(".rs")).join("doc")
+                } else {
+                    out_dir.to_owned()
+                };
+                let auxres = aux_cx.document(&out_dir);
                 if !auxres.status.success() {
                     return auxres;
                 }
@@ -1645,24 +1638,8 @@ impl<'test> TestCx<'test> {
             .arg(&self.testpaths.file)
             .arg("-A")
             .arg("internal_features")
-            .args(&self.props.compile_flags);
-
-        if self.config.aux_write_doc_cci {
-            match info_json {
-                Some(info_json) => {
-                    rustdoc
-                        .arg("-Zunstable-options")
-                        .arg("--merge=none")
-                        .arg(format!("--write-info-json={}", info_json.display()));
-                }
-                None => {
-                    rustdoc
-                        .arg("-Zunstable-options")
-                        .arg("--merge=write-only")
-                        .args(&include_flags);
-                }
-            }
-        }
+            .args(&self.props.compile_flags)
+            .args(&self.props.doc_flags);
 
         if self.config.mode == RustdocJson {
             rustdoc.arg("--output-format").arg("json").arg("-Zunstable-options");
@@ -1788,6 +1765,7 @@ impl<'test> TestCx<'test> {
     fn compute_aux_test_paths(&self, of: &TestPaths, rel_ab: &str) -> TestPaths {
         let test_ab =
             of.file.parent().expect("test file path has no parent").join("auxiliary").join(rel_ab);
+        dbg!(&of, rel_ab, &test_ab);
         if !test_ab.exists() {
             self.fatal(&format!("aux-build `{}` source not found", test_ab.display()))
         }
@@ -1892,7 +1870,7 @@ impl<'test> TestCx<'test> {
         aux_dir: &Path,
         is_bin: bool,
     ) -> AuxType {
-        let aux_testpaths = self.compute_aux_test_paths(of, source_path);
+        let aux_testpaths = self.compute_aux_test_paths(dbg!(of), dbg!(source_path));
         let aux_props = self.props.from_aux_file(&aux_testpaths.file, self.revision, self.config);
         let mut aux_dir = aux_dir.to_path_buf();
         if is_bin {
@@ -2706,7 +2684,7 @@ impl<'test> TestCx<'test> {
         let out_dir = self.output_base_dir();
         remove_and_create_dir_all(&out_dir);
 
-        let proc_res = self.document(&out_dir, None);
+        let proc_res = self.document(&out_dir);
         if !proc_res.status.success() {
             self.fatal_proc_rec("rustdoc failed!", &proc_res);
         }
@@ -2765,7 +2743,7 @@ impl<'test> TestCx<'test> {
         let aux_dir = new_rustdoc.aux_output_dir();
         new_rustdoc.build_all_auxiliary(&new_rustdoc.testpaths, &aux_dir, &mut rustc);
 
-        let proc_res = new_rustdoc.document(&compare_dir, None);
+        let proc_res = new_rustdoc.document(&compare_dir);
         if !proc_res.status.success() {
             eprintln!("failed to run nightly rustdoc");
             return;
@@ -2888,7 +2866,7 @@ impl<'test> TestCx<'test> {
         let out_dir = self.output_base_dir();
         remove_and_create_dir_all(&out_dir);
 
-        let proc_res = self.document(&out_dir, None);
+        let proc_res = self.document(&out_dir);
         if !proc_res.status.success() {
             self.fatal_proc_rec("rustdoc failed!", &proc_res);
         }
@@ -3818,7 +3796,7 @@ impl<'test> TestCx<'test> {
         if let Some(nodejs) = &self.config.nodejs {
             let out_dir = self.output_base_dir();
 
-            self.document(&out_dir, None);
+            self.document(&out_dir);
 
             let root = self.config.find_rust_src_root().unwrap();
             let file_stem =