redo_test.go

// Copyright 2014 Gyepi Sam. All rights reserved.
// Use of this source code is governed by a BSD-style
// license that can be found in the LICENSE file.

package redux

import (
	"bytes"
	"errors"
	"fmt"
	"io/ioutil"
	"os"
	"os/exec"
	"path/filepath"
	"regexp"
	"sort"
	"strings"
	"testing"
)

type Dir struct {
	root string
	path string
	t    *testing.T
}

func newDir(t *testing.T) (Dir, error) {
	s, err := ioutil.TempDir("", "redo-test-")
	return Dir{s, s, t}, err
}

func newDirAt(t *testing.T, dir string) (Dir, error) {
	d, err := newDir(t)
	if err != nil {
		return d, err
	}

	if len(dir) == 0 {
		return d, errors.New("newDir requires non-empty dir arg")
	}

	s := filepath.Join(d.path, dir)
	if err := os.MkdirAll(s, 0755); err != nil {
		return d, err
	}

	d.path = s

	return d, nil
}

func (dir Dir) newDirAt(s string) (Dir, error) {
	s = filepath.Join(dir.path, s)
	if err := os.MkdirAll(s, 0755); err != nil {
		return dir, err
	}
	return Dir{s, s, dir.t}, nil
}

func (dir Dir) Init() error {
	state := run(dir.t, exec.Command("redo-init", dir.path))
	if state.Err != nil {
		return state
	}
	return nil
}

func (dir Dir) Cleanup() {
	os.RemoveAll(dir.root)
}

func (dir Dir) Append(values ...string) string {
	s := make([]string, len(values)+1)
	s[0] = dir.path
	copy(s[1:], values)
	return filepath.Join(s...)
}

func (dir Dir) WriteFile(filename, content string) error {
	return ioutil.WriteFile(dir.Append(filename), []byte(content), 0655)
}

// A Script encapsulates an input, output, and the do file that generates one from the other.
type Script struct {
	Name       string // Names the test and, implicitly, the do file
	In         string // Input data for creating the output
	Out        string // Output data
	Command    string // Do script contents
	OutDir     string // Output file location
	DoFileName string // defaults to Name, but can be changed.
}

func echoScript(name, text string) *Script {
	return &Script{
		Name:    name,
		In:      text,
		Out:     text,
		Command: fmt.Sprintf("echo -n '%s'", quote(text)),
	}
}

type TestCases map[string]*Script

var Scripts = make(TestCases)

func (c TestCases) Add(name string) *Script {
	if len(name) == 0 {
		panic("TestCase missing name")
	}
	s := &Script{Name: name}
	c[s.Name] = s
	return s
}

func (c TestCases) Get(v string) Script {
	if s, ok := c[v]; ok {
		return *s
	}
	panic("Unknown test case: " + v)
}

func init() {
	var s *Script

	s = Scripts.Add("simple")
	s.In = "slippers,pumps,mules,sneakers,bowling shoes"
	words := strings.Split(s.In, ",")
	sort.Strings(words)
	s.Out = strings.Join(words, ",")
	s.Command = fmt.Sprintf("echo -n '%s'", quote(s.Out))

	s = Scripts.Add("allcaps")
	s.In = `
When to the sessions of sweet silent thought,
I summon up remembrance of things past,
I sigh the lack of many a thing I sought,
And with old woes new wail my dear time's waste:
`
	s.Out = strings.ToUpper(s.In)
	s.Command = fmt.Sprintf("echo -n '%s' | tr a-z A-Z", quote(s.In))

	s = Scripts.Add("fmt.txt")
	s.In = `I returned, and saw under the sun, that the race is not to the
swift, nor the battle to the strong, neither yet bread to the wise,
nor yet riches to men of understanding, nor yet favour to men of
skill; but time and chance happeneth to them all.`
	s.Out = `I returned, and saw under the sun, that the race is not to the
swift, nor
swift, the
swift, battle
swift, to
swift, the
swift, strong,
swift, neither
swift, yet
swift, bread
swift, to
swift, the
swift, wise,
nor yet riches to men of understanding, nor yet favour to men of
skill; but time and chance happeneth to them all.
`
	s.Command = fmt.Sprintf("fmt --width 10 --prefix swift, <<EOS\n%s\nEOS", s.In)

	s = Scripts.Add("uses-default.txt")
	s.In = `
Now is the winter of our discontent
Made glorious summer by this sun of York`
	s.Out = s.In
	s.DoFileName = "default.txt.do"
	s.Command = fmt.Sprintf("echo -n '%s'", quote(s.In))

	pears := strings.Split("Keiffer,Bosc,Moonglow,Bartlett,Magness,Seckel,Gorham,Anjou", ",")

	s = Scripts.Add("list")
	s.Out = strings.Join(pears, "\n")
	s.Command = fmt.Sprintf("echo -n '%s'", quote(s.Out))

	s = Scripts.Add("sorted-list")
	sort.Strings(pears)
	s.Out = strings.Join(pears, "\n") + "\n" //external sort adds a newline to every line.
	s.Command = `
redo-ifchange list
sort < list
`

	s = Scripts.Add("default-fail")
	s.DoFileName = "default.do"
	s.Command = "echo 'This script exists to fail and should be unreachable'; false"

	s = Scripts.Add("default-txt-fail")
	s.DoFileName = "default.txt.do"
	s.Command = "echo 'This script exists to fail and should be unreachable'; false"

	s = Scripts.Add("multiple-writes")
	s.Command = `
echo -n "writes to stdout"
echo -n "writes to file too!" > $3
`
	s = Scripts.Add("must-act")
	s.Command = `
    exit 0
    `
}

