pmg/internal/shim/system_test.go

package shim

import (
	"os"
	"path/filepath"
	"runtime"
	"testing"

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

func useSystemPaths(t *testing.T, dir string) {
	t.Helper()
	systemBinDirOverride = filepath.Join(dir, "bin")
	systemProfilePathOverride = filepath.Join(dir, "profile.d", "pmg.sh")
	systemExecutableOwnershipCheck = false

	// The go-build test binary is group-writable under a 002 umask, which the
	// executable validation rightly rejects. Point resolution at a crafted
	// 0755 binary so the manager validates a realistic path, not the harness.
	exe := filepath.Join(dir, "pmg")
	require.NoError(t, os.WriteFile(exe, []byte("#!/bin/sh\n"), 0o755))
	resolveExecutable = func() (string, error) { return exe, nil }

	t.Cleanup(func() {
		systemBinDirOverride = ""
		systemProfilePathOverride = ""
		systemExecutableOwnershipCheck = true
		resolveExecutable = currentExecutable
	})
}

func TestSystemShimManagerInstallAndRemove(t *testing.T) {
	root := t.TempDir()
	useSystemPaths(t, root)

	mgr, err := NewSystemShimManager()
	require.NoError(t, err)
	assert.True(t, mgr.config.SkipShellRc)
	assert.True(t, mgr.config.SystemProfile)
	assert.Equal(t, SystemBinDir(), mgr.GetBinDir())

	require.NoError(t, mgr.Install())
	assert.True(t, SystemShimsInstalled())
	assert.True(t, SystemProfileInstalled())

	npmShim := filepath.Join(SystemBinDir(), "npm")
	content, err := os.ReadFile(npmShim)
	require.NoError(t, err)
	assert.Contains(t, string(content), "export PMG_SHIM_PATH")
	assert.Contains(t, string(content), "pmg setup install")
	assert.Contains(t, string(content), "pmg setup remove")

	profile, err := os.ReadFile(SystemProfilePath())
	require.NoError(t, err)
	assert.Contains(t, string(profile), mgr.GetBinDir())
	assert.Contains(t, string(profile), systemProfileMarker)

	require.NoError(t, mgr.Install())
	profile2, err := os.ReadFile(SystemProfilePath())
	require.NoError(t, err)
	assert.Equal(t, string(profile), string(profile2))

	require.NoError(t, mgr.Remove())
	assert.False(t, SystemShimsInstalled())
	assert.False(t, SystemProfileInstalled())
	require.NoError(t, mgr.Remove())
}

func TestSystemShimManagerDoesNotTouchUserRc(t *testing.T) {
	root := t.TempDir()
	useSystemPaths(t, root)

	home := t.TempDir()
	bashrc := filepath.Join(home, ".bashrc")
	require.NoError(t, os.WriteFile(bashrc, []byte("# user bashrc\n"), 0o644))

	mgr, err := NewSystemShimManager()
	require.NoError(t, err)
	mgr.config.HomeDir = home
	require.NoError(t, mgr.Install())

	content, err := os.ReadFile(bashrc)
	require.NoError(t, err)
	assert.Equal(t, "# user bashrc\n", string(content))
}

func TestSystemShimsInstalledIgnoresUnmanagedFiles(t *testing.T) {
	root := t.TempDir()
	useSystemPaths(t, root)
	require.NoError(t, os.MkdirAll(SystemBinDir(), 0o755))
	require.NoError(t, os.WriteFile(filepath.Join(SystemBinDir(), "README"), []byte("not a shim"), 0o644))

	assert.False(t, SystemShimsInstalled())

	require.NoError(t, os.WriteFile(
		filepath.Join(SystemBinDir(), "npm"),
		[]byte("#!/bin/sh\n# PMG shim - do not edit, managed by pmg setup\n"),
		0o755,
	))
	assert.True(t, SystemShimsInstalled())
}

func TestWriteSystemProfileRepairsStalePath(t *testing.T) {
	root := t.TempDir()
	useSystemPaths(t, root)
	require.NoError(t, os.MkdirAll(filepath.Dir(SystemProfilePath()), 0o755))
	require.NoError(t, os.WriteFile(
		SystemProfilePath(),
		[]byte("# PMG system shims\nexport PATH=\"/stale/path:$PATH\"\n"),
		0o644,
	))

	binDir := filepath.Join(root, "custom-bin")
	require.NoError(t, writeSystemProfile(binDir))

	content, err := os.ReadFile(SystemProfilePath())
	require.NoError(t, err)
	assert.Contains(t, string(content), binDir)
	assert.NotContains(t, string(content), "/stale/path")
	assert.NotContains(t, string(content), SystemBinDir())
}

func TestValidateSystemExecutableRejectsPrivateBinary(t *testing.T) {
	systemExecutableOwnershipCheck = false
	t.Cleanup(func() { systemExecutableOwnershipCheck = true })

	privateDir := t.TempDir()
	privateExecutable := filepath.Join(privateDir, "pmg")
	require.NoError(t, os.WriteFile(privateExecutable, []byte("binary"), 0o700))

	err := validateSystemExecutable(privateExecutable)

	require.Error(t, err)
	assert.Contains(t, err.Error(), "not executable by all users")
}

func TestValidateSystemExecutableRejectsGroupWritable(t *testing.T) {
	systemExecutableOwnershipCheck = false
	t.Cleanup(func() { systemExecutableOwnershipCheck = true })

	dir := t.TempDir()
	path := filepath.Join(dir, "pmg")
	require.NoError(t, os.WriteFile(path, []byte("binary"), 0o755))
	require.NoError(t, os.Chmod(path, 0o775))

	err := validateSystemExecutable(path)

	require.Error(t, err)
	assert.Contains(t, err.Error(), "writable by group or others")
}

func TestValidateSystemExecutableRejectsNonRootOwner(t *testing.T) {
	if runtime.GOOS == "windows" {
		t.Skip("file ownership is not resolvable on Windows")
	}
	if os.Geteuid() == 0 {
		t.Skip("running as root: temp file is root-owned, so the owner check passes")
	}

	dir := t.TempDir()
	path := filepath.Join(dir, "pmg")
	require.NoError(t, os.WriteFile(path, []byte("binary"), 0o755))

	err := validateSystemExecutable(path)

	require.Error(t, err)
	assert.Contains(t, err.Error(), "must be owned by root")
}

func TestSystemShimBinaryResolvesInstalledPath(t *testing.T) {
	root := t.TempDir()
	useSystemPaths(t, root)

	exe := filepath.Join(root, "pmg")
	require.NoError(t, os.WriteFile(exe, []byte("#!/bin/sh\n"), 0o755))
	resolveExecutable = func() (string, error) { return exe, nil }

	mgr, err := NewSystemShimManager()
	require.NoError(t, err)
	require.NoError(t, mgr.Install())

	got, ok := SystemShimBinary()
	require.True(t, ok)
	assert.Equal(t, exe, got)
}

func TestSystemShimBinaryFalseWhenNoShims(t *testing.T) {
	root := t.TempDir()
	useSystemPaths(t, root)
	require.NoError(t, os.MkdirAll(SystemBinDir(), 0o755))

	_, ok := SystemShimBinary()
	assert.False(t, ok)
}

func TestParseShimPMGBinRoundTripsShellQuote(t *testing.T) {
	for _, path := range []string{"/usr/local/bin/pmg", "/opt/pmg dir/pmg", "/weird/o'brien/pmg"} {
		content := "#!/bin/sh\n" + shimScriptMarker + "\nPMG_BIN=" + shellQuote(path) + "\n"
		got, ok := parseShimPMGBin(content)
		require.True(t, ok, path)
		assert.Equal(t, path, got)
	}
}

func TestRequirePathSearchableByAll(t *testing.T) {
	if runtime.GOOS == "windows" {
		t.Skip("unix permission semantics")
	}

	t.Run("standard system path passes", func(t *testing.T) {
		// Only directories are inspected, so the file itself need not exist.
		assert.NoError(t, requirePathSearchableByAll("/usr/bin/pmg-does-not-exist"))
	})

	t.Run("non-searchable ancestor rejects", func(t *testing.T) {
		base := t.TempDir()
		require.NoError(t, os.Chmod(base, 0o700))
		sub := filepath.Join(base, "sub")
		require.NoError(t, os.MkdirAll(sub, 0o755))

		err := requirePathSearchableByAll(filepath.Join(sub, "pmg"))
		require.Error(t, err)
		assert.Contains(t, err.Error(), "not searchable by all users")
	})
}

func TestInstallValidatesExecutableAndRemoveDoesNot(t *testing.T) {
	root := t.TempDir()
	useSystemPaths(t, root)

	exe, err := resolveExecutable()
	require.NoError(t, err)
	require.NoError(t, os.Chmod(exe, 0o700))

	mgr, err := NewSystemShimManager()
	require.NoError(t, err, "constructor must not validate the executable")

	require.Error(t, mgr.Install(), "install must reject a binary other users cannot execute")
	require.NoError(t, mgr.Remove(), "remove must work even when the binary fails validation")
}