elvish/pkg/eval/builtin_fn_flow_test.go
Qi Xiao 9981b2a777 Reduce the flakiness of TestPeach with some random jitter.
There was a recent failure of the test that checks peach is
nondeterministic: https://github.com/elves/elvish/runs/2926941131

The failure can be reproduced reliably when setting GOMAXPROCS=1.
However, GitHub Action's Windows runner has two CPU cores, which means
GOMAXPROCS should be 2. Presumably, during that particular one, one of
the cores is occupied by another process, so Go had to run the
goroutines in order on one CPU core.

Go's time.Sleep yields the current goroutine and allow other scheduled
goroutines to run on the same thread. As a result, adding a random
jitter guarantees nondeterminism in execution order, even if only one
CPU core is available to execute threads.

Also run the nondeterminism check in an infinite loop.
2021-06-28 00:46:27 +01:00

90 lines
2.6 KiB
Go

package eval_test
import (
"testing"
. "src.elv.sh/pkg/eval"
. "src.elv.sh/pkg/eval/evaltest"
"src.elv.sh/pkg/eval/vals"
)
func TestRunParallel(t *testing.T) {
Test(t,
That(`run-parallel { put lorem } { echo ipsum }`).
Puts("lorem").Prints("ipsum\n"),
)
}
func TestEach(t *testing.T) {
Test(t,
That(`put 1 233 | each $put~`).Puts("1", "233"),
That(`echo "1\n233" | each $put~`).Puts("1", "233"),
That(`echo "1\r\n233" | each $put~`).Puts("1", "233"),
That(`each $put~ [1 233]`).Puts("1", "233"),
That(`range 10 | each [x]{ if (== $x 4) { break }; put $x }`).
Puts(0, 1, 2, 3),
That(`range 10 | each [x]{ if (== $x 4) { fail haha }; put $x }`).
Puts(0, 1, 2, 3).Throws(AnyError),
// TODO(xiaq): Test that "each" does not close the stdin.
)
}
func TestPeach(t *testing.T) {
// Testing the `peach` builtin is a challenge since, by definition, the order of execution is
// undefined.
Test(t,
// Verify the output has the expected values when sorted.
That(`range 5 | peach [x]{ * 2 $x } | order`).Puts(0, 2, 4, 6, 8),
// Test that the order of output does not necessarily match the order of
// input.
//
// Most of the time this effect can be observed without the need of any
// jitter, but if the system only has one CPU core to execute goroutines
// (which can happen even when GOMAXPROCS > 1), the scheduling of
// goroutines can become deterministic. The random jitter fixes that by
// forcing goroutines to yield the thread and allow other goroutines to
// execute.
That(`
var @in = (range 100)
while $true {
var @out = (all $in | peach [x]{ sleep (* (rand) 0.01); put $x })
if (not-eq $in $out) {
put $true
break
}
}
`).Puts(true),
// Verify that exceptions are propagated.
That(`peach [x]{ fail $x } [a]`).
Throws(FailError{"a"}, "fail $x ", "peach [x]{ fail $x } [a]"),
// Verify that `break` works by terminating the `peach` before the entire sequence is
// consumed.
That(`
var tot = 0
range 1 101 |
peach [x]{ if (== 50 $x) { break } else { put $x } } |
< (+ (all)) (+ (range 1 101))
`).Puts(true),
)
}
func TestFail(t *testing.T) {
Test(t,
That("fail haha").Throws(FailError{"haha"}, "fail haha"),
That("fn f { fail haha }", "fail ?(f)").Throws(
FailError{"haha"}, "fail haha ", "f"),
That("fail []").Throws(
FailError{vals.EmptyList}, "fail []"),
That("put ?(fail 1)[reason][type]").Puts("fail"),
That("put ?(fail 1)[reason][content]").Puts("1"),
)
}
func TestReturn(t *testing.T) {
Test(t,
That("return").Throws(Return),
// Use of return inside fn is tested in TestFn
)
}