Merge pull request #21 from bryopsida/20-filter-resources-considered-for-updates

Filter to only target resources with pullPolicy=Always

Author: bryopsida

README.md

@@ -10,8 +10,7 @@ This is still very early in development and has a few limitations.
 
 1. Does not support private registries
 2. Does not pull updates for things without `imagePullPolicy = Always`
-3. Only supports querying `linux/arm64` image repositories at the moment
-4. Only looks for updates to the same tag, IE for cases where base patches have been pushed to a tag
+3. Only looks for updates to the same tag, IE for cases where base patches have been pushed to a tag
 
 ## How to deploy
 

charts/patchwork/Chart.yaml

@@ -2,8 +2,8 @@ apiVersion: v2
 name: patchwork
 description: Watches deployments, daemonsets, and statefulsets for image updates and will automatically trigger rollouts to pull in updates
 type: application
-version: 0.5.0
-appVersion: '0.3.0'
+version: 0.6.0
+appVersion: '0.4.0'
 dependencies:
   - name: redis
     repository: https://groundhog2k.github.io/helm-charts/

charts/patchwork/README.md

@@ -1,6 +1,6 @@
 # patchwork
 
-![Version: 0.5.0](https://img.shields.io/badge/Version-0.5.0-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square) ![AppVersion: 0.3.0](https://img.shields.io/badge/AppVersion-0.3.0-informational?style=flat-square)
+![Version: 0.6.0](https://img.shields.io/badge/Version-0.6.0-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square) ![AppVersion: 0.4.0](https://img.shields.io/badge/AppVersion-0.4.0-informational?style=flat-square)
 
 Watches deployments, daemonsets, and statefulsets for image updates and will automatically trigger rollouts to pull in updates
 

package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "patchwork",
-  "version": "0.2.0",
+  "version": "0.3.0",
   "description": "",
   "author": "",
   "private": true,
@@ -73,6 +73,7 @@
     "testcontainers": "^9.9.1",
     "ts-jest": "29.1.0",
     "ts-loader": "^9.2.3",
+    "ts-mockito": "^2.6.1",
     "ts-node": "^10.0.0",
     "tsconfig-paths": "4.2.0",
     "typescript": "^5.0.0"

package.json

@@ -1,8 +1,12 @@
 import { Test, TestingModule } from '@nestjs/testing'
 import { K8sService } from './k8s.service'
+import { AppsV1Api, CoreV1Api } from '@kubernetes/client-node'
+import { mock, when, instance, anything } from 'ts-mockito'
 
 describe('K8sService', () => {
   let service: K8sService
+  let mockCore: CoreV1Api
+  let mockAppApi: AppsV1Api
 
   beforeEach(async () => {
     const module: TestingModule = await Test.createTestingModule({
@@ -11,7 +15,16 @@ describe('K8sService', () => {
         {
           provide: 'K8S_CONFIG',
           useValue: {
-            makeApiClient: jest.fn(),
+            makeApiClient: (type: any) => {
+              switch (type.name.toLowerCase()) {
+                case 'corev1api':
+                  mockCore = mock<CoreV1Api>()
+                  return instance(mockCore)
+                default:
+                  mockAppApi = mock<AppsV1Api>()
+                  return instance(mockAppApi)
+              }
+            },
           },
         },
       ],
@@ -23,4 +36,137 @@ describe('K8sService', () => {
   it('should be defined', () => {
     expect(service).toBeDefined()
   })
+
+  it('should not return images without pullPolicy: always', async () => {
+    // GIVEN
+    /*
+        const allDeploymentsProm = this.appClient.listDeploymentForAllNamespaces()
+    const allDaemonsetsProm = this.appClient.listDaemonSetForAllNamespaces()
+    const allStatefulsetsProm = this.appClient.listStatefulSetForAllNamespaces()
+    */
+    when(mockAppApi.listDeploymentForAllNamespaces()).thenResolve({
+      response: {} as unknown as any,
+      body: {
+        items: [
+          {
+            metadata: {
+              namesace: 'TEST',
+            },
+            spec: {
+              selector: {
+                matchLabels: {
+                  test: 'TEST-DEPLOYMENT',
+                },
+              },
+            },
+          },
+        ],
+      } as unknown as any,
+    })
+    when(mockAppApi.listStatefulSetForAllNamespaces()).thenResolve({
+      response: {} as unknown as any,
+      body: {
+        items: [
+          {
+            metadata: {
+              namespace: 'TEST',
+            },
+            spec: {
+              selector: {
+                matchLabels: {
+                  test: 'TEST-DEPLOYMENT',
+                },
+              },
+            },
+          },
+        ],
+      } as unknown as any,
+    })
+    when(mockAppApi.listDaemonSetForAllNamespaces()).thenResolve({
+      response: {} as unknown as any,
+      body: {
+        items: [
+          {
+            metadata: {
+              namespace: 'TEST',
+            },
+            spec: {
+              selector: {
+                matchLabels: {
+                  test: 'TEST-DEPLOYMENT',
+                },
+              },
+            },
+          },
+        ],
+      } as unknown as any,
+    })
+    when(
+      mockCore.listNamespacedPod(
+        anything(),
+        anything(),
+        anything(),
+        anything(),
+        anything(),
+        anything()
+      )
+    ).thenResolve({
+      response: {} as unknown as any,
+      body: {
+        items: [
+          {
+            status: {
+              containerStatuses: [
+                {
+                  name: 'test1',
+                  started: true,
+                  imageID: 'name@TEST',
+                },
+                {
+                  name: 'test2',
+                  started: true,
+                  imageID: 'name@TEST',
+                },
+              ],
+            },
+            spec: {
+              nodeName: 'TEST-NODE',
+              containers: [
+                {
+                  name: 'test1',
+                  image: 'busybox:latest',
+                  imagePullPolicy: 'Always',
+                },
+                {
+                  name: 'test2',
+                  image: 'alpine:latest',
+                  imagePullPolicy: 'Never',
+                },
+              ],
+            },
+          },
+        ] as unknown as any,
+      },
+    })
+    when(mockCore.readNode(anything())).thenResolve({
+      response: {} as unknown as any,
+      body: {
+        metadata: {
+          name: 'TEST-NODE',
+          labels: {},
+        },
+      } as unknown as any,
+    })
+
+    // WHEN
+    const imageList = await service.getImageList()
+
+    // THEN
+    expect(
+      imageList.some(
+        (iD) => iD.pullPolicy === 'IfNotPresent' || iD.pullPolicy === 'Never'
+      )
+    ).toBeFalsy()
+    expect(imageList.length).toEqual(3)
+  })
 })

src/kubernetes/k8s.service.spec.ts

@@ -35,6 +35,7 @@ export interface ImageDescriptor {
   owner: Resource
   nodes: string[]
   arch: string
+  pullPolicy: string
 }
 
 export interface IK8sService {
@@ -95,6 +96,10 @@ function getImageHash(container: V1Container, pod: V1Pod): string {
   return matchedStatuses[0].imageID.split('@')[1]
 }
 
+function getPullPolicy(container: V1Container): string {
+  return container.imagePullPolicy
+}
+
 function getResourceType(
   controllerObj: V1StatefulSet | V1Deployment | V1DaemonSet
 ): ResourceType {
@@ -126,6 +131,7 @@ async function getImageDescriptors(
   const node = await getNode(pod.spec.nodeName, coreClient)
   return pod.spec.containers.map((container: V1Container): ImageDescriptor => {
     return {
+      pullPolicy: getPullPolicy(container),
       repository: getImageRepo(container),
       tag: getImageTag(container),
       hash: getImageHash(container, pod),
@@ -183,7 +189,7 @@ export class K8sService implements IK8sService {
       )
     )
       .flat()
-      .filter((obj) => obj != null)
+      .filter((obj) => obj != null && obj.pullPolicy === 'Always')
   }
 
   async triggerRollingUpdate(resource: Resource): Promise<void> {