@skyhook-io/k8s-ui 1.5.13 → 1.6.0

package/src/utils/yaml.test.ts

@@ -0,0 +1,101 @@
+import { describe, it, expect } from 'vitest'
+import { parse as yamlParse } from 'yaml'
+import { cleanResourceForYaml, resourceToYaml } from './yaml'
+
+function makePod() {
+  return {
+    apiVersion: 'v1',
+    kind: 'Pod',
+    metadata: {
+      name: 'nginx',
+      namespace: 'default',
+      uid: 'abcd-1234',
+      resourceVersion: '99999',
+      creationTimestamp: '2026-01-01T00:00:00Z',
+      generation: 1,
+      managedFields: [{ manager: 'kubectl', operation: 'Update' }],
+      labels: { app: 'nginx' },
+      annotations: { 'kubectl.kubernetes.io/last-applied-configuration': '{}' },
+      ownerReferences: [{ kind: 'ReplicaSet', name: 'nginx-rs', uid: 'rs-uid' }],
+    },
+    spec: {
+      containers: [{ name: 'nginx', image: 'nginx:1.25' }],
+    },
+    status: {
+      phase: 'Running',
+      podIP: '10.0.0.1',
+    },
+  }
+}
+
+describe('cleanResourceForYaml', () => {
+  it('strips status', () => {
+    const cleaned = cleanResourceForYaml(makePod())
+    expect(cleaned.status).toBeUndefined()
+  })
+
+  it('strips all 5 server-generated metadata fields', () => {
+    const cleaned = cleanResourceForYaml(makePod())
+    expect(cleaned.metadata.uid).toBeUndefined()
+    expect(cleaned.metadata.resourceVersion).toBeUndefined()
+    expect(cleaned.metadata.creationTimestamp).toBeUndefined()
+    expect(cleaned.metadata.generation).toBeUndefined()
+    expect(cleaned.metadata.managedFields).toBeUndefined()
+  })
+
+  it('preserves user metadata', () => {
+    const cleaned = cleanResourceForYaml(makePod())
+    expect(cleaned.metadata.name).toBe('nginx')
+    expect(cleaned.metadata.namespace).toBe('default')
+    expect(cleaned.metadata.labels).toEqual({ app: 'nginx' })
+    expect(cleaned.metadata.annotations).toEqual({
+      'kubectl.kubernetes.io/last-applied-configuration': '{}',
+    })
+    expect(cleaned.metadata.ownerReferences).toHaveLength(1)
+  })
+
+  it('preserves spec', () => {
+    const cleaned = cleanResourceForYaml(makePod())
+    expect(cleaned.spec).toEqual({
+      containers: [{ name: 'nginx', image: 'nginx:1.25' }],
+    })
+  })
+
+  it('does not mutate the input', () => {
+    const input = makePod()
+    cleanResourceForYaml(input)
+    expect(input.status).toBeDefined()
+    expect(input.metadata.uid).toBe('abcd-1234')
+    expect(input.metadata.managedFields).toHaveLength(1)
+  })
+
+  it('returns null/undefined/primitives unchanged', () => {
+    expect(cleanResourceForYaml(null)).toBeNull()
+    expect(cleanResourceForYaml(undefined)).toBeUndefined()
+    expect(cleanResourceForYaml('not an object' as any)).toBe('not an object')
+    expect(cleanResourceForYaml(42 as any)).toBe(42)
+  })
+
+  it('handles object with no metadata field', () => {
+    const cleaned = cleanResourceForYaml({ kind: 'Pod', spec: {} })
+    expect(cleaned).toEqual({ kind: 'Pod', spec: {} })
+  })
+
+  it('handles metadata present but null', () => {
+    const cleaned = cleanResourceForYaml({ kind: 'Pod', metadata: null, spec: {} })
+    expect(cleaned).toEqual({ kind: 'Pod', metadata: null, spec: {} })
+  })
+})
+
+describe('resourceToYaml', () => {
+  it('returns empty string for null/undefined', () => {
+    expect(resourceToYaml(null)).toBe('')
+    expect(resourceToYaml(undefined)).toBe('')
+  })
+
+  it('round-trips through yaml.parse to the cleaned object', () => {
+    const cleaned = cleanResourceForYaml(makePod())
+    const yaml = resourceToYaml(makePod())
+    expect(yamlParse(yaml)).toEqual(cleaned)
+  })
+})

package/src/utils/yaml.ts

@@ -0,0 +1,26 @@
+import { stringify as yamlStringify } from 'yaml'
+
+const SERVER_GENERATED_METADATA = [
+  'managedFields',
+  'resourceVersion',
+  'uid',
+  'creationTimestamp',
+  'generation',
+] as const
+
+export function cleanResourceForYaml<T = any>(data: T): T {
+  if (!data || typeof data !== 'object') return data
+  const cleaned = structuredClone(data) as any
+  delete cleaned.status
+  if (cleaned.metadata && typeof cleaned.metadata === 'object') {
+    for (const field of SERVER_GENERATED_METADATA) {
+      delete cleaned.metadata[field]
+    }
+  }
+  return cleaned
+}
+
+export function resourceToYaml(data: any): string {
+  if (!data) return ''
+  return yamlStringify(cleanResourceForYaml(data), { lineWidth: 0, indent: 2 })
+}