Allow overwriting defaults for per-test comments

Demos this with `edition`

Author: oli-obk

CHANGELOG.md

@@ -10,6 +10,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ### Added
 
 * Started maintaining a changelog
+* `Config::comment_defaults` allows setting `//@` comments for all tests
 
 ### Fixed
 
@@ -20,5 +21,6 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ### Removed
 
 * `$DIR` and `RUSTLIB` replacements
+* `Config::edition` (replaced by `config.comment_defaults.base().edition`)
 
 ## [0.21.2] - 2023-09-27

Cargo.lock

@@ -1,6 +1,6 @@
 [package]
 name = "ui_test"
-version = "0.21.2"
+version = "0.22.0"
 edition = "2021"
 license = "MIT OR Apache-2.0"
 description = "A test framework for testing rustc diagnostics output"

Cargo.toml

@@ -1,6 +1,10 @@
 use regex::bytes::Regex;
+use spanned::Span;
 
-use crate::{dependencies::build_dependencies, CommandBuilder, Filter, Match, Mode, RustfixMode};
+use crate::{
+    dependencies::build_dependencies, per_test_config::Comments, CommandBuilder, Filter, Match,
+    Mode, RustfixMode,
+};
 pub use color_eyre;
 use color_eyre::eyre::Result;
 use std::{
@@ -45,8 +49,6 @@ pub struct Config {
     /// Where to dump files like the binaries compiled from tests.
     /// Defaults to `target/ui` in the current directory.
     pub out_dir: PathBuf,
-    /// The default edition to use on all tests.
-    pub edition: Option<String>,
     /// Skip test files whose names contain any of these entries.
     pub skip_files: Vec<String>,
     /// Only test files whose names contain any of these entries.
@@ -59,12 +61,19 @@ pub struct Config {
     pub run_only_ignored: bool,
     /// Filters must match exactly instead of just checking for substrings.
     pub filter_exact: bool,
+    /// The default settings settable via `@` comments
+    pub comment_defaults: Comments,
 }
 
 impl Config {
     /// Create a configuration for testing the output of running
     /// `rustc` on the test files.
     pub fn rustc(root_dir: impl Into<PathBuf>) -> Self {
+        let mut comment_defaults = Comments::default();
+        let _ = comment_defaults
+            .base()
+            .edition
+            .set("2021".into(), Span::default());
         Self {
             host: None,
             target: None,
@@ -96,13 +105,13 @@ impl Config {
                 .map(PathBuf::from)
                 .unwrap_or_else(|| std::env::current_dir().unwrap().join("target"))
                 .join("ui"),
-            edition: Some("2021".into()),
             skip_files: Vec::new(),
             filter_files: Vec::new(),
             threads: None,
             list: false,
             run_only_ignored: false,
             filter_exact: false,
+            comment_defaults,
         }
     }
 
@@ -111,7 +120,7 @@ impl Config {
     pub fn cargo(root_dir: impl Into<PathBuf>) -> Self {
         Self {
             program: CommandBuilder::cargo(),
-            edition: None,
+            comment_defaults: Default::default(),
             mode: Mode::Fail {
                 require_patterns: true,
                 rustfix: RustfixMode::Disabled,

src/config.rs

@@ -501,7 +501,7 @@ fn build_command(
     {
         cmd.arg(arg);
     }
-    let edition = comments.edition(revision, config)?;
+    let edition = comments.edition(revision, &config.comment_defaults)?;
 
     if let Some(edition) = edition {
         cmd.arg("--edition").arg(&*edition);
@@ -878,7 +878,7 @@ fn run_rustfix(
             stdout: stdout.into(),
         })?;
 
-    let edition = comments.edition(revision, config)?;
+    let edition = comments.edition(revision, &config.comment_defaults)?;
     let edition = edition
         .map(|mwl| {
             let line = mwl.span().unwrap_or_default();

src/lib.rs

@@ -21,7 +21,7 @@ mod tests;
 /// This crate supports various magic comments that get parsed as file-specific
 /// configuration values. This struct parses them all in one go and then they
 /// get processed by their respective use sites.
-#[derive(Default, Debug)]
+#[derive(Debug, Clone)]
 pub struct Comments {
     /// List of revision names to execute. Can only be specified once
     pub revisions: Option<Vec<String>>,
@@ -30,6 +30,17 @@ pub struct Comments {
     pub revisioned: HashMap<Vec<String>, Revisioned>,
 }
 
+impl Default for Comments {
+    fn default() -> Self {
+        let mut this = Self {
+            revisions: Default::default(),
+            revisioned: Default::default(),
+        };
+        this.revisioned.insert(vec![], Revisioned::default());
+        this
+    }
+}
+
 impl Comments {
     /// Check that a comment isn't specified twice across multiple differently revisioned statements.
     /// e.g. `//@[foo, bar] error-in-other-file: bop` and `//@[foo, baz] error-in-other-file boop` would end up
@@ -80,19 +91,26 @@ impl Comments {
     pub(crate) fn edition(
         &self,
         revision: &str,
-        config: &crate::Config,
+        default: &Self,
     ) -> Result<Option<MaybeSpanned<String>>, Errored> {
         let edition =
             self.find_one_for_revision(revision, "`edition` annotations", |r| r.edition.clone())?;
+        let default = default
+            .find_one_for_revision(revision, "`edition` annotations", |r| r.edition.clone())?;
         let edition = edition
             .into_inner()
-            .map(MaybeSpanned::from)
-            .or(config.edition.clone().map(MaybeSpanned::new_config));
+            .or(default.into_inner())
+            .map(MaybeSpanned::from);
         Ok(edition)
     }
+
+    /// The comments set for all revisions
+    pub fn base(&mut self) -> &mut Revisioned {
+        self.revisioned.get_mut(&[][..]).unwrap()
+    }
 }
 
-#[derive(Debug)]
+#[derive(Debug, Clone, Default)]
 /// Comments that can be filtered for specific revisions.
 pub struct Revisioned {
     /// The character range in which this revisioned item was first added.
@@ -158,7 +176,7 @@ impl<T> std::ops::DerefMut for CommentParser<T> {
 }
 
 /// The conditions used for "ignore" and "only" filters.
-#[derive(Debug)]
+#[derive(Debug, Clone)]
 pub enum Condition {
     /// The given string must appear in the host triple.
     Host(String),
@@ -177,7 +195,7 @@ pub enum Pattern {
     Regex(Regex),
 }
 
-#[derive(Debug)]
+#[derive(Debug, Clone)]
 pub(crate) struct ErrorMatch {
     pub pattern: Spanned<Pattern>,
     pub level: Level,

src/parser.rs

@@ -6,9 +6,7 @@ use ui_test::*;
 fn main() -> Result<()> {
     let path = Path::new(file!()).parent().unwrap();
     let root_dir = path.join("integrations");
-    let mut config = Config {
-        ..Config::cargo(root_dir.clone())
-    };
+    let mut config = Config::cargo(root_dir.clone());
     let args = Args::test()?;
     config.with_args(&args, true);