elvish/pkg/buildinfo/buildinfo_test.go

package buildinfo

import (
	"fmt"
	"runtime"
	"runtime/debug"
	"testing"

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

var ThatElvish = progtest.ThatElvish

func TestProgram(t *testing.T) {
	progtest.Test(t, &Program{},
		ThatElvish("-version").WritesStdout(Value.Version+"\n"),
		ThatElvish("-version", "-json").WritesStdout(mustToJSON(Value.Version)+"\n"),

		ThatElvish("-buildinfo").WritesStdout(
			fmt.Sprintf(
				"Version: %v\nGo version: %v\n", Value.Version, Value.GoVersion)),
		ThatElvish("-buildinfo", "-json").WritesStdout(mustToJSON(Value)+"\n"),

		ThatElvish().ExitsWith(2).WritesStderr("internal error: no suitable subprogram\n"),
	)
}

var devVersionWithVariantTests = []struct {
	name        string
	next        string
	vcsOverride string
	buildInfo   *debug.BuildInfo
	variant     string
	want        string
}{
	{
		name: "no BuildInfo",
		next: "0.42.0",
		want: "0.42.0-dev.unknown",
	},
	{
		name:      "BuildInfo with Main.Version = (devel)",
		next:      "0.42.0",
		buildInfo: &debug.BuildInfo{Main: debug.Module{Version: "(devel)"}},
		want:      "0.42.0-dev.unknown",
	},
	{
		name:      "BuildInfo with non-empty Main.Version != (devel)",
		next:      "0.42.0",
		buildInfo: &debug.BuildInfo{Main: debug.Module{Version: "v0.42.0-dev.foobar"}},
		want:      "0.42.0-dev.foobar",
	},
	{
		name: "BuildInfo with VCS data from clean checkout",
		next: "0.42.0",
		buildInfo: &debug.BuildInfo{Settings: []debug.BuildSetting{
			{Key: "vcs.revision", Value: "1234567890123456"},
			{Key: "vcs.time", Value: "2022-04-01T23:59:58Z"},
			{Key: "vcs.modified", Value: "false"},
		}},
		want: "0.42.0-dev.0.20220401235958-123456789012",
	},
	{
		name: "BuildInfo with VCS data from dirty checkout",
		next: "0.42.0",
		buildInfo: &debug.BuildInfo{Settings: []debug.BuildSetting{
			{Key: "vcs.revision", Value: "1234567890123456"},
			{Key: "vcs.time", Value: "2022-04-01T23:59:58Z"},
			{Key: "vcs.modified", Value: "true"},
		}},
		want: "0.42.0-dev.0.20220401235958-123456789012-dirty",
	},
	{
		name: "BuildInfo with unknown VCS timestamp format",
		next: "0.42.0",
		buildInfo: &debug.BuildInfo{Settings: []debug.BuildSetting{
			{Key: "vcs.revision", Value: "1234567890123456"},
			{Key: "vcs.time", Value: "April First"},
			{Key: "vcs.modified", Value: "false"},
		}},
		want: "0.42.0-dev.unknown",
	},
	{
		name:        "vcsOverride",
		next:        "0.42.0",
		vcsOverride: "20220401235958-123456789012",
		want:        "0.42.0-dev.0.20220401235958-123456789012",
	},
	{
		name:    "variant",
		next:    "0.42.0",
		variant: "distro",
		want:    "0.42.0-dev.unknown+distro",
	},
}

func TestDevVersionWithVariant(t *testing.T) {
	for _, test := range devVersionWithVariantTests {
		t.Run(test.name, func(t *testing.T) {
			testutil.Set(t, &readBuildInfo,
				func() (*debug.BuildInfo, bool) {
					return test.buildInfo, test.buildInfo != nil
				})
			got := devVersionWithVariant(test.next, test.vcsOverride, test.variant)
			if got != test.want {
				t.Errorf("got %q, want %q", got, test.want)
			}
		})
	}
}

func TestValue(t *testing.T) {
	vals.TestValue(t, Value).
		Index("version", Value.Version).
		Index("go-version", runtime.Version())
}