github.com/lazyledger/lazyledger-core@v0.35.0-dev.0.20210613111200-4c651f053571/libs/log/tmfmt_logger_test.go (about)

     1  package log_test
     2  
     3  import (
     4  	"bytes"
     5  	"errors"
     6  	"io/ioutil"
     7  	"math"
     8  	"regexp"
     9  	"testing"
    10  
    11  	kitlog "github.com/go-kit/kit/log"
    12  	"github.com/stretchr/testify/assert"
    13  
    14  	"github.com/lazyledger/lazyledger-core/libs/log"
    15  )
    16  
    17  func TestTMFmtLogger(t *testing.T) {
    18  	t.Parallel()
    19  	buf := &bytes.Buffer{}
    20  	logger := log.NewTMFmtLogger(buf)
    21  
    22  	if err := logger.Log("hello", "world"); err != nil {
    23  		t.Fatal(err)
    24  	}
    25  	assert.Regexp(t, regexp.MustCompile(`N\[.+\] unknown \s+ hello=world\n$`), buf.String())
    26  
    27  	buf.Reset()
    28  	if err := logger.Log("a", 1, "err", errors.New("error")); err != nil {
    29  		t.Fatal(err)
    30  	}
    31  	assert.Regexp(t, regexp.MustCompile(`N\[.+\] unknown \s+ a=1 err=error\n$`), buf.String())
    32  
    33  	buf.Reset()
    34  	if err := logger.Log("std_map", map[int]int{1: 2}, "my_map", mymap{0: 0}); err != nil {
    35  		t.Fatal(err)
    36  	}
    37  	assert.Regexp(t, regexp.MustCompile(`N\[.+\] unknown \s+ std_map=map\[1:2\] my_map=special_behavior\n$`), buf.String())
    38  
    39  	buf.Reset()
    40  	if err := logger.Log("level", "error"); err != nil {
    41  		t.Fatal(err)
    42  	}
    43  	assert.Regexp(t, regexp.MustCompile(`E\[.+\] unknown \s+\n$`), buf.String())
    44  
    45  	buf.Reset()
    46  	if err := logger.Log("_msg", "Hello"); err != nil {
    47  		t.Fatal(err)
    48  	}
    49  	assert.Regexp(t, regexp.MustCompile(`N\[.+\] Hello \s+\n$`), buf.String())
    50  
    51  	buf.Reset()
    52  	if err := logger.Log("module", "main", "module", "crypto", "module", "wire"); err != nil {
    53  		t.Fatal(err)
    54  	}
    55  	assert.Regexp(t, regexp.MustCompile(`N\[.+\] unknown \s+module=wire\s+\n$`), buf.String())
    56  }
    57  
    58  func BenchmarkTMFmtLoggerSimple(b *testing.B) {
    59  	benchmarkRunnerKitlog(b, log.NewTMFmtLogger(ioutil.Discard), baseMessage)
    60  }
    61  
    62  func BenchmarkTMFmtLoggerContextual(b *testing.B) {
    63  	benchmarkRunnerKitlog(b, log.NewTMFmtLogger(ioutil.Discard), withMessage)
    64  }
    65  
    66  func TestTMFmtLoggerConcurrency(t *testing.T) {
    67  	t.Parallel()
    68  	testConcurrency(t, log.NewTMFmtLogger(ioutil.Discard), 10000)
    69  }
    70  
    71  func benchmarkRunnerKitlog(b *testing.B, logger kitlog.Logger, f func(kitlog.Logger)) {
    72  	lc := kitlog.With(logger, "common_key", "common_value")
    73  	b.ReportAllocs()
    74  	b.ResetTimer()
    75  	for i := 0; i < b.N; i++ {
    76  		f(lc)
    77  	}
    78  }
    79  
    80  //nolint: errcheck // ignore errors
    81  var (
    82  	baseMessage = func(logger kitlog.Logger) { logger.Log("foo_key", "foo_value") }
    83  	withMessage = func(logger kitlog.Logger) { kitlog.With(logger, "a", "b").Log("d", "f") }
    84  )
    85  
    86  // These test are designed to be run with the race detector.
    87  
    88  func testConcurrency(t *testing.T, logger kitlog.Logger, total int) {
    89  	n := int(math.Sqrt(float64(total)))
    90  	share := total / n
    91  
    92  	errC := make(chan error, n)
    93  
    94  	for i := 0; i < n; i++ {
    95  		go func() {
    96  			errC <- spam(logger, share)
    97  		}()
    98  	}
    99  
   100  	for i := 0; i < n; i++ {
   101  		err := <-errC
   102  		if err != nil {
   103  			t.Fatalf("concurrent logging error: %v", err)
   104  		}
   105  	}
   106  }
   107  
   108  func spam(logger kitlog.Logger, count int) error {
   109  	for i := 0; i < count; i++ {
   110  		err := logger.Log("key", i)
   111  		if err != nil {
   112  			return err
   113  		}
   114  	}
   115  	return nil
   116  }
   117  
   118  type mymap map[int]int
   119  
   120  func (m mymap) String() string { return "special_behavior" }