github.com/ipld/go-ipld-prime@v0.21.0/node/tests/schemaMaps.go

package tests

import (
	"testing"

	qt "github.com/frankban/quicktest"

	"github.com/ipld/go-ipld-prime/datamodel"
	"github.com/ipld/go-ipld-prime/fluent"
	"github.com/ipld/go-ipld-prime/must"
	"github.com/ipld/go-ipld-prime/schema"
)

func SchemaTestMapsContainingMaybe(t *testing.T, engine Engine) {
	ts := schema.TypeSystem{}
	ts.Init()
	ts.Accumulate(schema.SpawnString("String"))
	ts.Accumulate(schema.SpawnMap("Map__String__String",
		"String", "String", false))
	ts.Accumulate(schema.SpawnMap("Map__String__nullableString",
		"String", "String", true))
	engine.Init(t, ts)

	t.Run("non-nullable", func(t *testing.T) {
		np := engine.PrototypeByName("Map__String__String")
		nrp := engine.PrototypeByName("Map__String__String.Repr")
		var n schema.TypedNode
		t.Run("typed-create", func(t *testing.T) {
			n = fluent.MustBuildMap(np, 2, func(ma fluent.MapAssembler) {
				ma.AssembleEntry("one").AssignString("1")
				ma.AssembleEntry("two").AssignString("2")
			}).(schema.TypedNode)
			t.Run("typed-read", func(t *testing.T) {
				qt.Assert(t, n.Kind(), qt.Equals, datamodel.Kind_Map)
				qt.Check(t, n.Length(), qt.Equals, int64(2))
				qt.Check(t, must.String(must.Node(n.LookupByString("one"))), qt.Equals, "1")
				qt.Check(t, must.String(must.Node(n.LookupByString("two"))), qt.Equals, "2")
				_, err := n.LookupByString("miss")
				qt.Check(t, err, qt.ErrorAs, &datamodel.ErrNotExists{})
			})
			t.Run("repr-read", func(t *testing.T) {
				nr := n.Representation()
				qt.Assert(t, nr.Kind(), qt.Equals, datamodel.Kind_Map)
				qt.Check(t, nr.Length(), qt.Equals, int64(2))
				qt.Check(t, must.String(must.Node(nr.LookupByString("one"))), qt.Equals, "1")
				qt.Check(t, must.String(must.Node(nr.LookupByString("two"))), qt.Equals, "2")
				_, err := nr.LookupByString("miss")
				qt.Check(t, err, qt.ErrorAs, &datamodel.ErrNotExists{})
			})
		})
		t.Run("repr-create", func(t *testing.T) {
			nr := fluent.MustBuildMap(nrp, 2, func(ma fluent.MapAssembler) {
				ma.AssembleEntry("one").AssignString("1")
				ma.AssembleEntry("two").AssignString("2")
			})
			qt.Check(t, n, NodeContentEquals, nr)
		})
	})
	t.Run("nullable", func(t *testing.T) {
		np := engine.PrototypeByName("Map__String__nullableString")
		nrp := engine.PrototypeByName("Map__String__nullableString.Repr")
		var n schema.TypedNode
		t.Run("typed-create", func(t *testing.T) {
			n = fluent.MustBuildMap(np, 2, func(ma fluent.MapAssembler) {
				ma.AssembleEntry("one").AssignString("1")
				ma.AssembleEntry("none").AssignNull()
			}).(schema.TypedNode)
			t.Run("typed-read", func(t *testing.T) {
				qt.Assert(t, n.Kind(), qt.Equals, datamodel.Kind_Map)
				qt.Check(t, n.Length(), qt.Equals, int64(2))
				qt.Check(t, must.String(must.Node(n.LookupByString("one"))), qt.Equals, "1")
				qt.Check(t, must.Node(n.LookupByString("none")), qt.Equals, datamodel.Null)
				_, err := n.LookupByString("miss")
				qt.Check(t, err, qt.ErrorAs, &datamodel.ErrNotExists{})
			})
			t.Run("repr-read", func(t *testing.T) {
				nr := n.Representation()
				qt.Assert(t, nr.Kind(), qt.Equals, datamodel.Kind_Map)
				qt.Check(t, nr.Length(), qt.Equals, int64(2))
				qt.Check(t, must.String(must.Node(nr.LookupByString("one"))), qt.Equals, "1")
				qt.Check(t, must.Node(nr.LookupByString("none")), qt.Equals, datamodel.Null)
				_, err := nr.LookupByString("miss")
				qt.Check(t, err, qt.ErrorAs, &datamodel.ErrNotExists{})
			})
		})
		t.Run("repr-create", func(t *testing.T) {
			nr := fluent.MustBuildMap(nrp, 2, func(ma fluent.MapAssembler) {
				ma.AssembleEntry("one").AssignString("1")
				ma.AssembleEntry("none").AssignNull()
			})
			qt.Check(t, n, NodeContentEquals, nr)
		})
	})
}

