testutils

type CallMethodFunc func(t *testing.T, obj interface{}, methodName string, values []interface{}) []interface{}

type CheckTestI func(u TestUtil) bool

type ComparerI func(u TestUtil, name string, actual, expected interface{}) bool

type DefTest struct {
	Number      int           // Test number.
	Description string        // Test description.
	EnvVars     []string      // List of environmental variable to be reset at the start of each test
	Config      interface{}   // Test configuration information to be used by test function or custom pre/post test functions.
	Inputs      []interface{} // Test inputs.
	Expected    []interface{} // Test expected results.
	Results     []interface{} // Test results.
	ObjStatus   *ObjectStatus // Details of object under test including field names and expected values, used by CheckFunc to verify values.
	// PrepFunc is function to be called before a test, leave unset to call default - which prints the test number and name.
	PrepFunc PrepTestI
	// CheckFunc is function to be called to check a test results, leave unset to call default.
	// Default compares actual results with expected results and verifies object status.
	CheckFunc CheckTestI
	// ResultsCompareFunc is function to be called to compare a test results, leave unset to call default.
	// Default compares actual results with expected results using reflect.DeepEqual().
	ResultsCompareFunc ComparerI
	// ResultsReportFunc is function to be called to report difference in test results, leave unset to call default - which uses spew.Sdump().
	ResultsReportFunc ReportDiffI
	// FieldCompareFunc is function to be called to compare a field values, leave unset to call default.
	// Default compares actual results with expected results using reflect.DeepEqual().
	FieldCompareFunc ComparerI
	// FieldCompareFunc is function to be called to report difference in field values, leave unset to call default - which uses spew.Sdump().
	FieldReportFunc ReportDiffI
}

type FieldInfo struct {
	Reporter     ReportDiffI `json:"reporter,omitempty"` // Function to do field specific reporting of differences, nil if not set.
	Comparer     ComparerI   `json:"comparer,omitempty"` // Function to do field specific compare, nil if not set.
	GetterMethod string      `json:"getter,omitempty"`   // The method to get the value, nil if no getter method.
	SetterMethod string      `json:"setter,omitempty"`   // The method to get the value, nil if no setter method.
	FieldValue   interface{} `json:"value"`              // The value to set or expected value to verify.
}

type Fields map[string]FieldInfo

type GetFieldFunc func(t *testing.T, obj interface{}, fieldName string) interface{}

type ObjectStatus struct {
	Object     interface{}    // The object or interface under test, this needs to be set during test before calling post test actions.
	GetField   GetFieldFunc   // The function to call to get a field value.
	SetField   SetFieldFunc   // The function to call to set a field value.
	CallMethod CallMethodFunc // The function to call a method on an object.
	Fields     Fields         // The fields of an object.
}

type PrepTestI func(u TestUtil)

type ReportDiffI func(u TestUtil, name string, actual, expected interface{})

type SetFieldFunc func(t *testing.T, obj interface{}, fieldName string, value interface{})

type TestUtil interface {
	CallPrepFunc()                 // Call the custom or default test preparation function.
	CallCheckFunc() bool           // Call the custom or default test checking function.
	Testing() *testing.T           // testing object.
	SetFailTests(value bool)       // Set the fail test setting to verify test check reporting.
	FailTests() bool               // Get the fail test setting.
	SetVerbose(value bool)         // Set the verbose setting.
	Verbose() bool                 // Get the verbose setting.
	SetTestData(testData *DefTest) // Set the test data.
	TestData() *DefTest            // Get the test data.
	// ResultsComparer calls the specified comparer, default checking function calls this to call test data's CompareFunc or CompareReflectDeepEqual if not set.
	ResultsComparer() bool
	// FieldComparer calls the field comparer, default checking function calls this to call test data's CompareFunc or CompareReflectDeepEqual if not set.
	FieldComparer(name string, actual, expected interface{}) bool
	// ResultReporter calls the specified reporter, default checking function calls this to call test data's ResultsReportFunc or ReportSpew if not set.
	ResultsReporter()
	// FieldReporter calls the specified reporter, default checking function calls this to call test data's ReportFieldsFunc or ReportSpew if not set.
	FieldReporter(name string, actual, expected interface{})
}