Tests: migrate from karma (deprecated) to vitest

larabr · larabr · commit 1324048083fd · 2026-04-01T12:26:24.000+02:00
diff --git a/eslint.config.mjs b/eslint.config.mjs
@@ -3,8 +3,6 @@ import eslint from '@eslint/js';
 import { defineConfig } from 'eslint/config';
 import tseslint from 'typescript-eslint';
 import globals from 'globals';
-// @ts-expect-error
-import pluginChaiFriendly from 'eslint-plugin-chai-friendly';
 import pluginImport from 'eslint-plugin-import';
 // @ts-expect-error
 import pluginEnforceUint8ArrayArrayBuffer from '@protontech/eslint-plugin-enforce-uint8array-arraybuffer';
@@ -32,7 +30,6 @@ export default defineConfig(
             }
         },
         plugins: {
-            'chai-friendly': pluginChaiFriendly,
             'import': pluginImport,
             '@protontech/enforce-uint8array-arraybuffer': pluginEnforceUint8ArrayArrayBuffer,
             '@stylistic': pluginStylistic
@@ -65,7 +62,6 @@ export default defineConfig(
                 capIsNew: false
             }],
             'class-methods-use-this': 'error',
-            'chai-friendly/no-unused-expressions': [ 'error', { allowShortCircuit: true } ],
             'arrow-body-style': 'off',
             'space-before-function-paren': 'off',
             'operator-linebreak': 'off',
diff --git a/karma.conf.js b/karma.conf.js
diff --git a/package.json b/package.json
@@ -13,7 +13,7 @@
         "tsconfig.json"
     ],
     "scripts": {
-        "test": "karma start karma.conf.js",
+        "test": "vitest --config test/vitest.config.ts --run",
         "lint": "eslint eslint.config.mjs lib test",
         "postversion": "git push && git push --tags",
         "test-type-definitions": "tsc"
@@ -39,37 +39,21 @@
         "@protontech/eslint-plugin-enforce-uint8array-arraybuffer": "^2.0.0",
         "@stylistic/eslint-plugin": "^5.9.0",
         "@types/bn.js": "^5.2.0",
-        "@types/chai": "^5.2.3",
-        "@types/chai-as-promised": "^8.0.2",
         "@types/elliptic": "^6.4.18",
-        "@types/mocha": "^10.0.10",
         "@types/sinon": "^21.0.0",
-        "@types/webpack-env": "^1.18.8",
         "@typescript-eslint/eslint-plugin": "^8.56.1",
+        "@vitest/browser-playwright": "^4.1.2",
         "bn.js": "^5.2.3",
-        "chai": "^6.2.2",
-        "chai-as-promised": "^8.0.2",
         "elliptic": "^6.6.1",
         "eslint": "^9.39.3",
         "eslint-import-resolver-typescript": "^4.4.4",
-        "eslint-plugin-chai-friendly": "^1.1.0",
         "eslint-plugin-import": "^2.32.0",
-        "karma": "^6.4.4",
-        "karma-chrome-launcher": "^3.2.0",
-        "karma-firefox-launcher": "^2.1.3",
-        "karma-mocha": "^2.0.1",
-        "karma-mocha-reporter": "^2.2.5",
-        "karma-webkit-launcher": "^2.6.0",
-        "karma-webpack": "^5.0.1",
-        "mocha": "^11.7.5",
         "playwright": "^1.58.1",
         "sinon": "^21.0.1",
-        "ts-loader": "^9.5.4",
-        "typescript": "^5.9.3",
+        "typescript": "^6.0.2",
         "typescript-eslint": "^8.56.1",
-        "web-streams-polyfill": "^3.3.3",
-        "webpack": "^5.105.2",
-        "webpack-cli": "^6.0.1"
+        "vitest": "^4.1.2",
+        "web-streams-polyfill": "^3.3.3"
     },
     "packageManager": "yarn@4.10.2",
     "engines": {
diff --git a/test/bigInteger.spec.ts b/test/bigInteger.spec.ts
@@ -1,4 +1,4 @@
-import { expect } from 'chai';
+import { describe, it, expect } from 'vitest';
 
 import BN from 'bn.js';
 import { bigIntToUint8Array, bitLength, byteLength, modExp, modInv } from '../lib/bigInteger';
diff --git a/test/config.spec.ts b/test/config.spec.ts
@@ -1,4 +1,4 @@
-import { expect } from 'chai';
+import { describe, it, expect } from 'vitest';
 import { config, SymEncryptedSessionKeyPacket, GrammarError } from '../lib/openpgp';
 import { decryptMessage, readMessage, VERIFICATION_STATUS, verifyMessage, readKey, readSignature, readPrivateKey } from '../lib';
 
@@ -115,7 +115,7 @@ habAyxd1AGKaNp1wbGFpbnRleHQgbWVzc2FnZQ==
 
         await expect(
             readMessage({ armoredMessage: skeskPlusLiteralData })
-        ).to.be.rejectedWith(GrammarError);
+        ).rejects.toThrow(GrammarError);
 
         const message = await readMessage({ armoredMessage: skeskPlusLiteralData, config: { enforceGrammar: false } });
         expect(message.packets[0]).to.be.instanceOf(SymEncryptedSessionKeyPacket);
