-
Notifications
You must be signed in to change notification settings - Fork 142
/
testutils.go
300 lines (252 loc) · 7.55 KB
/
testutils.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
package testutils
import (
"context"
"crypto/rand"
"crypto/rsa"
"encoding/json"
"fmt"
"log"
"net/http"
"net/http/httptest"
"os"
"strings"
"testing"
"time"
"github.com/go-logr/logr"
"github.com/weaveworks/weave-gitops/pkg/kube"
"github.com/weaveworks/weave-gitops/pkg/vendorfakes/fakelogr"
"gopkg.in/square/go-jose.v2"
"gopkg.in/square/go-jose.v2/jwt"
ctrl "sigs.k8s.io/controller-runtime"
"sigs.k8s.io/controller-runtime/pkg/client"
"sigs.k8s.io/controller-runtime/pkg/envtest"
kustomizev2 "github.com/fluxcd/kustomize-controller/api/v1beta2"
sourcev1 "github.com/fluxcd/source-controller/api/v1beta2"
"github.com/onsi/gomega"
appsv1 "k8s.io/api/apps/v1"
corev1 "k8s.io/api/core/v1"
v1 "k8s.io/apiextensions-apiserver/pkg/apis/apiextensions/v1"
apierrors "k8s.io/apimachinery/pkg/api/errors"
metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
"k8s.io/client-go/discovery"
memory "k8s.io/client-go/discovery/cached"
"k8s.io/client-go/dynamic"
"k8s.io/client-go/kubernetes"
"k8s.io/client-go/rest"
"k8s.io/client-go/restmapper"
)
const BaseURI = "https://weave.works/api"
var k8sEnv *K8sTestEnv
type K8sTestEnv struct {
Client client.Client
DynClient dynamic.Interface
RestMapper *restmapper.DeferredDiscoveryRESTMapper
Rest *rest.Config
Stop func()
}
// Starts a local k8s test environment for testing Kubernetes operations such as Create, Get, Delete, etc.
// Note that crdPaths are relative to the path of the test file,
// NOT the current working directory or path that the tests were started from.
func StartK8sTestEnvironment(crdPaths []string) (*K8sTestEnv, error) {
if k8sEnv != nil {
return k8sEnv, nil
}
testEnv := &envtest.Environment{
CRDDirectoryPaths: crdPaths,
CRDInstallOptions: envtest.CRDInstallOptions{
CleanUpAfterUse: false,
},
}
var err error
cfg, err := testEnv.Start()
if err != nil {
return nil, fmt.Errorf("could not start testEnv: %w", err)
}
scheme := kube.CreateScheme()
k8sManager, err := ctrl.NewManager(cfg, ctrl.Options{
ClientDisableCacheFor: []client.Object{
&corev1.Namespace{},
&corev1.Secret{},
&appsv1.Deployment{},
&corev1.ConfigMap{},
&kustomizev2.Kustomization{},
&sourcev1.GitRepository{},
&v1.CustomResourceDefinition{},
},
Scheme: scheme,
MetricsBindAddress: "0",
})
if err != nil {
return nil, fmt.Errorf("could not create controller manager: %w", err)
}
go func() {
err := k8sManager.Start(ctrl.SetupSignalHandler())
if err != nil {
log.Fatal(err.Error())
}
}()
dc, err := discovery.NewDiscoveryClientForConfig(cfg)
if err != nil {
return nil, fmt.Errorf("failed to initialize discovery client: %s", err)
}
mapper := restmapper.NewDeferredDiscoveryRESTMapper(memory.NewMemCacheClient(dc))
dyn, err := dynamic.NewForConfig(cfg)
if err != nil {
return nil, fmt.Errorf("failed to initialize dynamic client: %s", err)
}
k8sEnv = &K8sTestEnv{
Client: k8sManager.GetClient(),
DynClient: dyn,
RestMapper: mapper,
Rest: cfg,
Stop: func() {
err := testEnv.Stop()
if err != nil {
log.Fatal(err.Error())
}
},
}
return k8sEnv, nil
}
// MakeFakeLogr returns an API compliant logr object that can be used for unit testing.
func MakeFakeLogr() (logr.Logger, *fakelogr.LogSink) {
sink := &fakelogr.LogSink{}
sink.WithValuesStub = func(i ...interface{}) logr.LogSink {
return sink
}
sink.EnabledStub = func(i int) bool {
return true
}
return logr.New(sink), sink
}
func Setenv(k, v string) func() {
prev := os.Environ()
os.Setenv(k, v)
return func() {
os.Unsetenv(k)
for _, kv := range prev {
parts := strings.SplitN(kv, "=", 2)
os.Setenv(parts[0], parts[1])
}
}
}
// MakeRSAPrivateKey generates and returns an RSA Private Key.
func MakeRSAPrivateKey(t *testing.T) *rsa.PrivateKey {
t.Helper()
k, err := rsa.GenerateKey(rand.Reader, 4096)
if err != nil {
t.Fatal(err)
}
return k
}
// MakeJWToken creates and signs a token with the provided key.
func MakeJWToken(t *testing.T, key *rsa.PrivateKey, email string) string {
t.Helper()
signer, err := jose.NewSigner(jose.SigningKey{Algorithm: jose.RS256, Key: key}, nil)
if err != nil {
t.Fatal(err)
}
maxAgeSecondsAuthCookie := time.Second * 600
notBefore := time.Now().Add(-time.Second * 60)
claims := jwt.Claims{
Issuer: "http://127.0.0.1:5556/dex",
Subject: "testing",
Audience: jwt.Audience{"test-service"},
NotBefore: jwt.NewNumericDate(notBefore),
IssuedAt: jwt.NewNumericDate(notBefore),
Expiry: jwt.NewNumericDate(notBefore.Add(time.Duration(maxAgeSecondsAuthCookie))),
}
githubClaims := struct {
Groups []string `json:"groups"`
Email string `json:"email"`
PreferredUsername string `json:"preferred_username"`
}{
[]string{"testing"},
email,
"example",
}
signed, err := jwt.Signed(signer).Claims(claims).Claims(githubClaims).CompactSerialize()
if err != nil {
t.Fatal(err)
}
return signed
}
// MakeKeysetServer starts an HTTP server that can serve JSONWebKey sets.
func MakeKeysetServer(t *testing.T, key *rsa.PrivateKey) *httptest.Server {
t.Helper()
ts := httptest.NewTLSServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
w.Header().Set("Content-Type", "application/json")
var keys jose.JSONWebKeySet
keys.Keys = []jose.JSONWebKey{
{
Key: key.Public(),
Use: "sig",
Algorithm: "RS256",
},
}
_ = json.NewEncoder(w).Encode(keys)
}))
t.Cleanup(ts.Close)
return ts
}
// DeleteAllOf loops through all namespaces and deletes all resources from the given type
func DeleteAllOf(g *gomega.GomegaWithT, obj client.Object) {
ctx := context.Background()
nss := &corev1.NamespaceList{}
g.Expect(k8sEnv.Client.List(ctx, nss)).To(gomega.Succeed())
for _, ns := range nss.Items {
g.Expect(k8sEnv.Client.DeleteAllOf(ctx, obj, client.InNamespace(ns.Name))).To(gomega.Succeed())
}
}
// DeleteNamespace deletes a namespace.
// Note: deleting a namespace using this function on tests wont delete the underlying resources
// like in a real environment would.
func DeleteNamespace(g *gomega.GomegaWithT, ns *corev1.Namespace) {
// Code borrowed from controller-runtime: https://github.com/kubernetes-sigs/controller-runtime/blob/eb39b8eb28cfe920fa2450eb38f814fc9e8003e8/pkg/client/client_test.go#L51
clientset, err := kubernetes.NewForConfig(k8sEnv.Rest)
g.Expect(err).To(gomega.BeNil())
ctx := context.Background()
ns, err = clientset.CoreV1().Namespaces().Get(ctx, ns.Name, metav1.GetOptions{})
if err != nil {
return
}
err = clientset.CoreV1().Namespaces().Delete(ctx, ns.Name, metav1.DeleteOptions{})
g.Expect(err).NotTo(gomega.HaveOccurred())
// finalize if necessary
pos := -1
finalizers := ns.Spec.Finalizers
for i, fin := range finalizers {
if fin == "kubernetes" {
pos = i
break
}
}
if pos == -1 {
// no need to finalize
return
}
// re-get in order to finalize
ns, err = clientset.CoreV1().Namespaces().Get(ctx, ns.Name, metav1.GetOptions{})
if err != nil {
return
}
ns.Spec.Finalizers = append(finalizers[:pos], finalizers[pos+1:]...)
_, err = clientset.CoreV1().Namespaces().Finalize(ctx, ns, metav1.UpdateOptions{})
g.Expect(err).NotTo(gomega.HaveOccurred())
WAIT_LOOP:
for i := 0; i < 10; i++ {
ns, err = clientset.CoreV1().Namespaces().Get(ctx, ns.Name, metav1.GetOptions{})
if apierrors.IsNotFound(err) {
// success!
return
}
select {
case <-ctx.Done():
break WAIT_LOOP
// failed to delete in time, see failure below
case <-time.After(100 * time.Millisecond):
// do nothing, try again
}
}
g.Fail(fmt.Sprintf("timed out waiting for namespace %q to be deleted", ns.Name))
}