badness 0.14.0

A language server, formatter, and linter for LaTeX
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
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270

//! CLI-level tests for `badness debug format`, the invariant-check command the
//! smoke-test workflow (`.github/workflows/smoke-test.yml`) drives per file.
//!
//! These pin the output contracts the workflow greps — the parenthesized
//! failure labels, the report header, and the sanitized dump-file names — by
//! running the real binary (`CARGO_BIN_EXE_badness`). Every invocation passes
//! `--no-config` so a developer's own `badness.toml` cannot leak in.

use std::path::Path;
use std::process::{Command, Output};

use tempfile::TempDir;

fn badness(dir: &Path, args: &[&str]) -> Output {
    Command::new(env!("CARGO_BIN_EXE_badness"))
        .arg("--no-config")
        .args(args)
        .current_dir(dir)
        .output()
        .expect("run badness")
}

fn stdout(output: &Output) -> String {
    String::from_utf8_lossy(&output.stdout).into_owned()
}

fn stderr(output: &Output) -> String {
    String::from_utf8_lossy(&output.stderr).into_owned()
}

#[test]
fn passing_file_exits_zero() {
    let dir = TempDir::new().unwrap();
    std::fs::write(dir.path().join("ok.tex"), "Hello \\emph{world}.\n").unwrap();

    let output = badness(
        dir.path(),
        &["debug", "format", "--checks", "all", "ok.tex"],
    );

    assert!(output.status.success(), "stderr: {}", stderr(&output));
    assert!(stdout(&output).contains("All checks passed (checks: all, files: 1)"));
}

#[test]
fn report_on_passing_file_has_no_failure_headings() {
    let dir = TempDir::new().unwrap();
    std::fs::write(dir.path().join("ok.tex"), "Hello world.\n").unwrap();

    let output = badness(dir.path(), &["debug", "format", "--report", "ok.tex"]);

    assert!(output.status.success(), "stderr: {}", stderr(&output));
    let report = stdout(&output);
    assert!(report.contains("# Debug-format regression report"));
    assert!(report.contains("All checks passed."));
    assert!(!report.contains("(idempotency)"));
    assert!(!report.contains("(losslessness)"));
}

#[test]
fn dump_passes_writes_sanitized_artifact_names() {
    let dir = TempDir::new().unwrap();
    std::fs::create_dir(dir.path().join("sub dir")).unwrap();
    let source = "Hello \\emph{world}.\n";
    std::fs::write(dir.path().join("sub dir/a b.tex"), source).unwrap();

    let output = badness(
        dir.path(),
        &[
            "debug",
            "format",
            "--dump-dir",
            "dumps",
            "--dump-passes",
            "sub dir/a b.tex",
        ],
    );

    assert!(output.status.success(), "stderr: {}", stderr(&output));
    // The stem is the path as passed, sanitized exactly like the workflow's
    // `sed 's/[^[:alnum:]._-]/_/g'` — this is the artifact-lookup contract.
    let dumps = dir.path().join("dumps");
    let input = std::fs::read_to_string(dumps.join("sub_dir_a_b.tex.idempotency.input.txt"))
        .expect("input dump exists");
    let once = std::fs::read_to_string(dumps.join("sub_dir_a_b.tex.idempotency.once.txt"))
        .expect("once dump exists");
    let twice = std::fs::read_to_string(dumps.join("sub_dir_a_b.tex.idempotency.twice.txt"))
        .expect("twice dump exists");
    assert_eq!(input, source);
    assert_eq!(once, twice);
    assert!(
        dumps
            .join("sub_dir_a_b.tex.losslessness.input.txt")
            .exists()
    );
    assert!(
        dumps
            .join("sub_dir_a_b.tex.losslessness.parsed.txt")
            .exists()
    );
}

#[test]
fn dump_passes_requires_dump_dir() {
    let dir = TempDir::new().unwrap();
    std::fs::write(dir.path().join("ok.tex"), "x\n").unwrap();

    let output = badness(dir.path(), &["debug", "format", "--dump-passes", "ok.tex"]);

    assert_eq!(output.status.code(), Some(2), "clap usage error expected");
}

#[test]
fn trivia_check_passes_on_stable_prose() {
    let dir = TempDir::new().unwrap();
    std::fs::write(dir.path().join("ok.tex"), "alpha\nbeta gamma delta.\n").unwrap();

    let output = badness(
        dir.path(),
        &["debug", "format", "--checks", "trivia", "ok.tex"],
    );

    assert!(output.status.success(), "stderr: {}", stderr(&output));
    assert!(stdout(&output).contains("All checks passed (checks: trivia, files: 1)"));
}