diff --git a/test/crypto/argon2.spec.ts b/test/crypto/argon2.spec.ts
@@ -1,4 +1,4 @@
-import { expect } from 'chai';
+import { describe, it, expect } from 'vitest';
 import { argon2 } from '../../lib';
 import { ARGON2_PARAMS } from '../../lib/constants';
 import { arrayToHexString, hexStringToArray } from '../../lib/utils';
diff --git a/test/crypto/hash.spec.ts b/test/crypto/hash.spec.ts
@@ -1,4 +1,4 @@
-import { expect } from 'chai';
+import { describe, it, expect } from 'vitest';
 import { unsafeMD5, unsafeSHA1, SHA256, SHA512 } from '../../lib';
 import { arrayToHexString, stringToUtf8Array } from '../../lib/utils';
 
diff --git a/test/key/check.spec.ts b/test/key/check.spec.ts
@@ -1,4 +1,4 @@
-import { expect } from 'chai';
+import { describe, it, expect } from 'vitest';
 import { checkKeyStrength, checkKeyCompatibility, readKey } from '../../lib';
 
 // Test vector from https://www.ietf.org/archive/id/draft-ietf-openpgp-pqc-09.html#appendix-A.4.1
diff --git a/test/key/forwarding.spec.ts b/test/key/forwarding.spec.ts
@@ -1,4 +1,4 @@
-import { expect } from 'chai';
+import { describe, it, expect } from 'vitest';
 import { ec as EllipticCurve } from 'elliptic';
 import BN from 'bn.js';
 
@@ -76,7 +76,7 @@ yGZuVVMAK/ypFfebDf4D/rlEw3cysv213m8aoK8nAUO8xQX3XQq3Sg+EGm0BNV8E
         await expect(decryptMessage({
             message: await readMessage({ armoredMessage: fwdCiphertextArmored }),
             decryptionKeys: charlieKey
-        })).to.be.rejectedWith(/Error decrypting message/); // missing config flag
+        })).rejects.toThrow(/Error decrypting message/); // missing config flag
 
         const result = await decryptMessage({
             message: await readMessage({ armoredMessage: fwdCiphertextArmored }),
@@ -189,7 +189,7 @@ z5FbOJXSHsoez1SZ7GKgoxC+X0w=
 
         await expect(
             generateForwardingMaterial(keyWithP256Subkey, [{ name: 'Charlie', email: 'info@charlie.com' }])
-        ).to.be.rejectedWith(/unsuitable for forwarding/);
+        ).rejects.toThrow(/unsuitable for forwarding/);
     });
 
     it('decryption with forwarding - v4 key', async () => {
@@ -235,7 +235,7 @@ z5FbOJXSHsoez1SZ7GKgoxC+X0w=
             decryptionKeys: charlieKey,
             config: { allowForwardedMessages: true }
         });
