/
environment.go
314 lines (264 loc) · 11.1 KB
/
environment.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
312
313
314
package e2e
import (
"context"
"fmt"
"io"
"os"
"strings"
"sync"
"testing"
"time"
"github.com/kong/kubernetes-testing-framework/pkg/clusters"
"github.com/kong/kubernetes-testing-framework/pkg/clusters/addons/certmanager"
"github.com/kong/kubernetes-testing-framework/pkg/clusters/addons/loadimage"
"github.com/kong/kubernetes-testing-framework/pkg/clusters/addons/metallb"
"github.com/kong/kubernetes-testing-framework/pkg/clusters/types/gke"
"github.com/kong/kubernetes-testing-framework/pkg/clusters/types/kind"
"github.com/kong/kubernetes-testing-framework/pkg/environments"
"github.com/kong/kubernetes-testing-framework/pkg/utils/kubernetes/networking"
"github.com/kong/semver/v4"
"github.com/samber/lo"
"github.com/stretchr/testify/assert"
"github.com/stretchr/testify/require"
appsv1 "k8s.io/api/apps/v1"
corev1 "k8s.io/api/core/v1"
metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
"k8s.io/client-go/kubernetes"
"sigs.k8s.io/controller-runtime/pkg/client"
ctrllog "sigs.k8s.io/controller-runtime/pkg/log"
"sigs.k8s.io/controller-runtime/pkg/log/zap"
gatewayv1 "sigs.k8s.io/gateway-api/apis/v1"
gatewayclient "sigs.k8s.io/gateway-api/pkg/client/clientset/versioned"
operatorv1alpha1 "github.com/kong/gateway-operator/apis/v1alpha1"
operatorv1beta1 "github.com/kong/gateway-operator/apis/v1beta1"
"github.com/kong/gateway-operator/internal/versions"
"github.com/kong/gateway-operator/pkg/clientset"
testutils "github.com/kong/gateway-operator/pkg/utils/test"
"github.com/kong/gateway-operator/test/helpers"
)
// -----------------------------------------------------------------------------
// Testing Consts - Timeouts
// -----------------------------------------------------------------------------
const (
webhookReadinessTimeout = 2 * time.Minute
webhookReadinessTick = 2 * time.Second
)
// -----------------------------------------------------------------------------
// Testing Vars - Environment Overrideable
// -----------------------------------------------------------------------------
var (
existingCluster = os.Getenv("KONG_TEST_CLUSTER")
imageOverride = os.Getenv("KONG_TEST_GATEWAY_OPERATOR_IMAGE_OVERRIDE")
imageLoad = os.Getenv("KONG_TEST_GATEWAY_OPERATOR_IMAGE_LOAD")
skipClusterCleanup = strings.ToLower(os.Getenv("KONG_TEST_CLUSTER_PERSIST")) == "true"
)
// -----------------------------------------------------------------------------
// Test Suite - list of tests to run
// -----------------------------------------------------------------------------
var testSuite []func(*testing.T)
// GetTestSuite returns all e2e tests that should be run.
func GetTestSuite() []func(*testing.T) {
return testSuite
}
func addTestsToTestSuite(tests ...func(*testing.T)) {
testSuite = append(testSuite, tests...)
}
// -----------------------------------------------------------------------------
// Testing Vars - Testing Environment
// -----------------------------------------------------------------------------
// TestEnvironment represents a testing environment (K8s cluster) for running isolated e2e test.
type TestEnvironment struct {
Clients *testutils.K8sClients
Namespace *corev1.Namespace
Cleaner *clusters.Cleaner
Environment environments.Environment
}
// TestEnvOption is a functional option for configuring a test environment.
type TestEnvOption func(opt *testEnvOptions)
type testEnvOptions struct {
Image string
}
// WithOperatorImage allows configuring the operator image to use in the test environment.
func WithOperatorImage(image string) TestEnvOption {
return func(opts *testEnvOptions) {
opts.Image = image
}
}
var loggerOnce sync.Once
// CreateEnvironment creates a new independent testing environment for running isolated e2e test.
func CreateEnvironment(t *testing.T, ctx context.Context, opts ...TestEnvOption) TestEnvironment {
t.Helper()
var opt testEnvOptions
for _, o := range opts {
o(&opt)
}
skipClusterCleanup = existingCluster != ""
t.Log("configuring cluster for testing environment")
builder := environments.NewBuilder()
if existingCluster != "" {
clusterParts := strings.Split(existingCluster, ":")
require.Lenf(t, clusterParts, 2,
"existing cluster in wrong format (%s): format is <TYPE>:<NAME> (e.g. kind:test-cluster)", existingCluster,
)
clusterType, clusterName := clusterParts[0], clusterParts[1]
t.Logf("using existing %s cluster %s\n", clusterType, clusterName)
switch clusterType {
case string(kind.KindClusterType):
cluster, err := kind.NewFromExisting(clusterName)
require.NoError(t, err)
builder.WithExistingCluster(cluster)
builder.WithAddons(metallb.New())
builder.WithAddons(certmanager.New())
case string(gke.GKEClusterType):
cluster, err := gke.NewFromExistingWithEnv(ctx, clusterName)
require.NoError(t, err)
builder.WithExistingCluster(cluster)
builder.WithAddons(certmanager.New())
default:
t.Fatal(fmt.Errorf("unknown cluster type: %s", clusterType))
}
} else {
t.Log("no existing cluster found, deploying using Kubernetes In Docker (KIND)")
builder.WithAddons(metallb.New())
builder.WithAddons(certmanager.New())
}
if imageLoad != "" {
imageLoader, err := loadimage.NewBuilder().WithImage(imageLoad)
require.NoError(t, err)
t.Logf("loading image: %s", imageLoad)
builder.WithAddons(imageLoader.Build())
builder.WithAddons(certmanager.New())
}
if len(opt.Image) == 0 {
opt.Image = getOperatorImage(t)
}
kustomizeDir := PrepareKustomizeDir(t, opt.Image)
env, err := builder.Build(ctx)
require.NoError(t, err)
t.Cleanup(func() {
cleanupEnvironment(t, context.Background(), env, kustomizeDir.Tests())
})
t.Logf("waiting for cluster %s and all addons to become ready", env.Cluster().Name())
require.NoError(t, <-env.WaitForReady(ctx))
namespace, cleaner := helpers.SetupTestEnv(t, ctx, env)
t.Log("initializing Kubernetes API clients")
clients := &testutils.K8sClients{}
clients.K8sClient = env.Cluster().Client()
clients.OperatorClient, err = clientset.NewForConfig(env.Cluster().Config())
require.NoError(t, err)
clients.GatewayClient, err = gatewayclient.NewForConfig(env.Cluster().Config())
require.NoError(t, err)
t.Log("initializing manager client")
loggerOnce.Do(func() {
// A new client from package "sigs.k8s.io/controller-runtime/pkg/client" is created per execution
// of this function (see the line below this block). It requires a logger to be set, otherwise it logs
// "[controller-runtime] log.SetLogger(...) was never called; logs will not be displayed" with a stack trace.
// Since setting logger is a package level operation not safe for concurrent use, ensure it is set
// only once.
ctrllog.SetLogger(zap.New(func(o *zap.Options) {
o.DestWriter = io.Discard
}))
})
clients.MgrClient, err = client.New(env.Cluster().Config(), client.Options{})
require.NoError(t, err)
require.NoError(t, gatewayv1.AddToScheme(clients.MgrClient.Scheme()))
require.NoError(t, operatorv1alpha1.AddToScheme(clients.MgrClient.Scheme()))
require.NoError(t, operatorv1beta1.AddToScheme(clients.MgrClient.Scheme()))
t.Logf("deploying Gateway APIs CRDs from %s", testutils.GatewayExperimentalCRDsKustomizeURL)
require.NoError(t, clusters.KustomizeDeployForCluster(ctx, env.Cluster(), testutils.GatewayExperimentalCRDsKustomizeURL))
kicCRDsKustomizeURL := getCRDsKustomizeURLForKIC(t, versions.DefaultControlPlaneVersion)
t.Logf("deploying KIC CRDs from %s", kicCRDsKustomizeURL)
require.NoError(t, clusters.KustomizeDeployForCluster(ctx, env.Cluster(), kicCRDsKustomizeURL))
t.Log("creating system namespaces and serviceaccounts")
require.NoError(t, clusters.CreateNamespace(ctx, env.Cluster(), "kong-system"))
t.Log("deploying operator CRDs to test cluster via kustomize")
require.NoError(t, clusters.KustomizeDeployForCluster(ctx, env.Cluster(), kustomizeDir.CRD(), "--server-side"))
t.Log("deploying operator to test cluster via kustomize")
require.NoError(t, clusters.KustomizeDeployForCluster(ctx, env.Cluster(), kustomizeDir.Tests(), "--server-side"))
t.Log("waiting for operator deployment to complete")
require.NoError(t, waitForOperatorDeployment(ctx, clients.K8sClient))
t.Log("waiting for operator webhook service to be connective")
require.Eventually(t, waitForOperatorWebhookEventually(t, ctx, clients.K8sClient),
webhookReadinessTimeout, webhookReadinessTick)
t.Log("environment is ready, starting tests")
return TestEnvironment{
Clients: clients,
Namespace: namespace,
Cleaner: cleaner,
Environment: env,
}
}
// getCRDsKustomizeURLForKIC returns the Kubernetes Ingress Controller CRDs Kustomization URL for a given version.
func getCRDsKustomizeURLForKIC(t *testing.T, version string) string {
v, err := semver.Parse(version)
require.NoError(t, err)
const kicCRDsKustomizeURLTemplate = "https://github.com/Kong/kubernetes-ingress-controller/config/crd?ref=v%s"
return fmt.Sprintf(kicCRDsKustomizeURLTemplate, v)
}
func cleanupEnvironment(t *testing.T, ctx context.Context, env environments.Environment, kustomizePath string) {
t.Helper()
if env == nil {
return
}
if skipClusterCleanup {
t.Logf("cleaning up operator manifests using kustomize path: %s", kustomizePath)
assert.NoError(t, clusters.KustomizeDeleteForCluster(ctx, env.Cluster(), kustomizePath))
return
}
t.Logf("cleaning up testing cluster and environment %q", env.Name())
assert.NoError(t, env.Cleanup(ctx))
}
// -----------------------------------------------------------------------------
// Testing Main - Helper Functions
// -----------------------------------------------------------------------------
type deploymentAssertOptions func(*appsv1.Deployment) bool
func deploymentAssertConditions(conds ...appsv1.DeploymentCondition) deploymentAssertOptions {
return func(deployment *appsv1.Deployment) bool {
return lo.EveryBy(conds, func(cond appsv1.DeploymentCondition) bool {
return lo.ContainsBy(deployment.Status.Conditions, func(c appsv1.DeploymentCondition) bool {
return c.Type == cond.Type &&
c.Status == cond.Status &&
c.Reason == cond.Reason
})
})
}
}
func waitForOperatorDeployment(ctx context.Context, k8sClient *kubernetes.Clientset, opts ...deploymentAssertOptions) error {
outer:
for {
select {
case <-ctx.Done():
return ctx.Err()
default:
deployment, err := k8sClient.AppsV1().Deployments("kong-system").Get(ctx, "gateway-operator-controller-manager", metav1.GetOptions{})
if err != nil {
return err
}
if deployment.Status.AvailableReplicas <= 0 {
continue
}
for _, opt := range opts {
if !opt(deployment) {
continue outer
}
}
return nil
}
}
}
func waitForOperatorWebhookEventually(t *testing.T, ctx context.Context, k8sClient *kubernetes.Clientset) func() bool {
return func() bool {
if err := waitForOperatorWebhook(ctx, k8sClient); err != nil {
t.Logf("failed to wait for operator webhook: %v", err)
return false
}
t.Log("operator webhook ready")
return true
}
}
func waitForOperatorWebhook(ctx context.Context, k8sClient *kubernetes.Clientset) error {
webhookServiceNamespace := "kong-system"
webhookServiceName := "gateway-operator-validating-webhook"
webhookServicePort := 443
return networking.WaitForConnectionOnServicePort(ctx, k8sClient, webhookServiceNamespace, webhookServiceName, webhookServicePort, 10*time.Second)
}