workshop-rs-cli 1.16.1

Standalone CLI for the canonical Workshop core: parse, emit, convert, locales, and catalog identity.
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
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
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
//! CLI surface tests: parse/emit/convert a file, list locales, report the
//! machine-readable catalog identity, and fail explicitly on missing
//! target-locale mappings (with opt-in fallback).

use std::path::PathBuf;
use std::process::Command;

use workshop_rs::catalog::{Catalog, Locale};
use workshop_rs_cli::conformance::CONFORMANCE_SCHEMA_VERSION;
use workshop_rs_cli::conformance::{
    Comparison, ConformanceReason, ConformanceResult, ConformanceStatus, Equivalence, FeatureId,
    FeatureKind, FeatureNamespace, ReasonCode, TestArtifact,
};
use workshop_rs_cli::live_capture::{
    CENSUS_IDENTITY_SCHEMA_VERSION, CensusIdentity, LIVE_CAPTURE_SCHEMA_VERSION, LiveCapture,
};

fn bin() -> &'static str {
    env!("CARGO_BIN_EXE_workshop-rs-cli")
}

fn fixture(fixture_id: &str) -> PathBuf {
    PathBuf::from(env!("CARGO_MANIFEST_DIR"))
        .join("../workshop-rs/tests/fixtures/corpus")
        .join(format!("{fixture_id}.ws"))
}

fn run(args: &[&str]) -> std::process::Output {
    Command::new(bin()).args(args).output().expect("cli runs")
}

// Synthetic schema/diff input only. This helper deliberately creates no
// client artifact.
fn synthetic_capture(id: &str) -> String {
    let catalog = Catalog::builtin().unwrap();
    let locale = Locale::new("en-US");
    let raw = TestArtifact {
        name: "synthetic-cli/raw.ws".to_string(),
        revision: Some("synthetic-cli".to_string()),
        path: Some("synthetic-cli/raw.ws".to_string()),
        sha256: Some(
            "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa".to_string(),
        ),
        license: Some("test-only".to_string()),
    };
    let result = ConformanceResult {
        schema_version: CONFORMANCE_SCHEMA_VERSION,
        case_id: "wir/variables-global".to_string(),
        features: vec![
            FeatureId::new(FeatureNamespace::Wir, FeatureKind::Variable, "global").unwrap(),
        ],
        status: ConformanceStatus::Inconclusive,
        comparison: Comparison {
            mode: Equivalence::NotComparable,
            expected: None,
            observed: None,
            normalizer: None,
        },
        source: raw.clone(),
        catalog: catalog.identity(),
        locale: Some(locale.clone()),
        reason: Some(ConformanceReason {
            code: ReasonCode::Inconclusive,
            detail: "synthetic CLI schema input".to_string(),
        }),
    };
    LiveCapture {
        schema_version: LIVE_CAPTURE_SCHEMA_VERSION,
        capture_id: id.to_string(),
        game: "overwatch-2".to_string(),
        client: "synthetic-client".to_string(),
        season: "synthetic-season".to_string(),
        captured_at: "2026-08-18T00:00:00Z".to_string(),
        environment: "synthetic CLI unit input".to_string(),
        locale,
        catalog: catalog.identity(),
        census: CensusIdentity {
            schema_version: CENSUS_IDENTITY_SCHEMA_VERSION,
            digest: "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa".to_string(),
            shards: vec!["synthetic-cli-shard".to_string()],
        },
        raw_artifact: raw,
        results: vec![result],
    }
    .to_json()
    .unwrap()
}

#[test]
fn version_reports_the_machine_readable_identity() {
    let output = run(&["version"]);
    assert!(
        output.status.success(),
        "{}",
        String::from_utf8_lossy(&output.stderr)
    );
    let stdout = String::from_utf8(output.stdout).unwrap();
    assert!(stdout.contains("implementation version: "));
    assert!(stdout.contains("catalog version: "));
    assert!(stdout.contains("catalog digest: "));
    assert!(stdout.contains("locale en-us"));
    assert!(stdout.contains("locale zh-cn"));

    let output = run(&["version", "--json"]);
    assert!(output.status.success());
    let identity: serde_json::Value =
        serde_json::from_slice(&output.stdout).expect("identity is valid JSON");
    assert!(identity["implementation-version"].is_string());
    assert!(identity["catalog-digest"].is_string());
    assert!(identity["locale-coverage"].is_array());
}

#[test]
fn locales_lists_declared_locales_with_coverage() {
    let output = run(&["locales"]);
    assert!(output.status.success());
    let stdout = String::from_utf8(output.stdout).unwrap();
    let lines: Vec<&str> = stdout.lines().collect();
    let expected = Catalog::builtin().unwrap().identity().locale_coverage;
    assert_eq!(lines.len(), expected.len());
    assert_eq!(expected[0].mapped, expected[0].total);
    for (line, expected) in lines.iter().zip(expected) {
        let (reported_locale, coverage) = line.split_once(' ').expect("locale coverage line");
        let (mapped, total) = coverage.split_once('/').expect("mapped/total coverage");
        assert_eq!(reported_locale, expected.locale.as_str());
        assert_eq!(mapped.parse::<usize>().unwrap(), expected.mapped, "{line}");
        assert_eq!(total.parse::<usize>().unwrap(), expected.total, "{line}");
    }
}

