Unlock 30% off on Manual Testing Annual Plans this Holiday Season.

Copied to Clipboard!

Automation Advisor
Go-testdeep
td
AddAnchorableStructType

How to use AddAnchorableStructType method of td Package

Best Go-testdeep code snippet using td.AddAnchorableStructType

td_compat.go

Source:td_compat.go

...50// EqDeeply is a deprecated alias of [td.EqDeeply].51var EqDeeply = td.EqDeeply52// EqDeeplyError is a deprecated alias of [td.EqDeeplyError].53var EqDeeplyError = td.EqDeeplyError54// AddAnchorableStructType is a deprecated alias of [td.AddAnchorableStructType].55var AddAnchorableStructType = td.AddAnchorableStructType56// NewT is a deprecated alias of [td.NewT].57var NewT = td.NewT58// Assert is a deprecated alias of [td.Assert].59var Assert = td.Assert60// Require is a deprecated alias of [td.Require].61var Require = td.Require62// AssertRequire is a deprecated alias of [td.AssertRequire].63var AssertRequire = td.AssertRequire64// CmpAll is a deprecated alias of [td.CmpAll].65var CmpAll = td.CmpAll66// CmpAny is a deprecated alias of [td.CmpAny].67var CmpAny = td.CmpAny68// CmpArray is a deprecated alias of [td.CmpArray].69var CmpArray = td.CmpArray...

t_anchor.go

Source:t_anchor.go

