Rollup merge of #154741 - Zalathar:unreachable-pub, r=jieyouxu

Enforce `#![warn(unreachable_pub)]` in compiletest source

The actual public API surface of compiletest is restricted to two specific modules, `cli` and `rustdoc_gui_test`.

Other items have no reason to be `pub`.

There should be no change to compiletest behaviour.

Author: matthiaskrgr

src/tools/compiletest/src/common.rs

@@ -13,16 +13,16 @@ mod tests;
 
 /// The value of an `aux-crate` directive.
 #[derive(Clone, Debug, Default, PartialEq, Eq)]
-pub struct AuxCrate {
+pub(crate) struct AuxCrate {
     /// Contains `--extern` modifiers, if any. See the tracking issue for more
     /// info: <https://github.com/rust-lang/rust/issues/98405>
     /// With `aux-crate: noprelude:foo=bar.rs` this will be `noprelude`.
-    pub extern_modifiers: Option<String>,
+    pub(crate) extern_modifiers: Option<String>,
     /// With `aux-crate: foo=bar.rs` this will be `foo`.
     /// With `aux-crate: noprelude:foo=bar.rs` this will be `foo`.
-    pub name: String,
+    pub(crate) name: String,
     /// With `aux-crate: foo=bar.rs` this will be `bar.rs`.
-    pub path: String,
+    pub(crate) path: String,
 }
 
 /// The value of a `proc-macro` directive.
@@ -31,9 +31,9 @@ pub(crate) struct ProcMacro {
     /// Contains `--extern` modifiers, if any. See the tracking issue for more
     /// info: <https://github.com/rust-lang/rust/issues/98405>
     /// With `proc-macro: noprelude:bar.rs` this will be `noprelude`.
-    pub extern_modifiers: Option<String>,
+    pub(crate) extern_modifiers: Option<String>,
     /// With `proc-macro: bar.rs` this will be `bar.rs`.
-    pub path: String,
+    pub(crate) path: String,
 }
 
 /// Properties parsed from `aux-*` test directives.

src/tools/compiletest/src/directives.rs

@@ -1,7 +1,7 @@
 use crate::fatal;
 
 #[derive(Debug, Copy, Clone, PartialEq, Eq, Hash, PartialOrd, Ord)]
-pub enum Edition {
+pub(crate) enum Edition {
     // Note that the ordering here is load-bearing, as we want the future edition to be greater than
     // any year-based edition.
     Year(u32),
@@ -23,7 +23,7 @@ impl From<u32> for Edition {
     }
 }
 
-pub fn parse_edition(mut input: &str) -> Edition {
+pub(crate) fn parse_edition(mut input: &str) -> Edition {
     input = input.trim();
     if input == "future" {
         Edition::Future

src/tools/compiletest/src/directives/auxiliary.rs

@@ -9,7 +9,7 @@ use regex::Regex;
 use tracing::*;
 
 #[derive(Copy, Clone, Debug, PartialEq, Eq, Hash)]
-pub enum ErrorKind {
+pub(crate) enum ErrorKind {
     Help,
     Error,
     Note,
@@ -21,7 +21,7 @@ pub enum ErrorKind {
 }
 
 impl ErrorKind {
-    pub fn from_compiler_str(s: &str) -> ErrorKind {
+    pub(crate) fn from_compiler_str(s: &str) -> ErrorKind {
         match s {
             "help" => ErrorKind::Help,
             "error" | "error: internal compiler error" => ErrorKind::Error,
@@ -45,7 +45,7 @@ impl ErrorKind {
         })
     }
 
-    pub fn expect_from_user_str(s: &str) -> ErrorKind {
+    pub(crate) fn expect_from_user_str(s: &str) -> ErrorKind {
         ErrorKind::from_user_str(s).unwrap_or_else(|| {
             panic!(
                 "unexpected diagnostic kind `{s}`, expected \
@@ -70,16 +70,16 @@ impl fmt::Display for ErrorKind {
 }
 
 #[derive(Debug)]
-pub struct Error {
-    pub line_num: Option<usize>,
-    pub column_num: Option<usize>,
+pub(crate) struct Error {
+    pub(crate) line_num: Option<usize>,
+    pub(crate) column_num: Option<usize>,
     /// What kind of message we expect (e.g., warning, error, suggestion).
-    pub kind: ErrorKind,
-    pub msg: String,
+    pub(crate) kind: ErrorKind,
+    pub(crate) msg: String,
     /// For some `Error`s, like secondary lines of multi-line diagnostics, line annotations
     /// are not mandatory, even if they would otherwise be mandatory for primary errors.
     /// Only makes sense for "actual" errors, not for "expected" errors.
-    pub require_annotation: bool,
+    pub(crate) require_annotation: bool,
 }
 
 /// Looks for either "//~| KIND MESSAGE" or "//~^^... KIND MESSAGE"
@@ -92,7 +92,7 @@ pub struct Error {
 ///
 /// If revision is not None, then we look
 /// for `//[X]~` instead, where `X` is the current revision.
-pub fn load_errors(testfile: &Utf8Path, revision: Option<&str>) -> Vec<Error> {
+pub(crate) fn load_errors(testfile: &Utf8Path, revision: Option<&str>) -> Vec<Error> {
     let rdr = BufReader::new(File::open(testfile.as_std_path()).unwrap());
 
     // `last_nonfollow_error` tracks the most recently seen

src/tools/compiletest/src/edition.rs

@@ -83,14 +83,14 @@ struct DiagnosticCode {
     code: String,
 }
 
-pub fn rustfix_diagnostics_only(output: &str) -> String {
+pub(crate) fn rustfix_diagnostics_only(output: &str) -> String {
     output
         .lines()
         .filter(|line| line.starts_with('{') && serde_json::from_str::<Diagnostic>(line).is_ok())
         .collect()
 }
 
-pub fn extract_rendered(output: &str) -> String {
+pub(crate) fn extract_rendered(output: &str) -> String {
     output
         .lines()
         .filter_map(|line| {
@@ -137,7 +137,7 @@ pub fn extract_rendered(output: &str) -> String {
         .collect()
 }
 
-pub fn parse_output(file_name: &str, output: &str) -> Vec<Error> {
+pub(crate) fn parse_output(file_name: &str, output: &str) -> Vec<Error> {
     let mut errors = Vec::new();
     for line in output.lines() {
         // Compiler can emit non-json lines in non-`--error-format=json` modes,

src/tools/compiletest/src/errors.rs

@@ -1,9 +1,13 @@
 #![crate_name = "compiletest"]
+#![warn(unreachable_pub)]
 
 #[cfg(test)]
 mod tests;
 
+// Public modules needed by the compiletest binary or by `rustdoc-gui-test`.
 pub mod cli;
+pub mod rustdoc_gui_test;
+
 mod common;
 mod debuggers;
 mod diagnostics;
@@ -17,7 +21,6 @@ mod panic_hook;
 mod raise_fd_limit;
 mod read2;
 mod runtest;
-pub mod rustdoc_gui_test;
 mod util;
 
 use core::panic;

src/tools/compiletest/src/json.rs

@@ -2,7 +2,7 @@ use std::fmt;
 use std::panic::RefUnwindSafe;
 use std::sync::Mutex;
 
-pub trait ConsoleOut: fmt::Debug + RefUnwindSafe {
+pub(crate) trait ConsoleOut: fmt::Debug + RefUnwindSafe {
     fn write_fmt(&self, args: fmt::Arguments<'_>);
 }
 

src/tools/compiletest/src/lib.rs

@@ -7,7 +7,7 @@
 #[cfg(target_vendor = "apple")]
 #[allow(non_camel_case_types)]
 // FIXME(#139616): document caller contract.
-pub unsafe fn raise_fd_limit() {
+pub(crate) unsafe fn raise_fd_limit() {
     use std::ptr::null_mut;
     use std::{cmp, io};
 
@@ -54,4 +54,4 @@ pub unsafe fn raise_fd_limit() {
 }
 
 #[cfg(not(target_vendor = "apple"))]
-pub unsafe fn raise_fd_limit() {}
+pub(crate) unsafe fn raise_fd_limit() {}

src/tools/compiletest/src/output_capture.rs

@@ -7,15 +7,15 @@ mod tests;
 use std::io::{self, Write};
 use std::process::{Child, Output};
 
-pub use self::imp::read2;
+use self::imp::read2;
 
 #[derive(Copy, Clone, Debug)]
-pub enum Truncated {
+pub(crate) enum Truncated {
     Yes,
     No,
 }
 
-pub fn read2_abbreviated(
+pub(crate) fn read2_abbreviated(
     mut child: Child,
     filter_paths_from_len: &[String],
 ) -> io::Result<(Output, Truncated)> {
@@ -138,7 +138,7 @@ mod imp {
     use std::io::{self, Read};
     use std::process::{ChildStderr, ChildStdout};
 
-    pub fn read2(
+    pub(crate) fn read2(
         out_pipe: ChildStdout,
         err_pipe: ChildStderr,
         data: &mut dyn FnMut(bool, &mut Vec<u8>, bool),
@@ -160,7 +160,7 @@ mod imp {
     use std::process::{ChildStderr, ChildStdout};
     use std::{io, mem};
 
-    pub fn read2(
+    pub(crate) fn read2(
         mut out_pipe: ChildStdout,
         mut err_pipe: ChildStderr,
         data: &mut dyn FnMut(bool, &mut Vec<u8>, bool),
@@ -247,7 +247,7 @@ mod imp {
         done: bool,
     }
 
-    pub fn read2(
+    pub(crate) fn read2(
         out_pipe: ChildStdout,
         err_pipe: ChildStderr,
         data: &mut dyn FnMut(bool, &mut Vec<u8>, bool),