Files
gohoarder/pkg/storage/smb/smb_test.go
T
lukaszraczylo e39d6a0f0d feat: comprehensive audit + Tier 3 wiring (security/correctness/features)
Multi-agent audit + fix pass covering bugs, security, dead config wiring,
and missing features. All quality gates green: build/vet/test -race/govulncheck/
golangci-lint. Frontend tests 47/47.

SECURITY & CORRECTNESS

- Scanner pipeline fail-closed: cache.go scan timeout now 503 (was goto servePkg);
  scanner.go all-scanners-fail saves ScanStatusError; CheckVulnerabilities blocks
  on missing/error result instead of allowing.
- Scanner argv corrections: govulncheck source-mode + go.mod discovery;
  npm-audit generates lockfile via npm install --package-lock-only --ignore-scripts;
  pip-audit per-extension dispatch (wheel direct / sdist extract+pyproject).
- GHSA version-range filtering implemented (was always-include); url.QueryEscape
  on package name.
- pypi SSRF closed via host allowlist on original_url; url.QueryEscape on
  rewriteURL output.
- Path traversal: cache temp file uses os.CreateTemp; smb keyToPath sanitized;
  filesystem keyToPath returns error + filepath.Abs prefix-verify.
- Goroutine leaks plugged: cache.cleanupWorker stop channel; auth.ValidationCache
  Stop() with sync.Once; ws.unregister buffered with non-blocking send.
- WebSocket double-close panic fixed via sync.Once Client.closeSend().
- Race conditions: gormstore.registryCache sync.RWMutex (was concurrent map
  panic); auth.LastUsedAt no longer mutated under RLock; analytics strict
  lock-ordering invariant (statsMu before downloadsMu).
- Auth validator fails CLOSED on transport/unknown-status errors (was returning
  true,err 'allow cache fallback').
- Credential cache hash full SHA256 (was 8-byte truncate; eliminates 2^32
  collision risk).
- filesystem.fs.used incremented after successful rename (no quota inflation
  race).
- gormstore aggregation events deleted in same tx as insert (no double-counting).
- gormstore.SavePackage uses Updates(map) so zero-value security flags
  (RequiresAuth=false) can be cleared.
- partition_manager validates partition name regex before DROP TABLE.
- vcs/git: version regex validation rejects --option-injection; checkout uses
  --detach -- separator; removed TrimPrefix(repo,'v') that corrupted vault/
  vitess/vim-go.
- WebSocket CheckOrigin allowlist (was return true; CSWSH closed); same-origin
  default + ServerConfig.AllowedOrigins.
- fiber CVE GO-2026-4543 patched (v2.52.10 -> v2.52.12).

FUNCTIONAL FEATURES

- API key DB persistence: APIKeyModel + migration 202604280002, full CRUD,
  async LastUsedAt updates with WaitGroup-tracked goroutines drained on Close.
- Admin bootstrap via GOHOARDER_BOOTSTRAP_ADMIN_KEY env var; idempotent
  (skipped when non-revoked admin already exists).
