/* Copyright 2014 The Kubernetes Authors All rights reserved. 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 status import ( "fmt" "math/rand" "strconv" "testing" "time" "github.com/stretchr/testify/assert" "k8s.io/kubernetes/pkg/api" "k8s.io/kubernetes/pkg/api/errors" "k8s.io/kubernetes/pkg/api/unversioned" client "k8s.io/kubernetes/pkg/client/unversioned" "k8s.io/kubernetes/pkg/client/unversioned/testclient" kubecontainer "k8s.io/kubernetes/pkg/kubelet/container" kubepod "k8s.io/kubernetes/pkg/kubelet/pod" kubetypes "k8s.io/kubernetes/pkg/kubelet/types" "k8s.io/kubernetes/pkg/runtime" ) var testPod *api.Pod = &api.Pod{ ObjectMeta: api.ObjectMeta{ UID: "12345678", Name: "foo", Namespace: "new", }, } func newTestManager(kubeClient client.Interface) *manager { podManager := kubepod.NewBasicPodManager(kubepod.NewFakeMirrorClient()) podManager.AddPod(testPod) return NewManager(kubeClient, podManager).(*manager) } func generateRandomMessage() string { return strconv.Itoa(rand.Int()) } func getRandomPodStatus() api.PodStatus { return api.PodStatus{ Message: generateRandomMessage(), } } func verifyActions(t *testing.T, kubeClient client.Interface, expectedActions []testclient.Action) { actions := kubeClient.(*testclient.Fake).Actions() if len(actions) != len(expectedActions) { t.Fatalf("unexpected actions, got: %s expected: %s", actions, expectedActions) return } for i := 0; i < len(actions); i++ { e := expectedActions[i] a := actions[i] if !a.Matches(e.GetVerb(), e.GetResource()) || a.GetSubresource() != e.GetSubresource() { t.Errorf("unexpected actions, got: %s expected: %s", actions, expectedActions) } } } func verifyUpdates(t *testing.T, manager *manager, expectedUpdates int) { // Consume all updates in the channel. numUpdates := 0 for { hasUpdate := true select { case <-manager.podStatusChannel: numUpdates++ default: hasUpdate = false } if !hasUpdate { break } } if numUpdates != expectedUpdates { t.Errorf("unexpected number of updates %d, expected %d", numUpdates, expectedUpdates) } } func TestNewStatus(t *testing.T) { syncer := newTestManager(&testclient.Fake{}) syncer.SetPodStatus(testPod, getRandomPodStatus()) verifyUpdates(t, syncer, 1) status, _ := syncer.GetPodStatus(testPod.UID) if status.StartTime.IsZero() { t.Errorf("SetPodStatus did not set a proper start time value") } } func TestNewStatusPreservesPodStartTime(t *testing.T) { syncer := newTestManager(&testclient.Fake{}) pod := &api.Pod{ ObjectMeta: api.ObjectMeta{ UID: "12345678", Name: "foo", Namespace: "new", }, Status: api.PodStatus{}, } now := unversioned.Now() startTime := unversioned.NewTime(now.Time.Add(-1 * time.Minute)) pod.Status.StartTime = &startTime syncer.SetPodStatus(pod, getRandomPodStatus()) status, _ := syncer.GetPodStatus(pod.UID) if !status.StartTime.Time.Equal(startTime.Time) { t.Errorf("Unexpected start time, expected %v, actual %v", startTime, status.StartTime) } } func getReadyPodStatus() api.PodStatus { return api.PodStatus{ Conditions: []api.PodCondition{ { Type: api.PodReady, Status: api.ConditionTrue, }, }, } } func TestNewStatusSetsReadyTransitionTime(t *testing.T) { syncer := newTestManager(&testclient.Fake{}) podStatus := getReadyPodStatus() pod := &api.Pod{ ObjectMeta: api.ObjectMeta{ UID: "12345678", Name: "foo", Namespace: "new", }, Status: api.PodStatus{}, } syncer.SetPodStatus(pod, podStatus) verifyUpdates(t, syncer, 1) status, _ := syncer.GetPodStatus(pod.UID) readyCondition := api.GetPodReadyCondition(status) if readyCondition.LastTransitionTime.IsZero() { t.Errorf("Unexpected: last transition time not set") } } func TestChangedStatus(t *testing.T) { syncer := newTestManager(&testclient.Fake{}) syncer.SetPodStatus(testPod, getRandomPodStatus()) syncer.SetPodStatus(testPod, getRandomPodStatus()) verifyUpdates(t, syncer, 2) } func TestChangedStatusKeepsStartTime(t *testing.T) { syncer := newTestManager(&testclient.Fake{}) now := unversioned.Now() firstStatus := getRandomPodStatus() firstStatus.StartTime = &now syncer.SetPodStatus(testPod, firstStatus) syncer.SetPodStatus(testPod, getRandomPodStatus()) verifyUpdates(t, syncer, 2) finalStatus, _ := syncer.GetPodStatus(testPod.UID) if finalStatus.StartTime.IsZero() { t.Errorf("StartTime should not be zero") } if !finalStatus.StartTime.Time.Equal(now.Time) { t.Errorf("Expected %v, but got %v", now.Time, finalStatus.StartTime.Time) } } func TestChangedStatusUpdatesLastTransitionTime(t *testing.T) { syncer := newTestManager(&testclient.Fake{}) podStatus := getReadyPodStatus() pod := &api.Pod{ ObjectMeta: api.ObjectMeta{ UID: "12345678", Name: "foo", Namespace: "new", }, Status: api.PodStatus{}, } syncer.SetPodStatus(pod, podStatus) verifyUpdates(t, syncer, 1) oldStatus, _ := syncer.GetPodStatus(pod.UID) anotherStatus := getReadyPodStatus() anotherStatus.Conditions[0].Status = api.ConditionFalse syncer.SetPodStatus(pod, anotherStatus) verifyUpdates(t, syncer, 1) newStatus, _ := syncer.GetPodStatus(pod.UID) oldReadyCondition := api.GetPodReadyCondition(oldStatus) newReadyCondition := api.GetPodReadyCondition(newStatus) if newReadyCondition.LastTransitionTime.IsZero() { t.Errorf("Unexpected: last transition time not set") } if !oldReadyCondition.LastTransitionTime.Before(newReadyCondition.LastTransitionTime) { t.Errorf("Unexpected: new transition time %s, is not after old transition time %s", newReadyCondition.LastTransitionTime, oldReadyCondition.LastTransitionTime) } } func TestUnchangedStatus(t *testing.T) { syncer := newTestManager(&testclient.Fake{}) podStatus := getRandomPodStatus() syncer.SetPodStatus(testPod, podStatus) syncer.SetPodStatus(testPod, podStatus) verifyUpdates(t, syncer, 1) } func TestUnchangedStatusPreservesLastTransitionTime(t *testing.T) { syncer := newTestManager(&testclient.Fake{}) podStatus := getReadyPodStatus() pod := &api.Pod{ ObjectMeta: api.ObjectMeta{ UID: "12345678", Name: "foo", Namespace: "new", }, Status: api.PodStatus{}, } syncer.SetPodStatus(pod, podStatus) verifyUpdates(t, syncer, 1) oldStatus, _ := syncer.GetPodStatus(pod.UID) anotherStatus := getReadyPodStatus() syncer.SetPodStatus(pod, anotherStatus) // No update. verifyUpdates(t, syncer, 0) newStatus, _ := syncer.GetPodStatus(pod.UID) oldReadyCondition := api.GetPodReadyCondition(oldStatus) newReadyCondition := api.GetPodReadyCondition(newStatus) if newReadyCondition.LastTransitionTime.IsZero() { t.Errorf("Unexpected: last transition time not set") } if !oldReadyCondition.LastTransitionTime.Equal(newReadyCondition.LastTransitionTime) { t.Errorf("Unexpected: new transition time %s, is not equal to old transition time %s", newReadyCondition.LastTransitionTime, oldReadyCondition.LastTransitionTime) } } func TestSyncBatchIgnoresNotFound(t *testing.T) { client := testclient.Fake{} syncer := newTestManager(&client) client.AddReactor("get", "pods", func(action testclient.Action) (bool, runtime.Object, error) { return true, nil, errors.NewNotFound("pods", "test-pod") }) syncer.SetPodStatus(testPod, getRandomPodStatus()) syncer.syncBatch() verifyActions(t, syncer.kubeClient, []testclient.Action{ testclient.GetActionImpl{ActionImpl: testclient.ActionImpl{Verb: "get", Resource: "pods"}}, }) _, found := syncer.GetPodStatus(testPod.UID) assert.False(t, found, "Pod status should have been deleted") } func TestSyncBatch(t *testing.T) { syncer := newTestManager(&testclient.Fake{}) syncer.kubeClient = testclient.NewSimpleFake(testPod) syncer.SetPodStatus(testPod, getRandomPodStatus()) syncer.syncBatch() verifyActions(t, syncer.kubeClient, []testclient.Action{ testclient.GetActionImpl{ActionImpl: testclient.ActionImpl{Verb: "get", Resource: "pods"}}, testclient.UpdateActionImpl{ActionImpl: testclient.ActionImpl{Verb: "update", Resource: "pods", Subresource: "status"}}, }, ) } func TestSyncBatchChecksMismatchedUID(t *testing.T) { syncer := newTestManager(&testclient.Fake{}) pod := *testPod pod.UID = "first" syncer.podManager.AddPod(&pod) differentPod := *testPod differentPod.UID = "second" syncer.podManager.AddPod(&differentPod) syncer.kubeClient = testclient.NewSimpleFake(&pod) syncer.SetPodStatus(&differentPod, getRandomPodStatus()) syncer.syncBatch() verifyActions(t, syncer.kubeClient, []testclient.Action{ testclient.GetActionImpl{ActionImpl: testclient.ActionImpl{Verb: "get", Resource: "pods"}}, }) } func TestSyncBatchNoDeadlock(t *testing.T) { client := &testclient.Fake{} m := newTestManager(client) // Setup fake client. var ret api.Pod var err error client.AddReactor("*", "pods", func(action testclient.Action) (bool, runtime.Object, error) { switch action := action.(type) { case testclient.GetAction: assert.Equal(t, testPod.Name, action.GetName(), "Unexpeted GetAction: %+v", action) case testclient.UpdateAction: assert.Equal(t, testPod.Name, action.GetObject().(*api.Pod).Name, "Unexpeted UpdateAction: %+v", action) default: assert.Fail(t, "Unexpected Action: %+v", action) } return true, &ret, err }) pod := new(api.Pod) *pod = *testPod pod.Status.ContainerStatuses = []api.ContainerStatus{{State: api.ContainerState{Running: &api.ContainerStateRunning{}}}} getAction := testclient.GetActionImpl{ActionImpl: testclient.ActionImpl{Verb: "get", Resource: "pods"}} updateAction := testclient.UpdateActionImpl{ActionImpl: testclient.ActionImpl{Verb: "update", Resource: "pods", Subresource: "status"}} // Pod not found. ret = *pod err = errors.NewNotFound("pods", pod.Name) m.SetPodStatus(pod, getRandomPodStatus()) m.syncBatch() verifyActions(t, client, []testclient.Action{getAction}) client.ClearActions() // Pod was recreated. ret.UID = "other_pod" err = nil m.SetPodStatus(pod, getRandomPodStatus()) m.syncBatch() verifyActions(t, client, []testclient.Action{getAction}) client.ClearActions() // Pod not deleted (success case). ret = *pod m.SetPodStatus(pod, getRandomPodStatus()) m.syncBatch() verifyActions(t, client, []testclient.Action{getAction, updateAction}) client.ClearActions() // Pod is terminated, but still running. pod.DeletionTimestamp = new(unversioned.Time) m.SetPodStatus(pod, getRandomPodStatus()) m.syncBatch() verifyActions(t, client, []testclient.Action{getAction, updateAction}) client.ClearActions() // Pod is terminated successfully. pod.Status.ContainerStatuses[0].State.Running = nil pod.Status.ContainerStatuses[0].State.Terminated = &api.ContainerStateTerminated{} m.SetPodStatus(pod, getRandomPodStatus()) m.syncBatch() verifyActions(t, client, []testclient.Action{getAction, updateAction}) client.ClearActions() // Error case. err = fmt.Errorf("intentional test error") m.SetPodStatus(pod, getRandomPodStatus()) m.syncBatch() verifyActions(t, client, []testclient.Action{getAction}) client.ClearActions() } func TestStaleUpdates(t *testing.T) { pod := *testPod client := testclient.NewSimpleFake(&pod) m := newTestManager(client) status := api.PodStatus{Message: "initial status"} m.SetPodStatus(&pod, status) status.Message = "first version bump" m.SetPodStatus(&pod, status) status.Message = "second version bump" m.SetPodStatus(&pod, status) verifyUpdates(t, m, 3) t.Logf("First sync pushes latest status.") m.syncBatch() verifyActions(t, m.kubeClient, []testclient.Action{ testclient.GetActionImpl{ActionImpl: testclient.ActionImpl{Verb: "get", Resource: "pods"}}, testclient.UpdateActionImpl{ActionImpl: testclient.ActionImpl{Verb: "update", Resource: "pods", Subresource: "status"}}, }) client.ClearActions() for i := 0; i < 2; i++ { t.Logf("Next 2 syncs should be ignored (%d).", i) m.syncBatch() verifyActions(t, m.kubeClient, []testclient.Action{}) } t.Log("Unchanged status should not send an update.") m.SetPodStatus(&pod, status) verifyUpdates(t, m, 0) t.Log("... unless it's stale.") m.apiStatusVersions[pod.UID] = m.apiStatusVersions[pod.UID] - 1 m.SetPodStatus(&pod, status) m.syncBatch() verifyActions(t, m.kubeClient, []testclient.Action{ testclient.GetActionImpl{ActionImpl: testclient.ActionImpl{Verb: "get", Resource: "pods"}}, testclient.UpdateActionImpl{ActionImpl: testclient.ActionImpl{Verb: "update", Resource: "pods", Subresource: "status"}}, }) // Nothing stuck in the pipe. verifyUpdates(t, m, 0) } // shuffle returns a new shuffled list of container statuses. func shuffle(statuses []api.ContainerStatus) []api.ContainerStatus { numStatuses := len(statuses) randIndexes := rand.Perm(numStatuses) shuffled := make([]api.ContainerStatus, numStatuses) for i := 0; i < numStatuses; i++ { shuffled[i] = statuses[randIndexes[i]] } return shuffled } func TestStatusEquality(t *testing.T) { containerStatus := []api.ContainerStatus{} for i := 0; i < 10; i++ { s := api.ContainerStatus{ Name: fmt.Sprintf("container%d", i), } containerStatus = append(containerStatus, s) } podStatus := api.PodStatus{ ContainerStatuses: containerStatus, } for i := 0; i < 10; i++ { oldPodStatus := api.PodStatus{ ContainerStatuses: shuffle(podStatus.ContainerStatuses), } if !isStatusEqual(&oldPodStatus, &podStatus) { t.Fatalf("Order of container statuses should not affect equality.") } } } func TestStaticPodStatus(t *testing.T) { staticPod := *testPod staticPod.Annotations = map[string]string{kubetypes.ConfigSourceAnnotationKey: "file"} mirrorPod := *testPod mirrorPod.UID = "mirror-12345678" mirrorPod.Annotations = map[string]string{ kubetypes.ConfigSourceAnnotationKey: "api", kubetypes.ConfigMirrorAnnotationKey: "mirror", } client := testclient.NewSimpleFake(&mirrorPod) m := newTestManager(client) m.podManager.AddPod(&staticPod) m.podManager.AddPod(&mirrorPod) // Verify setup. assert.True(t, kubepod.IsStaticPod(&staticPod), "SetUp error: staticPod") assert.True(t, kubepod.IsMirrorPod(&mirrorPod), "SetUp error: mirrorPod") assert.Equal(t, m.podManager.TranslatePodUID(mirrorPod.UID), staticPod.UID) status := getRandomPodStatus() now := unversioned.Now() status.StartTime = &now m.SetPodStatus(&staticPod, status) retrievedStatus, _ := m.GetPodStatus(staticPod.UID) assert.True(t, isStatusEqual(&status, &retrievedStatus), "Expected: %+v, Got: %+v", status, retrievedStatus) retrievedStatus, _ = m.GetPodStatus(mirrorPod.UID) assert.True(t, isStatusEqual(&status, &retrievedStatus), "Expected: %+v, Got: %+v", status, retrievedStatus) // Should translate mirrorPod / staticPod UID. m.syncBatch() verifyActions(t, m.kubeClient, []testclient.Action{ testclient.GetActionImpl{ActionImpl: testclient.ActionImpl{Verb: "get", Resource: "pods"}}, testclient.UpdateActionImpl{ActionImpl: testclient.ActionImpl{Verb: "update", Resource: "pods", Subresource: "status"}}, }) updateAction := client.Actions()[1].(testclient.UpdateActionImpl) updatedPod := updateAction.Object.(*api.Pod) assert.Equal(t, mirrorPod.UID, updatedPod.UID, "Expected mirrorPod (%q), but got %q", mirrorPod.UID, updatedPod.UID) assert.True(t, isStatusEqual(&status, &updatedPod.Status), "Expected: %+v, Got: %+v", status, updatedPod.Status) client.ClearActions() // No changes. m.syncBatch() verifyActions(t, m.kubeClient, []testclient.Action{}) // Mirror pod identity changes. m.podManager.DeletePod(&mirrorPod) mirrorPod.UID = "new-mirror-pod" mirrorPod.Status = api.PodStatus{} m.podManager.AddPod(&mirrorPod) // Expect update to new mirrorPod. m.syncBatch() verifyActions(t, m.kubeClient, []testclient.Action{ testclient.GetActionImpl{ActionImpl: testclient.ActionImpl{Verb: "get", Resource: "pods"}}, testclient.UpdateActionImpl{ActionImpl: testclient.ActionImpl{Verb: "update", Resource: "pods", Subresource: "status"}}, }) updateAction = client.Actions()[1].(testclient.UpdateActionImpl) updatedPod = updateAction.Object.(*api.Pod) assert.Equal(t, mirrorPod.UID, updatedPod.UID, "Expected mirrorPod (%q), but got %q", mirrorPod.UID, updatedPod.UID) assert.True(t, isStatusEqual(&status, &updatedPod.Status), "Expected: %+v, Got: %+v", status, updatedPod.Status) } func TestSetContainerReadiness(t *testing.T) { containerID := kubecontainer.ContainerID{"test", "cOnTaInEr_Id"} containerStatus := api.ContainerStatus{ Name: "cOnTaInEr_NaMe", ContainerID: containerID.String(), Ready: false, } status := api.PodStatus{ ContainerStatuses: []api.ContainerStatus{containerStatus}, } m := newTestManager(&testclient.Fake{}) t.Log("Setting readiness before status should fail.") m.SetContainerReadiness(testPod, containerID, true) verifyUpdates(t, m, 0) t.Log("Setting initial status.") m.SetPodStatus(testPod, status) verifyUpdates(t, m, 1) t.Log("Setting unchanged readiness should do nothing.") m.SetContainerReadiness(testPod, containerID, false) verifyUpdates(t, m, 0) t.Log("Setting different readiness should generate update.") m.SetContainerReadiness(testPod, containerID, true) verifyUpdates(t, m, 1) t.Log("Setting non-existant container readiness should fail.") m.SetContainerReadiness(testPod, kubecontainer.ContainerID{"test", "foo"}, true) verifyUpdates(t, m, 0) } func TestSyncBatchCleanupVersions(t *testing.T) { m := newTestManager(&testclient.Fake{}) mirrorPod := *testPod mirrorPod.UID = "mirror-uid" mirrorPod.Name = "mirror_pod" mirrorPod.Annotations = map[string]string{ kubetypes.ConfigSourceAnnotationKey: "api", kubetypes.ConfigMirrorAnnotationKey: "mirror", } // Orphaned pods should be removed. m.apiStatusVersions[testPod.UID] = 100 m.apiStatusVersions[mirrorPod.UID] = 200 m.syncBatch() if _, ok := m.apiStatusVersions[testPod.UID]; ok { t.Errorf("Should have cleared status for testPod") } if _, ok := m.apiStatusVersions[mirrorPod.UID]; ok { t.Errorf("Should have cleared status for mirrorPod") } // Non-orphaned pods should not be removed. m.SetPodStatus(testPod, getRandomPodStatus()) m.podManager.AddPod(&mirrorPod) staticPod := mirrorPod staticPod.UID = "static-uid" staticPod.Annotations = map[string]string{kubetypes.ConfigSourceAnnotationKey: "file"} m.podManager.AddPod(&staticPod) m.apiStatusVersions[testPod.UID] = 100 m.apiStatusVersions[mirrorPod.UID] = 200 m.syncBatch() if _, ok := m.apiStatusVersions[testPod.UID]; !ok { t.Errorf("Should not have cleared status for testPod") } if _, ok := m.apiStatusVersions[mirrorPod.UID]; !ok { t.Errorf("Should not have cleared status for mirrorPod") } }