// TestMapsContainingMaps is probing *two* things:
//   - that maps can nest, obviously
//   - that representation semantics are held correctly when we recurse, both in builders and in reading
//
// To cover that latter situation, this depends on structs (so we can use rename directives on the representation to make it distinctive).
func SchemaTestMapsContainingMaps(t *testing.T, engine Engine) {
	ts := schema.TypeSystem{}
	ts.Init()
	ts.Accumulate(schema.SpawnString("String"))
	ts.Accumulate(schema.SpawnStruct("Frub", // "type Frub struct { field String (rename "encoded") }"
		[]schema.StructField{
			schema.SpawnStructField("field", "String", false, false), // plain field.
		},
		schema.SpawnStructRepresentationMap(map[string]string{
			"field": "encoded",
		}),
	))
	ts.Accumulate(schema.SpawnMap("Map__String__Frub", // "{String:Frub}"
		"String", "Frub", false))
	ts.Accumulate(schema.SpawnMap("Map__String__nullableMap__String__Frub", // "{String:nullable {String:Frub}}"
		"String", "Map__String__Frub", true))
	engine.Init(t, ts)

	np := engine.PrototypeByName("Map__String__nullableMap__String__Frub")
	nrp := engine.PrototypeByName("Map__String__nullableMap__String__Frub.Repr")
	creation := func(t *testing.T, np datamodel.NodePrototype, fieldName string) schema.TypedNode {
		return fluent.MustBuildMap(np, 3, func(ma fluent.MapAssembler) {
			ma.AssembleEntry("one").CreateMap(2, func(ma fluent.MapAssembler) {
				ma.AssembleEntry("zot").CreateMap(1, func(ma fluent.MapAssembler) { ma.AssembleEntry(fieldName).AssignString("11") })
				ma.AssembleEntry("zop").CreateMap(1, func(ma fluent.MapAssembler) { ma.AssembleEntry(fieldName).AssignString("12") })
			})
			ma.AssembleEntry("two").CreateMap(1, func(ma fluent.MapAssembler) {
				ma.AssembleEntry("zim").CreateMap(1, func(ma fluent.MapAssembler) { ma.AssembleEntry(fieldName).AssignString("21") })
			})
			ma.AssembleEntry("none").AssignNull()
		}).(schema.TypedNode)
	}
	reading := func(t *testing.T, n datamodel.Node, fieldName string) {
		withNode(n, func(n datamodel.Node) {
			qt.Assert(t, n.Kind(), qt.Equals, datamodel.Kind_Map)
			qt.Check(t, n.Length(), qt.Equals, int64(3))
			withNode(must.Node(n.LookupByString("one")), func(n datamodel.Node) {
				qt.Assert(t, n.Kind(), qt.Equals, datamodel.Kind_Map)
				qt.Check(t, n.Length(), qt.Equals, int64(2))
				withNode(must.Node(n.LookupByString("zot")), func(n datamodel.Node) {
					qt.Assert(t, n.Kind(), qt.Equals, datamodel.Kind_Map)
					qt.Check(t, n.Length(), qt.Equals, int64(1))
					qt.Check(t, must.String(must.Node(n.LookupByString(fieldName))), qt.Equals, "11")
				})
				withNode(must.Node(n.LookupByString("zop")), func(n datamodel.Node) {
					qt.Assert(t, n.Kind(), qt.Equals, datamodel.Kind_Map)
					qt.Check(t, n.Length(), qt.Equals, int64(1))
					qt.Check(t, must.String(must.Node(n.LookupByString(fieldName))), qt.Equals, "12")
				})
			})
			withNode(must.Node(n.LookupByString("two")), func(n datamodel.Node) {
				qt.Check(t, n.Length(), qt.Equals, int64(1))
				withNode(must.Node(n.LookupByString("zim")), func(n datamodel.Node) {
					qt.Assert(t, n.Kind(), qt.Equals, datamodel.Kind_Map)
					qt.Check(t, n.Length(), qt.Equals, int64(1))
					qt.Check(t, must.String(must.Node(n.LookupByString(fieldName))), qt.Equals, "21")
				})
			})
			withNode(must.Node(n.LookupByString("none")), func(n datamodel.Node) {
				qt.Check(t, n, NodeContentEquals, datamodel.Null)
			})
			_, err := n.LookupByString("miss")
			qt.Check(t, err, qt.ErrorAs, &datamodel.ErrNotExists{})
		})
	}
	var n schema.TypedNode
	t.Run("typed-create", func(t *testing.T) {
		n = creation(t, np, "field")
		t.Run("typed-read", func(t *testing.T) {
			reading(t, n, "field")
		})
		t.Run("repr-read", func(t *testing.T) {
			reading(t, n.Representation(), "encoded")
		})
	})
	t.Run("repr-create", func(t *testing.T) {
		nr := creation(t, nrp, "encoded")
		qt.Check(t, n, NodeContentEquals, nr)
	})
}

