-
Notifications
You must be signed in to change notification settings - Fork 129
/
manager.go
311 lines (273 loc) · 8.06 KB
/
manager.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
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
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
package env
import (
"bytes"
"fmt"
"os"
"strings"
corev1 "k8s.io/api/core/v1"
"github.com/kubeshop/testkube/pkg/api/v1/testkube"
)
const (
// SecretEnvVarPrefix is a prefix for secret env vars
SecretEnvVarPrefix = "RUNNER_SECRET_ENV"
// SecretVarPrefix is a prefix for secret vars
SecretVarPrefix = "RUNNER_SECRET_VAR_"
// ConfigMapVarPrefix is a prefix for config map vars
ConfigMapVarPrefix = "RUNNER_CONFIGMAP_VAR_"
// GitUsernameEnvVarName is git username environment var name
GitUsernameEnvVarName = "RUNNER_GITUSERNAME"
// GitTokenEnvVarName is git token environment var name
GitTokenEnvVarName = "RUNNER_GITTOKEN"
)
// Interface is responsible for exchanging envs and vars with executor pod
type Interface interface {
// PrepareSecrets prepares secret env vars based on secret envs and variables
PrepareSecrets(secretEnvs map[string]string, variables map[string]testkube.Variable) (secretEnvVars []corev1.EnvVar)
// PrepareEnvs prepares env vars based on envs and variables
PrepareEnvs(envs map[string]string, variables map[string]testkube.Variable) []corev1.EnvVar
// PrepareGitCredentials prepares git credentials
PrepareGitCredentials(usernameSecret, tokenSecret *testkube.SecretRef) (envVars []corev1.EnvVar)
// GetSecretEnvs get secret envs
GetSecretEnvs() (secretEnvs map[string]string)
// GetReferenceVars gets reference vars
GetReferenceVars(variables map[string]testkube.Variable)
// ObfuscateSecrets obfuscates secret values
ObfuscateSecrets(p []byte) []byte
// ObfuscateStringSlice obfuscates string slice values
ObfuscateStringSlice(values []string) []string
}
// NewManager returns an implementation of the Manager
func NewManager() *Manager {
return &Manager{}
}
// NewManagerWithVars returns an implementation of the Manager with variables
func NewManagerWithVars(variables map[string]testkube.Variable) *Manager {
return &Manager{
Variables: variables,
}
}
// Manager manages secret and config map exchange from job pods using env
type Manager struct {
Variables map[string]testkube.Variable
}
// PrepareSecrets prepares secret env vars based on secret envs and variables
func (m Manager) PrepareSecrets(secretEnvs map[string]string, variables map[string]testkube.Variable) (secretEnvVars []corev1.EnvVar) {
// preparet secret envs
i := 1
// Deprecated: use Secret Variables instead
for secretVar, secretName := range secretEnvs {
// TODO: these are duplicated because Postman executor is expecting it as json string
// and gets unmarshalled and the name and the value are taken from there, for other executors it will be like a normal env var.
secretEnvVars = append(secretEnvVars, corev1.EnvVar{
Name: secretVar,
ValueFrom: &corev1.EnvVarSource{
SecretKeyRef: &corev1.SecretKeySelector{
LocalObjectReference: corev1.LocalObjectReference{
Name: secretName,
},
Key: secretVar,
},
},
})
secretEnvVars = append(secretEnvVars, corev1.EnvVar{
Name: fmt.Sprintf("%s%d", SecretEnvVarPrefix, i),
ValueFrom: &corev1.EnvVarSource{
SecretKeyRef: &corev1.SecretKeySelector{
LocalObjectReference: corev1.LocalObjectReference{
Name: secretName,
},
Key: secretVar,
},
},
})
i++
}
i = 1
// prepare secret vars
for name, variable := range variables {
if !variable.IsSecret() || variable.SecretRef == nil {
continue
}
// TODO: these are duplicated because Postman executor is expecting it as json string
// and gets unmarshalled and the name and the value are taken from there, for other executors it will be like a normal env var.
secretEnvVars = append(secretEnvVars, corev1.EnvVar{
Name: name,
ValueFrom: &corev1.EnvVarSource{
SecretKeyRef: &corev1.SecretKeySelector{
LocalObjectReference: corev1.LocalObjectReference{
Name: variable.SecretRef.Name,
},
Key: variable.SecretRef.Key,
},
},
})
secretEnvVars = append(secretEnvVars, corev1.EnvVar{
Name: fmt.Sprintf("%s%d", SecretEnvVarPrefix, i),
ValueFrom: &corev1.EnvVarSource{
SecretKeyRef: &corev1.SecretKeySelector{
LocalObjectReference: corev1.LocalObjectReference{
Name: variable.SecretRef.Name,
},
Key: variable.SecretRef.Key,
},
},
})
i++
secretEnvVars = append(secretEnvVars, corev1.EnvVar{
Name: fmt.Sprintf("%s%s", SecretVarPrefix, name),
ValueFrom: &corev1.EnvVarSource{
SecretKeyRef: &corev1.SecretKeySelector{
LocalObjectReference: corev1.LocalObjectReference{
Name: variable.SecretRef.Name,
},
Key: variable.SecretRef.Key,
},
},
})
}
return secretEnvVars
}
// PrepareEnvs prepares env vars based on envs and variables
func (m Manager) PrepareEnvs(envs map[string]string, variables map[string]testkube.Variable) []corev1.EnvVar {
var env []corev1.EnvVar
for k, v := range envs {
env = append(env, corev1.EnvVar{
Name: k,
Value: v,
})
}
// prepare vars
for name, variable := range variables {
if variable.IsSecret() {
continue
}
if variable.ConfigMapRef == nil {
env = append(env, corev1.EnvVar{
Name: name,
Value: variable.Value,
})
} else {
env = append(env, corev1.EnvVar{
Name: name,
ValueFrom: &corev1.EnvVarSource{
ConfigMapKeyRef: &corev1.ConfigMapKeySelector{
LocalObjectReference: corev1.LocalObjectReference{
Name: variable.ConfigMapRef.Name,
},
Key: variable.ConfigMapRef.Key,
},
},
})
env = append(env, corev1.EnvVar{
Name: fmt.Sprintf("%s%s", ConfigMapVarPrefix, name),
ValueFrom: &corev1.EnvVarSource{
ConfigMapKeyRef: &corev1.ConfigMapKeySelector{
LocalObjectReference: corev1.LocalObjectReference{
Name: variable.ConfigMapRef.Name,
},
Key: variable.ConfigMapRef.Key,
},
},
})
}
}
return env
}
// PrepareGitCredentials prepares git credentials
func (m Manager) PrepareGitCredentials(usernameSecret, tokenSecret *testkube.SecretRef) (envVars []corev1.EnvVar) {
var data = []struct {
envVar string
secretRef *testkube.SecretRef
}{
{
GitUsernameEnvVarName,
usernameSecret,
},
{
GitTokenEnvVarName,
tokenSecret,
},
}
for _, value := range data {
if value.secretRef != nil {
envVars = append(envVars, corev1.EnvVar{
Name: value.envVar,
ValueFrom: &corev1.EnvVarSource{
SecretKeyRef: &corev1.SecretKeySelector{
LocalObjectReference: corev1.LocalObjectReference{
Name: value.secretRef.Name,
},
Key: value.secretRef.Key,
},
},
})
}
}
return envVars
}
// GetSecretEnvs gets secret envs
func (m Manager) GetSecretEnvs() (secretEnvs map[string]string) {
secretEnvs = make(map[string]string, 0)
i := 1
for {
envName := fmt.Sprintf("%s%d", SecretEnvVarPrefix, i)
secretEnv, ok := os.LookupEnv(envName)
if !ok {
break
}
secretEnvs[envName] = secretEnv
i++
}
return secretEnvs
}
// GetReferenceVars gets reference vars
func (m Manager) GetReferenceVars(variables map[string]testkube.Variable) {
for name, variable := range variables {
if variable.IsSecret() {
value, ok := os.LookupEnv(fmt.Sprintf("%s%s", SecretVarPrefix, name))
if !ok {
continue
}
variable.Value = value
variables[name] = variable
} else {
value, ok := os.LookupEnv(fmt.Sprintf("%s%s", ConfigMapVarPrefix, name))
if !ok {
continue
}
variable.Value = value
variables[name] = variable
}
}
return
}
// ObfuscateSecrets obfuscates secret values
func (m Manager) ObfuscateSecrets(p []byte) []byte {
if m.Variables == nil {
return p
}
for _, variable := range m.Variables {
if !variable.IsSecret() {
continue
}
p = bytes.ReplaceAll(p, []byte(variable.Value), []byte(strings.Repeat("*", len(variable.Value))))
}
return p
}
// ObfuscateStringSlice obfuscates string slice values
func (m Manager) ObfuscateStringSlice(values []string) []string {
if m.Variables == nil {
return values
}
var results []string
for _, value := range values {
for _, variable := range m.Variables {
if !variable.IsSecret() {
continue
}
value = strings.ReplaceAll(value, variable.Value, strings.Repeat("*", len(variable.Value)))
}
results = append(results, value)
}
return results
}