1// Copyright (c) 2016 Uber Technologies, Inc.
2//
3// Permission is hereby granted, free of charge, to any person obtaining a copy
4// of this software and associated documentation files (the "Software"), to deal
5// in the Software without restriction, including without limitation the rights
6// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
7// copies of the Software, and to permit persons to whom the Software is
8// furnished to do so, subject to the following conditions:
9//
10// The above copyright notice and this permission notice shall be included in
11// all copies or substantial portions of the Software.
12//
13// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
14// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
15// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
16// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
17// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
18// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
19// THE SOFTWARE.
20
21package zap
22
23import (
24	"strings"
25	"testing"
26
27	"github.com/stretchr/testify/assert"
28	"github.com/stretchr/testify/require"
29)
30
31func TestTakeStacktrace(t *testing.T) {
32	trace := takeStacktrace()
33	lines := strings.Split(trace, "\n")
34	require.True(t, len(lines) > 0, "Expected stacktrace to have at least one frame.")
35	assert.Contains(
36		t,
37		lines[0],
38		"testing.",
39		"Expected stacktrace to start with the test runner (zap frames are filtered out) %s.", lines[0],
40	)
41}
42
43func TestIsZapFrame(t *testing.T) {
44	zapFrames := []string{
45		"go.uber.org/zap.Stack",
46		"go.uber.org/zap.(*SugaredLogger).log",
47		"go.uber.org/zap/zapcore.(ArrayMarshalerFunc).MarshalLogArray",
48		"github.com/uber/tchannel-go/vendor/go.uber.org/zap.Stack",
49		"github.com/uber/tchannel-go/vendor/go.uber.org/zap.(*SugaredLogger).log",
50		"github.com/uber/tchannel-go/vendor/go.uber.org/zap/zapcore.(ArrayMarshalerFunc).MarshalLogArray",
51	}
52	nonZapFrames := []string{
53		"github.com/uber/tchannel-go.NewChannel",
54		"go.uber.org/not-zap.New",
55		"go.uber.org/zapext.ctx",
56		"go.uber.org/zap_ext/ctx.New",
57	}
58
59	t.Run("zap frames", func(t *testing.T) {
60		for _, f := range zapFrames {
61			require.True(t, isZapFrame(f), f)
62		}
63	})
64	t.Run("non-zap frames", func(t *testing.T) {
65		for _, f := range nonZapFrames {
66			require.False(t, isZapFrame(f), f)
67		}
68	})
69}
70
71func BenchmarkTakeStacktrace(b *testing.B) {
72	for i := 0; i < b.N; i++ {
73		takeStacktrace()
74	}
75}
76