-
Notifications
You must be signed in to change notification settings - Fork 49
/
envtest.go
260 lines (228 loc) · 9.05 KB
/
envtest.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
/*
Copyright 2022 The Kubernetes Authors.
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 helpers includes helper functions important for unit and integration testing.
package helpers
import (
"context"
"fmt"
"go/build"
"os"
"path"
"path/filepath"
goruntime "runtime"
g "github.com/onsi/ginkgo"
infrav1 "github.com/syself/cluster-api-provider-hetzner/api/v1beta1"
secretutil "github.com/syself/cluster-api-provider-hetzner/pkg/secrets"
"github.com/syself/cluster-api-provider-hetzner/pkg/services/baremetal/client/mocks"
robotmock "github.com/syself/cluster-api-provider-hetzner/pkg/services/baremetal/client/mocks/robot"
sshmock "github.com/syself/cluster-api-provider-hetzner/pkg/services/baremetal/client/mocks/ssh"
robotclient "github.com/syself/cluster-api-provider-hetzner/pkg/services/baremetal/client/robot"
sshclient "github.com/syself/cluster-api-provider-hetzner/pkg/services/baremetal/client/ssh"
hcloudclient "github.com/syself/cluster-api-provider-hetzner/pkg/services/hcloud/client"
fakeclient "github.com/syself/cluster-api-provider-hetzner/pkg/services/hcloud/client/fake"
corev1 "k8s.io/api/core/v1"
apierrors "k8s.io/apimachinery/pkg/api/errors"
metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
"k8s.io/apimachinery/pkg/runtime"
kerrors "k8s.io/apimachinery/pkg/util/errors"
utilruntime "k8s.io/apimachinery/pkg/util/runtime"
clientgoscheme "k8s.io/client-go/kubernetes/scheme"
"k8s.io/client-go/rest"
"k8s.io/klog/v2"
"k8s.io/klog/v2/klogr"
clusterv1 "sigs.k8s.io/cluster-api/api/v1beta1"
bootstrapv1 "sigs.k8s.io/cluster-api/bootstrap/kubeadm/api/v1beta1"
"sigs.k8s.io/cluster-api/cmd/clusterctl/log"
"sigs.k8s.io/cluster-api/util/kubeconfig"
ctrl "sigs.k8s.io/controller-runtime"
"sigs.k8s.io/controller-runtime/pkg/cache"
"sigs.k8s.io/controller-runtime/pkg/client"
"sigs.k8s.io/controller-runtime/pkg/envtest"
)
func init() {
klog.InitFlags(nil)
logger := klogr.New()
// use klog as the internal logger for this envtest environment.
log.SetLogger(logger)
// additionally force all of the controllers to use the Ginkgo logger.
ctrl.SetLogger(logger)
// add logger for ginkgo
klog.SetOutput(g.GinkgoWriter)
}
var (
scheme = runtime.NewScheme()
env *envtest.Environment
)
func init() {
// Calculate the scheme.
utilruntime.Must(clientgoscheme.AddToScheme(scheme))
utilruntime.Must(clusterv1.AddToScheme(scheme))
utilruntime.Must(bootstrapv1.AddToScheme(scheme))
utilruntime.Must(infrav1.AddToScheme(scheme))
// Get the root of the current file to use in CRD paths.
_, filename, _, _ := goruntime.Caller(0) //nolint:dogsled
root := path.Join(path.Dir(filename), "..", "..")
crdPaths := []string{
filepath.Join(root, "config", "crd", "bases"),
}
// append CAPI CRDs path
if capiPath := getFilePathToCAPICRDs(root); capiPath != "" {
crdPaths = append(crdPaths, capiPath)
}
// Create the test environment.
env = &envtest.Environment{
ErrorIfCRDPathMissing: true,
CRDDirectoryPaths: crdPaths,
}
}
type (
// TestEnvironment encapsulates a Kubernetes local test environment.
TestEnvironment struct {
ctrl.Manager
client.Client
Config *rest.Config
HCloudClientFactory hcloudclient.Factory
RobotClientFactory robotclient.Factory
SSHClientFactory sshclient.Factory
RescueSSHClient *sshmock.Client
OSSSHClientAfterInstallImage *sshmock.Client
OSSSHClientAfterCloudInit *sshmock.Client
RobotClient *robotmock.Client
cancel context.CancelFunc
}
)
// NewTestEnvironment creates a new environment spinning up a local api-server.
func NewTestEnvironment() *TestEnvironment {
// initialize webhook here to be able to test the envtest install via webhookOptions
initializeWebhookInEnvironment()
if _, err := env.Start(); err != nil {
err = kerrors.NewAggregate([]error{err, env.Stop()})
panic(err)
}
// Build the controller manager.
mgr, err := ctrl.NewManager(env.Config, ctrl.Options{
Scheme: scheme,
Port: env.WebhookInstallOptions.LocalServingPort,
CertDir: env.WebhookInstallOptions.LocalServingCertDir,
MetricsBindAddress: "0",
NewCache: cache.BuilderWithOptions(cache.Options{
SelectorsByObject: secretutil.AddSecretSelector(nil),
}),
})
if err != nil {
klog.Fatalf("unable to create manager: %s", err)
}
if err := (&infrav1.HetznerCluster{}).SetupWebhookWithManager(mgr); err != nil {
klog.Fatalf("failed to set up webhook with manager for HetznerCluster: %s", err)
}
if err := (&infrav1.HetznerClusterTemplate{}).SetupWebhookWithManager(mgr); err != nil {
klog.Fatalf("failed to set up webhook with manager for HetznerClusterTemplate: %s", err)
}
if err := (&infrav1.HCloudMachine{}).SetupWebhookWithManager(mgr); err != nil {
klog.Fatalf("failed to set up webhook with manager for HCloudMachine: %s", err)
}
if err := (&infrav1.HCloudMachineTemplate{}).SetupWebhookWithManager(mgr); err != nil {
klog.Fatalf("failed to set up webhook with manager for HCloudMachineTemplate: %s", err)
}
if err := (&infrav1.HetznerBareMetalMachine{}).SetupWebhookWithManager(mgr); err != nil {
klog.Fatalf("failed to set up webhook with manager for HetznerBareMetalMachine: %s", err)
}
if err := (&infrav1.HetznerBareMetalMachineTemplate{}).SetupWebhookWithManager(mgr); err != nil {
klog.Fatalf("failed to set up webhook with manager for HetznerBareMetalMachineTemplate: %s", err)
}
if err := (&infrav1.HetznerBareMetalHost{}).SetupWebhookWithManager(mgr); err != nil {
klog.Fatalf("failed to set up webhook with manager for HetznerBareMetalHost: %s", err)
}
// Create a fake HCloudClientFactory
hcloudClientFactory := fakeclient.NewHCloudClientFactory()
rescueSSHClient := &sshmock.Client{}
osSSHClientAfterInstallImage := &sshmock.Client{}
osSSHClientAfterCloudInit := &sshmock.Client{}
robotClient := &robotmock.Client{}
return &TestEnvironment{
Manager: mgr,
Client: mgr.GetClient(),
Config: mgr.GetConfig(),
HCloudClientFactory: hcloudClientFactory,
SSHClientFactory: mocks.NewSSHFactory(rescueSSHClient, osSSHClientAfterInstallImage, osSSHClientAfterCloudInit),
RescueSSHClient: rescueSSHClient,
OSSSHClientAfterInstallImage: osSSHClientAfterInstallImage,
OSSSHClientAfterCloudInit: osSSHClientAfterCloudInit,
RobotClientFactory: mocks.NewRobotFactory(robotClient),
RobotClient: robotClient,
}
}
// StartManager starts the manager and sets a cancel function into the testEnv object.
func (t *TestEnvironment) StartManager(ctx context.Context) error {
ctx, cancel := context.WithCancel(ctx)
t.cancel = cancel
return t.Manager.Start(ctx)
}
// Stop stops the manager and cancels the context.
func (t *TestEnvironment) Stop() error {
t.cancel()
return env.Stop()
}
// Cleanup deletes client objects.
func (t *TestEnvironment) Cleanup(ctx context.Context, objs ...client.Object) error {
errs := make([]error, 0, len(objs))
for _, o := range objs {
err := t.Client.Delete(ctx, o)
if apierrors.IsNotFound(err) {
// If the object is not found, it must've been garbage collected
// already. For example, if we delete namespace first and then
// objects within it.
continue
}
errs = append(errs, err)
}
return kerrors.NewAggregate(errs)
}
// CreateNamespace creates a namespace.
func (t *TestEnvironment) CreateNamespace(ctx context.Context, generateName string) (*corev1.Namespace, error) {
ns := &corev1.Namespace{
ObjectMeta: metav1.ObjectMeta{
GenerateName: fmt.Sprintf("%s-", generateName),
Labels: map[string]string{
"testenv/original-name": generateName,
},
},
}
if err := t.Client.Create(ctx, ns); err != nil {
return nil, err
}
return ns, nil
}
// CreateKubeconfigSecret generates a kubeconfig secret in a given capi cluster.
func (t *TestEnvironment) CreateKubeconfigSecret(ctx context.Context, cluster *clusterv1.Cluster) error {
return t.Create(ctx, kubeconfig.GenerateSecret(cluster, kubeconfig.FromEnvTestConfig(t.Config, cluster)))
}
func getFilePathToCAPICRDs(root string) string {
mod, err := newMod(filepath.Join(root, "go.mod"))
if err != nil {
return ""
}
packageName := "sigs.k8s.io/cluster-api"
clusterAPIVersion, err := mod.FindDependencyVersion(packageName)
if err != nil {
return ""
}
gopath := envOr("GOPATH", build.Default.GOPATH)
return filepath.Join(gopath, "pkg", "mod", "sigs.k8s.io", fmt.Sprintf("cluster-api@%s", clusterAPIVersion), "config", "crd", "bases")
}
func envOr(envKey, defaultValue string) string {
if value, ok := os.LookupEnv(envKey); ok {
return value
}
return defaultValue
}