♻️ Migrate tests to Vitest syntax

A good exercice in regex :)

Author: NatoBoram

package.json

@@ -35,8 +35,8 @@
     "lint:fix": "npm run lint:tests -- --fix && npm run lint:examples -- --fix && npm run lint:src:agile -- --fix && npm run lint:src:clients -- --fix && npm run lint:src:services -- --fix && npm run lint:src:version2 -- --fix && npm run lint:src:version3 -- --fix && npm run lint:src:serviceDesk -- --fix && npm run lint:src:files -- --fix",
     "doc": "typedoc --name \"Jira.js - Jira Cloud API library\" --out docs ./src/index.ts --plugin typedoc-plugin-extras --footerDate --footerTime --footerTypedocVersion --favicon https://svgshare.com/i/bHF.svg",
     "test": "npm run test:unit && npm run test:integration",
-    "test:unit": "ava tests/unit --timeout=2m -с 8",
-    "test:integration": "ava --timeout=2m --fail-fast --no-worker-threads -c 1 -s tests/integration/**/*.test.ts",
+    "test:unit": "vitest tests/unit --timeout=2m -с 8",
+    "test:integration": "vitest --timeout=2m --fail-fast --no-worker-threads -c 1 -s tests/integration/**/*.test.ts",
     "replace:all": "npm run replace:permissions:version2 && npm run replace:permissions:version3 && npm run replace:pagination:version2 && npm run replace:pagination:version3 && npm run replace:async:version2 && npm run replace:async:version3 && npm run replace:expansion:version2 && npm run replace:expansion:version3 && npm run replace:ordering:version2 && npm run replace:ordering:version3 && npm run replace:groupMember:version2 && npm run replace:workflowPaginated:version2",
     "replace:permissions:version2": "grep -rl \"(#permissions)\" ./src/version2 | xargs sed -i '' 's/(#permissions)/(https:\\/\\/developer.atlassian.com\\/cloud\\/jira\\/platform\\/rest\\/v2\\/intro\\/#permissions)/g'",
     "replace:permissions:version3": "grep -rl \"(#permissions)\" ./src/version3 | xargs sed -i '' 's/(#permissions)/(https:\\/\\/developer.atlassian.com\\/cloud\\/jira\\/platform\\/rest\\/v3\\/intro\\/#permissions)/g'",
@@ -71,7 +71,6 @@
     "@types/sinon": "^17.0.3",
     "@typescript-eslint/eslint-plugin": "^7.9.0",
     "@typescript-eslint/parser": "^7.9.0",
-    "ava": "^6.1.3",
     "dotenv": "^16.4.5",
     "eslint": "^8.57.0",
     "eslint-config-airbnb-base": "^15.0.0",
@@ -83,7 +82,8 @@
     "ts-node": "^10.9.2",
     "typedoc": "^0.25.13",
     "typedoc-plugin-extras": "^3.0.0",