func SchemaTestMapsWithComplexKeys(t *testing.T, engine Engine) {
	ts := schema.TypeSystem{}
	ts.Init()
	ts.Accumulate(schema.SpawnString("String"))
	ts.Accumulate(schema.SpawnStruct("StringyStruct",
		[]schema.StructField{
			schema.SpawnStructField("foo", "String", false, false),
			schema.SpawnStructField("bar", "String", false, false),
		},
		schema.SpawnStructRepresentationStringjoin(":"),
	))
	ts.Accumulate(schema.SpawnMap("Map__StringyStruct__String",
		"StringyStruct", "String", false))
	engine.Init(t, ts)

	np := engine.PrototypeByName("Map__StringyStruct__String")
	nrp := engine.PrototypeByName("Map__StringyStruct__String.Repr")
	var n schema.TypedNode
	t.Run("typed-create", func(t *testing.T) {
		n = fluent.MustBuildMap(np, 3, func(ma fluent.MapAssembler) {
			ma.AssembleKey().CreateMap(2, func(ma fluent.MapAssembler) {
				ma.AssembleEntry("foo").AssignString("a")
				ma.AssembleEntry("bar").AssignString("b")
			})
			ma.AssembleValue().AssignString("1")
			ma.AssembleKey().CreateMap(2, func(ma fluent.MapAssembler) {
				ma.AssembleEntry("foo").AssignString("c")
				ma.AssembleEntry("bar").AssignString("d")
			})
			ma.AssembleValue().AssignString("2")
			ma.AssembleKey().CreateMap(2, func(ma fluent.MapAssembler) {
				ma.AssembleEntry("foo").AssignString("e")
				ma.AssembleEntry("bar").AssignString("f")
			})
			ma.AssembleValue().AssignString("3")
		}).(schema.TypedNode)
		t.Run("typed-read", func(t *testing.T) {
			qt.Assert(t, n.Kind(), qt.Equals, datamodel.Kind_Map)
			qt.Check(t, n.Length(), qt.Equals, int64(3))
			n2 := must.Node(n.LookupByString("c:d"))
			qt.Assert(t, n2.Kind(), qt.Equals, datamodel.Kind_String)
			qt.Check(t, must.String(n2), qt.Equals, "2")
		})
		t.Run("repr-read", func(t *testing.T) {
			nr := n.Representation()
			qt.Assert(t, nr.Kind(), qt.Equals, datamodel.Kind_Map)
			qt.Check(t, nr.Length(), qt.Equals, int64(3))
			n2 := must.Node(nr.LookupByString("c:d"))
			qt.Assert(t, n2.Kind(), qt.Equals, datamodel.Kind_String)
			qt.Check(t, must.String(n2), qt.Equals, "2")
		})
	})
	t.Run("repr-create", func(t *testing.T) {
		nr := fluent.MustBuildMap(nrp, 3, func(ma fluent.MapAssembler) {
			ma.AssembleEntry("a:b").AssignString("1")
			ma.AssembleEntry("c:d").AssignString("2")
			ma.AssembleEntry("e:f").AssignString("3")
		})
		qt.Check(t, n, NodeContentEquals, nr)
	})
}