enable retryable commands

__tests__/main.test.ts

@@ -1,4 +1,4 @@
-import {execaCommandRunner, getIssueNumber} from '../src/utils/generic'
+import {execaCommandRunner, getIssueNumber, getNumberRange} from '../src/utils/generic'
 import * as fs from 'fs'
 import {promisify} from 'util'
 
@@ -36,3 +36,20 @@ test('Long Running Command With Timeout', async () => {
     )
     expect(state).toBeGreaterThan(0)
 }, 300000)
+
+test('Retry Some Commands', async () => {
+    const retry = getNumberRange(10)
+    for (let attempt = 0; attempt <= retry.length; attempt++) {
+        console.log(`Attempt ${attempt}`)
+        const state = await execaCommandRunner(
+            'bash',
+            ['invlidcommand'],
+            new Map<string, string>(),
+            null,
+            null,
+            null,
+            null
+        )
+        expect(state).toBeGreaterThan(0)
+    }
+})

action.yml

@@ -25,6 +25,10 @@ inputs:
     required: false
     description: 'Force Install the Test tool even if the Env does not need it'
     default: "false"
+  test-failure-retry:
+    required: false
+    description: 'Number of Retries to be performed on a failed tests. This is to account for some flaky tests'
+    default: '0'
   linter-infra-tool:
     required: false
     description: 'Tool used to perming linting operation on the repository'

src/test-infra/tox.ts

@@ -10,11 +10,13 @@ class ToxInfra implements TestInfra {
     version: string
     additionalArgs: string
     argMap: Map<string, string> = new Map<string, string>()
+    retry: number
 
     constructor(version: string, force: boolean, additionalArg: string) {
         this.name = 'tox'
         this.version = version
         this.force = force
+        this.retry = parseInt(core.getInput('test-failure-retry'))
         this.additionalArgs = additionalArg
         this.argMap = argToMap(additionalArg)
         for (const k of this.argMap.keys()) {
@@ -127,12 +129,21 @@ class ToxInfra implements TestInfra {
                 additionalArg.push(...[k, v])
             }
         }
-        const state = await commandRunner('tox', additionalArg, true, null, null)
-
-        if (state !== 0) {
-            throw new Error(`Tox Environment ${this.envName()} run completed with an exit code ${state}`)
+        if (isNaN(this.retry) || this.retry < 1) {
+            this.retry = 1
+        }
+        const retry = [...Array(this.retry).keys()]
+        for (let attempt = 1; attempt <= retry.length; attempt++) {
+            core.startGroup(`[Attempt ${attempt}] Run Unit Tests using Tox`)
+            const state = await commandRunner('tox', additionalArg, true, null, null)
+            core.endGroup()
+            if (state === 0) {
+                return Promise.resolve(state)
+            } else if (attempt >= retry.length) {
+                throw new Error(`Tox Environment ${this.envName()} run completed with an exit code ${state}`)
+            }
         }
-        return state
+        return Promise.resolve(1)
     }
 
     async setVersion(): Promise<number> {

src/utils/generic.ts

@@ -265,3 +265,7 @@ export async function getIssueNumber(jsonString: string): Promise<number> {
     const issueNumber = jsonPath.JSONPath({path: issuePathFilter, json: JSON.parse(jsonString)})[0]
     return Promise.resolve(parseInt(issueNumber.toString()))
 }
+
+export function getNumberRange(count: number): number[] {
+    return [...Array(count).keys()]
+}