-
Notifications
You must be signed in to change notification settings - Fork 197
/
testreconciler.go
266 lines (243 loc) · 12 KB
/
testreconciler.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
// Copyright 2022 Google LLC
//
// 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 testreconciler
import (
"context"
"fmt"
"log"
"net/http"
"regexp"
"testing"
"time"
loggingapis "github.com/GoogleCloudPlatform/k8s-config-connector/apis/resources/logging/v1beta1"
"github.com/GoogleCloudPlatform/k8s-config-connector/pkg/controller"
dclcontroller "github.com/GoogleCloudPlatform/k8s-config-connector/pkg/controller/dcl"
"github.com/GoogleCloudPlatform/k8s-config-connector/pkg/controller/direct/directbase"
"github.com/GoogleCloudPlatform/k8s-config-connector/pkg/controller/direct/logging"
"github.com/GoogleCloudPlatform/k8s-config-connector/pkg/controller/iam/auditconfig"
partialpolicy "github.com/GoogleCloudPlatform/k8s-config-connector/pkg/controller/iam/partialpolicy"
"github.com/GoogleCloudPlatform/k8s-config-connector/pkg/controller/iam/policy"
"github.com/GoogleCloudPlatform/k8s-config-connector/pkg/controller/iam/policymember"
"github.com/GoogleCloudPlatform/k8s-config-connector/pkg/controller/jitter"
"github.com/GoogleCloudPlatform/k8s-config-connector/pkg/controller/reconciliationinterval"
"github.com/GoogleCloudPlatform/k8s-config-connector/pkg/controller/tf"
"github.com/GoogleCloudPlatform/k8s-config-connector/pkg/crd/crdgeneration"
"github.com/GoogleCloudPlatform/k8s-config-connector/pkg/dcl/conversion"
"github.com/GoogleCloudPlatform/k8s-config-connector/pkg/dcl/metadata"
"github.com/GoogleCloudPlatform/k8s-config-connector/pkg/dcl/schema/dclschemaloader"
"github.com/GoogleCloudPlatform/k8s-config-connector/pkg/k8s"
"github.com/GoogleCloudPlatform/k8s-config-connector/pkg/servicemapping/servicemappingloader"
testcontroller "github.com/GoogleCloudPlatform/k8s-config-connector/pkg/test/controller"
testk8s "github.com/GoogleCloudPlatform/k8s-config-connector/pkg/test/k8s"
testservicemappingloader "github.com/GoogleCloudPlatform/k8s-config-connector/pkg/test/servicemappingloader"
mmdcl "github.com/GoogleCloudPlatform/declarative-resource-client-library/dcl"
tfschema "github.com/hashicorp/terraform-plugin-sdk/v2/helper/schema"
"golang.org/x/sync/semaphore"
apiextensions "k8s.io/apiextensions-apiserver/pkg/apis/apiextensions/v1"
"k8s.io/apimachinery/pkg/api/errors"
metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
"k8s.io/apimachinery/pkg/apis/meta/v1/unstructured"
"sigs.k8s.io/controller-runtime/pkg/event"
"sigs.k8s.io/controller-runtime/pkg/manager"
"sigs.k8s.io/controller-runtime/pkg/reconcile"
)
type ResourceCleanupPolicy string
const (
// Always clean up resources.
CleanupPolicyAlways ResourceCleanupPolicy = "Always"
// Clean up resources on test success or while a test is successful, once the test enters a FAILed state do not
// clean up any more resources.
CleanupPolicyOnSuccess ResourceCleanupPolicy = "OnSuccess"
)
var (
ExpectedSuccessfulReconcileResultFor = expectedSuccessfulReconcileResultFor
ExpectedUnsuccessfulReconcileResult = reconcile.Result{Requeue: false, RequeueAfter: 0 * time.Minute}
ExpectedRequeueReconcileStruct = reconcile.Result{Requeue: true}
)
type TestReconciler struct {
mgr manager.Manager
t *testing.T
provider *tfschema.Provider
smLoader *servicemappingloader.ServiceMappingLoader
dclConfig *mmdcl.Config
dclConverter *conversion.Converter
httpClient *http.Client
}
// TODO(kcc-eng): consolidate New() and NewForDCLAndTFTestReconciler() and keep the name as New() by refactoring all existing usages
func New(t *testing.T, mgr manager.Manager, provider *tfschema.Provider) *TestReconciler {
return NewTestReconciler(t, mgr, provider, nil, nil)
}
func NewTestReconciler(t *testing.T, mgr manager.Manager, provider *tfschema.Provider, dclConfig *mmdcl.Config, httpClient *http.Client) *TestReconciler {
smLoader := testservicemappingloader.New(t)
dclSchemaLoader, err := dclschemaloader.New()
if err != nil {
log.Fatalf("error creating a DCL schema loader: %v", err)
}
serviceMetaLoader := metadata.New()
dclConverter := conversion.New(dclSchemaLoader, serviceMetaLoader)
return &TestReconciler{
mgr: mgr,
t: t,
provider: provider,
smLoader: smLoader,
dclConverter: dclConverter,
dclConfig: dclConfig,
httpClient: httpClient,
}
}
func (r *TestReconciler) ReconcileIfManagedByKCC(ctx context.Context, unstruct *unstructured.Unstructured, expectedResult reconcile.Result, expectedErrorRegexp *regexp.Regexp) {
if k8s.IsManagedByKCC(unstruct.GroupVersionKind()) {
r.Reconcile(ctx, unstruct, expectedResult, expectedErrorRegexp)
} else {
// Some objects like Secrets should not be reconciled since they are
// not managed by KCC.
log.Printf("%v %v/%v is not managed by KCC; skipping reconciliation",
unstruct.GetKind(), unstruct.GetNamespace(), unstruct.GetName())
}
}
func (r *TestReconciler) Reconcile(ctx context.Context, unstruct *unstructured.Unstructured, expectedResult reconcile.Result, expectedErrorRegex *regexp.Regexp) {
r.t.Helper()
om := metav1.ObjectMeta{
Name: unstruct.GetName(),
Namespace: unstruct.GetNamespace(),
}
r.ReconcileObjectMeta(ctx, om, unstruct.GetKind(), expectedResult, expectedErrorRegex)
}
func (r *TestReconciler) ReconcileObjectMeta(ctx context.Context, om metav1.ObjectMeta, kind string, expectedResult reconcile.Result, expectedErrorRegex *regexp.Regexp) {
r.t.Helper()
reconciler := r.NewReconcilerForKind(kind)
testcontroller.RunReconcilerAssertResults(ctx, r.t, reconciler, kind, om, expectedResult, expectedErrorRegex)
}
// Creates and reconciles all unstructureds in the unstruct list. Returns a cleanup function that should be defered immediately after calling this function.
func (r *TestReconciler) CreateAndReconcile(ctx context.Context, unstructs []*unstructured.Unstructured, cleanupPolicy ResourceCleanupPolicy) func() {
r.t.Helper()
cleanupFuncs := make([]func(), 0, len(unstructs))
for _, u := range unstructs {
if err := r.mgr.GetClient().Create(ctx, u); err != nil {
r.t.Fatalf("error creating resource '%v': %v", u.GetKind(), err)
}
cleanupFuncs = append(cleanupFuncs, r.BuildCleanupFunc(ctx, u, cleanupPolicy))
r.ReconcileIfManagedByKCC(ctx, u, ExpectedSuccessfulReconcileResultFor(r, u), nil)
}
return func() {
for i := len(cleanupFuncs) - 1; i >= 0; i-- {
cleanupFuncs[i]()
}
}
}
func (r *TestReconciler) BuildCleanupFunc(ctx context.Context, unstruct *unstructured.Unstructured, cleanupPolicy ResourceCleanupPolicy) func() {
r.t.Helper()
return func() {
switch cleanupPolicy {
case CleanupPolicyAlways:
break
case CleanupPolicyOnSuccess:
if r.t.Failed() {
log.Printf("skipping cleanup of %v: %v/%v\n", unstruct.GetKind(), unstruct.GetNamespace(), unstruct.GetName())
return
}
default:
panic(fmt.Errorf("unknown cleanup policy: %v", cleanupPolicy))
}
log.Printf("Deleting %v: %v/%v\n", unstruct.GetKind(), unstruct.GetNamespace(), unstruct.GetName())
testk8s.RemoveDeletionDefenderFinalizerForUnstructured(r.t, unstruct, r.mgr.GetClient())
err := r.mgr.GetClient().Delete(ctx, unstruct)
if err != nil {
if errors.IsNotFound(err) {
log.Printf("Resource already gone; no deletion required.")
return
}
r.t.Errorf("error deleting %v: %v", unstruct, err)
}
r.ReconcileIfManagedByKCC(ctx, unstruct, ExpectedSuccessfulReconcileResultFor(r, unstruct), nil)
}
}
func (r *TestReconciler) NewReconcilerForKind(kind string) reconcile.Reconciler {
r.t.Helper()
var reconciler reconcile.Reconciler
var err error
// Set 'immediateReconcileRequests' and 'resourceWatcherRoutines'
// to nil to disable reconciler's ability to create asynchronous
// watches on unready dependencies. This feature of the reconciler
// is unnecessary for our tests since we reconcile each dependency
// first before the resource under test is reconciled. Overall,
// the feature adds risk of complications due to it's multi-threaded
// nature.
var immediateReconcileRequests chan event.GenericEvent = nil //nolint:revive
var resourceWatcherRoutines *semaphore.Weighted = nil //nolint:revive
stateIntoSpecDefaulter := k8s.NewStateIntoSpecDefaulter(r.mgr.GetClient())
defaulters := []k8s.Defaulter{stateIntoSpecDefaulter}
// we will actually assert the ReconcileAfter value later on so for dynamic tests
// we want to use an actual JitterGenerator for now.
var dclML metadata.ServiceMetadataLoader
if r.dclConverter != nil {
dclML = r.dclConverter.MetadataLoader
}
jg := jitter.NewDefaultGenerator(r.smLoader, dclML)
switch kind {
case "IAMPolicy":
reconciler, err = policy.NewReconciler(r.mgr, r.provider, r.smLoader, r.dclConverter, r.dclConfig, immediateReconcileRequests, resourceWatcherRoutines, defaulters, jg)
case "IAMPartialPolicy":
reconciler, err = partialpolicy.NewReconciler(r.mgr, r.provider, r.smLoader, r.dclConverter, r.dclConfig, immediateReconcileRequests, resourceWatcherRoutines, defaulters, jg)
case "IAMPolicyMember":
reconciler, err = policymember.NewReconciler(r.mgr, r.provider, r.smLoader, r.dclConverter, r.dclConfig, immediateReconcileRequests, resourceWatcherRoutines, defaulters, jg)
case "IAMAuditConfig":
reconciler, err = auditconfig.NewReconciler(r.mgr, r.provider, r.smLoader, r.dclConverter, r.dclConfig, immediateReconcileRequests, resourceWatcherRoutines, defaulters, jg)
default:
crd := testcontroller.GetCRDForKind(r.t, kind)
reconciler, err = r.newReconcilerForCRD(crd, defaulters, jg)
}
if err != nil {
r.t.Fatalf("error creating reconciler: %v", err)
}
return reconciler
}
func (r *TestReconciler) newReconcilerForCRD(crd *apiextensions.CustomResourceDefinition, defaulters []k8s.Defaulter, jg jitter.Generator) (reconcile.Reconciler, error) {
if crd.GetLabels()[crdgeneration.ManagedByKCCLabel] == "true" {
// Set 'immediateReconcileRequests' and 'resourceWatcherRoutines'
// to nil to disable reconciler's ability to create asynchronous
// watches on unready dependencies. This feature of the reconciler
// is unnecessary for our tests since we reconcile each dependency
// first before the resource under test is reconciled. Overall,
// the feature adds risk of complications due to it's multi-threaded
// nature.
var immediateReconcileRequests chan event.GenericEvent = nil //nolint:revive
var resourceWatcherRoutines *semaphore.Weighted = nil //nolint:revive
if crd.GetLabels()[crdgeneration.TF2CRDLabel] == "true" {
return tf.NewReconciler(r.mgr, crd, r.provider, r.smLoader, immediateReconcileRequests, resourceWatcherRoutines, defaulters, jg)
}
if crd.GetLabels()[k8s.DCL2CRDLabel] == "true" {
return dclcontroller.NewReconciler(r.mgr, crd, r.dclConverter, r.dclConfig, r.smLoader, immediateReconcileRequests, resourceWatcherRoutines, defaulters, jg)
}
switch crd.GetName() {
case "logginglogmetrics.logging.cnrm.cloud.google.com":
m, err := logging.GetModel(context.TODO(), &controller.Config{HTTPClient: r.httpClient})
if err != nil {
return nil, fmt.Errorf("error getting logging model: %w", err)
}
return directbase.NewReconciler(r.mgr, immediateReconcileRequests, resourceWatcherRoutines, loggingapis.LoggingLogMetricGVK, m, jg)
}
}
return nil, fmt.Errorf("CRD format not recognized")
}
func expectedSuccessfulReconcileResultFor(r *TestReconciler, u *unstructured.Unstructured) reconcile.Result {
if val, ok := k8s.GetAnnotation(k8s.ReconcileIntervalInSecondsAnnotation, u); ok {
reconcileInterval, err := reconciliationinterval.MeanReconcileReenqueuePeriodFromAnnotation(val)
if err != nil {
return reconcile.Result{}
}
return reconcile.Result{RequeueAfter: reconcileInterval}
}
return reconcile.Result{RequeueAfter: reconciliationinterval.MeanReconcileReenqueuePeriod(u.GroupVersionKind(), r.smLoader, r.dclConverter.MetadataLoader)}
}