/* Copyright 2015 The Kubernetes Authors All rights reserved. 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 parser_test import ( "bytes" "reflect" "testing" "text/template" "k8s.io/kubernetes/cmd/libs/go2idl/namer" "k8s.io/kubernetes/cmd/libs/go2idl/parser" "k8s.io/kubernetes/cmd/libs/go2idl/types" ) func construct(t *testing.T, files map[string]string, testNamer namer.Namer) (*parser.Builder, types.Universe, []*types.Type) { b := parser.New() for name, src := range files { if err := b.AddFile(name, []byte(src)); err != nil { t.Fatal(err) } } u, err := b.FindTypes() if err != nil { t.Fatal(err) } orderer := namer.Orderer{testNamer} o := orderer.Order(u) return b, u, o } func TestBuilder(t *testing.T) { var testFiles = map[string]string{ "base/foo/proto/foo.go": ` package foo import ( "base/common/proto" ) type Blah struct { common.Object Count int64 Frobbers map[string]*Frobber Baz []Object Nickname *string NumberIsAFavorite map[int]bool } type Frobber struct { Name string Amount int64 } type Object struct { common.Object } func AFunc(obj1 common.Object, obj2 Object) Frobber { } `, "base/common/proto/common.go": ` package common type Object struct { ID int64 } `, } var tmplText = ` package o {{define "Struct"}}type {{Name .}} interface { {{range $m := .Members}}{{$n := Name $m.Type}} {{if $m.Embedded}}{{$n}}{{else}}{{$m.Name}}() {{$n}}{{if $m.Type.Elem}}{{else}} Set{{$m.Name}}({{$n}}){{end}}{{end}}{{end}} } {{end}} {{define "Func"}}{{$s := .Signature}}func {{Raw .}}( {{range $s.Parameters}}{{Raw .}} {{end}}) {{range $s.Results}}{{Raw .}} {{end}}{} {{end}} {{range $t := .}}{{if eq $t.Kind "Struct"}}{{template "Struct" $t}}{{end}}{{end}} {{range $t := .}}{{if eq $t.Kind "Func"}}{{template "Func" $t}}{{end}}{{end}}` var expect = ` package o type CommonObject interface { ID() Int64 SetID(Int64) } type FooBlah interface { CommonObject Count() Int64 SetCount(Int64) Frobbers() MapStringToPointerFooFrobber Baz() SliceFooObject Nickname() PointerString NumberIsAFavorite() MapIntToBool } type FooFrobber interface { Name() String SetName(String) Amount() Int64 SetAmount(Int64) } type FooObject interface { CommonObject } func proto.AFunc( proto.Object proto.Object ) proto.Frobber {} ` testNamer := namer.NewPublicNamer(1, "proto") rawNamer := namer.NewRawNamer("o", nil) _, u, o := construct(t, testFiles, testNamer) t.Logf("\n%v\n\n", o) tmpl := template.Must( template.New(""). Funcs( map[string]interface{}{ "Name": testNamer.Name, "Raw": rawNamer.Name, }). Parse(tmplText), ) buf := &bytes.Buffer{} tmpl.Execute(buf, o) if e, a := expect, buf.String(); e != a { t.Errorf("Wanted, got:\n%v\n-----\n%v\n", e, a) } if p := u.Package("base/foo/proto"); !p.HasImport("base/common/proto") { t.Errorf("Unexpected lack of import line: %#s", p.Imports) } } func TestStructParse(t *testing.T) { var structTest = map[string]string{ "base/foo/proto/foo.go": ` package foo // Blah is a test. // A test, I tell you. type Blah struct { // A is the first field. A int64 ` + "`" + `json:"a"` + "`" + ` // B is the second field. // Multiline comments work. B string ` + "`" + `json:"b"` + "`" + ` } `, } _, u, o := construct(t, structTest, namer.NewPublicNamer(0)) t.Logf("%#v", o) blahT := u.Get(types.Name{"base/foo/proto", "Blah"}) if blahT == nil { t.Fatal("type not found") } if e, a := types.Struct, blahT.Kind; e != a { t.Errorf("struct kind wrong, wanted %v, got %v", e, a) } if e, a := "Blah is a test.\nA test, I tell you.\n", blahT.CommentLines; e != a { t.Errorf("struct comment wrong, wanted %v, got %v", e, a) } m := types.Member{ Name: "B", Embedded: false, CommentLines: "B is the second field.\nMultiline comments work.\n", Tags: `json:"b"`, Type: types.String, } if e, a := m, blahT.Members[1]; !reflect.DeepEqual(e, a) { t.Errorf("wanted, got:\n%#v\n%#v", e, a) } } func TestTypeKindParse(t *testing.T) { var testFiles = map[string]string{ "a/foo.go": "package a\ntype Test string\n", "b/foo.go": "package b\ntype Test map[int]string\n", "c/foo.go": "package c\ntype Test []string\n", "d/foo.go": "package d\ntype Test struct{a int; b struct{a int}; c map[int]string; d *string}\n", "e/foo.go": "package e\ntype Test *string\n", "f/foo.go": ` package f import ( "a" "b" ) type Test []a.Test type Test2 *a.Test type Test3 map[a.Test]b.Test type Test4 struct { a struct {a a.Test; b b.Test} b map[a.Test]b.Test c *a.Test d []a.Test e []string } `, "g/foo.go": ` package g type Test func(a, b string) (c, d string) func (t Test) Method(a, b string) (c, d string) { return t(a, b) } type Interface interface{Method(a, b string) (c, d string)} `, } // Check that the right types are found, and the namers give the expected names. assertions := []struct { Package, Name string k types.Kind names []string }{ { Package: "a", Name: "Test", k: types.Alias, names: []string{"Test", "ATest", "test", "aTest", "a.Test"}, }, { Package: "b", Name: "Test", k: types.Map, names: []string{"Test", "BTest", "test", "bTest", "b.Test"}, }, { Package: "c", Name: "Test", k: types.Slice, names: []string{"Test", "CTest", "test", "cTest", "c.Test"}, }, { Package: "d", Name: "Test", k: types.Struct, names: []string{"Test", "DTest", "test", "dTest", "d.Test"}, }, { Package: "e", Name: "Test", k: types.Pointer, names: []string{"Test", "ETest", "test", "eTest", "e.Test"}, }, { Package: "f", Name: "Test", k: types.Slice, names: []string{"Test", "FTest", "test", "fTest", "f.Test"}, }, { Package: "g", Name: "Test", k: types.Func, names: []string{"Test", "GTest", "test", "gTest", "g.Test"}, }, { Package: "g", Name: "Interface", k: types.Interface, names: []string{"Interface", "GInterface", "interface", "gInterface", "g.Interface"}, }, { Package: "", Name: "string", k: types.Builtin, names: []string{"String", "String", "string", "string", "string"}, }, { Package: "", Name: "int", k: types.Builtin, names: []string{"Int", "Int", "int", "int", "int"}, }, { Package: "", Name: "struct{a int}", k: types.Struct, names: []string{"StructInt", "StructInt", "structInt", "structInt", "struct{a int}"}, }, { Package: "", Name: "struct{a a.Test; b b.Test}", k: types.Struct, names: []string{"StructTestTest", "StructATestBTest", "structTestTest", "structATestBTest", "struct{a a.Test; b b.Test}"}, }, { Package: "", Name: "map[int]string", k: types.Map, names: []string{"MapIntToString", "MapIntToString", "mapIntToString", "mapIntToString", "map[int]string"}, }, { Package: "", Name: "map[a.Test]b.Test", k: types.Map, names: []string{"MapTestToTest", "MapATestToBTest", "mapTestToTest", "mapATestToBTest", "map[a.Test]b.Test"}, }, { Package: "", Name: "[]string", k: types.Slice, names: []string{"SliceString", "SliceString", "sliceString", "sliceString", "[]string"}, }, { Package: "", Name: "[]a.Test", k: types.Slice, names: []string{"SliceTest", "SliceATest", "sliceTest", "sliceATest", "[]a.Test"}, }, { Package: "", Name: "*string", k: types.Pointer, names: []string{"PointerString", "PointerString", "pointerString", "pointerString", "*string"}, }, { Package: "", Name: "*a.Test", k: types.Pointer, names: []string{"PointerTest", "PointerATest", "pointerTest", "pointerATest", "*a.Test"}, }, } namers := []namer.Namer{ namer.NewPublicNamer(0), namer.NewPublicNamer(1), namer.NewPrivateNamer(0), namer.NewPrivateNamer(1), namer.NewRawNamer("", nil), } for nameIndex, namer := range namers { _, u, _ := construct(t, testFiles, namer) t.Logf("Found types:\n") for pkgName, pkg := range u { for typeName, cur := range pkg.Types { t.Logf("%q-%q: %s %s", pkgName, typeName, cur.Name, cur.Kind) } } t.Logf("\n\n") for _, item := range assertions { n := types.Name{Package: item.Package, Name: item.Name} thisType := u.Get(n) if thisType == nil { t.Errorf("type %s not found", n) continue } if e, a := item.k, thisType.Kind; e != a { t.Errorf("%v-%s: type kind wrong, wanted %v, got %v (%#v)", nameIndex, n, e, a, thisType) } if e, a := item.names[nameIndex], namer.Name(thisType); e != a { t.Errorf("%v-%s: Expected %q, got %q", nameIndex, n, e, a) } } // Also do some one-off checks gtest := u.Get(types.Name{"g", "Test"}) if e, a := 1, len(gtest.Methods); e != a { t.Errorf("expected %v but found %v methods: %#v", e, a, gtest) } iface := u.Get(types.Name{"g", "Interface"}) if e, a := 1, len(iface.Methods); e != a { t.Errorf("expected %v but found %v methods: %#v", e, a, iface) } } }