crudcontracts

type Config[ENT, ID any] struct {
	// MakeContext is responsible to return back a backgrond context for testing with the crud contract subject.
	MakeContext func(testing.TB) context.Context
	// MakeEntity is responsible to create a populated Entity.
	MakeEntity func(testing.TB) ENT
	// SupportIDReuse is an optional configuration value that tells the contract
	// that recreating an entity with an ID which belongs to a previously deleted entity is accepted.
	SupportIDReuse bool
	// SupportRecreate is an optional configuration value that tells the contract
	// that deleting an Entity then recreating it with the same values is supported by the Creator.
	SupportRecreate bool
	// ChangeEntity is an optional configuration field for tests that involve updating an entity.
	// This field express what Entity fields are allowed to be changed by the user of the Updater crud interface.
	// For example, if the changed Entity field is ignored by the Update method,
	// you can match this by not changing the Entity field as part of the ChangeEntity function.
	ChangeEntity func(testing.TB, *ENT)
	// ExampleEntity is an optional field that able to return back an example Entity.
	// The Entity should have a valid ID and should exist in the resource which is being tested.
	//
	// ExampleEntity enables testing a resource that doesn't implement the crud.Creator interface.
	ExampleEntity func(testing.TB) ENT
	// IDA [optional] is the ID Accessor.
	// Configure this if you don't use the ext:"id" tag in your entity.
	// TODO: add support for this accessor in crudtest
	IDA extid.Accessor[ENT, ID]

	// LazyNotFoundError will allow QueryMany methods to return crud.ErrNotFound during the iteration,
	// instead during the method call.
	// For e.g.: crud.ByIDsFinder[ENT, ID]
	LazyNotFoundError bool
}

type Contract interface {
	testcase.Suite
	testcase.OpenSuite
}

type Option[ENT, ID any] option.Option[Config[ENT, ID]]

type QueryManySubject[ENT any] struct {
	// Query creates a query that expected to find the ExpectedEntity
	//
	// By convention, any preparation action that affect the resource must take place prior to returning the closure.
	// The QueryOneFunc closure should only have the Method call with the already mapped values.
	// Query will be evaluated in the beginning of the testing,
	// and executed after all the test Context preparation is done.
	//
	// The func signature for Query is the generic representation of a query that meant to find one result.
	// It is really similar to resources.Finder#FindByID,
	// with the exception that the closure meant to know the query method name on the subject and the inputs it requires.
	Query func(ctx context.Context) iter.Seq2[ENT, error]
	// IncludedEntity return an entity that is matched by the QueryManyFunc.
	// If subject doesn't support Creator, then it should be present in the subject resource.
	IncludedEntity func() ENT
	// MakeExcludedEntity is an optional property,
	// that could be used ensure the query returns only the expected values.
	// If subject doesn't support Creator, then it should be present in the subject resource.
	ExcludedEntity func() ENT
}

type QueryOneSubject[ENT any] struct {
	// Query creates a query that expected to find the ExpectedEntity
	//
	// By convention, any preparation action that affect the resource must take place prior to returning the closure.
	// The QueryOneFunc closure should only have the Method call with the already mapped values.
	// Query will be evaluated in the beginning of the testing,
	// and executed after all the test Context preparation is done.
	//
	// The func signature for Query is the generic representation of a query that meant to find one result.
	// It is really similar to resources.Finder#FindByID,
	// with the exception that the closure meant to know the query method name on the subject and the inputs it requires.
	Query func(ctx context.Context) (_ ENT, found bool, _ error)
	// ExpectedEntity is an entity that is matched by the Query.
	// If subject doesn't support Creator, then it should be present in the subject resource.
	ExpectedEntity ENT
	// MakeExcludedEntity is an optional property,
	// that could be used ensure the query returns only the expected values.
	// If subject doesn't support Creator, then it should be present in the subject resource.
	ExcludedEntity func() ENT
}

type TestingTBContextKey struct{}