hen 0.17.0

Run protocol-aware API request collections from the command line or through MCP.
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
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
mod support;

use serde_json::Value;

use support::TestWorkspace;

fn assert_verify_failure(
    source: &str,
    expected_message: &str,
    expected_location: &str,
    expected_excerpt: &str,
) {
    let workspace = TestWorkspace::new();
    workspace.write_file("collection.hen", source);

    let output = workspace.run_hen(["verify", "collection.hen"]);

    assert_eq!(output.status_code, 1, "stderr: {}", output.stderr);
    assert!(output.stdout.is_empty(), "stdout: {}", output.stdout);
    assert!(
        output.stderr.contains(expected_message),
        "stderr: {}",
        output.stderr
    );
    assert!(
        output.stderr.contains(expected_location),
        "stderr: {}",
        output.stderr
    );
    assert!(
        output.stderr.contains(expected_excerpt),
        "stderr: {}",
        output.stderr
    );
}

#[test]
fn verify_reports_requests_and_required_inputs() {
    let workspace = TestWorkspace::new();
    workspace.write_file(
        "fragments/imported.hen",
        r#"Imported request

POST https://example.com/imported/[[ token ]]
"#,
    );
    workspace.write_file(
        "collection.hen",
        r#"Verify Fixture

Verifies imported requests.

? region = [[ region = us-east-1 ]]

---

Root request

GET https://example.com/root

---

<< fragments/imported.hen
"#,
    );

    let output = workspace.run_hen(["verify", "collection.hen"]);

    assert_eq!(output.status_code, 0, "stderr: {}", output.stderr);
    assert!(
        output.stdout.contains("Verification passed"),
        "stdout: {}",
        output.stdout
    );
    assert!(
        output.stdout.contains("[0] GET https://example.com/root"),
        "stdout: {}",
        output.stdout
    );
    assert!(
        output
            .stdout
            .contains("[1] POST https://example.com/imported/[[ token ]]"),
        "stdout: {}",
        output.stdout
    );
    assert!(
        output.stdout.contains("Required inputs"),
        "stdout: {}",
        output.stdout
    );
    assert!(output.stdout.contains("token"), "stdout: {}", output.stdout);
    assert!(
        output.stdout.contains("region (default: us-east-1)"),
        "stdout: {}",
        output.stdout
    );
    assert!(output.stderr.is_empty(), "stderr: {}", output.stderr);
}

#[test]
fn verify_reports_available_environments() {
        let workspace = TestWorkspace::new();
        workspace.write_file(
                "collection.hen",
                r#"name = Environment Verify Fixture

$ API_ORIGIN = https://api.example.com

env local
    $ API_ORIGIN = http://localhost:3000

env staging
    $ API_ORIGIN = https://staging.example.com

---

Get profile

GET {{ API_ORIGIN }}/profile
"#,
        );

        let output = workspace.run_hen(["verify", "collection.hen"]);

        assert_eq!(output.status_code, 0, "stderr: {}", output.stderr);
        assert!(output.stdout.contains("Available environments"), "stdout: {}", output.stdout);
        assert!(output.stdout.contains("local"), "stdout: {}", output.stdout);
        assert!(output.stdout.contains("staging"), "stdout: {}", output.stdout);
}

#[test]
fn verify_outputs_json_report_with_available_environments() {
        let workspace = TestWorkspace::new();
        workspace.write_file(
                "collection.hen",
                r#"name = Environment Verify Fixture

$ API_ORIGIN = https://api.example.com

env local
    $ API_ORIGIN = http://localhost:3000

---

Get profile

GET {{ API_ORIGIN }}/profile
"#,
        );

        let output = workspace.run_hen(["verify", "collection.hen", "--output", "json"]);

        assert_eq!(output.status_code, 0, "stderr: {}", output.stderr);
        let parsed: Value = serde_json::from_str(&output.stdout).expect("stdout should be valid json");
        assert_eq!(parsed["availableEnvironments"][0], "local");
}

#[test]
fn verify_outputs_http_session_name_in_protocol_context() {
    let workspace = TestWorkspace::new();
    workspace.write_file(
        "collection.hen",
        r#"HTTP Session Verify Fixture

---

Login

session = web
POST https://example.com/login

^ & status == 200

---

Load profile

session = web
GET https://example.com/profile

^ & status == 200
"#,
    );

    let output = workspace.run_hen(["verify", "collection.hen", "--output", "json"]);

    assert_eq!(output.status_code, 0, "stderr: {}", output.stderr);
    let parsed: Value = serde_json::from_str(&output.stdout).expect("stdout should be valid json");
    assert_eq!(parsed["requests"][0]["protocol"], "http");
    assert_eq!(parsed["requests"][0]["protocolContext"]["sessionName"], "web");
    assert_eq!(parsed["requests"][1]["protocol"], "http");
    assert_eq!(parsed["requests"][1]["protocolContext"]["sessionName"], "web");
}

