Files
proxy/cmd/proxyctl/maintenance_test.go
T

249 lines
11 KiB
Go

package main
import (
"bytes"
"context"
"errors"
"os"
"os/exec"
"path/filepath"
"strings"
"testing"
"proxyctl/internal/operationlock"
"proxyctl/internal/oplog"
"proxyctl/internal/profile"
"proxyctl/internal/target"
)
type failingIdentityEnvironment struct{}
func (failingIdentityEnvironment) CurrentUser() (profile.UserIdentity, error) {
return profile.UserIdentity{}, errors.New("identity lookup failed")
}
func (failingIdentityEnvironment) LookupUser(string) (profile.UserIdentity, error) {
return profile.UserIdentity{}, os.ErrNotExist
}
func (failingIdentityEnvironment) LookupEnv(string) (string, bool) { return "", false }
type processFakeTarget struct {
id string
state target.State
err error
calls int
}
func (f *processFakeTarget) ID() string { return f.id }
func (f *processFakeTarget) Description() target.Description { return target.Description{Name: f.id} }
func (f *processFakeTarget) Availability(context.Context) target.Availability {
return target.Availability{Available: true, Evidence: "fake executable found"}
}
func (f *processFakeTarget) Confirmation(bool) string { return "" }
func (f *processFakeTarget) Inspect(context.Context, *profile.Profile) target.Inspection {
return target.Inspection{State: f.state, Evidence: "fake evidence for http://alice:secret@proxy.test"}
}
func (f *processFakeTarget) SetDesired(context.Context, bool, *profile.Profile) target.OperationResult {
f.calls++
if f.err == nil {
f.state = target.Disabled
}
return target.OperationResult{Inspection: target.Inspection{State: f.state, Evidence: "re-inspected fake state"}, Err: f.err}
}
func (f *processFakeTarget) DiagnosticChecks(context.Context, *profile.Profile) []target.Check {
return []target.Check{{Name: "required commands", OK: true, Evidence: "fake helper found"}, {Name: "write authority", OK: true, Evidence: "fake location writable"}}
}
func TestDoctorCommandUsesFakeTargetsAndIsolatedXDGWithoutMutation(t *testing.T) {
xdg := filepath.Join(t.TempDir(), "xdg-config")
store := profile.NewFileStore(filepath.Join(xdg, "proxyctl", "profiles.json"))
fake := &processFakeTarget{id: "fake", state: target.External}
var output bytes.Buffer
if err := runMaintenanceCommand([]string{"doctor"}, strings.NewReader(""), &output, store, []target.Target{fake}, nil, nil, []target.Check{{Name: "identity resolution", OK: true, Evidence: "fake user"}, {Name: "storage permissions", OK: true, Evidence: xdg}}); err != nil {
t.Fatal(err)
}
text := output.String()
for _, want := range []string{"Profile validity", "identity resolution", "storage permissions", "Target availability", "External", "required commands", "write authority"} {
if !strings.Contains(text, want) {
t.Errorf("doctor output missing %q: %s", want, text)
}
}
if strings.Contains(text, "secret") {
t.Fatalf("doctor leaked credentials: %s", text)
}
if fake.calls != 0 {
t.Fatalf("doctor mutated fake Target %d times", fake.calls)
}
if _, err := os.Stat(xdg); !os.IsNotExist(err) {
t.Fatalf("doctor created isolated XDG path: %v", err)
}
}
func TestDoctorReportsIdentityResolutionFailureStructurally(t *testing.T) {
var output bytes.Buffer
err := runWithEnvironment([]string{"doctor"}, strings.NewReader(""), &output, failingIdentityEnvironment{}, nil, "/test/proxyctl")
if err == nil || !strings.Contains(output.String(), "[FAIL] identity resolution") || !strings.Contains(output.String(), "identity lookup failed") {
t.Fatalf("doctor identity failure err=%v output=%q", err, output.String())
}
}
func TestDoctorReturnsFailureWhenAnyCheckFails(t *testing.T) {
store := profile.NewFileStore(filepath.Join(t.TempDir(), "profiles.json"))
fake := &processFakeTarget{id: "fake", state: target.Drifted}
var output bytes.Buffer
err := runMaintenanceCommand([]string{"doctor"}, strings.NewReader(""), &output, store, []target.Target{fake}, nil, nil, []target.Check{{Name: "identity", OK: true, Evidence: "ok"}})
if err == nil || !strings.Contains(output.String(), "[FAIL]") {
t.Fatalf("unhealthy doctor err=%v output=%q", err, output.String())
}
}
func TestDoctorStoragePermissionCheckIsReadOnly(t *testing.T) {
path := filepath.Join(t.TempDir(), "proxyctl", "profiles.json")
writeConfig(t, path, `{"profiles":[]}`)
if err := os.Chmod(path, 0o644); err != nil {
t.Fatal(err)
}
configuration := profile.Configuration{Path: path, Owner: profile.UserIdentity{UID: os.Getuid(), GID: os.Getgid()}}
checks := diagnosticChecks(configuration)
if checks[1].OK || !strings.Contains(checks[1].Evidence, "want 600") {
t.Fatalf("storage check = %#v", checks[1])
}
info, err := os.Stat(path)
if err != nil {
t.Fatal(err)
}
if info.Mode().Perm() != 0o644 {
t.Fatalf("doctor permission check changed mode to %o", info.Mode().Perm())
}
}
func TestCommandsRunAsRealProcessesInsideIsolatedUserState(t *testing.T) {
root := t.TempDir()
binary := filepath.Join(root, "bin", "proxyctl")
if err := os.MkdirAll(filepath.Dir(binary), 0o700); err != nil {
t.Fatal(err)
}
if err := os.MkdirAll(filepath.Join(root, "home"), 0o700); err != nil {
t.Fatal(err)
}
build := exec.Command("go", "build", "-tags", "proxyctl_process_test", "-o", binary, ".")
if output, err := build.CombinedOutput(); err != nil {
t.Fatalf("build proxyctl: %v\n%s", err, output)
}
environment := isolatedProcessEnvironment(root)
invoke := func(input string, args ...string) ([]byte, error) {
t.Helper()
command := exec.Command(binary, args...)
command.Env = environment
command.Stdin = strings.NewReader(input)
return command.CombinedOutput()
}
defaultOutput, err := invoke("q")
if err != nil || !strings.Contains(string(defaultOutput), "proxyctl — Target panel") {
t.Fatalf("default process err=%v output=%q", err, defaultOutput)
}
versionOutput, err := invoke("", "version", "--short")
if err != nil || strings.TrimSpace(string(versionOutput)) == "" || strings.Contains(string(versionOutput), " ") {
t.Fatalf("version process err=%v output=%q", err, versionOutput)
}
doctorOutput, doctorErr := invoke("", "doctor")
if !strings.Contains(string(doctorOutput), "Profile validity") || (doctorErr != nil && !strings.Contains(string(doctorOutput), "[FAIL]")) {
t.Fatalf("doctor process err=%v output=%q", doctorErr, doctorOutput)
}
resetOutput, err := invoke("no\n", "reset")
if err != nil || !strings.Contains(string(resetOutput), "Reset cancelled") {
t.Fatalf("reset cancellation process err=%v output=%q", err, resetOutput)
}
resetOutput, err = invoke("yes\n", "reset")
if err != nil || !strings.Contains(string(resetOutput), "shell: skipped (Disabled)") {
t.Fatalf("confirmed reset process err=%v output=%q", err, resetOutput)
}
installOutput, err := invoke("", "shell", "install")
if err != nil || !strings.Contains(string(installOutput), "installed") {
t.Fatalf("shell install process err=%v output=%q", err, installOutput)
}
startup := filepath.Join(root, "home", ".bashrc")
startupData, err := os.ReadFile(startup)
if err != nil || !strings.Contains(string(startupData), "proxyctl shell integration") {
t.Fatalf("isolated startup after install err=%v data=%q", err, startupData)
}
uninstallOutput, err := invoke("", "shell", "uninstall")
if err != nil || !strings.Contains(string(uninstallOutput), "uninstalled") {
t.Fatalf("shell uninstall process err=%v output=%q", err, uninstallOutput)
}
startupData, err = os.ReadFile(startup)
if err != nil || strings.Contains(string(startupData), "proxyctl shell integration") {
t.Fatalf("isolated startup after uninstall err=%v data=%q", err, startupData)
}
for _, path := range []string{
filepath.Join(root, "etc"),
filepath.Join(root, "var"),
filepath.Join(root, "home", ".docker"),
} {
if _, err := os.Stat(path); !os.IsNotExist(err) {
t.Fatalf("process smoke created prohibited system/Docker fixture %s: %v", path, err)
}
}
}
func isolatedProcessEnvironment(root string) []string {
blocked := map[string]bool{"HOME": true, "XDG_CONFIG_HOME": true, "XDG_STATE_HOME": true, "SHELL": true, "SUDO_USER": true, "HTTP_PROXY": true, "http_proxy": true, "HTTPS_PROXY": true, "https_proxy": true, "ALL_PROXY": true, "all_proxy": true, "NO_PROXY": true, "no_proxy": true}
environment := make([]string, 0, len(os.Environ())+4)
for _, item := range os.Environ() {
name, _, _ := strings.Cut(item, "=")
if !blocked[name] {
environment = append(environment, item)
}
}
return append(environment,
"HOME="+filepath.Join(root, "home"),
"XDG_CONFIG_HOME="+filepath.Join(root, "config"),
"XDG_STATE_HOME="+filepath.Join(root, "state"),
"SHELL=/bin/bash",
"PROXYCTL_PROCESS_TEST_HOME="+filepath.Join(root, "home"),
)
}
func TestResetCommandCancellationAndTruthfulPartialFailureWithFakeTargets(t *testing.T) {
root := t.TempDir()
config := filepath.Join(root, "xdg-config", "proxyctl", "profiles.json")
writeConfig(t, config, `{"profiles":[]}`)
store := profile.NewFileStore(config)
good := &processFakeTarget{id: "good", state: target.Enabled}
bad := &processFakeTarget{id: "bad", state: target.Drifted, err: errors.New("remove http://bob:hunter2@proxy.test failed")}
external := &processFakeTarget{id: "external", state: target.External}
stateDir := filepath.Join(root, "xdg-state", "proxyctl")
lock := operationlock.New(filepath.Join(stateDir, "operation.lock"))
logger := oplog.New(filepath.Join(stateDir, "operations.log"), 1024, 1)
var output bytes.Buffer
if err := runMaintenanceCommand([]string{"reset"}, strings.NewReader("no\n"), &output, store, []target.Target{good, bad, external}, lock, logger, nil); err != nil {
t.Fatal(err)
}
if good.calls+bad.calls+external.calls != 0 || !strings.Contains(output.String(), "cancelled") {
t.Fatalf("cancel result output=%q calls=%d/%d/%d", output.String(), good.calls, bad.calls, external.calls)
}
output.Reset()
err := runMaintenanceCommand([]string{"reset"}, strings.NewReader("yes\n"), &output, store, []target.Target{good, bad, external}, lock, logger, nil)
if err == nil {
t.Fatal("partial reset returned success")
}
text := output.String()
if good.calls != 1 || bad.calls != 1 || external.calls != 0 || !strings.Contains(text, "good: reset (Disabled)") || !strings.Contains(text, "bad: failed (Drifted)") || !strings.Contains(text, "fresh inspection: fake evidence for http://alice:REDACTED@proxy.test") || !strings.Contains(text, "external: skipped (External)") {
t.Fatalf("partial reset output=%q calls=%d/%d/%d", text, good.calls, bad.calls, external.calls)
}
if strings.Contains(text, "hunter2") || strings.Contains(text, "secret") || strings.Contains(err.Error(), "hunter2") {
t.Fatalf("reset leaked credentials: output=%q err=%v", text, err)
}
logData, readErr := os.ReadFile(filepath.Join(stateDir, "operations.log"))
if readErr != nil {
t.Fatal(readErr)
}
if strings.Contains(string(logData), "hunter2") || strings.Contains(string(logData), "bob:") {
t.Fatalf("log leaked full authenticated URL: %s", logData)
}
}