/
environment.go
164 lines (140 loc) · 5.46 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
// Copyright 2021 SAP SE or an SAP affiliate company. All rights reserved. This file is licensed under the Apache Software License, v. 2 except as noted otherwise in the LICENSE file
//
// 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 envtest
import (
"fmt"
"os"
"strings"
utilerrors "k8s.io/apimachinery/pkg/util/errors"
"k8s.io/client-go/rest"
"k8s.io/utils/ptr"
"sigs.k8s.io/controller-runtime/pkg/envtest"
logf "sigs.k8s.io/controller-runtime/pkg/log"
)
var log = logf.Log.WithName("gardener").WithName("test-env")
const envUseExistingGardener = "USE_EXISTING_GARDENER"
// GardenerTestEnvironment wraps envtest.Environment and additionally starts, registers and stops an instance of
// gardener-apiserver in order to work with gardener resources in the test.
type GardenerTestEnvironment struct {
*envtest.Environment
// UseExistingGardener specifies whether to run the test against an existing gardener control plane.
// If it is set to true, Start will skip starting a temporary control plane and gardener-apiserver, and connect to the
// cluster targeted by $KUBECONFIG instead.
// If it is unset, setting the USE_EXISTING_GARDENER env var to `true` will have the same effects.
UseExistingGardener *bool
// certDir contains the kube-apiserver certs (generated by controller-runtime's pkg/envtest) and the front-proxy
// certs for the API server aggregation layer
certDir string
aggregatorConfig AggregatorConfig
// GardenerAPIServer knows how to start, register and stop a temporary gardener-apiserver instance.
GardenerAPIServer *GardenerAPIServer
}
// Start starts the underlying envtest.Environment and the GardenerAPIServer.
func (e *GardenerTestEnvironment) Start() (*rest.Config, error) {
if e.Environment == nil {
e.Environment = &envtest.Environment{}
}
if e.useExistingGardener() {
log.V(1).Info("Using existing gardener setup")
e.Environment.UseExistingCluster = ptr.To(true)
} else {
// manage k-api cert dir by ourselves, we will add aggregator certs to it
kubeAPIServer := e.Environment.ControlPlane.GetAPIServer()
var err error
e.certDir, err = os.MkdirTemp("", "k8s_test_framework_")
if err != nil {
return nil, err
}
kubeAPIServer.CertDir = e.certDir
// configure kube-aggregator
if err := e.aggregatorConfig.ConfigureAPIServerArgs(e.certDir, kubeAPIServer.Configure()); err != nil {
return nil, err
}
}
// start kube control plane
log.V(1).Info("Starting envtest control plane")
adminRestConfig, err := e.Environment.Start()
if err != nil {
return nil, err
}
if !e.useExistingGardener() {
// start gardener API server
if e.GardenerAPIServer == nil {
e.GardenerAPIServer = &GardenerAPIServer{}
}
// add gardener-apiserver user
gardenerAPIServerUser, err := e.Environment.ControlPlane.AddUser(envtest.User{
Name: "gardener-apiserver",
// TODO: bootstrap gardener RBAC and bind to ClusterRole/gardener.cloud:system:apiserver
Groups: []string{"system:masters"},
}, &rest.Config{
// gotta go fast during tests -- we don't really care about overwhelming our test API server
QPS: 1000.0,
Burst: 2000.0,
})
if err != nil {
return nil, fmt.Errorf("unable to provision gardener-apiserver user: %w", err)
}
e.GardenerAPIServer.user = gardenerAPIServerUser
// default GardenerAPIServer settings to the envtest ControlPlane settings
if e.GardenerAPIServer.StartTimeout.Milliseconds() == 0 {
e.GardenerAPIServer.StartTimeout = e.ControlPlaneStartTimeout
}
if e.GardenerAPIServer.StopTimeout.Milliseconds() == 0 {
e.GardenerAPIServer.StopTimeout = e.ControlPlaneStopTimeout
}
if e.GardenerAPIServer.Out == nil && e.AttachControlPlaneOutput {
e.GardenerAPIServer.Out = os.Stdout
}
if e.GardenerAPIServer.Err == nil && e.AttachControlPlaneOutput {
e.GardenerAPIServer.Err = os.Stderr
}
// reuse etcd from envtest ControlPlane if not overwritten
if e.GardenerAPIServer.EtcdURL == nil {
e.GardenerAPIServer.EtcdURL = e.Environment.ControlPlane.Etcd.URL
}
if err := e.GardenerAPIServer.Start(); err != nil {
return nil, fmt.Errorf("failed to start gardener-apiserver: %w", err)
}
}
return adminRestConfig, nil
}
// Stop stops the underlying envtest.Environment and the GardenerAPIServer.
func (e *GardenerTestEnvironment) Stop() error {
var errList []error
if e.GardenerAPIServer != nil {
log.V(1).Info("Stopping gardener-apiserver")
if err := e.GardenerAPIServer.Stop(); err != nil {
errList = append(errList, err)
}
}
if e.Environment != nil {
log.V(1).Info("Stopping envtest control plane")
if err := e.Environment.Stop(); err != nil {
errList = append(errList, err)
}
}
if e.certDir != "" {
if err := os.RemoveAll(e.certDir); err != nil {
errList = append(errList, err)
}
}
return utilerrors.Flatten(utilerrors.NewAggregate(errList))
}
func (e *GardenerTestEnvironment) useExistingGardener() bool {
if e.UseExistingGardener == nil {
return strings.ToLower(os.Getenv(envUseExistingGardener)) == "true"
}
return *e.UseExistingGardener
}