From c882a9fc1414f3e2c285251a8c54b3beada15606 Mon Sep 17 00:00:00 2001
From: Elena Tanasoiu <elenatanasoiu@github.com>
Date: Thu, 23 Mar 2023 14:30:38 +0000
Subject: [PATCH] Only retry tests in CI

We introduced this change to help with reducing flakiness in CI [1].

This has a slightly different effect locally, where every failed test
will output three times.

This in turn makes it harder to read, especially when you have multiple
failing tests.

Since the original intent for this behaviour was to be used in CI, I'm
proposing we disable it when the CI env variable isn't set.

I've opted to set it for all jobs involving tests, just for consistency.
I'm happy to limit it to just the places where it's required.

[1]: https://github.com/github/vscode-codeql/pull/2059
---
 .github/workflows/main.yml                                | 1 +
 .../test/vscode-tests/jest.activated-extension.setup.ts   | 8 +++++---
 extensions/ql-vscode/test/vscode-tests/jest.setup.ts      | 8 +++++---
 3 files changed, 11 insertions(+), 6 deletions(-)

diff --git a/.github/workflows/main.yml b/.github/workflows/main.yml
index 15d1499c6..ee63d840a 100644
--- a/.github/workflows/main.yml
+++ b/.github/workflows/main.yml
@@ -199,6 +199,7 @@ jobs:
         run: echo "cli-versions=$(cat ./extensions/ql-vscode/supported_cli_versions.json | jq -rc)" >> $GITHUB_OUTPUT
     outputs:
       cli-versions: ${{ steps.set-variables.outputs.cli-versions }}
+
   cli-test:
     name: CLI Test
     runs-on: ${{ matrix.os }}
diff --git a/extensions/ql-vscode/test/vscode-tests/jest.activated-extension.setup.ts b/extensions/ql-vscode/test/vscode-tests/jest.activated-extension.setup.ts
index bf750a9ba..b05b15fbd 100644
--- a/extensions/ql-vscode/test/vscode-tests/jest.activated-extension.setup.ts
+++ b/extensions/ql-vscode/test/vscode-tests/jest.activated-extension.setup.ts
@@ -5,9 +5,11 @@ import * as tmp from "tmp";
 import { realpathSync } from "fs-extra";
 import { setStoragePath, storagePath } from "./global.helper";
 
-jest.retryTimes(3, {
-  logErrorsBeforeRetry: true,
-});
+if (process.env.CI) {
+  jest.retryTimes(3, {
+    logErrorsBeforeRetry: true,
+  });
+}
 
 // create an extension storage location
 let removeStorage: tmp.DirResult["removeCallback"] | undefined;
diff --git a/extensions/ql-vscode/test/vscode-tests/jest.setup.ts b/extensions/ql-vscode/test/vscode-tests/jest.setup.ts
index fe58b7f48..e9fd4f6c7 100644
--- a/extensions/ql-vscode/test/vscode-tests/jest.setup.ts
+++ b/extensions/ql-vscode/test/vscode-tests/jest.setup.ts
@@ -1,9 +1,11 @@
 import { env } from "vscode";
 import { beforeEachAction } from "./test-config";
 
-jest.retryTimes(3, {
-  logErrorsBeforeRetry: true,
-});
+if (process.env.CI) {
+  jest.retryTimes(3, {
+    logErrorsBeforeRetry: true,
+  });
+}
 
 beforeEach(async () => {
   jest.spyOn(env, "openExternal").mockResolvedValue(false);