pacoxu / kubernetes

Production-Grade Container Scheduling and Management
https://kubernetes.io
Apache License 2.0
2 stars 4 forks source link

[replace 0 with NoResyncPeriodFunc(] once it moved out pkg/controller/controller... #1739

Open github-actions[bot] opened 3 years ago

github-actions[bot] commented 3 years ago

[replace 0 with NoResyncPeriodFunc(] once it moved out pkg/controller/controller_utils.go in k/k.

https://github.com/pacoxu/kubernetes/blob/19f8624ecd4751bb1c5a01662c32364a0169337d/staging/src/k8s.io/legacy-cloud-providers/vsphere/credentialmanager_test.go#L212


/*
Copyright 2016 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 vsphere

import (
    "reflect"
    "strings"
    "testing"

    corev1 "k8s.io/api/core/v1"
    metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
    "k8s.io/apimachinery/pkg/labels"
    "k8s.io/client-go/informers"
    "k8s.io/client-go/kubernetes/fake"
)

func TestSecretCredentialManager_GetCredential(t *testing.T) {
    var (
        userKey             = "username"
        passwordKey         = "password"
        testUser            = "user"
        testPassword        = "password"
        testServer          = "0.0.0.0"
        testServer2         = "0.0.1.1"
        testServerFQIN      = "ExAmple.com"
        testUserServer2     = "user1"
        testPasswordServer2 = "password1"
        testIncorrectServer = "1.1.1.1"
    )
    var (
        secretName      = "vsconf"
        secretNamespace = "kube-system"
    )
    var (
        addSecretOp      = "ADD_SECRET_OP"
        getCredentialsOp = "GET_CREDENTIAL_OP"
        deleteSecretOp   = "DELETE_SECRET_OP"
    )
    type GetCredentialsTest struct {
        server   string
        username string
        password string
        err      error
    }
    type OpSecretTest struct {
        secret *corev1.Secret
    }
    type testEnv struct {
        testName       string
        ops            []string
        expectedValues []interface{}
    }

    client := &fake.Clientset{}
    metaObj := metav1.ObjectMeta{
        Name:      secretName,
        Namespace: secretNamespace,
    }

    defaultSecret := &corev1.Secret{
        ObjectMeta: metaObj,
        Data: map[string][]byte{
            testServer + "." + userKey:     []byte(testUser),
            testServer + "." + passwordKey: []byte(testPassword),
        },
    }

    multiVCSecret := &corev1.Secret{
        ObjectMeta: metaObj,
        Data: map[string][]byte{
            testServer + "." + userKey:      []byte(testUser),
            testServer + "." + passwordKey:  []byte(testPassword),
            testServer2 + "." + userKey:     []byte(testUserServer2),
            testServer2 + "." + passwordKey: []byte(testPasswordServer2),
        },
    }

    fqinSecret := &corev1.Secret{
        ObjectMeta: metaObj,
        Data: map[string][]byte{
            testServerFQIN + "." + userKey:     []byte(testUser),
            testServerFQIN + "." + passwordKey: []byte(testPassword),
        },
    }

    emptySecret := &corev1.Secret{
        ObjectMeta: metaObj,
        Data:       map[string][]byte{},
    }

    tests := []testEnv{
        {
            testName: "Deleting secret should give the credentials from cache",
            ops:      []string{addSecretOp, getCredentialsOp, deleteSecretOp, getCredentialsOp},
            expectedValues: []interface{}{
                OpSecretTest{
                    secret: defaultSecret,
                },
                GetCredentialsTest{
                    username: testUser,
                    password: testPassword,
                    server:   testServer,
                },
                OpSecretTest{
                    secret: defaultSecret,
                },
                GetCredentialsTest{
                    username: testUser,
                    password: testPassword,
                    server:   testServer,
                },
            },
        },
        {
            testName: "Add secret and get credentials",
            ops:      []string{addSecretOp, getCredentialsOp},
            expectedValues: []interface{}{
                OpSecretTest{
                    secret: defaultSecret,
                },
                GetCredentialsTest{
                    username: testUser,
                    password: testPassword,
                    server:   testServer,
                },
            },
        },
        {
            testName: "Getcredentials should fail by not adding at secret at first time",
            ops:      []string{getCredentialsOp},
            expectedValues: []interface{}{
                GetCredentialsTest{
                    username: testUser,
                    password: testPassword,
                    server:   testServer,
                    err:      ErrCredentialsNotFound,
                },
            },
        },
        {
            testName: "GetCredential should fail to get credentials from empty secrets",
            ops:      []string{addSecretOp, getCredentialsOp},
            expectedValues: []interface{}{
                OpSecretTest{
                    secret: emptySecret,
                },
                GetCredentialsTest{
                    server: testServer,
                    err:    ErrCredentialMissing,
                },
            },
        },
        {
            testName: "GetCredential should fail to get credentials for invalid server",
            ops:      []string{addSecretOp, getCredentialsOp},
            expectedValues: []interface{}{
                OpSecretTest{
                    secret: defaultSecret,
                },
                GetCredentialsTest{
                    server: testIncorrectServer,
                    err:    ErrCredentialsNotFound,
                },
            },
        },
        {
            testName: "GetCredential for multi-vc",
            ops:      []string{addSecretOp, getCredentialsOp},
            expectedValues: []interface{}{
                OpSecretTest{
                    secret: multiVCSecret,
                },
                GetCredentialsTest{
                    server:   testServer2,
                    username: testUserServer2,
                    password: testPasswordServer2,
                },
            },
        },
        {
            testName: "GetCredential for FQIN server name",
            ops:      []string{addSecretOp, getCredentialsOp},
            expectedValues: []interface{}{
                OpSecretTest{
                    fqinSecret,
                },
                GetCredentialsTest{
                    username: testUser,
                    password: testPassword,
                    server:   testServerFQIN,
                },
            },
        },
    }

    // TODO: replace 0 with NoResyncPeriodFunc() once it moved out pkg/controller/controller_utils.go in k/k.
    informerFactory := informers.NewSharedInformerFactory(client, 0)
    secretInformer := informerFactory.Core().V1().Secrets()
    secretCredentialManager := &SecretCredentialManager{
        SecretName:      secretName,
        SecretNamespace: secretNamespace,
        SecretLister:    secretInformer.Lister(),
        Cache: &SecretCache{
            VirtualCenter: make(map[string]*Credential),
        },
    }
    cleanupSecretCredentialManager := func() {
        secretCredentialManager.Cache.Secret = nil
        for key := range secretCredentialManager.Cache.VirtualCenter {
            delete(secretCredentialManager.Cache.VirtualCenter, key)
        }
        secrets, err := secretCredentialManager.SecretLister.List(labels.Everything())
        if err != nil {
            t.Fatal("Failed to get all secrets from sharedInformer. error: ", err)
        }
        for _, secret := range secrets {
            err := secretInformer.Informer().GetIndexer().Delete(secret)
            if err != nil {
                t.Fatalf("Failed to delete secret from informer: %v", err)
            }
        }
    }

    for _, test := range tests {
        t.Logf("Executing Testcase: %s", test.testName)
        for ntest, op := range test.ops {
            switch op {
            case addSecretOp:
                expected := test.expectedValues[ntest].(OpSecretTest)
                t.Logf("Adding secret: %s", expected.secret)
                err := secretInformer.Informer().GetIndexer().Add(expected.secret)
                if err != nil {
                    t.Fatalf("Failed to add secret to internal cache: %v", err)
                }
            case getCredentialsOp:
                expected := test.expectedValues[ntest].(GetCredentialsTest)
                credential, err := secretCredentialManager.GetCredential(expected.server)
                t.Logf("Retrieving credentials for server %s", expected.server)
                if err != expected.err {
                    t.Fatalf("Fail to get credentials with error: %v", err)
                }
                if expected.err == nil {
                    if expected.username != credential.User ||
                        expected.password != credential.Password {
                        t.Fatalf("Received credentials %v "+
                            "are different than actual credential user:%s password:%s", credential, expected.username,
                            expected.password)
                    }
                }
            case deleteSecretOp:
                expected := test.expectedValues[ntest].(OpSecretTest)
                t.Logf("Deleting secret: %s", expected.secret)
                err := secretInformer.Informer().GetIndexer().Delete(expected.secret)
                if err != nil {
                    t.Fatalf("Failed to delete secret to internal cache: %v", err)
                }
            }
        }
        cleanupSecretCredentialManager()
    }
}

func TestParseSecretConfig(t *testing.T) {
    var (
        testUsername   = "Admin"
        testPassword   = "Password"
        testIP         = "10.20.30.40"
        testServerFQIN = "ExAmple.com"
    )
    var testcases = []struct {
        testName      string
        data          map[string][]byte
        config        map[string]*Credential
        expectedError error
    }{
        {
            testName: "Valid username and password",
            data: map[string][]byte{
                "10.20.30.40.username": []byte(testUsername),
                "10.20.30.40.password": []byte(testPassword),
            },
            config: map[string]*Credential{
                testIP: {
                    User:     testUsername,
                    Password: testPassword,
                },
            },
            expectedError: nil,
        },
        {
            testName: "Invalid username key with valid password key",
            data: map[string][]byte{
                "10.20.30.40.usernam":  []byte(testUsername),
                "10.20.30.40.password": []byte(testPassword),
            },
            config:        nil,
            expectedError: ErrUnknownSecretKey,
        },
        {
            testName: "Missing username",
            data: map[string][]byte{
                "10.20.30.40.password": []byte(testPassword),
            },
            config: map[string]*Credential{
                testIP: {
                    Password: testPassword,
                },
            },
            expectedError: ErrCredentialMissing,
        },
        {
            testName: "Missing password",
            data: map[string][]byte{
                "10.20.30.40.username": []byte(testUsername),
            },
            config: map[string]*Credential{
                testIP: {
                    User: testUsername,
                },
            },
            expectedError: ErrCredentialMissing,
        },
        {
            testName: "FQIN stored as lowercase",
            data: map[string][]byte{
                testServerFQIN + ".username": []byte(testUsername),
                testServerFQIN + ".password": []byte(testPassword),
            },
            config: map[string]*Credential{
                strings.ToLower(testServerFQIN): {
                    User:     testUsername,
                    Password: testPassword,
                },
            },
            expectedError: nil,
        },
        {
            testName: "IP with unknown key",
            data: map[string][]byte{
                "10.20.30.40": []byte(testUsername),
            },
            config:        nil,
            expectedError: ErrUnknownSecretKey,
        },
    }

    resultConfig := make(map[string]*Credential)
    cleanupResultConfig := func(config map[string]*Credential) {
        for k := range config {
            delete(config, k)
        }
    }

    for _, testcase := range testcases {
        err := parseConfig(testcase.data, resultConfig)
        t.Logf("Executing Testcase: %s", testcase.testName)
        if err != testcase.expectedError {
            t.Fatalf("Parsing Secret failed for data %+v: %s", testcase.data, err)
        }
        if testcase.config != nil && !reflect.DeepEqual(testcase.config, resultConfig) {
            t.Fatalf("Parsing Secret failed for data %+v expected config %+v and actual config %+v",
                testcase.data, resultConfig, testcase.config)
        }
        cleanupResultConfig(resultConfig)
    }
}
ew file mode 100644
ndex 0000000000000..12c287753c608
++ b/staging/src/k8s.io/legacy-cloud-providers/vsphere/doc.go

315e249896136ae5ad69fcde724ab2ea44a1f996