github.com/tilt-dev/tilt@v0.33.15-0.20240515162809-0a22ed45d8a0/internal/controllers/core/cmd/execer_test.go

package cmd

import (
	"context"
	"io"
	"os/exec"
	"runtime"
	"strings"
	"testing"
	"time"

	"github.com/stretchr/testify/assert"
	"github.com/stretchr/testify/require"

	"github.com/tilt-dev/tilt/internal/localexec"
	"github.com/tilt-dev/tilt/internal/testutils"
	"github.com/tilt-dev/tilt/internal/testutils/bufsync"
	"github.com/tilt-dev/tilt/internal/testutils/tempdir"
	"github.com/tilt-dev/tilt/pkg/logger"
	"github.com/tilt-dev/tilt/pkg/model"
)

func TestTrue(t *testing.T) {
	f := newProcessExecFixture(t)

	f.start("exit 0")

	f.assertCmdSucceeds()
}

func TestWorkdir(t *testing.T) {
	f := newProcessExecFixture(t)

	d := tempdir.NewTempDirFixture(t)

	cmd := "pwd"
	if runtime.GOOS == "windows" {
		cmd = "cd"
	}

	f.startWithWorkdir(cmd, d.Path())

	f.assertCmdSucceeds()
	f.assertLogContains(d.Path())
}

func TestSleep(t *testing.T) {
	f := newProcessExecFixture(t)

	cmd := "sleep 1"
	if runtime.GOOS == "windows" {
		// believe it or not, this is the idiomatic way to sleep on windows
		// https://www.ibm.com/support/pages/timeout-command-run-batch-job-exits-immediately-and-returns-error-input-redirection-not-supported-exiting-process-immediately
		cmd = "ping -n 1 127.0.0.1"
	}
	f.start(cmd)

	f.waitForStatus(Running)

	time.Sleep(time.Second)

	f.assertCmdSucceeds()
}

func TestShutdownOnCancel(t *testing.T) {
	if runtime.GOOS == "windows" {
		t.Skip("no bash on windows")
	}
	f := newProcessExecFixture(t)

	cmd := `
function cleanup()
{
  echo "cleanup time!"
  exit 1
}

trap cleanup EXIT
sleep 100
`
	f.start(cmd)
	f.cancel()

	time.Sleep(time.Second)
	f.waitForStatus(Done)
	f.assertLogContains("cleanup time")
}

func TestPrintsLogs(t *testing.T) {
	f := newProcessExecFixture(t)

	f.start("echo testing123456")
	f.assertCmdSucceeds()
	f.assertLogContains("testing123456")
}

func TestHandlesExits(t *testing.T) {
	f := newProcessExecFixture(t)

	f.start("exit 1")

	f.waitForError()
	f.assertLogContains("exited with exit code 1")
}

func TestStopsGrandchildren(t *testing.T) {
	if runtime.GOOS == "windows" {
		t.Skip("no bash on windows")
	}
	f := newProcessExecFixture(t)

	f.start("bash -c '(for i in $(seq 1 20); do echo loop$i; sleep 1; done)'")
	f.waitForStatus(Running)

	// wait until there's log output
	timeout := time.After(time.Second)
	for {
		if strings.Contains(f.testWriter.String(), "loop1") {
			break
		}
		select {
		case <-timeout:
			t.Fatal("never saw any process output")
		case <-time.After(20 * time.Millisecond):
		}
	}

	// cancel the context
	f.cancel()
	f.waitForStatus(Done)
}

func TestHandlesProcessThatFailsToStart(t *testing.T) {
	f := newProcessExecFixture(t)

	f.startMalformedCommand()
	f.waitForError()
	f.assertLogContains("failed to start: ")
}

func TestExecEmpty(t *testing.T) {
	f := newProcessExecFixture(t)

	f.start("")
	f.waitForError()
	f.assertLogContains("empty cmd")
}