func quote(s string) string {
	return strings.Replace(s, "'", "'\\''", -1)
}

func (s Script) Write(dir string) error {
	return ioutil.WriteFile(filepath.Join(dir, s.GetDoFileName()), []byte(s.Command), os.ModePerm)
}

func (s Script) GetDoFileName() string {
	if len(s.DoFileName) > 0 {
		return s.DoFileName
	}
	return s.Name + ".do"
}

func (s Script) OutputFileName() string {
	return filepath.Join(s.OutDir, s.Name)
}

func (s Script) CheckOutput(t *testing.T, projectDir string) {
	CheckFileContent(t, filepath.Join(projectDir, s.OutputFileName()), s.Out)
}

func CheckFileContentf(t *testing.T, filepath, want, format string, args ...interface{}) {
	b, err := ioutil.ReadFile(filepath)
	if err != nil {
		t.Fatal(err)
	}
	got := string(b)

	if want != got {
		output := fmt.Sprintf("Mismatched content for %s.\nWANT:\n[%s]\nGOT:\n[%s]", filepath, want, got)
		if len(format) > 0 {
			output += fmt.Sprintf(format, args...)
		}
		t.Error(output)
	}
}

func CheckFileContent(t *testing.T, filepath, want string) {
	CheckFileContentf(t, filepath, want, "")
}

func (s Script) Checks(t *testing.T, dir Dir) {
	s.CheckOutput(t, dir.path)
	checkMetadata(t, dir.Append(s.GetDoFileName()))
	checkMetadata(t, dir.Append(s.OutputFileName()))
	checkPrerequisites(t, dir.Append(s.OutputFileName()), s.GetDoFileName())
}

type Result struct {
	Command string
	Stdout  string
	Stderr  string
	Err     error
}

func (r Result) String() string {
	out := make([]string, 3)

	out = append(out, "Result: {\n")
	out = append(out, fmt.Sprintf("Command: %s\n", r.Command))

	if len(r.Stdout) > 0 {
		out = append(out, fmt.Sprintf("Stdout:\n%s\n", r.Stdout))
	}

	if len(r.Stderr) > 0 {
		out = append(out, fmt.Sprintf("Stderr:\n%s\n", r.Stderr))
	}

	if r.Err != nil {
		out = append(out, fmt.Sprintf("Error:\n%s\n", r.Err))
	}

	out = append(out, "}")

	return strings.Join(out, "")
}

func (r Result) Error() string {
	return r.String()
}

func run(t *testing.T, cmd *exec.Cmd) Result {

	so, se := new(bytes.Buffer), new(bytes.Buffer)
	cmd.Stdout, cmd.Stderr = so, se

	result := Result{Command: fmt.Sprintf("%s %s", cmd.Path, strings.Join(cmd.Args, " "))}

	result.Err = cmd.Run()

	result.Stdout, result.Stderr = so.String(), se.String()

	if testing.Verbose() {
		t.Log(result.String())
	}
	return result
}

