choreo 0.13.0

DSL for BDD type testing.
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
use std::collections::HashMap;
use std::fmt;

// Represents the entire parsed test file
#[derive(Debug, Clone)]
pub struct TestSuite {
    pub statements: Vec<Statement>,
}

#[derive(Debug, PartialEq, Clone)]
pub enum TestState {
    Pending,
    Running,
    Passed,
    Failed(String),
    Skipped,
}

impl TestState {
    pub fn is_done(&self) -> bool {
        matches!(self, TestState::Passed | TestState::Failed(_))
    }

    pub fn is_failed(&self) -> bool {
        matches!(self, TestState::Failed(_))
    }
}

#[derive(Debug, Clone, PartialEq)]
pub enum ReportFormat {
    Json,
    Junit,
    None,
}

#[derive(Debug, Clone, PartialEq)]
pub struct Span {
    pub start: usize,
    pub end: usize,
    pub line: usize,
    pub column: usize,
}

#[derive(Debug, Clone, PartialEq)]
pub struct ScenarioSpan {
    pub name_span: Option<Span>,
    pub tests_span: Option<Span>,
    pub after_span: Option<Span>,
}

#[derive(Debug, Clone, PartialEq)]
pub struct SettingSpan {
    pub timeout_seconds_span: Option<Span>,
    pub report_path_span: Option<Span>,
    pub report_format_span: Option<Span>,
    pub shell_path_span: Option<Span>,
    pub stop_on_failure_span: Option<Span>,
    pub expected_failures_span: Option<Span>,
}

#[derive(Debug, Clone, PartialEq)]
pub struct TestSuiteSettings {
    pub timeout_seconds: u64,
    pub report_format: ReportFormat,
    pub report_path: String,
    pub stop_on_failure: bool,
    pub shell_path: Option<String>,
    pub expected_failures: usize,
    pub span: Option<Span>,
    pub setting_spans: Option<SettingSpan>,
}

impl Default for TestSuiteSettings {
    fn default() -> Self {
        Self {
            timeout_seconds: 60,
            report_format: ReportFormat::Json,
            report_path: "reports/".to_string(),
            stop_on_failure: false,
            shell_path: Option::from("/bin/sh".to_string()),
            expected_failures: 0,
            span: None,
            setting_spans: None,
        }
    }
}

#[derive(Debug, Clone, PartialEq)]
pub struct TestCase {
    pub name: String,
    pub description: String,
    pub given: Vec<GivenStep>,
    pub when: Vec<WhenStep>,
    pub then: Vec<ThenStep>,
    pub span: Option<Span>,
    pub testcase_spans: Option<TestCaseSpan>,
}

#[derive(Debug, Clone, PartialEq)]
pub struct TestCaseSpan {
    pub name_span: Option<Span>,
    pub description_span: Option<Span>,
    pub given_span: Option<Span>,
    pub when_span: Option<Span>,
    pub then_span: Option<Span>,
}

impl Default for TestCase {
    fn default() -> Self {
        Self {
            name: String::new(),
            description: String::new(),
            given: Vec::new(),
            when: Vec::new(),
            then: Vec::new(),
            span: None,
            testcase_spans: None,
        }
    }
}

/// Steps that can appear in a when block
#[derive(Debug, Clone, PartialEq)]
pub enum WhenStep {
    Action(Action),
    TaskCall(TaskCall),
}

/// Steps that can appear in a then block
#[derive(Debug, Clone, PartialEq)]
pub enum ThenStep {
    Condition(Condition),
    TaskCall(TaskCall),
}

// All possible top-level statements in a .chor file.
#[derive(Debug, Clone)]
pub enum Statement {
    SettingsDef(TestSuiteSettings),
    BackgroundDef(Vec<GivenStep>),
    EnvDef(Vec<String>),
    VarDef(String, Value),
    ActorDef(Vec<String>),
    FeatureDef(String),
    Scenario(Scenario),
    TestCase(TestCase),
    TaskDef(TaskDef),
}

/// A task definition - a reusable block of actions/conditions
#[derive(Debug, Clone, PartialEq)]
pub struct TaskDef {
    pub name: String,
    pub parameters: Vec<String>,
    pub body: Vec<TaskBodyItem>,
    pub span: Option<Span>,
}

