/
policy_telemetry_test.go
187 lines (174 loc) · 5.45 KB
/
policy_telemetry_test.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
// +build go1.13
// Copyright (c) Microsoft Corporation. All rights reserved.
// Licensed under the MIT License.
package azcore
import (
"context"
"fmt"
"net/http"
"testing"
"github.com/Azure/azure-sdk-for-go/sdk/internal/mock"
)
var defaultTelemetry = UserAgent + " " + platformInfo
func TestPolicyTelemetryDefault(t *testing.T) {
srv, close := mock.NewServer()
defer close()
srv.SetResponse()
pl := NewPipeline(srv, NewTelemetryPolicy(nil))
req, err := NewRequest(context.Background(), http.MethodGet, srv.URL())
if err != nil {
t.Fatalf("unexpected error: %v", err)
}
resp, err := pl.Do(req)
if err != nil {
t.Fatalf("unexpected error: %v", err)
}
if v := resp.Request.Header.Get(HeaderUserAgent); v != defaultTelemetry {
t.Fatalf("unexpected user agent value: %s", v)
}
}
func TestPolicyTelemetryWithCustomInfo(t *testing.T) {
srv, close := mock.NewServer()
defer close()
srv.SetResponse()
const testValue = "azcore_test"
o := DefaultTelemetryOptions()
o.Value = testValue
pl := NewPipeline(srv, NewTelemetryPolicy(&o))
req, err := NewRequest(context.Background(), http.MethodGet, srv.URL())
if err != nil {
t.Fatalf("unexpected error: %v", err)
}
resp, err := pl.Do(req)
if err != nil {
t.Fatalf("unexpected error: %v", err)
}
if v := resp.Request.Header.Get(HeaderUserAgent); v != fmt.Sprintf("%s %s", testValue, defaultTelemetry) {
t.Fatalf("unexpected user agent value: %s", v)
}
}
func TestPolicyTelemetryPreserveExisting(t *testing.T) {
srv, close := mock.NewServer()
defer close()
srv.SetResponse()
pl := NewPipeline(srv, NewTelemetryPolicy(nil))
req, err := NewRequest(context.Background(), http.MethodGet, srv.URL())
if err != nil {
t.Fatalf("unexpected error: %v", err)
}
const otherValue = "this should stay"
req.Header.Set(HeaderUserAgent, otherValue)
resp, err := pl.Do(req)
if err != nil {
t.Fatalf("unexpected error: %v", err)
}
if v := resp.Request.Header.Get(HeaderUserAgent); v != fmt.Sprintf("%s %s", defaultTelemetry, otherValue) {
t.Fatalf("unexpected user agent value: %s", v)
}
}
func TestPolicyTelemetryWithAppID(t *testing.T) {
srv, close := mock.NewServer()
defer close()
srv.SetResponse()
const appID = "my_application"
o := DefaultTelemetryOptions()
o.ApplicationID = appID
pl := NewPipeline(srv, NewTelemetryPolicy(&o))
req, err := NewRequest(context.Background(), http.MethodGet, srv.URL())
if err != nil {
t.Fatalf("unexpected error: %v", err)
}
resp, err := pl.Do(req)
if err != nil {
t.Fatalf("unexpected error: %v", err)
}
if v := resp.Request.Header.Get(HeaderUserAgent); v != fmt.Sprintf("%s %s", appID, defaultTelemetry) {
t.Fatalf("unexpected user agent value: %s", v)
}
}
func TestPolicyTelemetryWithAppIDAndReqTelemetry(t *testing.T) {
srv, close := mock.NewServer()
defer close()
srv.SetResponse()
const appID = "my_application"
o := DefaultTelemetryOptions()
o.ApplicationID = appID
pl := NewPipeline(srv, NewTelemetryPolicy(&o))
req, err := NewRequest(context.Background(), http.MethodGet, srv.URL())
if err != nil {
t.Fatalf("unexpected error: %v", err)
}
req.Telemetry("TestPolicyTelemetryWithAppIDAndReqTelemetry")
resp, err := pl.Do(req)
if err != nil {
t.Fatalf("unexpected error: %v", err)
}
if v := resp.Request.Header.Get(HeaderUserAgent); v != fmt.Sprintf("%s %s %s", "TestPolicyTelemetryWithAppIDAndReqTelemetry", appID, defaultTelemetry) {
t.Fatalf("unexpected user agent value: %s", v)
}
}
func TestPolicyTelemetryWithAppIDSanitized(t *testing.T) {
srv, close := mock.NewServer()
defer close()
srv.SetResponse()
const appID = "This will get the spaces removed and truncated."
o := DefaultTelemetryOptions()
o.ApplicationID = appID
pl := NewPipeline(srv, NewTelemetryPolicy(&o))
req, err := NewRequest(context.Background(), http.MethodGet, srv.URL())
if err != nil {
t.Fatalf("unexpected error: %v", err)
}
resp, err := pl.Do(req)
if err != nil {
t.Fatalf("unexpected error: %v", err)
}
const newAppID = "This/will/get/the/spaces"
if v := resp.Request.Header.Get(HeaderUserAgent); v != fmt.Sprintf("%s %s", newAppID, defaultTelemetry) {
t.Fatalf("unexpected user agent value: %s", v)
}
}
func TestPolicyTelemetryPreserveExistingWithAppID(t *testing.T) {
srv, close := mock.NewServer()
defer close()
srv.SetResponse()
const appID = "my_application"
o := DefaultTelemetryOptions()
o.ApplicationID = appID
pl := NewPipeline(srv, NewTelemetryPolicy(&o))
req, err := NewRequest(context.Background(), http.MethodGet, srv.URL())
if err != nil {
t.Fatalf("unexpected error: %v", err)
}
const otherValue = "this should stay"
req.Header.Set(HeaderUserAgent, otherValue)
resp, err := pl.Do(req)
if err != nil {
t.Fatalf("unexpected error: %v", err)
}
if v := resp.Request.Header.Get(HeaderUserAgent); v != fmt.Sprintf("%s %s %s", appID, defaultTelemetry, otherValue) {
t.Fatalf("unexpected user agent value: %s", v)
}
}
func TestPolicyTelemetryDisabled(t *testing.T) {
srv, close := mock.NewServer()
defer close()
srv.SetResponse()
const appID = "my_application"
o := DefaultTelemetryOptions()
o.ApplicationID = appID
o.Disabled = true
pl := NewPipeline(srv, NewTelemetryPolicy(&o))
req, err := NewRequest(context.Background(), http.MethodGet, srv.URL())
if err != nil {
t.Fatalf("unexpected error: %v", err)
}
req.Telemetry("this should be ignored")
resp, err := pl.Do(req)
if err != nil {
t.Fatalf("unexpected error: %v", err)
}
if v := resp.Request.Header.Get(HeaderUserAgent); v != "" {
t.Fatalf("unexpected user agent value: %s", v)
}
}