github.com/joomcode/cue@v0.4.4-0.20221111115225-539fe3512047/internal/core/export/export_test.go

// Copyright 2020 CUE Authors
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//     http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

package export_test

import (
	"testing"

	"github.com/joomcode/cue/cue"
	"github.com/joomcode/cue/cue/ast"
	"github.com/joomcode/cue/cue/cuecontext"
	"github.com/joomcode/cue/cue/errors"
	"github.com/joomcode/cue/cue/format"
	"github.com/joomcode/cue/cue/parser"
	"github.com/joomcode/cue/encoding/gocode/gocodec"
	"github.com/joomcode/cue/internal/astinternal"
	"github.com/joomcode/cue/internal/core/adt"
	"github.com/joomcode/cue/internal/core/compile"
	"github.com/joomcode/cue/internal/core/convert"
	"github.com/joomcode/cue/internal/core/eval"
	"github.com/joomcode/cue/internal/core/export"
	"github.com/joomcode/cue/internal/core/runtime"
	"github.com/joomcode/cue/internal/cuetest"
	"github.com/joomcode/cue/internal/cuetxtar"
	"github.com/joomcode/cue/internal/value"
	"github.com/rogpeppe/go-internal/txtar"
)

func TestDefinition(t *testing.T) {
	test := cuetxtar.TxTarTest{
		Root:   "./testdata",
		Name:   "definition",
		Update: cuetest.UpdateGoldenFiles,
	}

	r := runtime.New()

	test.Run(t, func(t *cuetxtar.Test) {
		a := t.ValidInstances()

		v, errs := compile.Files(nil, r, "", a[0].Files...)
		if errs != nil {
			t.Fatal(errs)
		}
		v.Finalize(eval.NewContext(r, v))

		// TODO: do we need to evaluate v? In principle not necessary.
		// v.Finalize(eval.NewContext(r, v))

		file, errs := export.Def(r, "", v)
		errors.Print(t, errs, nil)
		_, _ = t.Write(formatNode(t.T, file))
	})
}

func formatNode(t *testing.T, n ast.Node) []byte {
	t.Helper()

	b, err := format.Node(n)
	if err != nil {
		t.Fatal(err)
	}
	return b
}

// TestGenerated tests conversions of generated Go structs, which may be
// different from parsed or evaluated CUE, such as having Vertex values.
func TestGenerated(t *testing.T) {
	ctx := cuecontext.New()

	testCases := []struct {
		in  func(ctx *adt.OpContext) (adt.Expr, error)
		out string
		p   *export.Profile
	}{{
		in: func(ctx *adt.OpContext) (adt.Expr, error) {
			in := &C{
				Terminals: []*A{{Name: "Name", Description: "Desc"}},
			}
			return convert.GoValueToValue(ctx, in, false), nil
		},
		out: `Terminals: [{Name: "Name", Description: "Desc"}]`,
	}, {
		in: func(ctx *adt.OpContext) (adt.Expr, error) {
			in := &C{
				Terminals: []*A{{Name: "Name", Description: "Desc"}},
			}
			return convert.GoTypeToExpr(ctx, in)
		},
		out: `*null|{Terminals?: *null|[...*null|{Name: string, Description: string}]}`,
	}, {
		in: func(ctx *adt.OpContext) (adt.Expr, error) {
			in := []*A{{Name: "Name", Description: "Desc"}}
			return convert.GoValueToValue(ctx, in, false), nil
		},
		out: `[{Name: "Name", Description: "Desc"}]`,
	}, {
		in: func(ctx *adt.OpContext) (adt.Expr, error) {
			in := []*A{{Name: "Name", Description: "Desc"}}
			return convert.GoTypeToExpr(ctx, in)
		},
		out: `*null|[...*null|{Name: string, Description: string}]`,
	}, {
		in: func(ctx *adt.OpContext) (adt.Expr, error) {
			expr, err := parser.ParseExpr("test", `{
				x: Guide.#Terminal
				Guide: {}
			}`)
			if err != nil {
				return nil, err
			}
			c, err := compile.Expr(nil, ctx, "_", expr)
			if err != nil {
				return nil, err
			}
			root := &adt.Vertex{}
			root.AddConjunct(c)
			root.Finalize(ctx)

			// Simulate Value.Unify of Lookup("x") and Lookup("Guide").
			n := &adt.Vertex{}
			n.AddConjunct(adt.MakeRootConjunct(nil, root.Arcs[0]))
			n.AddConjunct(adt.MakeRootConjunct(nil, root.Arcs[1]))
			n.Finalize(ctx)

			return n, nil
		},
		out: `<[l2// x: undefined field: #Terminal] _|_>`,
		p:   export.Final,
	}, {
		in: func(r *adt.OpContext) (adt.Expr, error) {
			v := ctx.CompileString(`
				#Provider: {
					ID: string
					notConcrete: bool
					a: int
					b: a + 1
				}`)

			spec := v.LookupPath(cue.ParsePath("#Provider"))
			spec2 := spec.FillPath(cue.ParsePath("ID"), "12345")
			root := v.FillPath(cue.ParsePath("providers.foo"), spec2)
			_, n := value.ToInternal(root)

			return n, nil
		},
		out: `#Provider: {ID: string, notConcrete: bool, a: int, b: a+1}, providers: {foo: {ID: "12345", notConcrete: bool, a: int, b: a+1}}`,
		p:   export.All,
	}, {
		// Issue #882
		in: func(r *adt.OpContext) (adt.Expr, error) {
			valA := ctx.CompileString(`
				#One: { version: string }
			`)

			valB := ctx.CompileString(`
				#One: _
				ones: {[string]: #One}
			`)
			v := valB.Unify(valA)
			_, n := value.ToInternal(v)
			return n, nil
		},
		out: `#One: {version: string}, ones: {[string]: #One}`,
		p:   export.All,
	}, {
		// Indicate closedness in an element that is closed and misses parent
		// context.
		// Issue #882
		in: func(r *adt.OpContext) (adt.Expr, error) {
			v := ctx.CompileString(`
					#A: b: c: string
				`)
			v = v.LookupPath(cue.ParsePath("#A.b"))

			_, n := value.ToInternal(v)
			return n, nil
		},
		out: `_#def, _#def: {c: string}`,
		p:   export.All,
	}, {
		// Don't wrap in def if the if the value is an embedded scalar.
		// Issue #977
		in: func(r *adt.OpContext) (adt.Expr, error) {
			v := ctx.CompileString(`
					#A: { "foo", #enum: 2 }
				`)
			v = v.LookupPath(cue.ParsePath("#A"))

			_, n := value.ToInternal(v)
			return n, nil
		},
		out: `"foo", #enum: 2`,
		p:   export.All,
	}, {
		// Issue #1131
		in: func(r *adt.OpContext) (adt.Expr, error) {
			m := make(map[string]interface{})
			v := ctx.Encode(m)
			_, x := value.ToInternal(v)
			return x, nil
		},
		out: ``, // empty file
	}, {
		in: func(r *adt.OpContext) (adt.Expr, error) {
			v := &adt.Vertex{}
			v.SetValue(r, adt.Finalized, &adt.StructMarker{})
			return v, nil
		},
		out: ``, // empty file
	}}
	for _, tc := range testCases {
		t.Run("", func(t *testing.T) {
			ctx := adt.NewContext((*runtime.Runtime)(ctx), &adt.Vertex{})

			v, err := tc.in(ctx)
			if err != nil {
				t.Fatal("failed test case: ", err)
			}

			p := tc.p
			if p == nil {
				p = export.Simplified
			}

			var n ast.Node
			switch x := v.(type) {
			case *adt.Vertex:
				n, err = p.Def(ctx, "", x)
			default:
				n, err = p.Expr(ctx, "", v)
			}
			if err != nil {
				t.Fatal("failed export: ", err)
			}
			got := astinternal.DebugStr(n)
			if got != tc.out {
				t.Errorf("got:  %s\nwant: %s", got, tc.out)
			}
		})
	}
}

