48f1f51ef9
* *: use loglevel to control what gets logged instead of output redirection This stops logrus from doing all the formatting just to discard it immediately afterwards. * logflags: replace default formatter of logrus The default formatter of logrus emits logs in two different formats depending on whether or not the output is going to a terminal. The output format for non-terminals is indented to be machine readable, but we mostly read logs ourselves and the excessive quoting makes that format unreadable. When outputting to terminals it uses ANSI escape codes unconditionally, without checking whether the terminal it is connected to actually supports colors. This commit replaces the default formatter with a much simpler formatter that always uses a more readable format, doesn't use colors and places the key-value pairs at the beginning of the line (which is a better match for how we use them). * cmd/dlv: add command line options to redirect logs Adds two options, --log-to-file and --log-to-fd, to redirect logs to a file or to a file descriptor. When one of those two options is specified the "API server listening at:" message will also be redirected to the specified file/file descriptor. This allows clients that want to use the "API server listening at:" message to do so even if they want to redirect the target's stdout to another file or device. Implements #1179, #1523
273 lines
8.8 KiB
Go
273 lines
8.8 KiB
Go
package gdbserial_test
|
|
|
|
import (
|
|
"flag"
|
|
"fmt"
|
|
"os"
|
|
"os/exec"
|
|
"path/filepath"
|
|
"runtime"
|
|
"testing"
|
|
|
|
"github.com/go-delve/delve/pkg/logflags"
|
|
"github.com/go-delve/delve/pkg/proc"
|
|
"github.com/go-delve/delve/pkg/proc/gdbserial"
|
|
protest "github.com/go-delve/delve/pkg/proc/test"
|
|
)
|
|
|
|
func TestMain(m *testing.M) {
|
|
var logConf string
|
|
flag.StringVar(&logConf, "log", "", "configures logging")
|
|
flag.Parse()
|
|
logflags.Setup(logConf != "", logConf, "")
|
|
os.Exit(protest.RunTestsWithFixtures(m))
|
|
}
|
|
|
|
func withTestRecording(name string, t testing.TB, fn func(p *gdbserial.Process, fixture protest.Fixture)) {
|
|
fixture := protest.BuildFixture(name, 0)
|
|
protest.MustHaveRecordingAllowed(t)
|
|
if path, _ := exec.LookPath("rr"); path == "" {
|
|
t.Skip("test skipped, rr not found")
|
|
}
|
|
t.Log("recording")
|
|
p, tracedir, err := gdbserial.RecordAndReplay([]string{fixture.Path}, ".", true, []string{})
|
|
if err != nil {
|
|
t.Fatal("Launch():", err)
|
|
}
|
|
t.Logf("replaying %q", tracedir)
|
|
|
|
defer func() {
|
|
p.Detach(true)
|
|
if tracedir != "" {
|
|
protest.SafeRemoveAll(tracedir)
|
|
}
|
|
}()
|
|
|
|
fn(p, fixture)
|
|
}
|
|
|
|
func assertNoError(err error, t testing.TB, s string) {
|
|
if err != nil {
|
|
_, file, line, _ := runtime.Caller(1)
|
|
fname := filepath.Base(file)
|
|
t.Fatalf("failed assertion at %s:%d: %s - %s\n", fname, line, s, err)
|
|
}
|
|
}
|
|
|
|
func setFunctionBreakpoint(p proc.Process, t *testing.T, fname string) *proc.Breakpoint {
|
|
addr, err := proc.FindFunctionLocation(p, fname, true, 0)
|
|
assertNoError(err, t, fmt.Sprintf("FindFunctionLocation(%s)", fname))
|
|
bp, err := p.SetBreakpoint(addr, proc.UserBreakpoint, nil)
|
|
assertNoError(err, t, fmt.Sprintf("SetBreakpoint(%#x) function %s", addr, fname))
|
|
return bp
|
|
}
|
|
|
|
func TestRestartAfterExit(t *testing.T) {
|
|
protest.AllowRecording(t)
|
|
withTestRecording("testnextprog", t, func(p *gdbserial.Process, fixture protest.Fixture) {
|
|
setFunctionBreakpoint(p, t, "main.main")
|
|
assertNoError(proc.Continue(p), t, "Continue")
|
|
loc, err := p.CurrentThread().Location()
|
|
assertNoError(err, t, "CurrentThread().Location()")
|
|
err = proc.Continue(p)
|
|
if _, isexited := err.(proc.ErrProcessExited); err == nil || !isexited {
|
|
t.Fatalf("program did not exit: %v", err)
|
|
}
|
|
|
|
assertNoError(p.Restart(""), t, "Restart")
|
|
|
|
assertNoError(proc.Continue(p), t, "Continue (after restart)")
|
|
loc2, err := p.CurrentThread().Location()
|
|
assertNoError(err, t, "CurrentThread().Location() (after restart)")
|
|
if loc2.Line != loc.Line {
|
|
t.Fatalf("stopped at %d (expected %d)", loc2.Line, loc.Line)
|
|
}
|
|
err = proc.Continue(p)
|
|
if _, isexited := err.(proc.ErrProcessExited); err == nil || !isexited {
|
|
t.Fatalf("program did not exit (after exit): %v", err)
|
|
}
|
|
})
|
|
}
|
|
|
|
func TestRestartDuringStop(t *testing.T) {
|
|
protest.AllowRecording(t)
|
|
withTestRecording("testnextprog", t, func(p *gdbserial.Process, fixture protest.Fixture) {
|
|
setFunctionBreakpoint(p, t, "main.main")
|
|
assertNoError(proc.Continue(p), t, "Continue")
|
|
loc, err := p.CurrentThread().Location()
|
|
assertNoError(err, t, "CurrentThread().Location()")
|
|
|
|
assertNoError(p.Restart(""), t, "Restart")
|
|
|
|
assertNoError(proc.Continue(p), t, "Continue (after restart)")
|
|
loc2, err := p.CurrentThread().Location()
|
|
assertNoError(err, t, "CurrentThread().Location() (after restart)")
|
|
if loc2.Line != loc.Line {
|
|
t.Fatalf("stopped at %d (expected %d)", loc2.Line, loc.Line)
|
|
}
|
|
err = proc.Continue(p)
|
|
if _, isexited := err.(proc.ErrProcessExited); err == nil || !isexited {
|
|
t.Fatalf("program did not exit (after exit): %v", err)
|
|
}
|
|
})
|
|
}
|
|
|
|
func setFileBreakpoint(p proc.Process, t *testing.T, file string, line int) *proc.Breakpoint {
|
|
addr, _, err := p.BinInfo().LineToPC(file, line)
|
|
assertNoError(err, t, "LineToPC")
|
|
bp, err := p.SetBreakpoint(addr, proc.UserBreakpoint, nil)
|
|
assertNoError(err, t, fmt.Sprintf("SetBreakpoint(%#x) - %s:%d", addr, file, line))
|
|
return bp
|
|
}
|
|
|
|
func TestReverseBreakpointCounts(t *testing.T) {
|
|
protest.AllowRecording(t)
|
|
withTestRecording("bpcountstest", t, func(p *gdbserial.Process, fixture protest.Fixture) {
|
|
endbp := setFileBreakpoint(p, t, fixture.Source, 28)
|
|
assertNoError(proc.Continue(p), t, "Continue()")
|
|
loc, _ := p.CurrentThread().Location()
|
|
if loc.PC != endbp.Addr {
|
|
t.Fatalf("did not reach end of main.main function: %s:%d (%#x)", loc.File, loc.Line, loc.PC)
|
|
}
|
|
|
|
p.ClearBreakpoint(endbp.Addr)
|
|
assertNoError(p.Direction(proc.Backward), t, "Switching to backward direction")
|
|
bp := setFileBreakpoint(p, t, fixture.Source, 12)
|
|
startbp := setFileBreakpoint(p, t, fixture.Source, 20)
|
|
|
|
countLoop:
|
|
for {
|
|
assertNoError(proc.Continue(p), t, "Continue()")
|
|
loc, _ := p.CurrentThread().Location()
|
|
switch loc.PC {
|
|
case startbp.Addr:
|
|
break countLoop
|
|
case bp.Addr:
|
|
// ok
|
|
default:
|
|
t.Fatalf("unexpected stop location %s:%d %#x", loc.File, loc.Line, loc.PC)
|
|
}
|
|
}
|
|
|
|
t.Logf("TotalHitCount: %d", bp.TotalHitCount)
|
|
if bp.TotalHitCount != 200 {
|
|
t.Fatalf("Wrong TotalHitCount for the breakpoint (%d)", bp.TotalHitCount)
|
|
}
|
|
|
|
if len(bp.HitCount) != 2 {
|
|
t.Fatalf("Wrong number of goroutines for breakpoint (%d)", len(bp.HitCount))
|
|
}
|
|
|
|
for _, v := range bp.HitCount {
|
|
if v != 100 {
|
|
t.Fatalf("Wrong HitCount for breakpoint (%v)", bp.HitCount)
|
|
}
|
|
}
|
|
})
|
|
}
|
|
|
|
func getPosition(p *gdbserial.Process, t *testing.T) (when string, loc *proc.Location) {
|
|
var err error
|
|
when, err = p.When()
|
|
assertNoError(err, t, "When")
|
|
loc, err = p.CurrentThread().Location()
|
|
assertNoError(err, t, "Location")
|
|
return
|
|
}
|
|
|
|
func TestCheckpoints(t *testing.T) {
|
|
protest.AllowRecording(t)
|
|
withTestRecording("continuetestprog", t, func(p *gdbserial.Process, fixture protest.Fixture) {
|
|
// Continues until start of main.main, record output of 'when'
|
|
bp := setFunctionBreakpoint(p, t, "main.main")
|
|
assertNoError(proc.Continue(p), t, "Continue")
|
|
when0, loc0 := getPosition(p, t)
|
|
t.Logf("when0: %q (%#x)", when0, loc0.PC)
|
|
|
|
// Create a checkpoint and check that the list of checkpoints reflects this
|
|
cpid, err := p.Checkpoint("checkpoint1")
|
|
if cpid != 1 {
|
|
t.Errorf("unexpected checkpoint id %d", cpid)
|
|
}
|
|
assertNoError(err, t, "Checkpoint")
|
|
checkpoints, err := p.Checkpoints()
|
|
assertNoError(err, t, "Checkpoints")
|
|
if len(checkpoints) != 1 {
|
|
t.Fatalf("wrong number of checkpoints %v (one expected)", checkpoints)
|
|
}
|
|
|
|
// Move forward with next, check that the output of 'when' changes
|
|
assertNoError(proc.Next(p), t, "First Next")
|
|
assertNoError(proc.Next(p), t, "Second Next")
|
|
when1, loc1 := getPosition(p, t)
|
|
t.Logf("when1: %q (%#x)", when1, loc1.PC)
|
|
if loc0.PC == loc1.PC {
|
|
t.Fatalf("next did not move process %#x", loc0.PC)
|
|
}
|
|
if when0 == when1 {
|
|
t.Fatalf("output of when did not change after next: %q", when0)
|
|
}
|
|
|
|
// Move back to checkpoint, check that the output of 'when' is the same as
|
|
// what it was when we set the breakpoint
|
|
p.Restart(fmt.Sprintf("c%d", cpid))
|
|
when2, loc2 := getPosition(p, t)
|
|
t.Logf("when2: %q (%#x)", when2, loc2.PC)
|
|
if loc2.PC != loc0.PC {
|
|
t.Fatalf("PC address mismatch %#x != %#x", loc0.PC, loc2.PC)
|
|
}
|
|
if when0 != when2 {
|
|
t.Fatalf("output of when mismatched %q != %q", when0, when2)
|
|
}
|
|
|
|
// Move forward with next again, check that the output of 'when' matches
|
|
assertNoError(proc.Next(p), t, "First Next")
|
|
assertNoError(proc.Next(p), t, "Second Next")
|
|
when3, loc3 := getPosition(p, t)
|
|
t.Logf("when3: %q (%#x)", when3, loc3.PC)
|
|
if loc3.PC != loc1.PC {
|
|
t.Fatalf("PC address mismatch %#x != %#x", loc1.PC, loc3.PC)
|
|
}
|
|
if when3 != when1 {
|
|
t.Fatalf("when output mismatch %q != %q", when1, when3)
|
|
}
|
|
|
|
// Delete breakpoint, move back to checkpoint then next twice and check
|
|
// output of 'when' again
|
|
_, err = p.ClearBreakpoint(bp.Addr)
|
|
assertNoError(err, t, "ClearBreakpoint")
|
|
p.Restart(fmt.Sprintf("c%d", cpid))
|
|
assertNoError(proc.Next(p), t, "First Next")
|
|
assertNoError(proc.Next(p), t, "Second Next")
|
|
when4, loc4 := getPosition(p, t)
|
|
t.Logf("when4: %q (%#x)", when4, loc4.PC)
|
|
if loc4.PC != loc1.PC {
|
|
t.Fatalf("PC address mismatch %#x != %#x", loc1.PC, loc4.PC)
|
|
}
|
|
if when4 != when1 {
|
|
t.Fatalf("when output mismatch %q != %q", when1, when4)
|
|
}
|
|
|
|
// Delete checkpoint, check that the list of checkpoints is updated
|
|
assertNoError(p.ClearCheckpoint(cpid), t, "ClearCheckpoint")
|
|
checkpoints, err = p.Checkpoints()
|
|
assertNoError(err, t, "Checkpoints")
|
|
if len(checkpoints) != 0 {
|
|
t.Fatalf("wrong number of checkpoints %v (zero expected)", checkpoints)
|
|
}
|
|
})
|
|
}
|
|
|
|
func TestIssue1376(t *testing.T) {
|
|
// Backward Continue should terminate when it encounters the start of the process.
|
|
protest.AllowRecording(t)
|
|
withTestRecording("continuetestprog", t, func(p *gdbserial.Process, fixture protest.Fixture) {
|
|
bp := setFunctionBreakpoint(p, t, "main.main")
|
|
assertNoError(proc.Continue(p), t, "Continue (forward)")
|
|
_, err := p.ClearBreakpoint(bp.Addr)
|
|
assertNoError(err, t, "ClearBreakpoint")
|
|
assertNoError(p.Direction(proc.Backward), t, "Switching to backward direction")
|
|
assertNoError(proc.Continue(p), t, "Continue (backward)")
|
|
})
|
|
}
|