func (dir Dir) Command(target Script, scripts ...Script) *exec.Cmd {

	t := dir.t

	err := dir.Init()
	if err != nil {
		t.Fatal(err)
	}

	err = target.Write(dir.path)
	if err != nil {
		t.Fatal(err)
	}

	for _, script := range scripts {
		err := script.Write(dir.path)
		if err != nil {
			t.Fatal(err)
		}
	}

	cmdArgs := []string{}
	if testing.Verbose() {
		cmdArgs = append(cmdArgs, "-verbose")
	}
	cmdArgs = append(cmdArgs, target.Name)
	binary := "redo"
	if s := os.Getenv("REDO_BIN"); len(s) > 0 {
		binary = s
	}
	cmd := exec.Command(binary, cmdArgs...)

	cmd.Dir = dir.path

	return cmd
}

func (dir Dir) Run(target Script, scripts ...Script) Result {
	return run(dir.t, dir.Command(target, scripts...))
}

func checkFileMetadata(t *testing.T, path string, m0 *Metadata) {
	f, err := NewFile("", path)
	if err != nil {
		t.Fatal(err)
	}

	m1, err := f.NewMetadata()
	if err != nil {
		t.Fatal(err)
	} else if m1 == nil {
		t.Fatalf("Missing file (for metadata): " + path)
	}

	if !m1.Equal(m0) {
		t.Errorf("mismatched record and file metadata for %s", path)
	}
}

func checkMetadata(t *testing.T, path string) {
	f, err := NewFile("", path)
	if err != nil {
		t.Fatal(err)
	}

	m0, found, err := f.GetMetadata()
	if err != nil {
		t.Fatal(err)
	} else if !found {
		t.Fatalf("Missing record metadata for: " + path)
	}

	checkFileMetadata(t, path, &m0)
}

func checkPrerequisites(t *testing.T, source string, prerequisites ...string) {
	f, err := NewFile("", source)
	if err != nil {
		t.Fatal(err)
	}

	list, err := f.Prerequisites()
	if err != nil {
		t.Fatal(err)
	}

	paths := make(map[string]bool)

	for _, p := range list {
		paths[p.Path] = true
	}

	for _, path := range prerequisites {
		if _, ok := paths[path]; !ok {
			t.Errorf("File %s is missing prerequisite %s. Looked in %v", source, path, paths)
		}
	}
}

// File paths arguments should resolve correctly
func TestRedoArgs(t *testing.T) {

	testCases := []struct {
		Name string
		Dir  string
		Path string
	}{
		{"pwd_file", "$root", "$target"},
		{"pwd_relative_file", "$root", "./$target"},
		{"pwd_relative_path", "$dir", "$base/$target"},
		{"relative_path", "$dir", "./$base/$target"},
		{"indir_fullpath", "$root", "$root/$target"},
		{"outdir_fullpath", "/tmp", "$root/$target"},
	}

	s := Scripts.Get("allcaps")

	for _, v := range testCases {

		dir, err := newDirAt(t, v.Name)
		if err != nil {
			t.Fatal(err)
		}
		defer dir.Cleanup()

		expandfn := func(name string) string {
			switch name {
			case "root":
				return dir.path
			case "target":
				return s.Name
			case "dir":
				return filepath.Dir(dir.path)
			case "base":
				return filepath.Base(dir.path)
			}
			panic("Unknown expansion variable: " + name)
		}

		cmd := dir.Command(s)
		cmd.Dir = os.Expand(v.Dir, expandfn)

		// replace the target name arg with test case.
		for i, arg := range cmd.Args[1:] {
			if arg == s.Name {
				cmd.Args[i+1] = os.Expand(v.Path, expandfn)
				break
			}
		}

		t.Logf("cd %s && %s\n", cmd.Dir, strings.Join(cmd.Args, " "))

		result := run(t, cmd)
		if result.Err != nil {
			t.Errorf("%s: %s\n", v.Name, result)
			continue
		}

		s.Checks(t, dir)
	}
}

func CheckMatch(t *testing.T, pattern string, data string) {
	matched, err := regexp.Match(pattern, []byte(data))
	if err != nil {
		t.Fatalf("%s while matching pattern: %s", err, pattern)
	}
	if !matched {
		t.Errorf("Expected pattern [%s] to match message: [%s]", pattern, data)
	}
}

