Fix misused require.FailNow where failureMessage was absent

bbrks · bbrks · commit 1b42fc22925d · 2025-01-21T18:11:51.000Z
diff --git a/rest/utilities_testing_blip_client.go b/rest/utilities_testing_blip_client.go
@@ -136,7 +136,7 @@ func (c *BlipTesterCollectionClient) OneShotDocsSince(ctx context.Context, since
 				continue
 			} else if latestDocSeq := doc.latestSeq(); latestDocSeq != seq {
 				// this entry should've been cleaned up from _seqStore
-				require.FailNow(c.TB(), "seq %d found in _seqStore but latestSeq for doc %d - this should've been pruned out!", seq, latestDocSeq)
+				require.FailNowf(c.TB(), "found old seq in _seqStore", "seq %d found in _seqStore but latestSeq for doc %d - this should've been pruned out!", seq, latestDocSeq)
 				continue
 			}
 			if !yield(seq, doc) {
@@ -384,7 +384,7 @@ func (btcc *BlipTesterCollectionClient) _getClientDoc(docID string) (*clientDoc,
 	}
 	clientDoc, ok := btcc._seqStore[seq]
 	if !ok {
-		require.FailNow(btcc.TB(), "docID %q found in _seqFromDocID but seq %d not in _seqStore %v", docID, seq, btcc._seqStore)
+		require.FailNowf(btcc.TB(), "seq not found in _seqStore", "docID %q found in _seqFromDocID but seq %d not in _seqStore %v", docID, seq, btcc._seqStore)
 		return nil, false
 	}
 	return clientDoc, ok
@@ -612,7 +612,7 @@ func (btr *BlipTesterReplicator) initHandlers(btc *BlipTesterClient) {
 
 					// safety check - ensure SG is not sending a rev that we already had - ensures changes feed messaging is working correctly to prevent
 					if clientCV.SourceID == incomingCV.SourceID && clientCV.Value == incomingCV.Value {
-						require.FailNow(btc.TB(), "incoming revision %v is equal to client revision %v - should've been filtered via changes response before ending up as a rev", incomingCV, clientCV)
+						require.FailNowf(btc.TB(), "incoming revision is equal to client revision", "incoming revision %v is equal to client revision %v - should've been filtered via changes response before ending up as a rev", incomingCV, clientCV)
 					}
 
 					// incoming rev older than stored client version and comes from a different source - need to resolve
@@ -696,7 +696,7 @@ func (btr *BlipTesterReplicator) initHandlers(btc *BlipTesterClient) {
 					response.SetError("HTTP", http.StatusUnprocessableEntity, "test code intentionally rejected delta")
 					return
 				}
-				require.FailNow(btr.TB(), "expected delta rev message to be sent without noreply flag: %+v", msg)
+				require.FailNowf(btr.TB(), "expected delta rev message to be sent without noreply flag", "msg: %+v", msg)
 			}
 
 			// unmarshal body to extract deltaSrc
@@ -707,7 +707,7 @@ func (btr *BlipTesterReplicator) initHandlers(btc *BlipTesterClient) {
 			var old db.Body
 			doc, ok := btcr.getClientDoc(docID)
 			if !ok {
-				require.FailNow(btc.TB(), "docID %q not found in _seqFromDocID", docID)
+				require.FailNowf(btc.TB(), "doc not found", "docID %q not found", docID)
 				return
 			}
 			var deltaSrcVersion DocVersion
@@ -877,7 +877,7 @@ func (btr *BlipTesterReplicator) initHandlers(btc *BlipTesterClient) {
 
 				// safety check - ensure SG is not sending a rev that we already had - ensures changes feed messaging is working correctly to prevent
 				if clientCV.SourceID == incomingCV.SourceID && clientCV.Value == incomingCV.Value {
-					require.FailNow(btc.TB(), "incoming revision %v is equal to client revision %v - should've been filtered via changes response before ending up as a rev", incomingCV, clientCV)
+					require.FailNowf(btc.TB(), "incoming revision is equal to client revision", "incoming revision %v is equal to client revision %v - should've been filtered via changes response before ending up as a rev", incomingCV, clientCV)
 				}
 
 				// incoming rev older than stored client version and comes from a different source - need to resolve
@@ -1045,7 +1045,7 @@ func (btc *BlipTesterCollectionClient) updateLastReplicatedVersion(docID string,
 	defer btc.seqLock.Unlock()
 	doc, ok := btc._getClientDoc(docID)
 	if !ok {
-		require.FailNow(btc.TB(), "docID %q not found in _seqFromDocID", docID)
+		require.FailNowf(btc.TB(), "doc not found", "docID %q", docID)
 		return
 	}
 	doc.setLatestServerVersion(version)
@@ -1056,7 +1056,7 @@ func (btc *BlipTesterCollectionClient) getLastReplicatedVersion(docID string) (v
 	defer btc.seqLock.Unlock()
 	doc, ok := btc._getClientDoc(docID)
 	if !ok {
-		require.FailNow(btc.TB(), "docID %q not found in _seqFromDocID", docID)
+		require.FailNowf(btc.TB(), "doc not found", "docID %q", docID)
 		return DocVersion{}, false
 	}
 	doc.lock.RLock()
@@ -1113,7 +1113,7 @@ func (btcRunner *BlipTestClientRunner) NewBlipTesterClientOptsWithRT(rt *RestTes
 		opts.ConflictResolver = ConflictResolverDefault
 	}
 	if !opts.ConflictResolver.IsValid() {
-		require.FailNow(btcRunner.TB(), "invalid conflict resolver %q", opts.ConflictResolver)
+		require.FailNowf(btcRunner.TB(), "invalid conflict resolver", "invalid conflict resolver %q", opts.ConflictResolver)
 	}
 	if opts.SourceID == "" {
 		opts.SourceID = "blipclient"
@@ -1258,7 +1258,7 @@ func (btcRunner *BlipTestClientRunner) Collection(clientID uint32, collectionNam
 			return collectionClient
 		}
 	}
-	require.FailNow(btcRunner.clients[clientID].TB(), "Could not find collection %s in BlipTesterClient", collectionName)
+	require.FailNowf(btcRunner.clients[clientID].TB(), "unknown collection", "Could not find collection %s in BlipTesterClient", collectionName)
 	return nil
 }
 
@@ -1573,7 +1573,7 @@ func (btc *BlipTesterCollectionClient) StartPullSince(options BlipTesterPullOpti
 	errorDomain := subChangesResponse.Properties["Error-Domain"]
 	errorCode := subChangesResponse.Properties["Error-Code"]
 	if errorDomain != "" && errorCode != "" {
-		require.FailNowf(btc.TB(), "error %s %s from subChanges with body: %s", errorDomain, errorCode, string(rspBody))
+		require.FailNowf(btc.TB(), "error from subchanges", "error %s %s from subChanges with body: %s", errorDomain, errorCode, string(rspBody))
 	}
 }
 
@@ -1856,7 +1856,7 @@ func (btc *BlipTesterCollectionClient) ProcessInlineAttachments(inputBody []byte
 				// push the stub as-is
 				continue
 			}
-			require.FailNow(btc.TB(), "couldn't find data or stub property for inline attachment %s:%v", attachmentName, inlineAttachment)
+			require.FailNowf(btc.TB(), "couldn't find data or stub property for inline attachment", "att name %s:%v", attachmentName, inlineAttachment)
 		}
 
 		// Transform inline attachment data into metadata
@@ -1899,7 +1899,7 @@ func (btc *BlipTesterCollectionClient) GetVersion(docID string, docVersion DocVe
 
 	rev, ok := doc._revisionsBySeq[revSeq]
 	if !ok {
-		require.FailNow(btc.TB(), "seq %q for docID %q found but no rev in _seqStore", revSeq, docID)
+		require.FailNowf(btc.TB(), "no rev seq in _seqStore", "seq %q for docID %q found but no rev in _seqStore", revSeq, docID)
 		return nil, false
 	}
 

Original file line number	Diff line number	Diff line change
`@@ -136,7 +136,7 @@ func (c *BlipTesterCollectionClient) OneShotDocsSince(ctx context.Context, since`
`136`	`136`	`continue`
`137`	`137`	`} else if latestDocSeq := doc.latestSeq(); latestDocSeq != seq {`
`138`	`138`	`// this entry should've been cleaned up from _seqStore`
`139`		`- require.FailNow(c.TB(), "seq %d found in _seqStore but latestSeq for doc %d - this should've been pruned out!", seq, latestDocSeq)`
	`139`	`+ require.FailNowf(c.TB(), "found old seq in _seqStore", "seq %d found in _seqStore but latestSeq for doc %d - this should've been pruned out!", seq, latestDocSeq)`
`140`	`140`	`continue`
`141`	`141`	`}`
`142`	`142`	`if !yield(seq, doc) {`
`@@ -384,7 +384,7 @@ func (btcc BlipTesterCollectionClient) _getClientDoc(docID string) (clientDoc,`
`384`	`384`	`}`
`385`	`385`	`clientDoc, ok := btcc._seqStore[seq]`
`386`	`386`	`if !ok {`
`387`		`- require.FailNow(btcc.TB(), "docID %q found in _seqFromDocID but seq %d not in _seqStore %v", docID, seq, btcc._seqStore)`
	`387`	`+ require.FailNowf(btcc.TB(), "seq not found in _seqStore", "docID %q found in _seqFromDocID but seq %d not in _seqStore %v", docID, seq, btcc._seqStore)`
`388`	`388`	`return nil, false`
`389`	`389`	`}`
`390`	`390`	`return clientDoc, ok`
`@@ -612,7 +612,7 @@ func (btr BlipTesterReplicator) initHandlers(btc BlipTesterClient) {`
`612`	`612`
`613`	`613`	`// safety check - ensure SG is not sending a rev that we already had - ensures changes feed messaging is working correctly to prevent`
`614`	`614`	`if clientCV.SourceID == incomingCV.SourceID && clientCV.Value == incomingCV.Value {`
`615`		`- require.FailNow(btc.TB(), "incoming revision %v is equal to client revision %v - should've been filtered via changes response before ending up as a rev", incomingCV, clientCV)`
	`615`	`+ require.FailNowf(btc.TB(), "incoming revision is equal to client revision", "incoming revision %v is equal to client revision %v - should've been filtered via changes response before ending up as a rev", incomingCV, clientCV)`
`616`	`616`	`}`
`617`	`617`
`618`	`618`	`// incoming rev older than stored client version and comes from a different source - need to resolve`
`@@ -696,7 +696,7 @@ func (btr BlipTesterReplicator) initHandlers(btc BlipTesterClient) {`
`696`	`696`	`response.SetError("HTTP", http.StatusUnprocessableEntity, "test code intentionally rejected delta")`
`697`	`697`	`return`
`698`	`698`	`}`
`699`		`- require.FailNow(btr.TB(), "expected delta rev message to be sent without noreply flag: %+v", msg)`
	`699`	`+ require.FailNowf(btr.TB(), "expected delta rev message to be sent without noreply flag", "msg: %+v", msg)`
`700`	`700`	`}`
`701`	`701`
`702`	`702`	`// unmarshal body to extract deltaSrc`
`@@ -707,7 +707,7 @@ func (btr BlipTesterReplicator) initHandlers(btc BlipTesterClient) {`
`707`	`707`	`var old db.Body`
`708`	`708`	`doc, ok := btcr.getClientDoc(docID)`
`709`	`709`	`if !ok {`
`710`		`- require.FailNow(btc.TB(), "docID %q not found in _seqFromDocID", docID)`
	`710`	`+ require.FailNowf(btc.TB(), "doc not found", "docID %q not found", docID)`
`711`	`711`	`return`
`712`	`712`	`}`
`713`	`713`	`var deltaSrcVersion DocVersion`
`@@ -877,7 +877,7 @@ func (btr BlipTesterReplicator) initHandlers(btc BlipTesterClient) {`
`877`	`877`
`878`	`878`	`// safety check - ensure SG is not sending a rev that we already had - ensures changes feed messaging is working correctly to prevent`
`879`	`879`	`if clientCV.SourceID == incomingCV.SourceID && clientCV.Value == incomingCV.Value {`
`880`		`- require.FailNow(btc.TB(), "incoming revision %v is equal to client revision %v - should've been filtered via changes response before ending up as a rev", incomingCV, clientCV)`
	`880`	`+ require.FailNowf(btc.TB(), "incoming revision is equal to client revision", "incoming revision %v is equal to client revision %v - should've been filtered via changes response before ending up as a rev", incomingCV, clientCV)`
`881`	`881`	`}`
`882`	`882`
`883`	`883`	`// incoming rev older than stored client version and comes from a different source - need to resolve`
`@@ -1045,7 +1045,7 @@ func (btc *BlipTesterCollectionClient) updateLastReplicatedVersion(docID string,`
`1045`	`1045`	`defer btc.seqLock.Unlock()`
`1046`	`1046`	`doc, ok := btc._getClientDoc(docID)`
`1047`	`1047`	`if !ok {`
`1048`		`- require.FailNow(btc.TB(), "docID %q not found in _seqFromDocID", docID)`
	`1048`	`+ require.FailNowf(btc.TB(), "doc not found", "docID %q", docID)`
`1049`	`1049`	`return`
`1050`	`1050`	`}`
`1051`	`1051`	`doc.setLatestServerVersion(version)`
`@@ -1056,7 +1056,7 @@ func (btc *BlipTesterCollectionClient) getLastReplicatedVersion(docID string) (v`
`1056`	`1056`	`defer btc.seqLock.Unlock()`
`1057`	`1057`	`doc, ok := btc._getClientDoc(docID)`
`1058`	`1058`	`if !ok {`
`1059`		`- require.FailNow(btc.TB(), "docID %q not found in _seqFromDocID", docID)`
	`1059`	`+ require.FailNowf(btc.TB(), "doc not found", "docID %q", docID)`
`1060`	`1060`	`return DocVersion{}, false`
`1061`	`1061`	`}`
`1062`	`1062`	`doc.lock.RLock()`
`@@ -1113,7 +1113,7 @@ func (btcRunner BlipTestClientRunner) NewBlipTesterClientOptsWithRT(rt RestTes`
`1113`	`1113`	`opts.ConflictResolver = ConflictResolverDefault`
`1114`	`1114`	`}`
`1115`	`1115`	`if !opts.ConflictResolver.IsValid() {`
`1116`		`- require.FailNow(btcRunner.TB(), "invalid conflict resolver %q", opts.ConflictResolver)`
	`1116`	`+ require.FailNowf(btcRunner.TB(), "invalid conflict resolver", "invalid conflict resolver %q", opts.ConflictResolver)`
`1117`	`1117`	`}`
`1118`	`1118`	`if opts.SourceID == "" {`
`1119`	`1119`	`opts.SourceID = "blipclient"`
`@@ -1258,7 +1258,7 @@ func (btcRunner *BlipTestClientRunner) Collection(clientID uint32, collectionNam`
`1258`	`1258`	`return collectionClient`
`1259`	`1259`	`}`
`1260`	`1260`	`}`
`1261`		`- require.FailNow(btcRunner.clients[clientID].TB(), "Could not find collection %s in BlipTesterClient", collectionName)`
	`1261`	`+ require.FailNowf(btcRunner.clients[clientID].TB(), "unknown collection", "Could not find collection %s in BlipTesterClient", collectionName)`
`1262`	`1262`	`return nil`
`1263`	`1263`	`}`
`1264`	`1264`
`@@ -1573,7 +1573,7 @@ func (btc *BlipTesterCollectionClient) StartPullSince(options BlipTesterPullOpti`
`1573`	`1573`	`errorDomain := subChangesResponse.Properties["Error-Domain"]`
`1574`	`1574`	`errorCode := subChangesResponse.Properties["Error-Code"]`
`1575`	`1575`	`if errorDomain != "" && errorCode != "" {`
`1576`		`- require.FailNowf(btc.TB(), "error %s %s from subChanges with body: %s", errorDomain, errorCode, string(rspBody))`
	`1576`	`+ require.FailNowf(btc.TB(), "error from subchanges", "error %s %s from subChanges with body: %s", errorDomain, errorCode, string(rspBody))`
`1577`	`1577`	`}`
`1578`	`1578`	`}`
`1579`	`1579`
`@@ -1856,7 +1856,7 @@ func (btc *BlipTesterCollectionClient) ProcessInlineAttachments(inputBody []byte`
`1856`	`1856`	`// push the stub as-is`
`1857`	`1857`	`continue`
`1858`	`1858`	`}`
`1859`		`- require.FailNow(btc.TB(), "couldn't find data or stub property for inline attachment %s:%v", attachmentName, inlineAttachment)`
	`1859`	`+ require.FailNowf(btc.TB(), "couldn't find data or stub property for inline attachment", "att name %s:%v", attachmentName, inlineAttachment)`
`1860`	`1860`	`}`
`1861`	`1861`
`1862`	`1862`	`// Transform inline attachment data into metadata`
`@@ -1899,7 +1899,7 @@ func (btc *BlipTesterCollectionClient) GetVersion(docID string, docVersion DocVe`
`1899`	`1899`
`1900`	`1900`	`rev, ok := doc._revisionsBySeq[revSeq]`
`1901`	`1901`	`if !ok {`
`1902`		`- require.FailNow(btc.TB(), "seq %q for docID %q found but no rev in _seqStore", revSeq, docID)`
	`1902`	`+ require.FailNowf(btc.TB(), "no rev seq in _seqStore", "seq %q for docID %q found but no rev in _seqStore", revSeq, docID)`
`1903`	`1903`	`return nil, false`
`1904`	`1904`	`}`
`1905`	`1905`