chore(cli): add snapshot tests for reporters

Author: psteinroe

.gitignore

@@ -30,4 +30,4 @@ 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

Cargo.lock

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

crates/pgt_cli/Cargo.toml

@@ -1,16 +1,58 @@
 use std::path::PathBuf;
 
 use assert_cmd::Command;
-use predicates::prelude::*;
+use insta::assert_snapshot;
+
+const BIN: &str = "postgres-language-server";
 
 #[test]
 fn test_cli_check_command() {
-    let mut cmd = Command::cargo_bin("postgrestools").unwrap();
+    let output = Command::cargo_bin(BIN)
+        .unwrap()
+        .args([
+            "check",
+            PathBuf::from("tests/fixtures/test.sql").to_str().unwrap(),
+        ])
+        .output()
+        .unwrap();
+
+    assert!(!output.status.success(), "command unexpectedly succeeded");
 
-    let test_sql_path = PathBuf::from("tests/fixtures/test.sql");
+    let stdout = String::from_utf8_lossy(&output.stdout).to_string();
+    assert_snapshot!(normalize_durations(&stdout));
+}
 
-    cmd.args(["check", test_sql_path.to_str().unwrap()])
-        .assert()
-        .failure()
-        .stdout(predicate::str::contains("Found 1 error"));
+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;
+            let slice = &content[start..end];
+            if slice.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;
+            let slice = &content[start..end];
+            if slice.chars().any(|c| c.is_ascii_digit()) {
+                content.replace_range(start..end, "<duration>");
+            }
+            time_search = end + 1;
+        } else {
+            break;
+        }
+    }
+    content
 }

crates/pgt_cli/tests/assert_cmd.rs

@@ -1,24 +1,78 @@
-use bpaf::Args;
-use std::path::Path;
+use assert_cmd::Command;
+use insta::assert_snapshot;
+use std::path::PathBuf;
 
-use crate::run_cli;
-use pgt_console::BufferConsole;
-use pgt_fs::MemoryFileSystem;
-use pgt_workspace::DynRef;
+const BIN: &str = "postgres-language-server";
+
+fn run_check(args: &[&str]) -> String {
+    let mut cmd = Command::cargo_bin(BIN).expect("binary not built");
+    let mut full_args = vec!["check".to_string()];
+    full_args.extend(args.iter().map(|s| s.to_string()));
+    let test_sql = PathBuf::from("tests/fixtures/test.sql");
+    full_args.push(test_sql.to_str().unwrap().to_string());
+
+    let output = cmd.args(&full_args).output().expect("failed to run CLI");
+    assert!(
+        !output.status.success(),
+        "command unexpectedly succeeded: {:?}",
+        output.status
+    );
+
+    normalize_durations(&String::from_utf8_lossy(&output.stdout))
+}
+
+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
+}
 
 #[test]
