envorigin 1.12.0

//! End-to-end LSP session over stdio: initialize, didOpen, hover,
//! go-to-definition, shutdown, exit.

use std::io::{BufRead, BufReader, Write};
use std::path::Path;
use std::process::{Child, ChildStdin, ChildStdout, Command, Stdio};
use std::time::Duration;

use serde_json::{json, Value};

struct LspClient {
    child: Child,
    stdin: ChildStdin,
    stdout: BufReader<ChildStdout>,
}

impl LspClient {
    fn start() -> Self {
        let bin = Path::new(env!("CARGO_MANIFEST_DIR")).join("target/debug/envorigin");
        let mut child = Command::new(bin)
            .arg("lsp")
            .stdin(Stdio::piped())
            .stdout(Stdio::piped())
            .stderr(Stdio::null())
            .spawn()
            .expect("spawn envorigin lsp");
        let stdin = child.stdin.take().expect("stdin");
        let stdout = BufReader::new(child.stdout.take().expect("stdout"));
        Self {
            child,
            stdin,
            stdout,
        }
    }

    fn send(&mut self, message: Value) {
        let payload = serde_json::to_vec(&message).expect("serialize");
        self.stdin
            .write_all(format!("Content-Length: {}\r\n\r\n", payload.len()).as_bytes())
            .expect("write header");
        self.stdin.write_all(&payload).expect("write body");
        self.stdin.flush().expect("flush");
    }

    fn receive(&mut self) -> Value {
        let mut headers = String::new();
        loop {
            let mut line = String::new();
            self.stdout.read_line(&mut line).expect("read header line");
            if line == "\r\n" {
                break;
            }
            headers.push_str(&line);
        }
        let length: usize = headers
            .lines()
            .find_map(|line| line.strip_prefix("Content-Length:"))
            .expect("content-length header")
            .trim()
            .parse()
            .expect("parse length");
        let mut payload = vec![0u8; length];
        self.stdout.read_exact(&mut payload).expect("read body");
        serde_json::from_slice(&payload).expect("parse json")
    }

    fn request(&mut self, id: u64, method: &str, params: Value) -> Value {
        self.send(json!({"jsonrpc": "2.0", "id": id, "method": method, "params": params}));
        self.receive()
    }

    fn notify(&mut self, method: &str, params: Value) {
        self.send(json!({"jsonrpc": "2.0", "method": method, "params": params}));
    }

    /// Receive the next message matching `method`, skipping unrelated
    /// notifications (e.g. window/logMessage).
    fn receive_until(&mut self, method: &str) -> Value {
        loop {
            let message = self.receive();
            if message["method"].as_str() == Some(method) {
                return message;
            }
        }
    }

    fn shutdown(mut self) -> std::io::Result<()> {
        self.send(json!({"jsonrpc": "2.0", "id": 99, "method": "shutdown"}));
        self.receive();
        self.notify("exit", json!({}));
        drop(self.stdin);
        self.child.wait_with_output()?;
        Ok(())
    }
}

trait ReadExact {
    fn read_exact(&mut self, buf: &mut [u8]) -> std::io::Result<()>;
}

impl ReadExact for BufReader<ChildStdout> {
    fn read_exact(&mut self, buf: &mut [u8]) -> std::io::Result<()> {
        std::io::Read::read_exact(self, buf)
    }
}

#[test]
fn lsp_session_hover_definition_and_diagnostics() {
    let fixture =
        Path::new(env!("CARGO_MANIFEST_DIR")).join("tests/fixtures/precedence/compose.yaml");
    let uri = format!("file://{}", fixture.display());
    let content = std::fs::read_to_string(&fixture).unwrap();

    let mut client = LspClient::start();
    let initialize = client.request(
        1,
        "initialize",
        json!({"capabilities": {}, "processId": null}),
    );
    let capabilities = &initialize["result"]["capabilities"];
    assert_eq!(capabilities["hoverProvider"], true);
    assert_eq!(capabilities["definitionProvider"], true);

    client.notify("initialized", json!({}));
    client.notify(
        "textDocument/didOpen",
        json!({
            "textDocument": {
                "uri": uri,
                "languageId": "yaml",
                "version": 1,
                "text": content,
            }
        }),
    );

    // The server publishes diagnostics after didOpen.
    let _published = client.receive_until("textDocument/publishDiagnostics");

    // Hover over the P definition line (compose.yaml:9 -> 0-based line 8).
    let hover = client.request(
        2,
        "textDocument/hover",
        json!({"textDocument": {"uri": uri}, "position": {"line": 8, "character": 0}}),
    );
    let hover_text = hover["result"]["contents"]["value"].as_str().unwrap();
    assert!(
        hover_text.contains("P"),
        "hover names the variable: {hover_text}"
    );
    assert!(
        hover_text.contains("ServiceEnvironment"),
        "hover names the source kind: {hover_text}"
    );

    // Go-to-definition jumps to the winner source line (9 -> 0-based 8).
    let definition = client.request(
        3,
        "textDocument/definition",
        json!({"textDocument": {"uri": uri}, "position": {"line": 8, "character": 0}}),
    );
    let location = &definition["result"];
    assert_eq!(location["uri"], uri);
    assert_eq!(location["range"]["start"]["line"], 8);

    client.shutdown().expect("graceful shutdown");
}

