refactor: add redact for line numbers

Author: peter-jerry-ye

Cargo.lock

@@ -105,7 +105,7 @@ ariadne = { version = "0.5.1", features = ["auto-color"] }
 clap_complete = { version = "4.5.4" }
 schemars = "0.8"
 nucleo-matcher = "0.3.1"
-regex = { version = "1.10.3", default-features = false, features = ["std"] }
+regex = { version = "1.11.0", default-features = false, features = ["std"] }
 rand = "0.8.5"
 base64 = "0.22.1"
 derive_builder = "0.20.2"

Cargo.toml

@@ -26,7 +26,8 @@ rust-version.workspace = true
 anyhow.workspace = true
 dunce.workspace = true
 ignore.workspace = true
-snapbox.workspace = true
+snapbox = { workspace = true, features = ["regex"] }
 tempfile.workspace = true
 which.workspace = true
 home.workspace = true
+regex.workspace = true

crates/moon-test-util/Cargo.toml

@@ -17,4 +17,5 @@
 // For inquiries, you can contact us via e-mail at jichuruanjian@idea.edu.cn.
 
 pub mod cmdtest;
+pub mod stack_trace;
 pub mod test_dir;

crates/moon-test-util/src/lib.rs

@@ -0,0 +1,45 @@
+// moon: The build system and package manager for MoonBit.
+// Copyright (C) 2024 International Digital Economy Academy
+//
+// This program is free software: you can redistribute it and/or modify
+// it under the terms of the GNU Affero General Public License as published by
+// the Free Software Foundation, either version 3 of the License, or
+// (at your option) any later version.
+//
+// This program is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+// GNU Affero General Public License for more details.
+//
+// You should have received a copy of the GNU Affero General Public License
+// along with this program.  If not, see <https://www.gnu.org/licenses/>.
+//
+// For inquiries, you can contact us via e-mail at jichuruanjian@idea.edu.cn.
+
+use std::path::Path;
+
+fn stack_trace_line_number_regex() -> regex::Regex {
+    regex::Regex::new(r"(?<redacted>:[0-9]+)(?:[ \t]+(?:at|by)|\n|$)")
+        .expect("valid stack trace line number regex")
+}
+
+pub fn redaction_regex(pattern: &str) -> regex::Regex {
+    regex::Regex::new(pattern).expect("valid redaction regex")
+}
+
+pub fn stack_trace_redactions(_src_dir: &Path) -> snapbox::Redactions {
+    let mut redactions = snapbox::Redactions::new();
+    redactions
+        .insert("[LINE_NUMBER]", stack_trace_line_number_regex())
+        .expect("valid stack trace line number redaction");
+    redactions
+        .insert(
+            "[CORE_PATH]",
+            regex::Regex::new(
+                r"(?<redacted>(?:\$MOON_HOME|(?:[A-Za-z]:)?/[^ \t\r\n]*\.moon)/lib/core)",
+            )
+            .expect("valid moon core path regex"),
+        )
+        .expect("valid moon core path redaction");
+    redactions
+}

crates/moon-test-util/src/stack_trace.rs

