Test Framework for Unit Tests

[pano9000]

Hi all,

I'd like to start a discussion that will hopefully lead to us agreeing upon a test framework, for out unit tests.
This is not about E2E tests, for which "playwright" seems to be used already.

For the couple of unit tests we currently seem to have an attempt to use "jasmine" (in the spec folder) and then some self-written mini_test test runner in the spec-es6 folder.

Do you guys have any favourite test frameworks or suggestions?

I personally only have some experience with

• Mocha/Chai/Sinon/istanbul (but not with TS – not sure how "up-to-date" this tooling is nowadays)
• native node Test Runner (which is still experimental in some areas, e.g. the mocking features)
• vitest (which I kinda liked – it also seems to be very 'Jest' like, from what I remember they were telling in their docs)

edit: PR for vitest can be found here: #977

[eliandoran]

@pano9000 , there are two kind of tests that we inherit from @zadam 's repo:

1. spec, representing the server-side tests, written in Jasmine.
2. spec-es6 which are supposed to be for the client-side, written in pure ESM plus a custom assertion library like you mentioned.

For the server, Jasmine seems to work decently. On my side I don't have a preference on the unit test side, I guess Jest or Vitest could work just fine. And we need to get rid of the handmade client-side testing tool.

[pano9000]

after rebasing to latest develop branch, and switching to Vitest's newest version v3, but the error above is now gone 🤷 :-)

[eliandoran]

@pano9000 , most likely it was caused a cyclic dependency error.
I got rid of those recently.

[pano9000]

great work :-)
I was trying to pinpoint the cause when it originally came up, but did not get to the bottom of it, so put a short pause on it
-> and now I can see you saved me some headaches ;-) Thanks!

on another note:
My vitest porting is now finished -> I've only concentrated on porting the files to vitest and setting vitest up.
I did not move any of the test files -> this we likely should still do.

also I may be mistaken, but the "etapi" tests seem to be broken (or never finished/registered?):
When I try to run them jasmine, they never seem to be properly run.
Even if I change the expected value to something else -> no change in the jasmine runner output,
even If I manually throw an error -> nothing.

I will leave them as is for now

and one last question:

There is a test-examples/demo-todo-app.spec.ts file which seems to be a demo playwright test case -> is that one still needed?
Should that be moved over to e2e folder or do we get rid of it?

[pano9000]

I'll send a PR after a final rebase – please don't do any changes to package-lock.json in the meantime :-D ;-)

[eliandoran]

I was trying to pinpoint the cause when it originally came up, but did not get to the bottom of it, so put a short pause on it

Yes, I spent a lot of hours on it. I think it might even be some kind of bug in TypeScript since it was related to import type not being enforced due to the use of JavaScript.

also I may be mistaken, but the "etapi" tests seem to be broken (or never finished/registered?):

Probably, haven't run them myself.

There is a test-examples/demo-todo-app.spec.ts file which seems to be a demo playwright test case -> is that one still needed?

I'll remove it, I still have to clean up a bit all the end-to-end tests.

I'll send a PR after a final rebase – please don't do any changes to package-lock.json in the meantime :-D ;-)

Here's a trick: you don't need to worry about package-lock.json conflicts. You can simply run npm install and it will solve the merge conflict automatically.