/
clientsholder.go
364 lines (318 loc) · 12.5 KB
/
clientsholder.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
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
// Copyright (C) 2020-2024 Red Hat, Inc.
//
// This program is free software; you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation; either version 2 of the License, or
// (at your option) any later version.
//
// This program is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
// GNU General Public License for more details.
//
// You should have received a copy of the GNU General Public License along
// with this program; if not, write to the Free Software Foundation, Inc.,
// 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
package clientsholder
import (
"errors"
"fmt"
"time"
clientconfigv1 "github.com/openshift/client-go/config/clientset/versioned/typed/config/v1"
olmClient "github.com/operator-framework/operator-lifecycle-manager/pkg/api/client/clientset/versioned"
olmFakeClient "github.com/operator-framework/operator-lifecycle-manager/pkg/api/client/clientset/versioned/fake"
"github.com/test-network-function/cnf-certification-test/internal/log"
apiextv1c "k8s.io/apiextensions-apiserver/pkg/apis/apiextensions/v1"
apiextv1 "k8s.io/apiextensions-apiserver/pkg/client/clientset/clientset"
"k8s.io/apimachinery/pkg/runtime"
"k8s.io/client-go/discovery"
"k8s.io/client-go/dynamic"
"k8s.io/client-go/kubernetes"
"k8s.io/client-go/restmapper"
"k8s.io/client-go/scale"
cncfNetworkAttachmentv1 "github.com/k8snetworkplumbingwg/network-attachment-definition-client/pkg/client/clientset/versioned/typed/k8s.cni.cncf.io/v1"
ocpMachine "github.com/openshift/client-go/machineconfiguration/clientset/versioned"
appsv1 "k8s.io/api/apps/v1"
scalingv1 "k8s.io/api/autoscaling/v1"
corev1 "k8s.io/api/core/v1"
policyv1 "k8s.io/api/policy/v1"
rbacv1 "k8s.io/api/rbac/v1"
storagev1 "k8s.io/api/storage/v1"
apiextv1fake "k8s.io/apiextensions-apiserver/pkg/client/clientset/clientset/fake"
metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
k8sFakeClient "k8s.io/client-go/kubernetes/fake"
networkingv1 "k8s.io/client-go/kubernetes/typed/networking/v1"
"k8s.io/client-go/rest"
"k8s.io/client-go/tools/clientcmd"
clientcmdapi "k8s.io/client-go/tools/clientcmd/api"
)
const (
DefaultTimeout = 10 * time.Second
)
type ClientsHolder struct {
RestConfig *rest.Config
DynamicClient dynamic.Interface
ScalingClient scale.ScalesGetter
APIExtClient apiextv1.Interface
OlmClient olmClient.Interface
OcpClient clientconfigv1.ConfigV1Interface
K8sClient kubernetes.Interface
K8sNetworkingClient networkingv1.NetworkingV1Interface
CNCFNetworkingClient cncfNetworkAttachmentv1.K8sCniCncfIoV1Interface
MachineCfg ocpMachine.Interface
KubeConfig []byte
ready bool
GroupResources []*metav1.APIResourceList
}
var clientsHolder = ClientsHolder{}
// SetupFakeOlmClient Overrides the OLM client with the fake interface object for unit testing. Loads
// the mocking objects so olmv interface methods can find them.
func SetupFakeOlmClient(olmMockObjects []runtime.Object) {
clientsHolder.OlmClient = olmFakeClient.NewSimpleClientset(olmMockObjects...)
}
// GetTestClientHolder Overwrites the existing clientholders with a mocked version for unit testing.
// Only pure k8s interfaces will be available. The runtime objects must be pure k8s ones.
// For other (OLM, )
// runtime mocking objects loading, use the proper clientset mocking function.
func GetTestClientsHolder(k8sMockObjects []runtime.Object) *ClientsHolder {
// Build slices of different objects depending on what client
// is supposed to expect them.
var k8sClientObjects []runtime.Object
var k8sExtClientObjects []runtime.Object
for _, v := range k8sMockObjects {
// Based on what type of object is, populate certain object slices
// with what is supported by a certain client.
// Add more items below if/when needed.
switch v.(type) {
// K8s Client Objects
case *corev1.ServiceAccount:
k8sClientObjects = append(k8sClientObjects, v)
case *rbacv1.ClusterRole:
k8sClientObjects = append(k8sClientObjects, v)
case *rbacv1.ClusterRoleBinding:
k8sClientObjects = append(k8sClientObjects, v)
case *rbacv1.Role:
k8sClientObjects = append(k8sClientObjects, v)
case *rbacv1.RoleBinding:
k8sClientObjects = append(k8sClientObjects, v)
case *corev1.Pod:
k8sClientObjects = append(k8sClientObjects, v)
case *corev1.Service:
k8sClientObjects = append(k8sClientObjects, v)
case *corev1.Node:
k8sClientObjects = append(k8sClientObjects, v)
case *appsv1.Deployment:
k8sClientObjects = append(k8sClientObjects, v)
case *appsv1.StatefulSet:
k8sClientObjects = append(k8sClientObjects, v)
case *corev1.ResourceQuota:
k8sClientObjects = append(k8sClientObjects, v)
case *corev1.PersistentVolume:
k8sClientObjects = append(k8sClientObjects, v)
case *corev1.PersistentVolumeClaim:
k8sClientObjects = append(k8sClientObjects, v)
case *policyv1.PodDisruptionBudget:
k8sClientObjects = append(k8sClientObjects, v)
case *scalingv1.HorizontalPodAutoscaler:
k8sClientObjects = append(k8sClientObjects, v)
case *storagev1.StorageClass:
k8sClientObjects = append(k8sClientObjects, v)
// K8s Extension Client Objects
case *apiextv1c.CustomResourceDefinition:
k8sExtClientObjects = append(k8sExtClientObjects, v)
}
}
// Add the objects to their corresponding API Clients
clientsHolder.K8sClient = k8sFakeClient.NewSimpleClientset(k8sClientObjects...)
clientsHolder.APIExtClient = apiextv1fake.NewSimpleClientset(k8sExtClientObjects...)
clientsHolder.ready = true
return &clientsHolder
}
func SetTestK8sClientsHolder(k8sClient kubernetes.Interface) {
clientsHolder.K8sClient = k8sClient
clientsHolder.ready = true
}
func ClearTestClientsHolder() {
clientsHolder.K8sClient = nil
clientsHolder.ready = false
}
// GetClientsHolder returns the singleton ClientsHolder object.
func GetClientsHolder(filenames ...string) *ClientsHolder {
if clientsHolder.ready {
return &clientsHolder
}
if len(filenames) == 0 {
log.Fatal("Please provide a valid Kubeconfig. Either set the KUBECONFIG environment variable or alternatively copy a kube config to $HOME/.kube/config")
}
clientsHolder, err := newClientsHolder(filenames...)
if err != nil {
log.Fatal("Failed to create k8s clients holder, err: %v", err)
}
return clientsHolder
}
func GetNewClientsHolder(kubeconfigFile string) *ClientsHolder {
_, err := newClientsHolder(kubeconfigFile)
if err != nil {
log.Fatal("Failed to create k8s clients holder, err: %v", err)
}
return &clientsHolder
}
func createByteArrayKubeConfig(kubeConfig *clientcmdapi.Config) ([]byte, error) {
yamlBytes, err := clientcmd.Write(*kubeConfig)
if err != nil {
return nil, fmt.Errorf("failed to generate yaml bytes from kubeconfig: %w", err)
}
return yamlBytes, nil
}
// Creates a clientcmdapi.Config object from a rest.Config.
// Based on https://github.com/kubernetes/client-go/issues/711#issuecomment-1666075787
func GetClientConfigFromRestConfig(restConfig *rest.Config) *clientcmdapi.Config {
return &clientcmdapi.Config{
Kind: "Config",
APIVersion: "v1",
Clusters: map[string]*clientcmdapi.Cluster{
"default-cluster": {
Server: restConfig.Host,
CertificateAuthority: restConfig.TLSClientConfig.CAFile,
},
},
Contexts: map[string]*clientcmdapi.Context{
"default-context": {
Cluster: "default-cluster",
AuthInfo: "default-user",
},
},
CurrentContext: "default-context",
AuthInfos: map[string]*clientcmdapi.AuthInfo{
"default-user": {
Token: restConfig.BearerToken,
},
},
}
}
func getClusterRestConfig(filenames ...string) (*rest.Config, error) {
restConfig, err := rest.InClusterConfig()
if err == nil {
log.Info("CNF Cert Suite is running inside a cluster.")
// Convert restConfig to clientcmdapi.Config so we can get the kubeconfig "file" bytes
// needed by preflight's operator checks.
clientConfig := GetClientConfigFromRestConfig(restConfig)
clientsHolder.KubeConfig, err = createByteArrayKubeConfig(clientConfig)
if err != nil {
return nil, fmt.Errorf("failed to create byte array from kube config reference: %v", err)
}
// No error: we're inside a cluster.
return restConfig, nil
}
log.Info("Running outside a cluster. Parsing kubeconfig file/s %+v", filenames)
if len(filenames) == 0 {
return nil, errors.New("no kubeconfig files set")
}
// Get the rest.Config from the kubeconfig file/s.
precedence := []string{}
precedence = append(precedence, filenames...)
loadingRules := clientcmd.NewDefaultClientConfigLoadingRules()
loadingRules.Precedence = precedence
kubeconfig := clientcmd.NewNonInteractiveDeferredLoadingClientConfig(
loadingRules,
&clientcmd.ConfigOverrides{},
)
// Save merged config to temporary kubeconfig file.
kubeRawConfig, err := kubeconfig.RawConfig()
if err != nil {
return nil, fmt.Errorf("failed to get kube raw config: %w", err)
}
clientsHolder.KubeConfig, err = createByteArrayKubeConfig(&kubeRawConfig)
if err != nil {
return nil, fmt.Errorf("failed to byte array kube config reference: %w", err)
}
restConfig, err = kubeconfig.ClientConfig()
if err != nil {
return nil, fmt.Errorf("cannot instantiate rest config: %s", err)
}
return restConfig, nil
}
// GetClientsHolder instantiate an ocp client
func newClientsHolder(filenames ...string) (*ClientsHolder, error) { //nolint:funlen // this is a special function with lots of assignments
log.Info("Creating k8s go-clients holder.")
var err error
clientsHolder.RestConfig, err = getClusterRestConfig(filenames...)
if err != nil {
return nil, fmt.Errorf("failed to get rest.Config: %v", err)
}
clientsHolder.RestConfig.Timeout = DefaultTimeout
clientsHolder.DynamicClient, err = dynamic.NewForConfig(clientsHolder.RestConfig)
if err != nil {
return nil, fmt.Errorf("cannot instantiate dynamic client (unstructured/dynamic): %s", err)
}
clientsHolder.APIExtClient, err = apiextv1.NewForConfig(clientsHolder.RestConfig)
if err != nil {
return nil, fmt.Errorf("cannot instantiate apiextv1: %s", err)
}
clientsHolder.OlmClient, err = olmClient.NewForConfig(clientsHolder.RestConfig)
if err != nil {
return nil, fmt.Errorf("cannot instantiate olm clientset: %s", err)
}
clientsHolder.K8sClient, err = kubernetes.NewForConfig(clientsHolder.RestConfig)
if err != nil {
return nil, fmt.Errorf("cannot instantiate k8sclient: %s", err)
}
// create the oc client
clientsHolder.OcpClient, err = clientconfigv1.NewForConfig(clientsHolder.RestConfig)
if err != nil {
return nil, fmt.Errorf("cannot instantiate ocClient: %s", err)
}
clientsHolder.MachineCfg, err = ocpMachine.NewForConfig(clientsHolder.RestConfig)
if err != nil {
return nil, fmt.Errorf("cannot instantiate MachineCfg client: %s", err)
}
clientsHolder.K8sNetworkingClient, err = networkingv1.NewForConfig(clientsHolder.RestConfig)
if err != nil {
return nil, fmt.Errorf("cannot instantiate k8s networking client: %s", err)
}
discoveryClient, err := discovery.NewDiscoveryClientForConfig(clientsHolder.RestConfig)
if err != nil {
return nil, fmt.Errorf("cannot instantiate discoveryClient: %s", err)
}
clientsHolder.GroupResources, err = discoveryClient.ServerPreferredResources()
if err != nil {
return nil, fmt.Errorf("cannot get list of resources in cluster: %s", err)
}
resolver := scale.NewDiscoveryScaleKindResolver(discoveryClient)
gr, err := restmapper.GetAPIGroupResources(clientsHolder.K8sClient.Discovery())
if err != nil {
return nil, fmt.Errorf("cannot instantiate GetAPIGroupResources: %s", err)
}
mapper := restmapper.NewDiscoveryRESTMapper(gr)
clientsHolder.ScalingClient, err = scale.NewForConfig(clientsHolder.RestConfig, mapper, dynamic.LegacyAPIPathResolverFunc, resolver)
if err != nil {
return nil, fmt.Errorf("cannot instantiate ScalesGetter: %s", err)
}
clientsHolder.CNCFNetworkingClient, err = cncfNetworkAttachmentv1.NewForConfig(clientsHolder.RestConfig)
if err != nil {
return nil, fmt.Errorf("cannot instantiate CNCF networking client")
}
clientsHolder.ready = true
return &clientsHolder, nil
}
type Context struct {
namespace string
podName string
containerName string
}
func NewContext(namespace, podName, containerName string) Context {
return Context{
namespace: namespace,
podName: podName,
containerName: containerName,
}
}
func (c *Context) GetNamespace() string {
return c.namespace
}
func (c *Context) GetPodName() string {
return c.podName
}
func (c *Context) GetContainerName() string {
return c.containerName
}