tokmd-core 1.11.0

High-level API façade for tokmd. The recommended entry point for library usage.
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
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
//! Integration tests for tokmd-core workflows.

#[cfg(feature = "analysis")]
use tokmd_core::{analyze_workflow, settings::AnalyzeSettings};
use tokmd_core::{
    export_workflow, lang_workflow, module_workflow,
    settings::{ExportSettings, LangSettings, ModuleSettings, ScanSettings},
};

// ============================================================================
// Lang workflow
// ============================================================================

#[test]
fn lang_workflow_scans_current_crate() {
    let scan = ScanSettings::for_paths(vec!["src".to_string()]);
    let lang = LangSettings::default();

    let receipt = lang_workflow(&scan, &lang).expect("lang_workflow should succeed");

    assert_eq!(receipt.mode, "lang");
    assert_eq!(receipt.schema_version, tokmd_types::SCHEMA_VERSION);
    assert!(
        !receipt.report.rows.is_empty(),
        "should find some languages"
    );
    // This crate is Rust, so we should find Rust
    assert!(
        receipt.report.rows.iter().any(|r| r.lang == "Rust"),
        "should find Rust in this crate"
    );
}

#[test]
fn lang_workflow_respects_top_setting() {
    let scan = ScanSettings::for_paths(vec!["src".to_string()]);
    let lang = LangSettings {
        top: 1,
        ..Default::default()
    };

    let receipt = lang_workflow(&scan, &lang).expect("lang_workflow should succeed");

    // Should have at most 2 rows (1 real + 1 "Other" if needed)
    assert!(receipt.report.rows.len() <= 2, "should respect top setting");
}

#[test]
fn lang_workflow_with_files_enabled() {
    let scan = ScanSettings::for_paths(vec!["src".to_string()]);
    let lang = LangSettings {
        files: true,
        ..Default::default()
    };

    let receipt = lang_workflow(&scan, &lang).expect("lang_workflow should succeed");
    assert!(receipt.args.with_files);
}

#[test]
fn lang_workflow_receipt_has_complete_status() {
    let scan = ScanSettings::for_paths(vec!["src".to_string()]);
    let lang = LangSettings::default();

    let receipt = lang_workflow(&scan, &lang).expect("lang_workflow should succeed");
    // ScanStatus doesn't implement PartialEq; compare via Debug
    assert_eq!(format!("{:?}", receipt.status), "Complete");
}

#[test]
fn lang_workflow_receipt_has_tool_info() {
    let scan = ScanSettings::for_paths(vec!["src".to_string()]);
    let lang = LangSettings::default();

    let receipt = lang_workflow(&scan, &lang).expect("lang_workflow should succeed");
    assert!(!receipt.tool.name.is_empty());
    assert!(!receipt.tool.version.is_empty());
}

#[test]
fn lang_workflow_receipt_has_valid_timestamp() {
    let scan = ScanSettings::for_paths(vec!["src".to_string()]);
    let lang = LangSettings::default();

    let receipt = lang_workflow(&scan, &lang).expect("lang_workflow should succeed");
    // generated_at_ms should be a timestamp after 2020-01-01
    assert!(receipt.generated_at_ms > 1_577_836_800_000);
}

#[test]
fn lang_workflow_receipt_has_scan_args() {
    let scan = ScanSettings::for_paths(vec!["src".to_string()]);
    let lang = LangSettings::default();

    let receipt = lang_workflow(&scan, &lang).expect("lang_workflow should succeed");
    assert!(
        !receipt.scan.paths.is_empty(),
        "scan.paths should not be empty"
    );
}

#[test]
fn lang_workflow_top_zero_returns_all_languages() {
    let scan = ScanSettings::for_paths(vec!["src".to_string()]);
    let lang = LangSettings {
        top: 0,
        ..Default::default()
    };

    let receipt = lang_workflow(&scan, &lang).expect("lang_workflow should succeed");
    // top=0 means no limit; all languages should be present
    assert!(
        !receipt.report.rows.is_empty(),
        "top=0 should return all languages"
    );
}