#[test]
fn verify_outputs_oauth_auth_profile_in_protocol_context() {
    let workspace = TestWorkspace::new();
    workspace.write_file(
        "collection.hen",
        r#"name = OAuth Verify Fixture

oauth api
  grant = client_credentials
  issuer = https://login.example.com
  client_id = secret.env("CLIENT_ID")
  client_secret = secret.env("CLIENT_SECRET")
  access_token -> $API_ACCESS_TOKEN

---

Get profile

auth = api
GET https://example.com/profile
"#,
    );

    let output = workspace.run_hen(["verify", "collection.hen", "--output", "json"]);

    assert_eq!(output.status_code, 0, "stderr: {}", output.stderr);
    let parsed: Value = serde_json::from_str(&output.stdout).expect("stdout should be valid json");
    assert_eq!(parsed["requests"][0]["protocolContext"]["authProfile"], "api");
}

#[test]
fn verify_rejects_unknown_oauth_profile_reference() {
    assert_verify_failure(
        r#"name = Unknown OAuth Fixture

oauth api
  grant = client_credentials
  issuer = https://login.example.com
  client_id = secret.env("CLIENT_ID")
  client_secret = secret.env("CLIENT_SECRET")

---

Get profile

auth = missing
GET https://example.com/profile
"#,
    "request references unknown OAuth profile 'missing'",
    "9:1",
        "auth = missing",
    );
}

#[test]
fn verify_does_not_execute_shell_substitutions() {
    let workspace = TestWorkspace::new();
    workspace.write_file(
        "collection.hen",
        r#"Shell Verify

$ shell_value = $(touch side-effect.txt)

---

Shell request

GET https://example.com/{{ shell_value }}
"#,
    );

    let output = workspace.run_hen(["verify", "collection.hen"]);

    assert_eq!(output.status_code, 0, "stderr: {}", output.stderr);
    assert!(
        !workspace.root().join("side-effect.txt").exists(),
        "verify executed a shell substitution"
    );
}

#[test]
fn verify_accepts_local_secret_references_without_loading_them() {
    let workspace = TestWorkspace::new();
    workspace.write_file(
        "collection.hen",
        r#"name = Secret Verify Fixture

$ API_TOKEN = secret.env("HEN_TEST_VERIFY_TOKEN")
$ CLIENT_ID = secret.file("./missing/client_id.txt")

---

Get profile

GET https://example.com/profile

* Authorization = Bearer {{ API_TOKEN }}
* X-Client-Id = {{ CLIENT_ID }}
"#,
    );

    let output = workspace.run_hen(["verify", "collection.hen"]);

    assert_eq!(output.status_code, 0, "stderr: {}", output.stderr);
    assert!(output.stdout.contains("Verification passed"), "stdout: {}", output.stdout);
}

#[test]
fn verify_rejects_unsupported_secret_provider() {
    assert_verify_failure(
        r#"name = Unsupported Secret Provider Fixture

$ API_TOKEN = secret.keychain("service/account")

---

Get profile

GET https://example.com/profile
"#,
        "unsupported provider 'keychain'",
    "2:1",
        "$ API_TOKEN = secret.keychain(\"service/account\")",
    );
}

#[test]
fn verify_accepts_websocket_authoring_slice() {
    let workspace = TestWorkspace::new();
    workspace.write_file(
        "collection.hen",
        r#"WebSocket Verify

---

Open socket

protocol = ws
session = chat
GET wss://example.com/chat

---

Send hello

session = chat
~~~json
{"type":"hello"}
~~~

---

Receive reply

session = chat
receive
within = 2s
"#,
    );

    let output = workspace.run_hen(["verify", "collection.hen"]);

    assert_eq!(output.status_code, 0, "stderr: {}", output.stderr);
    assert!(
        output.stdout.contains("[0] GET wss://example.com/chat"),
        "stdout: {}",
        output.stdout
    );
    assert!(
        output.stdout.contains("[1] GET wss://example.com/chat"),
        "stdout: {}",
        output.stdout
    );
    assert!(
        output.stdout.contains("[2] GET wss://example.com/chat"),
        "stdout: {}",
        output.stdout
    );
}

