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
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
|
// Unless explicitly stated otherwise all files in this repository are licensed
// under the Apache License Version 2.0.
// This product includes software developed at Datadog (https://www.datadoghq.com/).
// Copyright 2024 Datadog, Inc.
package integrations
import (
"errors"
"os"
"runtime"
"testing"
"time"
"ci-visibility-test-github/main/civisibility/constants"
"gopkg.in/DataDog/dd-trace-go.v1/ddtrace/ext"
"github.com/stretchr/testify/assert"
"gopkg.in/DataDog/dd-trace-go.v1/ddtrace/mocktracer"
)
var mockTracer mocktracer.Tracer
func TestMain(m *testing.M) {
// Initialize civisibility using the mocktracer for testing
mockTracer = InitializeCIVisibilityMock()
// Run tests
os.Exit(m.Run())
}
func createDDTestSession(now time.Time) DdTestSession {
session := CreateTestSessionWith("my-command", "/tmp/wd", "my-testing-framework", now)
session.SetTag("my-tag", "my-value")
return session
}
func createDDTestModule(now time.Time) (DdTestSession, DdTestModule) {
session := createDDTestSession(now)
module := session.GetOrCreateModuleWithFrameworkAndStartTime("my-module", "my-module-framework", "framework-version", now)
module.SetTag("my-tag", "my-value")
return session, module
}
func createDDTestSuite(now time.Time) (DdTestSession, DdTestModule, DdTestSuite) {
session, module := createDDTestModule(now)
suite := module.GetOrCreateSuiteWithStartTime("my-suite", now)
suite.SetTag("my-tag", "my-value")
return session, module, suite
}
func createDDTest(now time.Time) (DdTestSession, DdTestModule, DdTestSuite, DdTest) {
session, module, suite := createDDTestSuite(now)
test := suite.CreateTestWithStartTime("my-test", now)
test.SetTag("my-tag", "my-value")
return session, module, suite, test
}
func commonAssertions(assert *assert.Assertions, sessionSpan mocktracer.Span) {
tags := map[string]interface{}{
"my-tag": "my-value",
constants.Origin: constants.CIAppTestOrigin,
constants.TestType: constants.TestTypeTest,
constants.TestCommand: "my-command",
}
spanTags := sessionSpan.Tags()
assert.Subset(spanTags, tags)
assert.Contains(spanTags, constants.OSPlatform)
assert.Contains(spanTags, constants.OSArchitecture)
assert.Contains(spanTags, constants.OSVersion)
assert.Contains(spanTags, constants.RuntimeVersion)
assert.Contains(spanTags, constants.RuntimeName)
assert.Contains(spanTags, constants.GitRepositoryURL)
assert.Contains(spanTags, constants.GitCommitSHA)
}
func TestSession(t *testing.T) {
mockTracer.Reset()
assert := assert.New(t)
now := time.Now()
session := createDDTestSession(now)
assert.NotNil(session.Context())
assert.Equal("my-command", session.Command())
assert.Equal("/tmp/wd", session.WorkingDirectory())
assert.Equal("my-testing-framework", session.Framework())
assert.Equal(now, session.StartTime())
session.Close(42)
finishedSpans := mockTracer.FinishedSpans()
assert.Equal(1, len(finishedSpans))
sessionAssertions(assert, now, finishedSpans[0])
// session already closed, this is a no-op
session.Close(0)
}
func sessionAssertions(assert *assert.Assertions, now time.Time, sessionSpan mocktracer.Span) {
assert.Equal(now, sessionSpan.StartTime())
assert.Equal("my-testing-framework.test_session", sessionSpan.OperationName())
tags := map[string]interface{}{
ext.ResourceName: "my-testing-framework.test_session.my-command",
ext.Error: true,
ext.ErrorType: "ExitCode",
ext.ErrorMsg: "exit code is not zero.",
ext.SpanType: constants.SpanTypeTestSession,
constants.TestStatus: constants.TestStatusFail,
constants.TestCommandExitCode: 42,
}
spanTags := sessionSpan.Tags()
assert.Subset(spanTags, tags)
assert.Contains(spanTags, constants.TestSessionIDTag)
commonAssertions(assert, sessionSpan)
}
func TestModule(t *testing.T) {
mockTracer.Reset()
assert := assert.New(t)
now := time.Now()
session, module := createDDTestModule(now)
defer func() { session.Close(0) }()
module.SetErrorInfo("my-type", "my-message", "my-stack")
assert.NotNil(module.Context())
assert.Equal("my-module", module.Name())
assert.Equal("my-module-framework", module.Framework())
assert.Equal(now, module.StartTime())
assert.Equal(session, module.Session())
module.Close()
finishedSpans := mockTracer.FinishedSpans()
assert.Equal(1, len(finishedSpans))
moduleAssertions(assert, now, finishedSpans[0])
//no-op call
module.Close()
}
func moduleAssertions(assert *assert.Assertions, now time.Time, moduleSpan mocktracer.Span) {
assert.Equal(now, moduleSpan.StartTime())
assert.Equal("my-module-framework.test_module", moduleSpan.OperationName())
tags := map[string]interface{}{
ext.ResourceName: "my-module",
ext.Error: true,
ext.ErrorType: "my-type",
ext.ErrorMsg: "my-message",
ext.ErrorStack: "my-stack",
ext.SpanType: constants.SpanTypeTestModule,
constants.TestModule: "my-module",
}
spanTags := moduleSpan.Tags()
assert.Subset(spanTags, tags)
assert.Contains(spanTags, constants.TestSessionIDTag)
assert.Contains(spanTags, constants.TestModuleIDTag)
commonAssertions(assert, moduleSpan)
}
func TestSuite(t *testing.T) {
mockTracer.Reset()
assert := assert.New(t)
now := time.Now()
session, module, suite := createDDTestSuite(now)
defer func() {
session.Close(0)
module.Close()
}()
suite.SetErrorInfo("my-type", "my-message", "my-stack")
assert.NotNil(suite.Context())
assert.Equal("my-suite", suite.Name())
assert.Equal(now, suite.StartTime())
assert.Equal(module, suite.Module())
suite.Close()
finishedSpans := mockTracer.FinishedSpans()
assert.Equal(1, len(finishedSpans))
suiteAssertions(assert, now, finishedSpans[0])
//no-op call
suite.Close()
}
func suiteAssertions(assert *assert.Assertions, now time.Time, suiteSpan mocktracer.Span) {
assert.Equal(now, suiteSpan.StartTime())
assert.Equal("my-module-framework.test_suite", suiteSpan.OperationName())
tags := map[string]interface{}{
ext.ResourceName: "my-suite",
ext.Error: true,
ext.ErrorType: "my-type",
ext.ErrorMsg: "my-message",
ext.ErrorStack: "my-stack",
ext.SpanType: constants.SpanTypeTestSuite,
constants.TestModule: "my-module",
constants.TestSuite: "my-suite",
}
spanTags := suiteSpan.Tags()
assert.Subset(spanTags, tags)
assert.Contains(spanTags, constants.TestSessionIDTag)
assert.Contains(spanTags, constants.TestModuleIDTag)
assert.Contains(spanTags, constants.TestSuiteIDTag)
commonAssertions(assert, suiteSpan)
}
func Test(t *testing.T) {
mockTracer.Reset()
assert := assert.New(t)
now := time.Now()
session, module, suite, test := createDDTest(now)
defer func() {
session.Close(0)
module.Close()
suite.Close()
}()
test.SetError(errors.New("we keep the last error"))
test.SetErrorInfo("my-type", "my-message", "my-stack")
pc, _, _, _ := runtime.Caller(0)
test.SetTestFunc(runtime.FuncForPC(pc))
assert.NotNil(test.Context())
assert.Equal("my-test", test.Name())
assert.Equal(now, test.StartTime())
assert.Equal(suite, test.Suite())
test.Close(ResultStatusPass)
finishedSpans := mockTracer.FinishedSpans()
assert.Equal(1, len(finishedSpans))
testAssertions(assert, now, finishedSpans[0])
//no-op call
test.Close(ResultStatusSkip)
}
func testAssertions(assert *assert.Assertions, now time.Time, testSpan mocktracer.Span) {
assert.Equal(now, testSpan.StartTime())
assert.Equal("my-module-framework.test", testSpan.OperationName())
tags := map[string]interface{}{
ext.ResourceName: "my-suite.my-test",
ext.Error: true,
ext.ErrorType: "my-type",
ext.ErrorMsg: "my-message",
ext.ErrorStack: "my-stack",
ext.SpanType: constants.SpanTypeTest,
constants.TestModule: "my-module",
constants.TestSuite: "my-suite",
constants.TestName: "my-test",
constants.TestStatus: constants.TestStatusPass,
}
spanTags := testSpan.Tags()
assert.Subset(spanTags, tags)
assert.Contains(spanTags, constants.TestSessionIDTag)
assert.Contains(spanTags, constants.TestModuleIDTag)
assert.Contains(spanTags, constants.TestSuiteIDTag)
assert.Contains(spanTags, constants.TestSourceFile)
assert.Contains(spanTags, constants.TestSourceStartLine)
commonAssertions(assert, testSpan)
}
|
