Return meaningful error types depending on what failed

github · Aug 25, 2021 · 70d83e3 · 70d83e3
1 parent 533bb57
commit 70d83e3
Show file tree

Hide file tree

Showing 2 changed files with 55 additions and 5 deletions.
diff --git a/__tests__/main.test.ts b/__tests__/main.test.ts
@@ -2,6 +2,7 @@ import * as core from '@actions/core'
 import {Context} from '@actions/github/lib/context'
 import {APIClient} from '../src/api-client'
 import {Updater} from '../src/updater'
+import {ImageService} from '../src/image-service'
 import * as inputs from '../src/inputs'
 import {run} from '../src/main'
 
@@ -178,6 +179,40 @@ describe('run', () => {
     })
   })
 
+  describe('when there is an error pulling images', () => {
+    beforeEach(() => {
+      jest
+        .spyOn(ImageService, 'pull')
+        .mockImplementationOnce(
+          jest.fn(async () =>
+            Promise.reject(new Error('error pulling an image'))
+          )
+        )
+
+      process.env.GITHUB_EVENT_PATH = eventFixturePath('default')
+      process.env.GITHUB_EVENT_NAME = 'workflow_dispatch'
+      context = new Context()
+    })
+
+    test('it fails the workflow', async () => {
+      await run(context)
+
+      expect(core.setFailed).toHaveBeenCalledWith(
+        expect.stringContaining('error pulling an image')
+      )
+    })
+
+    test('it relays a failure message to the dependabot service', async () => {
+      await run(context)
+
+      expect(reportJobErrorSpy).toHaveBeenCalledWith({
+        'error-type': 'actions_workflow_image',
+        'error-detail': 'error pulling an image'
+      })
+      expect(markJobAsProcessedSpy).toHaveBeenCalled()
+    })
+  })
+
   describe('when there is an error running the update', () => {
     beforeEach(() => {
       jest
@@ -205,7 +240,7 @@ describe('run', () => {
       await run(context)
 
       expect(reportJobErrorSpy).toHaveBeenCalledWith({
-        'error-type': 'actions_workflow_unknown',
+        'error-type': 'actions_workflow_updater',
         'error-detail': 'error running the update'
       })
       expect(markJobAsProcessedSpy).toHaveBeenCalled()

diff --git a/src/main.ts b/src/main.ts
@@ -13,7 +13,9 @@ export const PROXY_IMAGE_NAME =
   'docker.pkg.github.com/github/dependabot-update-job-proxy:latest'
 
 export enum DependabotErrorType {
-  Unknown = 'actions_workflow_unknown'
+  Unknown = 'actions_workflow_unknown',
+  Image = 'actions_workflow_image',
+  UpdateRun = 'actions_workflow_updater'
 }
 
 export async function run(context: Context): Promise<void> {
@@ -42,10 +44,23 @@ export async function run(context: Context): Promise<void> {
         details,
         credentials
       )
-      await ImageService.pull(UPDATER_IMAGE_NAME)
-      await ImageService.pull(PROXY_IMAGE_NAME)
 
-      await updater.runUpdater()
+      try {
+        await ImageService.pull(UPDATER_IMAGE_NAME)
+        await ImageService.pull(PROXY_IMAGE_NAME)
+      } catch (error) {
+        failJob(apiClient, error, DependabotErrorType.Image)
+        core.setFailed(error.message)
+        return
+      }
+
+      try {
+        await updater.runUpdater()
+      } catch (error) {
+        failJob(apiClient, error, DependabotErrorType.UpdateRun)
+        core.setFailed(error.message)
+        return
+      }
       core.info('🤖 ~fin~')
     } catch (error) {
       // Update Dependabot API on the job failure