/* Copyright 2015 The Kubernetes 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 gengo import ( "reflect" "strings" "testing" "github.com/google/go-cmp/cmp" ) func TestExtractCommentTags(t *testing.T) { commentLines := []string{ "Human comment that is ignored.", "+foo=value1", "+bar", "+foo=value2", "+baz=qux,zrb=true", "+bip=\"value3\"", } a := ExtractCommentTags("+", commentLines) e := map[string][]string{ "foo": {"value1", "value2"}, "bar": {""}, "baz": {"qux,zrb=true"}, "bip": {`"value3"`}, } if !reflect.DeepEqual(e, a) { t.Errorf("Wrong result:\n%v", cmp.Diff(e, a)) } } func TestExtractSingleBoolCommentTag(t *testing.T) { commentLines := []string{ "Human comment that is ignored.", "+TRUE=true", "+FALSE=false", "+MULTI=true", "+MULTI=false", "+MULTI=multi", "+NOTBOOL=blue", "+EMPTY", } testCases := []struct { key string def bool exp bool err string // if set, ignore exp. }{ {"TRUE", false, true, ""}, {"FALSE", true, false, ""}, {"MULTI", false, true, ""}, {"NOTBOOL", false, true, "is not boolean"}, {"EMPTY", false, true, "is not boolean"}, {"ABSENT", true, true, ""}, {"ABSENT", false, false, ""}, } for i, tc := range testCases { v, err := ExtractSingleBoolCommentTag("+", tc.key, tc.def, commentLines) if err != nil && tc.err == "" { t.Errorf("[%d]: unexpected failure: %v", i, err) } else if err == nil && tc.err != "" { t.Errorf("[%d]: expected failure: %v", i, tc.err) } else if err != nil { if !strings.Contains(err.Error(), tc.err) { t.Errorf("[%d]: unexpected error: expected %q, got %q", i, tc.err, err) } } else if v != tc.exp { t.Errorf("[%d]: unexpected value: expected %t, got %t", i, tc.exp, v) } } } func TestExtractExtendedCommentTags(t *testing.T) { mktags := func(t ...Tag) []Tag { return t } mkstrs := func(s ...string) []string { return s } cases := []struct { name string comments []string prefixes []string expect map[string][]Tag }{{ name: "no args", comments: []string{ "Human comment that is ignored", "+simpleNoVal", "+simpleWithVal=val", "+duplicateNoVal", "+duplicateNoVal", "+duplicateWithVal=val1", "+duplicateWithVal=val2", }, expect: map[string][]Tag{ "simpleNoVal": mktags(Tag{"simpleNoVal", nil, ""}), "simpleWithVal": mktags(Tag{"simpleWithVal", nil, "val"}), "duplicateNoVal": mktags( Tag{"duplicateNoVal", nil, ""}, Tag{"duplicateNoVal", nil, ""}), "duplicateWithVal": mktags( Tag{"duplicateWithVal", nil, "val1"}, Tag{"duplicateWithVal", nil, "val2"}), }, }, { name: "empty parens", comments: []string{ "Human comment that is ignored", "+simpleNoVal()", "+simpleWithVal()=val", "+duplicateNoVal()", "+duplicateNoVal()", "+duplicateWithVal()=val1", "+duplicateWithVal()=val2", }, expect: map[string][]Tag{ "simpleNoVal": mktags(Tag{"simpleNoVal", nil, ""}), "simpleWithVal": mktags(Tag{"simpleWithVal", nil, "val"}), "duplicateNoVal": mktags( Tag{"duplicateNoVal", nil, ""}, Tag{"duplicateNoVal", nil, ""}), "duplicateWithVal": mktags( Tag{"duplicateWithVal", nil, "val1"}, Tag{"duplicateWithVal", nil, "val2"}), }, }, { name: "mixed no args and empty parens", comments: []string{ "Human comment that is ignored", "+noVal", "+withVal=val1", "+noVal()", "+withVal()=val2", }, expect: map[string][]Tag{ "noVal": mktags( Tag{"noVal", nil, ""}, Tag{"noVal", nil, ""}), "withVal": mktags( Tag{"withVal", nil, "val1"}, Tag{"withVal", nil, "val2"}), }, }, { name: "with args", comments: []string{ "Human comment that is ignored", "+simpleNoVal(arg)", "+simpleWithVal(arg)=val", "+duplicateNoVal(arg1)", "+duplicateNoVal(arg2)", "+duplicateWithVal(arg1)=val1", "+duplicateWithVal(arg2)=val2", }, expect: map[string][]Tag{ "simpleNoVal": mktags(Tag{"simpleNoVal", mkstrs("arg"), ""}), "simpleWithVal": mktags(Tag{"simpleWithVal", mkstrs("arg"), "val"}), "duplicateNoVal": mktags( Tag{"duplicateNoVal", mkstrs("arg1"), ""}, Tag{"duplicateNoVal", mkstrs("arg2"), ""}), "duplicateWithVal": mktags( Tag{"duplicateWithVal", mkstrs("arg1"), "val1"}, Tag{"duplicateWithVal", mkstrs("arg2"), "val2"}), }, }, { name: "mixed no args and empty parens", comments: []string{ "Human comment that is ignored", "+noVal", "+withVal=val1", "+noVal(arg)", "+withVal(arg)=val2", }, expect: map[string][]Tag{ "noVal": mktags( Tag{"noVal", nil, ""}, Tag{"noVal", mkstrs("arg"), ""}), "withVal": mktags( Tag{"withVal", nil, "val1"}, Tag{"withVal", mkstrs("arg"), "val2"}), }, }, { name: "prefixes", comments: []string{ "Human comment that is ignored", "+pfx1Foo", "+pfx2Foo=val1", "+pfx3Bar", "+pfx4Bar=val", "+pfx1Foo(arg)", "+pfx2Foo(arg)=val2", "+pfx3Bar(arg)", "+pfx4Bar(arg)=val", }, prefixes: []string{"pfx1Foo", "pfx2Foo"}, expect: map[string][]Tag{ "pfx1Foo": mktags( Tag{"pfx1Foo", nil, ""}, Tag{"pfx1Foo", mkstrs("arg"), ""}), "pfx2Foo": mktags( Tag{"pfx2Foo", nil, "val1"}, Tag{"pfx2Foo", mkstrs("arg"), "val2"}), }, }} for _, tc := range cases { result, _ := ExtractFunctionStyleCommentTags("+", tc.prefixes, tc.comments) if !reflect.DeepEqual(result, tc.expect) { t.Errorf("case %q: wrong result:\n%v", tc.name, cmp.Diff(tc.expect, result)) } } } func TestParseTagKey(t *testing.T) { mkss := func(s ...string) []string { return s } cases := []struct { input string expectKey string expectArgs []string err bool }{ {"simple", "simple", nil, false}, {"parens()", "parens", nil, false}, {"withArgLower(arg)", "withArgLower", mkss("arg"), false}, {"withArgUpper(ARG)", "withArgUpper", mkss("ARG"), false}, {"withArgMixed(ArG)", "withArgMixed", mkss("ArG"), false}, {"withArgs(arg1, arg2)", "", nil, true}, {"trailingParen(arg))", "", nil, true}, {"trailingSpace(arg) ", "", nil, true}, {"argWithDash(arg-name) ", "", nil, true}, {"argWithUnder(arg_name) ", "", nil, true}, } for _, tc := range cases { key, args, err := parseTagKey(tc.input, nil) if err != nil && tc.err == false { t.Errorf("[%q]: expected success, got: %v", tc.input, err) continue } if err == nil { if tc.err == true { t.Errorf("[%q]: expected failure, got: %v(%v)", tc.input, key, args) continue } if key != tc.expectKey { t.Errorf("[%q]\nexpected key: %q, got: %q", tc.input, tc.expectKey, key) } if len(args) != len(tc.expectArgs) { t.Errorf("[%q]: expected %d args, got: %q", tc.input, len(tc.expectArgs), args) continue } for i := range tc.expectArgs { if want, got := tc.expectArgs[i], args[i]; got != want { t.Errorf("[%q]\nexpected %q, got %q", tc.input, want, got) } } } } } func TestParseTagKeyWithTagNames(t *testing.T) { mkss := func(s ...string) []string { return s } cases := []struct { input string expectKey string expectArgs []string }{ {"name", "name", nil}, {"name()", "name", nil}, {"name(arg)", "name", mkss("arg")}, {"nameNoMatch", "", nil}, {"nameNoMatch()", "", nil}, {"nameNoMatch(arg)", "", nil}, } for _, tc := range cases { key, args, err := parseTagKey(tc.input, []string{"name"}) if err != nil { t.Errorf("[%q]: expected success, got: %v", tc.input, err) continue } if key != tc.expectKey { t.Errorf("[%q]\nexpected key: %q, got: %q", tc.input, tc.expectKey, key) } if len(args) != len(tc.expectArgs) { t.Errorf("[%q]: expected %d args, got: %q", tc.input, len(tc.expectArgs), args) continue } for i := range tc.expectArgs { if want, got := tc.expectArgs[i], args[i]; got != want { t.Errorf("[%q]\nexpected %q, got %q", tc.input, want, got) } } } } func TestParseTagArgs(t *testing.T) { mkss := func(s ...string) []string { return s } cases := []struct { input string expect []string err bool }{ {")", nil, false}, {"lower)", mkss("lower"), false}, {"CAPITAL)", mkss("CAPITAL"), false}, {"MiXeD)", mkss("MiXeD"), false}, {"mIxEd)", mkss("mIxEd"), false}, {"_under)", nil, true}, {"has space", nil, true}, {"has-dash", nil, true}, {`"hasQuotes"`, nil, true}, {"multiple, args)", nil, true}, {"noClosingParen", nil, true}, {"extraParen))", nil, true}, {"trailingSpace) ", nil, true}, } for _, tc := range cases { ret, err := parseTagArgs(tc.input) if err != nil && tc.err == false { t.Errorf("[%q]: expected success, got: %v", tc.input, err) continue } if err == nil { if tc.err == true { t.Errorf("[%q]: expected failure, got: %q", tc.input, ret) continue } if len(ret) != len(tc.expect) { t.Errorf("[%q]: expected %d results, got: %q", tc.input, len(tc.expect), ret) continue } for i := range tc.expect { if want, got := tc.expect[i], ret[i]; got != want { t.Errorf("[%q]\nexpected %q, got %q", tc.input, want, got) } } } } }