#[test]
fn lsp_unknown_file_type_yields_no_diagnostics() {
    let fixture = Path::new(env!("CARGO_MANIFEST_DIR")).join("tests/fixtures/basic/.env");
    let uri = format!("file://{}", fixture.display());
    let content = std::fs::read_to_string(&fixture).unwrap();

    let mut client = LspClient::start();
    client.request(1, "initialize", json!({"capabilities": {}}));
    client.notify("initialized", json!({}));
    client.notify(
        "textDocument/didOpen",
        json!({
            "textDocument": {"uri": uri, "languageId": "dotenv", "version": 1, "text": content}
        }),
    );
    let published = client.receive_until("textDocument/publishDiagnostics");
    assert_eq!(
        published["params"]["diagnostics"].as_array().unwrap().len(),
        0
    );
    client.shutdown().expect("graceful shutdown");
}

// Keep Duration import used for possible future timeouts.
#[allow(dead_code)]
fn _timeout_hint() -> Duration {
    Duration::from_secs(10)
}

#[test]
fn lsp_unsaved_changes_reflect_in_diagnostics() {
    let fixture =
        Path::new(env!("CARGO_MANIFEST_DIR")).join("tests/fixtures/precedence/compose.yaml");
    let uri = format!("file://{}", fixture.display());
    let content = std::fs::read_to_string(&fixture).unwrap();

    let mut client = LspClient::start();
    client.request(1, "initialize", json!({"capabilities": {}}));
    client.notify("initialized", json!({}));
    client.notify(
        "textDocument/didOpen",
        json!({
            "textDocument": {"uri": uri, "languageId": "yaml", "version": 1, "text": content}
        }),
    );
    let _ = client.receive_until("textDocument/publishDiagnostics");

    // Unsaved edit: add a variable referencing an undefined variable.
    let edited = content.replace("      Y:\n", "      Y:\n      BROKEN: ${UNDEFINED_VAR}\n");
    client.notify(
        "textDocument/didChange",
        json!({
            "textDocument": {"uri": uri, "version": 2},
            "contentChanges": [{"text": edited}]
        }),
    );
    let published = client.receive_until("textDocument/publishDiagnostics");
    let diagnostics = published["params"]["diagnostics"].as_array().unwrap();
    assert!(
        diagnostics
            .iter()
            .any(|diag| diag["code"] == "undefined-interpolation-variable"),
        "unsaved edit should surface the undefined reference, got {diagnostics:?}"
    );
    client.shutdown().expect("graceful shutdown");
}

#[test]
fn lsp_routes_all_four_backends() {
    let cases = [
        (
            "gitlab",
            "tests/fixtures/gitlab/.gitlab-ci.yml",
            "gitlab-include-external",
        ),
        (
            "circleci",
            "tests/fixtures/circleci/.circleci/config.yml",
            "circleci-context-external",
        ),
        (
            "actions",
            "tests/fixtures/actions/.github/workflows/workflow.yaml",
            "github-env-runtime",
        ),
    ];
    for (label, relative, expected_code) in cases {
        let fixture = Path::new(env!("CARGO_MANIFEST_DIR")).join(relative);
        let uri = format!("file://{}", fixture.display());
        let content = std::fs::read_to_string(&fixture).unwrap();

        let mut client = LspClient::start();
        client.request(1, "initialize", json!({"capabilities": {}}));
        client.notify("initialized", json!({}));
        client.notify(
            "textDocument/didOpen",
            json!({
                "textDocument": {"uri": uri, "languageId": "yaml", "version": 1, "text": content}
            }),
        );
        let published = client.receive_until("textDocument/publishDiagnostics");
        let diagnostics = published["params"]["diagnostics"].as_array().unwrap();
        assert!(
            diagnostics.iter().any(|diag| diag["code"] == expected_code),
            "{label}: expected {expected_code} in {diagnostics:?}"
        );
        client.shutdown().expect("graceful shutdown");
    }
}

