Function TestSudoDevbox

internal/setup/setup_test.go:141–197

TestSudoDevbox uses sudo on the current test binary to recursively call itself as root. This test can only be run manually (because it needs sudo) but is still useful for testing after making any changes to the sudo code. - Within the test we check if os.Getuid() == 0 to act differently depending o

(t *testing.T)

//   - The non-sudo version of the test looks for the same file to know if the
//     sudo worked.
func TestSudoDevbox(t *testing.T) {
	t.Skip("this test must be run manually because it requires sudo")

	ctx := t.Context()
	key := "test-sudo-devbox"
	resultFile := key + "-result"

	// Non-sudo process cleans up the result file.
	os.Remove(resultFile)
	t.Cleanup(func() {
		if os.Getuid() != 0 {
			os.Remove(resultFile)
		}
	})

	task := &testTask{}
	task.RunFunc = func(ctx context.Context) error {
		ran, err := SudoDevbox(ctx, "-test.run", "^"+t.Name()+"$")
		if ran || err != nil {
			return err
		}

		// Create a result file to indicate to the non-sudo process that
		// we ran as root successfully.
		if os.Getuid() == 0 {
			return os.WriteFile(resultFile, nil, 0o666)
		}
		err = fmt.Errorf("task.NeedsRun not running as root after calling SudoDevbox")
		t.Error(err)
		return err
	}
	task.NeedsRunFunc = func(ctx context.Context, lastRun RunInfo) bool {
		if os.Getuid() == 0 {
			t.Error("task.NeedsRun called in sudo process, but should only be called in user process")
		}
		return true
	}

	old := defaultPrompt
	t.Cleanup(func() { defaultPrompt = old })
	defaultPrompt = func(msg string) (response any, err error) {
		if os.Getuid() == 0 {
			err = fmt.Errorf("user prompted again while already running as sudo")
			t.Error(err)
			return false, err
		}
		return true, nil
	}

	err := ConfirmRun(ctx, key, task, "Allow sudo to run Devbox as root?")
	if err != nil {
		t.Error("got ConfirmRun error:", err)
	}
	if _, err := os.Stat(resultFile); err != nil {
		t.Error("got missing sudo result file:", err)
	}
}