Merge pull request #1857 from alphagov/migration-script-will-now-repo…

…rt-head-and-script-failures Migration will now report head and script failures
alphagov · Dec 19, 2022 · 523bed7 · 523bed7
2 parents e4dac2e + 1f3dc3e
commit 523bed7
Show file tree

Hide file tree

Showing 2 changed files with 30 additions and 7 deletions.
diff --git a/lib/migrator/migrationSteps.js b/lib/migrator/migrationSteps.js
@@ -199,18 +199,17 @@ module.exports.upgradeIfUnchanged = (filePaths, starterFilePath, additionalStep)
 
   const reporter = await addReporter(`Overwrite ${filePath}`)
 
-  if (!matchFound) {
-    await reporter(false)
-    return false
-  }
-
   let result = false
   try {
-    await copyFileFromStarter(starterFilePath || filePath, filePath)
+    if (matchFound) {
+      await copyFileFromStarter(starterFilePath || filePath, filePath)
+    } else {
+      await reporter(false)
+    }
     if (additionalStep) {
       result = await additionalStep()
     } else {
-      result = true
+      result = matchFound
     }
   } catch (e) {
     await verboseLog(e.message)

diff --git a/lib/migrator/migrationSteps.spec.js b/lib/migrator/migrationSteps.spec.js
@@ -51,6 +51,7 @@ describe('migration steps', () => {
   beforeEach(() => {
     fileHelpers.replaceStartOfFile.mockResolvedValue(true)
     fileHelpers.getFileAsLines.mockResolvedValue(true)
+    fileHelpers.matchAgainstOldVersions.mockResolvedValue(true)
   })
 
   afterEach(() => {
@@ -283,6 +284,29 @@ describe('migration steps', () => {
     expect(mockReporter).toHaveBeenCalledWith(true)
   })
 
+  it('report if changed layout', async () => {
+    const layout = 'app/views/layout.html'
+    const additionalStep = jest.fn().mockResolvedValue(true)
+
+    fileHelpers.matchAgainstOldVersions.mockReturnValue(false)
+
+    const result = await upgradeIfUnchanged([layout], layout, additionalStep)
+
+    expect(result).toBeTruthy()
+
+    expect(fileHelpers.matchAgainstOldVersions).toHaveBeenCalledTimes(1)
+    expect(fileHelpers.matchAgainstOldVersions).toHaveBeenCalledWith(layout)
+
+    expect(additionalStep).toHaveBeenCalledTimes(1)
+    expect(additionalStep).toHaveBeenCalled()
+
+    expect(reporter.addReporter).toHaveBeenCalledTimes(1)
+    expect(reporter.addReporter).toHaveBeenCalledWith(`Overwrite ${layout}`)
+
+    expect(mockReporter).toHaveBeenCalledTimes(2)
+    expect(mockReporter).toHaveBeenCalledWith(true)
+  })
+
   it('delete if unchanged unbranded layout', async () => {
     const unbrandedLayout = 'app/views/layout_unbranded.html'