This repository has been archived by the owner on Jun 6, 2024. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 360
/
k8sValidator_test.go
257 lines (221 loc) · 9.08 KB
/
k8sValidator_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
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
package validation
import (
"fmt"
"io"
"os"
"sync"
"testing"
"github.com/datreeio/datree/pkg/extractor"
"github.com/stretchr/testify/assert"
"github.com/stretchr/testify/mock"
kubeconformValidator "github.com/yannh/kubeconform/pkg/validator"
)
type mockValidationClient struct {
mock.Mock
}
func (m *mockValidationClient) Validate(filename string, r io.ReadCloser) []kubeconformValidator.Result {
args := m.Called(filename, r)
return args.Get(0).([]kubeconformValidator.Result)
}
func TestValidateResources(t *testing.T) {
test_valid_multiple_configurations(t)
test_valid_multiple_configurations_only_k8s_files(t)
test_invalid_file(t)
test_get_all_schema_locations_online(t)
test_get_all_schema_locations_offline(t)
t.Run("test empty file", test_empty_file)
t.Run("test_offline_with_remote_custom_schema_location", test_offline_with_remote_custom_schema_location)
t.Run("test missing schema skipped", test_missing_schema_skipped)
t.Run("test_validateResource_offline_with_local_schema", test_validateResource_offline_with_local_schema)
t.Run("test_validateResource_offline_without_custom_schema_location", test_validateResource_offline_without_custom_schema_location)
}
func test_valid_multiple_configurations(t *testing.T) {
validationClient := &mockValidationClient{}
validationClient.On("Validate", mock.Anything, mock.Anything).Return([]kubeconformValidator.Result{
{Status: kubeconformValidator.Valid},
})
k8sValidator := K8sValidator{
validationClient: validationClient,
}
path := "../../internal/fixtures/kube/pass-all.yaml"
filesConfigurationsChan := make(chan *extractor.FileConfigurations, 1)
filesConfigurationsChan <- &extractor.FileConfigurations{
FileName: path,
Configurations: []extractor.Configuration{},
}
close(filesConfigurationsChan)
validConfigurationsChan, _, _ := k8sValidator.ValidateResources(filesConfigurationsChan, 1, false)
for p := range validConfigurationsChan {
assert.Equal(t, path, p.FileName)
}
}
func test_valid_multiple_configurations_only_k8s_files(t *testing.T) {
validationClient := &mockValidationClient{}
validationClient.On("Validate", mock.Anything, mock.Anything).Return([]kubeconformValidator.Result{
{Status: kubeconformValidator.Valid},
})
k8sValidator := K8sValidator{
validationClient: validationClient,
}
path := "../../internal/fixtures/kube/Chart.yaml"
filesConfigurationsChan := make(chan *extractor.FileConfigurations, 1)
filesConfigurationsChan <- &extractor.FileConfigurations{
FileName: path,
Configurations: []extractor.Configuration{},
}
close(filesConfigurationsChan)
validK8sFilesChan, _ := k8sValidator.GetK8sFiles(filesConfigurationsChan, 1)
for p := range validK8sFilesChan {
assert.Equal(t, path, p.FileName)
}
}
func test_invalid_file(t *testing.T) {
validationClient := &mockValidationClient{}
validationClient.On("Validate", mock.Anything, mock.Anything).Return([]kubeconformValidator.Result{
{Status: kubeconformValidator.Invalid, Err: fmt.Errorf("missing 'apiVersion' key")},
})
k8sValidator := K8sValidator{
validationClient: validationClient,
}
path := "../../internal/fixtures/kube/invalidK8sSchema.yaml"
filesConfigurationsChan := make(chan *extractor.FileConfigurations, 1)
filesConfigurationsChan <- &extractor.FileConfigurations{
FileName: path,
Configurations: []extractor.Configuration{},
}
close(filesConfigurationsChan)
_, invalidFilesChan, _ := k8sValidator.ValidateResources(filesConfigurationsChan, 1, false)
for p := range invalidFilesChan {
assert.Equal(t, path, p.Path)
}
}
func test_empty_file(t *testing.T) {
validationClient := &mockValidationClient{}
validationClient.On("Validate", mock.Anything, mock.Anything).Return([]kubeconformValidator.Result{
{Status: kubeconformValidator.Invalid, Err: fmt.Errorf("empty file")},
})
k8sValidator := K8sValidator{
validationClient: validationClient,
}
path := "../../internal/fixtures/kube/empty.yaml"
filesConfigurationsChan := make(chan *extractor.FileConfigurations, 1)
filesConfigurationsChan <- &extractor.FileConfigurations{
FileName: path,
Configurations: []extractor.Configuration{},
}
close(filesConfigurationsChan)
_, invalidFilesChan, _ := k8sValidator.ValidateResources(filesConfigurationsChan, 1, false)
for p := range invalidFilesChan {
assert.Equal(t, path, p.Path)
}
}
func test_offline_with_remote_custom_schema_location(t *testing.T) {
validationClient := &mockValidationClient{}
validationClient.On("Validate", mock.Anything, mock.Anything).Return([]kubeconformValidator.Result{
{Status: kubeconformValidator.Error, Err: fmt.Errorf("no such host")},
})
k8sValidator := K8sValidator{
validationClient: validationClient,
areThereCustomSchemaLocations: true,
isOffline: true,
}
path := "../../internal/fixtures/kube/pass-all.yaml"
filesConfigurationsChan := make(chan *extractor.FileConfigurations, 1)
filesConfigurationsChan <- &extractor.FileConfigurations{
FileName: path,
Configurations: []extractor.Configuration{},
}
close(filesConfigurationsChan)
_, invalidFilesChan, filesWithWarningsChan := k8sValidator.ValidateResources(filesConfigurationsChan, 1, false)
for p := range invalidFilesChan {
assert.Equal(t, 1, len(p.ValidationErrors))
assert.Equal(t, "k8s schema validation error: no such host\n", p.ValidationErrors[0].Error())
}
for p := range filesWithWarningsChan {
panic("expected 0 warnings when custom --schema-location provided, instead got warning: " + p.Warning)
}
}
func test_missing_schema_skipped(t *testing.T) {
validationClient := &mockValidationClient{}
validationClient.On("Validate", mock.Anything, mock.Anything).Return([]kubeconformValidator.Result{
{Status: kubeconformValidator.Skipped, Err: nil},
})
k8sValidator := K8sValidator{
validationClient: validationClient,
}
path := "../../internal/fixtures/kube/invalid-kind.yaml"
filesConfigurationsChan := make(chan *extractor.FileConfigurations, 1)
filesConfigurationsChan <- &extractor.FileConfigurations{
FileName: path,
Configurations: []extractor.Configuration{},
}
close(filesConfigurationsChan)
k8sValidationWarningPerValidFile := make(K8sValidationWarningPerValidFile)
var wg sync.WaitGroup
filesConfigurationsChanRes, invalidFilesChan, filesWithWarningsChan := k8sValidator.ValidateResources(filesConfigurationsChan, 1, false)
wg.Add(1)
go func() {
for p := range filesConfigurationsChanRes {
_ = p
}
for p := range invalidFilesChan {
_ = p
}
for p := range filesWithWarningsChan {
k8sValidationWarningPerValidFile[p.Filename] = *p
}
wg.Done()
}()
wg.Wait()
assert.Equal(t, 1, len(k8sValidationWarningPerValidFile))
assert.Equal(t, "k8s schema validation skipped: --ignore-missing-schemas flag was used", k8sValidationWarningPerValidFile[path].Warning)
}
func test_get_all_schema_locations_online(t *testing.T) {
homeDir, _ := os.UserHomeDir()
expectedOutput := []string{
"/my-local-schema-location",
"default",
"https://raw.githubusercontent.com/yannh/kubernetes-json-schema/master/{{ .NormalizedKubernetesVersion }}/{{ .ResourceKind }}{{ .KindSuffix }}.json",
"https://raw.githubusercontent.com/datreeio/CRDs-catalog/main/{{ .Group }}/{{ .ResourceKind }}_{{ .ResourceAPIVersion }}.json",
homeDir + "/.datree/crdSchemas/{{ .ResourceKind }}_{{ .ResourceAPIVersion }}.json",
}
actual := getAllSchemaLocations([]string{"/my-local-schema-location"}, false)
assert.Equal(t, expectedOutput, actual)
}
func test_get_all_schema_locations_offline(t *testing.T) {
expectedOutput := []string{
"/my-local-schema-location",
}
actual := getAllSchemaLocations([]string{"/my-local-schema-location"}, true)
assert.Equal(t, expectedOutput, actual)
}
func test_validateResource_offline_with_local_schema(t *testing.T) {
k8sValidator := &K8sValidator{
validationClient: newKubeconformValidator("1.21.0", false, getAllSchemaLocations([]string{
"some-path-to-non-existing-file-to-get-404.yaml",
}, true), false),
isOffline: true,
areThereCustomSchemaLocations: true,
}
isValid, validationErrors, validationWarningResult, err := k8sValidator.validateResource("../../internal/fixtures/kube/pass-all.yaml")
var nilValidationWarning *validationWarning
assert.Equal(t, nil, err)
assert.Equal(t, false, isValid)
assert.Equal(t, "k8s schema validation error: could not find schema for Deployment\n", validationErrors[0].Error())
assert.Equal(t, nilValidationWarning, validationWarningResult)
}
func test_validateResource_offline_without_custom_schema_location(t *testing.T) {
k8sValidator := &K8sValidator{
validationClient: newKubeconformValidator("1.21.0", false, getAllSchemaLocations([]string{}, true), true),
isOffline: true,
areThereCustomSchemaLocations: false,
}
isValid, validationErrors, validationWarningResult, err := k8sValidator.validateResource("../../internal/fixtures/kube/pass-all.yaml")
assert.Equal(t, nil, err)
assert.Equal(t, true, isValid)
assert.Equal(t, 0, len(validationErrors))
assert.Equal(t, &validationWarning{
WarningKind: NetworkError,
WarningMessage: "k8s schema validation skipped: no internet connection",
}, validationWarningResult)
}