#[test]
fn trivia_check_counts_skipped_bib_files_separately() {
    // The trivia oracle is LaTeX-CST-based and runs nothing on a `.bib` file:
    // the summary must report it as skipped, never fold it into the checked
    // count (which would overstate oracle coverage on a `.bib`-heavy sweep).
    let dir = TempDir::new().unwrap();
    std::fs::write(dir.path().join("ok.tex"), "alpha beta.\n").unwrap();
    std::fs::write(
        dir.path().join("refs.bib"),
        "@article{key, title = {T}, year = {2020}}\n",
    )
    .unwrap();

    let output = badness(dir.path(), &["debug", "format", "--checks", "trivia", "."]);
    assert!(output.status.success(), "stderr: {}", stderr(&output));
    assert!(
        stdout(&output).contains("All checks passed (checks: trivia, files: 1, skipped: 1)"),
        "stdout: {}",
        stdout(&output)
    );

    let output = badness(
        dir.path(),
        &["debug", "format", "--checks", "trivia", "--report", "."],
    );
    assert!(output.status.success(), "stderr: {}", stderr(&output));
    let report = stdout(&output);
    assert!(report.contains("- Files checked: 1"), "report: {report}");
    assert!(report.contains("- Files skipped: 1"), "report: {report}");
}

#[test]
fn trivia_check_fires_on_a_known_hybrid() {
    let dir = TempDir::new().unwrap();
    // A known convergence failure (found by the S0 sweep): joining
    // `\ExplSyntaxOn` with its statement makes the doc-prose reflow relocate
    // the margined `%    \begin{macrocode}` frame line, so the formatted
    // perturbed output stops parsing cleanly. The trivia check (wrap pinned to
    // reflow) must fail on it — and only under `--checks trivia`, never `all`
    // (where the `.dtx` default `Preserve` applies and everything passes).
    std::fs::write(
        dir.path().join("expl.dtx"),
        "% \\section{Implementation}\n\
         %    \\begin{macrocode}\n\
         \\ExplSyntaxOn\n\
         \\tl_new:N \\l_tmpa_tl\n\
         %    \\end{macrocode}\n\
         %\n\
         % Some prose.\n\
         %    \\begin{macrocode}\n\
         \\ExplSyntaxOff\n\
         %    \\end{macrocode}\n",
    )
    .unwrap();

    let output = badness(
        dir.path(),
        &["debug", "format", "--checks", "trivia", "expl.dtx"],
    );
    assert_eq!(output.status.code(), Some(1));
    let log = stderr(&output);
    assert!(log.contains("Debug check failed (trivia:"), "log: {log}");

    let output = badness(
        dir.path(),
        &[
            "debug", "format", "--checks", "trivia", "--report", "expl.dtx",
        ],
    );
    assert_eq!(output.status.code(), Some(1));
    let report = stdout(&output);
    assert!(report.contains("- Checks: `trivia`"), "report: {report}");
    assert!(
        report.contains("### 1. `expl.dtx` (trivia)"),
        "report: {report}"
    );
    assert!(report.contains("- Variant: `"), "report: {report}");

    // `all` keeps its meaning: losslessness + idempotency only. The same file
    // passes it, and no `(trivia)` label can appear in its output.
    let output = badness(
        dir.path(),
        &["debug", "format", "--checks", "all", "--report", "expl.dtx"],
    );
    assert!(output.status.success(), "stderr: {}", stderr(&output));
    assert!(!stdout(&output).contains("(trivia)"));
}

#[test]
fn line_width_flag_reaches_the_formatter() {
    let dir = TempDir::new().unwrap();
    let long = "alpha beta gamma delta epsilon zeta eta theta iota kappa\n";
    std::fs::write(dir.path().join("wide.tex"), long).unwrap();

    let output = badness(
        dir.path(),
        &[
            "debug",
            "format",
            "--checks",
            "idempotency",
            "--line-width",
            "30",
            "--dump-dir",
            "dumps",
            "--dump-passes",
            "wide.tex",
        ],
    );

    assert!(output.status.success(), "stderr: {}", stderr(&output));
    let once = std::fs::read_to_string(
        dir.path()
            .join("dumps")
            .join("wide.tex.idempotency.once.txt"),
    )
    .expect("once dump exists");
    assert!(
        once.lines().count() > 1 && once.lines().all(|l| l.len() <= 30),
        "expected a wrap at width 30, got: {once:?}"
    );
}

#[test]
fn format_error_never_reads_as_an_invariant_failure() {
    let dir = TempDir::new().unwrap();
    // An unclosed group parses with diagnostics, so the formatter refuses it:
    // a `format-error`, not an idempotency or losslessness regression.
    std::fs::write(dir.path().join("bad.tex"), "a{\n").unwrap();

    let output = badness(dir.path(), &["debug", "format", "bad.tex"]);

    assert_eq!(output.status.code(), Some(1));
    let log = stderr(&output).to_lowercase();
    assert!(log.contains("(format-error)"), "log: {log}");
    assert!(!log.contains("idempot"), "log: {log}");
    assert!(!log.contains("lossless"), "log: {log}");

    let output = badness(dir.path(), &["debug", "format", "--report", "bad.tex"]);
    assert_eq!(output.status.code(), Some(1));
    let report = stdout(&output);
    assert!(report.contains("### 1. `bad.tex` (format-error)"));
    assert!(report.contains("- Files checked: 1"));
}