#[test]
fn lsp_analyzes_multi_document_gitlab_file() {
    // Multi-document YAML (spec doc + pipeline doc) through the LSP path:
    // parse must succeed and hover must resolve a global variable. The LSP
    // routes by filename, so the content is opened as .gitlab-ci.yml.
    let fixture = Path::new(env!("CARGO_MANIFEST_DIR")).join("tests/fixtures/gitlab/multi-doc.yml");
    let content = std::fs::read_to_string(&fixture).unwrap();
    let dir = tempfile::tempdir().unwrap();
    let gitlab_file = dir.path().join(".gitlab-ci.yml");
    std::fs::write(&gitlab_file, &content).unwrap();
    let uri = format!("file://{}", gitlab_file.display());

    let mut client = LspClient::start();
    client.request(1, "initialize", json!({"capabilities": {}}));
    client.notify("initialized", json!({}));
    client.notify(
        "textDocument/didOpen",
        json!({
            "textDocument": {"uri": uri, "languageId": "yaml", "version": 1, "text": content}
        }),
    );
    let _published = client.receive_until("textDocument/publishDiagnostics");

    // GO_VERSION is defined on 0-based line 10 of the pipeline document.
    let hover = client.request(
        2,
        "textDocument/hover",
        json!({"textDocument": {"uri": uri}, "position": {"line": 10, "character": 3}}),
    );
    assert!(
        hover["result"]["contents"]["value"]
            .as_str()
            .unwrap()
            .contains("GO_VERSION"),
        "multi-doc hover resolves: {hover}"
    );
    client.shutdown().expect("graceful shutdown");
}

#[test]
fn lsp_routes_compose_filename_variants() {
    let dir = tempfile::tempdir().unwrap();
    for name in [
        "compose.yaml",
        "compose.yml",
        "docker-compose.yaml",
        "docker-compose.yml",
    ] {
        let file = dir.path().join(name);
        std::fs::write(
            &file,
            "services:\n  web:\n    image: nginx\n    environment:\n      MODE: production\n",
        )
        .unwrap();
        let uri = format!("file://{}", file.display());
        let mut client = LspClient::start();
        client.request(1, "initialize", json!({"capabilities": {}}));
        client.notify("initialized", json!({}));
        client.notify(
            "textDocument/didOpen",
            json!({
                "textDocument": {"uri": uri, "languageId": "yaml", "version": 1,
                                  "text": std::fs::read_to_string(&file).unwrap()}
            }),
        );
        let published = client.receive_until("textDocument/publishDiagnostics");
        // A valid compose file publishes (possibly empty) diagnostics; hover
        // must resolve the MODE symbol.
        let hover = client.request(
            2,
            "textDocument/hover",
            json!({"textDocument": {"uri": uri}, "position": {"line": 4, "character": 0}}),
        );
        let hover_text = hover["result"]["contents"]["value"].as_str().unwrap_or("");
        assert!(
            hover_text.contains("MODE"),
            "{name}: hover should resolve MODE, got {hover_text:?}"
        );
        let _ = published;
        client.shutdown().expect("graceful shutdown");
    }
}

#[test]
fn lsp_dotenv_files_get_security_diagnostics() {
    let dir = tempfile::tempdir().unwrap();
    let env_file = dir.path().join(".env");
    std::fs::write(&env_file, "AWS_KEY=AKIAIOSFODNN7EXAMPLE\n").unwrap();
    let uri = format!("file://{}", env_file.display());

    let mut client = LspClient::start();
    client.request(1, "initialize", json!({"capabilities": {}}));
    client.notify("initialized", json!({}));
    client.notify(
        "textDocument/didOpen",
        json!({
            "textDocument": {"uri": uri, "languageId": "dotenv", "version": 1,
                              "text": std::fs::read_to_string(&env_file).unwrap()}
        }),
    );
    let published = client.receive_until("textDocument/publishDiagnostics");
    let diagnostics = published["params"]["diagnostics"].as_array().unwrap();
    assert!(
        diagnostics
            .iter()
            .any(|diag| diag["code"] == "known-secret-format"),
        "dotenv security diagnostics missing, got {diagnostics:?}"
    );
    client.shutdown().expect("graceful shutdown");
}