datadriven_test.go

// Copyright 2019 The Cockroach Authors.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//     http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
// implied. See the License for the specific language governing
// permissions and limitations under the License.

package datadriven

import (
	"bytes"
	"fmt"
	"io/ioutil"
	"math/rand"
	"os"
	"path/filepath"
	"reflect"
	"sort"
	"strings"
	"sync/atomic"
	"testing"
	"time"

	"github.com/pmezard/go-difflib/difflib"
)

func TestNewLineBetweenDirectives(t *testing.T) {
	RunTestFromString(t, `
# Some testing of sensitivity to newlines
foo
----
unknown command

bar
----
unknown command




bar
----
unknown command
`, func(t *testing.T, d *TestData) string {
		if d.Input != "sentence" {
			return "unknown command"
		}
		return ""
	})
}

func TestParseLine(t *testing.T) {
	RunTestFromString(t, `
parse
xx =
----
here: cannot parse directive at column 4: xx =

parse
xx a=b a=c
----
"xx" [a=b a=c]

parse
xx a=b b=c c=(1,2,3)
----
"xx" [a=b b=c c=(1, 2, 3)]
`, func(t *testing.T, d *TestData) string {
		cmd, args, err := ParseLine(d.Input)
		if err != nil {
			return fmt.Errorf("here: %w", err).Error()
		}
		return fmt.Sprintf("%q %+v", cmd, args)
	})
}

func TestSkip(t *testing.T) {
	RunTestFromString(t, `
skip
----

# This error should never happen.
error
----
`, func(t *testing.T, d *TestData) string {
		switch d.Cmd {
		case "skip":
			// Verify that calling t.Skip() does not fail with an API error on
			// testing.T.
			t.Skip("woo")
		case "error":
			// The skip should mask the error afterwards.
			t.Error("never reached")
		}
		return d.Expected
	})
}

func TestSubTest(t *testing.T) {
	RunTest(t, "testdata/subtest", func(t *testing.T, d *TestData) string {
		switch d.Cmd {
		case "hello":
			return d.CmdArgs[0].Key + " was said"
		case "skip":
			// Verify that calling t.Skip() does not fail with an API error on
			// testing.T.
			t.Skip("woo")
		case "error":
			// The skip should mask the error afterwards.
			t.Error("never reached")
		default:
			t.Fatalf("unknown directive: %s", d.Cmd)
		}
		return d.Expected
	})
}

func TestMultiLineTest(t *testing.T) {
	RunTest(t, "testdata/multiline", func(t *testing.T, d *TestData) string {
		switch d.Cmd {
		case "small":
			return `just
two lines of output`
		case "large":
			return `more
than
five
lines
of
output`
		default:
			t.Fatalf("unknown directive: %s", d.Cmd)
		}
		return d.Expected
	})
}

func TestRetry(t *testing.T) {
	var v atomic.Uint32
	RunTest(t, "testdata/retry", func(t *testing.T, d *TestData) string {
		switch d.Cmd {
		case "inc":
			n := 1
			d.MaybeScanArgs(t, "n", &n)
			for i := 0; i < n; i++ {
				go func() {
					time.Sleep(time.Duration(rand.Intn(10)) * time.Microsecond)
					v.Add(1)
				}()
			}
			return ""

		case "read":
			return d.Retry(t, func() string {
				return fmt.Sprint(v.Load())
			})

		default:
			t.Fatalf("unknown directive: %s", d.Cmd)
		}
		return d.Expected
	})
}

func TestDirective(t *testing.T) {
	RunTest(t, "testdata/directive", func(t *testing.T, d *TestData) string {
		var buf bytes.Buffer
		fmt.Fprintf(&buf, "cmd: %s\n%d arguments\n", d.Cmd, len(d.CmdArgs))
		for _, a := range d.CmdArgs {
			fmt.Fprintf(&buf, "key=%#v vals=%#v\n", a.Key, a.Vals)
		}
		return buf.String()
	})
}

func TestWalk(t *testing.T) {
	Walk(t, "testdata/walk", func(t *testing.T, path string) {
		RunTest(t, path, func(t *testing.T, d *TestData) string {
			return fmt.Sprintf("test name: %s\n", t.Name())
		})
	})
}