...12)13// Anchors are stored globally by testing.TB.Name().14var allAnchors = map[string]*anchors.Info{}15var allAnchorsMu sync.Mutex16// AddAnchorableStructType declares a struct type as anchorable. fn17// is a function allowing to return a unique and identifiable instance18// of the struct type.19//20// fn has to have the following signature:21//22//	func (nextAnchor int) TYPE23//24// TYPE is the struct type to make anchorable and nextAnchor is an25// index to allow to differentiate several instances of the same type.26//27// For example, the [time.Time] type which is anchorable by default,28// could be declared as:29//30//	AddAnchorableStructType(func (nextAnchor int) time.Time {31//	  return time.Unix(int64(math.MaxInt64-1000424443-nextAnchor), 42)32//	})33//34// Just as a note, the 1000424443 constant allows to avoid to flirt35// with the math.MaxInt64 extreme limit and so avoid possible36// collision with real world values.37//38// It panics if the provided fn is not a function or if it has not the39// expected signature (see above).40//41// See also [T.Anchor], [T.AnchorsPersistTemporarily],42// [T.DoAnchorsPersist], [T.ResetAnchors] and [T.SetAnchorsPersist].43func AddAnchorableStructType(fn any) {44	err := anchors.AddAnchorableStructType(fn)45	if err != nil {46		panic(color.Bad(err.Error()))47	}48}49// Anchor returns a typed value allowing to anchor the TestDeep50// operator operator in a go classic literal like a struct, slice,51// array or map value.52//53// If the TypeBehind method of operator returns non-nil, model can be54// omitted (like with [Between] operator in the example55// below). Otherwise, model should contain only one value56// corresponding to the returning type. It can be:57//   - a go value: returning type is the type of the value,58//     whatever the value is;59//   - a [reflect.Type].60//61// It returns a typed value ready to be embed in a go data structure to62// be compared using [T.Cmp] or [T.CmpLax]:63//64//	import (65//	  "testing"66//67//	  "github.com/maxatome/go-testdeep/td"68//	)69//70//	func TestFunc(tt *testing.T) {71//	  got := Func()72//73//	  t := td.NewT(tt)74//	  t.Cmp(got, &MyStruct{75//	    Name:    "Bob",76//	    Details: &MyDetails{77//	      Nick: t.Anchor(td.HasPrefix("Bobby"), "").(string),78//	      Age:  t.Anchor(td.Between(40, 50)).(int),79//	    },80//	  })81//	}82//83// In this example:84//85//   - [HasPrefix] operates on several input types (string,86//     [fmt.Stringer], error, â¦), so its TypeBehind method returns always87//     nil as it can not guess in advance on which type it operates. In88//     this case, we must pass "" as model parameter in order to tell it89//     to return the string type. Note that the .(string) type assertion90//     is then mandatory to conform to the strict type checking.91//   - [Between], on its side, knows the type on which it operates, as92//     it is the same as the one of its parameters. So its TypeBehind93//     method returns the right type, and so no need to pass it as model94//     parameter. Note that the .(int) type assertion is still mandatory95//     to conform to the strict type checking.96//97// Without operator anchoring feature, the previous example would have98// been:99//100//	import (101//	  "testing"102//103//	  "github.com/maxatome/go-testdeep/td"104//	)105//106//	func TestFunc(tt *testing.T) {107//	  got := Func()108//109//	  t := td.NewT(tt)110//	  t.Cmp(got, td.Struct(&MyStruct{Name: "Bob"},111//	    td.StructFields{112//	    "Details": td.Struct(&MyDetails{},113//	      td.StructFields{114//	        "Nick": td.HasPrefix("Bobby"),115//	        "Age":  td.Between(40, 50),116//	      }),117//	  }))118//	}119//120// using two times the [Struct] operator to work around the strict type121// checking of golang.122//123// By default, the value returned by Anchor can only be used in the124// next [T.Cmp] or [T.CmpLax] call. To make it persistent across calls,125// see [T.SetAnchorsPersist] and [T.AnchorsPersistTemporarily] methods.126//127// See [T.A] method for a shorter synonym of Anchor.128//129// See also [T.AnchorsPersistTemporarily], [T.DoAnchorsPersist],130// [T.ResetAnchors], [T.SetAnchorsPersist] and [AddAnchorableStructType].131func (t *T) Anchor(operator TestDeep, model ...any) any {132	if operator == nil {133		t.Helper()134		t.Fatal(color.Bad("Cannot anchor a nil TestDeep operator"))135	}136	var typ reflect.Type137	if len(model) > 0 {138		if len(model) != 1 {139			t.Helper()140			t.Fatal(color.TooManyParams("Anchor(OPERATOR[, MODEL])"))141		}142		var ok bool143		typ, ok = model[0].(reflect.Type)144		if !ok {145			typ = reflect.TypeOf(model[0])146			if typ == nil {147				t.Helper()148				t.Fatal(color.Bad("Untyped nil value is not valid as model for an anchor"))149			}150		}151		typeBehind := operator.TypeBehind()152		if typeBehind != nil && typeBehind != typ {153			t.Helper()154			t.Fatal(color.Bad("Operator %s TypeBehind() returned %s which differs from model type %s. Omit model or ensure its type is %[2]s",155				operator.GetLocation().Func, typeBehind, typ))156		}157	} else {158		typ = operator.TypeBehind()159		if typ == nil {160			t.Helper()161			t.Fatal(color.Bad("Cannot anchor operator %s as TypeBehind() returned nil. Use model parameter to specify the type to return",162				operator.GetLocation().Func))163		}164	}165	nvm, err := t.Config.anchors.AddAnchor(typ, reflect.ValueOf(operator))166	if err != nil {167		t.Helper()168		t.Fatal(color.Bad(err.Error()))169	}170	return nvm.Interface()171}172// A is a synonym for [T.Anchor].173//174//	import (175//	  "testing"176//177//	  "github.com/maxatome/go-testdeep/td"178//	)179//180//	func TestFunc(tt *testing.T) {181//	  got := Func()182//183//	  t := td.NewT(tt)184//	  t.Cmp(got, &MyStruct{185//	    Name:    "Bob",186//	    Details: &MyDetails{187//	      Nick: t.A(td.HasPrefix("Bobby"), "").(string),188//	      Age:  t.A(td.Between(40, 50)).(int),189//	    },190//	  })191//	}192//193// See also [T.AnchorsPersistTemporarily], [T.DoAnchorsPersist],194// [T.ResetAnchors], [T.SetAnchorsPersist] and [AddAnchorableStructType].195func (t *T) A(operator TestDeep, model ...any) any {196	t.Helper()197	return t.Anchor(operator, model...)198}199func (t *T) resetNonPersistentAnchors() {200	t.Config.anchors.ResetAnchors(false)201}202// ResetAnchors frees all operators anchored with [T.Anchor]203// method. Unless operators anchoring persistence has been enabled204// with [T.SetAnchorsPersist], there is no need to call this205// method. Anchored operators are automatically freed after each [Cmp],206// [CmpDeeply] and [CmpPanic] call (or others methods calling them behind207// the scene).208//209// See also [T.Anchor], [T.AnchorsPersistTemporarily],210// [T.DoAnchorsPersist], [T.SetAnchorsPersist] and [AddAnchorableStructType].211func (t *T) ResetAnchors() {212	t.Config.anchors.ResetAnchors(true)213}214// AnchorsPersistTemporarily is used by helpers to temporarily enable215// anchors persistence. See [tdhttp] package for an example of use. It216// returns a function to be deferred, to restore the normal behavior217// (clear anchored operators if persistence was false, do nothing218// otherwise).219//220// Typically used as:221//222//	defer t.AnchorsPersistTemporarily()()223//	// or224//	t.Cleanup(t.AnchorsPersistTemporarily())225//226// See also [T.Anchor], [T.DoAnchorsPersist], [T.ResetAnchors],227// [T.SetAnchorsPersist] and [AddAnchorableStructType].228//229// [tdhttp]: https://pkg.go.dev/github.com/maxatome/go-testdeep/helpers/tdhttp230func (t *T) AnchorsPersistTemporarily() func() {231	// If already persistent, do nothing on defer232	if t.DoAnchorsPersist() {233		return func() {}234	}235	t.SetAnchorsPersist(true)236	return func() {237		t.SetAnchorsPersist(false)238		t.Config.anchors.ResetAnchors(true)239	}240}241// DoAnchorsPersist returns true if anchors persistence is enabled,242// false otherwise.243//244// See also [T.Anchor], [T.AnchorsPersistTemporarily],245// [T.ResetAnchors], [T.SetAnchorsPersist] and [AddAnchorableStructType].246func (t *T) DoAnchorsPersist() bool {247	return t.Config.anchors.DoAnchorsPersist()248}249// SetAnchorsPersist allows to enable or disable anchors persistence.250//251// See also [T.Anchor], [T.AnchorsPersistTemporarily],252// [T.DoAnchorsPersist], [T.ResetAnchors] and [AddAnchorableStructType].253func (t *T) SetAnchorsPersist(persist bool) {254	t.Config.anchors.SetAnchorsPersist(persist)255}256func (t *T) initAnchors() {257	if t.Config.anchors != nil {258		return259	}260	name := t.Name()261	allAnchorsMu.Lock()262	defer allAnchorsMu.Unlock()263	t.Config.anchors = allAnchors[name]264	if t.Config.anchors == nil {265		t.Config.anchors = anchors.NewInfo()266		allAnchors[name] = t.Config.anchors...