#[test]
fn lang_workflow_receipt_rows_have_code_lines() {
    let scan = ScanSettings::for_paths(vec!["src".to_string()]);
    let lang = LangSettings::default();

    let receipt = lang_workflow(&scan, &lang).expect("lang_workflow should succeed");
    // Every row should have non-negative code count
    for row in &receipt.report.rows {
        assert!(
            row.code > 0 || row.lang == "Other",
            "row should have code lines: {:?}",
            row.lang
        );
    }
}

#[test]
fn lang_workflow_receipt_is_serializable() {
    let scan = ScanSettings::for_paths(vec!["src".to_string()]);
    let lang = LangSettings::default();

    let receipt = lang_workflow(&scan, &lang).expect("lang_workflow should succeed");
    let json = serde_json::to_string(&receipt);
    assert!(json.is_ok(), "receipt should be JSON-serializable");

    // Should round-trip
    let json_str = json.expect("receipt should serialize to JSON");
    let deserialized: Result<tokmd_types::LangReceipt, _> = serde_json::from_str(&json_str);
    assert!(
        deserialized.is_ok(),
        "receipt should round-trip through JSON"
    );
}

// ============================================================================
// Module workflow
// ============================================================================

#[test]
fn module_workflow_scans_current_crate() {
    let scan = ScanSettings::for_paths(vec!["src".to_string()]);
    let module = ModuleSettings::default();

    let receipt = module_workflow(&scan, &module).expect("module_workflow should succeed");

    assert_eq!(receipt.mode, "module");
    assert_eq!(receipt.schema_version, tokmd_types::SCHEMA_VERSION);
    assert!(!receipt.report.rows.is_empty(), "should find some modules");
}

#[test]
fn module_workflow_with_custom_depth() {
    let scan = ScanSettings::for_paths(vec!["src".to_string()]);
    let module = ModuleSettings {
        module_depth: 1,
        ..Default::default()
    };

    let receipt = module_workflow(&scan, &module).expect("module_workflow should succeed");
    assert_eq!(receipt.args.module_depth, 1);
}

#[test]
fn module_workflow_with_custom_roots() {
    let scan = ScanSettings::for_paths(vec!["src".to_string()]);
    let module = ModuleSettings {
        module_roots: vec!["src".to_string()],
        ..Default::default()
    };

    let receipt = module_workflow(&scan, &module).expect("module_workflow should succeed");
    assert!(receipt.args.module_roots.contains(&"src".to_string()));
}

#[test]
fn module_workflow_receipt_has_complete_status() {
    let scan = ScanSettings::for_paths(vec!["src".to_string()]);
    let module = ModuleSettings::default();

    let receipt = module_workflow(&scan, &module).expect("module_workflow should succeed");
    assert_eq!(format!("{:?}", receipt.status), "Complete");
}

#[test]
fn module_workflow_receipt_is_serializable() {
    let scan = ScanSettings::for_paths(vec!["src".to_string()]);
    let module = ModuleSettings::default();

    let receipt = module_workflow(&scan, &module).expect("module_workflow should succeed");
    let json = serde_json::to_string(&receipt);
    assert!(json.is_ok(), "module receipt should be JSON-serializable");
}

#[test]
fn module_workflow_with_top_setting() {
    let scan = ScanSettings::for_paths(vec!["src".to_string()]);
    let module = ModuleSettings {
        top: 1,
        ..Default::default()
    };

    let receipt = module_workflow(&scan, &module).expect("module_workflow should succeed");
    assert_eq!(receipt.args.top, 1);
}

// ============================================================================
// Export workflow
// ============================================================================

#[test]
fn export_workflow_scans_current_crate() {
    let scan = ScanSettings::for_paths(vec!["src".to_string()]);
    let export = ExportSettings::default();

    let receipt = export_workflow(&scan, &export).expect("export_workflow should succeed");

    assert_eq!(receipt.mode, "export");
    assert_eq!(receipt.schema_version, tokmd_types::SCHEMA_VERSION);
    assert!(!receipt.data.rows.is_empty(), "should find some files");
}

