use vitest for integration tests (#1444)

* install vitest

* add chrome flags for autoplay policy

* add vitest import

* change timeout config to be compatible with vitest API

* fixup installation

* upgrade package.json

* change xit to supported api  for vitest

* use timeout api for vitest

* WIP

* delete deprecated tslint and add rule for type export

* apply eslint fix for import type

* add global variable to vitest config

* remove webdriver lib from tsconfig

* update memory test to be compliant with vitest API

* update package script to run memory test wiht vitest

* add missing import for vitest

* remove chai from project and replace it by vitest assertion lib

* try to upgrade node version in CI to fix bug

* remove chai types

* bump package version

* add a vitest config

* create a globalSetup for vitest

* change to new timeout api

* change require to import for raw and arraybuffer file

* fix: enable browser mode

* rename tests files to .test.js

* update package.json scripts

* lint

* update CI to use npm script

* Remove now unneeded dependencies

* Re-add @vitest/browser

* Remove notion of mocha chai and sinon from CONTRIBUTING.md, replacing it by vitest

* Remove reliance on sinon for fake timers and stubs

* parametrize test config so it can run on firefox

* use cross-env for compatibility

* delete useless files and lint

* increase timeout for a flaky test

* skip problematic test on firefox

* fix

* skip test

* delete file globalSetup

* PR feedback

* specify the folder scenario for integration tests

* rename files

* make port param optional

---------

Co-authored-by: Paul Berberian <[email protected]>

Author: Florent-Bouisset

.eslintrc.js

@@ -14,13 +14,7 @@ module.exports = {
     project: "tsconfig.eslint.json",
     sourceType: "module",
   },
-  plugins: [
-    "eslint-plugin-import",
-    "eslint-plugin-jsdoc",
-    "ban",
-    "@typescript-eslint",
-    "@typescript-eslint/tslint",
-  ],
+  plugins: ["eslint-plugin-import", "eslint-plugin-jsdoc", "ban", "@typescript-eslint"],
   rules: {
     "ban/ban": [
       2,
@@ -80,6 +74,7 @@ module.exports = {
       },
     ],
     "@typescript-eslint/consistent-type-imports": "error",
+    "@typescript-eslint/consistent-type-exports": "error",
     "@typescript-eslint/naming-convention": [
       "error",
       {
@@ -309,27 +304,5 @@ module.exports = {
     "use-isnan": "error",
     "valid-typeof": "error",
     yoda: "error",
-    "@typescript-eslint/tslint/config": [
-      "error",
-      {
-        rules: {
-          encoding: true,
-          "import-spacing": true,
-          "prefer-while": true,
-          "return-undefined": true,
-          whitespace: [
-            true,
-            "check-branch",
-            "check-decl",
-            "check-operator",
-            "check-module",
-            "check-separator",
-            "check-type",
-            "check-typecast",
-            "check-preblock",
-          ],
-        },
-      },
-    ],
   },
 };

.github/workflows/checks.yml

@@ -39,7 +39,7 @@ jobs:
 
     strategy:
       matrix:
-        node-version: [16.x]
+        node-version: [20.x]
         # See supported Node.js release schedule at https://nodejs.org/en/about/releases/
 
     steps:
@@ -57,7 +57,7 @@ jobs:
 
     strategy:
       matrix:
-        node-version: [16.x]
+        node-version: [20.x]
         # See supported Node.js release schedule at https://nodejs.org/en/about/releases/
 
     steps:
@@ -75,7 +75,7 @@ jobs:
 
     strategy:
       matrix:
-        node-version: [16.x]
+        node-version: [20.x]
         # See supported Node.js release schedule at https://nodejs.org/en/about/releases/
 
     steps:
@@ -93,14 +93,14 @@ jobs:
       - run: npm run build
       # Firefox seems to have issue with integration tests on GitHub actions only
       # TODO to check
-      - run: node tests/integration/run.mjs --bchromehl
+      - run: npm run test:integration
 
   memory_linux:
     runs-on: ubuntu-latest
 
     strategy:
       matrix:
-        node-version: [16.x]
+        node-version: [20.x]
         # See supported Node.js release schedule at https://nodejs.org/en/about/releases/
 
     steps:

CONTRIBUTING.md

@@ -229,7 +229,7 @@ New integration tests are not required when a new code is added. Just make sure
 those tests pass before doing a pull request by running: `npm run test:integration`.
 
 It you want to improve our integration tests, you are welcome to do so. Those are wrote in
-`tests/integration` with the help of the Mocha, Chai and Sinon libraries.
+`tests/integration` with the help of the `vitest` library.
 
 We also use a homemade library and server to serve media contents to our tests. If you
 want to know how it works, we invite you to rely on the already created tests and to read
@@ -240,7 +240,7 @@ the corresponding files.
 Memory tests replicate simple scenarios and try to detect memory leaks.
 
 You can also help us improving our memory tests. Those are written in `test/memory`. The
-testing stack used is Mocha, Chai and Sinon.
+testing library used is `vitest`.
 
 ## Documentation