osp-cli 1.5.1

CLI and REPL for querying and managing OSP infrastructure data
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

use super::*;
use serde_json::json;

// Protects the end-to-end interaction of filter, sort, limit, and project on
// ordinary flat rows, which is the bread-and-butter pipeline shape in real use.
#[test]
fn flat_pipeline_filter_sort_limit_project_produces_ranked_subset() {
    let rows = vec![
        row(json!({"host": "alpha", "status": "active", "score": 30, "owner": "ops"})),
        row(json!({"host": "beta", "status": "active", "score": 10, "owner": "db"})),
        row(json!({"host": "gamma", "status": "disabled", "score": 5, "owner": "ops"})),
        row(json!({"host": "delta", "status": "active", "score": 20, "owner": "api"})),
    ];

    let output = run_rows_pipeline(rows, "F status=active | S score | L 2 | P host score owner");
    let OutputItems::Rows(rows) = output.items else {
        panic!("expected flat rows");
    };

    assert_eq!(
        rows,
        vec![
            row(json!({"host": "beta", "score": 10, "owner": "db"})),
            row(json!({"host": "delta", "score": 20, "owner": "api"})),
        ]
    );
}

// Protects composed fanout/filter/project/sort behavior on nested row data so
// nested arrays behave like real datasets instead of toy objects.
#[test]
fn nested_row_pipeline_fanout_filter_project_sort_preserves_selected_records() {
    let rows = vec![
        row(json!({
            "host": "alpha",
            "networks": [
                {"cidr": "10.0.0.0/24", "vlan": 120, "role": "prod"},
                {"cidr": "10.0.1.0/24", "vlan": 220, "role": "db"}
            ]
        })),
        row(json!({
            "host": "beta",
            "networks": [
                {"cidr": "10.0.2.0/24", "vlan": 250, "role": "prod"}
            ]
        })),
        row(json!({"host": "gamma"})),
    ];

    let output = run_rows_pipeline(rows, "P networks[] | F vlan>=200 | P cidr role | S cidr");
    let OutputItems::Rows(rows) = output.items else {
        panic!("expected flat rows");
    };

    assert_eq!(
        rows,
        vec![
            row(json!({"cidr": "10.0.1.0/24", "role": "db"})),
            row(json!({"cidr": "10.0.2.0/24", "role": "prod"})),
        ]
    );
}

// Protects grouped execution as a distinct mode: filtering after grouping must
// operate over member rows and aggregation must reflect the filtered members.
#[test]
fn grouped_pipeline_filter_then_aggregate_uses_member_rows_not_headers() {
    let rows = vec![
        row(json!({"dept": "sales", "env": "prod", "amount": 100})),
        row(json!({"dept": "sales", "env": "dev", "amount": 30})),
        row(json!({"dept": "eng", "env": "prod", "amount": 50})),
        row(json!({"dept": "eng", "env": "dev", "amount": 70})),
        row(json!({"dept": "support", "env": "dev", "amount": 40})),
    ];

    let output = run_rows_pipeline(
        rows,
        "G dept | F env=prod | A sum(amount) AS total | S dept",
    );
    let OutputItems::Groups(groups) = output.items else {
        panic!("expected grouped rows");
    };

    assert_eq!(groups.len(), 2);
    assert_eq!(groups[0].groups["dept"], json!("eng"));
    assert_eq!(groups[0].aggregates["total"], json!(50.0));
    assert_eq!(groups[1].groups["dept"], json!("sales"));
    assert_eq!(groups[1].aggregates["total"], json!(100.0));
}

// Protects the "no matches" end state for a composed pipeline so later stages
// do not invent rows or retain stale structure after an empty filter result.
#[test]
fn composed_pipeline_returns_clean_empty_rows_when_nothing_matches() {
    let rows = vec![
        row(json!({"host": "alpha", "status": "active", "score": 30})),
        row(json!({"host": "beta", "status": "active", "score": 10})),
        row(json!({"host": "gamma", "status": "disabled", "score": 5})),
    ];

    let output = run_rows_pipeline(rows, "F status=retired | S score | L 1 | P host");
    let OutputItems::Rows(rows) = output.items else {
        panic!("expected flat rows");
    };

    assert!(rows.is_empty());
}

// Protects the row/group seam by proving grouped summaries can be aggregated,
// collapsed back to rows, and then treated like ordinary row output.
#[test]
fn grouped_pipeline_can_collapse_back_to_ranked_summary_rows() {
    let rows = vec![
        row(json!({"dept": "sales", "amount": 70})),
        row(json!({"dept": "sales", "amount": 60})),
        row(json!({"dept": "eng", "amount": 50})),
        row(json!({"dept": "eng", "amount": 40})),
    ];

    let output = run_rows_pipeline(
        rows,
        "G dept | A sum(amount) AS total | Z | F total>120 | S dept | P dept total",
    );
    let OutputItems::Rows(rows) = output.items else {
        panic!("expected summary rows");
    };

    assert_eq!(rows, vec![row(json!({"dept": "sales", "total": 130.0}))]);
}