func TestExecCmd(t *testing.T) {
	testCases := execTestCases()

	l := logger.NewLogger(logger.NoneLvl, io.Discard)

	for _, tc := range testCases {
		t.Run(tc.name, func(t *testing.T) {
			c, err := localexec.EmptyEnv().ExecCmd(tc.cmd, l)
			require.NoError(t, err)
			assertCommandEqual(t, tc.cmd, c)
		})
	}
}

type execTestCase struct {
	name string
	cmd  model.Cmd
}

func execTestCases() []execTestCase {
	// these need to appear as actual paths or exec.Command will attempt to resolve them
	// (their actual existence is irrelevant since they won't actually execute; similarly,
	// it won't matter that they're unix paths even on Windows)
	return []execTestCase{
		{"command only", model.Cmd{Argv: []string{"/bin/ls"}}},
		{"command array", model.Cmd{Argv: []string{"/bin/echo", "hi"}}},
		{"current working directory", model.Cmd{Argv: []string{"/bin/echo", "hi"}, Dir: "/foo"}},
		{"env", model.Cmd{Argv: []string{"/bin/echo", "hi"}, Env: []string{"FOO=bar"}}},
	}
}

func assertCommandEqual(t *testing.T, expected model.Cmd, actual *exec.Cmd) {
	t.Helper()
	assert.Equal(t, expected.Argv[0], actual.Path)
	assert.Equal(t, expected.Argv, actual.Args)
	assert.Equal(t, expected.Dir, actual.Dir)
	for _, e := range expected.Env {
		assert.Contains(t, actual.Env, e)
	}
}

type processExecFixture struct {
	t          *testing.T
	ctx        context.Context
	cancel     context.CancelFunc
	execer     *processExecer
	testWriter *bufsync.ThreadSafeBuffer
	statusCh   chan statusAndMetadata
}

func newProcessExecFixture(t *testing.T) *processExecFixture {
	execer := NewProcessExecer(localexec.EmptyEnv())
	execer.gracePeriod = time.Second
	testWriter := bufsync.NewThreadSafeBuffer()
	ctx, _, _ := testutils.ForkedCtxAndAnalyticsForTest(testWriter)
	ctx, cancel := context.WithCancel(ctx)

	ret := &processExecFixture{
		t:          t,
		ctx:        ctx,
		cancel:     cancel,
		execer:     execer,
		testWriter: testWriter,
	}

	t.Cleanup(ret.tearDown)
	return ret
}

func (f *processExecFixture) tearDown() {
	f.cancel()
}

func (f *processExecFixture) startMalformedCommand() {
	c := model.Cmd{Argv: []string{"\""}, Dir: "."}
	f.statusCh = f.execer.Start(f.ctx, c, f.testWriter)
}

func (f *processExecFixture) startWithWorkdir(cmd string, workdir string) {
	c := model.ToHostCmd(cmd)
	c.Dir = workdir
	f.statusCh = f.execer.Start(f.ctx, c, f.testWriter)
}

func (f *processExecFixture) start(cmd string) {
	f.startWithWorkdir(cmd, ".")
}

func (f *processExecFixture) assertCmdSucceeds() {
	f.waitForStatus(Done)
}

func (f *processExecFixture) waitForStatus(expectedStatus status) {
	deadlineCh := time.After(2 * time.Second)
	for {
		select {
		case sm, ok := <-f.statusCh:
			if !ok {
				f.t.Fatal("statusCh closed")
			}
			if expectedStatus == sm.status {
				return
			}
			if sm.status == Error {
				f.t.Error("Unexpected Error")
				return
			}
			if sm.status == Done {
				f.t.Error("Unexpected Done")
				return
			}
		case <-deadlineCh:
			f.t.Fatal("Timed out waiting for cmd sm")
		}
	}
}

func (f *processExecFixture) assertLogContains(s string) {
	require.Eventuallyf(f.t, func() bool {
		return strings.Contains(f.testWriter.String(), s)
	}, time.Second, 5*time.Millisecond, "log contains %q", s)
}

func (f *processExecFixture) waitForError() {
	f.waitForStatus(Error)
}