CBG-5126: disable rev cache test env (#8016)

gregns1 · web-flow · commit ac42c0a4cd2a · 2026-01-30T14:08:21.000Z
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -136,6 +136,25 @@ jobs:
         with:
           test-results: test.json
 
+  test-disable-rev-cache:
+    runs-on: ubuntu-latest
+    env:
+      GOPRIVATE: github.com/couchbaselabs
+      SG_TEST_DISABLE_REV_CACHE: true
+    steps:
+      - uses: actions/checkout@v5
+      - uses: actions/setup-go@v5
+        with:
+          go-version: 1.25.6
+      - name: Run Tests
+        run: go test -tags cb_sg_devmode -shuffle=on -timeout=30m -count=1 -json -v "./..." | tee test.json | jq -s -jr 'sort_by(.Package,.Time) | .[].Output | select (. != null )'
+        shell: bash
+      - name: Annotate Failures
+        if: always()
+        uses: guyarb/golang-test-annotations@v0.8.0
+        with:
+          test-results: test.json
+
   python-format:
     runs-on: ubuntu-latest
     steps:
diff --git a/base/constants.go b/base/constants.go
@@ -47,6 +47,9 @@ const (
 	TestEnvSyncGatewayUseXattrs = "SG_TEST_USE_XATTRS"
 	TestEnvSyncGatewayTrue      = "True"
 
+	// TestEnvDisableRevCache if set to true will disable the revision cache for tests
+	TestEnvDisableRevCache = "SG_TEST_DISABLE_REV_CACHE"
+
 	// Should the tests drop the GSI indexes?
 	TestEnvSyncGatewayDropIndexes = "SG_TEST_DROP_INDEXES"
 
diff --git a/base/util_testing.go b/base/util_testing.go
@@ -284,6 +284,15 @@ func TestsDisableGSI() bool {
 	return !useGSI
 }
 
+// TestDisableRevCache returns true if environment variable SG_TEST_DISABLE_REV_CACHE is set to true
+func TestDisableRevCache() bool {
+	if disableRevCache := os.Getenv(TestEnvDisableRevCache); disableRevCache != "" {
+		val, _ := strconv.ParseBool(disableRevCache)
+		return val
+	}
+	return false
+}
+
 // Check the whether tests are being run with SG_TEST_BACKING_STORE=Couchbase
 func TestUseCouchbaseServer() bool {
 	backingStore := os.Getenv(TestEnvSyncGatewayBackingStore)
diff --git a/db/attachment_test.go b/db/attachment_test.go
@@ -107,6 +107,9 @@ func TestBackupOldRevisionWithAttachments(t *testing.T) {
 }
 
 func TestGetBackupRevisionWhenCurrentRevisionHasAttachments(t *testing.T) {
+	if base.TestDisableRevCache() {
+		t.Skip("pending fix in CBG-5141")
+	}
 	base.SetUpTestLogging(t, base.LevelDebug, base.KeyAll)
 
 	db, ctx := SetupTestDBWithOptions(t, DatabaseContextOptions{
@@ -138,7 +141,7 @@ func TestGetBackupRevisionWhenCurrentRevisionHasAttachments(t *testing.T) {
 	require.NoError(t, err)
 
 	// assert version is fetched and attachments is empty
-	assert.Equal(t, docRev.CV.String(), doc1.HLV.GetCurrentVersionString())
+	assert.Equal(t, doc1.HLV.GetCurrentVersionString(), docRev.CV.String())
 	assert.Empty(t, docRev.Attachments)
 }
 
diff --git a/db/database_test.go b/db/database_test.go
@@ -1154,6 +1154,9 @@ func TestDeltaSyncConcurrentClientCachePopulation(t *testing.T) {
 	if !base.IsEnterpriseEdition() {
 		t.Skip("Delta sync only supported in EE")
 	}
+	if base.TestDisableRevCache() {
+		t.Skip("test requires revision cache to be enabled")
+	}
 
 	tests := []struct {
 		name              string
@@ -1661,7 +1664,6 @@ func TestGetRemovedAndDeleted(t *testing.T) {
 	assert.NoError(t, err, "Put")
 
 	rev2body := Body{
-		"key1":      1234,
 		BodyDeleted: true,
 		BodyRev:     rev1id,
 	}
@@ -1683,7 +1685,6 @@ func TestGetRemovedAndDeleted(t *testing.T) {
 	rev2digest := rev2id[2:]
 	rev1digest := rev1id[2:]
 	expectedResult := Body{
-		"key1":      1234,
 		BodyDeleted: true,
 		BodyRevisions: Revisions{
 			RevisionsStart: 2,
diff --git a/db/revision_cache_bypass.go b/db/revision_cache_bypass.go
@@ -40,6 +40,7 @@ func (rc *BypassRevisionCache) GetWithRev(ctx context.Context, docID, revID stri
 
 	docRev = DocumentRevision{
 		RevID:                  revID,
+		DocID:                  docID,
 		RevCacheValueDeltaLock: &sync.Mutex{}, // initialize the mutex for delta updates
 	}
 	var hlv *HybridLogicalVector
@@ -62,6 +63,7 @@ func (rc *BypassRevisionCache) GetWithCV(ctx context.Context, docID string, cv *
 
 	docRev = DocumentRevision{
 		CV:                     cv,
+		DocID:                  docID,
 		RevCacheValueDeltaLock: &sync.Mutex{}, // initialize the mutex for delta updates
 	}
 
@@ -95,6 +97,7 @@ func (rc *BypassRevisionCache) GetActive(ctx context.Context, docID string, coll
 
 	docRev = DocumentRevision{
 		RevID:                  doc.GetRevTreeID(),
+		DocID:                  docID,
 		RevCacheValueDeltaLock: &sync.Mutex{}, // initialize the mutex for delta updates
 	}
 
diff --git a/db/revision_cache_test.go b/db/revision_cache_test.go
@@ -277,6 +277,9 @@ func TestLRURevisionCacheEvictionMixedRevAndCV(t *testing.T) {
 }
 
 func TestLRURevisionCacheEvictionMemoryBased(t *testing.T) {
+	if base.TestDisableRevCache() {
+		t.Skip("Revision cache disabled, eviction test needs revision cache enabled")
+	}
 	testCases := []struct {
 		name       string
 		UseCVCache bool
@@ -691,6 +694,9 @@ func TestBypassRevisionCache(t *testing.T) {
 // Ensure attachment properties aren't being incorrectly stored in revision cache body when inserted via Put
 func TestPutRevisionCacheAttachmentProperty(t *testing.T) {
 
+	if base.TestDisableRevCache() {
+		t.Skip("Revision cache expected to be used for this test")
+	}
 	base.SetUpTestLogging(t, base.LevelInfo, base.KeyAll)
 
 	db, ctx := setupTestDB(t)
@@ -959,6 +965,9 @@ func TestImmediateRevCacheMemoryBasedEviction(t *testing.T) {
 //   - Add new doc that will take over the shard memory capacity and assert that that eviction takes place and
 //     all stats are as expected
 func TestShardedMemoryEviction(t *testing.T) {
+	if base.TestDisableRevCache() {
+		t.Skip("Test is sharded revision cache specific")
+	}
 	dbcOptions := DatabaseContextOptions{
 		RevisionCacheOptions: &RevisionCacheOptions{
 			MaxBytes:     160,
@@ -1009,6 +1018,9 @@ func TestShardedMemoryEviction(t *testing.T) {
 //   - Test adding a doc to sharded revision cache that will immediately be evicted due to size
 //   - Assert that stats look as expected
 func TestShardedMemoryEvictionWhenShardEmpty(t *testing.T) {
+	if base.TestDisableRevCache() {
+		t.Skip("test is sharded revision cache specific")
+	}
 	dbcOptions := DatabaseContextOptions{
 		RevisionCacheOptions: &RevisionCacheOptions{
 			MaxBytes:     100,
@@ -1112,6 +1124,9 @@ func TestImmediateRevCacheItemBasedEviction(t *testing.T) {
 }
 
 func TestResetRevCache(t *testing.T) {
+	if base.TestDisableRevCache() {
+		t.Skip("Revision cache expected to be used for this test")
+	}
 	dbcOptions := DatabaseContextOptions{
 		RevisionCacheOptions: &RevisionCacheOptions{
 			MaxBytes:     100,
@@ -1137,6 +1152,9 @@ func TestResetRevCache(t *testing.T) {
 }
 
 func TestBasicOperationsOnCacheWithMemoryStat(t *testing.T) {
+	if base.TestDisableRevCache() {
+		t.Skip("Revision cache expected to be used for this test")
+	}
 	testCases := []struct {
 		name       string
 		UseCVCache bool
@@ -1333,6 +1351,9 @@ func TestConcurrentLoad(t *testing.T) {
 }
 
 func TestRevisionCacheRemove(t *testing.T) {
+	if base.TestDisableRevCache() {
+		t.Skip("test requires revision cache to be enabled")
+	}
 	db, ctx := setupTestDB(t)
 	defer db.Close(ctx)
 	collection, ctx := GetSingleDatabaseCollectionWithUser(ctx, t, db)
@@ -1375,6 +1396,9 @@ func TestRevisionCacheRemove(t *testing.T) {
 //   - Assert each doc returned is the correct one (correct rev ID etc)
 //   - Assert that each doc is found at the rev cache and no misses are reported
 func TestRevCacheHitMultiCollection(t *testing.T) {
+	if base.TestDisableRevCache() {
+		t.Skip("test requires revision cache to be enabled")
+	}
 	base.TestRequiresCollections(t)
 
 	tb := base.GetTestBucket(t)
@@ -2226,6 +2250,9 @@ func TestPutRevHighRevCacheChurn(t *testing.T) {
 }
 
 func TestRevCacheOnDemandImportNoCache(t *testing.T) {
+	if base.TestDisableRevCache() {
+		t.Skip("test requires rev cache enabled")
+	}
 	base.SkipImportTestsIfNotEnabled(t)
 
 	db, ctx := setupTestDB(t)
@@ -2255,6 +2282,9 @@ func TestRevCacheOnDemandImportNoCache(t *testing.T) {
 }
 
 func TestFetchBackupWithDeletedFlag(t *testing.T) {
+	if base.TestDisableRevCache() {
+		t.Skip("pending fix in CBG-5141")
+	}
 	db, ctx := SetupTestDBWithOptions(t, DatabaseContextOptions{
 		// enable delta sync so CV revs are backed up
 		DeltaSyncOptions: DeltaSyncOptions{
@@ -2354,6 +2384,9 @@ func TestRemoveFromRevLookup(t *testing.T) {
 }
 
 func TestLoadFromBucketLegacyRevsThatAreBackedUpPreUpgrade(t *testing.T) {
+	if base.TestDisableRevCache() {
+		t.Skip("test requires rev cache enabled")
+	}
 	db, ctx := SetupTestDBWithOptions(t, DatabaseContextOptions{
 		OldRevExpirySeconds: base.DefaultOldRevExpirySeconds,
 		RevisionCacheOptions: &RevisionCacheOptions{
@@ -2561,6 +2594,9 @@ func TestUpdateDeltaRevCacheMemoryStatPanicMultipleEntries(t *testing.T) {
 }
 
 func TestEvictionOfRevIDKeysWhenNoItemInCVMap(t *testing.T) {
+	if base.TestDisableRevCache() {
+		t.Skip("test requires rev cache enabled for eviction to run")
+	}
 	db, ctx := SetupTestDBWithOptions(t, DatabaseContextOptions{
 		OldRevExpirySeconds: base.DefaultOldRevExpirySeconds,
 		RevisionCacheOptions: &RevisionCacheOptions{
@@ -2614,6 +2650,9 @@ func TestEvictionOfRevIDKeysWhenNoItemInCVMap(t *testing.T) {
 }
 
 func TestEvictionOfCVKeysWhenNoItemInRevMap(t *testing.T) {
+	if base.TestDisableRevCache() {
+		t.Skip("test requires rev cache enabled for eviction to run")
+	}
 	db, ctx := SetupTestDBWithOptions(t, DatabaseContextOptions{
 		OldRevExpirySeconds: base.DefaultOldRevExpirySeconds,
 		RevisionCacheOptions: &RevisionCacheOptions{
@@ -2681,6 +2720,9 @@ func TestEvictionOfCVKeysWhenNoItemInRevMap(t *testing.T) {
 
 func TestBasicLoadBackupRevCacheOnlyPopulateOneMap(t *testing.T) {
 
+	if base.TestDisableRevCache() {
+		t.Skip("test requires rev cache enabled")
+	}
 	db, ctx := SetupTestDBWithOptions(t, DatabaseContextOptions{
 		OldRevExpirySeconds: base.DefaultOldRevExpirySeconds,
 		RevisionCacheOptions: &RevisionCacheOptions{
@@ -2741,6 +2783,9 @@ func TestBasicLoadBackupRevCacheOnlyPopulateOneMap(t *testing.T) {
 }
 
 func TestItemResidentInCacheBackupRevLoaded(t *testing.T) {
+	if base.TestDisableRevCache() {
+		t.Skip("test requires rev cache enabled")
+	}
 	testCases := []struct {
 		name     string
 		useRevID bool
diff --git a/db/util_testing.go b/db/util_testing.go
@@ -573,6 +573,13 @@ func AddOptionsFromEnvironmentVariables(dbcOptions *DatabaseContextOptions) {
 	if base.TestsDisableGSI() {
 		dbcOptions.UseViews = true
 	}
+
+	if base.TestDisableRevCache() {
+		if dbcOptions.RevisionCacheOptions == nil {
+			dbcOptions.RevisionCacheOptions = DefaultRevisionCacheOptions()
+		}
+		dbcOptions.RevisionCacheOptions.MaxItemCount = 0
+	}
 }
 
 // SetupTestDBWithOptions creates an online test db with the specified database context options. Note that environment variables will override values (SG_TEST_USE_XATTRS, SG_TEST_USE_DEFAULT_COLLECTION).
diff --git a/jenkins-integration-build.sh b/jenkins-integration-build.sh
@@ -74,6 +74,10 @@ if [ "${TEST_DEBUG:-}" == "true" ]; then
     export SG_TEST_BUCKET_POOL_DEBUG="true"
 fi
 
+if [ "${DISABLE_REV_CACHE:-}" == "true" ]; then
+    export SG_TEST_DISABLE_REV_CACHE="true"
+fi
+
 if [ "${TARGET_TEST}" != "ALL" ]; then
     GO_TEST_FLAGS+=(-run "${TARGET_TEST}")
 fi
diff --git a/rest/api_test.go b/rest/api_test.go
@@ -3401,6 +3401,9 @@ func TestHLVUpdateOnRevReplicatorPut(t *testing.T) {
 }
 
 func TestDocCRUDWithCV(t *testing.T) {
+	if base.TestDisableRevCache() {
+		t.Skip("Test requires revision cache to be enabled, fetches older revisions expecting to be resident in cache")
+	}
 	rt := NewRestTester(t, nil)
 	defer rt.Close()
 
diff --git a/rest/blip_api_delta_sync_test.go b/rest/blip_api_delta_sync_test.go
@@ -836,13 +836,17 @@ func TestBlipDeltaSyncPullTombstonedStarChan(t *testing.T) {
 
 		sgCanUseDelta := base.IsEnterpriseEdition()
 		if sgCanUseDelta {
-			assert.Equal(t, deltaCacheHitsStart+1, deltaCacheHitsEnd)
-			assert.Equal(t, deltaCacheMissesStart+1, deltaCacheMissesEnd)
+			if !base.TestDisableRevCache() {
+				assert.Equal(t, deltaCacheHitsStart+1, deltaCacheHitsEnd)
+				assert.Equal(t, deltaCacheMissesStart+1, deltaCacheMissesEnd)
+			}
 			assert.Equal(t, deltasRequestedStart+2, deltasRequestedEnd)
 			assert.Equal(t, deltasSentStart+2, deltasSentEnd)
 		} else {
-			assert.Equal(t, deltaCacheHitsStart, deltaCacheHitsEnd)
-			assert.Equal(t, deltaCacheMissesStart, deltaCacheMissesEnd)
+			if !base.TestDisableRevCache() {
+				assert.Equal(t, deltaCacheHitsStart, deltaCacheHitsEnd)
+				assert.Equal(t, deltaCacheMissesStart, deltaCacheMissesEnd)
+			}
 			assert.Equal(t, deltasRequestedStart, deltasRequestedEnd)
 			assert.Equal(t, deltasSentStart, deltasSentEnd)
 		}
@@ -856,6 +860,9 @@ func TestBlipDeltaSyncPullRevCache(t *testing.T) {
 	if !base.IsEnterpriseEdition() {
 		t.Skipf("Skipping enterprise-only delta sync test.")
 	}
+	if base.TestDisableRevCache() {
+		t.Skip("rev cache specific test")
+	}
 
 	base.SetUpTestLogging(t, base.LevelDebug, base.KeyAll)
 
diff --git a/rest/changestest/changes_api_test.go b/rest/changestest/changes_api_test.go
@@ -1757,6 +1757,7 @@ func updateTestDoc(rt *rest.RestTester, docid string, revid string, body string)
 // Validate retrieval of various document body types using include_docs.
 func TestChangesIncludeDocs(t *testing.T) {
 	base.SetUpTestLogging(t, base.LevelInfo, base.KeyNone)
+	t.Skip("pending CBG-4542")
 
 	rtConfig := rest.RestTesterConfig{SyncFn: `function(doc) {channel(doc.channels)}`}
 	rt := rest.NewRestTester(t, &rtConfig)
diff --git a/rest/config_test.go b/rest/config_test.go
@@ -3070,6 +3070,9 @@ func TestNotFoundOnInvalidDatabase(t *testing.T) {
 
 func TestRevCacheMemoryLimitConfig(t *testing.T) {
 	base.SetUpTestLogging(t, base.LevelInfo, base.KeyAll)
+	if base.TestDisableRevCache() {
+		t.Skip("test is rev cache config related test, should not override the test")
+	}
 	rt := NewRestTester(t, &RestTesterConfig{
 		CustomTestBucket: base.GetTestBucket(t),
 		PersistentConfig: true,
diff --git a/rest/importtest/import_test.go b/rest/importtest/import_test.go
@@ -1582,6 +1582,9 @@ func TestImportZeroValueDecimalPlacesScientificNotation(t *testing.T) {
 func TestImportRevisionCopy(t *testing.T) {
 
 	base.SkipImportTestsIfNotEnabled(t)
+	if base.TestDisableRevCache() {
+		t.Skip("Backup import revs requires previous rev to be in revision cache")
+	}
 
 	rtConfig := rest.RestTesterConfig{
 		SyncFn: `function(doc, oldDoc) { channel(doc.channels) }`,
diff --git a/rest/replicatortest/replicator_test.go b/rest/replicatortest/replicator_test.go
@@ -6873,6 +6873,9 @@ func TestUnprocessableDeltas(t *testing.T) {
 	if !base.IsEnterpriseEdition() {
 		t.Skipf("Requires EE for some delta sync")
 	}
+	if base.TestDisableRevCache() {
+		t.Skipf("Test requires altering of rev cache values")
+	}
 
 	// need Sync debugging due to AssertLogContains below
 	base.SetUpTestLogging(t, base.LevelDebug, base.KeySync)
diff --git a/rest/revocation_test.go b/rest/revocation_test.go
diff --git a/rest/utilities_testing.go b/rest/utilities_testing.go

Original file line number	Diff line number	Diff line change
`@@ -107,6 +107,9 @@ func TestBackupOldRevisionWithAttachments(t *testing.T) {`
`107`	`107`	`}`
`108`	`108`
`109`	`109`	`func TestGetBackupRevisionWhenCurrentRevisionHasAttachments(t *testing.T) {`
	`110`	`+ if base.TestDisableRevCache() {`
	`111`	`+ t.Skip("pending fix in CBG-5141")`
	`112`	`+ }`
`110`	`113`	`base.SetUpTestLogging(t, base.LevelDebug, base.KeyAll)`
`111`	`114`
`112`	`115`	`db, ctx := SetupTestDBWithOptions(t, DatabaseContextOptions{`
`@@ -138,7 +141,7 @@ func TestGetBackupRevisionWhenCurrentRevisionHasAttachments(t *testing.T) {`
`138`	`141`	`require.NoError(t, err)`
`139`	`142`
`140`	`143`	`// assert version is fetched and attachments is empty`
`141`		`- assert.Equal(t, docRev.CV.String(), doc1.HLV.GetCurrentVersionString())`
	`144`	`+ assert.Equal(t, doc1.HLV.GetCurrentVersionString(), docRev.CV.String())`
`142`	`145`	`assert.Empty(t, docRev.Attachments)`
`143`	`146`	`}`
`144`	`147`
Original file line number	Diff line number	Diff line change
`@@ -40,6 +40,7 @@ func (rc *BypassRevisionCache) GetWithRev(ctx context.Context, docID, revID stri`
`40`	`40`
`41`	`41`	`docRev = DocumentRevision{`
`42`	`42`	`RevID: revID,`
	`43`	`+ DocID: docID,`
`43`	`44`	`RevCacheValueDeltaLock: &sync.Mutex{}, // initialize the mutex for delta updates`
`44`	`45`	`}`
`45`	`46`	`var hlv *HybridLogicalVector`
`@@ -62,6 +63,7 @@ func (rc BypassRevisionCache) GetWithCV(ctx context.Context, docID string, cv `
`62`	`63`
`63`	`64`	`docRev = DocumentRevision{`
`64`	`65`	`CV: cv,`
	`66`	`+ DocID: docID,`
`65`	`67`	`RevCacheValueDeltaLock: &sync.Mutex{}, // initialize the mutex for delta updates`
`66`	`68`	`}`
`67`	`69`
`@@ -95,6 +97,7 @@ func (rc *BypassRevisionCache) GetActive(ctx context.Context, docID string, coll`
`95`	`97`
`96`	`98`	`docRev = DocumentRevision{`
`97`	`99`	`RevID: doc.GetRevTreeID(),`
	`100`	`+ DocID: docID,`
`98`	`101`	`RevCacheValueDeltaLock: &sync.Mutex{}, // initialize the mutex for delta updates`
`99`	`102`	`}`
`100`	`103`
Original file line number	Diff line number	Diff line change
`@@ -573,6 +573,13 @@ func AddOptionsFromEnvironmentVariables(dbcOptions *DatabaseContextOptions) {`
`573`	`573`	`if base.TestsDisableGSI() {`
`574`	`574`	`dbcOptions.UseViews = true`
`575`	`575`	`}`
	`576`	`+`
	`577`	`+ if base.TestDisableRevCache() {`
	`578`	`+ if dbcOptions.RevisionCacheOptions == nil {`
	`579`	`+ dbcOptions.RevisionCacheOptions = DefaultRevisionCacheOptions()`
	`580`	`+ }`
	`581`	`+ dbcOptions.RevisionCacheOptions.MaxItemCount = 0`
	`582`	`+ }`
`576`	`583`	`}`
`577`	`584`
`578`	`585`	`// SetupTestDBWithOptions creates an online test db with the specified database context options. Note that environment variables will override values (SG_TEST_USE_XATTRS, SG_TEST_USE_DEFAULT_COLLECTION).`
Original file line number	Diff line number	Diff line change
`@@ -3401,6 +3401,9 @@ func TestHLVUpdateOnRevReplicatorPut(t *testing.T) {`
`3401`	`3401`	`}`
`3402`	`3402`
`3403`	`3403`	`func TestDocCRUDWithCV(t *testing.T) {`
	`3404`	`+ if base.TestDisableRevCache() {`
	`3405`	`+ t.Skip("Test requires revision cache to be enabled, fetches older revisions expecting to be resident in cache")`
	`3406`	`+ }`
`3404`	`3407`	`rt := NewRestTester(t, nil)`
`3405`	`3408`	`defer rt.Close()`
`3406`	`3409`