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
|
package transcript_test
import (
"testing"
"src.elv.sh/pkg/testutil"
. "src.elv.sh/pkg/transcript"
"src.elv.sh/pkg/tt"
)
type Dir = testutil.Dir
var (
It = tt.It
Dedent = testutil.Dedent
)
func TestParseSessionsInFS(t *testing.T) {
tt.Test(t, ParseFromFS,
// How sessions are discovered, in both .elv and .elvts files.
It("scans .elv and .elvts files recursively, ignoring other files").
Args(Dir{
"d1": Dir{
"foo.elv": Dedent(`
# ~~~elvish-transcript
# ~> echo foo
# foo
# ~~~
fn x {|| }
`),
"ignored.txt": "",
},
"d2": Dir{
"bar.elvts": Dedent(`
~> echo bar
bar
`),
},
"ignored.go": "package a",
}).
Rets([]*Node{
{
"d1/foo.elv", nil, nil,
[]*Node{{
"x", nil, nil,
[]*Node{{"", nil, []Interaction{{"~> ", "echo foo", 2, 3, "foo\n", 3, 4}}, nil, 2, 4}},
1, 5}},
1, 5,
},
{"d2/bar.elvts", nil, []Interaction{{"~> ", "echo bar", 1, 2, "bar\n", 2, 3}}, nil, 1, 3},
}),
// .elv file-specific handling
It("extracts all elvish-transcript code blocks from .elv files").
Args(oneFile("a.elv", `
# ~~~elvish-transcript
# ~> f 1
# 1
# ~~~
#
# ~~~elvish-transcript
# ~> f 2
# 2
# ~~~
fn f {|| }
# ~~~elvish-transcript
# ~> echo $v
# foo
# ~~~
var v
`)).
Rets([]*Node{
{"a.elv", nil, nil,
[]*Node{
{"f", nil, nil, []*Node{
{"", nil, []Interaction{{"~> ", "f 1", 2, 3, "1\n", 3, 4}}, nil, 2, 4},
{"", nil, []Interaction{{"~> ", "f 2", 7, 8, "2\n", 8, 9}}, nil, 7, 9},
}, 1, 10},
{"$v", nil, nil, []*Node{
{"", nil, []Interaction{{"~> ", "echo $v", 13, 14, "foo\n", 14, 15}}, nil, 13, 15},
}, 12, 16},
},
1, 16},
}, error(nil)),
It("uses fields after elvish-transcript in session name in .elv files").
Args(oneFile("a.elv", `
# ~~~elvish-transcript title
# ~> echo foo
# foo
# ~~~
fn x {|| }
`)).
Rets([]*Node{
{"a.elv", nil, nil, []*Node{
{"x", nil, nil, []*Node{
{"title", nil, []Interaction{{"~> ", "echo foo", 2, 3, "foo\n", 3, 4}}, nil, 2, 4},
}, 1, 5},
}, 1, 5},
}),
It("supports file-level and symbol-level directives").
Args(oneFile("a.elv", `
#//file1
#//file2
#//symbol1
#//symbol2
# ~~~elvish-transcript title
# ~> echo foo
# foo
# ~~~
fn x {|| }
`)).
Rets([]*Node{
{"a.elv", []string{"file1", "file2"}, nil, []*Node{
{"x", []string{"symbol1", "symbol2"}, nil, []*Node{
{"title", nil, []Interaction{{"~> ", "echo foo", 7, 8, "foo\n", 8, 9}}, nil, 7, 9},
}, 6, 10},
}, 1, 10},
}),
It("processes each code block in .elv files like a .elvts file").
Args(oneFile("a.elv", `
# ~~~elvish-transcript
#
# ~> nop top
#
# # h1 #
#
# ~> nop h1
#
# ## h2 ##
# ~> nop h2
fn x { }
`)).
Rets([]*Node{{
"a.elv", nil, nil, []*Node{{
"x", nil, nil, []*Node{{
"", nil,
[]Interaction{{"~> ", "nop top", 3, 4, "", 4, 4}},
[]*Node{{
"h1", nil,
[]Interaction{{"~> ", "nop h1", 7, 8, "", 8, 8}},
[]*Node{{
"h2", nil,
[]Interaction{{"~> ", "nop h2", 10, 11, "", 11, 11}}, nil,
9, 11,
}},
5, 11,
}},
2, 11,
}},
1, 11,
}},
1, 11,
}}, error(nil)),
// Session splitting
It("strips leading and trailing newlines in sessions in .elvts files").
Args(oneFile("a.elvts", `
# h1 #
~> echo foo
foo
`)).
Rets([]*Node{{
"a.elvts", nil, nil,
[]*Node{{
"h1", nil,
[]Interaction{{"~> ", "echo foo", 4, 5, "foo\n", 5, 6}}, nil,
1, 8,
}},
1, 8,
}}),
It("organizes nodes into a tree").
Args(oneFile("a.elvts", `
~> nop top level
# section 1 #
~> nop in section 1
## subsection 1.1 ##
~> nop in subsection 1.1
## subsection 1.2 ##
~> nop in subsection 1.2
# section 2 #
~> nop in section 2
`)).
Rets([]*Node{{
"a.elvts", nil,
[]Interaction{{"~> ", "nop top level", 1, 2, "", 2, 2}},
[]*Node{
{
"section 1", nil,
[]Interaction{{"~> ", "nop in section 1", 4, 5, "", 5, 5}},
[]*Node{
{"subsection 1.1", nil, []Interaction{{"~> ", "nop in subsection 1.1", 7, 8, "", 8, 8}}, nil, 6, 9},
{"subsection 1.2", nil, []Interaction{{"~> ", "nop in subsection 1.2", 10, 11, "", 11, 11}}, nil, 9, 12},
},
3, 12,
},
{
"section 2", nil,
[]Interaction{{"~> ", "nop in section 2", 13, 14, "", 14, 14}}, nil,
12, 14,
},
},
1, 14,
}}, error(nil)),
It("ignores comment lines in .elvts files").
Args(oneFile("a.elvts", `
// some comment before code
~> echo foo; echo bar
// some comments before output
foo
// some comments inside output
bar
// some comments after output; note that the preceding empty
// lines is also stripped
`)).
Rets([]*Node{{
"a.elvts", nil,
[]Interaction{{"~> ", "echo foo; echo bar", 2, 3, "foo\nbar\n", 4, 7}}, nil,
1, 10,
}}),
It("errors if h2 appears before any h1 in .elvts files").
Args(oneFile("a.elvts", `
## h2 ##
`)).
Rets([]*Node(nil), errorWithMsg{"a.elvts:1: h2 before h1"}),
// How a single session is parsed into (REPL) cycles. Most of the code
// path is shared between .elv and .elvts files, so most of the cases
// below only test .elvts files.
It("supports cycles with multi-line code and output").
Args(oneFile("a.elvts", `
~> echo foo
echo bar
foo
bar
`)).
Rets([]*Node{{
"a.elvts",
nil,
[]Interaction{{"~> ", "echo foo\necho bar", 1, 3, "foo\nbar\n", 3, 5}},
nil,
1, 5,
}}),
It("supports multiple cycles").
Args(oneFile("a.elvts", `
~> echo foo
echo bar
foo
bar
~> echo lorem
echo ipsum
lorem
ipsum
`)).
Rets([]*Node{{
"a.elvts", nil,
[]Interaction{
{"~> ", "echo foo\necho bar", 1, 3, "foo\nbar\n", 3, 5},
{"~> ", "echo lorem\necho ipsum", 5, 7, "lorem\nipsum\n", 7, 9},
}, nil,
1, 9,
}}),
It("supports cycles with empty output").
Args(oneFile("a.elvts", `
~> nop
~> nop
`)).
Rets([]*Node{{
"a.elvts", nil,
[]Interaction{
{"~> ", "nop", 1, 2, "", 2, 2},
{"~> ", "nop", 2, 3, "", 3, 3},
}, nil,
1, 3,
}}),
It("supports more complex prompts").
Args(oneFile("a.elvts", `
~/foo> echo foo
foo
/opt/bar> echo bar
bar
`)).
Rets([]*Node{{
"a.elvts", nil,
[]Interaction{
{"~/foo> ", "echo foo", 1, 2, "foo\n", 2, 3},
{"/opt/bar> ", "echo bar", 3, 4, "bar\n", 4, 5},
}, nil,
1, 5,
}}),
It("supports directives").
Args(oneFile("a.elvts", `
//directive 1
// some comment and some empty lines
//directive 2
~> nop
`)).
Rets([]*Node{{
"a.elvts",
[]string{"directive 1", "directive 2"},
[]Interaction{{"~> ", "nop", 7, 8, "", 8, 8}}, nil,
1, 8,
}}),
It("errors when a session in a .elvts file doesn't start with a prompt").
Args(oneFile("a.elvts", `
something
~> echo foo
foo
`)).
Rets([]*Node(nil), errorWithMsg{"a.elvts:2: first non-comment line of a session doesn't have prompt"}),
It("errors when a session in a fn elvdoc in a .elv file doesn't start with a prompt").
Args(oneFile("a.elv", `
# ~~~elvish-transcript
# something
# ~~~
fn x { }
`)).
Rets([]*Node(nil), errorWithMsg{"a.elv:2: first non-comment line of a session doesn't have prompt"}),
It("errors when a session in a var elvdoc in a .elv file doesn't start with a prompt").
Args(oneFile("a.elv", `
# ~~~elvish-transcript
# something
# ~~~
var x
`)).
Rets([]*Node(nil), errorWithMsg{"a.elv:2: first non-comment line of a session doesn't have prompt"}),
)
}
func oneFile(name, content string) Dir { return Dir{name: Dedent(content)} }
type errorWithMsg struct{ msg string }
func (e errorWithMsg) Match(got tt.RetValue) bool {
if gotErr, ok := got.(error); ok {
return e.msg == gotErr.Error()
}
return false
}
|