decypher 0.2.0-alpha.6

//! Integration tests for parser error reporting.
//!
//! These tests verify that the parser returns appropriate [`CypherError`]s
//! (correct [`ErrorKind`], non-empty spans, and rendered diagnostic text) for
//! various categories of invalid input.

use assert2::check;
use decypher::CypherError;
use decypher::ErrorKind;
use decypher::parse;

/// An empty string produces an `EmptyInput` error.
///
/// Unit: `parse()`
/// Precondition: Input is an empty string.
/// Expectation: Returns `Err(CypherError { kind: ErrorKind::EmptyInput, .. })`.
#[test]
fn test_empty_string() {
    let result = parse("");
    check!(result.is_err());
    match result.unwrap_err() {
        CypherError {
            kind: ErrorKind::EmptyInput,
            ..
        } => {}
        _ => panic!("expected EmptyInput error"),
    }
}

/// An unknown top-level keyword produces a parse error.
///
/// Unit: `parse()`
/// Precondition: Input starts with an unrecognised identifier `FOOBAR`.
/// Expectation: Returns `Err`.
#[test]
fn test_invalid_keyword() {
    let result = parse("FOOBAR;");
    check!(result.is_err());
}

/// An unterminated single-quoted string produces a parse error whose
/// rendered text mentions "unterminated" or "string".
///
/// Unit: `parse()` / `CypherError::render()`
/// Precondition: String literal opened with `'` is never closed.
/// Expectation: Returns `Err` and rendered message mentions the issue.
#[test]
fn test_unterminated_string() {
    let result = parse("MATCH (n) WHERE n.name = 'hello RETURN n;");
    check!(result.is_err());
    let err = result.unwrap_err();
    let rendered = err.render("MATCH (n) WHERE n.name = 'hello RETURN n;");
    check!(
        rendered.contains("unterminated") || rendered.contains("string"),
        "expected unterminated string diagnostic, got: {}",
        rendered
    );
}

/// A missing closing parenthesis in a node pattern produces a parse error.
///
/// Unit: `parse()`
/// Precondition: Node pattern `(n` is never closed with `)`.
/// Expectation: Returns `Err`.
#[test]
fn test_missing_closing_paren() {
    let result = parse("MATCH (n RETURN n;");
    check!(result.is_err());
}

/// A `MATCH` keyword without a subsequent pattern produces a parse error.
///
/// Unit: `parse()`
/// Precondition: `MATCH` is immediately followed by `RETURN` with no pattern.
/// Expectation: Returns `Err`.
#[test]
fn test_invalid_pattern() {
    let result = parse("MATCH RETURN n;");
    check!(result.is_err());
}

/// `RETURN;` (no projection) produces a `MissingClause` error.
///
/// Unit: `parse()`
/// Precondition: `RETURN` is followed immediately by `;`.
/// Expectation: Returns `Err` with `ErrorKind::MissingClause { clause: "projection", .. }`.
#[test]
fn test_incomplete_return() {
    let result = parse("RETURN;");
    check!(result.is_err());
    let err = result.unwrap_err();
    check!(matches!(
        err.kind(),
        ErrorKind::MissingClause {
            clause: "projection",
            ..
        }
    ));
}

/// A string of punctuation that forms no valid grammar produces a parse error.
///
/// Unit: `parse()`
/// Precondition: Input is `"!!!@@@###"`.
/// Expectation: Returns `Err`.
#[test]
fn test_garbage_input() {
    let result = parse("!!!@@@###");
    check!(result.is_err());
}

/// A parse error produces a non-empty `Display` string.
///
/// Unit: `CypherError::fmt()`
/// Precondition: A query with a syntax error (missing `)` before WHERE).
/// Expectation: The formatted error string is non-empty.
#[test]
fn test_error_contains_position_info() {
    let result = parse("MATCH (n WHERE n.name = 'hello' RETURN n;");
    check!(result.is_err());
    let err = result.unwrap_err();
    let err_string = format!("{}", err);
    check!(!err_string.is_empty());
}

/// The `ErrorKind` on a parse error can be pattern-matched.
///
/// Unit: `CypherError::kind()`
/// Precondition: Two parses — one succeeds (`RETURN 1`), one fails (`RETURN`).
/// Expectation: The failing parse returns `MissingClause { clause: "projection", after: "RETURN" }`.
#[test]
fn test_error_kind_is_matchable() {
    let result = parse("RETURN 1");
    check!(result.is_ok());

    let result = parse("RETURN");
    check!(result.is_err());
    let err = result.unwrap_err();
    match err.kind() {
        ErrorKind::MissingClause { clause, after } => {
            check!(*clause == "projection");
            check!(*after == "RETURN");
        }
        _ => panic!("expected MissingClause, got {:?}", err.kind()),
    }
}

/// The span on a `RETURN;` error has at least one non-zero boundary.
///
/// Unit: `CypherError::span()`
/// Precondition: `RETURN;` produces a `MissingClause` error.
/// Expectation: `span.start > 0 || span.end > 0`.
#[test]
fn test_error_span_is_valid() {
    let result = parse("RETURN;");
    check!(result.is_err());
    let err = result.unwrap_err();
    let span = err.span();
    check!(span.start > 0 || span.end > 0);
}