type A struct {
	Name        string
	Description string
}

type B struct {
	Image string
}

type C struct {
	Terminals []*A
}

// For debugging purposes. Do not delete.
func TestX(t *testing.T) {
	t.Skip()

	in := `
-- in.cue --
package test

// // Foo
// a: [X=string]: [Y=string]: {
// 	name: X+Y
// }

// [Y=string]: [X=string]: name: {Y+X}
// {
// 	name:  X.other + Y
// 	other: string
// }

// c: [X=string]: X

// #pkg1: Object

// "Hello \(#pkg1)!"


// Object: "World"

// // A Foo fooses stuff.
// foos are instances of Foo.
// foos: [string]: {}

// // // My first little foo.
// foos: MyFoo: {}
	`

	archive := txtar.Parse([]byte(in))
	a := cuetxtar.Load(archive, "/tmp/test")
	if err := a[0].Err; err != nil {
		t.Fatal(err)
	}

	// x := a[0].Files[0]
	// astutil.Sanitize(x)

	r := runtime.New()
	v, errs := compile.Files(nil, r, "", a[0].Files...)
	if errs != nil {
		t.Fatal(errs)
	}
	v.Finalize(eval.NewContext(r, v))

	file, errs := export.Def(r, "main", v)
	if errs != nil {
		t.Fatal(errs)
	}

	t.Error(string(formatNode(t, file)))
}

func TestFromGo(t *testing.T) {
	type Struct struct {
		A string
		B string
	}

	m := make(map[string]Struct)
	m["hello"] = Struct{
		A: "a",
		B: "b",
	}
	var r cue.Runtime
	codec := gocodec.New(&r, nil)
	v, err := codec.Decode(m)
	if err != nil {
		panic(err)
	}

	syn, _ := format.Node(v.Syntax())
	if got := string(syn); got != `{
	hello: {
		A: "a"
		B: "b"
	}
}` {
		t.Errorf("incorrect ordering: %s\n", got)
	}
}

func TestFromAPI(t *testing.T) {
	testCases := []struct {
		expr ast.Expr
		out  string
	}{{
		expr: ast.NewCall(ast.NewIdent("close"), ast.NewStruct()),
		out:  `close({})`,
	}, {
		expr: ast.NewCall(ast.NewIdent("close"), ast.NewStruct(
			"a", ast.NewString("foo"),
		)),
		out: `close({a: "foo"})`,
	}, {
		expr: ast.NewCall(ast.NewIdent("close"), ast.NewStruct(
			ast.Embed(ast.NewStruct("a", ast.NewString("foo"))),
		)),
		out: `close({a: "foo"})`,
	}}
	// Issue #1204
	for _, tc := range testCases {
		t.Run("", func(t *testing.T) {
			ctx := cuecontext.New()

			v := ctx.BuildExpr(tc.expr)

			r, x := value.ToInternal(v)
			file, err := export.Def(r, "foo", x)

			if err != nil {
				t.Fatal(err)
			}

			got := astinternal.DebugStr(file)
			if got != tc.out {
				t.Errorf("got:  %s\nwant: %s", got, tc.out)
			}

		})
	}
}