@@ -3,81 +3,45 @@ use super::*;
 #[cfg(unix)]
 #[test]
 fn test_native_abort_trace() {
+    const ANSI_LINE_NUMBER_REGEX: &str = r"(?<redacted>:[0-9]+)(?:(?:\x1b\[[0-9;]*m)|(?:\[ANSI_[A-Z]+\]))*(?:[ \t]+(?:(?:\x1b\[[0-9;]*m)|(?:\[ANSI_[A-Z]+\]))*(?:at|by)|\n|$)";
     let dir = TestDir::new("native_abort_trace/native_abort_trace.in");
-
-    fn strip_ansi(input: &str) -> String {
-        let mut out = String::with_capacity(input.len());
-        let mut chars = input.chars().peekable();
-        while let Some(c) = chars.next() {
-            if c == '\x1b' {
-                if chars.peek() == Some(&'[') {
-                    chars.next();
-                    for c2 in chars.by_ref() {
-                        if c2 == 'm' {
-                            break;
-                        }
-                    }
-                }
-                continue;
-            }
-            out.push(c);
-        }
-        out
-    }
-
-    fn normalize_line_numbers(input: &str) -> String {
-        let mut out = String::with_capacity(input.len());
-        for line in input.lines() {
-            let Some(pos) = line.find("main.c:") else {
-                out.push_str(line);
-                out.push('\n');
-                continue;
-            };
-            let prefix = &line[..pos];
-            let rest = &line[pos + "main.c:".len()..];
-            let mut digits_len = 0;
-            for ch in rest.chars() {
-                if ch.is_ascii_digit() {
-                    digits_len += ch.len_utf8();
-                } else {
-                    break;
-                }
-            }
-            if digits_len == 0 {
-                out.push_str(line);
-                out.push('\n');
-                continue;
-            }
-            let suffix = &rest[digits_len..];
-            out.push_str(prefix);
-            out.push_str("main.c:<line>");
-            out.push_str(suffix);
-            out.push('\n');
-        }
-        out
-    }
-
-    let output = snapbox::cmd::Command::new(moon_bin())
+    let mut redactions = moon_test_util::stack_trace::stack_trace_redactions(dir.as_ref());
+    redactions
+        .insert("[ANSI_RED]", "\u{1b}[31m")
+        .expect("valid ANSI red redaction");
+    redactions
+        .insert("[ANSI_GRAY]", "\u{1b}[90m")
+        .expect("valid ANSI gray redaction");
+    redactions
+        .insert("[ANSI_CYAN]", "\u{1b}[36m")
+        .expect("valid ANSI cyan redaction");
+    redactions
+        .insert("[ANSI_BOLD]", "\u{1b}[1m")
+        .expect("valid ANSI bold redaction");
+    redactions
+        .insert("[ANSI_RESET]", "\u{1b}[0m")
+        .expect("valid ANSI reset redaction");
+    redactions
+        .insert(
+            "[LINE_NUMBER]",
+            moon_test_util::stack_trace::redaction_regex(ANSI_LINE_NUMBER_REGEX),
+        )
+        .expect("valid ANSI stack trace line number redaction");
+    snapbox::cmd::Command::new(moon_bin())
+        .with_assert(snapbox::Assert::new().redact_with(redactions))
         .current_dir(&dir)
+        .env("NO_COLOR", "1")
+        .env("CLICOLOR", "0")
         .args(["run", "--target", "native", "cmd/main"])
         .assert()
         .success()
-        .get_output()
-        .to_owned();
-
-    let mut out = String::from_utf8_lossy(&output.stdout).to_string();
-    out.push_str(&String::from_utf8_lossy(&output.stderr));
-    let out = replace_dir(&normalize_line_numbers(&strip_ansi(&out)), &dir);
+        .stdout_eq("Hello\n")
+        .stderr_eq(snapbox::str![[r#"
+[ANSI_RED]RUNTIME ERROR: abort() called[ANSI_RESET]
+[ANSI_GRAY][CORE_PATH]/builtin/option.mbt[LINE_NUMBER][ANSI_RESET] [ANSI_CYAN]at[ANSI_RESET] [ANSI_BOLD]@moonbitlang/core/option.Option::unwrap[Int][ANSI_RESET]
+[ANSI_GRAY][..]/cmd/main/main.mbt[LINE_NUMBER][ANSI_RESET] [ANSI_CYAN]by[ANSI_RESET] [ANSI_BOLD]@username/scratch/cmd/main.g[ANSI_RESET]
+[ANSI_GRAY][..]/cmd/main/main.mbt[LINE_NUMBER][ANSI_RESET] [ANSI_CYAN]by[ANSI_RESET] [ANSI_BOLD]@username/scratch/cmd/main.f[ANSI_RESET]
+[ANSI_GRAY][..]/cmd/main/main.mbt[LINE_NUMBER][ANSI_RESET] [ANSI_CYAN]by[ANSI_RESET] [ANSI_BOLD]main[ANSI_RESET]
 
-    check(
-        &out,
-        expect![[r#"
-            Hello
-            RUNTIME ERROR: abort() called
-            $MOON_HOME/lib/core/builtin/option.mbt:39 at @moonbitlang/core/option.Option::unwrap[Int]
-            $ROOT/cmd/main/main.mbt:14 by @username/scratch/cmd/main.g
-            $ROOT/cmd/main/main.mbt:9 by @username/scratch/cmd/main.f
-            $ROOT/cmd/main/main.mbt:4 by main
-        "#]],
-    );
+"#]]);
 }