areev 1.9.2

Command-line interface for Areev, the embedded memory engine for AI agents.
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

//! `areev::pack` as a LIBRARY (#315): a Rust host installs an agent without
//! shipping and spawning the binary.
//!
//! The cases mirror `pack_smoke.rs`, run through the API with no subprocess —
//! which is the point: a service that provisions a memory per tenant had to
//! carry the `areev` binary in its image, spawn `pack install --format json`,
//! parse the stdout, and map string errors back to causes.

use areev::pack::{install_pack, validate_pack, InstallOptions, PackError};
use areev_cal::AreevFacade;
use areev_core::authz::{AUTHZ_NS, REL_PERMITS};
use areev_core::types::{Fact, Grain};
use areev_store::Areev;
use std::path::{Path, PathBuf};
use tempfile::TempDir;

fn write(dir: &Path, rel: &str, body: &str) {
    let p = dir.join(rel);
    if let Some(parent) = p.parent() {
        std::fs::create_dir_all(parent).unwrap();
    }
    std::fs::write(p, body).unwrap();
}

/// A minimal pack: one Definition, one manifest.
fn simple_pack(dir: &TempDir) -> PathBuf {
    let root = dir.path().join("pack");
    std::fs::create_dir_all(&root).unwrap();
    write(
        &root,
        "grains/010-tool.json",
        r#"{"type": "tool", "kind": "definition", "tool_name": "lookup",
            "tool_description": "look something up", "created_at": 500}"#,
    );
    write(
        &root,
        "pack.json",
        r#"{"pack": "demo", "version": "1.0.0", "namespace": "ap",
            "grains": ["grains/010-tool.json"]}"#,
    );
    root
}

#[test]
fn validate_opens_no_memory_at_all() {
    // Content addressing needs no store, so CI can check a pack without
    // provisioning one.
    let dir = TempDir::new().unwrap();
    let root = simple_pack(&dir);
    let r = validate_pack(&root).expect("valid");
    assert_eq!(r.pack, "demo");
    assert_eq!(r.version, "1.0.0");
    assert_eq!(r.namespace.as_deref(), Some("ap"));
    assert_eq!(r.grains.len(), 1);
    assert_eq!(r.grains[0].grain_type, "tool");
    assert_eq!(r.grains[0].hash.len(), 64);
    assert!(r.warnings.is_empty(), "{:?}", r.warnings);
}

#[test]
fn a_mismatched_expected_hash_returns_pck_e002_with_nothing_written() {
    let dir = TempDir::new().unwrap();
    let root = simple_pack(&dir);
    write(
        &root,
        "pack.json",
        r#"{"pack": "demo", "version": "1.0.0", "namespace": "ap",
            "grains": [{"file": "grains/010-tool.json",
                        "expected_hash": "00000000000000000000000000000000000000000000000000000000deadbeef"}]}"#,
    );
    let err = validate_pack(&root).unwrap_err();
    assert_eq!(err.code(), "PCK-E002", "{err}");
    match err {
        PackError::ExpectationMismatch { expected, built, .. } => {
            assert!(expected.starts_with("0000"), "{expected}");
            assert_eq!(built.len(), 64, "{built}");
        }
        other => panic!("wrong cause: {other}"),
    }

    // And an install of the same pack writes nothing.
    let m = Areev::open(dir.path().join("m.db").to_str().unwrap()).unwrap();
    let facade = AreevFacade::with_session(m, Some("ap".into()), None);
    let before = facade.with_store(|s| s.head_op_seq()).unwrap();
    let err = install_pack(&facade, &root, &InstallOptions::default()).unwrap_err();
    assert_eq!(err.code(), "PCK-E002", "{err}");
    let after = facade.with_store(|s| s.head_op_seq()).unwrap();
    assert_eq!(before, after, "a refused pack leaves the memory untouched");
}

#[test]
fn a_forward_grain_reference_returns_pck_e003() {
    let dir = TempDir::new().unwrap();
    let root = dir.path().join("pack");
    std::fs::create_dir_all(&root).unwrap();
    // The workflow names a tool that is listed AFTER it.
    write(
        &root,
        "grains/010-workflow.json",
        r#"{"type": "workflow", "nodes": ["step"], "bindings": {"step": "grain:tool"},
            "created_at": 600}"#,
    );
    write(
        &root,
        "grains/020-tool.json",
        r#"{"type": "tool", "id": "tool", "kind": "definition", "tool_name": "lookup",
            "tool_description": "x", "created_at": 500}"#,
    );
    write(
        &root,
        "pack.json",
        r#"{"pack": "demo", "version": "1.0.0", "namespace": "ap",
            "grains": ["grains/010-workflow.json", "grains/020-tool.json"]}"#,
    );
    let err = validate_pack(&root).unwrap_err();
    assert_eq!(err.code(), "PCK-E003", "{err}");
}