#[test]
fn parse_parses_a_corpus_file() {
    let file = fixture("basic-rule");
    let output = run(&["parse", file.to_str().unwrap()]);
    assert!(
        output.status.success(),
        "{}",
        String::from_utf8_lossy(&output.stderr)
    );
    let stdout = String::from_utf8(output.stdout).unwrap();
    assert!(stdout.contains("rule \"setup\""), "{stdout}");
}

#[test]
fn parse_with_explicit_locale_works() {
    let file = fixture("basic-rule");
    let output = run(&["parse", "--locale", "en-US", file.to_str().unwrap()]);
    assert!(
        output.status.success(),
        "{}",
        String::from_utf8_lossy(&output.stderr)
    );
}

#[test]
fn parse_reports_unknown_spellings_with_failure_exit() {
    let dir = std::env::temp_dir().join("workshop-rs-cli-parse-bad");
    std::fs::create_dir_all(&dir).unwrap();
    let bad = dir.join("bad.ws");
    std::fs::write(
        &bad,
        "rule (\"x\") { event { Ongoing - Global; } actions { Totally Unknown Thing(1); } }",
    )
    .unwrap();
    let output = run(&["parse", "--locale", "en-US", bad.to_str().unwrap()]);
    assert_eq!(output.status.code(), Some(1));
    let stderr = String::from_utf8_lossy(&output.stderr);
    assert!(stderr.contains("Totally Unknown Thing"), "{stderr}");
    let _ = std::fs::remove_dir_all(&dir);
}

/// C6: canonical-identity validation gates the CLI — a call with the wrong
/// arity for its declared signature must fail, not parse and re-emit
/// verbatim.
#[test]
fn parse_rejects_noncanonical_call_arity() {
    let dir = std::env::temp_dir().join("workshop-rs-cli-arity");
    std::fs::create_dir_all(&dir).unwrap();
    let file = dir.join("arity.ws");
    std::fs::write(
        &file,
        "rule (\"x\") { event { Ongoing - Global; } actions { Wait(1, 2, 3, 4, 5); } }",
    )
    .unwrap();
    for command in ["parse", "emit"] {
        let output = run(&[command, "--locale", "en-US", file.to_str().unwrap()]);
        assert_eq!(
            output.status.code(),
            Some(1),
            "{command} must fail on non-canonical arity: {}",
            String::from_utf8_lossy(&output.stderr)
        );
    }
    let output = run(&[
        "convert",
        file.to_str().unwrap(),
        "--from",
        "en-US",
        "--to",
        "zh-CN",
    ]);
    assert_eq!(
        output.status.code(),
        Some(1),
        "convert must fail on non-canonical arity: {}",
        String::from_utf8_lossy(&output.stderr)
    );
    let _ = std::fs::remove_dir_all(&dir);
}

#[test]
fn emit_emits_localized_text() {
    let file = fixture("basic-rule");
    let output = run(&["emit", file.to_str().unwrap()]);
    assert!(
        output.status.success(),
        "{}",
        String::from_utf8_lossy(&output.stderr)
    );
    let stdout = String::from_utf8(output.stdout).unwrap();
    assert!(stdout.contains("rule (\"setup\") {"), "{stdout}");
    assert!(stdout.contains("Disable Inspector Recording;"), "{stdout}");
}

#[test]
fn convert_to_zh_cn_uses_the_corpus_without_fallback() {
    let file = fixture("basic-rule");
    let output = run(&[
        "convert",
        file.to_str().unwrap(),
        "--from",
        "en-US",
        "--to",
        "zh-CN",
    ]);
    assert!(output.status.success());
    let stdout = String::from_utf8_lossy(&output.stdout);
    assert!(stdout.contains("持续 - 全局"), "{stdout}");
    assert!(stdout.contains("禁用查看器录制"), "{stdout}");
}

#[test]
fn convert_to_zh_cn_with_fallback_reports_the_choice() {
    let dir = std::env::temp_dir().join("workshop-rs-cli-convert-fallback");
    std::fs::create_dir_all(&dir).unwrap();
    let file = dir.join("unmapped.ws");
    std::fs::write(
        &file,
        "rule (\"setup\") { event { Ongoing - Global; } actions { Disable Inspector Recording; Disable Game Mode In-World UI(Event Player); } }",
    )
    .unwrap();
    let output = run(&[
        "convert",
        file.to_str().unwrap(),
        "--from",
        "en-US",
        "--to",
        "th-TH",
        "--fallback-locale",
        "en-US",
    ]);
    assert!(
        output.status.success(),
        "{}",
        String::from_utf8_lossy(&output.stderr)
    );
    let stdout = String::from_utf8(output.stdout).unwrap();
    assert!(stdout.contains("ดำเนินอยู่ - ทั่วโลก"), "{stdout}");
    assert!(
        stdout.contains("Disable Game Mode In-World UI(Event Player)"),
        "{stdout}"
    );
    let stderr = String::from_utf8_lossy(&output.stderr);
    assert!(
        stderr.contains("fallback-locale spelling") && stderr.contains("disableGameModeInworldUI"),
        "the fallback choice is visible in tooling output: {stderr}"
    );
    let _ = std::fs::remove_dir_all(&dir);
}