// Stuff that should fail..
func TestFailures(t *testing.T) {
	tests := []struct {
		script  Script
		pattern string
	}{
		// Simple failure
		{Scripts.Get("default-fail"), "exit status 1"},
		// A well behaved .do script does not write to both outputs.
		{Scripts.Get("multiple-writes"), "Error.+wrote to stdout and to file"},
		{Scripts.Get("must-act"), "no output or file activity"},
	}

	for _, test := range tests {
		dir, err := newDir(t)
		if err != nil {
			t.Fatal(err)
		}
		defer dir.Cleanup()

		result := dir.Run(test.script)

		if result.Err != nil {
			CheckMatch(t, test.pattern, result.Stderr)
		} else {
			t.Errorf("Expected script %s to fail", test.script.Name)
		}
	}
}

//build scripts in higher level directories should work.
func TestBuildScriptLevel(t *testing.T) {

	for _, testScript := range []Script{Scripts.Get("fmt.txt")} {
		for _, subdir := range []string{"", "1", "1/2", "1/2/3"} {
			for _, doFile := range []string{"default.do", "default.txt.do", testScript.GetDoFileName()} {
				dir, err := newDir(t)
				if err != nil {
					t.Fatal(err)
				}
				defer dir.Cleanup()

				s := testScript
				s.DoFileName = doFile
				s.OutDir = subdir
				cmd := dir.Command(s)
				if len(subdir) > 0 {
					cmd.Dir = dir.Append(subdir)
					err := os.MkdirAll(cmd.Dir, 0777)
					if err != nil {
						t.Fatal(err)
					}
				}

				result := run(t, cmd)
				if result.Err != nil {
					t.Errorf("%s %s %s: %s\n", dir.path, subdir, doFile, result)
					continue
				}

				s.Checks(t, dir)

			}
		}
	}
}

// This test for redo choosing  more specific build scripts over less specific ones.
// In this case, the less specific build scripts fail.
func TestScriptSelectionOrder(t *testing.T) {

	type passfail struct {
		Pass Script
		Fail Script
	}

	cases := []passfail{
		// choose target.ext.do over default.ext.do
		{Scripts.Get("fmt.txt"), Scripts.Get("default-txt-fail")},

		// choose target.ext.do over default.do
		{Scripts.Get("fmt.txt"), Scripts.Get("default-fail")},

		// choose target.do over default.do
		{Scripts.Get("allcaps"), Scripts.Get("default-fail")},

		// choose default.ext.do over default.do
		{Scripts.Get("uses-default.txt"), Scripts.Get("default-fail")},
	}

	ext := []string{"x", "a", "b", "c", "d"}

	p := Scripts.Get("allcaps")
	p.Name = strings.Join(ext, ".")

	for i := 0; i < len(ext); i++ {
		// choose file specific script over any default script.
		f := Scripts.Get("default-fail")

		f.Name = strings.Join(append([]string{"default"}, ext[i+1:]...), ".")

		cases = append(cases, passfail{p, f})

		// chose more specific default script over less specific one.
		d := p                        // copy of successful script
		d.DoFileName = f.Name + ".do" // writing to a default do script

		for j := i + 1; j < len(ext); j++ {
			f.Name = strings.Join(append([]string{"default"}, ext[j:]...), ".")
			cases = append(cases, passfail{d, f})
		}
	}

	for _, pair := range cases {
		dir, err := newDir(t)
		if err != nil {
			t.Fatal(err)
		}
		defer dir.Cleanup()

		result := dir.Run(pair.Pass, pair.Fail)
		if result.Err != nil {
			t.Errorf("%s: %s\n", dir.path, result)
			continue
		}

		pair.Pass.Checks(t, dir)
		// No need to check for failing script.
		// If it ran, Pass would fail!

	}
}

// Setup scripts and invoke the first one, which should produce expected output.
func SimpleTree(t *testing.T, scripts ...Script) {
	if len(scripts) == 0 {
		panic("SimpleTree requires at least one script argument")
	}

	dir, err := newDir(t)
	if err != nil {
		t.Fatal(err)
	}
	defer dir.Cleanup()
	first := scripts[0]
	var rest []Script
	if len(scripts) > 1 {
		rest = scripts[1:]
	}

	if result := dir.Run(first, rest...); result.Err != nil {
		t.Fatal(result)
	}
	first.Checks(t, dir)
}

