feat: attempt to migrate values on recovery from the values repo

Author: j-zimnowoda

src/cmd/migrate.test.ts

@@ -3,6 +3,7 @@ import {
   applyChanges,
   Changes,
   filterChanges,
+  needsMigration,
   processDeletionEntry,
   removeSopsArtifacts,
   sopsMigration,
@@ -442,3 +443,33 @@ describe('processDeletionEntry', () => {
     expect(mockDeleteFile).not.toHaveBeenCalled()
   })
 })
+
+describe('needsMigration', () => {
+  const makeLoadYaml =
+    (repoSpecVersion: number | undefined, defaultSpecVersion: number | undefined) =>
+    async (path: string, _opts?: any): Promise<any> => {
+      if (path.includes('versions.yaml')) return repoSpecVersion !== undefined ? { spec: { specVersion: repoSpecVersion } } : undefined
+      if (path.includes('defaults.yaml')) return defaultSpecVersion !== undefined ? { versions: { specVersion: defaultSpecVersion } } : undefined
+      return undefined
+    }
+
+  it('returns true when repo specVersion differs from defaults specVersion', async () => {
+    const result = await needsMigration({ loadYaml: makeLoadYaml(69, 70) })
+    expect(result).toBe(true)
+  })
+
+  it('returns false when repo specVersion matches defaults specVersion', async () => {
+    const result = await needsMigration({ loadYaml: makeLoadYaml(70, 70) })
+    expect(result).toBe(false)
+  })
+
+  it('returns false when versions.yaml is missing', async () => {
+    const result = await needsMigration({ loadYaml: makeLoadYaml(undefined, 70) })
+    expect(result).toBe(false)
+  })
+
+  it('returns false when defaults.yaml is missing', async () => {
+    const result = await needsMigration({ loadYaml: makeLoadYaml(69, undefined) })
+    expect(result).toBe(false)
+  })
+})

src/cmd/migrate.ts

@@ -850,6 +850,15 @@ export const setAtPath = (path: string, values: Record<string, any>, value: stri
   paths.forEach((p) => set(values, p, Array.isArray(value) ? [...value] : value))
 }
 
+export const needsMigration = async (deps = { loadYaml }): Promise<boolean> => {
+  const defaults = await deps.loadYaml(`${rootDir}/helmfile.d/snippets/defaults.yaml`, { noError: true })
+  const defaultSpecVersion: number = defaults?.versions?.specVersion
+  const versions = await deps.loadYaml(`${env.ENV_DIR}/env/settings/versions.yaml`, { noError: true })
+  const repoSpecVersion: number = versions?.spec?.specVersion
+  if (!repoSpecVersion || !defaultSpecVersion) return false
+  return repoSpecVersion !== defaultSpecVersion
+}
+
 export const migrate = async (): Promise<boolean> => {
   const d = terminal(`cmd:${cmdName}:migrate`)
   const argv: Arguments = getParsedArgs()

src/operator/main.ts

@@ -3,9 +3,12 @@ import fs from 'fs'
 import process from 'node:process'
 import path from 'path'
 import { retryInstallStep } from '../cmd/install'
+import { commit } from '../cmd/commit'
+import { needsMigration } from '../cmd/migrate'
 import { terminal } from '../common/debug'
 import { env } from '../common/envalid'
 import { getStoredGitRepoConfig } from '../common/git-config'
+import { getDefaultValues, writeValues } from '../common/values'
 import { AplOperations } from './apl-operations'
 import { AplOperator, AplOperatorConfig } from './apl-operator'
 import { GitRepository } from './git-repository'
@@ -79,6 +82,14 @@ async function main(): Promise<void> {
       await installer.ensureRecoveryPrerequisites()
       await installer.applyRecoveryManifests()
       await installer.recoverFromGit()
+      if (await needsMigration()) {
+        d.info('specVersion mismatch detected, running migration before install')
+        const defaultValues = await getDefaultValues()
+        await writeValues(defaultValues)
+        await aplOps.migrate()
+        const gitConfig = await getStoredGitRepoConfig()
+        await commit(gitConfig)
+      }
       d.info('Recovery installation completed, switching installation mode to standard')
       await installer.resetRecoveryModeToStandard()
       await installer.reconcileInstall()