executable-stories 0.1.0

BDD story documentation for Rust tests
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

use executable_stories::Story;

#[test]
fn test_story_new() {
    let mut s = Story::new("test scenario").with_tags(&["tag1"]);
    s.given("a precondition");
    s.when("an action");
    s.then("an outcome");
    s.pass();
}

#[test]
fn test_story_with_and_but() {
    let mut s = Story::new("scenario with and/but");
    s.given("a precondition");
    s.and("another precondition");
    s.when("an action");
    s.then("an outcome");
    s.but("not this other outcome");
    s.pass();
}

#[test]
fn test_story_with_tickets() {
    let mut s = Story::new("ticketed scenario")
        .with_tags(&["smoke"])
        .with_tickets(&["JIRA-123", "JIRA-456"]);
    s.given("a setup");
    s.when("something happens");
    s.then("it works");
    s.pass();
}

#[test]
fn test_doc_methods() {
    let mut s = Story::new("test docs");
    s.given("something");
    s.note("a note");
    s.pass();
}

#[test]
fn test_doc_methods_on_steps() {
    let mut s = Story::new("docs on steps");
    s.given("a user exists");
    s.kv("user_id", serde_json::json!(42));
    s.when("the user logs in");
    s.code("request", "POST /login", Some("http"));
    s.then("login succeeds");
    s.link("docs", "https://example.com/auth");
    s.pass();
}

#[test]
fn test_story_level_docs() {
    let mut s = Story::new("story level docs");
    // Docs added before any step go to story-level
    s.note("this is a story-level note");
    s.given("something");
    s.pass();
}

#[test]
fn test_fail_without_pass() {
    // This story will record as "fail" because pass() is never called.
    let mut s = Story::new("failing scenario");
    s.given("a precondition");
    s.when("something goes wrong");
    // no s.pass() -- intentionally failing
    drop(s);
}