/// Items that can appear in a task body
#[derive(Debug, Clone, PartialEq)]
pub enum TaskBodyItem {
    Action(Action),
    Condition(Condition),
}

/// Represents a task call with arguments
#[derive(Debug, Clone, PartialEq)]
pub struct TaskCall {
    pub name: String,
    pub arguments: Vec<TaskArg>,
}

/// Task argument can be a string, number, duration, or variable reference
#[derive(Debug, Clone, PartialEq)]
pub enum TaskArg {
    String(String),
    Number(i32),
    Duration(f32),
    VariableRef(String),
}

#[derive(Debug, Clone, PartialEq)]
pub struct ForeachBlock {
    pub loop_variable: String,
    pub array_variable: String,
    pub tests: Vec<TestCase>,
}

#[derive(Debug, Clone, PartialEq)]
pub enum ScenarioBodyItem {
    Test(TestCase),
    Foreach(ForeachBlock),
}

#[derive(Debug, Clone, PartialEq)]
pub struct Scenario {
    pub name: String,
    pub tests: Vec<TestCase>,
    pub body: Vec<ScenarioBodyItem>,
    pub after: Vec<WhenStep>,
    pub parallel: bool,
    pub span: Option<Span>,
    pub scenario_span: Option<ScenarioSpan>,
}

impl Default for Scenario {
    fn default() -> Self {
        Self {
            name: String::new(),
            tests: Vec::new(),
            body: Vec::new(),
            after: Vec::new(),
            parallel: false,
            span: None,
            scenario_span: None,
        }
    }
}

#[derive(Debug, Clone, PartialEq)]
pub enum GivenStep {
    Action(Action),
    Condition(Condition),
    TaskCall(TaskCall),
}

#[derive(Debug, Clone, PartialEq)]
pub enum StateCondition {
    HasSucceeded(String),
    CanStart,
}

// All possible conditions that can trigger a rule.
#[derive(Debug, Clone, PartialEq)]
pub enum Condition {
    // deprecated
    Wait {
        op: String,
        wait: f32,
    },
    // deprecated
    StateSucceeded {
        outcome: String,
    },
    State(StateCondition),
    // --- Terminal Conditions ---
    OutputContains {
        actor: String,
        text: String,
    },
    OutputNotContains {
        actor: String,
        text: String,
    },
    OutputMatches {
        actor: String,
        regex: String,
        capture_as: Option<String>,
    },
    LastCommandSucceeded,
    LastCommandFailed,
    LastCommandExitCodeIs(i32),
    StdoutIsEmpty,
    StderrIsEmpty,
    StderrContains(String),
    OutputStartsWith(String),
    OutputEndsWith(String),
    OutputEquals(String),
    // --- JSON Conditions ---
    OutputIsValidJson,
    JsonValueIsString {
        path: String,
    },
    JsonValueIsNumber {
        path: String,
    },
    JsonValueIsArray {
        path: String,
    },
    JsonValueIsObject {
        path: String,
    },
    JsonValueHasSize {
        path: String,
        size: usize,
    },
    JsonOutputHasPath {
        path: String,
    },
    JsonOutputAtEquals {
        path: String,
        value: Value,
    },
    JsonOutputAtIncludes {
        path: String,
        value: Value,
    },
    JsonOutputAtHasItemCount {
        path: String,
        count: i32,
    },
    // --- Filesystem Conditions ---
    FileExists {
        path: String,
    },
    DirExists {
        path: String,
    },
    DirDoesNotExist {
        path: String,
    },
    FileContains {
        path: String,
        content: String,
    },
    FileDoesNotExist {
        path: String,
    },
    FileIsEmpty {
        path: String,
    },
    FileIsNotEmpty {
        path: String,
    },
    // --- Web Conditions ---
    ResponseStatusIs(u16),
    ResponseStatusIsSuccess,
    ResponseStatusIsError,
    ResponseStatusIsIn(Vec<u16>),
    ResponseTimeIsBelow {
        duration: f32,
    },
    ResponseBodyContains {
        value: String,
    },
    ResponseBodyMatches {
        regex: String,
        capture_as: Option<String>,
    },
    ResponseBodyEqualsJson {
        expected: String,
        ignored: Vec<String>,
    },
    JsonBodyHasPath {
        path: String,
    },
    JsonPathEquals {
        path: String,
        expected_value: Value,
    },
    JsonPathCapture {
        path: String,
        capture_as: String,
    },
    // --- System Conditions ---
    ServiceIsRunning {
        name: String,
    },
    ServiceIsStopped {
        name: String,
    },
    ServiceIsInstalled {
        name: String,
    },
    PortIsListening {
        port: u16,
    },
    PortIsClosed {
        port: u16,
    },
}

