github.com/gnolang/gno@v0.0.0-20240520182011-228e9d0192ce/gnovm/pkg/transpiler/transpiler_test.go

package transpiler

import (
	"go/ast"
	goscanner "go/scanner"
	"go/token"
	"strings"
	"testing"

	"github.com/stretchr/testify/assert"
	"github.com/stretchr/testify/require"
)

func TestTranspile(t *testing.T) {
	t.Parallel()

	cases := []struct {
		name            string
		tags            string
		source          string
		expectedOutput  string
		expectedImports []*ast.ImportSpec
		expectedError   string
	}{
		{
			name: "hello",
			source: `
package foo

func hello() string { return "world"}
`,
			expectedOutput: `
// Code generated by github.com/gnolang/gno. DO NOT EDIT.

//line foo.gno:1:1
package foo

func hello() string { return "world" }
`,
		},
		{
			name: "hello with tags",
			tags: "gno",
			source: `
package foo

func hello() string { return "world"}
`,
			expectedOutput: `
// Code generated by github.com/gnolang/gno. DO NOT EDIT.

//go:build gno

//line foo.gno:1:1
package foo

func hello() string { return "world" }
`,
		},
		{
			name: "use-std",
			source: `
package foo

import "std"

func hello() string {
	_ = std.Foo
	return "world"
}
`,
			expectedOutput: `
// Code generated by github.com/gnolang/gno. DO NOT EDIT.

//line foo.gno:1:1
package foo

import "github.com/gnolang/gno/gnovm/stdlibs/stdshim"

func hello() string {
	_ = std.Foo
	return "world"
}
`,
			expectedImports: []*ast.ImportSpec{
				{
					Path: &ast.BasicLit{
						ValuePos: 21,
						Kind:     9,
						Value:    `"github.com/gnolang/gno/gnovm/stdlibs/stdshim"`,
					},
					EndPos: 26,
				},
			},
		},
		{
			name: "use-realm",
			source: `
package foo

import "gno.land/r/users"

func foo()  { _ = users.Register}
`,
			expectedOutput: `
// Code generated by github.com/gnolang/gno. DO NOT EDIT.

//line foo.gno:1:1
package foo

import "github.com/gnolang/gno/examples/gno.land/r/users"

func foo() { _ = users.Register }
`,
			expectedImports: []*ast.ImportSpec{
				{
					Path: &ast.BasicLit{
						ValuePos: 21,
						Kind:     9,
						Value:    `"github.com/gnolang/gno/examples/gno.land/r/users"`,
					},
					EndPos: 39,
				},
			},
		},
		{
			name: "use-avl",
			source: `
package foo

import "gno.land/p/demo/avl"

func foo()  { _ = avl.Tree }
`,
			expectedOutput: `
// Code generated by github.com/gnolang/gno. DO NOT EDIT.

//line foo.gno:1:1
package foo

import "github.com/gnolang/gno/examples/gno.land/p/demo/avl"

func foo() { _ = avl.Tree }
`,
			expectedImports: []*ast.ImportSpec{
				{
					Path: &ast.BasicLit{
						ValuePos: 21,
						Kind:     9,
						Value:    `"github.com/gnolang/gno/examples/gno.land/p/demo/avl"`,
					},
					EndPos: 42,
				},
			},
		},
		{
			name: "use-named-std",
			source: `
package foo

import bar "std"

func hello() string {
	_ = bar.Foo
	return "world"
}
`,
			expectedOutput: `
// Code generated by github.com/gnolang/gno. DO NOT EDIT.

//line foo.gno:1:1
package foo

import bar "github.com/gnolang/gno/gnovm/stdlibs/stdshim"

func hello() string {
	_ = bar.Foo
	return "world"
}
`,
			expectedImports: []*ast.ImportSpec{
				{
					Name: &ast.Ident{
						NamePos: 21,
						Name:    "bar",
					},
					Path: &ast.BasicLit{
						ValuePos: 25,
						Kind:     9,
						Value:    `"github.com/gnolang/gno/gnovm/stdlibs/stdshim"`,
					},
					EndPos: 30,
				},
			},
		},
		{
			name: "blacklisted-package",
			source: `
package foo

import "reflect"

func foo() { _ = reflect.ValueOf }
`,
			expectedError: `transpileAST: foo.gno:3:8: import "reflect" is not in the whitelist`,
		},
		{
			name: "syntax-error",
			source: `
package foo

invalid
`,
			expectedError: `parse: foo.gno:3:1: expected declaration, found invalid`,
		},
		{
			name: "unknown-realm",
			source: `
package foo

import "gno.land/p/demo/unknownxyz"
`,
			expectedOutput: `
// Code generated by github.com/gnolang/gno. DO NOT EDIT.

//line foo.gno:1:1
package foo

import "github.com/gnolang/gno/examples/gno.land/p/demo/unknownxyz"
`,
			expectedImports: []*ast.ImportSpec{
				{
					Path: &ast.BasicLit{
						ValuePos: 21,
						Kind:     9,
						Value:    `"github.com/gnolang/gno/examples/gno.land/p/demo/unknownxyz"`,
					},
					EndPos: 49,
				},
			},
		},
		{
			name: "whitelisted-package",
			source: `
package foo

import "regexp"

func foo() { _ = regexp.MatchString }
`,
			expectedOutput: `
// Code generated by github.com/gnolang/gno. DO NOT EDIT.

//line foo.gno:1:1
package foo

import "regexp"

func foo() { _ = regexp.MatchString }
`,
			expectedImports: []*ast.ImportSpec{
				{
					Path: &ast.BasicLit{
						ValuePos: 21,
						Kind:     9,
						Value:    `"regexp"`,
					},
				},
			},
		},
	}
	for _, c := range cases {
		c := c // scopelint
		t.Run(c.name, func(t *testing.T) {
			t.Parallel()
			// "\n" is added for better test case readability, now trim it
			source := strings.TrimPrefix(c.source, "\n")

			res, err := Transpile(source, c.tags, "foo.gno")

			if c.expectedError != "" {
				require.EqualError(t, err, c.expectedError)
				return
			}
			require.NoError(t, err)
			expectedOutput := strings.TrimPrefix(c.expectedOutput, "\n")
			assert.Equal(t, expectedOutput, res.Translated, "wrong output")
			assert.Equal(t, c.expectedImports, res.Imports, "wrong imports")
		})
	}
}

func TestParseGoBuildErrors(t *testing.T) {
	tests := []struct {
		name          string
		output        string
		expectedError error
	}{
		{
			name:          "empty output",
			output:        "",
			expectedError: nil,
		},
		{
			name:          "random output",
			output:        "xxx",
			expectedError: nil,
		},
		{
			name: "some errors",
			output: `xxx
main.gno:6:2: nasty error
pkg/file.gno:60:20: ugly error`,
			expectedError: goscanner.ErrorList{
				&goscanner.Error{
					Pos: token.Position{
						Filename: "main.gno",
						Line:     6,
						Column:   2,
					},
					Msg: "nasty error",
				},
				&goscanner.Error{
					Pos: token.Position{
						Filename: "pkg/file.gno",
						Line:     60,
						Column:   20,
					},
					Msg: "ugly error",
				},
			},
		},
	}
	for _, tt := range tests {
		t.Run(tt.name, func(t *testing.T) {
			err := parseGoBuildErrors(tt.output)

			assert.Equal(t, tt.expectedError, err)
		})
	}
}