kuberuntime_manager_test.go 47 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346
  1. /*
  2. Copyright 2016 The Kubernetes Authors.
  3. Licensed under the Apache License, Version 2.0 (the "License");
  4. you may not use this file except in compliance with the License.
  5. You may obtain a copy of the License at
  6. http://www.apache.org/licenses/LICENSE-2.0
  7. Unless required by applicable law or agreed to in writing, software
  8. distributed under the License is distributed on an "AS IS" BASIS,
  9. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  10. See the License for the specific language governing permissions and
  11. limitations under the License.
  12. */
  13. package kuberuntime
  14. import (
  15. "path/filepath"
  16. "reflect"
  17. "sort"
  18. "testing"
  19. "time"
  20. cadvisorapi "github.com/google/cadvisor/info/v1"
  21. "github.com/stretchr/testify/assert"
  22. "github.com/stretchr/testify/require"
  23. v1 "k8s.io/api/core/v1"
  24. metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
  25. "k8s.io/apimachinery/pkg/types"
  26. "k8s.io/apimachinery/pkg/util/sets"
  27. utilfeature "k8s.io/apiserver/pkg/util/feature"
  28. "k8s.io/client-go/util/flowcontrol"
  29. featuregatetesting "k8s.io/component-base/featuregate/testing"
  30. runtimeapi "k8s.io/cri-api/pkg/apis/runtime/v1alpha2"
  31. apitest "k8s.io/cri-api/pkg/apis/testing"
  32. podutil "k8s.io/kubernetes/pkg/api/v1/pod"
  33. "k8s.io/kubernetes/pkg/credentialprovider"
  34. "k8s.io/kubernetes/pkg/features"
  35. kubecontainer "k8s.io/kubernetes/pkg/kubelet/container"
  36. containertest "k8s.io/kubernetes/pkg/kubelet/container/testing"
  37. proberesults "k8s.io/kubernetes/pkg/kubelet/prober/results"
  38. )
  39. var (
  40. fakeCreatedAt int64 = 1
  41. )
  42. func createTestRuntimeManager() (*apitest.FakeRuntimeService, *apitest.FakeImageService, *kubeGenericRuntimeManager, error) {
  43. return customTestRuntimeManager(&credentialprovider.BasicDockerKeyring{})
  44. }
  45. func customTestRuntimeManager(keyring *credentialprovider.BasicDockerKeyring) (*apitest.FakeRuntimeService, *apitest.FakeImageService, *kubeGenericRuntimeManager, error) {
  46. fakeRuntimeService := apitest.NewFakeRuntimeService()
  47. fakeImageService := apitest.NewFakeImageService()
  48. // Only an empty machineInfo is needed here, because in unit test all containers are besteffort,
  49. // data in machineInfo is not used. If burstable containers are used in unit test in the future,
  50. // we may want to set memory capacity.
  51. machineInfo := &cadvisorapi.MachineInfo{}
  52. osInterface := &containertest.FakeOS{}
  53. manager, err := newFakeKubeRuntimeManager(fakeRuntimeService, fakeImageService, machineInfo, osInterface, &containertest.FakeRuntimeHelper{}, keyring)
  54. return fakeRuntimeService, fakeImageService, manager, err
  55. }
  56. // sandboxTemplate is a sandbox template to create fake sandbox.
  57. type sandboxTemplate struct {
  58. pod *v1.Pod
  59. attempt uint32
  60. createdAt int64
  61. state runtimeapi.PodSandboxState
  62. }
  63. // containerTemplate is a container template to create fake container.
  64. type containerTemplate struct {
  65. pod *v1.Pod
  66. container *v1.Container
  67. sandboxAttempt uint32
  68. attempt int
  69. createdAt int64
  70. state runtimeapi.ContainerState
  71. }
  72. // makeAndSetFakePod is a helper function to create and set one fake sandbox for a pod and
  73. // one fake container for each of its container.
  74. func makeAndSetFakePod(t *testing.T, m *kubeGenericRuntimeManager, fakeRuntime *apitest.FakeRuntimeService,
  75. pod *v1.Pod) (*apitest.FakePodSandbox, []*apitest.FakeContainer) {
  76. sandbox := makeFakePodSandbox(t, m, sandboxTemplate{
  77. pod: pod,
  78. createdAt: fakeCreatedAt,
  79. state: runtimeapi.PodSandboxState_SANDBOX_READY,
  80. })
  81. var containers []*apitest.FakeContainer
  82. newTemplate := func(c *v1.Container) containerTemplate {
  83. return containerTemplate{
  84. pod: pod,
  85. container: c,
  86. createdAt: fakeCreatedAt,
  87. state: runtimeapi.ContainerState_CONTAINER_RUNNING,
  88. }
  89. }
  90. podutil.VisitContainers(&pod.Spec, func(c *v1.Container) bool {
  91. containers = append(containers, makeFakeContainer(t, m, newTemplate(c)))
  92. return true
  93. })
  94. fakeRuntime.SetFakeSandboxes([]*apitest.FakePodSandbox{sandbox})
  95. fakeRuntime.SetFakeContainers(containers)
  96. return sandbox, containers
  97. }
  98. // makeFakePodSandbox creates a fake pod sandbox based on a sandbox template.
  99. func makeFakePodSandbox(t *testing.T, m *kubeGenericRuntimeManager, template sandboxTemplate) *apitest.FakePodSandbox {
  100. config, err := m.generatePodSandboxConfig(template.pod, template.attempt)
  101. assert.NoError(t, err, "generatePodSandboxConfig for sandbox template %+v", template)
  102. podSandboxID := apitest.BuildSandboxName(config.Metadata)
  103. podSandBoxStatus := &apitest.FakePodSandbox{
  104. PodSandboxStatus: runtimeapi.PodSandboxStatus{
  105. Id: podSandboxID,
  106. Metadata: config.Metadata,
  107. State: template.state,
  108. CreatedAt: template.createdAt,
  109. Network: &runtimeapi.PodSandboxNetworkStatus{
  110. Ip: apitest.FakePodSandboxIPs[0],
  111. },
  112. Labels: config.Labels,
  113. },
  114. }
  115. // assign additional IPs
  116. additionalIPs := apitest.FakePodSandboxIPs[1:]
  117. additionalPodIPs := make([]*runtimeapi.PodIP, 0, len(additionalIPs))
  118. for _, ip := range additionalIPs {
  119. additionalPodIPs = append(additionalPodIPs, &runtimeapi.PodIP{
  120. Ip: ip,
  121. })
  122. }
  123. podSandBoxStatus.Network.AdditionalIps = additionalPodIPs
  124. return podSandBoxStatus
  125. }
  126. // makeFakePodSandboxes creates a group of fake pod sandboxes based on the sandbox templates.
  127. // The function guarantees the order of the fake pod sandboxes is the same with the templates.
  128. func makeFakePodSandboxes(t *testing.T, m *kubeGenericRuntimeManager, templates []sandboxTemplate) []*apitest.FakePodSandbox {
  129. var fakePodSandboxes []*apitest.FakePodSandbox
  130. for _, template := range templates {
  131. fakePodSandboxes = append(fakePodSandboxes, makeFakePodSandbox(t, m, template))
  132. }
  133. return fakePodSandboxes
  134. }
  135. // makeFakeContainer creates a fake container based on a container template.
  136. func makeFakeContainer(t *testing.T, m *kubeGenericRuntimeManager, template containerTemplate) *apitest.FakeContainer {
  137. sandboxConfig, err := m.generatePodSandboxConfig(template.pod, template.sandboxAttempt)
  138. assert.NoError(t, err, "generatePodSandboxConfig for container template %+v", template)
  139. containerConfig, _, err := m.generateContainerConfig(template.container, template.pod, template.attempt, "", template.container.Image, []string{}, nil)
  140. assert.NoError(t, err, "generateContainerConfig for container template %+v", template)
  141. podSandboxID := apitest.BuildSandboxName(sandboxConfig.Metadata)
  142. containerID := apitest.BuildContainerName(containerConfig.Metadata, podSandboxID)
  143. imageRef := containerConfig.Image.Image
  144. return &apitest.FakeContainer{
  145. ContainerStatus: runtimeapi.ContainerStatus{
  146. Id: containerID,
  147. Metadata: containerConfig.Metadata,
  148. Image: containerConfig.Image,
  149. ImageRef: imageRef,
  150. CreatedAt: template.createdAt,
  151. State: template.state,
  152. Labels: containerConfig.Labels,
  153. Annotations: containerConfig.Annotations,
  154. LogPath: filepath.Join(sandboxConfig.GetLogDirectory(), containerConfig.GetLogPath()),
  155. },
  156. SandboxID: podSandboxID,
  157. }
  158. }
  159. // makeFakeContainers creates a group of fake containers based on the container templates.
  160. // The function guarantees the order of the fake containers is the same with the templates.
  161. func makeFakeContainers(t *testing.T, m *kubeGenericRuntimeManager, templates []containerTemplate) []*apitest.FakeContainer {
  162. var fakeContainers []*apitest.FakeContainer
  163. for _, template := range templates {
  164. fakeContainers = append(fakeContainers, makeFakeContainer(t, m, template))
  165. }
  166. return fakeContainers
  167. }
  168. // makeTestContainer creates a test api container.
  169. func makeTestContainer(name, image string) v1.Container {
  170. return v1.Container{
  171. Name: name,
  172. Image: image,
  173. }
  174. }
  175. // makeTestPod creates a test api pod.
  176. func makeTestPod(podName, podNamespace, podUID string, containers []v1.Container) *v1.Pod {
  177. return &v1.Pod{
  178. ObjectMeta: metav1.ObjectMeta{
  179. UID: types.UID(podUID),
  180. Name: podName,
  181. Namespace: podNamespace,
  182. },
  183. Spec: v1.PodSpec{
  184. Containers: containers,
  185. },
  186. }
  187. }
  188. // verifyPods returns true if the two pod slices are equal.
  189. func verifyPods(a, b []*kubecontainer.Pod) bool {
  190. if len(a) != len(b) {
  191. return false
  192. }
  193. // Sort the containers within a pod.
  194. for i := range a {
  195. sort.Sort(containersByID(a[i].Containers))
  196. }
  197. for i := range b {
  198. sort.Sort(containersByID(b[i].Containers))
  199. }
  200. // Sort the pods by UID.
  201. sort.Sort(podsByID(a))
  202. sort.Sort(podsByID(b))
  203. return reflect.DeepEqual(a, b)
  204. }
  205. func verifyFakeContainerList(fakeRuntime *apitest.FakeRuntimeService, expected sets.String) (sets.String, bool) {
  206. actual := sets.NewString()
  207. for _, c := range fakeRuntime.Containers {
  208. actual.Insert(c.Id)
  209. }
  210. return actual, actual.Equal(expected)
  211. }
  212. // Only extract the fields of interests.
  213. type cRecord struct {
  214. name string
  215. attempt uint32
  216. state runtimeapi.ContainerState
  217. }
  218. type cRecordList []*cRecord
  219. func (b cRecordList) Len() int { return len(b) }
  220. func (b cRecordList) Swap(i, j int) { b[i], b[j] = b[j], b[i] }
  221. func (b cRecordList) Less(i, j int) bool {
  222. if b[i].name != b[j].name {
  223. return b[i].name < b[j].name
  224. }
  225. return b[i].attempt < b[j].attempt
  226. }
  227. func verifyContainerStatuses(t *testing.T, runtime *apitest.FakeRuntimeService, expected []*cRecord, desc string) {
  228. actual := []*cRecord{}
  229. for _, cStatus := range runtime.Containers {
  230. actual = append(actual, &cRecord{name: cStatus.Metadata.Name, attempt: cStatus.Metadata.Attempt, state: cStatus.State})
  231. }
  232. sort.Sort(cRecordList(expected))
  233. sort.Sort(cRecordList(actual))
  234. assert.Equal(t, expected, actual, desc)
  235. }
  236. func TestNewKubeRuntimeManager(t *testing.T) {
  237. _, _, _, err := createTestRuntimeManager()
  238. assert.NoError(t, err)
  239. }
  240. func TestVersion(t *testing.T) {
  241. _, _, m, err := createTestRuntimeManager()
  242. assert.NoError(t, err)
  243. version, err := m.Version()
  244. assert.NoError(t, err)
  245. assert.Equal(t, kubeRuntimeAPIVersion, version.String())
  246. }
  247. func TestContainerRuntimeType(t *testing.T) {
  248. _, _, m, err := createTestRuntimeManager()
  249. assert.NoError(t, err)
  250. runtimeType := m.Type()
  251. assert.Equal(t, apitest.FakeRuntimeName, runtimeType)
  252. }
  253. func TestGetPodStatus(t *testing.T) {
  254. fakeRuntime, _, m, err := createTestRuntimeManager()
  255. assert.NoError(t, err)
  256. containers := []v1.Container{
  257. {
  258. Name: "foo1",
  259. Image: "busybox",
  260. ImagePullPolicy: v1.PullIfNotPresent,
  261. },
  262. {
  263. Name: "foo2",
  264. Image: "busybox",
  265. ImagePullPolicy: v1.PullIfNotPresent,
  266. },
  267. }
  268. pod := &v1.Pod{
  269. ObjectMeta: metav1.ObjectMeta{
  270. UID: "12345678",
  271. Name: "foo",
  272. Namespace: "new",
  273. },
  274. Spec: v1.PodSpec{
  275. Containers: containers,
  276. },
  277. }
  278. // Set fake sandbox and faked containers to fakeRuntime.
  279. makeAndSetFakePod(t, m, fakeRuntime, pod)
  280. podStatus, err := m.GetPodStatus(pod.UID, pod.Name, pod.Namespace)
  281. assert.NoError(t, err)
  282. assert.Equal(t, pod.UID, podStatus.ID)
  283. assert.Equal(t, pod.Name, podStatus.Name)
  284. assert.Equal(t, pod.Namespace, podStatus.Namespace)
  285. assert.Equal(t, apitest.FakePodSandboxIPs, podStatus.IPs)
  286. }
  287. func TestGetPods(t *testing.T) {
  288. fakeRuntime, _, m, err := createTestRuntimeManager()
  289. assert.NoError(t, err)
  290. pod := &v1.Pod{
  291. ObjectMeta: metav1.ObjectMeta{
  292. UID: "12345678",
  293. Name: "foo",
  294. Namespace: "new",
  295. },
  296. Spec: v1.PodSpec{
  297. Containers: []v1.Container{
  298. {
  299. Name: "foo1",
  300. Image: "busybox",
  301. },
  302. {
  303. Name: "foo2",
  304. Image: "busybox",
  305. },
  306. },
  307. },
  308. }
  309. // Set fake sandbox and fake containers to fakeRuntime.
  310. fakeSandbox, fakeContainers := makeAndSetFakePod(t, m, fakeRuntime, pod)
  311. // Convert the fakeContainers to kubecontainer.Container
  312. containers := make([]*kubecontainer.Container, len(fakeContainers))
  313. for i := range containers {
  314. fakeContainer := fakeContainers[i]
  315. c, err := m.toKubeContainer(&runtimeapi.Container{
  316. Id: fakeContainer.Id,
  317. Metadata: fakeContainer.Metadata,
  318. State: fakeContainer.State,
  319. Image: fakeContainer.Image,
  320. ImageRef: fakeContainer.ImageRef,
  321. Labels: fakeContainer.Labels,
  322. Annotations: fakeContainer.Annotations,
  323. })
  324. if err != nil {
  325. t.Fatalf("unexpected error %v", err)
  326. }
  327. containers[i] = c
  328. }
  329. // Convert fakeSandbox to kubecontainer.Container
  330. sandbox, err := m.sandboxToKubeContainer(&runtimeapi.PodSandbox{
  331. Id: fakeSandbox.Id,
  332. Metadata: fakeSandbox.Metadata,
  333. State: fakeSandbox.State,
  334. CreatedAt: fakeSandbox.CreatedAt,
  335. Labels: fakeSandbox.Labels,
  336. Annotations: fakeSandbox.Annotations,
  337. })
  338. if err != nil {
  339. t.Fatalf("unexpected error %v", err)
  340. }
  341. expected := []*kubecontainer.Pod{
  342. {
  343. ID: types.UID("12345678"),
  344. Name: "foo",
  345. Namespace: "new",
  346. Containers: []*kubecontainer.Container{containers[0], containers[1]},
  347. Sandboxes: []*kubecontainer.Container{sandbox},
  348. },
  349. }
  350. actual, err := m.GetPods(false)
  351. assert.NoError(t, err)
  352. if !verifyPods(expected, actual) {
  353. t.Errorf("expected %#v, got %#v", expected, actual)
  354. }
  355. }
  356. func TestKillPod(t *testing.T) {
  357. // Tests that KillPod also kills Ephemeral Containers
  358. defer featuregatetesting.SetFeatureGateDuringTest(t, utilfeature.DefaultFeatureGate, features.EphemeralContainers, true)()
  359. fakeRuntime, _, m, err := createTestRuntimeManager()
  360. assert.NoError(t, err)
  361. pod := &v1.Pod{
  362. ObjectMeta: metav1.ObjectMeta{
  363. UID: "12345678",
  364. Name: "foo",
  365. Namespace: "new",
  366. },
  367. Spec: v1.PodSpec{
  368. Containers: []v1.Container{
  369. {
  370. Name: "foo1",
  371. Image: "busybox",
  372. },
  373. {
  374. Name: "foo2",
  375. Image: "busybox",
  376. },
  377. },
  378. EphemeralContainers: []v1.EphemeralContainer{
  379. {
  380. EphemeralContainerCommon: v1.EphemeralContainerCommon{
  381. Name: "debug",
  382. Image: "busybox",
  383. },
  384. },
  385. },
  386. },
  387. }
  388. // Set fake sandbox and fake containers to fakeRuntime.
  389. fakeSandbox, fakeContainers := makeAndSetFakePod(t, m, fakeRuntime, pod)
  390. // Convert the fakeContainers to kubecontainer.Container
  391. containers := make([]*kubecontainer.Container, len(fakeContainers))
  392. for i := range containers {
  393. fakeContainer := fakeContainers[i]
  394. c, err := m.toKubeContainer(&runtimeapi.Container{
  395. Id: fakeContainer.Id,
  396. Metadata: fakeContainer.Metadata,
  397. State: fakeContainer.State,
  398. Image: fakeContainer.Image,
  399. ImageRef: fakeContainer.ImageRef,
  400. Labels: fakeContainer.Labels,
  401. })
  402. if err != nil {
  403. t.Fatalf("unexpected error %v", err)
  404. }
  405. containers[i] = c
  406. }
  407. runningPod := kubecontainer.Pod{
  408. ID: pod.UID,
  409. Name: pod.Name,
  410. Namespace: pod.Namespace,
  411. Containers: []*kubecontainer.Container{containers[0], containers[1], containers[2]},
  412. Sandboxes: []*kubecontainer.Container{
  413. {
  414. ID: kubecontainer.ContainerID{
  415. ID: fakeSandbox.Id,
  416. Type: apitest.FakeRuntimeName,
  417. },
  418. },
  419. },
  420. }
  421. err = m.KillPod(pod, runningPod, nil)
  422. assert.NoError(t, err)
  423. assert.Equal(t, 3, len(fakeRuntime.Containers))
  424. assert.Equal(t, 1, len(fakeRuntime.Sandboxes))
  425. for _, sandbox := range fakeRuntime.Sandboxes {
  426. assert.Equal(t, runtimeapi.PodSandboxState_SANDBOX_NOTREADY, sandbox.State)
  427. }
  428. for _, c := range fakeRuntime.Containers {
  429. assert.Equal(t, runtimeapi.ContainerState_CONTAINER_EXITED, c.State)
  430. }
  431. }
  432. func TestSyncPod(t *testing.T) {
  433. fakeRuntime, fakeImage, m, err := createTestRuntimeManager()
  434. assert.NoError(t, err)
  435. containers := []v1.Container{
  436. {
  437. Name: "foo1",
  438. Image: "busybox",
  439. ImagePullPolicy: v1.PullIfNotPresent,
  440. },
  441. {
  442. Name: "foo2",
  443. Image: "alpine",
  444. ImagePullPolicy: v1.PullIfNotPresent,
  445. },
  446. }
  447. pod := &v1.Pod{
  448. ObjectMeta: metav1.ObjectMeta{
  449. UID: "12345678",
  450. Name: "foo",
  451. Namespace: "new",
  452. },
  453. Spec: v1.PodSpec{
  454. Containers: containers,
  455. },
  456. }
  457. backOff := flowcontrol.NewBackOff(time.Second, time.Minute)
  458. result := m.SyncPod(pod, &kubecontainer.PodStatus{}, []v1.Secret{}, backOff)
  459. assert.NoError(t, result.Error())
  460. assert.Equal(t, 2, len(fakeRuntime.Containers))
  461. assert.Equal(t, 2, len(fakeImage.Images))
  462. assert.Equal(t, 1, len(fakeRuntime.Sandboxes))
  463. for _, sandbox := range fakeRuntime.Sandboxes {
  464. assert.Equal(t, runtimeapi.PodSandboxState_SANDBOX_READY, sandbox.State)
  465. }
  466. for _, c := range fakeRuntime.Containers {
  467. assert.Equal(t, runtimeapi.ContainerState_CONTAINER_RUNNING, c.State)
  468. }
  469. }
  470. func TestPruneInitContainers(t *testing.T) {
  471. fakeRuntime, _, m, err := createTestRuntimeManager()
  472. assert.NoError(t, err)
  473. init1 := makeTestContainer("init1", "busybox")
  474. init2 := makeTestContainer("init2", "busybox")
  475. pod := &v1.Pod{
  476. ObjectMeta: metav1.ObjectMeta{
  477. UID: "12345678",
  478. Name: "foo",
  479. Namespace: "new",
  480. },
  481. Spec: v1.PodSpec{
  482. InitContainers: []v1.Container{init1, init2},
  483. },
  484. }
  485. templates := []containerTemplate{
  486. {pod: pod, container: &init1, attempt: 3, createdAt: 3, state: runtimeapi.ContainerState_CONTAINER_EXITED},
  487. {pod: pod, container: &init1, attempt: 2, createdAt: 2, state: runtimeapi.ContainerState_CONTAINER_EXITED},
  488. {pod: pod, container: &init2, attempt: 1, createdAt: 1, state: runtimeapi.ContainerState_CONTAINER_EXITED},
  489. {pod: pod, container: &init1, attempt: 1, createdAt: 1, state: runtimeapi.ContainerState_CONTAINER_UNKNOWN},
  490. {pod: pod, container: &init2, attempt: 0, createdAt: 0, state: runtimeapi.ContainerState_CONTAINER_EXITED},
  491. {pod: pod, container: &init1, attempt: 0, createdAt: 0, state: runtimeapi.ContainerState_CONTAINER_EXITED},
  492. }
  493. fakes := makeFakeContainers(t, m, templates)
  494. fakeRuntime.SetFakeContainers(fakes)
  495. podStatus, err := m.GetPodStatus(pod.UID, pod.Name, pod.Namespace)
  496. assert.NoError(t, err)
  497. m.pruneInitContainersBeforeStart(pod, podStatus)
  498. expectedContainers := sets.NewString(fakes[0].Id, fakes[2].Id)
  499. if actual, ok := verifyFakeContainerList(fakeRuntime, expectedContainers); !ok {
  500. t.Errorf("expected %v, got %v", expectedContainers, actual)
  501. }
  502. }
  503. func TestSyncPodWithInitContainers(t *testing.T) {
  504. fakeRuntime, _, m, err := createTestRuntimeManager()
  505. assert.NoError(t, err)
  506. initContainers := []v1.Container{
  507. {
  508. Name: "init1",
  509. Image: "init",
  510. ImagePullPolicy: v1.PullIfNotPresent,
  511. },
  512. }
  513. containers := []v1.Container{
  514. {
  515. Name: "foo1",
  516. Image: "busybox",
  517. ImagePullPolicy: v1.PullIfNotPresent,
  518. },
  519. {
  520. Name: "foo2",
  521. Image: "alpine",
  522. ImagePullPolicy: v1.PullIfNotPresent,
  523. },
  524. }
  525. pod := &v1.Pod{
  526. ObjectMeta: metav1.ObjectMeta{
  527. UID: "12345678",
  528. Name: "foo",
  529. Namespace: "new",
  530. },
  531. Spec: v1.PodSpec{
  532. Containers: containers,
  533. InitContainers: initContainers,
  534. },
  535. }
  536. backOff := flowcontrol.NewBackOff(time.Second, time.Minute)
  537. // 1. should only create the init container.
  538. podStatus, err := m.GetPodStatus(pod.UID, pod.Name, pod.Namespace)
  539. assert.NoError(t, err)
  540. result := m.SyncPod(pod, podStatus, []v1.Secret{}, backOff)
  541. assert.NoError(t, result.Error())
  542. expected := []*cRecord{
  543. {name: initContainers[0].Name, attempt: 0, state: runtimeapi.ContainerState_CONTAINER_RUNNING},
  544. }
  545. verifyContainerStatuses(t, fakeRuntime, expected, "start only the init container")
  546. // 2. should not create app container because init container is still running.
  547. podStatus, err = m.GetPodStatus(pod.UID, pod.Name, pod.Namespace)
  548. assert.NoError(t, err)
  549. result = m.SyncPod(pod, podStatus, []v1.Secret{}, backOff)
  550. assert.NoError(t, result.Error())
  551. verifyContainerStatuses(t, fakeRuntime, expected, "init container still running; do nothing")
  552. // 3. should create all app containers because init container finished.
  553. // Stop init container instance 0.
  554. sandboxIDs, err := m.getSandboxIDByPodUID(pod.UID, nil)
  555. require.NoError(t, err)
  556. sandboxID := sandboxIDs[0]
  557. initID0, err := fakeRuntime.GetContainerID(sandboxID, initContainers[0].Name, 0)
  558. require.NoError(t, err)
  559. fakeRuntime.StopContainer(initID0, 0)
  560. // Sync again.
  561. podStatus, err = m.GetPodStatus(pod.UID, pod.Name, pod.Namespace)
  562. assert.NoError(t, err)
  563. result = m.SyncPod(pod, podStatus, []v1.Secret{}, backOff)
  564. assert.NoError(t, result.Error())
  565. expected = []*cRecord{
  566. {name: initContainers[0].Name, attempt: 0, state: runtimeapi.ContainerState_CONTAINER_EXITED},
  567. {name: containers[0].Name, attempt: 0, state: runtimeapi.ContainerState_CONTAINER_RUNNING},
  568. {name: containers[1].Name, attempt: 0, state: runtimeapi.ContainerState_CONTAINER_RUNNING},
  569. }
  570. verifyContainerStatuses(t, fakeRuntime, expected, "init container completed; all app containers should be running")
  571. // 4. should restart the init container if needed to create a new podsandbox
  572. // Stop the pod sandbox.
  573. fakeRuntime.StopPodSandbox(sandboxID)
  574. // Sync again.
  575. podStatus, err = m.GetPodStatus(pod.UID, pod.Name, pod.Namespace)
  576. assert.NoError(t, err)
  577. result = m.SyncPod(pod, podStatus, []v1.Secret{}, backOff)
  578. assert.NoError(t, result.Error())
  579. expected = []*cRecord{
  580. // The first init container instance is purged and no longer visible.
  581. // The second (attempt == 1) instance has been started and is running.
  582. {name: initContainers[0].Name, attempt: 1, state: runtimeapi.ContainerState_CONTAINER_RUNNING},
  583. // All containers are killed.
  584. {name: containers[0].Name, attempt: 0, state: runtimeapi.ContainerState_CONTAINER_EXITED},
  585. {name: containers[1].Name, attempt: 0, state: runtimeapi.ContainerState_CONTAINER_EXITED},
  586. }
  587. verifyContainerStatuses(t, fakeRuntime, expected, "kill all app containers, purge the existing init container, and restart a new one")
  588. }
  589. // A helper function to get a basic pod and its status assuming all sandbox and
  590. // containers are running and ready.
  591. func makeBasePodAndStatus() (*v1.Pod, *kubecontainer.PodStatus) {
  592. pod := &v1.Pod{
  593. ObjectMeta: metav1.ObjectMeta{
  594. UID: "12345678",
  595. Name: "foo",
  596. Namespace: "foo-ns",
  597. },
  598. Spec: v1.PodSpec{
  599. Containers: []v1.Container{
  600. {
  601. Name: "foo1",
  602. Image: "busybox",
  603. },
  604. {
  605. Name: "foo2",
  606. Image: "busybox",
  607. },
  608. {
  609. Name: "foo3",
  610. Image: "busybox",
  611. },
  612. },
  613. },
  614. }
  615. status := &kubecontainer.PodStatus{
  616. ID: pod.UID,
  617. Name: pod.Name,
  618. Namespace: pod.Namespace,
  619. SandboxStatuses: []*runtimeapi.PodSandboxStatus{
  620. {
  621. Id: "sandboxID",
  622. State: runtimeapi.PodSandboxState_SANDBOX_READY,
  623. Metadata: &runtimeapi.PodSandboxMetadata{Name: pod.Name, Namespace: pod.Namespace, Uid: "sandboxuid", Attempt: uint32(0)},
  624. Network: &runtimeapi.PodSandboxNetworkStatus{Ip: "10.0.0.1"},
  625. },
  626. },
  627. ContainerStatuses: []*kubecontainer.ContainerStatus{
  628. {
  629. ID: kubecontainer.ContainerID{ID: "id1"},
  630. Name: "foo1", State: kubecontainer.ContainerStateRunning,
  631. Hash: kubecontainer.HashContainer(&pod.Spec.Containers[0]),
  632. },
  633. {
  634. ID: kubecontainer.ContainerID{ID: "id2"},
  635. Name: "foo2", State: kubecontainer.ContainerStateRunning,
  636. Hash: kubecontainer.HashContainer(&pod.Spec.Containers[1]),
  637. },
  638. {
  639. ID: kubecontainer.ContainerID{ID: "id3"},
  640. Name: "foo3", State: kubecontainer.ContainerStateRunning,
  641. Hash: kubecontainer.HashContainer(&pod.Spec.Containers[2]),
  642. },
  643. },
  644. }
  645. return pod, status
  646. }
  647. func TestComputePodActions(t *testing.T) {
  648. _, _, m, err := createTestRuntimeManager()
  649. require.NoError(t, err)
  650. // Creating a pair reference pod and status for the test cases to refer
  651. // the specific fields.
  652. basePod, baseStatus := makeBasePodAndStatus()
  653. noAction := podActions{
  654. SandboxID: baseStatus.SandboxStatuses[0].Id,
  655. ContainersToStart: []int{},
  656. ContainersToKill: map[kubecontainer.ContainerID]containerToKillInfo{},
  657. }
  658. for desc, test := range map[string]struct {
  659. mutatePodFn func(*v1.Pod)
  660. mutateStatusFn func(*kubecontainer.PodStatus)
  661. actions podActions
  662. resetStatusFn func(*kubecontainer.PodStatus)
  663. }{
  664. "everying is good; do nothing": {
  665. actions: noAction,
  666. },
  667. "start pod sandbox and all containers for a new pod": {
  668. mutateStatusFn: func(status *kubecontainer.PodStatus) {
  669. // No container or sandbox exists.
  670. status.SandboxStatuses = []*runtimeapi.PodSandboxStatus{}
  671. status.ContainerStatuses = []*kubecontainer.ContainerStatus{}
  672. },
  673. actions: podActions{
  674. KillPod: true,
  675. CreateSandbox: true,
  676. Attempt: uint32(0),
  677. ContainersToStart: []int{0, 1, 2},
  678. ContainersToKill: getKillMap(basePod, baseStatus, []int{}),
  679. },
  680. },
  681. "restart exited containers if RestartPolicy == Always": {
  682. mutatePodFn: func(pod *v1.Pod) { pod.Spec.RestartPolicy = v1.RestartPolicyAlways },
  683. mutateStatusFn: func(status *kubecontainer.PodStatus) {
  684. // The first container completed, restart it,
  685. status.ContainerStatuses[0].State = kubecontainer.ContainerStateExited
  686. status.ContainerStatuses[0].ExitCode = 0
  687. // The second container exited with failure, restart it,
  688. status.ContainerStatuses[1].State = kubecontainer.ContainerStateExited
  689. status.ContainerStatuses[1].ExitCode = 111
  690. },
  691. actions: podActions{
  692. SandboxID: baseStatus.SandboxStatuses[0].Id,
  693. ContainersToStart: []int{0, 1},
  694. ContainersToKill: getKillMap(basePod, baseStatus, []int{}),
  695. },
  696. },
  697. "restart failed containers if RestartPolicy == OnFailure": {
  698. mutatePodFn: func(pod *v1.Pod) { pod.Spec.RestartPolicy = v1.RestartPolicyOnFailure },
  699. mutateStatusFn: func(status *kubecontainer.PodStatus) {
  700. // The first container completed, don't restart it,
  701. status.ContainerStatuses[0].State = kubecontainer.ContainerStateExited
  702. status.ContainerStatuses[0].ExitCode = 0
  703. // The second container exited with failure, restart it,
  704. status.ContainerStatuses[1].State = kubecontainer.ContainerStateExited
  705. status.ContainerStatuses[1].ExitCode = 111
  706. },
  707. actions: podActions{
  708. SandboxID: baseStatus.SandboxStatuses[0].Id,
  709. ContainersToStart: []int{1},
  710. ContainersToKill: getKillMap(basePod, baseStatus, []int{}),
  711. },
  712. },
  713. "don't restart containers if RestartPolicy == Never": {
  714. mutatePodFn: func(pod *v1.Pod) { pod.Spec.RestartPolicy = v1.RestartPolicyNever },
  715. mutateStatusFn: func(status *kubecontainer.PodStatus) {
  716. // Don't restart any containers.
  717. status.ContainerStatuses[0].State = kubecontainer.ContainerStateExited
  718. status.ContainerStatuses[0].ExitCode = 0
  719. status.ContainerStatuses[1].State = kubecontainer.ContainerStateExited
  720. status.ContainerStatuses[1].ExitCode = 111
  721. },
  722. actions: noAction,
  723. },
  724. "Kill pod and recreate everything if the pod sandbox is dead, and RestartPolicy == Always": {
  725. mutatePodFn: func(pod *v1.Pod) { pod.Spec.RestartPolicy = v1.RestartPolicyAlways },
  726. mutateStatusFn: func(status *kubecontainer.PodStatus) {
  727. status.SandboxStatuses[0].State = runtimeapi.PodSandboxState_SANDBOX_NOTREADY
  728. },
  729. actions: podActions{
  730. KillPod: true,
  731. CreateSandbox: true,
  732. SandboxID: baseStatus.SandboxStatuses[0].Id,
  733. Attempt: uint32(1),
  734. ContainersToStart: []int{0, 1, 2},
  735. ContainersToKill: getKillMap(basePod, baseStatus, []int{}),
  736. },
  737. },
  738. "Kill pod and recreate all containers (except for the succeeded one) if the pod sandbox is dead, and RestartPolicy == OnFailure": {
  739. mutatePodFn: func(pod *v1.Pod) { pod.Spec.RestartPolicy = v1.RestartPolicyOnFailure },
  740. mutateStatusFn: func(status *kubecontainer.PodStatus) {
  741. status.SandboxStatuses[0].State = runtimeapi.PodSandboxState_SANDBOX_NOTREADY
  742. status.ContainerStatuses[1].State = kubecontainer.ContainerStateExited
  743. status.ContainerStatuses[1].ExitCode = 0
  744. },
  745. actions: podActions{
  746. KillPod: true,
  747. CreateSandbox: true,
  748. SandboxID: baseStatus.SandboxStatuses[0].Id,
  749. Attempt: uint32(1),
  750. ContainersToStart: []int{0, 2},
  751. ContainersToKill: getKillMap(basePod, baseStatus, []int{}),
  752. },
  753. },
  754. "Kill pod and recreate all containers if the PodSandbox does not have an IP": {
  755. mutateStatusFn: func(status *kubecontainer.PodStatus) {
  756. status.SandboxStatuses[0].Network.Ip = ""
  757. },
  758. actions: podActions{
  759. KillPod: true,
  760. CreateSandbox: true,
  761. SandboxID: baseStatus.SandboxStatuses[0].Id,
  762. Attempt: uint32(1),
  763. ContainersToStart: []int{0, 1, 2},
  764. ContainersToKill: getKillMap(basePod, baseStatus, []int{}),
  765. },
  766. },
  767. "Kill and recreate the container if the container's spec changed": {
  768. mutatePodFn: func(pod *v1.Pod) {
  769. pod.Spec.RestartPolicy = v1.RestartPolicyAlways
  770. },
  771. mutateStatusFn: func(status *kubecontainer.PodStatus) {
  772. status.ContainerStatuses[1].Hash = uint64(432423432)
  773. },
  774. actions: podActions{
  775. SandboxID: baseStatus.SandboxStatuses[0].Id,
  776. ContainersToKill: getKillMap(basePod, baseStatus, []int{1}),
  777. ContainersToStart: []int{1},
  778. },
  779. },
  780. "Kill and recreate the container if the liveness check has failed": {
  781. mutatePodFn: func(pod *v1.Pod) {
  782. pod.Spec.RestartPolicy = v1.RestartPolicyAlways
  783. },
  784. mutateStatusFn: func(status *kubecontainer.PodStatus) {
  785. m.livenessManager.Set(status.ContainerStatuses[1].ID, proberesults.Failure, basePod)
  786. },
  787. actions: podActions{
  788. SandboxID: baseStatus.SandboxStatuses[0].Id,
  789. ContainersToKill: getKillMap(basePod, baseStatus, []int{1}),
  790. ContainersToStart: []int{1},
  791. },
  792. resetStatusFn: func(status *kubecontainer.PodStatus) {
  793. m.livenessManager.Remove(status.ContainerStatuses[1].ID)
  794. },
  795. },
  796. "Kill and recreate the container if the startup check has failed": {
  797. mutatePodFn: func(pod *v1.Pod) {
  798. pod.Spec.RestartPolicy = v1.RestartPolicyAlways
  799. },
  800. mutateStatusFn: func(status *kubecontainer.PodStatus) {
  801. m.startupManager.Set(status.ContainerStatuses[1].ID, proberesults.Failure, basePod)
  802. },
  803. actions: podActions{
  804. SandboxID: baseStatus.SandboxStatuses[0].Id,
  805. ContainersToKill: getKillMap(basePod, baseStatus, []int{1}),
  806. ContainersToStart: []int{1},
  807. },
  808. resetStatusFn: func(status *kubecontainer.PodStatus) {
  809. m.startupManager.Remove(status.ContainerStatuses[1].ID)
  810. },
  811. },
  812. "Verify we do not create a pod sandbox if no ready sandbox for pod with RestartPolicy=Never and all containers exited": {
  813. mutatePodFn: func(pod *v1.Pod) {
  814. pod.Spec.RestartPolicy = v1.RestartPolicyNever
  815. },
  816. mutateStatusFn: func(status *kubecontainer.PodStatus) {
  817. // no ready sandbox
  818. status.SandboxStatuses[0].State = runtimeapi.PodSandboxState_SANDBOX_NOTREADY
  819. status.SandboxStatuses[0].Metadata.Attempt = uint32(1)
  820. // all containers exited
  821. for i := range status.ContainerStatuses {
  822. status.ContainerStatuses[i].State = kubecontainer.ContainerStateExited
  823. status.ContainerStatuses[i].ExitCode = 0
  824. }
  825. },
  826. actions: podActions{
  827. SandboxID: baseStatus.SandboxStatuses[0].Id,
  828. Attempt: uint32(2),
  829. CreateSandbox: false,
  830. KillPod: true,
  831. ContainersToStart: []int{},
  832. ContainersToKill: map[kubecontainer.ContainerID]containerToKillInfo{},
  833. },
  834. },
  835. "Verify we create a pod sandbox if no ready sandbox for pod with RestartPolicy=Never and no containers have ever been created": {
  836. mutatePodFn: func(pod *v1.Pod) {
  837. pod.Spec.RestartPolicy = v1.RestartPolicyNever
  838. },
  839. mutateStatusFn: func(status *kubecontainer.PodStatus) {
  840. // no ready sandbox
  841. status.SandboxStatuses[0].State = runtimeapi.PodSandboxState_SANDBOX_NOTREADY
  842. status.SandboxStatuses[0].Metadata.Attempt = uint32(2)
  843. // no visible containers
  844. status.ContainerStatuses = []*kubecontainer.ContainerStatus{}
  845. },
  846. actions: podActions{
  847. SandboxID: baseStatus.SandboxStatuses[0].Id,
  848. Attempt: uint32(3),
  849. CreateSandbox: true,
  850. KillPod: true,
  851. ContainersToStart: []int{0, 1, 2},
  852. ContainersToKill: map[kubecontainer.ContainerID]containerToKillInfo{},
  853. },
  854. },
  855. "Kill and recreate the container if the container is in unknown state": {
  856. mutatePodFn: func(pod *v1.Pod) { pod.Spec.RestartPolicy = v1.RestartPolicyNever },
  857. mutateStatusFn: func(status *kubecontainer.PodStatus) {
  858. status.ContainerStatuses[1].State = kubecontainer.ContainerStateUnknown
  859. },
  860. actions: podActions{
  861. SandboxID: baseStatus.SandboxStatuses[0].Id,
  862. ContainersToKill: getKillMap(basePod, baseStatus, []int{1}),
  863. ContainersToStart: []int{1},
  864. },
  865. },
  866. } {
  867. pod, status := makeBasePodAndStatus()
  868. if test.mutatePodFn != nil {
  869. test.mutatePodFn(pod)
  870. }
  871. if test.mutateStatusFn != nil {
  872. test.mutateStatusFn(status)
  873. }
  874. actions := m.computePodActions(pod, status)
  875. verifyActions(t, &test.actions, &actions, desc)
  876. if test.resetStatusFn != nil {
  877. test.resetStatusFn(status)
  878. }
  879. }
  880. }
  881. func getKillMap(pod *v1.Pod, status *kubecontainer.PodStatus, cIndexes []int) map[kubecontainer.ContainerID]containerToKillInfo {
  882. m := map[kubecontainer.ContainerID]containerToKillInfo{}
  883. for _, i := range cIndexes {
  884. m[status.ContainerStatuses[i].ID] = containerToKillInfo{
  885. container: &pod.Spec.Containers[i],
  886. name: pod.Spec.Containers[i].Name,
  887. }
  888. }
  889. return m
  890. }
  891. func getKillMapWithInitContainers(pod *v1.Pod, status *kubecontainer.PodStatus, cIndexes []int) map[kubecontainer.ContainerID]containerToKillInfo {
  892. m := map[kubecontainer.ContainerID]containerToKillInfo{}
  893. for _, i := range cIndexes {
  894. m[status.ContainerStatuses[i].ID] = containerToKillInfo{
  895. container: &pod.Spec.InitContainers[i],
  896. name: pod.Spec.InitContainers[i].Name,
  897. }
  898. }
  899. return m
  900. }
  901. func verifyActions(t *testing.T, expected, actual *podActions, desc string) {
  902. if actual.ContainersToKill != nil {
  903. // Clear the message field since we don't need to verify the message.
  904. for k, info := range actual.ContainersToKill {
  905. info.message = ""
  906. actual.ContainersToKill[k] = info
  907. }
  908. }
  909. assert.Equal(t, expected, actual, desc)
  910. }
  911. func TestComputePodActionsWithInitContainers(t *testing.T) {
  912. _, _, m, err := createTestRuntimeManager()
  913. require.NoError(t, err)
  914. // Creating a pair reference pod and status for the test cases to refer
  915. // the specific fields.
  916. basePod, baseStatus := makeBasePodAndStatusWithInitContainers()
  917. noAction := podActions{
  918. SandboxID: baseStatus.SandboxStatuses[0].Id,
  919. ContainersToStart: []int{},
  920. ContainersToKill: map[kubecontainer.ContainerID]containerToKillInfo{},
  921. }
  922. for desc, test := range map[string]struct {
  923. mutatePodFn func(*v1.Pod)
  924. mutateStatusFn func(*kubecontainer.PodStatus)
  925. actions podActions
  926. }{
  927. "initialization completed; start all containers": {
  928. actions: podActions{
  929. SandboxID: baseStatus.SandboxStatuses[0].Id,
  930. ContainersToStart: []int{0, 1, 2},
  931. ContainersToKill: getKillMapWithInitContainers(basePod, baseStatus, []int{}),
  932. },
  933. },
  934. "initialization in progress; do nothing": {
  935. mutatePodFn: func(pod *v1.Pod) { pod.Spec.RestartPolicy = v1.RestartPolicyAlways },
  936. mutateStatusFn: func(status *kubecontainer.PodStatus) {
  937. status.ContainerStatuses[2].State = kubecontainer.ContainerStateRunning
  938. },
  939. actions: noAction,
  940. },
  941. "Kill pod and restart the first init container if the pod sandbox is dead": {
  942. mutatePodFn: func(pod *v1.Pod) { pod.Spec.RestartPolicy = v1.RestartPolicyAlways },
  943. mutateStatusFn: func(status *kubecontainer.PodStatus) {
  944. status.SandboxStatuses[0].State = runtimeapi.PodSandboxState_SANDBOX_NOTREADY
  945. },
  946. actions: podActions{
  947. KillPod: true,
  948. CreateSandbox: true,
  949. SandboxID: baseStatus.SandboxStatuses[0].Id,
  950. Attempt: uint32(1),
  951. NextInitContainerToStart: &basePod.Spec.InitContainers[0],
  952. ContainersToStart: []int{},
  953. ContainersToKill: getKillMapWithInitContainers(basePod, baseStatus, []int{}),
  954. },
  955. },
  956. "initialization failed; restart the last init container if RestartPolicy == Always": {
  957. mutatePodFn: func(pod *v1.Pod) { pod.Spec.RestartPolicy = v1.RestartPolicyAlways },
  958. mutateStatusFn: func(status *kubecontainer.PodStatus) {
  959. status.ContainerStatuses[2].ExitCode = 137
  960. },
  961. actions: podActions{
  962. SandboxID: baseStatus.SandboxStatuses[0].Id,
  963. NextInitContainerToStart: &basePod.Spec.InitContainers[2],
  964. ContainersToStart: []int{},
  965. ContainersToKill: getKillMapWithInitContainers(basePod, baseStatus, []int{}),
  966. },
  967. },
  968. "initialization failed; restart the last init container if RestartPolicy == OnFailure": {
  969. mutatePodFn: func(pod *v1.Pod) { pod.Spec.RestartPolicy = v1.RestartPolicyOnFailure },
  970. mutateStatusFn: func(status *kubecontainer.PodStatus) {
  971. status.ContainerStatuses[2].ExitCode = 137
  972. },
  973. actions: podActions{
  974. SandboxID: baseStatus.SandboxStatuses[0].Id,
  975. NextInitContainerToStart: &basePod.Spec.InitContainers[2],
  976. ContainersToStart: []int{},
  977. ContainersToKill: getKillMapWithInitContainers(basePod, baseStatus, []int{}),
  978. },
  979. },
  980. "initialization failed; kill pod if RestartPolicy == Never": {
  981. mutatePodFn: func(pod *v1.Pod) { pod.Spec.RestartPolicy = v1.RestartPolicyNever },
  982. mutateStatusFn: func(status *kubecontainer.PodStatus) {
  983. status.ContainerStatuses[2].ExitCode = 137
  984. },
  985. actions: podActions{
  986. KillPod: true,
  987. SandboxID: baseStatus.SandboxStatuses[0].Id,
  988. ContainersToStart: []int{},
  989. ContainersToKill: getKillMapWithInitContainers(basePod, baseStatus, []int{}),
  990. },
  991. },
  992. "init container state unknown; kill and recreate the last init container if RestartPolicy == Always": {
  993. mutatePodFn: func(pod *v1.Pod) { pod.Spec.RestartPolicy = v1.RestartPolicyAlways },
  994. mutateStatusFn: func(status *kubecontainer.PodStatus) {
  995. status.ContainerStatuses[2].State = kubecontainer.ContainerStateUnknown
  996. },
  997. actions: podActions{
  998. SandboxID: baseStatus.SandboxStatuses[0].Id,
  999. NextInitContainerToStart: &basePod.Spec.InitContainers[2],
  1000. ContainersToStart: []int{},
  1001. ContainersToKill: getKillMapWithInitContainers(basePod, baseStatus, []int{2}),
  1002. },
  1003. },
  1004. "init container state unknown; kill and recreate the last init container if RestartPolicy == OnFailure": {
  1005. mutatePodFn: func(pod *v1.Pod) { pod.Spec.RestartPolicy = v1.RestartPolicyOnFailure },
  1006. mutateStatusFn: func(status *kubecontainer.PodStatus) {
  1007. status.ContainerStatuses[2].State = kubecontainer.ContainerStateUnknown
  1008. },
  1009. actions: podActions{
  1010. SandboxID: baseStatus.SandboxStatuses[0].Id,
  1011. NextInitContainerToStart: &basePod.Spec.InitContainers[2],
  1012. ContainersToStart: []int{},
  1013. ContainersToKill: getKillMapWithInitContainers(basePod, baseStatus, []int{2}),
  1014. },
  1015. },
  1016. "init container state unknown; kill pod if RestartPolicy == Never": {
  1017. mutatePodFn: func(pod *v1.Pod) { pod.Spec.RestartPolicy = v1.RestartPolicyNever },
  1018. mutateStatusFn: func(status *kubecontainer.PodStatus) {
  1019. status.ContainerStatuses[2].State = kubecontainer.ContainerStateUnknown
  1020. },
  1021. actions: podActions{
  1022. KillPod: true,
  1023. SandboxID: baseStatus.SandboxStatuses[0].Id,
  1024. ContainersToStart: []int{},
  1025. ContainersToKill: getKillMapWithInitContainers(basePod, baseStatus, []int{}),
  1026. },
  1027. },
  1028. "Pod sandbox not ready, init container failed, but RestartPolicy == Never; kill pod only": {
  1029. mutatePodFn: func(pod *v1.Pod) { pod.Spec.RestartPolicy = v1.RestartPolicyNever },
  1030. mutateStatusFn: func(status *kubecontainer.PodStatus) {
  1031. status.SandboxStatuses[0].State = runtimeapi.PodSandboxState_SANDBOX_NOTREADY
  1032. },
  1033. actions: podActions{
  1034. KillPod: true,
  1035. CreateSandbox: false,
  1036. SandboxID: baseStatus.SandboxStatuses[0].Id,
  1037. Attempt: uint32(1),
  1038. ContainersToStart: []int{},
  1039. ContainersToKill: getKillMapWithInitContainers(basePod, baseStatus, []int{}),
  1040. },
  1041. },
  1042. "Pod sandbox not ready, and RestartPolicy == Never, but no visible init containers; create a new pod sandbox": {
  1043. mutatePodFn: func(pod *v1.Pod) { pod.Spec.RestartPolicy = v1.RestartPolicyNever },
  1044. mutateStatusFn: func(status *kubecontainer.PodStatus) {
  1045. status.SandboxStatuses[0].State = runtimeapi.PodSandboxState_SANDBOX_NOTREADY
  1046. status.ContainerStatuses = []*kubecontainer.ContainerStatus{}
  1047. },
  1048. actions: podActions{
  1049. KillPod: true,
  1050. CreateSandbox: true,
  1051. SandboxID: baseStatus.SandboxStatuses[0].Id,
  1052. Attempt: uint32(1),
  1053. NextInitContainerToStart: &basePod.Spec.InitContainers[0],
  1054. ContainersToStart: []int{},
  1055. ContainersToKill: getKillMapWithInitContainers(basePod, baseStatus, []int{}),
  1056. },
  1057. },
  1058. } {
  1059. pod, status := makeBasePodAndStatusWithInitContainers()
  1060. if test.mutatePodFn != nil {
  1061. test.mutatePodFn(pod)
  1062. }
  1063. if test.mutateStatusFn != nil {
  1064. test.mutateStatusFn(status)
  1065. }
  1066. actions := m.computePodActions(pod, status)
  1067. verifyActions(t, &test.actions, &actions, desc)
  1068. }
  1069. }
  1070. func makeBasePodAndStatusWithInitContainers() (*v1.Pod, *kubecontainer.PodStatus) {
  1071. pod, status := makeBasePodAndStatus()
  1072. pod.Spec.InitContainers = []v1.Container{
  1073. {
  1074. Name: "init1",
  1075. Image: "bar-image",
  1076. },
  1077. {
  1078. Name: "init2",
  1079. Image: "bar-image",
  1080. },
  1081. {
  1082. Name: "init3",
  1083. Image: "bar-image",
  1084. },
  1085. }
  1086. // Replace the original statuses of the containers with those for the init
  1087. // containers.
  1088. status.ContainerStatuses = []*kubecontainer.ContainerStatus{
  1089. {
  1090. ID: kubecontainer.ContainerID{ID: "initid1"},
  1091. Name: "init1", State: kubecontainer.ContainerStateExited,
  1092. Hash: kubecontainer.HashContainer(&pod.Spec.InitContainers[0]),
  1093. },
  1094. {
  1095. ID: kubecontainer.ContainerID{ID: "initid2"},
  1096. Name: "init2", State: kubecontainer.ContainerStateExited,
  1097. Hash: kubecontainer.HashContainer(&pod.Spec.InitContainers[0]),
  1098. },
  1099. {
  1100. ID: kubecontainer.ContainerID{ID: "initid3"},
  1101. Name: "init3", State: kubecontainer.ContainerStateExited,
  1102. Hash: kubecontainer.HashContainer(&pod.Spec.InitContainers[0]),
  1103. },
  1104. }
  1105. return pod, status
  1106. }
  1107. func TestComputePodActionsWithInitAndEphemeralContainers(t *testing.T) {
  1108. defer featuregatetesting.SetFeatureGateDuringTest(t, utilfeature.DefaultFeatureGate, features.EphemeralContainers, true)()
  1109. // Make sure existing test cases pass with feature enabled
  1110. TestComputePodActions(t)
  1111. TestComputePodActionsWithInitContainers(t)
  1112. _, _, m, err := createTestRuntimeManager()
  1113. require.NoError(t, err)
  1114. basePod, baseStatus := makeBasePodAndStatusWithInitAndEphemeralContainers()
  1115. noAction := podActions{
  1116. SandboxID: baseStatus.SandboxStatuses[0].Id,
  1117. ContainersToStart: []int{},
  1118. ContainersToKill: map[kubecontainer.ContainerID]containerToKillInfo{},
  1119. }
  1120. for desc, test := range map[string]struct {
  1121. mutatePodFn func(*v1.Pod)
  1122. mutateStatusFn func(*kubecontainer.PodStatus)
  1123. actions podActions
  1124. }{
  1125. "steady state; do nothing; ignore ephemeral container": {
  1126. actions: noAction,
  1127. },
  1128. "No ephemeral containers running; start one": {
  1129. mutateStatusFn: func(status *kubecontainer.PodStatus) {
  1130. status.ContainerStatuses = status.ContainerStatuses[:4]
  1131. },
  1132. actions: podActions{
  1133. SandboxID: baseStatus.SandboxStatuses[0].Id,
  1134. ContainersToStart: []int{},
  1135. ContainersToKill: map[kubecontainer.ContainerID]containerToKillInfo{},
  1136. EphemeralContainersToStart: []int{0},
  1137. },
  1138. },
  1139. "Start second ephemeral container": {
  1140. mutatePodFn: func(pod *v1.Pod) {
  1141. pod.Spec.EphemeralContainers = append(pod.Spec.EphemeralContainers, v1.EphemeralContainer{
  1142. EphemeralContainerCommon: v1.EphemeralContainerCommon{
  1143. Name: "debug2",
  1144. Image: "busybox",
  1145. },
  1146. })
  1147. },
  1148. actions: podActions{
  1149. SandboxID: baseStatus.SandboxStatuses[0].Id,
  1150. ContainersToStart: []int{},
  1151. ContainersToKill: map[kubecontainer.ContainerID]containerToKillInfo{},
  1152. EphemeralContainersToStart: []int{1},
  1153. },
  1154. },
  1155. "Ephemeral container exited; do not restart": {
  1156. mutatePodFn: func(pod *v1.Pod) { pod.Spec.RestartPolicy = v1.RestartPolicyAlways },
  1157. mutateStatusFn: func(status *kubecontainer.PodStatus) {
  1158. status.ContainerStatuses[4].State = kubecontainer.ContainerStateExited
  1159. },
  1160. actions: podActions{
  1161. SandboxID: baseStatus.SandboxStatuses[0].Id,
  1162. ContainersToStart: []int{},
  1163. ContainersToKill: map[kubecontainer.ContainerID]containerToKillInfo{},
  1164. },
  1165. },
  1166. "initialization in progress; start ephemeral container": {
  1167. mutateStatusFn: func(status *kubecontainer.PodStatus) {
  1168. status.ContainerStatuses[3].State = kubecontainer.ContainerStateRunning
  1169. status.ContainerStatuses = status.ContainerStatuses[:4]
  1170. },
  1171. actions: podActions{
  1172. SandboxID: baseStatus.SandboxStatuses[0].Id,
  1173. ContainersToStart: []int{},
  1174. ContainersToKill: map[kubecontainer.ContainerID]containerToKillInfo{},
  1175. EphemeralContainersToStart: []int{0},
  1176. },
  1177. },
  1178. "Kill pod and do not restart ephemeral container if the pod sandbox is dead": {
  1179. mutatePodFn: func(pod *v1.Pod) { pod.Spec.RestartPolicy = v1.RestartPolicyAlways },
  1180. mutateStatusFn: func(status *kubecontainer.PodStatus) {
  1181. status.SandboxStatuses[0].State = runtimeapi.PodSandboxState_SANDBOX_NOTREADY
  1182. },
  1183. actions: podActions{
  1184. KillPod: true,
  1185. CreateSandbox: true,
  1186. SandboxID: baseStatus.SandboxStatuses[0].Id,
  1187. Attempt: uint32(1),
  1188. NextInitContainerToStart: &basePod.Spec.InitContainers[0],
  1189. ContainersToStart: []int{},
  1190. ContainersToKill: getKillMapWithInitContainers(basePod, baseStatus, []int{}),
  1191. },
  1192. },
  1193. "Kill pod if all containers exited except ephemeral container": {
  1194. mutatePodFn: func(pod *v1.Pod) {
  1195. pod.Spec.RestartPolicy = v1.RestartPolicyNever
  1196. },
  1197. mutateStatusFn: func(status *kubecontainer.PodStatus) {
  1198. // all regular containers exited
  1199. for i := 0; i < 3; i++ {
  1200. status.ContainerStatuses[i].State = kubecontainer.ContainerStateExited
  1201. status.ContainerStatuses[i].ExitCode = 0
  1202. }
  1203. },
  1204. actions: podActions{
  1205. SandboxID: baseStatus.SandboxStatuses[0].Id,
  1206. CreateSandbox: false,
  1207. KillPod: true,
  1208. ContainersToStart: []int{},
  1209. ContainersToKill: map[kubecontainer.ContainerID]containerToKillInfo{},
  1210. },
  1211. },
  1212. "Ephemeral container is in unknown state; leave it alone": {
  1213. mutatePodFn: func(pod *v1.Pod) { pod.Spec.RestartPolicy = v1.RestartPolicyNever },
  1214. mutateStatusFn: func(status *kubecontainer.PodStatus) {
  1215. status.ContainerStatuses[4].State = kubecontainer.ContainerStateUnknown
  1216. },
  1217. actions: noAction,
  1218. },
  1219. } {
  1220. pod, status := makeBasePodAndStatusWithInitAndEphemeralContainers()
  1221. if test.mutatePodFn != nil {
  1222. test.mutatePodFn(pod)
  1223. }
  1224. if test.mutateStatusFn != nil {
  1225. test.mutateStatusFn(status)
  1226. }
  1227. actions := m.computePodActions(pod, status)
  1228. verifyActions(t, &test.actions, &actions, desc)
  1229. }
  1230. }
  1231. func makeBasePodAndStatusWithInitAndEphemeralContainers() (*v1.Pod, *kubecontainer.PodStatus) {
  1232. pod, status := makeBasePodAndStatus()
  1233. pod.Spec.InitContainers = []v1.Container{
  1234. {
  1235. Name: "init1",
  1236. Image: "bar-image",
  1237. },
  1238. }
  1239. pod.Spec.EphemeralContainers = []v1.EphemeralContainer{
  1240. {
  1241. EphemeralContainerCommon: v1.EphemeralContainerCommon{
  1242. Name: "debug",
  1243. Image: "busybox",
  1244. },
  1245. },
  1246. }
  1247. status.ContainerStatuses = append(status.ContainerStatuses, &kubecontainer.ContainerStatus{
  1248. ID: kubecontainer.ContainerID{ID: "initid1"},
  1249. Name: "init1", State: kubecontainer.ContainerStateExited,
  1250. Hash: kubecontainer.HashContainer(&pod.Spec.InitContainers[0]),
  1251. }, &kubecontainer.ContainerStatus{
  1252. ID: kubecontainer.ContainerID{ID: "debug1"},
  1253. Name: "debug", State: kubecontainer.ContainerStateRunning,
  1254. Hash: kubecontainer.HashContainer((*v1.Container)(&pod.Spec.EphemeralContainers[0].EphemeralContainerCommon)),
  1255. })
  1256. return pod, status
  1257. }