refactor: migrate tests to Vitest + TS #1202

jescalada · 2025-09-14T11:40:02Z

Fixes #1150, built on top of #1166.

Not all tests were perfectly refactored from Chai/Mocha -> Vitest. Some required partial or total rewriting to get them to play nice.

Some tests, specifically the proxy-related tests (proxy.test.ts, testProxy.test.ts and most importantly testProxyRoute.test.ts) have been very problematic for some reason - the tests in testPush.test.ts seem to fail in the CI when some of the proxy tests execute prior. They fail on the first execution locally, and then pass without issue (maybe a caching/cleanup problem).

Coverage has dropped somewhat to 80.5%, but we should see an increase after removing unused/untested code such as plugin stuff.

Note that the CI is failing due to the new Blue Oak license.

…e-ts-refactor-redone

Co-authored-by: j-k <[email protected]> Signed-off-by: Juan Escalada <[email protected]>

This will be removed in a later PR once the new CLI tests are converted to Vitest

… files

06kellyjac · 2025-10-24T13:36:05Z

I think we discussed "BlueOak-1.0.0" before and can add it to the licenses list

jescalada · 2025-11-03T16:33:30Z

@pGrovesy @grovesy This is the other big PR that could use a review! 🙏🏼

kriswest

A huge contribution (reading it took half a day!).

A few questions about type overrides as and whether some can be removed for type safety in the tests. The schema docs generator also needs to be run (type generator was run). There's also a few places you could use vitest's assert to simplify checks.

I spotted a number of things that aren't really within the scope of this PR and commented on them. If on reviewing them you agree, either you or I should create issues to resolve those.

.github/workflows/dependency-review.yml

kriswest · 2025-11-10T15:41:47Z

config.schema.json

                "password": {
                  "type": "string",
                  "description": "Password for the given `username`."
+                },


Are you able to run the schema docs generator (gen-schema-doc) to add these properties to the config reference? Give me a shout if not (i.e. if you haven't got the python env setup needed to do so).

You have run the quicktype generator (generate-config-types).

kriswest · 2025-11-10T15:51:52Z

src/config/index.ts

  const config = loadFullConfiguration();
+
+  if (!config.cookieSecret) {
+    throw new Error('cookieSecret is not set!');


We should possibly make cookieSecret required in the config schema. Currently none of the top-level properties are required... but then that lets you validate a file full of overrides (as long as the defaults cover everything that is actually required). However, its leading to our generated type for the config having these properties as optional.

This may be worth some further thought - we could have two top-level schemas (for the defaults and for override files) that reference the same defs for top-level properties I suppose. That would give us two different typescript types to use, as appropriate.

kriswest · 2025-11-10T15:54:37Z

src/config/index.ts

+export const getSessionMaxAgeHours = (): number => {
  const config = loadFullConfiguration();
-  return config.sessionMaxAgeHours;
+  return config.sessionMaxAgeHours || 24;


As above - no default needed if it has to be in the defaults and we have a type expressing that.

kriswest · 2025-11-10T15:59:03Z

src/proxy/processors/push-action/checkCommitMessages.ts

-    console.log('No commit message included...');
-    return false;
-  }
+    console.log(`isMessageAllowed(${commitMessage})`);


this is (existing) debug output, we should drop it or start doing a better job with logging!

Not a blocker for this PR, but a note to self/reminder

There are several other places that info on why the message has failed the check is just being logged. We should refactor this to return an error message or null and then carry that forward into step.log messages, as that'll make illegal messages way less annoying to debug and we can drop all the debug logging here.

kriswest · 2025-11-11T13:05:02Z

test/testPush.test.ts

+            ],
+          },
+        });
+      expect(res.status).toBe(401);


This should probably be a 403 - not an issue for this PR

kriswest · 2025-11-11T13:05:31Z

test/testPush.test.ts

+            ],
+          },
+        });
+      expect(res.status).toBe(401);


This should probably be a 403

kriswest · 2025-11-11T13:05:51Z

test/testPush.test.ts

+            {
+              label: 'I am happy for this to be pushed to the upstream repository',
+              tooltip: {
+                text: 'Are you happy for this contribution to be pushed upstream?',
+                links: [],
+              },
+              checked: true,
+            },
+          ],
+        },
+      });
+    expect(res.status).toBe(401);


This should probably be a 403

kriswest · 2025-11-11T13:06:54Z

test/testPush.test.ts

+          ],
+        },
+      });
+    expect(res.status).toBe(401);


This should probably be a 403, etc. will stop marking them here

kriswest · 2025-11-11T13:15:48Z

vitest.config.ts

@@ -0,0 +1,35 @@
+import { defineConfig } from 'vitest/config';


