package servicetest import ( "fmt" "sort" "strings" "testing" "github.com/derekparker/delve/proc" "github.com/derekparker/delve/service/api" protest "github.com/derekparker/delve/proc/test" ) type varTest struct { name string value string setTo string varType string err error } func matchStringOrPrefix(output, target string) bool { if strings.HasSuffix(target, "…") { prefix := target[:len(target)-len("…")] b := strings.HasPrefix(output, prefix) return b } else { return output == target } } func assertVariable(t *testing.T, variable *proc.Variable, expected varTest) { if variable.Name != expected.name { t.Fatalf("Expected %s got %s\n", expected.name, variable.Name) } cv := api.ConvertVar(variable) if cv.Type != expected.varType { t.Fatalf("Expected %s got %s (for variable %s)\n", expected.varType, cv.Type, expected.name) } if ss := cv.SinglelineString(); !matchStringOrPrefix(ss, expected.value) { t.Fatalf("Expected %#v got %#v (for variable %s)\n", expected.value, ss, expected.name) } } func evalVariable(p *proc.Process, symbol string) (*proc.Variable, error) { scope, err := p.CurrentThread.Scope() if err != nil { return nil, err } return scope.EvalVariable(symbol) } func (tc *varTest) settable() bool { return tc.setTo != "" } func (tc *varTest) afterSet() varTest { r := *tc r.value = r.setTo return r } func setVariable(p *proc.Process, symbol, value string) error { scope, err := p.CurrentThread.Scope() if err != nil { return err } return scope.SetVariable(symbol, value) } const varTestBreakpointLineNumber = 59 func withTestProcess(name string, t *testing.T, fn func(p *proc.Process, fixture protest.Fixture)) { fixture := protest.BuildFixture(name) p, err := proc.Launch([]string{fixture.Path}) if err != nil { t.Fatal("Launch():", err) } defer func() { p.Halt() p.Kill() }() fn(p, fixture) } func TestVariableEvaluation(t *testing.T) { testcases := []varTest{ {"a1", "\"foofoofoofoofoofoo\"", "", "struct string", nil}, {"a11", "[3]main.FooBar [{Baz: 1, Bur: \"a\"},{Baz: 2, Bur: \"b\"},{Baz: 3, Bur: \"c\"}]", "", "[3]main.FooBar", nil}, {"a12", "[]main.FooBar len: 2, cap: 2, [{Baz: 4, Bur: \"d\"},{Baz: 5, Bur: \"e\"}]", "", "struct []main.FooBar", nil}, {"a13", "[]*main.FooBar len: 3, cap: 3, [*{Baz: 6, Bur: \"f\"},*{Baz: 7, Bur: \"g\"},*{Baz: 8, Bur: \"h\"}]", "", "struct []*main.FooBar", nil}, {"a2", "6", "10", "int", nil}, {"a3", "7.23", "3.1", "float64", nil}, {"a4", "[2]int [1,2]", "", "[2]int", nil}, {"a5", "[]int len: 5, cap: 5, [1,2,3,4,5]", "", "struct []int", nil}, {"a6", "main.FooBar {Baz: 8, Bur: \"word\"}", "", "main.FooBar", nil}, {"a7", "*main.FooBar {Baz: 5, Bur: \"strum\"}", "", "*main.FooBar", nil}, {"a8", "main.FooBar2 {Bur: 10, Baz: \"feh\"}", "", "main.FooBar2", nil}, {"a9", "*main.FooBar nil", "", "*main.FooBar", nil}, {"baz", "\"bazburzum\"", "", "struct string", nil}, {"neg", "-1", "-20", "int", nil}, {"f32", "1.2", "1.1", "float32", nil}, {"c64", "(1 + 2i)", "(4 + 5i)", "complex64", nil}, {"c128", "(2 + 3i)", "(6.3 + 7i)", "complex128", nil}, {"a6.Baz", "8", "20", "int", nil}, {"a7.Baz", "5", "25", "int", nil}, {"a8.Baz", "\"feh\"", "", "struct string", nil}, {"a9.Baz", "nil", "", "int", fmt.Errorf("a9 is nil")}, {"a9.NonExistent", "nil", "", "int", fmt.Errorf("a9 has no member NonExistent")}, {"a8", "main.FooBar2 {Bur: 10, Baz: \"feh\"}", "", "main.FooBar2", nil}, // reread variable after member {"i32", "[2]int32 [1,2]", "", "[2]int32", nil}, {"b1", "true", "false", "bool", nil}, {"b2", "false", "true", "bool", nil}, {"i8", "1", "2", "int8", nil}, {"u16", "65535", "0", "uint16", nil}, {"u32", "4294967295", "1", "uint32", nil}, {"u64", "18446744073709551615", "2", "uint64", nil}, {"u8", "255", "3", "uint8", nil}, {"up", "5", "4", "uintptr", nil}, {"f", "main.barfoo", "", "func()", nil}, {"ba", "[]int len: 200, cap: 200, [0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,...+136 more]", "", "struct []int", nil}, {"ms", "main.Nest {Level: 0, Nest: *main.Nest {Level: 1, Nest: *(*main.Nest)(…", "", "main.Nest", nil}, {"ms.Nest.Nest", "*main.Nest {Level: 2, Nest: *main.Nest {Level: 3, Nest: *(*main.Nest)(…", "", "*main.Nest", nil}, {"ms.Nest.Nest.Nest.Nest.Nest", "*main.Nest nil", "", "*main.Nest", nil}, {"ms.Nest.Nest.Nest.Nest.Nest.Nest", "", "", "*main.Nest", fmt.Errorf("ms.Nest.Nest.Nest.Nest.Nest is nil")}, {"main.p1", "10", "12", "int", nil}, {"p1", "10", "13", "int", nil}, {"NonExistent", "", "", "", fmt.Errorf("could not find symbol value for NonExistent")}, } withTestProcess("testvariables", t, func(p *proc.Process, fixture protest.Fixture) { err := p.Continue() assertNoError(err, t, "Continue() returned an error") for _, tc := range testcases { variable, err := evalVariable(p, tc.name) if tc.err == nil { assertNoError(err, t, "EvalVariable() returned an error") assertVariable(t, variable, tc) } else { if err == nil { t.Fatalf("Expected error %s, got no error: %s\n", tc.err.Error(), api.ConvertVar(variable).SinglelineString()) } if tc.err.Error() != err.Error() { t.Fatalf("Unexpected error. Expected %s got %s", tc.err.Error(), err.Error()) } } if tc.settable() { assertNoError(setVariable(p, tc.name, tc.setTo), t, "SetVariable()") variable, err = evalVariable(p, tc.name) assertNoError(err, t, "EvalVariable()") assertVariable(t, variable, tc.afterSet()) assertNoError(setVariable(p, tc.name, tc.value), t, "SetVariable()") variable, err := evalVariable(p, tc.name) assertNoError(err, t, "EvalVariable()") assertVariable(t, variable, tc) } } }) } func TestMultilineVariableEvaluation(t *testing.T) { testcases := []varTest{ {"a1", "\"foofoofoofoofoofoo\"", "", "struct string", nil}, {"a11", `[3]main.FooBar [ {Baz: 1, Bur: "a"}, {Baz: 2, Bur: "b"}, {Baz: 3, Bur: "c"}, ]`, "", "[3]main.FooBar", nil}, {"a12", `[]main.FooBar len: 2, cap: 2, [ {Baz: 4, Bur: "d"}, {Baz: 5, Bur: "e"}, ]`, "", "struct []main.FooBar", nil}, {"a13", `[]*main.FooBar len: 3, cap: 3, [ *{Baz: 6, Bur: "f"}, *{Baz: 7, Bur: "g"}, *{Baz: 8, Bur: "h"}, ]`, "", "struct []*main.FooBar", nil}, {"a2", "6", "10", "int", nil}, {"a4", "[2]int [1,2]", "", "[2]int", nil}, {"a5", "[]int len: 5, cap: 5, [1,2,3,4,5]", "", "struct []int", nil}, {"a6", "main.FooBar {Baz: 8, Bur: \"word\"}", "", "main.FooBar", nil}, {"a7", "*main.FooBar {Baz: 5, Bur: \"strum\"}", "", "*main.FooBar", nil}, {"a8", "main.FooBar2 {Bur: 10, Baz: \"feh\"}", "", "main.FooBar2", nil}, {"a9", "*main.FooBar nil", "", "*main.FooBar", nil}, {"a8", "main.FooBar2 {Bur: 10, Baz: \"feh\"}", "", "main.FooBar2", nil}, // reread variable after member {"i32", "[2]int32 [1,2]", "", "[2]int32", nil}, {"ba", "[]int len: 200, cap: 200, [0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,...+136 more]", "", "struct []int", nil}, {"ms", `main.Nest { Level: 0, Nest: *main.Nest { Level: 1, Nest: *(*main.Nest)(…`, "", "main.Nest", nil}, } withTestProcess("testvariables", t, func(p *proc.Process, fixture protest.Fixture) { err := p.Continue() assertNoError(err, t, "Continue() returned an error") for _, tc := range testcases { variable, err := evalVariable(p, tc.name) assertNoError(err, t, "EvalVariable() returned an error") if ms := api.ConvertVar(variable).MultilineString(""); !matchStringOrPrefix(ms, tc.value) { t.Fatalf("Expected %s got %s (variable %s)\n", tc.value, ms, variable.Name) } } }) } type varArray []*proc.Variable // Len is part of sort.Interface. func (s varArray) Len() int { return len(s) } // Swap is part of sort.Interface. func (s varArray) Swap(i, j int) { s[i], s[j] = s[j], s[i] } // Less is part of sort.Interface. It is implemented by calling the "by" closure in the sorter. func (s varArray) Less(i, j int) bool { return s[i].Name < s[j].Name } func TestLocalVariables(t *testing.T) { testcases := []struct { fn func(*proc.EvalScope) ([]*proc.Variable, error) output []varTest }{ {(*proc.EvalScope).LocalVariables, []varTest{ {"a1", "\"foofoofoofoofoofoo\"", "", "struct string", nil}, {"a10", "\"ofo\"", "", "struct string", nil}, {"a11", "[3]main.FooBar [{Baz: 1, Bur: \"a\"},{Baz: 2, Bur: \"b\"},{Baz: 3, Bur: \"c\"}]", "", "[3]main.FooBar", nil}, {"a12", "[]main.FooBar len: 2, cap: 2, [{Baz: 4, Bur: \"d\"},{Baz: 5, Bur: \"e\"}]", "", "struct []main.FooBar", nil}, {"a13", "[]*main.FooBar len: 3, cap: 3, [*{Baz: 6, Bur: \"f\"},*{Baz: 7, Bur: \"g\"},*{Baz: 8, Bur: \"h\"}]", "", "struct []*main.FooBar", nil}, {"a2", "6", "", "int", nil}, {"a3", "7.23", "", "float64", nil}, {"a4", "[2]int [1,2]", "", "[2]int", nil}, {"a5", "[]int len: 5, cap: 5, [1,2,3,4,5]", "", "struct []int", nil}, {"a6", "main.FooBar {Baz: 8, Bur: \"word\"}", "", "main.FooBar", nil}, {"a7", "*main.FooBar {Baz: 5, Bur: \"strum\"}", "", "*main.FooBar", nil}, {"a8", "main.FooBar2 {Bur: 10, Baz: \"feh\"}", "", "main.FooBar2", nil}, {"a9", "*main.FooBar nil", "", "*main.FooBar", nil}, {"b1", "true", "", "bool", nil}, {"b2", "false", "", "bool", nil}, {"ba", "[]int len: 200, cap: 200, [0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,...+136 more]", "", "struct []int", nil}, {"c128", "(2 + 3i)", "", "complex128", nil}, {"c64", "(1 + 2i)", "", "complex64", nil}, {"f", "main.barfoo", "", "func()", nil}, {"f32", "1.2", "", "float32", nil}, {"i32", "[2]int32 [1,2]", "", "[2]int32", nil}, {"i8", "1", "", "int8", nil}, {"ms", "main.Nest {Level: 0, Nest: *main.Nest {Level: 1, Nest: *(*main.Nest)…", "", "main.Nest", nil}, {"neg", "-1", "", "int", nil}, {"u16", "65535", "", "uint16", nil}, {"u32", "4294967295", "", "uint32", nil}, {"u64", "18446744073709551615", "", "uint64", nil}, {"u8", "255", "", "uint8", nil}, {"up", "5", "", "uintptr", nil}}}, {(*proc.EvalScope).FunctionArguments, []varTest{ {"bar", "main.FooBar {Baz: 10, Bur: \"lorem\"}", "", "main.FooBar", nil}, {"baz", "\"bazburzum\"", "", "struct string", nil}}}, } withTestProcess("testvariables", t, func(p *proc.Process, fixture protest.Fixture) { err := p.Continue() assertNoError(err, t, "Continue() returned an error") for _, tc := range testcases { scope, err := p.CurrentThread.Scope() assertNoError(err, t, "AsScope()") vars, err := tc.fn(scope) assertNoError(err, t, "LocalVariables() returned an error") sort.Sort(varArray(vars)) if len(tc.output) != len(vars) { t.Fatalf("Invalid variable count. Expected %d got %d.", len(tc.output), len(vars)) } for i, variable := range vars { assertVariable(t, variable, tc.output[i]) } } }) } func TestEmbeddedStruct(t *testing.T) { withTestProcess("testvariables4", t, func(p *proc.Process, fixture protest.Fixture) { testcases := []varTest{ {"b.val", "-314", "", "int", nil}, {"b.A.val", "-314", "", "int", nil}, {"b.a.val", "42", "", "int", nil}, {"b.ptr.val", "1337", "", "int", nil}, {"b.C.s", "\"hello\"", "", "struct string", nil}, {"b.s", "\"hello\"", "", "struct string", nil}, } assertNoError(p.Continue(), t, "Continue()") for _, tc := range testcases { variable, err := evalVariable(p, tc.name) if tc.err == nil { assertNoError(err, t, "EvalVariable() returned an error") assertVariable(t, variable, tc) } else { if tc.err.Error() != err.Error() { t.Fatalf("Unexpected error. Expected %s got %s", tc.err.Error(), err.Error()) } } } }) } func TestComplexSetting(t *testing.T) { withTestProcess("testvariables", t, func(p *proc.Process, fixture protest.Fixture) { err := p.Continue() assertNoError(err, t, "Continue() returned an error") h := func(setExpr, value string) { assertNoError(setVariable(p, "c128", setExpr), t, "SetVariable()") variable, err := evalVariable(p, "c128") assertNoError(err, t, "EvalVariable()") if s := api.ConvertVar(variable).SinglelineString(); s != value { t.Fatalf("Wrong value of c128: \"%s\", expected \"%s\" after setting it to \"%s\"", s, value, setExpr) } } h("3.2i", "(0 + 3.2i)") h("1.1", "(1.1 + 0i)") h("1 + 3.3i", "(1 + 3.3i)") h("complex128(1.2, 3.4)", "(1.2 + 3.4i)") }) }