chore(cli): add snapshot tests for reporters (#577)

i want to make sure the cli refactoring does not change functionality :D

Author: psteinroe

.gitignore

@@ -30,4 +30,6 @@ squawk/
 # Auto generated treesitter files
 crates/pgt_treesitter_grammar/src/grammar.json
 crates/pgt_treesitter_grammar/src/node-types.json
-crates/pgt_treesitter_grammar/src/parser.c
+crates/pgt_treesitter_grammar/src/parser.c
+crates/pgt_treesitter_grammar/src/parser.c.codex-session-id
+.codex-session-id

Cargo.lock

@@ -53,7 +53,7 @@ tikv-jemallocator = "0.6.0"
 
 [dev-dependencies]
 assert_cmd = "2.0.16"
-predicates = "3.1.3"
+insta      = { workspace = true, features = ["yaml"] }
 
 [lib]
 doctest = false

crates/pgt_cli/Cargo.toml

@@ -0,0 +1,219 @@
+use assert_cmd::Command;
+use insta::assert_snapshot;
+use std::path::Path;
+use std::process::ExitStatus;
+
+const BIN: &str = "postgres-language-server";
+const CONFIG_PATH: &str = "tests/fixtures/postgres-language-server.jsonc";
+
+#[test]
+#[cfg_attr(
+    target_os = "windows",
+    ignore = "snapshot expectations only validated on unix-like platforms"
+)]
+fn check_default_reporter_snapshot() {
+    assert_snapshot!(run_check(&["tests/fixtures/test.sql"]));
+}
+
+#[test]
+#[cfg_attr(
+    target_os = "windows",
+    ignore = "snapshot expectations only validated on unix-like platforms"
+)]
+fn check_github_reporter_snapshot() {
+    assert_snapshot!(run_check(&[
+        "--reporter",
+        "github",
+        "tests/fixtures/test.sql"
+    ]));
+}
+
+#[test]
+#[cfg_attr(
+    target_os = "windows",
+    ignore = "snapshot expectations only validated on unix-like platforms"
+)]
+fn check_gitlab_reporter_snapshot() {
+    assert_snapshot!(run_check(&[
+        "--reporter",
+        "gitlab",
+        "tests/fixtures/test.sql"
+    ]));
+}
+
+#[test]
+#[cfg_attr(
+    target_os = "windows",
+    ignore = "snapshot expectations only validated on unix-like platforms"
+)]
+fn check_junit_reporter_snapshot() {
+    assert_snapshot!(run_check(&[
+        "--reporter",
+        "junit",
+        "tests/fixtures/test.sql"
+    ]));
+}
+
+#[test]
+#[cfg_attr(
+    target_os = "windows",
+    ignore = "snapshot expectations only validated on unix-like platforms"
+)]
+fn check_stdin_snapshot() {
+    assert_snapshot!(run_check_with(
+        &[
+            "--config-path",
+            CONFIG_PATH,
+            "--stdin-file-path",
+            "virtual.sql"
+        ],
+        Some("alter tqjable stdin drop column id;\n"),
+        None
+    ));
+}
+
+#[test]
+#[cfg_attr(
+    target_os = "windows",
+    ignore = "snapshot expectations only validated on unix-like platforms"
+)]
+fn check_directory_traversal_snapshot() {
+    let project_dir = Path::new("tests/fixtures/traversal");
+    assert_snapshot!(run_check_with(
+        &["--diagnostic-level", "info", "."],
+        None,
+        Some(project_dir)
+    ));
+}
+
+fn run_check(args: &[&str]) -> String {
+    let mut full_args = vec!["--config-path", CONFIG_PATH];
+    full_args.extend_from_slice(args);
+    run_check_with(&full_args, None, None)
+}
+
+fn run_check_with(args: &[&str], stdin: Option<&str>, cwd: Option<&Path>) -> String {
+    let mut cmd = Command::cargo_bin(BIN).expect("binary not built");
+    if let Some(dir) = cwd {
+        cmd.current_dir(dir);
+    }
+    if let Some(input) = stdin {
+        cmd.write_stdin(input);
+    }
+
+    let mut full_args = vec!["check"];
+    full_args.extend_from_slice(args);
+    let output = cmd.args(full_args).output().expect("failed to run CLI");
+
+    normalize_output(
+        output.status,
+        &String::from_utf8_lossy(&output.stdout),
+        &String::from_utf8_lossy(&output.stderr),
+    )
+}
+
+fn normalize_durations(input: &str) -> String {
+    let mut content = input.to_owned();
+
+    let mut search_start = 0;
+    while let Some(relative) = content[search_start..].find(" in ") {
+        let start = search_start + relative + 4;
+        if let Some(end_rel) = content[start..].find('.') {
+            let end = start + end_rel;
+            if content[start..end].chars().any(|c| c.is_ascii_digit()) {
+                content.replace_range(start..end, "<duration>");
+                search_start = start + "<duration>".len() + 1;
+                continue;
+            }
+            search_start = end + 1;
+        } else {
+            break;
+        }
+    }
+
+    let mut time_search = 0;
+    while let Some(relative) = content[time_search..].find("time=\"") {
+        let start = time_search + relative + 6;
+        if let Some(end_rel) = content[start..].find('"') {
+            let end = start + end_rel;
+            if content[start..end].chars().any(|c| c.is_ascii_digit()) {
+                content.replace_range(start..end, "<duration>");
+            }
+            time_search = end + 1;
+        } else {
+            break;
+        }
+    }
+
+    content
+}
+
+fn normalize_output(status: ExitStatus, stdout: &str, stderr: &str) -> String {
+    let normalized_stdout = normalize_durations(stdout);
+    let normalized_stderr = normalize_diagnostics(stderr);
+    let status_label = if status.success() {
+        "success"
+    } else {
+        "failure"
+    };
+    format!(
+        "status: {status_label}\nstdout:\n{}\nstderr:\n{}\n",
+        normalized_stdout.trim_end(),
+        normalized_stderr.trim_end()
+    )
+}
+
+fn normalize_diagnostics(input: &str) -> String {
+    let normalized = normalize_durations(input);
+    let mut lines = normalized.lines().peekable();
+    let mut diagnostic_sections: Vec<String> = Vec::new();
+    let mut other_lines: Vec<String> = Vec::new();
+
+    while let Some(line) = lines.next() {
+        if is_path_line(line) {
+            let mut block = String::from(line);
+            while let Some(&next) = lines.peek() {
+                if is_path_line(next) || next.starts_with("check ") {
+                    break;
+                }
+                block.push('\n');
+                block.push_str(next);
+                lines.next();
+            }
+            diagnostic_sections.push(trim_trailing_newlines(block));
+        } else {
+            other_lines.push(line.to_string());
+        }
+    }
+
+    diagnostic_sections.sort();
+
+    let mut parts = Vec::new();
+    if !diagnostic_sections.is_empty() {
+        parts.push(diagnostic_sections.join("\n\n"));
+    }
+
+    let rest = trim_trailing_newlines(other_lines.join("\n"));
+    if rest.trim().is_empty() {
+        parts.join("\n\n")
+    } else if parts.is_empty() {
+        rest
+    } else {
+        parts.push(rest);
+        parts.join("\n\n")
+    }
+}
+
+fn is_path_line(line: &str) -> bool {
+    let trimmed = line.trim_start();
+    (trimmed.starts_with("./") || trimmed.starts_with("tests/"))
+        && trimmed.contains(':')
+        && trimmed.contains(" syntax")
+}
+
+fn trim_trailing_newlines(mut value: String) -> String {
+    while value.ends_with('\n') {
+        value.pop();
+    }
+    value
+}

crates/pgt_cli/tests/assert_check.rs

@@ -0,0 +1,17 @@
+{
+  "$schema": "https://pg-language-server.com/schema/postgres-language-server.schema.json",
+  "vcs": {
+    "enabled": false,
+    "clientKind": "git",
+    "useIgnoreFile": false
+  },
+  "files": {
+    "ignore": []
+  },
+  "linter": {
+    "enabled": true,
+    "rules": {
+      "recommended": true
+    }
+  }
+}

crates/pgt_cli/tests/assert_cmd.rs

@@ -0,0 +1 @@
+alter tqjable another drop column id;

crates/pgt_cli/tests/commands/check.rs

@@ -0,0 +1 @@
+alter tqjable bad drop column id;