// Basic Dependency -- redo-ifchange
func TestBasicDependency(t *testing.T) {
	dir, err := newDir(t)
	if err != nil {
		t.Fatal(err)
	}
	defer dir.Cleanup()

	sorted := Scripts.Get("sorted-list")
	list := Scripts.Get("list")

	for i := 0; i < 2; i++ {
		result := dir.Run(sorted, list)
		if result.Err != nil {
			t.Errorf("%s: %s\n", dir.path, result)
			break
		}

		sorted.Checks(t, dir)
		list.Checks(t, dir)

		// force source rebuilding
		if err := dir.WriteFile(list.OutputFileName(), "Break checksum and timestamp!"); err != nil {
			t.Fatal(err)
		}
	}
}

// Shared source prerequisite change should trigger ifchange event in all dependents.
// See:  https://github.com/gyepisam/redux/issues/6
func TestSharedPrerequisiteChange(t *testing.T) {
	dir, err := newDir(t)
	if err != nil {
		t.Fatal(err)
	}
	defer dir.Cleanup()

	files := []struct {
		name    string
		content string
	}{
		{"shared", ""},
		{"one.x", "one"},
		{"two.x", "two"},
		{"default.y.do", `s="${1%%.y}.x" && redo-ifchange shared $s && cat shared $s | tr a-z A-Z` + "\n"},
	}

	for i, word := range []string{"shared", "boom"} {
		// Write most files only once
		// Write the first file twice, each time with different content.
		files[0].content = word
		for _, f := range files {
			if err := dir.WriteFile(f.name, f.content); err != nil {
				t.Fatal(err)
			}
			if i == 1 {
				break
			}
		}

		result := dir.Run(Script{Name: "@all", Command: "redo-ifchange one.y two.y"})

		if result.Err != nil {
			t.Fatalf("%s: %s\n", dir.path, result)
			continue
		}

		// Each turn should produce a different output since the "shared" file changes each time
		// and all dependents "one.y" and "two.y" should update accordingly.
		for _, name := range []string{"one", "two"} {
			CheckFileContent(t, dir.Append(name+".y"), strings.ToUpper(word+name))
		}
	}
}

// Loop detection
func TestDetectLoop(t *testing.T) {

	dir, err := newDir(t)
	if err != nil {
		t.Fatal(err)
	}
	defer dir.Cleanup()

	m := func(name, cmd string) Script {
		return Script{Name: name, Command: cmd}
	}

	result := dir.Run(m(`@all`, `redo-ifchange tick`),
		m(`tick`, `redo-ifchange tock; date +%s`),
		m(`tock`, `redo-ifchange tick; date +%s`))

	if result.Err != nil {
		CheckMatch(t, "detected on pending target", result.Stderr)
	} else {
		t.Error("Expected script TestDetectLoop to fail")
	}
}

// The second argument to a do script depends
// on the extensions of the target and do files.
func TestArg2(t *testing.T) {
	tests := []struct {
		target string
		do     string
		arg2   string
	}{
		{`blenny`, `blenny.do`, `blenny`},
		{`blenny`, `default.do`, `blenny`},
		{`blenny.a`, `blenny.a.do`, `blenny.a`},
		{`blenny.a`, `default.a.do`, `blenny`},
		{`blenny.a`, `default.do`, `blenny.a`},
		{`blenny.a.b`, `blenny.a.b.do`, `blenny.a.b`},
		{`blenny.a.b`, `default.a.b.do`, `blenny`},
		{`blenny.a.b`, `default.b.do`, `blenny.a`},
		{`blenny.a.b`, `default.do`, `blenny.a.b`},
		{`blenny.a.b.c`, `blenny.a.b.c.do`, `blenny.a.b.c`},
		{`blenny.a.b.c`, `default.a.b.c.do`, `blenny`},
		{`blenny.a.b.c`, `default.b.c.do`, `blenny.a`},
		{`blenny.a.b.c`, `default.c.do`, `blenny.a.b`},
		{`blenny.a.b.c`, `default.do`, `blenny.a.b.c`},
	}

	for _, r := range tests {
		dir, err := newDir(t)
		if err != nil {
			t.Fatal(err)
		}

		entry := Script{Name: `@all`, Command: `redo-ifchange ` + r.target}
		subject := Script{Name: r.target, DoFileName: r.do, Command: `echo -n "arg1=$1;arg2=$2"`}

		result := dir.Run(entry, subject)
		if result.Err != nil {
			t.Fatalf("%v", result)
		}

		want := fmt.Sprintf("arg1=%s;arg2=%s", r.target, r.arg2)
		CheckFileContentf(t, dir.Append(r.target), want, "\n\nCreated by: %s", r.do)

		dir.Cleanup()
	}
}