tokf 0.2.33

Config-driven CLI tool that compresses command output before it reaches an LLM context
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

#![allow(clippy::unwrap_used, clippy::expect_used)]

use std::process::Command;

use serde_json::Value;
use tempfile::TempDir;

fn tokf() -> Command {
    Command::new(env!("CARGO_BIN_EXE_tokf"))
}

#[test]
fn info_shows_version() {
    let tmp = TempDir::new().unwrap();
    let output = tokf().current_dir(tmp.path()).arg("info").output().unwrap();
    let stdout = String::from_utf8_lossy(&output.stdout);
    assert!(
        output.status.success(),
        "stderr: {}",
        String::from_utf8_lossy(&output.stderr)
    );
    assert!(
        stdout.starts_with("tokf "),
        "expected version line starting with 'tokf ', got:\n{stdout}"
    );
}

#[test]
fn info_shows_search_directories() {
    let tmp = TempDir::new().unwrap();
    let output = tokf().current_dir(tmp.path()).arg("info").output().unwrap();
    let stdout = String::from_utf8_lossy(&output.stdout);
    assert!(output.status.success());
    assert!(
        stdout.contains("filter search directories:"),
        "missing search dirs header:\n{stdout}"
    );
    assert!(
        stdout.contains("[built-in]"),
        "missing built-in label:\n{stdout}"
    );
    assert!(stdout.contains("[local]"), "missing local label:\n{stdout}");
}

#[test]
fn info_shows_tracking_db() {
    let tmp = TempDir::new().unwrap();
    let output = tokf().current_dir(tmp.path()).arg("info").output().unwrap();
    let stdout = String::from_utf8_lossy(&output.stdout);
    assert!(output.status.success());
    assert!(
        stdout.contains("tracking database:"),
        "missing tracking db header:\n{stdout}"
    );
    assert!(
        stdout.contains("TOKF_DB_PATH:"),
        "missing TOKF_DB_PATH line:\n{stdout}"
    );
}

#[test]
fn info_shows_cache_path() {
    let tmp = TempDir::new().unwrap();
    let output = tokf().current_dir(tmp.path()).arg("info").output().unwrap();
    let stdout = String::from_utf8_lossy(&output.stdout);
    assert!(output.status.success());
    assert!(
        stdout.contains("filter cache:"),
        "missing cache header:\n{stdout}"
    );
}

#[test]
fn info_shows_filter_counts() {
    let tmp = TempDir::new().unwrap();
    let output = tokf().current_dir(tmp.path()).arg("info").output().unwrap();
    let stdout = String::from_utf8_lossy(&output.stdout);
    assert!(output.status.success());
    assert!(
        stdout.contains("built-in:"),
        "missing built-in count:\n{stdout}"
    );
    assert!(stdout.contains("total:"), "missing total count:\n{stdout}");
}

#[test]
fn info_tokf_home_shown_in_output() {
    let tmp = TempDir::new().unwrap();
    let output = tokf()
        .current_dir(tmp.path())
        .env("TOKF_HOME", tmp.path().to_str().unwrap())
        .arg("info")
        .output()
        .unwrap();
    let stdout = String::from_utf8_lossy(&output.stdout);
    assert!(output.status.success());
    assert!(
        stdout.contains("TOKF_HOME:"),
        "expected TOKF_HOME line in output:\n{stdout}"
    );
    assert!(
        stdout.contains(tmp.path().to_str().unwrap()),
        "expected TOKF_HOME value in output:\n{stdout}"
    );
}

#[test]
fn info_tokf_home_redirects_user_filter_dir() {
    let tmp = TempDir::new().unwrap();
    let home_dir = tmp.path().join("myhome");
    std::fs::create_dir_all(home_dir.join("filters")).unwrap();

    let output = tokf()
        .current_dir(tmp.path())
        .env("TOKF_HOME", home_dir.to_str().unwrap())
        .arg("info")
        .output()
        .unwrap();
    let stdout = String::from_utf8_lossy(&output.stdout);
    assert!(output.status.success());
    // The [user] search dir should appear under TOKF_HOME
    assert!(
        stdout.contains(home_dir.to_str().unwrap()),
        "expected TOKF_HOME path in filter search dirs:\n{stdout}"
    );
}

#[test]
fn info_json_includes_home_override() {
    let tmp = TempDir::new().unwrap();
    let output = tokf()
        .current_dir(tmp.path())
        .env("TOKF_HOME", tmp.path().to_str().unwrap())
        .args(["info", "--json"])
        .output()
        .unwrap();
    assert!(output.status.success());
    let stdout = String::from_utf8_lossy(&output.stdout);
    let parsed: Value = serde_json::from_str(&stdout).expect("valid JSON");
    // home_override is now a top-level field, not nested under tracking_db
    assert!(
        parsed["home_override"].is_string(),
        "home_override should be a top-level string when TOKF_HOME is set, got: {parsed}"
    );
    assert_eq!(
        parsed["home_override"].as_str().unwrap(),
        tmp.path().to_str().unwrap()
    );
}

