mirror of
https://github.com/lukaszraczylo/gohoarder.git
synced 2026-07-12 04:50:45 +00:00
e39d6a0f0d
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).
299 lines
7.2 KiB
Go
299 lines
7.2 KiB
Go
package app
|
|
|
|
import (
|
|
"encoding/json"
|
|
"net/http/httptest"
|
|
"testing"
|
|
"time"
|
|
|
|
"github.com/gofiber/fiber/v2"
|
|
"github.com/lukaszraczylo/gohoarder/pkg/analytics"
|
|
"github.com/stretchr/testify/suite"
|
|
)
|
|
|
|
type AnalyticsHandlersTestSuite struct {
|
|
suite.Suite
|
|
app *fiber.App
|
|
appInst *App
|
|
engine *analytics.Engine
|
|
}
|
|
|
|
func (s *AnalyticsHandlersTestSuite) SetupTest() {
|
|
// Create analytics engine
|
|
s.engine = analytics.NewEngine(analytics.Config{
|
|
MaxEvents: 10000,
|
|
FlushInterval: 5 * time.Minute,
|
|
})
|
|
|
|
// Seed some test data
|
|
s.engine.TrackDownload(analytics.PackageDownload{
|
|
Registry: "npm",
|
|
Name: "lodash",
|
|
Version: "4.17.21",
|
|
Timestamp: time.Now(),
|
|
BytesSize: 1024,
|
|
})
|
|
s.engine.TrackDownload(analytics.PackageDownload{
|
|
Registry: "npm",
|
|
Name: "react",
|
|
Version: "18.0.0",
|
|
Timestamp: time.Now(),
|
|
BytesSize: 2048,
|
|
})
|
|
s.engine.TrackDownload(analytics.PackageDownload{
|
|
Registry: "pypi",
|
|
Name: "requests",
|
|
Version: "2.28.0",
|
|
Timestamp: time.Now(),
|
|
BytesSize: 512,
|
|
})
|
|
|
|
// Create app instance
|
|
s.appInst = &App{
|
|
analyticsEngine: s.engine,
|
|
}
|
|
|
|
// Create Fiber app
|
|
s.app = fiber.New()
|
|
|
|
// Register routes
|
|
s.app.Get("/api/analytics/top", s.appInst.handleAnalyticsTopPackages)
|
|
s.app.Get("/api/analytics/trending", s.appInst.handleAnalyticsTrendingPackages)
|
|
s.app.Get("/api/analytics/trends", s.appInst.handleAnalyticsTrends)
|
|
s.app.Get("/api/analytics/total", s.appInst.handleAnalyticsTotalStats)
|
|
s.app.Get("/api/analytics/registry/:registry", s.appInst.handleAnalyticsRegistryStats)
|
|
s.app.Get("/api/analytics/package/:registry/:name", s.appInst.handleAnalyticsPackageStats)
|
|
s.app.Get("/api/analytics/search", s.appInst.handleAnalyticsSearch)
|
|
}
|
|
|
|
func (s *AnalyticsHandlersTestSuite) TearDownTest() {
|
|
if s.engine != nil {
|
|
s.engine.Close()
|
|
}
|
|
}
|
|
|
|
func TestAnalyticsHandlersTestSuite(t *testing.T) {
|
|
suite.Run(t, new(AnalyticsHandlersTestSuite))
|
|
}
|
|
|
|
func (s *AnalyticsHandlersTestSuite) TestHandleAnalyticsTopPackages() {
|
|
tests := []struct {
|
|
name string
|
|
queryParams string
|
|
expectedStatus int
|
|
expectError bool
|
|
}{
|
|
{
|
|
name: "get top packages default",
|
|
queryParams: "",
|
|
expectedStatus: 200,
|
|
expectError: false,
|
|
},
|
|
{
|
|
name: "get top packages with limit",
|
|
queryParams: "?limit=5",
|
|
expectedStatus: 200,
|
|
expectError: false,
|
|
},
|
|
{
|
|
name: "get top packages with registry filter",
|
|
queryParams: "?registry=npm",
|
|
expectedStatus: 200,
|
|
expectError: false,
|
|
},
|
|
}
|
|
|
|
for _, tt := range tests {
|
|
s.Run(tt.name, func() {
|
|
req := httptest.NewRequest("GET", "/api/analytics/top"+tt.queryParams, nil)
|
|
resp, err := s.app.Test(req)
|
|
s.Require().NoError(err)
|
|
s.Equal(tt.expectedStatus, resp.StatusCode)
|
|
|
|
if !tt.expectError {
|
|
var result struct {
|
|
Packages []analytics.PackageStats `json:"packages"`
|
|
Total int `json:"total"`
|
|
}
|
|
err = json.NewDecoder(resp.Body).Decode(&result)
|
|
s.NoError(err)
|
|
}
|
|
})
|
|
}
|
|
}
|
|
|
|
func (s *AnalyticsHandlersTestSuite) TestHandleAnalyticsTrendingPackages() {
|
|
req := httptest.NewRequest("GET", "/api/analytics/trending", nil)
|
|
resp, err := s.app.Test(req)
|
|
s.Require().NoError(err)
|
|
s.Equal(200, resp.StatusCode)
|
|
|
|
var result struct {
|
|
Packages []analytics.PackageStats `json:"packages"`
|
|
Total int `json:"total"`
|
|
}
|
|
err = json.NewDecoder(resp.Body).Decode(&result)
|
|
s.NoError(err)
|
|
}
|
|
|
|
func (s *AnalyticsHandlersTestSuite) TestHandleAnalyticsTrends() {
|
|
tests := []struct {
|
|
name string
|
|
queryParams string
|
|
expectedStatus int
|
|
}{
|
|
{
|
|
name: "get trends default timeframe",
|
|
queryParams: "",
|
|
expectedStatus: 200,
|
|
},
|
|
{
|
|
name: "get trends with registry filter",
|
|
queryParams: "?registry=npm",
|
|
expectedStatus: 200,
|
|
},
|
|
}
|
|
|
|
for _, tt := range tests {
|
|
s.Run(tt.name, func() {
|
|
req := httptest.NewRequest("GET", "/api/analytics/trends"+tt.queryParams, nil)
|
|
resp, err := s.app.Test(req)
|
|
s.Require().NoError(err)
|
|
s.Equal(tt.expectedStatus, resp.StatusCode)
|
|
})
|
|
}
|
|
}
|
|
|
|
func (s *AnalyticsHandlersTestSuite) TestHandleAnalyticsTotalStats() {
|
|
req := httptest.NewRequest("GET", "/api/analytics/total", nil)
|
|
resp, err := s.app.Test(req)
|
|
s.Require().NoError(err)
|
|
s.Equal(200, resp.StatusCode)
|
|
|
|
var result struct {
|
|
TotalDownloads int64 `json:"total_downloads"`
|
|
TotalBytes int64 `json:"total_bytes"`
|
|
UniquePackages int `json:"unique_packages"`
|
|
}
|
|
err = json.NewDecoder(resp.Body).Decode(&result)
|
|
s.NoError(err)
|
|
s.Greater(result.TotalDownloads, int64(0))
|
|
}
|
|
|
|
func (s *AnalyticsHandlersTestSuite) TestHandleAnalyticsRegistryStats() {
|
|
tests := []struct {
|
|
name string
|
|
registry string
|
|
expectedStatus int
|
|
}{
|
|
{
|
|
name: "npm registry stats",
|
|
registry: "npm",
|
|
expectedStatus: 200,
|
|
},
|
|
{
|
|
name: "pypi registry stats",
|
|
registry: "pypi",
|
|
expectedStatus: 200,
|
|
},
|
|
{
|
|
name: "go registry stats",
|
|
registry: "go",
|
|
expectedStatus: 200,
|
|
},
|
|
}
|
|
|
|
for _, tt := range tests {
|
|
s.Run(tt.name, func() {
|
|
req := httptest.NewRequest("GET", "/api/analytics/registry/"+tt.registry, nil)
|
|
resp, err := s.app.Test(req)
|
|
s.Require().NoError(err)
|
|
s.Equal(tt.expectedStatus, resp.StatusCode)
|
|
})
|
|
}
|
|
}
|
|
|
|
func (s *AnalyticsHandlersTestSuite) TestHandleAnalyticsPackageStats() {
|
|
tests := []struct {
|
|
name string
|
|
registry string
|
|
packageName string
|
|
expectedStatus int
|
|
}{
|
|
{
|
|
name: "lodash package stats",
|
|
registry: "npm",
|
|
packageName: "lodash",
|
|
expectedStatus: 200,
|
|
},
|
|
{
|
|
name: "react package stats",
|
|
registry: "npm",
|
|
packageName: "react",
|
|
expectedStatus: 200,
|
|
},
|
|
{
|
|
name: "requests package stats",
|
|
registry: "pypi",
|
|
packageName: "requests",
|
|
expectedStatus: 200,
|
|
},
|
|
}
|
|
|
|
for _, tt := range tests {
|
|
s.Run(tt.name, func() {
|
|
req := httptest.NewRequest("GET", "/api/analytics/package/"+tt.registry+"/"+tt.packageName, nil)
|
|
resp, err := s.app.Test(req)
|
|
s.Require().NoError(err)
|
|
s.Equal(tt.expectedStatus, resp.StatusCode)
|
|
})
|
|
}
|
|
}
|
|
|
|
func (s *AnalyticsHandlersTestSuite) TestHandleAnalyticsSearch() {
|
|
tests := []struct {
|
|
name string
|
|
queryParams string
|
|
expectedStatus int
|
|
expectError bool
|
|
}{
|
|
{
|
|
name: "search for lodash",
|
|
queryParams: "?q=lodash",
|
|
expectedStatus: 200,
|
|
expectError: false,
|
|
},
|
|
{
|
|
name: "search for react",
|
|
queryParams: "?q=react",
|
|
expectedStatus: 200,
|
|
expectError: false,
|
|
},
|
|
{
|
|
name: "search with no query",
|
|
queryParams: "",
|
|
expectedStatus: 400, // Query parameter is required
|
|
expectError: true,
|
|
},
|
|
}
|
|
|
|
for _, tt := range tests {
|
|
s.Run(tt.name, func() {
|
|
req := httptest.NewRequest("GET", "/api/analytics/search"+tt.queryParams, nil)
|
|
resp, err := s.app.Test(req)
|
|
s.Require().NoError(err)
|
|
s.Equal(tt.expectedStatus, resp.StatusCode)
|
|
|
|
if !tt.expectError {
|
|
var result struct {
|
|
Query string `json:"query"`
|
|
Results []analytics.PackageStats `json:"results"`
|
|
Total int `json:"total"`
|
|
}
|
|
err = json.NewDecoder(resp.Body).Decode(&result)
|
|
s.NoError(err)
|
|
}
|
|
})
|
|
}
|
|
}
|