#[test]
fn export_workflow_finds_rust_files() {
    let scan = ScanSettings::for_paths(vec!["src".to_string()]);
    let export = ExportSettings::default();

    let receipt = export_workflow(&scan, &export).expect("export_workflow should succeed");
    let has_rust = receipt.data.rows.iter().any(|r| r.lang == "Rust");
    assert!(has_rust, "should find Rust files in src/");
}

#[test]
fn export_workflow_file_rows_have_paths() {
    let scan = ScanSettings::for_paths(vec!["src".to_string()]);
    let export = ExportSettings::default();

    let receipt = export_workflow(&scan, &export).expect("export_workflow should succeed");
    for row in &receipt.data.rows {
        assert!(!row.path.is_empty(), "each file row should have a path");
    }
}

#[test]
fn export_workflow_paths_use_forward_slashes() {
    let scan = ScanSettings::for_paths(vec!["src".to_string()]);
    let export = ExportSettings::default();

    let receipt = export_workflow(&scan, &export).expect("export_workflow should succeed");
    for row in &receipt.data.rows {
        assert!(
            !row.path.contains('\\'),
            "paths should use forward slashes, got: {}",
            row.path
        );
    }
}

#[test]
fn export_workflow_with_min_code_filter() {
    let scan = ScanSettings::for_paths(vec!["src".to_string()]);

    let export_all = ExportSettings {
        min_code: 0,
        ..Default::default()
    };
    let receipt_all = export_workflow(&scan, &export_all).expect("export_workflow should succeed");

    let export_filtered = ExportSettings {
        min_code: 9999,
        ..Default::default()
    };
    let receipt_filtered =
        export_workflow(&scan, &export_filtered).expect("export_workflow should succeed");

    assert!(
        receipt_filtered.data.rows.len() <= receipt_all.data.rows.len(),
        "min_code filter should reduce rows"
    );
}

#[test]
fn export_workflow_with_max_rows() {
    let scan = ScanSettings::for_paths(vec!["src".to_string()]);
    let export = ExportSettings {
        max_rows: 1,
        ..Default::default()
    };

    let receipt = export_workflow(&scan, &export).expect("export_workflow should succeed");
    assert!(
        receipt.data.rows.len() <= 1,
        "max_rows=1 should limit output, got {}",
        receipt.data.rows.len()
    );
}

#[test]
fn export_workflow_receipt_is_serializable() {
    let scan = ScanSettings::for_paths(vec!["src".to_string()]);
    let export = ExportSettings::default();

    let receipt = export_workflow(&scan, &export).expect("export_workflow should succeed");
    let json = serde_json::to_string(&receipt);
    assert!(json.is_ok(), "export receipt should be JSON-serializable");
}

#[test]
fn export_workflow_receipt_has_complete_status() {
    let scan = ScanSettings::for_paths(vec!["src".to_string()]);
    let export = ExportSettings::default();

    let receipt = export_workflow(&scan, &export).expect("export_workflow should succeed");
    assert_eq!(format!("{:?}", receipt.status), "Complete");
}

// ============================================================================
// ScanSettings
// ============================================================================

#[test]
fn scan_settings_excluded_patterns() {
    let scan = ScanSettings {
        paths: vec!["src".to_string()],
        options: tokmd_core::settings::ScanOptions {
            excluded: vec!["**/tests/**".to_string()],
            ..Default::default()
        },
    };
    let lang = LangSettings::default();

    let receipt = lang_workflow(&scan, &lang).expect("lang_workflow should succeed");
    assert_eq!(receipt.mode, "lang");
}

#[test]
fn scan_settings_current_dir() {
    let settings = ScanSettings::current_dir();
    assert_eq!(settings.paths, vec!["."]);
}

