[3.2.3 backport] CBG-4480: fail test harness if dev time assertions hit (#7313)

* CBG-4340 fail test harness if dev time assertions hit

If a panic occurs in a goroutine, like ServeHTTP handler, it might be
swallowed.

* remove unreachable code

* Update rest/handler.go

---------

Co-authored-by: Ben Brooks <[email protected]>

Author: torcolvin

base/audit_types.go

@@ -9,6 +9,7 @@
 package base
 
 import (
+	"context"
 	"encoding/json"
 	"fmt"
 	"reflect"
@@ -150,9 +151,9 @@ func (ed *EventDescriptor) expandOptionalFieldGroups(groups []fieldGroup) {
 	}
 }
 
-func (i AuditID) MustValidateFields(f AuditFields) {
+func (i AuditID) MustValidateFields(ctx context.Context, f AuditFields) {
 	if err := i.ValidateFields(f); err != nil {
-		panic(fmt.Errorf("audit event %q (%s) invalid:\n%v", i, AuditEvents[i].Name, err))
+		AssertfCtx(ctx, "audit event %q (%s) invalid:\n%v", i, AuditEvents[i].Name, err)
 	}
 }
 

base/devmode.go

@@ -8,7 +8,10 @@
 
 package base
 
-import "context"
+import (
+	"context"
+	"sync/atomic"
+)
 
 // IsDevMode returns true when compiled with the `cb_sg_devmode` build tag, and false otherwise.
 //
@@ -18,6 +21,9 @@ func IsDevMode() bool {
 	return cbSGDevModeBuildTagSet
 }
 
+// DevModeAssertionFailures is a counter of the number of assertion failures that have occurred in dev mode. This will always be zero in non-dev mode.
+var DevModeAssertionFailures atomic.Uint32
+
 // AssertfCtx panics when compiled with the `cb_sg_devmode` build tag, and just warns otherwise.
 // Callers must be aware that they are responsible for handling returns to cover the non-devmode warn case.
 func AssertfCtx(ctx context.Context, format string, args ...any) {

base/devmode_on.go

@@ -11,6 +11,13 @@
 
 package base
 
+import (
+	"context"
+)
+
 const cbSGDevModeBuildTagSet = true
 
-var assertLogFn logFn = PanicfCtx
+var assertLogFn logFn = func(ctx context.Context, format string, args ...any) {
+	DevModeAssertionFailures.Add(1)
+	PanicfCtx(ctx, format, args...)
+}

base/logger_audit.go

@@ -128,7 +128,7 @@ func Audit(ctx context.Context, id AuditID, additionalData AuditFields) {
 			globalFields = logger.globalFields
 		}
 		fields = expandFields(id, ctx, globalFields, additionalData)
-		id.MustValidateFields(fields)
+		id.MustValidateFields(ctx, fields)
 	}
 
 	if !logger.shouldLog(id, ctx) {

base/main_test_bucket_pool.go

@@ -725,6 +725,11 @@ func TestBucketPoolMain(ctx context.Context, m *testing.M, bucketReadierFunc TBP
 	GTestBucketPool = NewTestBucketPoolWithOptions(ctx, bucketReadierFunc, bucketInitFunc, options)
 	teardownFuncs = append(teardownFuncs, func() { GTestBucketPool.Close(ctx) })
 
+	teardownFuncs = append(teardownFuncs, func() {
+		if DevModeAssertionFailures.Load() > 0 {
+			panic("Test harness failed due to failures from -tag cb_sg_devmode. Look at logs for panic statements.")
+		}
+	})
 	// must be the last teardown function added to the list to correctly detect leaked goroutines
 	teardownFuncs = append(teardownFuncs, SetUpTestGoroutineDump(m))
 

rest/handler.go

@@ -965,6 +965,7 @@ func (h *handler) checkPublicAuth(dbCtx *db.DatabaseContext) (err error) {
 				provider := dbCtx.Options.OIDCOptions.Providers.GetProviderForIssuer(h.ctx(), issuerUrlForDB(h, dbCtx.Name), testProviderAudiences)
 				if provider != nil && provider.ValidationKey != nil {
 					if base.StringDefault(provider.ClientID, "") == username && *provider.ValidationKey == password {
+						auditFields = base.AuditFields{base.AuditFieldAuthMethod: "basic"}
 						return nil
 					}
 				}