Relax assertion for CBS resurrection

Author: torcolvin

topologytest/couchbase_lite_mock_peer_test.go

@@ -142,6 +142,22 @@ func (p *CouchbaseLiteMockPeer) WaitForDocVersion(dsName sgbucket.DataStoreName,
 	return body
 }
 
+// WaitForCV waits for a document to reach a specific CV. Returns the state of the document at that version. The test will fail if the document does not reach the expected version in 20s.
+func (p *CouchbaseLiteMockPeer) WaitForCV(dsName sgbucket.DataStoreName, docID string, expected DocMetadata, replications Replications) db.Body {
+	var data []byte
+	require.EventuallyWithT(p.TB(), func(c *assert.CollectT) {
+		var actual *DocMetadata
+		data, actual = p.getLatestDocVersion(dsName, docID)
+		if !assert.NotNil(c, actual, "Could not find docID:%+v on %p\nVersion %#v", docID, p, expected) {
+			return
+		}
+		assertCVEqual(c, docID, p.name, *actual, data, expected, replications)
+	}, totalWaitTime, pollInterval)
+	var body db.Body
+	require.NoError(p.TB(), base.JSONUnmarshal(data, &body))
+	return body
+}
+
 // WaitForTombstoneVersion waits for a document to reach a specific version, this must be a tombstone. The test will fail if the document does not reach the expected version in 20s.
 func (p *CouchbaseLiteMockPeer) WaitForTombstoneVersion(dsName sgbucket.DataStoreName, docID string, expected DocMetadata, replications Replications) {
 	client := p.getSingleSGBlipClient().CollectionClient(dsName)

topologytest/couchbase_server_peer_test.go

@@ -184,6 +184,14 @@ func (p *CouchbaseServerPeer) WaitForDocVersion(dsName sgbucket.DataStoreName, d
 	return body
 }
 
+// WaitForCV waits for a document to reach a specific CV. The test will fail if the document does not reach the expected version in 20s.
+func (p *CouchbaseServerPeer) WaitForCV(dsName sgbucket.DataStoreName, docID string, expected DocMetadata, replications Replications) db.Body {
+	docBytes := p.waitForCV(dsName, docID, expected, replications)
+	var body db.Body
+	require.NoError(p.TB(), base.JSONUnmarshal(docBytes, &body), "couldn't unmarshal docID %s: %s", docID, docBytes)
+	return body
+}
+
 // WaitForTombstoneVersion waits for a document to reach a specific version, this must be a tombstone. The test will fail if the document does not reach the expected version in 20s.
 func (p *CouchbaseServerPeer) WaitForTombstoneVersion(dsName sgbucket.DataStoreName, docID string, expected DocMetadata, replications Replications) {
 	docBytes := p.waitForDocVersion(dsName, docID, expected, replications)
@@ -208,6 +216,24 @@ func (p *CouchbaseServerPeer) waitForDocVersion(dsName sgbucket.DataStoreName, d
 	return docBytes
 }
 
+// waitForCV waits for a document to reach a specific CV and returns the body in bytes. The bytes will be nil if the document is a tombstone. The test will fail if the document does not reach the expected version in 20s.
+func (p *CouchbaseServerPeer) waitForCV(dsName sgbucket.DataStoreName, docID string, expected DocMetadata, replications Replications) []byte {
+	var docBytes []byte
+	var version DocMetadata
+	require.EventuallyWithT(p.TB(), func(c *assert.CollectT) {
+		var err error
+		var xattrs map[string][]byte
+		var cas uint64
+		docBytes, xattrs, cas, err = p.getCollection(dsName).GetWithXattrs(p.Context(), docID, metadataXattrNames)
+		if !assert.NoError(c, err) {
+			return
+		}
+		version = getDocVersion(docID, p, cas, xattrs)
+		assertCVEqual(c, docID, p.name, version, docBytes, expected, replications)
+	}, totalWaitTime, pollInterval)
+	return docBytes
+}
+
 // Close will shut down the peer and close any active replications on the peer.
 func (p *CouchbaseServerPeer) Close() {
 	for _, r := range p.pullReplications {

topologytest/hlv_test.go

@@ -15,7 +15,6 @@ import (
 
 	"github.com/couchbase/sync_gateway/base"
 	"github.com/couchbase/sync_gateway/db"
-	"github.com/stretchr/testify/assert"
 	"github.com/stretchr/testify/require"
 )
 
@@ -60,6 +59,15 @@ func waitForVersionAndBody(t *testing.T, dsName base.ScopeAndCollectionName, pee
 	}
 }
 
+// waitForCVAndBody waits for a document to reach a specific cv on all peers.
+func waitForCVAndBody(t *testing.T, dsName base.ScopeAndCollectionName, peers Peers, replications Replications, docID string, expectedVersion BodyAndVersion) {
+	t.Logf("waiting for doc version on all peers, written from %s: %#v", expectedVersion.updatePeer, expectedVersion)
+	for _, peer := range peers.SortedPeers() {
+		t.Logf("waiting for doc version on peer %s, written from %s: %#v", peer, expectedVersion.updatePeer, expectedVersion)
+		body := peer.WaitForCV(dsName, docID, expectedVersion.docMeta, replications)
+		requireBodyEqual(t, expectedVersion.body, body)
+	}
+}
 func waitForTombstoneVersion(t *testing.T, dsName base.ScopeAndCollectionName, peers Peers, replications Replications, docID string, expectedVersion BodyAndVersion) {
 	t.Logf("waiting for tombstone version on all peers, written from %s: %#v", expectedVersion.updatePeer, expectedVersion)
 	for _, peer := range peers.SortedPeers() {
@@ -156,31 +164,6 @@ func getDocID(t *testing.T) string {
 	return fmt.Sprintf("doc_%s", name)
 }
 
-// waitForConvergingVersion waits for the same document version to reach all peers.
-func waitForConvergingVersion(t *testing.T, dsName base.ScopeAndCollectionName, peers Peers, replications Replications, docID string) {
-	t.Logf("waiting for converged doc versions across all peers")
-	var docMetaA DocMetadata
-	var bodyA db.Body
-	if !assert.EventuallyWithT(t, func(c *assert.CollectT) {
-		for peerAid, peerA := range peers.SortedPeers() {
-			docMetaA, bodyA = peerA.GetDocument(dsName, docID)
-			for peerBid, peerB := range peers.SortedPeers() {
-				if peerAid == peerBid {
-					continue
-				}
-				docMetaB, bodyB := peerB.GetDocument(dsName, docID)
-				cvA, cvB := docMetaA.CV(t), docMetaB.CV(t)
-				require.Equalf(c, cvA, cvB, "CV mismatch: %s:%#v != %s:%#v", peerAid, docMetaA, peerBid, docMetaB)
-				require.Equalf(c, bodyA, bodyB, "body mismatch: %s:%s != %s:%s", peerAid, bodyA, peerBid, bodyB)
-			}
-		}
-	}, totalWaitTime, pollInterval) {
-		// do if !assert->require pattern so we can delay PrintGlobalDocState evaluation
-		require.FailNowf(t, "Peers did not converge on version", "Global state for doc %q on all peers:\n%s\nReplications: %s", docID, peers.PrintGlobalDocState(t, dsName, docID), replications)
-	}
-	t.Logf("Peers converged on %q version: %#+v body %s", docID, docMetaA, bodyA)
-}
-
 // PrintGlobalDocState returns the current state of a document across all peers, and also logs it on `t`.
 func (p Peers) PrintGlobalDocState(t testing.TB, dsName base.ScopeAndCollectionName, docID string) string {
 	var globalState strings.Builder

topologytest/multi_actor_no_conflict_test.go

@@ -102,7 +102,12 @@ func TestMultiActorResurrect(t *testing.T) {
 
 							resBody := []byte(fmt.Sprintf(`{"activePeer": "%s", "createPeer": "%s", "deletePeer": "%s", "resurrectPeer": "%s", "topology": "%s", "action": "resurrect"}`, resurrectPeerName, createPeerName, deletePeer, resurrectPeer, topology.description))
 							resurrectVersion := resurrectPeer.WriteDocument(collectionName, docID, resBody)
-							waitForVersionAndBody(t, collectionName, peers, replications, docID, resurrectVersion)
+							// in the case of a Couchbase Server resurrection, the hlv is lost since all system xattrs are lost on a resurrection
+							if resurrectPeer.Type() == PeerTypeCouchbaseServer {
+								waitForCVAndBody(t, collectionName, peers, replications, docID, resurrectVersion)
+							} else {
+								waitForVersionAndBody(t, collectionName, peers, replications, docID, resurrectVersion)
+							}
 						})
 					}
 				}

topologytest/peer_test.go

@@ -51,6 +51,9 @@ type Peer interface {
 	// WaitForDocVersion waits for a document to reach a specific version. Returns the state of the document at that version. The test will fail if the document does not reach the expected version in 20s.
 	WaitForDocVersion(dsName sgbucket.DataStoreName, docID string, expected DocMetadata, replications Replications) db.Body
 
+	// WaitForCV waits for a document to reach a specific CV. Returns the state of the document at that version. The test will fail if the document does not reach the expected version in 20s.
+	WaitForCV(dsName sgbucket.DataStoreName, docID string, expected DocMetadata, replications Replications) db.Body
+
 	// WaitForTombstoneVersion waits for a document to reach a specific version. This document must be a tombstone. The test will fail if the document does not reach the expected version in 20s.
 	WaitForTombstoneVersion(dsName sgbucket.DataStoreName, docID string, expected DocMetadata, replications Replications)
 

topologytest/sync_gateway_peer_test.go

@@ -153,6 +153,25 @@ func (p *SyncGatewayPeer) WaitForDocVersion(dsName sgbucket.DataStoreName, docID
 	return doc.Body(ctx)
 }
 
+// WaitForCV waits for a document to reach a specific CV. The test will fail if the document does not reach the expected version in 20s.
+func (p *SyncGatewayPeer) WaitForCV(dsName sgbucket.DataStoreName, docID string, expected DocMetadata, replications Replications) db.Body {
+	collection, ctx := p.getCollection(dsName)
+	var doc *db.Document
+	require.EventuallyWithT(p.TB(), func(c *assert.CollectT) {
+		var err error
+		doc, err = collection.GetDocument(ctx, docID, db.DocUnmarshalAll)
+		assert.NoError(c, err)
+		if doc == nil {
+			return
+		}
+		version := DocMetadataFromDocument(doc)
+		bodyBytes, err := doc.BodyBytes(ctx)
+		assert.NoError(c, err)
+		assertCVEqual(c, docID, p.name, version, bodyBytes, expected, replications)
+	}, totalWaitTime, pollInterval)
+	return doc.Body(ctx)
+}
+
 // WaitForTombstoneVersion waits for a document to reach a specific version, this must be a tombstone. The test will fail if the document does not reach the expected version in 20s.
 func (p *SyncGatewayPeer) WaitForTombstoneVersion(dsName sgbucket.DataStoreName, docID string, expected DocMetadata, replications Replications) {
 	docBytes := p.WaitForDocVersion(dsName, docID, expected, replications)

topologytest/version_test.go

@@ -29,13 +29,13 @@ type DocMetadata struct {
 }
 
 // CV returns the current version of the document.
-func (v DocMetadata) CV(t require.TestingT) db.Version {
+func (v DocMetadata) CV(t assert.TestingT) db.Version {
 	if v.ImplicitHLV != nil {
 		return *v.ImplicitHLV.ExtractCurrentVersionFromHLV()
 	} else if v.HLV != nil {
 		return *v.HLV.ExtractCurrentVersionFromHLV()
 	}
-	require.FailNowf(t, "no hlv available", "%#v", v)
+	assert.FailNowf(t, "no hlv available", "%#v", v)
 	return db.Version{}
 }
 
@@ -92,3 +92,8 @@ func DocMetadataFromDocVersion(t testing.TB, docID string, hlv *db.HybridLogical
 func assertHLVEqual(t assert.TestingT, docID string, p string, version DocMetadata, body []byte, expected DocMetadata, replications Replications) {
 	assert.True(t, version.IsHLVEqual(expected), "Actual HLV does not match expected on %s for peer %s.  Expected: %#v, Actual: %#v\nActual Body: %s\nReplications:\n%s", docID, p, expected, version, body, replications.Stats())
 }
+
+// assertCV asserts that CV of the version is equal to the expected CV.
+func assertCVEqual(t assert.TestingT, docID string, p string, version DocMetadata, body []byte, expected DocMetadata, replications Replications) {
+	assert.Equal(t, expected.CV(t), version.CV(t), "Actual HLV's CV does not match expected on %s for peer %s.  Expected: %#v, Actual: %#v\nActual Body: %s\nReplications:\n%s", docID, p, expected, version, body, replications.Stats())
+}