// All possible actions that can be executed.
#[derive(Debug, Clone, PartialEq)]
pub enum Action {
    // --- System Actions ---
    Pause {
        duration: f32,
    },
    Log {
        message: String,
    },
    Timestamp {
        variable: String,
    },
    Uuid {
        variable: String,
    },
    // --- Terminal Actions ---
    Run {
        actor: String,
        command: String,
    },
    SetCwd {
        path: String,
    },
    // --- Filesystem Actions ---
    CreateFile {
        path: String,
        content: String,
    },
    CreateDir {
        path: String,
    },
    DeleteFile {
        path: String,
    },
    DeleteDir {
        path: String,
    },
    ReadFile {
        path: String,
        variable: Option<String>,
    },
    // --- Web Actions ---
    HttpSetHeader {
        key: String,
        value: String,
    },
    HttpClearHeader {
        key: String,
    },
    HttpClearHeaders,
    HttpSetCookie {
        key: String,
        value: String,
    },
    HttpClearCookie {
        key: String,
    },
    HttpClearCookies,
    HttpGet {
        url: String,
    },
    HttpPost {
        url: String,
        body: String,
    },
    HttpPut {
        url: String,
        body: String,
    },
    HttpPatch {
        url: String,
        body: String,
    },
    HttpDelete {
        url: String,
    },
}

impl Action {
    pub fn is_filesystem_creation(&self) -> bool {
        matches!(self, Self::CreateFile { .. } | Self::CreateDir { .. })
    }
}

// Primitive values.
#[derive(Debug, Clone, PartialEq)]
pub enum Value {
    String(String),
    Number(i32),
    Bool(bool),
    Array(Vec<Value>),
    Object(HashMap<String, Value>),
}

impl Value {
    pub fn as_string(&self) -> String {
        match self {
            Value::String(s) => s.clone(),
            Value::Number(n) => n.to_string(),
            Value::Bool(b) => b.to_string(),
            Value::Array(a) => a
                .iter()
                .map(Value::as_string)
                .collect::<Vec<_>>()
                .join(", "),
            Value::Object(_) => {
                // Serialize to compact JSON string for object representation
                match self.to_json_value() {
                    serde_json::Value::String(s) => s,
                    other => other.to_string(),
                }
            }
        }
    }

    fn to_json_value(&self) -> serde_json::Value {
        match self {
            Value::String(s) => serde_json::Value::String(s.clone()),
            Value::Number(n) => serde_json::Value::Number(serde_json::Number::from(*n)),
            Value::Bool(b) => serde_json::Value::Bool(*b),
            Value::Array(arr) => {
                let vec = arr.iter().map(|v| v.to_json_value()).collect();
                serde_json::Value::Array(vec)
            }
            Value::Object(map) => {
                let mut obj = serde_json::Map::new();
                for (k, v) in map {
                    obj.insert(k.clone(), v.to_json_value());
                }
                serde_json::Value::Object(obj)
            }
        }
    }
}

impl fmt::Display for Value {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        match self {
            Value::String(s) => write!(f, "{}", s),
            Value::Number(n) => write!(f, "{}", n),
            Value::Bool(b) => write!(f, "{}", b),
            Value::Array(arr) => {
                let items: Vec<String> = arr.iter().map(|v| v.to_string()).collect();
                write!(f, "[{}]", items.join(", "))
            }
            Value::Object(_) => {
                // Print compact JSON for objects
                let json = self.to_json_value();
                write!(f, "{}", json)
            }
        }
    }
}