#[test]
fn install_runs_under_the_callers_bound_principal() {
    // The facade, not an owner store: a service installing on a tenant's
    // behalf is authorized like every other write.
    let dir = TempDir::new().unwrap();
    let root = simple_pack(&dir);
    let mut m = Areev::open(dir.path().join("m.db").to_str().unwrap()).unwrap();
    m.add(
        &Fact::new("user:installer", REL_PERMITS, "read ON ap")
            .namespace(AUTHZ_NS)
            .created_at(1_000),
    )
    .unwrap();
    let facade = AreevFacade::with_session(m, Some("ap".into()), None)
        .with_principal("user:installer")
        .unwrap();
    let before = facade.with_store(|s| s.head_op_seq()).unwrap();
    let err = install_pack(&facade, &root, &InstallOptions::default()).unwrap_err();
    assert!(err.to_string().contains("AUT-E001"), "{err}");
    assert_eq!(
        facade.with_store(|s| s.head_op_seq()).unwrap(),
        before,
        "a refused install leaves the op-log unchanged"
    );
}

#[test]
fn a_dry_run_reports_and_writes_nothing() {
    let dir = TempDir::new().unwrap();
    let root = simple_pack(&dir);
    let m = Areev::open(dir.path().join("m.db").to_str().unwrap()).unwrap();
    let facade = AreevFacade::with_session(m, Some("ap".into()), None);
    let before = facade.with_store(|s| s.head_op_seq()).unwrap();
    let r = install_pack(
        &facade,
        &root,
        &InstallOptions { dry_run: true, ..Default::default() },
    )
    .expect("dry run");
    assert_eq!(r.grains.len(), 1);
    assert_eq!(facade.with_store(|s| s.head_op_seq()).unwrap(), before);
}

#[test]
fn an_owner_install_writes_the_grains_at_the_validated_addresses() {
    let dir = TempDir::new().unwrap();
    let root = simple_pack(&dir);
    let validated = validate_pack(&root).unwrap();
    let m = Areev::open(dir.path().join("m.db").to_str().unwrap()).unwrap();
    let facade = AreevFacade::with_session(m, Some("ap".into()), None);
    let installed = install_pack(&facade, &root, &InstallOptions::default()).expect("install");
    assert_eq!(
        validated.grains[0].hash, installed.grains[0].hash,
        "validate describes install"
    );
    let h = areev_core::error::Hash::from_hex(&installed.grains[0].hash).unwrap();
    assert!(facade.with_store(|s| s.has(&h)).unwrap());
}

// ---------------------------------------------------------------------------
// #316 — manifest surface
// ---------------------------------------------------------------------------

#[test]
fn an_unknown_top_level_key_is_warned_not_dropped_in_silence() {
    let dir = TempDir::new().unwrap();
    let root = simple_pack(&dir);
    write(
        &root,
        "pack.json",
        r#"{"pack": "demo", "version": "1.0.0", "namespace": "ap",
            "templats": {"brief": "..."},
            "grains": ["grains/010-tool.json"]}"#,
    );
    let r = validate_pack(&root).expect("a misspelling warns, it does not refuse");
    assert!(
        r.warnings.iter().any(|w| w.contains("templats")),
        "the warning must name the key: {:?}",
        r.warnings
    );
}

#[test]
fn the_reserved_host_object_comes_back_verbatim_and_warns_about_nothing() {
    let dir = TempDir::new().unwrap();
    let root = simple_pack(&dir);
    write(
        &root,
        "pack.json",
        r#"{"pack": "demo", "version": "1.0.0", "namespace": "ap",
            "host": {"config_schema": {"type": "object"}, "fixtures": ["a"]},
            "grains": ["grains/010-tool.json"]}"#,
    );
    let r = validate_pack(&root).expect("valid");
    assert!(r.warnings.is_empty(), "`host` is reserved: {:?}", r.warnings);
    let host = r.host.expect("returned verbatim");
    assert_eq!(host["config_schema"]["type"], "object");
    assert_eq!(host["fixtures"][0], "a");
}

#[test]
fn an_evalset_in_a_pack_is_checked_the_way_eval_create_checks_one() {
    let dir = TempDir::new().unwrap();
    let root = dir.path().join("pack");
    std::fs::create_dir_all(&root).unwrap();
    // A case with neither `input` nor `expect` — `areev eval create` refuses
    // it, and `pack validate` used to address it cleanly.
    write(
        &root,
        "grains/010-evalset.json",
        r#"{"type": "fact", "subject": "evalset:gate", "relation": "mg:evalset",
            "object": "{\"name\":\"gate\",\"cases\":[{\"name\":\"a\"}]}",
            "namespace": "agent:harness", "created_at": 500}"#,
    );
    write(
        &root,
        "pack.json",
        r#"{"pack": "demo", "version": "1.0.0", "grains": ["grains/010-evalset.json"]}"#,
    );
    let err = validate_pack(&root).unwrap_err();
    assert_eq!(err.code(), "PCK-E001", "{err}");
    assert!(err.to_string().contains("expect"), "{err}");

    // A valid one addresses.
    write(
        &root,
        "grains/010-evalset.json",
        r#"{"type": "fact", "subject": "evalset:gate", "relation": "mg:evalset",
            "object": "{\"name\":\"gate\",\"cases\":[{\"name\":\"a\",\"input\":{\"q\":1},\"expect\":{\"equals\":{\"q\":1}}}]}",
            "namespace": "agent:harness", "created_at": 500}"#,
    );
    let r = validate_pack(&root).expect("a well-formed evalset validates");
    assert_eq!(r.grains.len(), 1);
}