setup

type BackendOpts struct {
	// Capped collections cleanup interval.
	CappedCleanupInterval time.Duration

	// Percentage of documents to cleanup for capped collections. If not set, defaults to 20.
	CappedCleanupPercentage uint8
}

type SetupCompatOpts struct {
	// Data providers.
	Providers []shareddata.Provider

	// If true, a non-existent collection will be added to the list of collections.
	// This is useful to test the behavior when a collection is not found.
	//
	// This flag is not needed, always add a non-existent collection.
	// TODO https://github.com/FerretDB/FerretDB/issues/1545
	AddNonExistentCollection bool
	// contains filtered or unexported fields
}

type SetupCompatResult struct {
	Ctx               context.Context
	TargetCollections []*mongo.Collection
	CompatCollections []*mongo.Collection
}

type SetupOpts struct {
	// Database to use. If empty, temporary test-specific database is created and dropped after test.
	DatabaseName string

	// Collection to use. If empty, temporary test-specific collection is created and dropped after test.
	// Most tests should keep this empty.
	CollectionName string

	// Data providers. If empty, collection is not created.
	Providers []shareddata.Provider

	// Benchmark data provider. If empty, collection is not created.
	BenchmarkProvider shareddata.BenchmarkProvider

	// ExtraOptions sets the options in MongoDB URI, when the option exists it overwrites that option.
	ExtraOptions url.Values

	// SetupUser true creates a user and returns an authenticated client.
	SetupUser bool

	// Options to override default backend configuration.
	BackendOptions *BackendOpts
}

type SetupResult struct {
	Ctx        context.Context
	Collection *mongo.Collection
	MongoDBURI string
}