t_anchor_test.go

Source:t_anchor_test.go

...86}87func (p privStruct) Num() int64 {88	return p.num89}90func TestAddAnchorableStructType(tt *testing.T) {91	type MyStruct struct {92		Priv privStruct93	}94	ttt := test.NewTestingTB(tt.Name())95	t := td.NewT(ttt)96	// We want to anchor this operator97	op := td.Smuggle((privStruct).Num, int64(42))98	// Without making privStruct anchorable, it does not work99	td.Cmp(tt, ttt.CatchFatal(func() { t.A(op, privStruct{}) }),100		"td_test.privStruct struct type is not supported as an anchor. Try AddAnchorableStructType")101	// Make privStruct anchorable102	td.AddAnchorableStructType(func(nextAnchor int) privStruct {103		return privStruct{num: int64(2e9 - nextAnchor)}104	})105	td.CmpTrue(tt,106		t.Cmp(MyStruct{Priv: privStruct{num: 42}},107			MyStruct{108				Priv: t.A(op, privStruct{}).(privStruct), // â now it works109			}))110	// Error111	test.CheckPanic(tt,112		func() { td.AddAnchorableStructType(123) },113		"usage: AddAnchorableStructType(func (nextAnchor int) STRUCT_TYPE)")114}115func TestAnchorsPersist(tt *testing.T) {116	ttt := test.NewTestingTB(tt.Name())117	t1 := td.NewT(ttt)118	t2 := td.NewT(ttt)119	t3 := td.NewT(t1)120	tt.Run("without anchors persistence", func(tt *testing.T) {121		// Anchors persistence is shared for a same testing.TB122		td.CmpFalse(tt, t1.DoAnchorsPersist())123		td.CmpFalse(tt, t2.DoAnchorsPersist())124		td.CmpFalse(tt, t3.DoAnchorsPersist())125		func() {126			defer t1.AnchorsPersistTemporarily()()127			td.CmpTrue(tt, t1.DoAnchorsPersist())...

AddAnchorableStructType

Using AI Code Generation

1import (2type Person struct {3}4func main() {5	data := []Person{6		{"Steve", 18},7		{"Elliot", 24},8		{"Stevie", 16},9	}10	td := tablewriter.NewWriter(os.Stdout)11	td.SetHeader([]string{"Name", "Age"})12	td.SetBorder(false)13	td.SetRowLine(true)14	td.SetCenterSeparator(" ")15	td.SetColumnSeparator(" ")16	td.SetRowSeparator("-")17	td.SetHeaderLine(false)18	td.SetAutoWrapText(false)19	td.SetHeaderAlignment(tablewriter.ALIGN_LEFT)20	td.SetAlignment(tablewriter.ALIGN_LEFT)21	td.SetAutoFormatHeaders(false)22	td.SetAutoFormatHeaders(false)23	td.SetAutoWrapText(false)24	td.SetAutoMergeCells(true)25	td.SetHeaderLine(false)26	td.SetHeaderAlignment(tablewriter.ALIGN_LEFT)27	td.SetAlignment(tablewriter.ALIGN_LEFT)28	td.SetCenterSeparator(" ")29	td.SetColumnSeparator(" ")30	td.SetRowSeparator("-")31	td.SetBorder(false)32	td.SetRowLine(true)33	td.SetAutoWrapText(false)34	td.SetAutoMergeCells(true)35	td.SetHeaderLine(false)36	td.SetHeaderAlignment(tablewriter.ALIGN_LEFT)37	td.SetAlignment(tablewriter.ALIGN_LEFT)38	td.SetCenterSeparator(" ")39	td.SetColumnSeparator(" ")40	td.SetRowSeparator("-")41	td.SetBorder(false)42	td.SetRowLine(true)43	td.SetAutoWrapText(false)44	td.SetAutoMergeCells(true)45	td.SetHeaderLine(false)46	td.SetHeaderAlignment(tablewriter.ALIGN_LEFT)47	td.SetAlignment(tablewriter.ALIGN_LEFT)48	td.SetCenterSeparator(" ")49	td.SetColumnSeparator(" ")50	td.SetRowSeparator("-")51	td.SetBorder(false)52	td.SetRowLine(true)53	td.SetAutoWrapText(false)54	td.SetAutoMergeCells(true)55	td.SetHeaderLine(false)56	td.SetHeaderAlignment(tablewriter.ALIGN_LEFT)57	td.SetAlignment(tablewriter.ALIGN_LEFT)58	td.SetCenterSeparator(" ")59	td.SetColumnSeparator(" ")60	td.SetRowSeparator("-")61	td.SetBorder(false)62	td.SetRowLine(true)63	td.SetAutoWrapText(false)64	td.SetAutoMergeCells(true)65	td.SetHeaderLine(false)66	td.SetHeaderAlignment(tablewriter.ALIGN_LEFT)67	td.SetAlignment(tablewriter.ALIGN_LEFT)68	td.SetCenterSeparator(" ")69	td.SetColumnSeparator(" ")70	td.SetRowSeparator("-")71	td.SetBorder(false)72	td.SetRowLine(true)

AddAnchorableStructType

Using AI Code Generation

1import (2type User struct {3}4func main() {5	td := structuredtext.NewDocument()6	td.AddAnchorableStructType(User{}, "User", "User", strcase.ToSnake)7	fmt.Println(td.String())8}9import (10type User struct {11}12func main() {13	td := structuredtext.NewDocument()14	td.AddAnchorableStructType(User{}, "User", "User", strcase.ToSnake)15	fmt.Println(td.String())16}17import (18type User struct {19}20func main() {21	td := structuredtext.NewDocument()22	td.AddAnchorableStructType(User{}, "User", "User", strcase.ToSnake)23	fmt.Println(td.String())24}25import (26type User struct {27}28func main() {29	td := structuredtext.NewDocument()30	td.AddAnchorableStructType(User{}, "User", "User", strcase.ToSnake)31	fmt.Println(td.String())32}33import (

AddAnchorableStructType

Using AI Code Generation

1import (2type User struct {3}4func main() {5    td := xlsx.NewTemplate()6    td.AddAnchorableStructType(User{}, nil)7    td.ParseFiles("template.xlsx")8    td.WriteToFile("out.xlsx")9}10{{.Name}} is {{.Age}} years old and he lives in {{.City}}11import (12type User struct {13}14func main() {15    td := xlsx.NewTemplate()16    td.AddAnchorableStructType(User{}, nil)17    td.ParseFiles("template.xlsx")18    td.WriteToFile("out.xlsx")19}20{{.Name}} is {{.Age}} years old and he lives in {{.City}}

AddAnchorableStructType

Using AI Code Generation

1import (2type AnchorableStruct struct {3}4func main() {5	td := xlsx.NewTemplateData()6	td.AddAnchorableStructType(AnchorableStruct{})

AddAnchorableStructType

Using AI Code Generation

1td.AddAnchorableStructType("MyStruct", "MyStruct", typeof(MyStruct), "MyStruct");2td.AddAnchorableStructType("MyStruct", "MyStruct", typeof(MyStruct), "MyStruct");3td.AddAnchorableStructType("MyStruct", "MyStruct", typeof(MyStruct), "MyStruct");4td.AddAnchorableStructType("MyStruct", "MyStruct", typeof(MyStruct), "MyStruct");5td.AddAnchorableStructType("MyStruct", "MyStruct", typeof(MyStruct), "MyStruct");6td.AddAnchorableStructType("MyStruct", "MyStruct", typeof(MyStruct), "MyStruct");7td.AddAnchorableStructType("MyStruct", "MyStruct", typeof(MyStruct), "MyStruct");8td.AddAnchorableStructType("MyStruct", "MyStruct", typeof(MyStruct), "MyStruct");9td.AddAnchorableStructType("MyStruct", "MyStruct", typeof(MyStruct), "MyStruct");10td.AddAnchorableStructType("MyStruct", "MyStruct", typeof(MyStruct), "MyStruct");11td.AddAnchorableStructType("MyStruct", "MyStruct", typeof(MyStruct), "MyStruct");12td.AddAnchorableStructType("MyStruct", "MyStruct", typeof(MyStruct), "MyStruct");13td.AddAnchorableStructType("MyStruct", "MyStruct", typeof(MyStruct), "MyStruct");

AddAnchorableStructType

Using AI Code Generation

1import (2type Test struct {3}4func main() {5	td := wade.NewTableData()6	td.AddAnchorableStructType(Test{}, "Test")7	fmt.Println(td.String())8}9import (10type Test struct {11}12func main() {13	td := wade.NewTableData()14	td.AddAnchorableStructType(Test{}, "Test")15	fmt.Println(td.String())16}17import (18type Test struct {19}20func main() {21	td := wade.NewTableData()22	td.AddAnchorableStructType(Test{}, "Test")23	fmt.Println(td.String())24}25import (26type Test struct {27}28func main() {29	td := wade.NewTableData()30	td.AddAnchorableStructType(Test{}, "Test")31	fmt.Println(td.String())32}33import (34type Test struct {35}36func main() {37	td := wade.NewTableData()38	td.AddAnchorableStructType(Test{}, "Test")39	fmt.Println(td.String())40}

AddAnchorableStructType

Using AI Code Generation

1import (2func main() {3    td := giu.NewTypeDictionary()4    td.AddAnchorableStructType("mystruct", "MyStruct")5    fmt.Println(td)6}7{"AnchorableStructTypes":{"mystruct":"MyStruct"}}8{9    "AnchorableStructTypes": {10    }11}12import (13func main() {14    td := giu.NewTypeDictionary()15    td.FromJSONFile("3.json")16    fmt.Println(td)17}18{"AnchorableStructTypes":{"mystruct":"MyStruct"}}19{20    "AnchorableStructTypes": {21    }22}23import (24func main() {25    td := giu.NewTypeDictionary()26    td.FromJSONString(`{"AnchorableStructTypes": {"mystruct": "MyStruct"}}`)27    fmt.Println(td)28}29{"AnchorableStructTypes":{"mystruct":"MyStruct"}}

Automation Testing Tutorials

Learn to execute automation testing from scratch with LambdaTest Learning Hub. Right from setting up the prerequisites to run your first automation test, to following best practices and diving deeper into advanced test scenarios. LambdaTest Learning Hubs compile a list of step-by-step guides to help you be proficient with different test automation frameworks i.e. Selenium, Cypress, TestNG etc.