Should there be a vitest config file for the cli tests as well?

jescalada and others added 30 commits August 24, 2025 09:39

refactor(ts): passport/activeDirectory

d3d73d9

chore: add missing types

ba086f1

refactor(ts): JWT handler and utils

0c7d1fb

refactor(ts): passport/index

b419f4e

refactor(ts): passport/local

06a64ea

refactor(ts): passport/ldaphelper

4dfbc2d

refactor(ts): passport/oidc

09a1876

refactor(ts): auth routes

abc09bd

refactor(ts): config routes

03c4952

refactor(ts): misc routes and index

7ed9eb0

refactor(ts): push routes and update related types/db handlers

3d99de2

refactor(ts): repo routes

944e0b5

refactor(ts): user routes

6a7089f

refactor(ts): emailSender and missing implementation

6c9d3bf

refactor(ts): service/index and missing types

6899e4e

refactor(ts): urls

63c30a0

fix: failing tests due to incorrect imports

812a910

chore: update .eslintrc

9d5bdd8

chore: fix type checks

c951015

chore: fix CLI service imports

b046903

Merge branch 'main' of https://github.com/finos/git-proxy into servic…

97ad7c7

…e-ts-refactor-redone

chore: run npm format

9008ac5

test: add basic oidc tests and ignore openid-client type error on import

f36b3d1

test: increase testOidc and testPush coverage

51df315

test: improve push test coverage

f7ed291

test: add missing smtp tests

b2b1b14

Update .eslintrc.json

ae43800

Co-authored-by: j-k <[email protected]> Signed-off-by: Juan Escalada <[email protected]>

Update src/db/file/users.ts

17a8adf

Co-authored-by: j-k <[email protected]> Signed-off-by: Juan Escalada <[email protected]>

Update src/service/passport/jwtAuthHandler.ts

c7cf87e

Co-authored-by: j-k <[email protected]> Signed-off-by: Juan Escalada <[email protected]>

Update src/service/passport/index.ts

8aa1a97

Co-authored-by: j-k <[email protected]> Signed-off-by: Juan Escalada <[email protected]>

jescalada added 7 commits October 12, 2025 00:35

chore: temporarily skip proxy tests to prevent errors

73e5d8b

chore: temporarily skip problematic proxy route tests

f1920c9

chore: temporarily add ts-mocha to CLI dev deps

5f4ac95

This will be removed in a later PR once the new CLI tests are converted to Vitest

chore: update vitest config to limit coverage check to API

52cfaab

chore: exclude more unnecessary files in coverage and include only TS…

c9b324a

… files

chore: exclude type files from coverage check

a268711

test: rewrite proxy filter tests and new ones for helpers

41abea2

jescalada marked this pull request as ready for review October 14, 2025 04:07

jescalada requested review from a team, 06kellyjac, coopernetes and kriswest October 14, 2025 04:16

jescalada and others added 5 commits October 14, 2025 13:20

chore: bump vite to latest

65aa650

Merge branch 'main' into 1150-vitest-migration-from-service

4909c03

chore: update package-lock.json and remove unused JS test

51478b0

fix: failing tests and formatting

bfa4374

Merge branch 'main' into 1150-vitest-migration-from-service

b375597

jescalada and others added 4 commits October 27, 2025 10:57

chore: add BlueOak-1.0.0 to allowed licenses list

c3995c5

Merge branch 'main' into 1150-vitest-migration-from-service

4b1adbc

Merge branch 'main' into 1150-vitest-migration-from-service

ef6b730

Merge branch 'main' into 1150-vitest-migration-from-service

2350b59

jescalada mentioned this pull request Oct 31, 2025

test: add ESM plugin tests #1265

Closed

kriswest mentioned this pull request Nov 3, 2025

3rd November 2025 - GitProxy Meeting Minutes #1259

Open

20 tasks

Merge branch 'main' into 1150-vitest-migration-from-service

9951967

jescalada and others added 3 commits November 5, 2025 21:12

Merge branch 'main' into 1150-vitest-migration-from-service

8e38584

Merge branch 'main' into 1150-vitest-migration-from-service

ea1f875

Merge branch 'main' into 1150-vitest-migration-from-service

1a42226

kriswest requested changes Nov 11, 2025

View reviewed changes

		@@ -0,0 +1,35 @@
		import { defineConfig } from 'vitest/config';

refactor: migrate tests to Vitest + TS #1202

Are you sure you want to change the base?

refactor: migrate tests to Vitest + TS #1202

Conversation

jescalada commented Sep 14, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

06kellyjac commented Oct 24, 2025

Uh oh!

jescalada commented Nov 3, 2025

Uh oh!

kriswest left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

jescalada commented Sep 14, 2025 •

edited

Loading