#[test]
fn usage_errors_exit_2() {
    let output = run(&["convert"]);
    assert_eq!(output.status.code(), Some(2));
    let output = run(&["no-such-command"]);
    assert_eq!(output.status.code(), Some(2));
}

#[test]
fn seasonal_diff_requires_two_capture_files() {
    let output = run(&["seasonal-diff"]);
    assert_eq!(output.status.code(), Some(2));
    let output = run(&["seasonal-diff", "previous.json"]);
    assert_eq!(output.status.code(), Some(2));
    let output = run(&["seasonal-diff", "previous.json", "current.json", "extra"]);
    assert_eq!(output.status.code(), Some(2));
}

#[test]
fn seasonal_diff_missing_capture_fails_without_fabricating_results() {
    let output = run(&["seasonal-diff", "/no/previous.json", "/no/current.json"]);
    assert_eq!(output.status.code(), Some(1));
    assert!(String::from_utf8_lossy(&output.stderr).contains("cannot read"));
}

#[test]
fn seasonal_diff_runs_text_and_json_success_paths_with_synthetic_schema_input() {
    let dir = std::env::temp_dir().join(format!("workshop-rs-cli-seasonal-{}", std::process::id()));
    std::fs::create_dir_all(&dir).unwrap();
    let previous = dir.join("previous.json");
    let current = dir.join("current.json");
    std::fs::write(&previous, synthetic_capture("capture-a")).unwrap();
    std::fs::write(&current, synthetic_capture("capture-b")).unwrap();
    let previous_arg = previous.to_string_lossy().to_string();
    let current_arg = current.to_string_lossy().to_string();

    let output = run(&["seasonal-diff", &previous_arg, &current_arg]);
    assert!(
        output.status.success(),
        "{}",
        String::from_utf8_lossy(&output.stderr)
    );
    assert!(String::from_utf8_lossy(&output.stdout).contains("RuntimeUncertainty"));

    let output = run(&["seasonal-diff", &previous_arg, &current_arg, "--json"]);
    assert!(output.status.success());
    let report: serde_json::Value = serde_json::from_slice(&output.stdout).unwrap();
    assert!(
        report["runtimeUncertainty"]
            .as_array()
            .is_some_and(|entries| !entries.is_empty())
    );

    let _ = std::fs::remove_file(previous);
    let _ = std::fs::remove_file(current);
    let _ = std::fs::remove_dir(&dir);
}

#[test]
fn census_runs_with_machine_readable_results() {
    let output = run(&["census", "--json"]);
    assert_eq!(output.status.code(), Some(1));
    let report: serde_json::Value = serde_json::from_slice(&output.stdout).expect("valid report");
    assert!(
        report["census"]["shards"]
            .as_array()
            .is_some_and(|shards| !shards.is_empty())
    );
    assert!(report["results"].as_array().is_some_and(|results| {
        results
            .iter()
            .any(|result| result["status"] == "inconclusive")
            && results
                .iter()
                .any(|result| result["status"] == "unexpected-regression")
    }));

    let output = run(&["census", "--json", "extra"]);
    assert_eq!(output.status.code(), Some(2));
    let output = run(&["census", "--bogus"]);
    assert_eq!(output.status.code(), Some(2));
}

#[test]
fn corpus_runs_full_and_minimized_cases_without_materialized_reference_comparison() {
    let manifest = PathBuf::from(env!("CARGO_MANIFEST_DIR"))
        .join("../workshop-rs/tests/fixtures/corpus/real-projects.json");
    let output = run(&["corpus", manifest.to_str().unwrap()]);
    assert!(
        output.status.success(),
        "{}",
        String::from_utf8_lossy(&output.stderr)
    );
    let stdout = String::from_utf8(output.stdout).unwrap();
    assert!(
        stdout.contains("real-project/overpy-cake/full: Inconclusive"),
        "{stdout}"
    );
    assert!(
        stdout.contains("minimized-regression/overpy-cake-loop: Inconclusive"),
        "{stdout}"
    );
    assert!(
        stdout.contains("matched=0")
            && stdout.contains("known-gap=0")
            && stdout.contains("inconclusive=2"),
        "{stdout}"
    );

    let output = run(&["corpus", manifest.to_str().unwrap(), "--json"]);
    assert!(output.status.success());
    let report: serde_json::Value = serde_json::from_slice(&output.stdout).expect("valid report");
    assert_eq!(report["results"].as_array().unwrap().len(), 2);
    assert_eq!(report["summary"]["known-gap"], 0);
    assert_eq!(report["summary"]["inconclusive"], 2);
}

#[test]
fn corpus_missing_manifest_fails_explicitly() {
    let output = run(&["corpus", "/no/such/workshop-rs-manifest.json"]);
    assert_eq!(output.status.code(), Some(1));
    assert!(String::from_utf8_lossy(&output.stderr).contains("cannot read"));
}