#[test]
fn info_tokf_db_path_env_override() {
    let tmp = TempDir::new().unwrap();
    let custom_path = tmp.path().join("custom.db");

    let output = tokf()
        .current_dir(tmp.path())
        .env("TOKF_DB_PATH", custom_path.to_str().unwrap())
        .arg("info")
        .output()
        .unwrap();
    let stdout = String::from_utf8_lossy(&output.stdout);
    assert!(output.status.success());
    assert!(
        stdout.contains(custom_path.to_str().unwrap()),
        "expected custom DB path in output:\n{stdout}"
    );
}

#[test]
fn info_json_is_valid() {
    let tmp = TempDir::new().unwrap();
    let output = tokf()
        .current_dir(tmp.path())
        .args(["info", "--json"])
        .output()
        .unwrap();
    assert!(
        output.status.success(),
        "stderr: {}",
        String::from_utf8_lossy(&output.stderr)
    );
    let stdout = String::from_utf8_lossy(&output.stdout);
    let parsed: Value = serde_json::from_str(&stdout).expect("info --json should be valid JSON");
    assert!(parsed["version"].is_string());
    assert!(parsed["search_dirs"].is_array());
    assert!(parsed["tracking_db"].is_object());
    assert!(parsed["cache"].is_object());
    assert!(parsed["filters"].is_object());
    assert!(parsed["filters"]["builtin"].is_number());
    assert!(parsed["filters"]["total"].is_number());
}

#[test]
fn info_json_includes_access_fields() {
    let tmp = TempDir::new().unwrap();
    let output = tokf()
        .current_dir(tmp.path())
        .args(["info", "--json"])
        .output()
        .unwrap();
    assert!(output.status.success());
    let stdout = String::from_utf8_lossy(&output.stdout);
    let parsed: Value = serde_json::from_str(&stdout).unwrap();

    // cache and tracking_db should carry an `access` field
    assert!(
        parsed["cache"]["access"].is_string(),
        "cache.access should be a string, got: {}",
        parsed["cache"]
    );
    assert!(
        parsed["tracking_db"]["access"].is_string(),
        "tracking_db.access should be a string, got: {}",
        parsed["tracking_db"]
    );

    // search dirs should carry an `access` field (null when not found, string when found)
    let dirs = parsed["search_dirs"].as_array().unwrap();
    let local = &dirs[0];
    // `access` is null when the dir does not exist, a string label when it does
    assert!(
        local["access"].is_null() || local["access"].is_string(),
        "search_dirs[0].access should be null or string, got: {}",
        local["access"]
    );
}

#[test]
fn info_shows_config_files() {
    let tmp = TempDir::new().unwrap();
    let output = tokf().current_dir(tmp.path()).arg("info").output().unwrap();
    let stdout = String::from_utf8_lossy(&output.stdout);
    assert!(output.status.success());
    assert!(
        stdout.contains("config files:"),
        "missing config files header:\n{stdout}"
    );
    assert!(
        stdout.contains("config.toml"),
        "expected config.toml in output:\n{stdout}"
    );
    assert!(
        stdout.contains("auth.toml"),
        "expected auth.toml in output:\n{stdout}"
    );
}

#[test]
fn info_json_includes_config_files() {
    let tmp = TempDir::new().unwrap();
    let output = tokf()
        .current_dir(tmp.path())
        .args(["info", "--json"])
        .output()
        .unwrap();
    assert!(output.status.success());
    let stdout = String::from_utf8_lossy(&output.stdout);
    let parsed: Value = serde_json::from_str(&stdout).unwrap();
    assert!(
        parsed["config_files"].is_array(),
        "expected config_files array in JSON output: {parsed}"
    );
    let files = parsed["config_files"].as_array().unwrap();
    assert!(!files.is_empty(), "config_files should not be empty");
    assert!(
        files[0]["scope"].is_string(),
        "config_files entries should have scope field"
    );
    assert!(
        files[0]["path"].is_string(),
        "config_files entries should have path field"
    );
}

#[test]
fn info_human_shows_access_status() {
    let tmp = TempDir::new().unwrap();
    let output = tokf().current_dir(tmp.path()).arg("info").output().unwrap();
    let stdout = String::from_utf8_lossy(&output.stdout);
    assert!(output.status.success());
    // The cache and DB lines should contain a parenthesised access label.
    // In a clean temp directory the DB does not exist yet; the cache may or may not.
    // Either way we expect one of the known labels to appear.
    let known_labels = [
        "writable",
        "read-only!",
        "will be created",
        "dir not writable!",
    ];
    assert!(
        known_labels.iter().any(|l| stdout.contains(l)),
        "expected an access label in output:\n{stdout}"
    );
}