test: cleanup and centralize test utils

Signed-off-by: Sam Gammon <[email protected]>

Author: sgammon

__tests__/command.test.ts

@@ -1,10 +1,18 @@
 import * as command from '../src/command'
-import { withTestBinary } from './utils'
+import { setupCoreMocks, withTestBinary } from './utils'
+
+const { clearMocks, resetState } = setupCoreMocks()
 
 describe('action transport tools', () => {
   beforeEach(() => {
     jest.clearAllMocks()
   })
+  afterEach(() => {
+    clearMocks()
+  })
+  afterAll(async () => {
+    await resetState()
+  })
 
   it('can obtain the current buildless cli version', async () => {
     withTestBinary(async () => {

__tests__/index.test.ts

@@ -1,17 +1,21 @@
-/**
- * Unit tests for the action's entrypoint, src/index.ts
- */
-
 import * as main from '../src/main'
+import { setupCoreMocks } from './utils'
 
-const runMock = jest.spyOn(main, 'entry').mockImplementation()
-const cleanupMock = jest.spyOn(main, 'cleanup').mockImplementation()
+const { clearMocks, resetState } = setupCoreMocks()
+const runMock = jest.spyOn(main, 'entry').mockImplementation(() => Promise.resolve())
+const cleanupMock = jest.spyOn(main, 'cleanup').mockImplementation(() => Promise.resolve())
 
 describe('index', () => {
+  afterEach(() => {
+    clearMocks()
+  })
+  afterAll(async () => {
+    await resetState()
+  })
+
   it('calls entrypoint when imported', async () => {
     // eslint-disable-next-line @typescript-eslint/no-require-imports
     require('../src/index')
-
     expect(runMock).toHaveBeenCalled()
   })
 })
@@ -20,7 +24,6 @@ describe('cleanup', () => {
   it('calls entrypoint when imported', async () => {
     // eslint-disable-next-line @typescript-eslint/no-require-imports
     require('../src/cleanup')
-
     expect(cleanupMock).toHaveBeenCalled()
   })
 })

__tests__/main.test.ts

@@ -1,24 +1,20 @@
-import * as core from '@actions/core'
+import { setupCoreMocks } from './utils'
 import * as main from '../src/main'
 import { ActionOutputName } from '../src/outputs'
 
+const { setupMocks, clearMocks, resetState, errorMock, getInputMock, setFailedMock, setOutputMock } = setupCoreMocks()
 const runMock = jest.spyOn(main, 'entry')
 
-let debugMock: jest.SpyInstance
-let errorMock: jest.SpyInstance
-let getInputMock: jest.SpyInstance
-let setFailedMock: jest.SpyInstance
-let setOutputMock: jest.SpyInstance
-
 describe('action entry', () => {
   beforeEach(() => {
     jest.clearAllMocks()
-
-    debugMock = jest.spyOn(core, 'debug').mockImplementation()
-    errorMock = jest.spyOn(core, 'error').mockImplementation()
-    getInputMock = jest.spyOn(core, 'getInput').mockImplementation()
-    setFailedMock = jest.spyOn(core, 'setFailed').mockImplementation()
-    setOutputMock = jest.spyOn(core, 'setOutput').mockImplementation()
+    setupMocks()
+  })
+  afterEach(() => {
+    clearMocks()
+  })
+  afterAll(async () => {
+    await resetState()
   })
 
   it('sets the path and version outputs', async () => {
@@ -41,7 +37,7 @@ describe('action entry', () => {
       ActionOutputName.VERSION,
       expect.anything()
     )
-  }, 30000)
+  })
 
   it('sets a failed status', async () => {
     // Set the action's inputs as return values from core.getInput()

__tests__/releases.test.ts

@@ -1,22 +1,18 @@
-import * as core from '@actions/core'
-import * as github from '@actions/github'
 import * as releases from '../src/releases'
+import { setupCoreMocks } from './utils'
 
+const { resetState, setupMocks } = setupCoreMocks()
 const resolveLatestMock = jest.spyOn(releases, 'resolveLatestVersion')
 
-let debugMock: jest.SpyInstance
-let errorMock: jest.SpyInstance
-let setFailedMock: jest.SpyInstance
-let getOctokitMock: jest.SpyInstance
-
 describe('release utilities', () => {
   beforeEach(() => {
     jest.clearAllMocks()
-    debugMock = jest.spyOn(core, 'debug').mockImplementation()
-    errorMock = jest.spyOn(core, 'error').mockImplementation()
-    setFailedMock = jest.spyOn(core, 'setFailed').mockImplementation()
-    getOctokitMock = jest.spyOn(github, 'getOctokit').mockImplementation()
+    setupMocks()
+  })
+  afterAll(async () => {
+    await resetState()
   })
+
   it('can resolve the latest buildless release', async () => {
     const result = await releases.resolveLatestVersion()
     expect(result).not.toBeNull()

__tests__/transport.test.ts

@@ -1,10 +1,16 @@
 import * as transport from '../src/transport'
 import { RpcTransport } from '../src/config'
+import { setupCoreMocks } from './utils'
+
+const { resetState } = setupCoreMocks()
 
 describe('action transport tools', () => {
   beforeEach(() => {
     jest.clearAllMocks()
   })
+  afterAll(async () => {
+    await resetState()
+  })
 
   it('can provide a configured rpc transport', async () => {
     const engine = transport.obtainTransport()

__tests__/utils.ts

@@ -1,7 +1,12 @@
 import path from 'node:path'
 import fs from 'node:fs'
+import * as core from '@actions/core'
+import * as exec from '@actions/exec'
+import * as github from '@actions/github'
 import { opendir, access } from 'node:fs/promises'
 import { setBinpath } from '../src/command'
+import { onExit } from '../src/diagnostics'
+import { httpClient } from '../src/config'
 import { install as installBuildless } from '../src/main'
 
 /**
@@ -64,3 +69,55 @@ export async function withTestBinary<R>(
   setBinpath(binpath)
   return await fn(binpath)
 }
+
+export function resetState() {
+  onExit(false)
+}
+
+export function setupCoreMocks(): {
+  debugMock: jest.SpyInstance,
+  errorMock: jest.SpyInstance,
+  getInputMock: jest.SpyInstance,
+  setFailedMock: jest.SpyInstance,
+  setOutputMock: jest.SpyInstance,
+  getJsonMock: jest.SpyInstance,
+  getOctokitMock: jest.SpyInstance,
+  execMock: jest.SpyInstance,
+  clearMocks: () => void,
+  setupMocks: () => void,
+  resetState: () => void,
+} {
+  let debugMock: jest.SpyInstance = jest.spyOn(core, 'debug')
+  let errorMock: jest.SpyInstance = jest.spyOn(core, 'error')
+  let getInputMock: jest.SpyInstance = jest.spyOn(core, 'getInput')
+  let setFailedMock: jest.SpyInstance = jest.spyOn(core, 'setFailed')
+  let setOutputMock: jest.SpyInstance = jest.spyOn(core, 'setOutput')
+  let execMock: jest.SpyInstance = jest.spyOn(exec, 'exec')
+  let getOctokitMock: jest.SpyInstance = jest.spyOn(github, 'getOctokit').mockImplementation()
+  let getJsonMock: jest.SpyInstance = jest.spyOn(httpClient, 'getJson').mockImplementation()
+
+  return {
+    debugMock,
+    errorMock,
+    getInputMock,
+    setFailedMock,
+    setOutputMock,
+    getJsonMock,
+    getOctokitMock,
+    execMock,
+    resetState: () => {
+      resetState()
+    },
+    clearMocks: () => {
+      // Nothing at this time.
+    },
+    setupMocks: () => {
+      execMock = jest.spyOn(exec, 'exec').mockImplementation()
+      debugMock = jest.spyOn(core, 'debug').mockImplementation()
+      errorMock = jest.spyOn(core, 'error').mockImplementation()
+      getInputMock = jest.spyOn(core, 'getInput').mockImplementation()
+      setFailedMock = jest.spyOn(core, 'setFailed').mockImplementation()
+      setOutputMock = jest.spyOn(core, 'setOutput').mockImplementation()
+    },
+  }
+}