// Protects envelope preservation for nested row data: matching inside an object
// array must keep the matching parent object intact instead of flattening it to
// a scalar fragment.
#[test]
fn nested_document_like_rows_keep_parent_envelope_when_descendant_matches() {
    let rows = vec![row(json!({
        "title": "Deploy Reference",
        "footer": ["Generated from prod metadata"],
        "commands": [
            {
                "name": "deploy",
                "summary": "Roll out service",
                "owner": "platform"
            },
            {
                "name": "status",
                "summary": "Inspect rollout",
                "owner": "ops"
            }
        ]
    }))];

    let output = run_rows_pipeline(rows, "deploy | ? | L 1");
    let OutputItems::Rows(rows) = output.items else {
        panic!("expected flat rows");
    };

    assert_eq!(rows.len(), 1);
    assert_eq!(rows[0]["title"], json!("Deploy Reference"));
    assert_eq!(rows[0]["footer"], json!(["Generated from prod metadata"]));
    let commands = rows[0]["commands"].as_array().expect("commands array");
    assert_eq!(commands.len(), 1);
    assert_eq!(commands[0]["name"], json!("deploy"));
    assert_eq!(commands[0]["summary"], json!("Roll out service"));
    assert_eq!(commands[0]["owner"], json!("platform"));
}

// Protects mixed-structure handling in a realistic fanout/group pipeline: rows
// with missing or empty collections must not create phantom groups or null junk.
#[test]
fn mixed_structures_do_not_create_phantom_groups_after_fanout_pipeline() {
    let rows = vec![
        row(json!({
            "service": "api",
            "endpoints": [
                {"region": "eu", "enabled": true},
                {"region": "us", "enabled": false}
            ]
        })),
        row(json!({
            "service": "worker",
            "endpoints": [
                {"region": "us", "enabled": true}
            ]
        })),
        row(json!({"service": "cron", "endpoints": []})),
        row(json!({"service": "ops"})),
    ];

    let output = run_rows_pipeline(
        rows,
        "P endpoints[] | F enabled=true | G region | A count AS count | S region",
    );
    let OutputItems::Groups(groups) = output.items else {
        panic!("expected grouped rows");
    };

    assert_eq!(groups.len(), 2);
    assert_eq!(groups[0].groups["region"], json!("eu"));
    assert_eq!(groups[0].aggregates["count"], json!(1));
    assert_eq!(groups[1].groups["region"], json!("us"));
    assert_eq!(groups[1].aggregates["count"], json!(1));
}

// Protects negated path quick on ordinary rows: deleting one addressed array
// element must not also delete real sibling `null` values when the collection
// is compacted afterward.
#[test]
fn negated_path_quick_preserves_real_null_array_items() {
    let rows = vec![row(json!({
        "items": [null, {"name": "keep"}, {"name": "drop"}]
    }))];

    let output = run_rows_pipeline(rows, "!items[2]");
    let OutputItems::Rows(rows) = output.items else {
        panic!("expected flat rows");
    };

    assert_eq!(rows.len(), 1);
    assert_eq!(
        rows[0],
        row(json!({
            "items": [null, {"name": "keep"}]
        }))
    );
}

// Protects fuzzy quick as a filter rather than a ranking language: matched rows
// should keep source order even when one row is a "closer" fuzzy hit.
#[test]
fn fuzzy_quick_filters_rows_without_reordering_matches() {
    let rows = vec![
        row(json!({"name": "docter", "kind": "near"})),
        row(json!({"name": "doctor", "kind": "exact-word"})),
        row(json!({"name": "status", "kind": "miss"})),
    ];

    let output = run_rows_pipeline(rows, "%docter");
    let OutputItems::Rows(rows) = output.items else {
        panic!("expected flat rows");
    };

    assert_eq!(
        rows,
        vec![
            row(json!({"name": "docter", "kind": "near"})),
            row(json!({"name": "doctor", "kind": "exact-word"})),
        ]
    );
}

// Protects grouped-output metadata through the public output pipeline:
// grouped headers should stay intact, projections over member rows should not
// rewrite the grouped shape, and copy/unroll/value stages should preserve the
// grouped boundary instead of materializing generic top-level rows.
#[test]
fn grouped_output_pipeline_preserves_headers_and_group_shape() {
    let grouped = osp_cli::core::output_model::OutputResult {
        items: osp_cli::core::output_model::OutputItems::Groups(vec![
            osp_cli::core::output_model::Group {
                groups: json!({"team": "ops"}).as_object().cloned().expect("object"),
                aggregates: json!({"count": 2}).as_object().cloned().expect("object"),
                rows: vec![
                    row(json!({"uid": "alice", "roles": ["eng", "ops"]})),
                    row(json!({"uid": "bob", "roles": ["ops"]})),
                ],
            },
        ]),
        document: None,
        meta: Default::default(),
    };

    let passthrough = osp_cli::dsl::apply_output_pipeline(grouped.clone(), &["P uid".to_string()])
        .expect("projection should not rewrite grouped members into flat output");
    assert!(matches!(
        passthrough.items,
        osp_cli::core::output_model::OutputItems::Groups(_)
    ));
    assert_eq!(passthrough.meta.key_index, vec!["team", "count"]);
    assert!(passthrough.meta.grouped);

    let copied = osp_cli::dsl::apply_output_pipeline(grouped.clone(), &["Y".to_string()])
        .expect("copy should preserve grouped output");
    assert!(copied.meta.wants_copy);
    assert!(copied.meta.grouped);

    let values = osp_cli::dsl::apply_output_pipeline(grouped.clone(), &["VALUE uid".to_string()])
        .expect("value extraction should preserve grouped output");
    let osp_cli::core::output_model::OutputItems::Groups(value_groups) = values.items else {
        panic!("expected grouped output");
    };
    assert_eq!(
        value_groups[0]
            .rows
            .iter()
            .map(|row| row.get("value").cloned().expect("value"))
            .collect::<Vec<_>>(),
        vec![json!("alice"), json!("bob")]
    );

    let unrolled = osp_cli::dsl::apply_output_pipeline(grouped, &["U roles".to_string()])
        .expect("unroll should preserve grouped output");
    assert!(matches!(
        unrolled.items,
        osp_cli::core::output_model::OutputItems::Groups(_)
    ));
}