func TestRewrite(t *testing.T) {
	const testDir = "testdata/rewrite"
	files, err := ioutil.ReadDir(testDir)
	if err != nil {
		t.Fatal(err)
	}
	var tests []string
	for _, file := range files {
		if name := file.Name(); strings.HasSuffix(name, "-before") {
			tests = append(tests, strings.TrimSuffix(name, "-before"))
		} else if !strings.HasSuffix(name, "-after") {
			t.Fatalf("all files in %s must end in either -before or -after: %s", testDir, name)
		}
	}
	sort.Strings(tests)

	for _, test := range tests {
		subTest(t, test, func(t testing.TB) {
			path := filepath.Join(testDir, fmt.Sprintf("%s-before", test))
			file, err := os.OpenFile(path, os.O_RDONLY, 0644 /* irrelevant */)
			if err != nil {
				t.Fatal(err)
			}
			defer func() { _ = file.Close() }()

			// Implement a few simple directives.
			handler := func(t testing.TB, d *TestData) string {
				switch d.Cmd {
				case "noop":
					return d.Input

				case "duplicate":
					return fmt.Sprintf("%s\n%s", d.Input, d.Input)

				case "duplicate-with-blank":
					return fmt.Sprintf("%s\n\n%s", d.Input, d.Input)

				case "no-output":
					return ""

				default:
					t.Fatalf("unknown directive %s", d.Cmd)
					return ""
				}
			}

			rewriteData := runTestInternal(t, path, file, handler, true /* rewrite */)

			afterPath := filepath.Join(testDir, fmt.Sprintf("%s-after", test))
			if *rewriteTestFiles {
				// We are rewriting the rewrite tests. Dump the output into -after files
				out, err := os.Create(afterPath)
				defer func() { _ = out.Close() }()
				if err != nil {
					t.Fatal(err)
				}
				if _, err := out.Write(rewriteData); err != nil {
					t.Fatal(err)
				}
			} else {
				after, err := os.Open(afterPath)
				defer func() { _ = after.Close() }()
				if err != nil {
					t.Fatal(err)
				}
				expected, err := ioutil.ReadAll(after)
				if err != nil {
					t.Fatal(err)
				}

				if string(rewriteData) != string(expected) {
					linesExp := difflib.SplitLines(string(expected))
					linesActual := difflib.SplitLines(string(rewriteData))
					diff, err := difflib.GetUnifiedDiffString(difflib.UnifiedDiff{
						A: linesExp,
						B: linesActual,
					})
					if err != nil {
						t.Fatal(err)
					}
					t.Errorf("expected didn't match actual:\n%s", diff)
				}
			}
		})
	}
}

func TestMaybeScan_Noop(t *testing.T) {
	RunTestFromString(t, `
cmd
----
"", "", ""
`, func(t *testing.T, d *TestData) string {
		var x, y, z string
		d.MaybeScanArgs(t, "vals", &x, &y, &z)
		return fmt.Sprintf("%q, %q, %q", x, y, z)
	})
}

func TestScanArgsExpansion(t *testing.T) {
	RunTestFromString(t, `
cmd vals=(foo, bar, bax)
----
"foo", "bar", "bax"
`, func(t *testing.T, d *TestData) string {
		var x, y, z string
		d.ScanArgs(t, "vals", &x, &y, &z)
		return fmt.Sprintf("%q, %q, %q", x, y, z)
	})
}

func TestScanArgsSingle(t *testing.T) {
	checkScanEquivalence := func(d *TestData, dest1, dest2 interface{}) {
		d.ScanArgs(t, "vals", dest1)
		if _, ok := d.Arg("vals"); !ok {
			t.Fatal("`vals` argument not found by TestData.Arg")
		}
		if ok := d.MaybeScanArgs(t, "vals", dest2); !ok {
			t.Fatal("`vals` argument not found by TestData.MaybeScanArgs")
		}
		if !reflect.DeepEqual(dest1, dest2) {
			t.Fatalf("scanned values %#v and %#v are unequal", dest1, dest2)
		}
	}

	RunTestFromString(t, `
[]string vals=(foo, bar, bax)
----
[]string{"foo", "bar", "bax"}

[]int vals=(1, 2, 3, 4)
----
[]int{1, 2, 3, 4}

[]uint64 vals=(1, 2, 3, 4)
----
[]uint64{0x1, 0x2, 0x3, 0x4}

string vals=(foo)
----
"foo"

bool vals=true
----
true

float64 vals=1.1
----
1.1

[]float64 vals=(1.1, 2.2, 3.3, 4.4)
----
[]float64{1.1, 2.2, 3.3, 4.4}

time.Duration vals=10.0m
----
10m0s
	`, func(t *testing.T, d *TestData) string {
		switch d.Cmd {
		case "[]string":
			var dest1, dest2 []string
			checkScanEquivalence(d, &dest1, &dest2)
			return fmt.Sprintf("%#v", dest1)
		case "[]int":
			var dest1, dest2 []int
			checkScanEquivalence(d, &dest1, &dest2)
			return fmt.Sprintf("%#v", dest1)
		case "[]uint64":
			var dest1, dest2 []uint64
			checkScanEquivalence(d, &dest1, &dest2)
			return fmt.Sprintf("%#v", dest1)
		case "[]float64":
			var dest1, dest2 []float64
			checkScanEquivalence(d, &dest1, &dest2)
			return fmt.Sprintf("%#v", dest1)
		case "float64":
			var dest1, dest2 float64
			checkScanEquivalence(d, &dest1, &dest2)
			return fmt.Sprintf("%#v", dest1)
		case "time.Duration":
			var dest1, dest2 time.Duration
			checkScanEquivalence(d, &dest1, &dest2)
			return fmt.Sprintf("%s", dest1)
		case "string":
			var dest1, dest2 string
			checkScanEquivalence(d, &dest1, &dest2)
			return fmt.Sprintf("%#v", dest1)
		case "bool":
			var dest1, dest2 bool
			checkScanEquivalence(d, &dest1, &dest2)
			return fmt.Sprintf("%#v", dest1)
		default:
			return fmt.Sprintf("unrecognized type %s", d.Cmd)
		}
	})
}

func TestString(t *testing.T) {
	RunTest(t, "testdata/string", func(t *testing.T, d *TestData) string {
		return d.String()
	})
}

func BenchmarkInput(b *testing.B) {
	RunTestFromStringAny(b, `
foo
----
unknown command
`, func(t testing.TB, d *TestData) string {
		return "unknown command"
	})
}