-    "typescript": "^5.4.5"
+    "typescript": "^5.4.5",
+    "vitest": "^1.6.0"
   },
   "dependencies": {
     "axios": "^1.6.8",

tests/integration/agile/sprint.test.ts

@@ -1,27 +1,25 @@
-import test from 'ava';
+import { afterAll, beforeAll, test } from 'vitest';
 import { AgileModels } from '../../../src/index.js';
 import { Constants } from '../constants.js';
-import {
-  createAgileProject, deleteAgileProject, getAgileClient, getVersion3Client,
-} from '../utils/index.js';
+import { createAgileProject, deleteAgileProject, getAgileClient, getVersion3Client } from '../utils/index.js';
 
 const client = getAgileClient();
 
 let board: any;
 let sprint: AgileModels.Sprint;
 
-test.before(async () => {
+beforeAll(async () => {
   await createAgileProject();
 });
 
-test.after(async () => {
+afterAll(async () => {
   await deleteAgileProject();
 });
 
-test.serial('should create new sprint', async t => {
+test.sequential('should create new sprint', async ({ expect }) => {
   const boards = await client.board.getAllBoards({ name: Constants.testAgileProjectKey });
 
-  t.is(boards.total, 1);
+  expect(boards.total).toBe(1);
 
   [board] = boards.values;
 
@@ -30,12 +28,12 @@ test.serial('should create new sprint', async t => {
     originBoardId: board.id,
   });
 
-  t.truthy(!!sprint);
-  t.is(sprint.name, 'New sprint');
-  t.is(sprint.state, 'future');
+  expect(!!sprint).toBeTruthy();
+  expect(sprint.name).toBe('New sprint');
+  expect(sprint.state).toBe('future');
 });
 
-test.serial('should create and move task to sprint', async t => {
+test.sequential('should create and move task to sprint', async ({ expect }) => {
   const issue = await getVersion3Client().issues.createIssue({
     fields: {
       summary: 'Test task',
@@ -57,33 +55,29 @@ test.serial('should create and move task to sprint', async t => {
     issues: [issue.key],
   });
 
-  t.truthy(!!issue);
+  expect(!!issue).toBeTruthy();
 });
 
-test.serial('should return issues for sprint', async t => {
+test.sequential('should return issues for sprint', async ({ expect }) => {
   const { issues } = await client.sprint.getIssuesForSprint({
     sprintId: sprint.id,
   });
 
-  t.truthy(!!issues);
-  t.is(issues[0].fields?.summary, 'Test task');
+  expect(!!issues).toBeTruthy();
+  expect(issues[0].fields?.summary).toBe('Test task');
 });
 
-test.serial('should partially update sprint', async t => {
+test.sequential('should partially update sprint', async ({ expect }) => {
   const newSprint = await client.sprint.partiallyUpdateSprint({
     sprintId: sprint.id,
     state: 'active',
     startDate: new Date(),
     endDate: new Date(Date.now() + 1000),
   });
 
-  t.is(newSprint.state, 'active');
+  expect(newSprint.state).toBe('active');
 });
 
-test.serial('should remove sprint', async t => {
-  await client.sprint.deleteSprint({
-    sprintId: sprint.id,
-  });
-
-  t.pass();
+test.sequential('should remove sprint', async ({ expect }) => {
+  await client.sprint.deleteSprint({ sprintId: sprint.id });
 });

tests/integration/version2/avatars.test.ts

@@ -1,22 +1,22 @@
-import test from 'ava';
+import { test } from 'vitest';
 import type { Avatar } from '../../../src/version3/models/index.js';
 import { getVersion2Client } from '../utils/index.js';
 
 const client = getVersion2Client();
 
 let avatar: Avatar | undefined;
 
-test.serial('should get all system avatars', async t => {
+test.sequential('should get all system avatars', async ({ expect }) => {
   const systemAvatars = await client.avatars.getAllSystemAvatars({ type: 'project' });
 
   avatar = systemAvatars.system?.[0];
 
-  t.truthy(!!avatar);
+  expect(!!avatar).toBeTruthy();
 });
 
-test.serial('should return avatar image with contentType', async t => {
+test.sequential('should return avatar image with contentType', async ({ expect }) => {
   const avatarWithDetails = await client.avatars.getAvatarImageByID({ id: avatar!.id, type: 'project' });
 
-  t.is(avatarWithDetails.contentType, 'image/svg+xml');
-  t.truthy(avatarWithDetails.avatar instanceof Uint8Array);
+  expect(avatarWithDetails.contentType).toBe('image/svg+xml');
+  expect(avatarWithDetails.avatar instanceof Uint8Array).toBeTruthy();
 });

tests/integration/version2/dashboards.test.ts

@@ -1,27 +1,27 @@
-import test from 'ava';
+import { test } from 'vitest';
+import { Version2Models } from '../../../src/index.js';
 import { Constants } from '../constants.js';
 import { getVersion2Client } from '../utils/index.js';
-import { Version2Models } from '../../../src/index.js';
 
 let dashboard: Version2Models.Dashboard;
 const client = getVersion2Client();
 
-test.serial('should create dashboard', async t => {
+test.sequential('should create dashboard', async ({ expect }) => {
   dashboard = await client.dashboards.createDashboard({
     name: Constants.testDashboardName,
     sharePermissions: [],
   });
 
-  t.truthy(!!dashboard);
-  t.is(dashboard.name, Constants.testDashboardName);
-  t.deepEqual(dashboard.sharePermissions, []);
+  expect(!!dashboard).toBeTruthy();
+  expect(dashboard.name).toBe(Constants.testDashboardName);
+  expect(dashboard.sharePermissions).toStrictEqual([]);
 });
 
-test.serial('should remove dashboard', async t => {
+test.sequential('should remove dashboard', async ({ expect }) => {
   const response = await client.dashboards.deleteDashboard({
     id: dashboard.id,
   });
 
-  t.is(typeof response, 'string');
-  t.is<string | void, string>(response, '');
+  expect(typeof response).toBe('string');
+  expect(response).toBe('');
 });

tests/integration/version2/groups.test.ts

@@ -1,23 +1,23 @@
-import test from 'ava';
+import { test } from 'vitest';
 import { Constants } from '../index.js';
 import { getVersion2Client } from '../utils/index.js';
 
 const client = getVersion2Client();
 
-test.serial('should create a group', async t => {
+test.sequential('should create a group', async ({ expect }) => {
   const group = await client.groups.createGroup({
     name: Constants.testGroupName,
   });
 
-  t.truthy(!!group);
-  t.is(group.name, Constants.testGroupName);
+  expect(!!group).toBeTruthy();
+  expect(group.name).toBe(Constants.testGroupName);
 });
 
-test.serial('should remove a group', async t => {
+test.sequential('should remove a group', async ({ expect }) => {
   const response = await client.groups.removeGroup({
     groupname: Constants.testGroupName,
   });
 
-  t.is(typeof response, 'string');
-  t.is(response.trim(), '');
+  expect(typeof response).toBe('string');
+  expect(response.trim()).toBe('');
 });

tests/integration/version2/issueAttachments.test.ts

@@ -1,23 +1,23 @@
 import * as fs from 'fs';
-import test from 'ava';
-import { Constants } from '../constants.js';
+import { afterAll, beforeAll, test } from 'vitest';
 import type { Attachment, Issue } from '../../../src/version2/models/index.js';
+import { Constants } from '../constants.js';
 import { cleanupEnvironment, getVersion2Client, prepareEnvironment } from '../utils/index.js';
 
 const client = getVersion2Client({ noCheckAtlassianToken: true });
 
 let issue: Issue;
 let attachments: Attachment[];
 
-test.before(async () => {
+beforeAll(async () => {
   await prepareEnvironment();
 });
 
-test.after(async () => {
+afterAll(async () => {
   await cleanupEnvironment();
 });
 
-test.serial('should add attachment', async t => {
+test.sequential('should add attachment', async ({ expect }) => {
   issue = await client.issues.createIssue({
     fields: {
       summary: 'Issue with attachment',
@@ -30,7 +30,7 @@ test.serial('should add attachment', async t => {
     },
   });
 
-  t.truthy(!!issue);
+  expect(!!issue).toBeTruthy();
 
   attachments = await client.issueAttachments.addAttachment({
     issueIdOrKey: issue.key,
@@ -40,21 +40,17 @@ test.serial('should add attachment', async t => {
     },
   });
 
-  t.truthy(!!attachments);
-  t.is(attachments[0].filename, 'issueAttachments.test.ts');
-  t.is(attachments[0].mimeType, 'video/mp2t');
+  expect(!!attachments).toBeTruthy();
+  expect(attachments[0].filename).toBe('issueAttachments.test.ts');
+  expect(attachments[0].mimeType).toBe('video/mp2t');
 });
 
-test.serial('should getAttachmentContent', async t => {
+test.sequential('should getAttachmentContent', async ({ expect }) => {
   const content = await client.issueAttachments.getAttachmentContent({ id: attachments[0].id });
 
-  t.truthy(Buffer.isBuffer(content));
+  expect(Buffer.isBuffer(content)).toBeTruthy();
 });
 
-test.serial('should remove attachment', async t => {
-  await client.issues.deleteIssue({
-    issueIdOrKey: issue.key,
-  });
-
-  t.pass();
+test.sequential('should remove attachment', async ({ expect }) => {
+  await client.issues.deleteIssue({ issueIdOrKey: issue.key });
 });

tests/integration/version2/issueComments.test.ts

@@ -1,17 +1,17 @@
 import { AxiosError } from 'axios';
-import test from 'ava';
+import { afterAll, beforeAll, test } from 'vitest';
 import { Constants } from '../constants.js';
 import { cleanupEnvironment, getVersion2Client, prepareEnvironment } from '../utils/index.js';
 
-test.before(async () => {
+beforeAll(async () => {
   await prepareEnvironment();
 });
 
-test.after(async () => {
+afterAll(async () => {
   await cleanupEnvironment();
 });
 
-test.serial('should update comment', async t => {
+test.sequential('should update comment', async ({ expect }) => {
   const client = getVersion2Client({ noCheckAtlassianToken: true });
 
   const issue = await client.issues.createIssue({
@@ -26,7 +26,7 @@ test.serial('should update comment', async t => {
     },
   });
 
-  t.truthy(!!issue);
+  expect(!!issue).toBeTruthy();
 
   const comment = await client.issueComments
     .addComment({
@@ -39,16 +39,16 @@ test.serial('should update comment', async t => {
       throw error;
     });
 
-  t.truthy(!!comment);
+  expect(!!comment).toBeTruthy();
 
   const updatedComment = await client.issueComments.updateComment({
     issueIdOrKey: issue.key,
     id: comment.id,
     comment: 'updated comment',
   });
 
-  t.truthy(!!updatedComment);
-  t.is(updatedComment.id, comment.id);
+  expect(!!updatedComment).toBeTruthy();
+  expect(updatedComment.id).toBe(comment.id);
 
   await client.issues.deleteIssue({
     issueIdOrKey: issue.key,

tests/integration/version2/issueSearch.test.ts

@@ -1,22 +1,22 @@
-import test from 'ava';
+import { afterAll, beforeAll, test } from 'vitest';
 import { cleanupEnvironment, getVersion2Client, prepareEnvironment } from '../utils/index.js';
 
-test.before(async () => {
+beforeAll(async () => {
   await prepareEnvironment();
 });
 
-test.after(async () => {
+afterAll(async () => {
   await cleanupEnvironment();
 });
 
-test.serial('searchForIssuesUsingJql should correctly calls', async t => {
+test.sequential('searchForIssuesUsingJql should correctly calls', async ({ expect }) => {
   const client = getVersion2Client({ noCheckAtlassianToken: true });
 
   const issues = await client.issueSearch.searchForIssuesUsingJql({
     jql: 'assignee=currentuser()',
   });
 
-  t.is(issues.startAt, 0);
-  t.is(issues.maxResults, 50);
-  t.deepEqual(issues.issues, []);
+  expect(issues.startAt).toBe(0);
+  expect(issues.maxResults).toBe(50);
+  expect(issues.issues).toStrictEqual([]);
 });