-        expect(decryptionTrialPromise).to.be.rejectedWith(/Error decrypting message/);
+        await expect(decryptionTrialPromise).rejects.toThrow(/Error decrypting message/);
     });
 
     it('decryption with forwarding - v4 key with multiple subkeys', async () => {
@@ -426,9 +426,9 @@ siLL+xMJ+Hy4AhsMAAAKagEA4Knj6S6nG24nuXfqkkytPlFTHwzurjv3+qqXwWL6
 =un5O
 -----END PGP PRIVATE KEY BLOCK-----` });
 
-        await expect(isForwardingKey(signOnlyKey)).to.eventually.be.false;
-        await expect(isForwardingKey(charlieKeyEncrypted)).to.eventually.be.true;
-        await expect(isForwardingKey(charlieKey)).to.eventually.be.true;
-        await expect(isForwardingKey(bobKey)).to.eventually.be.false;
+        await expect(isForwardingKey(signOnlyKey)).resolves.toBe(false);
+        await expect(isForwardingKey(charlieKeyEncrypted)).resolves.toBe(true);
+        await expect(isForwardingKey(charlieKey)).resolves.toBe(true);
+        await expect(isForwardingKey(bobKey)).resolves.toBe(false);
     });
 });
diff --git a/test/key/utils.spec.ts b/test/key/utils.spec.ts
@@ -1,4 +1,4 @@
-import { expect } from 'chai';
+import { describe, it, expect } from 'vitest';
 import { createSandbox as createSinonSandbox } from 'sinon';
 import { revokeKey, sign, createMessage, enums } from '../../lib/openpgp';
 import {
diff --git a/test/message/context.spec.ts b/test/message/context.spec.ts
@@ -1,4 +1,4 @@
-import { expect } from 'chai';
+import { describe, it, expect } from 'vitest';
 import { verifyMessage, signMessage, generateKey, readSignature, readMessage, decryptMessage, encryptMessage, readKey, SignatureContextError, serverTime } from '../../lib';
 import { VERIFICATION_STATUS } from '../../lib/constants';
 
@@ -41,7 +41,7 @@ describe('context', () => {
             verificationKeys: [publicKey],
             signatureContext: { value: 'unexpected-context', required: true },
             expectSigned: true
-        })).to.be.rejectedWith(SignatureContextError);
+        })).rejects.toThrow(SignatureContextError);
 
         const verificationMissingContext = await verifyMessage({
             textData,
@@ -212,7 +212,7 @@ describe('context', () => {
             textData: 'message with context',
             sessionKey: { algorithm: 'aes128', data: new Uint8Array(16) }, // unused
             signatureContext: { value: 'test-context', critical: true }
-        })).to.be.rejectedWith(/Unexpected `signatureContext` input without any `signingKeys` provided/);
+        })).rejects.toThrow(/Unexpected `signatureContext` input without any `signingKeys` provided/);
 
         // missing verification keys
         await expect(decryptMessage({
@@ -226,7 +226,7 @@ sJFJxllC0j4wHCOS9uiSYsZ/pWCqxX/3sFh4VBFOpr0HAA==
 -----END PGP MESSAGE-----` }),
             sessionKeys: { algorithm: 'aes128', data: new Uint8Array(16) }, // unused
             signatureContext: { value: 'test-context', required: true }
