File: tlogger.go

package info (click to toggle)
golang-github-cactus-mlog 1.0.10-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 272 kB
  • sloc: makefile: 2
file content (41 lines) | stat: -rw-r--r-- 1,219 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
// Copyright (c) 2012-2016 Eli Janssen
// Use of this source code is governed by an MIT-style
// license that can be found in the LICENSE file.
//
// some parts from: https://brandur.org/t-parallel

package mlog

import (
	"fmt"
	"testing"
)

// TestoingLogWriter is an adapter between mlog and Go's testing package,
// which lets us send all output to `t.Log` so that it's correctly
// collated with the test that emitted it. This helps especially when
// using parallel testing where output would otherwise be interleaved
// and make debugging extremely difficult.
type TestingLogWriter struct {
	tb testing.TB
}

func (lw *TestingLogWriter) Write(p []byte) (n int, err error) {
	// Unfortunately, even with this call to `t.Helper()` there's no
	// way to correctly attribute the log location to where it's
	// actually emitted in our code (everything shows up under
	// `logger.go`). A good explanation of this problem and possible
	// future solutions here:
	//
	// https://github.com/neilotoole/slogt#deficiency
	if lw == nil {
		return 0, nil
	}
	if lw.tb == nil {
		fmt.Println("got nil testing.TB")
		return 0, fmt.Errorf("got a nil testing.TBf")
	}
	lw.tb.Helper()
	lw.tb.Logf(string(p))
	return len(p), nil
}