-
Notifications
You must be signed in to change notification settings - Fork 12
/
diag1log_tests.go
188 lines (174 loc) · 6.47 KB
/
diag1log_tests.go
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
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
// Copyright (c) 2021 Palantir Technologies. All rights reserved.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
package wrapped1logtests
import (
"bytes"
"encoding/json"
"io"
"testing"
"github.com/palantir/pkg/objmatcher"
"github.com/palantir/pkg/safejson"
"github.com/palantir/pkg/safelong"
"github.com/palantir/witchcraft-go-logging/conjure/witchcraft/api/logging"
"github.com/palantir/witchcraft-go-logging/wlog/diaglog/diag1log"
"github.com/stretchr/testify/assert"
"github.com/stretchr/testify/require"
)
type Diag1TestCase struct {
Name string
Diagnostic logging.Diagnostic
UnsafeParams map[string]interface{}
JSONMatcher objmatcher.MapMatcher
}
func Diag1TestCases(entityName, entityVersion string) []Diag1TestCase {
return []Diag1TestCase{
{
Name: "generic diagnostic log entry",
Diagnostic: logging.NewDiagnosticFromGeneric(logging.GenericDiagnostic{
DiagnosticType: "DIAG_TYPE",
Value: map[string]string{
"testKey": "test_value",
},
}),
UnsafeParams: map[string]interface{}{
"Password": "HelloWorld!",
},
JSONMatcher: map[string]objmatcher.Matcher{
"type": objmatcher.NewEqualsMatcher("wrapped.1"),
"entityName": objmatcher.NewEqualsMatcher(entityName),
"entityVersion": objmatcher.NewEqualsMatcher(entityVersion),
"payload": objmatcher.MapMatcher(map[string]objmatcher.Matcher{
"type": objmatcher.NewEqualsMatcher("diagnosticLogV1"),
"diagnosticLogV1": objmatcher.MapMatcher(map[string]objmatcher.Matcher{
"type": objmatcher.NewEqualsMatcher("diagnostic.1"),
"time": objmatcher.NewRegExpMatcher(".+"),
"diagnostic": objmatcher.MapMatcher(map[string]objmatcher.Matcher{
"type": objmatcher.NewEqualsMatcher("generic"),
"generic": objmatcher.MapMatcher(map[string]objmatcher.Matcher{
"diagnosticType": objmatcher.NewEqualsMatcher("DIAG_TYPE"),
"value": objmatcher.MapMatcher(map[string]objmatcher.Matcher{
"testKey": objmatcher.NewEqualsMatcher("test_value"),
}),
}),
}),
"unsafeParams": objmatcher.MapMatcher(map[string]objmatcher.Matcher{
"Password": objmatcher.NewEqualsMatcher("HelloWorld!"),
}),
}),
}),
},
},
{
Name: "thread dump diagnostic log entry",
Diagnostic: logging.NewDiagnosticFromThreadDump(logging.ThreadDumpV1{
Threads: []logging.ThreadInfoV1{
{
Id: safeLongVal(13),
Name: stringVal("testName"),
StackTrace: []logging.StackFrameV1{
{
Address: stringVal("address_val"),
Procedure: stringVal("procedure_val"),
File: stringVal("file_val"),
Line: intVal(99),
Params: map[string]interface{}{
"stackFrameParam": 33,
},
},
},
Params: map[string]interface{}{
"threadParam": 77,
},
},
},
}),
UnsafeParams: map[string]interface{}{
"Password": "HelloWorld!",
},
JSONMatcher: map[string]objmatcher.Matcher{
"type": objmatcher.NewEqualsMatcher("wrapped.1"),
"entityName": objmatcher.NewEqualsMatcher(entityName),
"entityVersion": objmatcher.NewEqualsMatcher(entityVersion),
"payload": objmatcher.MapMatcher(map[string]objmatcher.Matcher{
"type": objmatcher.NewEqualsMatcher("diagnosticLogV1"),
"diagnosticLogV1": objmatcher.MapMatcher(map[string]objmatcher.Matcher{
"type": objmatcher.NewEqualsMatcher("diagnostic.1"),
"time": objmatcher.NewRegExpMatcher(".+"),
"diagnostic": objmatcher.MapMatcher(map[string]objmatcher.Matcher{
"type": objmatcher.NewEqualsMatcher("threadDump"),
"threadDump": objmatcher.MapMatcher(map[string]objmatcher.Matcher{
"threads": objmatcher.SliceMatcher([]objmatcher.Matcher{
objmatcher.MapMatcher(map[string]objmatcher.Matcher{
"id": objmatcher.NewEqualsMatcher(json.Number("13")),
"name": objmatcher.NewEqualsMatcher("testName"),
"stackTrace": objmatcher.SliceMatcher([]objmatcher.Matcher{
objmatcher.MapMatcher(map[string]objmatcher.Matcher{
"address": objmatcher.NewEqualsMatcher("address_val"),
"procedure": objmatcher.NewEqualsMatcher("procedure_val"),
"file": objmatcher.NewEqualsMatcher("file_val"),
"line": objmatcher.NewEqualsMatcher(json.Number("99")),
"params": objmatcher.MapMatcher(map[string]objmatcher.Matcher{
"stackFrameParam": objmatcher.NewEqualsMatcher(json.Number("33")),
}),
}),
}),
"params": objmatcher.MapMatcher(map[string]objmatcher.Matcher{
"threadParam": objmatcher.NewEqualsMatcher(json.Number("77")),
}),
}),
}),
}),
}),
"unsafeParams": objmatcher.MapMatcher(map[string]objmatcher.Matcher{
"Password": objmatcher.NewEqualsMatcher("HelloWorld!"),
}),
}),
}),
},
},
}
}
func safeLongVal(in int64) *safelong.SafeLong {
val, err := safelong.NewSafeLong(in)
if err != nil {
panic(err)
}
return &val
}
func intVal(in int) *int {
return &in
}
func stringVal(in string) *string {
return &in
}
func Diag1LogJSONTestSuite(t *testing.T, entityName, entityVersion string, loggerProvider func(w io.Writer) diag1log.Logger) {
diag1LogJSONOutputTests(t, entityName, entityVersion, loggerProvider)
}
func diag1LogJSONOutputTests(t *testing.T, entityName, entityVersion string, loggerProvider func(w io.Writer) diag1log.Logger) {
for i, tc := range Diag1TestCases(entityName, entityVersion) {
t.Run(tc.Name, func(t *testing.T) {
buf := &bytes.Buffer{}
logger := loggerProvider(buf)
logger.Diagnostic(
tc.Diagnostic,
diag1log.UnsafeParams(tc.UnsafeParams),
)
gotEventLog := map[string]interface{}{}
logEntry := buf.Bytes()
err := safejson.Unmarshal(logEntry, &gotEventLog)
require.NoError(t, err, "Case %d: %s\nEvent log line is not a valid map: %v", i, tc.Name, string(logEntry))
assert.NoError(t, tc.JSONMatcher.Matches(gotEventLog), "Case %d: %s", i, tc.Name)
})
}
}