mirror of
https://github.com/netbirdio/netbird.git
synced 2026-07-20 07:21:27 +02: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>
119 lines
3.3 KiB
Go
119 lines
3.3 KiB
Go
//go:build privileged
|
|
|
|
package client
|
|
|
|
import (
|
|
"context"
|
|
"errors"
|
|
"runtime"
|
|
"strings"
|
|
"testing"
|
|
"time"
|
|
|
|
"github.com/stretchr/testify/assert"
|
|
"github.com/stretchr/testify/require"
|
|
cryptossh "golang.org/x/crypto/ssh"
|
|
|
|
"github.com/netbirdio/netbird/client/ssh/testutil"
|
|
)
|
|
|
|
func TestSSHClient_CommandExecution(t *testing.T) {
|
|
if runtime.GOOS == "windows" && testutil.IsCI() {
|
|
t.Skip("Skipping Windows command execution tests in CI due to S4U authentication issues")
|
|
}
|
|
|
|
server, _, client := setupTestSSHServerAndClient(t)
|
|
defer func() {
|
|
err := server.Stop()
|
|
require.NoError(t, err)
|
|
}()
|
|
defer func() {
|
|
err := client.Close()
|
|
assert.NoError(t, err)
|
|
}()
|
|
|
|
ctx, cancel := context.WithTimeout(context.Background(), 3*time.Second)
|
|
defer cancel()
|
|
|
|
t.Run("ExecuteCommand captures output", func(t *testing.T) {
|
|
output, err := client.ExecuteCommand(ctx, "echo hello")
|
|
assert.NoError(t, err)
|
|
assert.Contains(t, string(output), "hello")
|
|
})
|
|
|
|
t.Run("ExecuteCommandWithIO streams output", func(t *testing.T) {
|
|
err := client.ExecuteCommandWithIO(ctx, "echo world")
|
|
assert.NoError(t, err)
|
|
})
|
|
|
|
t.Run("commands with flags work", func(t *testing.T) {
|
|
output, err := client.ExecuteCommand(ctx, "echo -n test_flag")
|
|
assert.NoError(t, err)
|
|
assert.Equal(t, "test_flag", strings.TrimSpace(string(output)))
|
|
})
|
|
|
|
t.Run("non-zero exit codes don't return errors", func(t *testing.T) {
|
|
var testCmd string
|
|
if runtime.GOOS == "windows" {
|
|
testCmd = "echo hello | Select-String notfound"
|
|
} else {
|
|
testCmd = "echo 'hello' | grep 'notfound'"
|
|
}
|
|
_, err := client.ExecuteCommand(ctx, testCmd)
|
|
assert.NoError(t, err)
|
|
})
|
|
}
|
|
|
|
func TestSSHClient_ContextCancellation(t *testing.T) {
|
|
server, serverAddr, _ := setupTestSSHServerAndClient(t)
|
|
defer func() {
|
|
err := server.Stop()
|
|
require.NoError(t, err)
|
|
}()
|
|
|
|
t.Run("connection with short timeout", func(t *testing.T) {
|
|
ctx, cancel := context.WithTimeout(context.Background(), 1*time.Millisecond)
|
|
defer cancel()
|
|
|
|
currentUser := testutil.GetTestUsername(t)
|
|
_, err := Dial(ctx, serverAddr, currentUser, DialOptions{
|
|
InsecureSkipVerify: true,
|
|
})
|
|
if err != nil {
|
|
// Check for actual timeout-related errors rather than string matching
|
|
assert.True(t,
|
|
errors.Is(err, context.DeadlineExceeded) ||
|
|
errors.Is(err, context.Canceled) ||
|
|
strings.Contains(err.Error(), "timeout"),
|
|
"Expected timeout-related error, got: %v", err)
|
|
}
|
|
})
|
|
|
|
t.Run("command execution cancellation", func(t *testing.T) {
|
|
ctx, cancel := context.WithTimeout(context.Background(), 5*time.Second)
|
|
defer cancel()
|
|
currentUser := testutil.GetTestUsername(t)
|
|
client, err := Dial(ctx, serverAddr, currentUser, DialOptions{
|
|
InsecureSkipVerify: true,
|
|
})
|
|
require.NoError(t, err)
|
|
defer func() {
|
|
if err := client.Close(); err != nil {
|
|
t.Logf("client close error: %v", err)
|
|
}
|
|
}()
|
|
|
|
cmdCtx, cmdCancel := context.WithTimeout(context.Background(), 100*time.Millisecond)
|
|
defer cmdCancel()
|
|
|
|
err = client.ExecuteCommandWithPTY(cmdCtx, "sleep 10")
|
|
if err != nil {
|
|
var exitMissingErr *cryptossh.ExitMissingError
|
|
isValidCancellation := errors.Is(err, context.DeadlineExceeded) ||
|
|
errors.Is(err, context.Canceled) ||
|
|
errors.As(err, &exitMissingErr)
|
|
assert.True(t, isValidCancellation, "Should handle command cancellation properly")
|
|
}
|
|
})
|
|
}
|