elvish/pkg/eval/builtin_fn_flow_test.go

package eval_test

import (
	"fmt"
	"testing"

	. "src.elv.sh/pkg/eval"
	"src.elv.sh/pkg/testutil"

	"src.elv.sh/pkg/eval/errs"
	. "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"),
		That(`run-parallel { } { fail foo }`).Throws(FailError{"foo"}),
	)
}

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) { continue }; put $x }`).
			Puts(0, 1, 2, 3, 5, 6, 7, 8, 9),
		That(`range 10 | each {|x| if (== $x 4) { fail haha }; put $x }`).
			Puts(0, 1, 2, 3).Throws(FailError{"haha"}),
		// TODO(xiaq): Test that "each" does not close the stdin.
	)
}

func TestPeach(t *testing.T) {
	testTimeScale := fmt.Sprint(testutil.TestTimeScale())
	// 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),

		// Handling of "continue".
		That(`range 5 | peach {|x| if (== $x 2) { continue }; * 2 $x } | order`).
			Puts(0, 2, 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),

		// Test the parallelism of peach by observing its run time relative to
		// the run time of the function. Since the exact run time is subject to
		// scheduling differences, benchmark it multiple times and use the
		// fastest run time.

		// Unlimited workers: when scheduling allows, no two function runs are
		// serial. Best run time is between t and 2t, regardless of input size.
		That(`
				var t = (* 0.002 `+testTimeScale+`)
				var best-run = (benchmark &min-runs=5 &min-time=0 {
					range 6 | peach {|_| sleep $t }
				} &on-end={|metrics| put $metrics[min] })
				put $best-run
				< $t $best-run (* 2 $t)`).
			Puts(Anything, true),
		// 2 workers:
		//
		// - When scheduling allows, at least two function runs are parallel.
		//
		// - No more than two functions are parallel.
		//
		// Best run time is between (ceil(n/2) * t) and n*t, where n is the
		// input size.
		That(`
				var t = (* 0.002 `+testTimeScale+`)
				var best-run = (benchmark &min-runs=5 &min-time=0 {
					range 6 | peach &num-workers=2 {|_| sleep $t }
				} &on-end={|metrics| put $metrics[min] })
				put $best-run
				< (* 3 $t) $best-run (* 6 $t)`).
			Puts(Anything, true),

		// Invalid options are handled.
		That(`peach &num-workers=0 {|x| * 2 $x }`).Throws(errs.BadValue{
			What:   "peach &num-workers",
			Valid:  "exact positive integer or +inf",
			Actual: "0",
		}),
		That(`peach &num-workers=-2 {|x| * 2 $x }`).Throws(errs.BadValue{
			What:   "peach &num-workers",
			Valid:  "exact positive integer or +inf",
			Actual: "-2",
		}),
	)
}

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
	)
}

func TestDefer(t *testing.T) {
	Test(t,
		That("{ defer { put a }; put b }").Puts("b", "a"),
		That("defer { }").
			Throws(ErrorWithMessage("defer must be called from within a closure")),
		That("{ defer { fail foo } }").
			Throws(FailError{"foo"}, "fail foo ", "{ defer { fail foo } }"),
		That("{ defer {|x| } }").Throws(
			errs.ArityMismatch{What: "arguments",
				ValidLow: 1, ValidHigh: 1, Actual: 0},
			"defer {|x| } ", "{ defer {|x| } }"),
	)
}