-fn syntax_error() {
-    let mut fs = MemoryFileSystem::default();
-    let mut console = BufferConsole::default();
+fn check_default_reporter_snapshot() {
+    assert_snapshot!(run_check(&[]));
+}
 
-    let file_path = Path::new("test.sql");
-    fs.insert(file_path.into(), "select 1".as_bytes());
+#[test]
+fn check_github_reporter_snapshot() {
+    assert_snapshot!(run_check(&["--reporter", "github"]));
+}
 
-    let result = run_cli(
-        DynRef::Borrowed(&mut fs),
-        &mut console,
-        Args::from([("check"), file_path.as_os_str().to_str().unwrap()].as_slice()),
-    );
+#[test]
+fn check_gitlab_reporter_snapshot() {
+    assert_snapshot!(run_check(&["--reporter", "gitlab"]));
+}
 
-    assert!(result.is_ok(), "run_cli returned {result:?}");
+#[test]
+fn check_junit_reporter_snapshot() {
+    assert_snapshot!(run_check(&["--reporter", "junit"]));
 }

crates/pgt_cli/tests/commands/check.rs

@@ -0,0 +1,9 @@
+---
+source: crates/pgt_cli/tests/commands/check.rs
+expression: "run_check(&[])"
+snapshot_kind: text
+---
+Warning: You are using the deprecated config filename 'postgrestools.jsonc'. Please rename it to 'postgres-language-server.jsonc'. Support for the old filename will be removed in a future version.
+
+Checked 1 file in <duration>. No fixes applied.
+Found 1 error.

crates/pgt_cli/tests/commands/snapshots/main__commands__check__check_default_reporter_snapshot.snap

@@ -0,0 +1,8 @@
+---
+source: crates/pgt_cli/tests/commands/check.rs
+expression: "run_check(&[\"--reporter\", \"github\"])"
+snapshot_kind: text
+---
+Warning: You are using the deprecated config filename 'postgrestools.jsonc'. Please rename it to 'postgres-language-server.jsonc'. Support for the old filename will be removed in a future version.
+
+::error title=syntax,file=tests/fixtures/test.sql,line=1,endLine=1,col=1,endColumn=35::Invalid statement: syntax error at or near "tqjable"

crates/pgt_cli/tests/commands/snapshots/main__commands__check__check_github_reporter_snapshot.snap

@@ -0,0 +1,21 @@
+---
+source: crates/pgt_cli/tests/commands/check.rs
+expression: "run_check(&[\"--reporter\", \"gitlab\"])"
+snapshot_kind: text
+---
+Warning: You are using the deprecated config filename 'postgrestools.jsonc'. Please rename it to 'postgres-language-server.jsonc'. Support for the old filename will be removed in a future version.
+
+[
+  {
+    "description": "Invalid statement: syntax error at or near \"tqjable\"",
+    "check_name": "syntax",
+    "fingerprint": "15806099827984337215",
+    "severity": "critical",
+    "location": {
+      "path": "tests/fixtures/test.sql",
+      "lines": {
+        "begin": 1
+      }
+    }
+  }
+]

crates/pgt_cli/tests/commands/snapshots/main__commands__check__check_gitlab_reporter_snapshot.snap

@@ -0,0 +1,15 @@
+---
+source: crates/pgt_cli/tests/commands/check.rs
+expression: "run_check(&[\"--reporter\", \"junit\"])"
+snapshot_kind: text
+---
+Warning: You are using the deprecated config filename 'postgrestools.jsonc'. Please rename it to 'postgres-language-server.jsonc'. Support for the old filename will be removed in a future version.
+
+<?xml version="1.0" encoding="UTF-8"?>
+<testsuites name="PostgresTools" tests="1" failures="1" errors="1" time="<duration>">
+    <testsuite name="tests/fixtures/test.sql" tests="1" disabled="0" errors="0" failures="1" package="org.pgt">
+        <testcase name="org.pgt.syntax" line="1" column="1">
+            <failure message="Invalid statement: syntax error at or near &quot;tqjable&quot;">line 0, col 0, Invalid statement: syntax error at or near &quot;tqjable&quot;</failure>
+        </testcase>
+    </testsuite>
+</testsuites>

crates/pgt_cli/tests/commands/snapshots/main__commands__check__check_junit_reporter_snapshot.snap

@@ -1,53 +1 @@
 mod commands;
-
-use bpaf::ParseFailure;
-use pgt_cli::{CliDiagnostic, CliSession, pgt_command};
-use pgt_console::{Console, ConsoleExt, markup};
-use pgt_fs::FileSystem;
-use pgt_workspace::{App, DynRef};
-
-/// Create an [App] instance using the provided [FileSystem] and [Console]
-/// instance, and using an in-process "remote" instance of the workspace
-pub(crate) fn run_cli<'app>(
-    fs: DynRef<'app, dyn FileSystem>,
-    console: &'app mut dyn Console,
-    args: bpaf::Args,
-) -> Result<(), CliDiagnostic> {
-    use pgt_cli::SocketTransport;
-    use pgt_lsp::ServerFactory;
-    use pgt_workspace::{WorkspaceRef, workspace};
-    use tokio::{
-        io::{duplex, split},
-        runtime::Runtime,
-    };
-
-    let factory = ServerFactory::default();
-    let connection = factory.create(None);
-
-    let runtime = Runtime::new().expect("failed to create runtime");
-
-    let (client, server) = duplex(4096);
-    let (stdin, stdout) = split(server);
-    runtime.spawn(connection.accept(stdin, stdout));
-
-    let (client_read, client_write) = split(client);
-    let transport = SocketTransport::open(runtime, client_read, client_write);
-
-    let workspace = workspace::client(transport).unwrap();
-    let app = App::new(fs, console, WorkspaceRef::Owned(workspace));
-
-    let mut session = CliSession { app };
-    let command = pgt_command().run_inner(args);
-    match command {
-        Ok(command) => session.run(command),
-        Err(failure) => {
-            if let ParseFailure::Stdout(help, _) = &failure {
-                let console = &mut session.app.console;
-                console.log(markup! {{help.to_string()}});
-                Ok(())
-            } else {
-                Err(CliDiagnostic::parse_error_bpaf(failure))
-            }
-        }
-    }
-}