- Auth middleware factory in pkg/app: RequireAuth, RequireRole, RequirePermission,
  OptionalAuth. Mounted on proxy + read APIs when Auth.Enabled=true.
  DELETE /api/packages/* requires admin role. /health public for k8s probes.
- NFS storage backend: pkg/storage/nfs wraps filesystem with /proc/mounts
  detection (Linux), post-write fsync, read-after-write health probe.
- WebSocket real-time pipeline: pkg/events Broadcaster interface; cache + scanner
  managers emit EventPackageCached / EventPackageDownloaded / EventScanComplete;
  app.go runs 30s EventStatsUpdate ticker. Frontend has full WS client (reconnect
  with exponential backoff 1s->30s, 25s heartbeat, subscriber pattern), Pinia
  realtime store, Dashboard live indicator + activity feed + reactive stats
  override.
- TLS termination: fiber.ListenTLS when Server.TLS.Enabled.
- Pre-warming: Prewarming.Enabled flag wired (was hardcoded false); Interval,
  MaxConcurrent, TopPackages plumbed.
- NetworkConfig wired (timeouts, retry, rate-limit, circuit-breaker).
- AuthConfig.BcryptCost wired.
- Security.Scanners.Static.MaxPackageSize plumbed to cache.io.LimitReader.
- Handlers.{Go,NPM,PyPI}.Enabled gates route mounting.
- Graceful shutdown: authManager.Close drains async writes.

LINT/HYGIENE

- 80 golangci-lint issues resolved: errcheck (Close/Write/RemoveAll wrapped),
  gofmt, gosec G104/G306, govet shadow renames + fieldalignment reorders,
  staticcheck ST1000 pkg comments + QF1003 tagged switches + QF1008 embedded
  field selectors + QF1001 De Morgan's law.

BEHAVIOR CHANGES

- Scanner now fail-closed: deployments without scanner binaries
  (trivy/govulncheck/npm-audit/pip-audit/grype) BLOCK packages instead of
  serving unscanned. Add binaries or plan a future allow-on-scan-error flag.
- WS origin defaults to same-origin; cross-origin dashboards must set
  server.allowed_origins.
- Validator no longer fails open; private packages won't serve from cache when
  validation can't be performed.
- download_events retention dropped from 24h to ~5min (deleted in agg tx).
  Migration 202604280001 purges pre-upgrade events.
- DELETE /api/packages/* requires admin role when auth enabled.

NEW PACKAGES

- pkg/events  - Broadcaster interface
- pkg/storage/nfs  - NFS-aware filesystem wrapper

DEFERRED (out of scope this pass)

- Static scanner implementation (config defines AllowedLicenses/MaxPackageSize/
  BlockSuspicious but pkg/scanner/static/ does not exist).
- AuthConfig.AuditLog wiring (no audit log infra yet).
- CacheConfig.TTLOverrides passthrough (would touch cache.Config beyond
  integrator scope).
2026-07-10 09:37:55 +01:00

329 lines
6.9 KiB
Go

package smb
import (
"testing"
"github.com/stretchr/testify/suite"
)
type SMBStorageTestSuite struct {
suite.Suite
}
func TestSMBStorageTestSuite(t *testing.T) {
suite.Run(t, new(SMBStorageTestSuite))
}
func (s *SMBStorageTestSuite) TestNewSMBStorage() {
tests := []struct {
name string
errorMsg string
config Config
expectError bool
}{
{
name: "valid config",
config: Config{
Host: "fileserver.example.com",
Port: 445,
Share: "gohoarder",
Path: "packages",
Username: "testuser",
Password: "testpass",
Domain: "CORP",
MaxSizeBytes: 1024 * 1024,
PoolSize: 5,
},
expectError: false,
},
{
name: "missing host",
config: Config{
Share: "gohoarder",
Username: "testuser",
Password: "testpass",
},
expectError: true,
errorMsg: "host is required",
},
{
name: "missing share",
config: Config{
Host: "fileserver.example.com",
Username: "testuser",
Password: "testpass",
},
expectError: true,
errorMsg: "share is required",
},
{
name: "default port",
config: Config{
Host: "fileserver.example.com",
Share: "gohoarder",
Username: "testuser",
Password: "testpass",
},
expectError: false,
},
{
name: "default pool size",
config: Config{
Host: "fileserver.example.com",
Share: "gohoarder",
Username: "testuser",
Password: "testpass",
},
expectError: false,
},
}
for _, tt := range tests {
s.Run(tt.name, func() {
storage, err := New(tt.config)
if tt.expectError {
s.Error(err)
if tt.errorMsg != "" {
s.Contains(err.Error(), tt.errorMsg)
}
s.Nil(storage)
} else {
// Note: This will fail in actual execution since we can't connect to a real SMB server
// But it tests the validation logic
if err != nil {
// Connection errors are expected in unit tests
s.Contains(err.Error(), "Failed to create initial SMB connection")
}
}
})
}
}
func (s *SMBStorageTestSuite) TestKeyToPath() {
tests := []struct {
name string
basePath string
key string
expectedWin string // Expected Windows-style path
}{
{
name: "simple key with base path",
basePath: "packages",
key: "test/file.txt",
expectedWin: "packages\\test\\file.txt",
},
{
name: "simple key without base path",
basePath: "",
key: "test/file.txt",
expectedWin: "test\\file.txt",
},
{
name: "nested key",
basePath: "cache",
key: "deep/nested/path/file.txt",
expectedWin: "cache\\deep\\nested\\path\\file.txt",
},
{
name: "key with backslashes",
basePath: "packages",
key: "test\\file.txt",
expectedWin: "packages\\test\\file.txt",
},
}
for _, tt := range tests {
s.Run(tt.name, func() {
storage := &SMBStorage{
config: Config{
Path: tt.basePath,
},
}
result, err := storage.keyToPath(tt.key)
s.NoError(err)
s.Equal(tt.expectedWin, result)
})
}
}
func (s *SMBStorageTestSuite) TestPathToKey() {
tests := []struct {
name string
basePath string
path string
expected string
}{
{
name: "windows path with base path",
basePath: "packages",
path: "packages\\test\\file.txt",
expected: "test/file.txt",
},
{
name: "windows path without base path",
basePath: "",
path: "test\\file.txt",
expected: "test/file.txt",
},
{
name: "nested windows path",
basePath: "cache",
path: "cache\\deep\\nested\\path\\file.txt",
expected: "deep/nested/path/file.txt",
},
}
for _, tt := range tests {
s.Run(tt.name, func() {
storage := &SMBStorage{
config: Config{
Path: tt.basePath,
},
}
result := storage.pathToKey(tt.path)
s.Equal(tt.expected, result)
})
}
}
func (s *SMBStorageTestSuite) TestConfigDefaults() {
config := Config{
Host: "fileserver.example.com",
Share: "gohoarder",
Username: "testuser",
Password: "testpass",
}
// This will fail to connect, but we can verify the config validation
_, err := New(config)
// We expect a connection error, not a validation error
if err != nil {
s.NotContains(err.Error(), "host is required")
s.NotContains(err.Error(), "share is required")
}
}
func (s *SMBStorageTestSuite) TestPathNormalization() {
tests := []struct {
name string
inputPath string
expectedPath string
}{
{
name: "path with trailing slash",
inputPath: "packages/",
expectedPath: "packages",
},
{
name: "path with trailing backslash",
inputPath: "packages\\",
expectedPath: "packages",
},
{
name: "path without trailing slash",
inputPath: "packages",
expectedPath: "packages",
},
{
name: "empty path",
inputPath: "",
expectedPath: "",
},
{
name: "nested path with trailing slash",
inputPath: "cache/packages/",
expectedPath: "cache/packages",
},
}
for _, tt := range tests {
s.Run(tt.name, func() {
config := Config{
Host: "fileserver.example.com",
Share: "gohoarder",
Path: tt.inputPath,
Username: "testuser",
Password: "testpass",
}
// This will fail to connect, but we can check the config
storage, _ := New(config)
if storage != nil {
s.Equal(tt.expectedPath, storage.config.Path)
}
})
}
}
func (s *SMBStorageTestSuite) TestPoolSizeDefaults() {
config := Config{
Host: "fileserver.example.com",
Share: "gohoarder",
Username: "testuser",
Password: "testpass",
}
storage, _ := New(config)
if storage != nil {
s.Equal(5, storage.poolSize) // Default pool size
}
}
func (s *SMBStorageTestSuite) TestPortDefaults() {
config := Config{
Host: "fileserver.example.com",
Share: "gohoarder",
Username: "testuser",
Password: "testpass",
}
storage, _ := New(config)
if storage != nil {
s.Equal(445, storage.config.Port) // Default SMB port
}
}
func (s *SMBStorageTestSuite) TestClose() {
// Create a storage instance (will fail to connect but that's ok)
config := Config{
Host: "fileserver.example.com",
Share: "gohoarder",
Username: "testuser",
Password: "testpass",
}
storage, _ := New(config)
if storage != nil {
// Close should not panic
err := storage.Close()
s.NoError(err)
}
}
func (s *SMBStorageTestSuite) TestConnectionPoolChannel() {
config := Config{
Host: "fileserver.example.com",
Share: "gohoarder",
Username: "testuser",
Password: "testpass",
PoolSize: 10,
}
storage, _ := New(config)
if storage != nil {
// Verify pool channel capacity
s.NotNil(storage.connPool)
s.Equal(10, cap(storage.connPool))
}
}
func (s *SMBStorageTestSuite) TestSMBConnectionStruct() {
// Verify smbConnection structure exists and has required fields
conn := &smbConnection{}
s.NotNil(conn)
}