mirror of
https://github.com/netbirdio/netbird.git
synced 2026-07-16 11:39:57 +00:00
* [client] categorize root/system-mutating tests behind a privileged build tag Tests that need root or mutate host state (nftables/iptables/DNS, TUN/WireGuard interfaces, routes, eBPF, SSH/service install) are now gated behind a //go:build privileged tag. The default `go test ./client/...` runs as a non-root user with no sudo and leaves host networking untouched; mixed files were split so pure-logic tests stay in the default suite. A self-hosting ory/dockertest/v4 harness (client/testutil/privileged) runs the privileged suite inside a --privileged --cap-add=NET_ADMIN container via `make test-privileged`; a DOCKER_CI=true guard skips the spawn when already inside the container. Added `make test-unit` for the host-safe run. * [client] add PRIV_RUN/PRIV_PKGS filters to the privileged test harness The dockertest harness now reads two optional env vars when building the in-container `go test` command: PRIV_RUN adds a -run test-name filter and PRIV_PKGS overrides the package list. Both empty reproduce the full privileged suite, so CI and `make test-privileged` behave as before. Lets a developer run a single privileged test in the container, e.g.: PRIV_RUN=TestNftablesManager PRIV_PKGS=./client/firewall/nftables/... make test-privileged * [client] fix unused-helper lint after the privileged test split Splitting privileged tests into *_privileged_test.go left their shared helpers in the untagged files, so in the default (no-tag) build they had no callers and golangci-lint flagged them as unused. Moved the privileged-only helpers into the privileged files next to their callers (generateDummyHandler; createEngine/startSignal/startManagement/getConnectedPeers/ getPeers + kaep/kasp; (*mockDaemon).setJWTToken). Annotated the shared routing-test fixtures that must stay untagged for cross-platform compilation with //nolint:unused (systemops_bsd expected* vars, ensureIPv6DefaultRoute on bsd/windows, loopbackIfaceWindows), matching the existing linux variant. * [client] fix privileged test CI failures and run the harness on macOS The host-safe unit run dropped sudo but two privileged test groups were never tagged, and the Docker privileged job silently never ran the suite: - Gate the ssh/server PrivilegeDropper command-construction tests behind the privileged tag (they require root to target a different UID); split them into executor_unix_privileged_test.go. - Tag sharedsock raw-socket tests privileged (need CAP_NET_RAW). - Fix the Docker job command: nested single quotes around the build tags closed the sh -c wrapper early, dropping the go list package set and the privileged tag, so go test ran on the empty repo root. Use double quotes. Make the self-hosting harness usable from a dev Mac: - Build it on darwin as well as linux; it only drives Docker. - Resolve the active docker context endpoint into DOCKER_HOST when the default /var/run/docker.sock is absent (Docker Desktop, Colima, OrbStack). - Rename the misspelled containerGoModache constant to containerGoModCache. * Update client/internal/engine_privileged_test.go Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com> * Update client/internal/routemanager/systemops/systemops_linux_test.go Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com> * Update client/internal/routemanager/systemops/systemops_windows_test.go Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com> * Update client/server/server_privileged_test.go Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com> * [ci] Run privileged-tagged tests on darwin, windows and freebsd The privileged build tag split moved root/system-mutating tests behind //go:build privileged, but only the linux docker job was given the tag. The native darwin (sudo), windows (PsExec64 -s) and freebsd VM runners already have the required privileges, so add the privileged tag there too to keep CI running the same set of tests as before the split. * [ci] Exclude dockertest harness from the darwin privileged run The privileged tag now compiles client/testutil/privileged on darwin, whose TestRunPrivilegedSuiteInDocker spawns a container the macOS runner has no Docker for. Exclude the harness package from the darwin list, matching the linux job, so the privileged tests run in place without a container spawn. --------- Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
197 lines
4.8 KiB
Go
197 lines
4.8 KiB
Go
//go:build privileged
|
|
|
|
package cmd
|
|
|
|
import (
|
|
"context"
|
|
"fmt"
|
|
"os"
|
|
"runtime"
|
|
"testing"
|
|
"time"
|
|
|
|
"github.com/kardianos/service"
|
|
"github.com/stretchr/testify/assert"
|
|
"github.com/stretchr/testify/require"
|
|
)
|
|
|
|
const (
|
|
serviceStartTimeout = 10 * time.Second
|
|
serviceStopTimeout = 5 * time.Second
|
|
statusPollInterval = 500 * time.Millisecond
|
|
)
|
|
|
|
// waitForServiceStatus waits for service to reach expected status with timeout
|
|
func waitForServiceStatus(expectedStatus service.Status, timeout time.Duration) (bool, error) {
|
|
cfg, err := newSVCConfig()
|
|
if err != nil {
|
|
return false, err
|
|
}
|
|
|
|
ctxSvc, cancel := context.WithCancel(context.Background())
|
|
defer cancel()
|
|
|
|
s, err := newSVC(newProgram(ctxSvc, cancel), cfg)
|
|
if err != nil {
|
|
return false, err
|
|
}
|
|
|
|
ctx, timeoutCancel := context.WithTimeout(context.Background(), timeout)
|
|
defer timeoutCancel()
|
|
|
|
ticker := time.NewTicker(statusPollInterval)
|
|
defer ticker.Stop()
|
|
|
|
for {
|
|
select {
|
|
case <-ctx.Done():
|
|
return false, fmt.Errorf("timeout waiting for service status %v", expectedStatus)
|
|
case <-ticker.C:
|
|
status, err := s.Status()
|
|
if err != nil {
|
|
// Continue polling on transient errors
|
|
continue
|
|
}
|
|
if status == expectedStatus {
|
|
return true, nil
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
// TestServiceLifecycle tests the complete service lifecycle
|
|
func TestServiceLifecycle(t *testing.T) {
|
|
// TODO: Add support for Windows and macOS
|
|
if runtime.GOOS != "linux" && runtime.GOOS != "freebsd" {
|
|
t.Skipf("Skipping service lifecycle test on unsupported OS: %s", runtime.GOOS)
|
|
}
|
|
|
|
if os.Getenv("CONTAINER") == "true" {
|
|
t.Skip("Skipping service lifecycle test in container environment")
|
|
}
|
|
|
|
originalServiceName := serviceName
|
|
serviceName = "netbirdtest" + fmt.Sprintf("%d", time.Now().Unix())
|
|
defer func() {
|
|
serviceName = originalServiceName
|
|
}()
|
|
|
|
tempDir := t.TempDir()
|
|
configPath = fmt.Sprintf("%s/netbird-test-config.json", tempDir)
|
|
logLevel = "info"
|
|
daemonAddr = fmt.Sprintf("unix://%s/netbird-test.sock", tempDir)
|
|
|
|
// Ensure cleanup even if a subtest fails and Stop/Uninstall subtests don't run.
|
|
t.Cleanup(func() {
|
|
cfg, err := newSVCConfig()
|
|
if err != nil {
|
|
t.Errorf("cleanup: create service config: %v", err)
|
|
return
|
|
}
|
|
ctxSvc, cancel := context.WithCancel(context.Background())
|
|
defer cancel()
|
|
s, err := newSVC(newProgram(ctxSvc, cancel), cfg)
|
|
if err != nil {
|
|
t.Errorf("cleanup: create service: %v", err)
|
|
return
|
|
}
|
|
|
|
// If the subtests already cleaned up, there's nothing to do.
|
|
if _, err := s.Status(); err != nil {
|
|
return
|
|
}
|
|
|
|
if err := s.Stop(); err != nil {
|
|
t.Errorf("cleanup: stop service: %v", err)
|
|
}
|
|
if err := s.Uninstall(); err != nil {
|
|
t.Errorf("cleanup: uninstall service: %v", err)
|
|
}
|
|
})
|
|
|
|
ctx := context.Background()
|
|
|
|
t.Run("Install", func(t *testing.T) {
|
|
installCmd.SetContext(ctx)
|
|
err := installCmd.RunE(installCmd, []string{})
|
|
require.NoError(t, err)
|
|
|
|
cfg, err := newSVCConfig()
|
|
require.NoError(t, err)
|
|
|
|
ctxSvc, cancel := context.WithCancel(context.Background())
|
|
defer cancel()
|
|
|
|
s, err := newSVC(newProgram(ctxSvc, cancel), cfg)
|
|
require.NoError(t, err)
|
|
|
|
status, err := s.Status()
|
|
assert.NoError(t, err)
|
|
assert.NotEqual(t, service.StatusUnknown, status)
|
|
})
|
|
|
|
t.Run("Start", func(t *testing.T) {
|
|
startCmd.SetContext(ctx)
|
|
err := startCmd.RunE(startCmd, []string{})
|
|
require.NoError(t, err)
|
|
|
|
running, err := waitForServiceStatus(service.StatusRunning, serviceStartTimeout)
|
|
require.NoError(t, err)
|
|
assert.True(t, running)
|
|
})
|
|
|
|
t.Run("Restart", func(t *testing.T) {
|
|
restartCmd.SetContext(ctx)
|
|
err := restartCmd.RunE(restartCmd, []string{})
|
|
require.NoError(t, err)
|
|
|
|
running, err := waitForServiceStatus(service.StatusRunning, serviceStartTimeout)
|
|
require.NoError(t, err)
|
|
assert.True(t, running)
|
|
})
|
|
|
|
t.Run("Reconfigure", func(t *testing.T) {
|
|
originalLogLevel := logLevel
|
|
logLevel = "debug"
|
|
defer func() {
|
|
logLevel = originalLogLevel
|
|
}()
|
|
|
|
reconfigureCmd.SetContext(ctx)
|
|
err := reconfigureCmd.RunE(reconfigureCmd, []string{})
|
|
require.NoError(t, err)
|
|
|
|
running, err := waitForServiceStatus(service.StatusRunning, serviceStartTimeout)
|
|
require.NoError(t, err)
|
|
assert.True(t, running)
|
|
})
|
|
|
|
t.Run("Stop", func(t *testing.T) {
|
|
stopCmd.SetContext(ctx)
|
|
err := stopCmd.RunE(stopCmd, []string{})
|
|
require.NoError(t, err)
|
|
|
|
stopped, err := waitForServiceStatus(service.StatusStopped, serviceStopTimeout)
|
|
require.NoError(t, err)
|
|
assert.True(t, stopped)
|
|
})
|
|
|
|
t.Run("Uninstall", func(t *testing.T) {
|
|
uninstallCmd.SetContext(ctx)
|
|
err := uninstallCmd.RunE(uninstallCmd, []string{})
|
|
require.NoError(t, err)
|
|
|
|
cfg, err := newSVCConfig()
|
|
require.NoError(t, err)
|
|
|
|
ctxSvc, cancel := context.WithCancel(context.Background())
|
|
defer cancel()
|
|
|
|
s, err := newSVC(newProgram(ctxSvc, cancel), cfg)
|
|
require.NoError(t, err)
|
|
|
|
_, err = s.Status()
|
|
assert.Error(t, err)
|
|
})
|
|
}
|