#[test]
fn scan_settings_for_multiple_paths() {
    let settings = ScanSettings::for_paths(vec!["src".to_string(), "tests".to_string()]);
    assert_eq!(settings.paths.len(), 2);
}

// ============================================================================
// Version helper
// ============================================================================

#[test]
fn version_not_empty() {
    let v = tokmd_core::version();
    assert!(!v.is_empty());
    assert!(v.contains('.'), "version should look like semver");
}

#[test]
fn core_schema_version_matches() {
    assert_eq!(tokmd_core::CORE_SCHEMA_VERSION, tokmd_types::SCHEMA_VERSION);
}

// ============================================================================
// Diff workflow
// ============================================================================

#[test]
fn diff_workflow_same_directory() {
    use tokmd_core::settings::DiffSettings;

    let settings = DiffSettings {
        from: "src".to_string(),
        to: "src".to_string(),
    };

    let receipt = tokmd_core::diff_workflow(&settings).expect("diff_workflow should succeed");
    // Self-diff should have zero-delta rows
    for row in &receipt.diff_rows {
        assert_eq!(
            row.delta_code, 0,
            "self-diff should have zero delta_code for {}",
            row.lang
        );
    }
}

#[test]
fn diff_workflow_receipt_has_totals() {
    use tokmd_core::settings::DiffSettings;

    let settings = DiffSettings {
        from: "src".to_string(),
        to: "src".to_string(),
    };

    let receipt = tokmd_core::diff_workflow(&settings).expect("diff_workflow should succeed");
    // Totals should exist
    assert_eq!(receipt.totals.delta_code, 0);
}

// ============================================================================
// Analyze workflow (feature-gated)
// ============================================================================

#[test]
#[cfg(feature = "analysis")]
fn analyze_workflow_runs_with_receipt_preset() {
    let scan = ScanSettings::for_paths(vec!["src".to_string()]);
    let analyze = AnalyzeSettings::default();

    let receipt = analyze_workflow(&scan, &analyze).expect("analyze_workflow should succeed");

    assert_eq!(receipt.mode, "analysis");
    assert!(
        receipt.derived.is_some(),
        "receipt preset should include derived metrics"
    );
}

// ============================================================================
// Property tests
// ============================================================================

mod properties {
    use super::*;
    use proptest::prelude::*;

    proptest! {
        #[test]
        fn lang_workflow_top_never_exceeds_limit(top in 1usize..20) {
            let scan = ScanSettings::for_paths(vec!["src".to_string()]);
            let lang = LangSettings {
                top,
                ..Default::default()
            };

            let receipt = lang_workflow(&scan, &lang).expect("lang_workflow should succeed");
            // rows should be at most top + 1 (for possible "Other" row)
            prop_assert!(
                receipt.report.rows.len() <= top + 1,
                "top={} but got {} rows",
                top,
                receipt.report.rows.len()
            );
        }

        #[test]
        fn export_max_rows_respected(max_rows in 1usize..10) {
            let scan = ScanSettings::for_paths(vec!["src".to_string()]);
            let export = ExportSettings {
                max_rows,
                ..Default::default()
            };

            let receipt = export_workflow(&scan, &export).expect("export_workflow should succeed");
            prop_assert!(
                receipt.data.rows.len() <= max_rows,
                "max_rows={} but got {} rows",
                max_rows,
                receipt.data.rows.len()
            );
        }

        #[test]
        fn lang_workflow_always_produces_complete_status(
            top in 0usize..5,
            files in proptest::bool::ANY,
        ) {
            let scan = ScanSettings::for_paths(vec!["src".to_string()]);
            let lang = LangSettings {
                top,
                files,
                ..Default::default()
            };

            let receipt = lang_workflow(&scan, &lang).expect("lang_workflow should succeed");
            prop_assert_eq!(format!("{:?}", receipt.status), "Complete");
            prop_assert_eq!(receipt.mode.as_str(), "lang");
            prop_assert_eq!(receipt.schema_version, tokmd_types::SCHEMA_VERSION);
        }
    }
}