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
|
/*
Copyright 2022 The Kubernetes Authors.
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 options
import (
"fmt"
"reflect"
"testing"
"time"
"github.com/stretchr/testify/assert"
)
/*
* TestDefaultServerOptions is intended to ensure we do not make a backward incompatible
* change to the default flag values for the ANP agent.
*/
func TestDefaultServerOptions(t *testing.T) {
defaultAgentOptions := NewGrpcProxyAgentOptions()
assertDefaultValue(t, "AgentCert", defaultAgentOptions.AgentCert, "")
assertDefaultValue(t, "AgentKey", defaultAgentOptions.AgentKey, "")
assertDefaultValue(t, "CaCert", defaultAgentOptions.CaCert, "")
assertDefaultValue(t, "ProxyServerHost", defaultAgentOptions.ProxyServerHost, "127.0.0.1")
assertDefaultValue(t, "ProxyServerPort", defaultAgentOptions.ProxyServerPort, 8091)
assertDefaultValue(t, "HealthServerHost", defaultAgentOptions.HealthServerHost, "")
assertDefaultValue(t, "HealthServerPort", defaultAgentOptions.HealthServerPort, 8093)
assertDefaultValue(t, "AdminBindAddress", defaultAgentOptions.AdminBindAddress, "127.0.0.1")
assertDefaultValue(t, "AdminServerPort", defaultAgentOptions.AdminServerPort, 8094)
assertDefaultValue(t, "EnableProfiling", defaultAgentOptions.EnableProfiling, false)
assertDefaultValue(t, "EnableContentionProfiling", defaultAgentOptions.EnableContentionProfiling, false)
assertDefaultValue(t, "AgentIdentifiers", defaultAgentOptions.AgentIdentifiers, "")
assertDefaultValue(t, "SyncInterval", defaultAgentOptions.SyncInterval, 1*time.Second)
assertDefaultValue(t, "ProbeInterval", defaultAgentOptions.ProbeInterval, 1*time.Second)
assertDefaultValue(t, "SyncIntervalCap", defaultAgentOptions.SyncIntervalCap, 10*time.Second)
assertDefaultValue(t, "KeepaliveTime", defaultAgentOptions.KeepaliveTime, 1*time.Hour)
assertDefaultValue(t, "ServiceAccountTokenPath", defaultAgentOptions.ServiceAccountTokenPath, "")
assertDefaultValue(t, "WarnOnChannelLimit", defaultAgentOptions.WarnOnChannelLimit, false)
assertDefaultValue(t, "SyncForever", defaultAgentOptions.SyncForever, false)
assertDefaultValue(t, "XfrChannelSize", defaultAgentOptions.XfrChannelSize, 150)
assertDefaultValue(t, "APIContentType", defaultAgentOptions.APIContentType, "application/vnd.kubernetes.protobuf")
}
func assertDefaultValue(t *testing.T, fieldName string, actual, expected interface{}) {
t.Helper()
assert.IsType(t, expected, actual, "For field %s, got the wrong type.", fieldName)
assert.Equal(t, expected, actual, "For field %s, got the wrong value.", fieldName)
}
func TestValidate(t *testing.T) {
for desc, tc := range map[string]struct {
fieldMap map[string]interface{}
expected error
}{
"default": {
fieldMap: map[string]interface{}{},
expected: nil,
},
"ZeroProxyServerPort": {
fieldMap: map[string]interface{}{"ProxyServerPort": 0},
expected: fmt.Errorf("proxy server port 0 must be greater than 0"),
},
"NegativeProxyServerPort": {
fieldMap: map[string]interface{}{"ProxyServerPort": -1},
expected: fmt.Errorf("proxy server port -1 must be greater than 0"),
},
"ReservedProxyServerPort": {
fieldMap: map[string]interface{}{"ProxyServerPort": 1023},
expected: nil, //TODO: fmt.Errorf("please do not try to use reserved port 1023 for the proxy server port"),
},
"StartValidProxyServerPort": {
fieldMap: map[string]interface{}{"ProxyServerPort": 1024},
expected: nil,
},
"EndValidProxyServerPort": {
fieldMap: map[string]interface{}{"ProxyServerPort": 49151},
expected: nil,
},
"StartEphemeralProxyServerPort": {
fieldMap: map[string]interface{}{"ProxyServerPort": 49152},
expected: nil, //TODO: fmt.Errorf("please do not try to use ephemeral port 49152 for the proxy server port"),
},
"ZeroHealthServerPort": {
fieldMap: map[string]interface{}{"HealthServerPort": 0},
expected: fmt.Errorf("health server port 0 must be greater than 0"),
},
"NegativeHealthServerPort": {
fieldMap: map[string]interface{}{"HealthServerPort": -1},
expected: fmt.Errorf("health server port -1 must be greater than 0"),
},
"ReservedHealthServerPort": {
fieldMap: map[string]interface{}{"HealthServerPort": 1023},
expected: nil, //TODO: fmt.Errorf("please do not try to use reserved port 1023 for the health server port"),
},
"StartValidHealthServerPort": {
fieldMap: map[string]interface{}{"HealthServerPort": 1024},
expected: nil,
},
"EndValidHealthServerPort": {
fieldMap: map[string]interface{}{"HealthServerPort": 49151},
expected: nil,
},
"StartEphemeralHealthServerPort": {
fieldMap: map[string]interface{}{"HealthServerPort": 49152},
expected: nil, //TODO: fmt.Errorf("please do not try to use ephemeral port 49152 for the health server port"),
},
"ZeroAdminServerPort": {
fieldMap: map[string]interface{}{"AdminServerPort": 0},
expected: fmt.Errorf("admin server port 0 must be greater than 0"),
},
"NegativeAdminServerPort": {
fieldMap: map[string]interface{}{"AdminServerPort": -1},
expected: fmt.Errorf("admin server port -1 must be greater than 0"),
},
"ReservedAdminServerPort": {
fieldMap: map[string]interface{}{"AdminServerPort": 1023},
expected: nil, //TODO: fmt.Errorf("please do not try to use reserved port 1023 for the health port"),
},
"StartValidAdminServerPort": {
fieldMap: map[string]interface{}{"AdminServerPort": 1024},
expected: nil,
},
"EndValidAdminServerPort": {
fieldMap: map[string]interface{}{"AdminServerPort": 49151},
expected: nil,
},
"StartEphemeralAdminServerPort": {
fieldMap: map[string]interface{}{"AdminServerPort": 49152},
expected: nil, //TODO: fmt.Errorf("please do not try to use ephemeral port 49152 for the health port"),
},
"ContentionProfilingRequiresProfiling": {
fieldMap: map[string]interface{}{
"EnableContentionProfiling": true,
"EnableProfiling": false,
},
expected: fmt.Errorf("if --enable-contention-profiling is set, --enable-profiling must also be set"),
},
"ZeroXfrChannelSize": {
fieldMap: map[string]interface{}{"XfrChannelSize": 0},
expected: fmt.Errorf("channel size 0 must be greater than 0"),
},
"NegativeXfrChannelSize": {
fieldMap: map[string]interface{}{"XfrChannelSize": -10},
expected: fmt.Errorf("channel size -10 must be greater than 0"),
},
"ServerCountSource": {
fieldMap: map[string]interface{}{"ServerCountSource": "foobar"},
expected: fmt.Errorf("--server-count-source must be one of '', 'default', 'max', got foobar"),
},
} {
t.Run(desc, func(t *testing.T) {
testAgentOptions := NewGrpcProxyAgentOptions()
for field, value := range tc.fieldMap {
rv := reflect.ValueOf(testAgentOptions)
rv = rv.Elem()
fv := rv.FieldByName(field)
switch reflect.TypeOf(value).Kind() {
case reflect.String:
svalue := value.(string)
fv.SetString(svalue)
case reflect.Int:
ivalue := value.(int)
fv.SetInt(int64(ivalue))
case reflect.Bool:
bvalue := value.(bool)
fv.SetBool(bvalue)
}
}
actual := testAgentOptions.Validate()
assert.IsType(t, tc.expected, actual, "Validation for case %s, got the wrong type.", desc)
assert.Equal(t, tc.expected, actual, "Validation for case %s, got the wrong value.", desc)
})
}
}
|
