CBG-4280 Improve test assertions for attachments (#7637)

Author: torcolvin

base/constants.go

@@ -203,6 +203,8 @@ const (
 	ContentTypeJSON = "application/json"
 	// ContentTypeFormEncoded is the content type for form-encoded requests.
 	ContentTypeFormEncoded = "application/x-www-form-urlencoded"
+	// ContentTypeOctetStream is for binary data
+	ContentTypeOctetStream = "application/octet-stream"
 )
 
 // UnitTestUrl returns the configured test URL.

base/util_testing.go

@@ -19,11 +19,13 @@ import (
 	"io"
 	"io/fs"
 	"log"
+	"maps"
 	"math/rand"
 	"os"
 	"path/filepath"
 	"runtime"
 	"runtime/pprof"
+	"slices"
 	"sort"
 	"strconv"
 	"strings"
@@ -1003,3 +1005,15 @@ func GetNonDefaultDatastoreNames(t testing.TB, bucket Bucket) []sgbucket.DataSto
 func TestClusterSpec(t *testing.T) CouchbaseClusterSpec {
 	return GTestBucketPool.clusterSpec
 }
+
+// RequireKeysEqual asserts that a map has the expected keys.
+func RequireKeysEqual[T any](t testing.TB, expectedKeys []string, actual map[string]T, msgAndArgs ...any) {
+	require.ElementsMatch(t, expectedKeys, slices.Collect(maps.Keys(actual)), msgAndArgs...)
+}
+
+// RequireXattrNotFound asserts that the given xattr is not found on the document.
+func RequireXattrNotFound(t testing.TB, dataStore sgbucket.DataStore, docID string, xattrName string) {
+	xattrs, _, err := dataStore.GetXattrs(TestCtx(t), docID, []string{xattrName})
+	require.Error(t, err, fmt.Sprintf("Expected xattr %q to not be found on document %q but has contents %s", xattrName, docID, xattrs[xattrName]))
+	RequireXattrNotFoundError(t, err)
+}

db/attachment.go

@@ -46,19 +46,25 @@ type updatedAttachment struct {
 // updatedAttachments holds the user facing attachment name and raw contents
 type updatedAttachments map[string]updatedAttachment
 
-// A map of keys -> DocAttachments.
-type AttachmentMap map[string]*DocAttachment
-
-// A struct which models an attachment.  Currently only used by test code, however
-// new code or refactoring in the main codebase should try to use where appropriate.
+// AttachmentMap can represent:
+//   - _sync.attachments
+//   - _globalSync.attachments_meta
+//   - inline body `_attachments` from blip rev messages
+//   - inline body `_attachments`from pre Sync Gateway 2.5
+type AttachmentMap map[string]DocAttachment
+
+// DocAttachment models an attachment. This could be attachment metadata or the full body of an attachment.
+//   - `_sync.attachments` : Data field should not be present
+//   - `_globalSync.attachments_meta` : Data field should not be present
+//   - `_attachments` body from blip or REST input/output: Data field could be present if Stub: false
 type DocAttachment struct {
 	ContentType string `json:"content_type,omitempty"`
 	Digest      string `json:"digest,omitempty"`
 	Length      int    `json:"length,omitempty"`
 	Revpos      int    `json:"revpos,omitempty"`
 	Stub        bool   `json:"stub,omitempty"`
 	Version     int    `json:"ver,omitempty"`
-	Data        []byte `json:"-"` // tell json marshal/unmarshal to ignore this field
+	Data        []byte `json:"data,omitempty"` // this field is present for unmarshalling data but typically should not be marshalled for output.
 }
 
 // ErrAttachmentTooLarge is returned when an attempt to attach an oversize attachment is made.