#[test]
fn verify_accepts_websocket_exchange_authoring_slice() {
    let workspace = TestWorkspace::new();
    workspace.write_file(
        "collection.hen",
        r#"WebSocket Exchange Verify

---

Open socket

protocol = ws
session = chat
GET wss://example.com/chat

---

Send hello

session = chat
within = 2s
~~~json
{"type":"hello"}
~~~
"#,
    );

    let output = workspace.run_hen(["verify", "collection.hen"]);

    assert_eq!(output.status_code, 0, "stderr: {}", output.stderr);
    assert!(
        output.stdout.contains("[0] GET wss://example.com/chat"),
        "stdout: {}",
        output.stdout
    );
    assert!(
        output.stdout.contains("[1] GET wss://example.com/chat"),
        "stdout: {}",
        output.stdout
    );
}

#[test]
fn verify_reports_parse_failures_without_running_requests() {
    let workspace = TestWorkspace::new();
    workspace.write_file(
        "collection.hen",
        r#"Broken Verify

---

Broken assertion

GET https://example.com

^ & body =~ /foo/
"#,
    );

    let output = workspace.run_hen(["verify", "collection.hen"]);

    assert_eq!(output.status_code, 1, "stderr: {}", output.stderr);
    assert!(output.stdout.is_empty(), "stdout: {}", output.stdout);
    assert!(output
        .stderr
        .contains("No valid operator found in assertion"));
}

#[test]
fn verify_reports_unknown_schema_reference_at_declaration_span() {
    assert_verify_failure(
        r#"name = Verify Unknown Reference
description = Ensure unknown schema references point at the owning declaration.

schema User {
  profile: Profile
}

---

Get user

GET https://example.com/users/1
"#,
        "User references unknown validation target Profile",
    "--> 3:1",
        "schema User {",
    );
}

#[test]
fn verify_reports_invalid_scalar_base_reference_at_declaration_span() {
    assert_verify_failure(
        r#"name = Verify Invalid Scalar Base
description = Ensure schema-backed scalar bases point at the scalar declaration.

schema User {
  id: UUID
}

scalar UserAlias = User

---

Get user

GET https://example.com/users/1
"#,
        "scalar UserAlias cannot use schema User as a scalar base",
    "--> 6:1",
        "scalar UserAlias = User",
    );
}

#[test]
fn verify_reports_unknown_schema_assertion_target_at_assertion_span() {
    assert_verify_failure(
        r#"name = Verify Unknown Assertion Target
description = Ensure schema assertions are validated during verify.

---

Get user

GET https://example.com/users/1

^ & body === MissingUser
"#,
        "Unknown schema validation target 'MissingUser'",
    "--> 6:1",
        "^ & body === MissingUser",
    );
}

#[test]
fn verify_reports_duplicate_declaration_names_at_second_declaration() {
    assert_verify_failure(
        r#"name = Verify Duplicate Declaration
description = Ensure duplicate declaration names point at the second definition.

schema User {
  id: UUID
}

scalar User = string

---

Get user

GET https://example.com/users/1
"#,
        "User is already defined",
    "--> 6:1",
        "scalar User = string",
    );
}

#[test]
fn verify_reports_reserved_name_redefinitions_at_declaration_span() {
    assert_verify_failure(
        r#"name = Verify Reserved Name
description = Ensure built-in names cannot be redefined.

scalar UUID = string

---

Get user

GET https://example.com/users/1
"#,
        "UUID is reserved and cannot be redefined",
    "--> 3:1",
        "scalar UUID = string",
    );
}

#[test]
fn verify_reports_invalid_scalar_predicate_combinations_at_declaration_span() {
    assert_verify_failure(
        r#"name = Verify Invalid Scalar Expression
description = Ensure invalid scalar base combinations point at the declaration.

scalar Broken = string & integer

---

Get user

GET https://example.com/users/1
"#,
        "scalar expressions can only declare one base type",
    "--> 3:17",
        "scalar Broken = string & integer",
    );
}

#[test]
fn verify_reports_misplaced_declarations_after_requests_begin() {
    assert_verify_failure(
        r#"name = Verify Misplaced Declaration
description = Ensure declarations after requests begin get a targeted error.

---

Get user

GET https://example.com/users/1

schema User {
  id: UUID
}
"#,
        "schema and scalar declarations must appear before the first ---",
    "--> 6:1",
        "schema User {",
    );
}