git @ Cat's Eye Technologies Falderal / master tests / test-freestyle-format.markdown
master

Tree @master (Download .tar.gz)

test-freestyle-format.markdown @master — view rendered · raw · history · blame 

  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
Falderal Test: "freestyle" format for tests
-------------------------------------

This document tests the alternate ("freestyle") format for tests
introduced in the Falderal Literate Test Format version 0.11.  This
format allows the test body to consist entirely of un-prefixed text,
as long as it is written in a single indented block, and as long as
the final line(s) of the test begin with one of the prefixes
`=> ` or `==> ` or `===> ` or `?> ` or `??> `or `???> `.

    -> Functionality "Cat" is implemented by shell command "python3 cat.py"

    -> Tests for functionality "Cat"

Cat cats.

    meow
    => meow

    meow
    ==> meow

    meow
    ===> meow

There may be multiple final lines.

    purr
    prrr
    prreow
    ==> purr
    ==> prrr
    ==> prreow

The use of `==>` means that any text in the preceding lines that would,
in the previous format, be recognized as prefixes, are no longer recognized
as prefixes.

    | purr
    | prrr
    = prreow
    => | purr
    => | prrr
    => = prreow

    | purr
    + prrr
    ? prreow
    => | purr
    => + prrr
    => ? prreow

    purr
    -> prrr
    prreow
    ===> purr
    ===> -> prrr
    ===> prreow

Demonstrate error expectation (Intentional fail.)

    meow
    ?> woof

    meow
    ??> woof

    | meow
    ? rreoww
    ???> bow
    ???> wow

Freestyle-format tests can also contain input sections.

    -> Functionality "Silly Interpreter" is implemented by
    -> shell command "python3 silly-interpreter.py %(test-body-file)"

    -> Tests for functionality "Silly Interpreter"

    read x
    read y
    print y
    print x
    <= meow
    <= purr
    => purr
    => meow

    read x
    read y
    print y
    print x
    <== meow
    <== purr
    ==> purr
    ==> meow

    read x
    read y
    print y
    print x
    <=== meow
    <=== purr
    ===> purr
    ===> meow

The trick of re-using the previous test body with a different
test input if the test body is omitted doesn't work with
freestyle-format test input sections (i.e., this will fail.)

    <== zing
    <== zang
    ==> zang
    ==> zing