The idempotency.go (perhaps not so accurately named) contains API calls that kubeadm does against an API server using client-go. Some users seem to have unstable setups where for unknown reasons the API server can be unavailable or refuse to respond as expected. Use PollUntilContextTimeout in all exported functions to ensure such API calls are all retry-able. NOTE: The context passed to PollUntilContextTimeout is not propagated in the polled function. Instead the poll function creates it's own context 'ctx := context.Background()', this is to avoid breaking expectations on the side of the callers, that expect a certain type of error and not "context timeout" errors. Additional changes: - Make all context.TODO() -> context.Background() - Update all unit tests and make sure during testing the retry interval and timeout are short. Test coverage of idempotency.go is at ~97%. - Remove the TestMutateConfigMapWithConflict test. It does not contribute much, because conflict handling is done at the API, server side, not on the side of kubeadm. This simulating this is not needed.
209 lines
5.3 KiB
Go
209 lines
5.3 KiB
Go
/*
|
|
Copyright 2017 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 clusterinfo
|
|
|
|
import (
|
|
"context"
|
|
"os"
|
|
"testing"
|
|
"text/template"
|
|
"time"
|
|
|
|
rbac "k8s.io/api/rbac/v1"
|
|
apierrors "k8s.io/apimachinery/pkg/api/errors"
|
|
metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
|
|
"k8s.io/apimachinery/pkg/runtime"
|
|
"k8s.io/apimachinery/pkg/runtime/schema"
|
|
"k8s.io/apiserver/pkg/authentication/user"
|
|
clientsetfake "k8s.io/client-go/kubernetes/fake"
|
|
core "k8s.io/client-go/testing"
|
|
bootstrapapi "k8s.io/cluster-bootstrap/token/api"
|
|
|
|
kubeadmapi "k8s.io/kubernetes/cmd/kubeadm/app/apis/kubeadm"
|
|
)
|
|
|
|
var testConfigTempl = template.Must(template.New("test").Parse(`apiVersion: v1
|
|
clusters:
|
|
- cluster:
|
|
server: {{.Server}}
|
|
name: kubernetes
|
|
contexts:
|
|
- context:
|
|
cluster: kubernetes
|
|
user: kubernetes-admin
|
|
name: kubernetes-admin@kubernetes
|
|
current-context: kubernetes-admin@kubernetes
|
|
kind: Config
|
|
preferences: {}
|
|
users:
|
|
- name: kubernetes-admin`))
|
|
|
|
func TestCreateBootstrapConfigMapIfNotExists(t *testing.T) {
|
|
tests := []struct {
|
|
name string
|
|
fileExist bool
|
|
createErr error
|
|
expectErr bool
|
|
}{
|
|
{
|
|
"successful case should have no error",
|
|
true,
|
|
nil,
|
|
false,
|
|
},
|
|
{
|
|
"if configmap already exists, return error",
|
|
true,
|
|
apierrors.NewAlreadyExists(schema.GroupResource{Resource: "configmaps"}, "test"),
|
|
true,
|
|
},
|
|
{
|
|
"unexpected error should be returned",
|
|
true,
|
|
apierrors.NewUnauthorized("go away!"),
|
|
true,
|
|
},
|
|
{
|
|
"if the file does not exist, return error",
|
|
false,
|
|
nil,
|
|
true,
|
|
},
|
|
}
|
|
|
|
servers := []struct {
|
|
Server string
|
|
}{
|
|
{Server: "https://10.128.0.6:6443"},
|
|
{Server: "https://[2001:db8::6]:3446"},
|
|
}
|
|
|
|
for _, server := range servers {
|
|
file, err := os.CreateTemp("", "")
|
|
if err != nil {
|
|
t.Fatalf("could not create tempfile: %v", err)
|
|
}
|
|
defer os.Remove(file.Name())
|
|
|
|
if err := testConfigTempl.Execute(file, server); err != nil {
|
|
t.Fatalf("could not write to tempfile: %v", err)
|
|
}
|
|
|
|
if err := file.Close(); err != nil {
|
|
t.Fatalf("could not close tempfile: %v", err)
|
|
}
|
|
|
|
// Override the default timeouts to be shorter
|
|
defaultTimeouts := kubeadmapi.GetActiveTimeouts()
|
|
defaultAPICallTimeout := defaultTimeouts.KubernetesAPICall
|
|
defaultTimeouts.KubernetesAPICall = &metav1.Duration{Duration: time.Microsecond * 500}
|
|
defer func() {
|
|
defaultTimeouts.KubernetesAPICall = defaultAPICallTimeout
|
|
}()
|
|
|
|
for _, tc := range tests {
|
|
t.Run(tc.name, func(t *testing.T) {
|
|
client := clientsetfake.NewSimpleClientset()
|
|
if tc.createErr != nil {
|
|
client.PrependReactor("create", "configmaps", func(action core.Action) (bool, runtime.Object, error) {
|
|
return true, nil, tc.createErr
|
|
})
|
|
}
|
|
|
|
fileName := file.Name()
|
|
if !tc.fileExist {
|
|
fileName = "notexistfile"
|
|
}
|
|
err := CreateBootstrapConfigMapIfNotExists(client, fileName)
|
|
if tc.expectErr && err == nil {
|
|
t.Errorf("CreateBootstrapConfigMapIfNotExists(%s) wanted error, got nil", tc.name)
|
|
} else if !tc.expectErr && err != nil {
|
|
t.Errorf("CreateBootstrapConfigMapIfNotExists(%s) returned unexpected error: %v", tc.name, err)
|
|
}
|
|
})
|
|
}
|
|
}
|
|
}
|
|
|
|
func TestCreateClusterInfoRBACRules(t *testing.T) {
|
|
tests := []struct {
|
|
name string
|
|
client *clientsetfake.Clientset
|
|
}{
|
|
{
|
|
name: "the RBAC rules already exist",
|
|
client: newMockClientForTest(t),
|
|
},
|
|
{
|
|
name: "the RBAC rules do not exist",
|
|
client: clientsetfake.NewSimpleClientset(),
|
|
},
|
|
}
|
|
for _, tt := range tests {
|
|
t.Run(tt.name, func(t *testing.T) {
|
|
if err := CreateClusterInfoRBACRules(tt.client); err != nil {
|
|
t.Errorf("CreateClusterInfoRBACRules() hits unexpected error: %v", err)
|
|
}
|
|
})
|
|
}
|
|
}
|
|
|
|
func newMockClientForTest(t *testing.T) *clientsetfake.Clientset {
|
|
client := clientsetfake.NewSimpleClientset()
|
|
|
|
_, err := client.RbacV1().Roles(metav1.NamespacePublic).Create(context.TODO(), &rbac.Role{
|
|
ObjectMeta: metav1.ObjectMeta{
|
|
Name: BootstrapSignerClusterRoleName,
|
|
Namespace: metav1.NamespacePublic,
|
|
},
|
|
Rules: []rbac.PolicyRule{
|
|
{
|
|
Verbs: []string{"get"},
|
|
APIGroups: []string{""},
|
|
Resources: []string{"Secret"},
|
|
ResourceNames: []string{bootstrapapi.ConfigMapClusterInfo},
|
|
},
|
|
},
|
|
}, metav1.CreateOptions{})
|
|
if err != nil {
|
|
t.Fatalf("error creating role: %v", err)
|
|
}
|
|
|
|
_, err = client.RbacV1().RoleBindings(metav1.NamespacePublic).Create(context.TODO(), &rbac.RoleBinding{
|
|
ObjectMeta: metav1.ObjectMeta{
|
|
Name: BootstrapSignerClusterRoleName,
|
|
Namespace: metav1.NamespacePublic,
|
|
},
|
|
RoleRef: rbac.RoleRef{
|
|
APIGroup: rbac.GroupName,
|
|
Kind: "Role",
|
|
Name: BootstrapSignerClusterRoleName,
|
|
},
|
|
Subjects: []rbac.Subject{
|
|
{
|
|
Kind: rbac.UserKind,
|
|
Name: user.Anonymous,
|
|
},
|
|
},
|
|
}, metav1.CreateOptions{})
|
|
if err != nil {
|
|
t.Fatalf("error creating rolebinding: %v", err)
|
|
}
|
|
|
|
return client
|
|
}
|