rustledger 0.16.1

Drop-in replacement for Beancount. Pure Rust, 10-30x faster.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104

//! Regression for issue #1306.
//!
//! A config file that exists but fails to parse must surface a clear
//! error, not be silently discarded so the user gets a misleading
//! downstream message. The reporter put a *source* definition
//! (`type` / `command`) under `[price.mapping.hy]`, which can't
//! deserialize as a `CommodityMapping`; `rledger price hy` then reported
//! "no price source configured" while `rledger config show` reported the
//! real TOML parse error. `main` now fails fast on a config-load error.

mod common;

use std::process::Command;

#[test]
fn malformed_config_surfaces_parse_error_instead_of_silent_default() {
    let bin = require_rledger!();

    // The exact mistake from #1306: a `[price.mapping.X]` table shaped
    // like a source definition. A valid mapping is a ticker string or a
    // `{ source = "..." }` table, so this can't deserialize.
    let dir = tempfile::tempdir().expect("tempdir");
    std::fs::write(
        dir.path().join(".rledger.toml"),
        "[price.mapping.hy]\ntype = \"command\"\ncommand = [\"uv\", \"run\", \"pricedl\"]\n",
    )
    .expect("write config");

    let output = Command::new(bin)
        .args(["price", "hy"])
        // Run inside the tempdir so its `.rledger.toml` is the project
        // config, and point every config-dir source at the (empty)
        // tempdir so no real user/system config is loaded first. HOME +
        // XDG_CONFIG_HOME cover Unix; APPDATA / PROGRAMDATA / USERPROFILE
        // cover the Windows paths `dirs::config_dir()` consults, keeping
        // the test hermetic across platforms.
        .current_dir(dir.path())
        .env("HOME", dir.path())
        .env("XDG_CONFIG_HOME", dir.path())
        .env("APPDATA", dir.path())
        .env("PROGRAMDATA", dir.path())
        .env("USERPROFILE", dir.path())
        .output()
        .expect("run rledger price");

    let stdout = String::from_utf8_lossy(&output.stdout);
    let stderr = String::from_utf8_lossy(&output.stderr);

    assert!(
        !output.status.success(),
        "a malformed config must fail, not exit 0 with defaults.\nstdout: {stdout}\nstderr: {stderr}"
    );
    assert!(
        stderr.contains("Failed to parse config file"),
        "stderr should name the config parse failure.\nstderr: {stderr}"
    );
    // The whole bug was that the misleading message masked the real
    // parse error — it must no longer appear.
    assert!(
        !stdout.contains("no price source configured")
            && !stderr.contains("no price source configured"),
        "the real parse error must replace the misleading 'no price source configured' message.\nstdout: {stdout}\nstderr: {stderr}"
    );
}

/// A broken config must NOT block commands that don't read it. `main`
/// loads config before clap parses (for alias expansion), so a naive
/// fail-fast there would break `--help`/`--version` and the `config`
/// subcommands a user runs to *fix* the file — a bootstrap deadlock.
/// `--help` must still succeed with a malformed config present.
#[test]
fn malformed_config_does_not_block_help() {
    let bin = require_rledger!();

    let dir = tempfile::tempdir().expect("tempdir");
    std::fs::write(
        dir.path().join(".rledger.toml"),
        "[price.mapping.hy]\ntype = \"command\"\ncommand = [\"uv\", \"run\", \"pricedl\"]\n",
    )
    .expect("write config");

    let output = Command::new(bin)
        .arg("--help")
        .current_dir(dir.path())
        .env("HOME", dir.path())
        .env("XDG_CONFIG_HOME", dir.path())
        .env("APPDATA", dir.path())
        .env("PROGRAMDATA", dir.path())
        .env("USERPROFILE", dir.path())
        .output()
        .expect("run rledger --help");

    let stdout = String::from_utf8_lossy(&output.stdout);
    assert!(
        output.status.success(),
        "--help must succeed despite a broken config (no bootstrap deadlock); \
         stdout: {stdout}\nstderr: {}",
        String::from_utf8_lossy(&output.stderr)
    );
    assert!(
        stdout.contains("Usage") || stdout.contains("usage"),
        "--help should print usage; stdout: {stdout}"
    );
}