src.elv.sh@v0.21.0-dev.0.20240515223629-06979efb9a2a/pkg/prog/prog_test.go

package prog_test

import (
	"errors"
	"fmt"
	"os"
	"testing"

	. "src.elv.sh/pkg/prog"
	"src.elv.sh/pkg/prog/progtest"
	"src.elv.sh/pkg/testutil"
)

var (
	Test       = progtest.Test
	ThatElvish = progtest.ThatElvish
)

func TestFlagHandling(t *testing.T) {
	Test(t, &testProgram{},
		ThatElvish("-bad-flag").
			ExitsWith(2).
			WritesStderrContaining("flag provided but not defined: -bad-flag\nUsage:"),
		// -h is treated as a bad flag
		ThatElvish("-h").
			ExitsWith(2).
			WritesStderrContaining("flag provided but not defined: -h\nUsage:"),

		ThatElvish("-help").
			WritesStdoutContaining("Usage: elvish [flags] [script]"),
	)
}

func TestLogFlag(t *testing.T) {
	testutil.InTempDir(t)
	Test(t, &testProgram{},
		ThatElvish("-log", "log").DoesNothing(),
		ThatElvish("-log", "bad/log").WritesStderrContaining("open bad/log:"),
	)

	_, err := os.Stat("log")
	if err != nil {
		t.Errorf("log file was not created: %v", err)
	}
}

func TestCustomFlag(t *testing.T) {
	Test(t, &testProgram{customFlag: true},
		ThatElvish("-flag", "foo").
			WritesStdout("-flag foo\n"),
	)
}

func TestSharedFlags(t *testing.T) {
	Test(t, &testProgram{sharedFlags: true},
		ThatElvish("-sock", "sock", "-db", "db", "-json").
			WritesStdout("-sock sock -db db -json true\n"),
	)
}

func TestSharedFlags_MultiplePrograms(t *testing.T) {
	Test(t,
		Composite(
			&testProgram{sharedFlags: true, returnErr: NextProgram()},
			&testProgram{sharedFlags: true}),
		ThatElvish("-sock", "sock", "-db", "db", "-json").
			WritesStdout("-sock sock -db db -json true\n"),
	)
}

func TestShowDeprecations(t *testing.T) {
	testutil.Set(t, &DeprecationLevel, 0)

	Test(t, &testProgram{},
		ThatElvish("-deprecation-level", "42").DoesNothing(),
	)

	if DeprecationLevel != 42 {
		t.Errorf("ShowDeprecations = %d, want 42", DeprecationLevel)
	}
}

func TestComposite(t *testing.T) {
	Test(t,
		Composite(
			&testProgram{returnErr: NextProgram()},
			&testProgram{writeOut: "program 2"}),
		ThatElvish().WritesStdout("program 2"),
	)
}

func TestComposite_NoSuitableSubprogram(t *testing.T) {
	Test(t,
		Composite(
			&testProgram{returnErr: NextProgram()},
			&testProgram{returnErr: NextProgram()}),
		ThatElvish().
			ExitsWith(2).
			WritesStderr("internal error: no suitable subprogram\n"),
	)
}

func TestComposite_RunsCleanupsIfAnyProgramIsRun(t *testing.T) {
	Test(t,
		Composite(
			&testProgram{returnErr: NextProgram(func(fds [3]*os.File) {
				fds[1].WriteString("program 1 cleanup\n")
			})},
			&testProgram{returnErr: NextProgram(func(fds [3]*os.File) {
				fds[1].WriteString("program 2 cleanup\n")
			})},
			&testProgram{writeOut: "program 3\n"}),
		ThatElvish().
			WritesStdout("program 3\nprogram 2 cleanup\nprogram 1 cleanup\n"),
	)
}

func TestComposite_RunsCleanupsEvenIfProgramReturnsError(t *testing.T) {
	Test(t,
		Composite(
			&testProgram{returnErr: NextProgram(func(fds [3]*os.File) {
				fds[1].WriteString("program 1 cleanup\n")
			})},
			&testProgram{returnErr: errors.New("program 2 error")}),
		ThatElvish().
			ExitsWith(2).
			WritesStderr("program 2 error\n").
			WritesStdout("program 1 cleanup\n"),
	)
}

func TestComposite_SkipsCleanupsIfAllProgramsReturnNextProgram(t *testing.T) {
	Test(t,
		Composite(
			&testProgram{returnErr: NextProgram(func(fds [3]*os.File) {
				fds[1].WriteString("program 1 cleanup\n")
			})},
			&testProgram{returnErr: NextProgram()}),
		ThatElvish().
			ExitsWith(2).
			WritesStderr("internal error: no suitable subprogram\n"),
	)
}

func TestComposite_PreferEarlierSubprogram(t *testing.T) {
	Test(t,
		Composite(
			&testProgram{writeOut: "program 1"},
			&testProgram{writeOut: "program 2"}),
		ThatElvish().WritesStdout("program 1"),
	)
}

func TestBadUsageError(t *testing.T) {
	Test(t,
		&testProgram{returnErr: BadUsage("lorem ipsum")},
		ThatElvish().ExitsWith(2).WritesStderrContaining("lorem ipsum\n"),
	)
}

func TestExitError(t *testing.T) {
	Test(t, &testProgram{returnErr: Exit(3)},
		ThatElvish().ExitsWith(3),
	)
}

func TestExitError_0(t *testing.T) {
	Test(t, &testProgram{returnErr: Exit(0)},
		ThatElvish().ExitsWith(0),
	)
}

type testProgram struct {
	writeOut    string
	returnErr   error
	customFlag  bool
	sharedFlags bool

	flag        string
	daemonPaths *DaemonPaths
	json        *bool
}

func (p *testProgram) RegisterFlags(f *FlagSet) {
	if p.customFlag {
		f.StringVar(&p.flag, "flag", "default", "a flag")
	}
	if p.sharedFlags {
		p.daemonPaths = f.DaemonPaths()
		p.json = f.JSON()
	}
}

func (p *testProgram) Run(fds [3]*os.File, args []string) error {
	if p.returnErr != nil {
		return p.returnErr
	}
	fds[1].WriteString(p.writeOut)
	if p.customFlag {
		fmt.Fprintf(fds[1], "-flag %s\n", p.flag)
	}
	if p.sharedFlags {
		fmt.Fprintf(fds[1], "-sock %s -db %s -json %v\n",
			p.daemonPaths.Sock, p.daemonPaths.DB, *p.json)
	}
	return nil
}