mirror of
https://github.com/MHSanaei/3x-ui.git
synced 2026-08-30 06:57:14 +00:00
Test-quality audit: fix 2 prod bugs, strengthen weak tests, add mutation/fuzz/CI tooling (#5345)
* test(audit): add gremlins/rapid/coverage tooling + AUDIT.md scaffold * test(audit): hygiene sweep (race-clean except logger global; Finding #2) + smell inventory * test(audit): cover untested error/edge branches (TLS proxy+pin, migration tag cleanup=Finding #1) * test(audit): strengthen internal/sub link tests (dedup key, TLS/Reality mapping, clash well-formedness) * test(audit): property (rapid) + fuzz tests for joinHostPort/userinfo/pin/ParseLink * test(audit): tighten frontend subSortIndex rejection assertions + wire coverage * ci(audit): add shuffle gate + non-blocking race job (Finding #2) + fuzz-smoke; document mutation policy * chore(audit): gitignore frontend coverage output * test(audit): exhaustive whole-repo pass — strengthen 5 weak/fake tests (netproxy, CSP, modal per-protocol loops, schema coercions) * docs(contributing): add Testing section (conventions, race/shuffle, fuzz, mutation policy); drop AUDIT.md ledger * fix(logger,migration): guard logBuffer with mutex; execute legacy tag cleanup (tx.Exec); make CI race gate blocking * ci(mutation): add nightly scoped gremlins workflow (informational artifacts) * test(audit): strengthen runtime tests — baseURL scheme/port bounds, isNonEmptySlice, trafficReset * test(audit): strengthen clash tests — reality field mapping + tcp-header validation * test(audit): runtime — egress-proxy + content-type tests; drop redundant bp=='' branch * test(audit): strengthen link parser/helper tests (defaultPort, splitComma, base64, canonicalQuery, tls/reality/transport mapping) * test(audit): strengthen sub/xray/common/netsafe/mtproto/config/middleware tests (kill surviving mutants) * test(audit): raise timeout on protocol-iteration modal tests (heavy re-renders, slow on CI) * fix(logger): GetLogs returns at most c entries (off-by-one fix; addresses PR review) * perf(logger): snapshot logBuffer under lock so GetLogs doesn't block logging; clarify fuzz-seed docs (addresses PR review)
This commit is contained in:
@@ -3,6 +3,7 @@ package middleware
|
||||
import (
|
||||
"net/http"
|
||||
"net/http/httptest"
|
||||
"strings"
|
||||
"testing"
|
||||
|
||||
"github.com/mhsanaei/3x-ui/v3/internal/web/session"
|
||||
@@ -80,7 +81,9 @@ func TestSecurityHeadersMiddleware(t *testing.T) {
|
||||
gin.SetMode(gin.TestMode)
|
||||
router := gin.New()
|
||||
router.Use(SecurityHeadersMiddleware(true))
|
||||
var capturedNonce string
|
||||
router.GET("/", func(c *gin.Context) {
|
||||
capturedNonce = c.GetString("csp_nonce")
|
||||
c.String(http.StatusOK, "ok")
|
||||
})
|
||||
|
||||
@@ -101,6 +104,33 @@ func TestSecurityHeadersMiddleware(t *testing.T) {
|
||||
if got := headers.Get("Strict-Transport-Security"); got == "" {
|
||||
t.Fatal("Strict-Transport-Security should be set for direct HTTPS")
|
||||
}
|
||||
|
||||
// CSP is the highest-value header here: assert it stays nonce-bound with its hardening
|
||||
// directives, so weakening it (unsafe-inline, dropped frame-ancestors, broken nonce) fails.
|
||||
csp := headers.Get("Content-Security-Policy")
|
||||
if csp == "" {
|
||||
t.Fatal("Content-Security-Policy header must be set")
|
||||
}
|
||||
if capturedNonce == "" {
|
||||
t.Fatal("csp_nonce context value must be set (the injected inline script reads it)")
|
||||
}
|
||||
if want := "script-src 'self' 'nonce-" + capturedNonce + "'"; !strings.Contains(csp, want) {
|
||||
t.Fatalf("CSP script-src must be bound to the per-request nonce %q; got %q", want, csp)
|
||||
}
|
||||
for _, directive := range []string{"object-src 'none'", "frame-ancestors 'none'", "base-uri 'self'", "form-action 'self'"} {
|
||||
if !strings.Contains(csp, directive) {
|
||||
t.Errorf("CSP missing hardening directive %q; got %q", directive, csp)
|
||||
}
|
||||
}
|
||||
// script-src must NOT allow 'unsafe-inline' (it would defeat the nonce). Check the
|
||||
// script-src directive in isolation, since style-src legitimately uses unsafe-inline.
|
||||
scriptDir := csp[strings.Index(csp, "script-src"):]
|
||||
if i := strings.Index(scriptDir, ";"); i >= 0 {
|
||||
scriptDir = scriptDir[:i]
|
||||
}
|
||||
if strings.Contains(scriptDir, "unsafe-inline") {
|
||||
t.Errorf("CSP script-src must not allow 'unsafe-inline': %q", scriptDir)
|
||||
}
|
||||
}
|
||||
|
||||
func TestSecurityHeadersMiddlewareSkipsHSTSWithoutDirectHTTPS(t *testing.T) {
|
||||
|
||||
@@ -0,0 +1,99 @@
|
||||
package middleware
|
||||
|
||||
import (
|
||||
"net/http"
|
||||
"net/http/httptest"
|
||||
"strings"
|
||||
"testing"
|
||||
|
||||
"github.com/gin-gonic/gin"
|
||||
)
|
||||
|
||||
// The accept side of validate.go:45 — `c.ShouldBindWith(&dst, binding.JSON)` must SUCCEED
|
||||
// for a well-formed JSON body and decode it into the destination struct. If the conditional
|
||||
// is flipped (err != nil -> err == nil) or the bind call is dropped, a valid body would be
|
||||
// rejected or the fields would come back zero-valued; both fail these assertions.
|
||||
func TestBindJSONAndValidate_ValidJSONDecodesAndPasses(t *testing.T) {
|
||||
var got *sampleBody
|
||||
r := newRouter(func(c *gin.Context) {
|
||||
var ok bool
|
||||
got, ok = BindJSONAndValidate[sampleBody](c)
|
||||
if !ok {
|
||||
t.Fatalf("expected ok=true for valid JSON; got false")
|
||||
}
|
||||
})
|
||||
|
||||
rec := httptest.NewRecorder()
|
||||
req := httptest.NewRequest(http.MethodPost, "/submit",
|
||||
strings.NewReader(`{"port":443,"protocol":"vless","tag":"inbound-443"}`))
|
||||
req.Header.Set("Content-Type", "application/json")
|
||||
r.ServeHTTP(rec, req)
|
||||
|
||||
if got == nil {
|
||||
t.Fatal("expected decoded struct; got nil")
|
||||
}
|
||||
if got.Port != 443 || got.Protocol != "vless" || got.Tag != "inbound-443" {
|
||||
t.Fatalf("decoded JSON mismatch: %+v", got)
|
||||
}
|
||||
}
|
||||
|
||||
// The reject side of validate.go:45 — a malformed JSON body must be caught by the bind
|
||||
// conditional, returning (nil,false) with a parse-error Message and NO validator Issues.
|
||||
// If the conditional is flipped so malformed input bypasses the bind check, control falls
|
||||
// through to validate.Struct on a zero-valued struct, which would instead emit validator
|
||||
// Issues (e.g. rule="required"/"gte"). Asserting empty Issues + non-empty Message pins the
|
||||
// distinct parse-failure path that line 45 owns.
|
||||
func TestBindJSONAndValidate_MalformedJSONRejectedWithoutValidatorIssues(t *testing.T) {
|
||||
r := newRouter(func(c *gin.Context) {
|
||||
if _, ok := BindJSONAndValidate[sampleBody](c); ok {
|
||||
t.Fatal("expected ok=false on malformed JSON; got true")
|
||||
}
|
||||
})
|
||||
|
||||
rec := httptest.NewRecorder()
|
||||
req := httptest.NewRequest(http.MethodPost, "/submit",
|
||||
strings.NewReader(`{"port":}`))
|
||||
req.Header.Set("Content-Type", "application/json")
|
||||
r.ServeHTTP(rec, req)
|
||||
|
||||
msg := decodeMsg(t, rec.Body.String())
|
||||
if msg.Success {
|
||||
t.Fatal("expected Success=false on malformed JSON")
|
||||
}
|
||||
payload, err := payloadFromObj(msg.Obj)
|
||||
if err != nil {
|
||||
t.Fatalf("payload extraction: %v", err)
|
||||
}
|
||||
if len(payload.Issues) != 0 {
|
||||
t.Fatalf("expected empty Issues for a JSON parse error (not validator output); got %+v", payload.Issues)
|
||||
}
|
||||
if payload.Message == "" {
|
||||
t.Fatal("expected non-empty Message describing the JSON parse error")
|
||||
}
|
||||
}
|
||||
|
||||
// BindJSONAndValidateInto shares the same line-45-style bind conditional (line 57). Cover its
|
||||
// accept side: a valid JSON body must bind onto the caller-supplied destination and pass,
|
||||
// overwriting any pre-populated field. A flipped/dropped bind check leaves the destination
|
||||
// untouched (or returns false), which these assertions catch.
|
||||
func TestBindJSONAndValidateInto_ValidJSONBindsOntoDestination(t *testing.T) {
|
||||
dst := &sampleBody{Tag: "preset"}
|
||||
r := newRouter(func(c *gin.Context) {
|
||||
if !BindJSONAndValidateInto(c, dst) {
|
||||
t.Fatal("expected ok=true for valid JSON; got false")
|
||||
}
|
||||
})
|
||||
|
||||
rec := httptest.NewRecorder()
|
||||
req := httptest.NewRequest(http.MethodPost, "/submit",
|
||||
strings.NewReader(`{"port":8443,"protocol":"trojan","tag":"inbound-8443"}`))
|
||||
req.Header.Set("Content-Type", "application/json")
|
||||
r.ServeHTTP(rec, req)
|
||||
|
||||
if dst.Port != 8443 || dst.Protocol != "trojan" {
|
||||
t.Fatalf("expected JSON to bind onto destination; got %+v", dst)
|
||||
}
|
||||
if dst.Tag != "inbound-8443" {
|
||||
t.Fatalf("expected payload Tag to overwrite preset; got %q", dst.Tag)
|
||||
}
|
||||
}
|
||||
Reference in New Issue
Block a user