/// Comparing with `NULL` using `=` parses without error (no strict-mode rejection).
///
/// Unit: `parse()`
/// Precondition: WHERE clause with `n.x = NULL`.
/// Expectation: Returns `Ok` (the comparison is syntactically valid; semantic
///   checks may flag this separately).
#[test]
fn test_null_comparison_note_skipped() {
    let result = parse("MATCH (n) WHERE n.x = NULL RETURN n");
    check!(result.is_ok());
}

/// `CypherError::render` produces a string containing `"error:"` and the
/// phrase `"projection"`.
///
/// Unit: `CypherError::render()`
/// Precondition: `RETURN;` fails with `MissingClause`.
/// Expectation: Rendered string contains `"error:"` and `"projection"`.
#[test]
fn test_render_produces_output() {
    let result = parse("RETURN;");
    check!(result.is_err());
    let err = result.unwrap_err();
    let rendered = err.render("RETURN;");
    check!(rendered.contains("error:"));
    check!(rendered.contains("projection"));
}

/// `parse_all` returns `(None, Diagnostics)` for a completely invalid query.
///
/// Unit: `parse_all()`
/// Precondition: `RETURN;` has no valid projection.
/// Expectation: `query.is_none()`, `diags` is non-empty with exactly one error.
#[test]
fn test_diagnostics_wrapper() {
    use decypher::parse_all;
    let (query, diags) = parse_all("RETURN;");
    check!(query.is_none());
    check!(!diags.is_empty());
    check!(diags.len() == 1);
}

/// `parse_with_label` attaches the source label to the error on failure.
///
/// Unit: `parse_with_label()`
/// Precondition: Two parses — one succeeds (`RETURN 1`), one fails (`RETURN;`).
/// Expectation: Successful parse returns `Ok`; failed parse returns `Err` with
///   `source_label() == Some("test.cypher")`.
#[test]
fn test_parse_with_label() {
    use decypher::parse_with_label;
    let result = parse_with_label("RETURN 1", "test.cypher");
    check!(result.is_ok());

    let result = parse_with_label("RETURN;", "test.cypher");
    check!(result.is_err());
    let err = result.unwrap_err();
    check!(err.source_label() == Some("test.cypher"));
}

/// A malformed label expression renders a diagnostic mentioning "label" and "dynamic".
///
/// Unit: `parse()` / `CypherError::render()`
/// Precondition: `MATCH (n:(Person|)) RETURN n;` — empty label alternative.
/// Expectation: Returns `Err`; rendered output contains `"label"` and `"dynamic"`.
#[test]
fn test_malformed_label_expression_has_help() {
    let input = "MATCH (n:(Person|)) RETURN n;";
    let result = parse(input);
    check!(result.is_err());
    let err = result.unwrap_err();
    let rendered = err.render(input);
    check!(rendered.contains("label"));
    check!(rendered.contains("dynamic"));
}

/// An invalid `{,}` quantifier renders a diagnostic mentioning "quantifier"
/// and the valid format `{n,m}` or `{n}`.
///
/// Unit: `parse()` / `CypherError::render()`
/// Precondition: Path quantifier `{,}` has neither minimum nor maximum.
/// Expectation: Returns `Err`; rendered output contains `"quantifier"` and a
///   format hint.
#[test]
fn test_invalid_quantifier_has_help() {
    let input = "MATCH p = ((a)-[:R]->(b)){,} RETURN p;";
    let result = parse(input);
    check!(result.is_err());
    let err = result.unwrap_err();
    let rendered = err.render(input);
    check!(rendered.contains("quantifier"));
    check!(rendered.contains("{n,m}") || rendered.contains("{n}"));
}

/// An empty `COUNT { }` subquery body renders a diagnostic mentioning
/// "subquery" and prompting to add `MATCH` or `RETURN`.
///
/// Unit: `parse()` / `CypherError::render()`
/// Precondition: `RETURN COUNT { };` — subquery body has no clauses.
/// Expectation: Returns `Err`; rendered output contains `"subquery"` and
///   either `"MATCH"` or `"RETURN"`.
#[test]
fn test_empty_subquery_body_has_help() {
    let input = "RETURN COUNT { };";
    let result = parse(input);
    check!(result.is_err());
    let err = result.unwrap_err();
    let rendered = err.render(input);
    check!(rendered.contains("subquery"));
    check!(rendered.contains("MATCH") || rendered.contains("RETURN"));
}

/// In recovery mode, a second valid statement is returned even when the first
/// has syntax errors.
///
/// Unit: `parse_with_options()` with `recover = true`
/// Precondition: Input has an invalid first statement followed by `RETURN 1;`.
/// Expectation: `query.is_some()` (the second statement succeeds) and `diags`
///   is non-empty.
#[test]
fn test_recovery_with_rich_syntax_errors() {
    use decypher::{ParseOptions, parse_with_options};
    let input = "MATCH (n:(Person|)) RETURN n; RETURN 1;";
    let mut opts = ParseOptions::default();
    opts.recover = true;
    let (query, diags) = parse_with_options(input, opts);
    check!(query.is_some());
    check!(!diags.is_empty());
}