-        })).to.be.rejectedWith(/Unexpected `signatureContext` input without any `verificationKeys` provided/);
+        })).rejects.toThrow(/Unexpected `signatureContext` input without any `verificationKeys` provided/);
     });
 
     it('does not verify a message without context', async () => {
diff --git a/test/message/encryptMessage.spec.ts b/test/message/encryptMessage.spec.ts
@@ -1,4 +1,4 @@
-import { expect } from 'chai';
+import { describe, it, expect, beforeAll, afterAll } from 'vitest';
 import { readToEnd, toStream, type WebStream } from '@openpgp/web-stream-tools';
 import { config as globalConfig, type CompressedDataPacket, enums, SymEncryptedSessionKeyPacket, type PartialConfig, SymEncryptedIntegrityProtectedDataPacket } from '../../lib/openpgp';
 
@@ -14,15 +14,17 @@ const generateStreamOfData = (): { stream: WebStream<string>, data: string } =>
 
 describe('message encryption and decryption', () => {
     const { minRSABits } = globalConfig;
-    before('downgrade openpgp config and load stream polyfills', async () => {
+    // downgrade openpgp config and load stream polyfills
+    beforeAll(async () => {
         globalConfig.minRSABits = 512;
 
         // load stream polyfills if needed
         if (!globalThis.TransformStream) {
             await import('web-streams-polyfill/es6');
         }
     });
-    after('restore openpgp config', () => {
+    // restore openpgp config
+    afterAll(() => {
         globalConfig.minRSABits = minRSABits;
     });
 
diff --git a/test/message/processMIME.spec.ts b/test/message/processMIME.spec.ts
@@ -1,4 +1,4 @@
-import { expect } from 'chai';
+import { describe, it, expect } from 'vitest';
 
 import { readKey, processMIME } from '../../lib';
 import { utf8ArrayToString } from '../../lib/utils';
diff --git a/test/message/signMessage.spec.ts b/test/message/signMessage.spec.ts
@@ -1,4 +1,4 @@
-import { expect } from 'chai';
+import { describe, it, expect } from 'vitest';
 import { readToEnd } from '@openpgp/web-stream-tools';
 import { verifyMessage, signMessage, generateKey, readSignature } from '../../lib';
 import { VERIFICATION_STATUS } from '../../lib/constants';
@@ -89,7 +89,7 @@ describe('message signing', () => {
             signature: await readSignature({ armoredSignature }),
             verificationKeys: [publicKey],
             expectSigned: true
-        })).to.be.rejectedWith(/Signed digest did not match/);
+        })).rejects.toThrow(/Signed digest did not match/);
 
         const verificationResult = await verifyMessage({
             textData,
diff --git a/test/message/utils.spec.ts b/test/message/utils.spec.ts
@@ -1,4 +1,4 @@
-import { expect } from 'chai';
+import { describe, it, expect } from 'vitest';
 import { PublicKeyEncryptedSessionKeyPacket, AEADEncryptedDataPacket } from '../../lib/openpgp';
 import { stripArmor, splitMessage, armorBytes, readMessage } from '../../lib';
 import { removeTrailingSpaces } from '../../lib/message/utils';
diff --git a/test/message/verifyMessage.spec.ts b/test/message/verifyMessage.spec.ts
@@ -1,4 +1,4 @@
-import { expect } from 'chai';
+import { describe, it, expect } from 'vitest';
 import { readKey, verifyMessage, generateKey, verifyCleartextMessage, readSignature, readCleartextMessage } from '../../lib';
 import { VERIFICATION_STATUS } from '../../lib/constants';
 
diff --git a/test/setup.ts b/test/setup.ts
@@ -1,10 +1,8 @@
-import { use as chaiUse } from 'chai';
-import chaiAsPromised from 'chai-as-promised';
+import { beforeAll } from 'vitest';
 
 import { init, updateServerTime } from '../lib';
 
-chaiUse(chaiAsPromised);
-before(() => {
+beforeAll(() => {
     // set server time in the future to spot functions that use local time unexpectedly
     const HOUR = 3600 * 1000;
     updateServerTime(new Date(Date.now() + HOUR));
diff --git a/test/utils.spec.ts b/test/utils.spec.ts
@@ -1,4 +1,4 @@
-import { expect } from 'chai';
+import { describe, it, expect } from 'vitest';
 import { isStream, readToEnd } from '@openpgp/web-stream-tools';
 import { concatArrays, hexStringToArray, stringToUtf8Array, utf8ArrayToString } from '../lib/utils';
 import type { Data } from '../lib';
diff --git a/test/vitest.config.ts b/test/vitest.config.ts
diff --git a/tsconfig.json b/tsconfig.json
diff --git a/yarn.lock b/yarn.lock

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-import { expect } from 'chai';`
	`1`	`+import { describe, it, expect } from 'vitest';`
`2`	`2`
`3`	`3`	`import BN from 'bn.js';`
`4`	`4`	`import { bigIntToUint8Array, bitLength, byteLength, modExp, modInv } from '../lib/bigInteger';`