test: replace uvu with AVA

Author: screendriver

ava.config.integration.mjs

@@ -0,0 +1,6 @@
+import defaultConfig from './ava.config.mjs';
+
+export default {
+    ...defaultConfig,
+    files: ['./test/integration/**/*.test.{ts,tsx}'],
+};

ava.config.mjs

@@ -0,0 +1,8 @@
+export default {
+    files: ['./test/unit/**/*.test.{ts,tsx}'],
+    extensions: {
+        ts: 'module',
+        tsx: 'module',
+    },
+    nodeArguments: ['--no-warnings', '--loader=tsx'],
+};

package.json

@@ -32,9 +32,9 @@
         "compile": "tsc --build",
         "lint": "eslint src test --ext '.ts,.tsx'",
         "copy:paste:detection": "jscpd src test",
-        "test:unit": "TS_NODE_PROJECT=tsconfig.base.json uvu -r ts-node/register/transpile-only 'test/unit/' '.*\\.test\\.(ts|tsx)$'",
+        "test:unit": "ava",
         "test:unit:coverage": "c8 npm run test:unit",
-        "test:integration": "TS_NODE_PROJECT=tsconfig.base.json uvu -r ts-node/register/transpile-only 'test/integration/' '.*\\.test\\.(ts|tsx)$'",
+        "test:integration": "ava --config ava.config.integration.mjs",
         "test:unit:mutation": "stryker run"
     },
     "dependencies": {

test/integration/deletePipelines.test.tsx

@@ -1,6 +1,5 @@
 import React from 'react';
-import { test } from 'uvu';
-import * as assert from 'uvu/assert';
+import test from 'ava';
 import { render, cleanup } from 'ink-testing-library';
 import { parseISO } from 'date-fns';
 import delay from 'delay';
@@ -11,7 +10,7 @@ import { App } from '../../src/App';
 import { deletePipeline, filterPipelinesByDate, listPipelines } from '../../src/gitlab';
 import { getRequest, deleteRequest } from '../../src/network';
 
-test.after.each(cleanup);
+test.afterEach(cleanup);
 
 async function waitUntilDeleted(frames: string[]) {
     if (frames.some((frame) => frame.includes('Pipelines deleted'))) {
@@ -53,30 +52,30 @@ function renderApp(gitlabUrl: string) {
     );
 }
 
-test(
+test.serial(
     'deletes 4 old pipelines that are older than 30 days',
-    withGitLabServer({}, async (url) => {
+    withGitLabServer({}, async (t, url) => {
         const { lastFrame, frames } = renderApp(url);
         await waitUntilDeleted(frames);
 
         const actual = lastFrame();
         const expected =
             '4 pipelines found\nDeleting pipeline with id 32 for project 42\nDeleting pipeline with id 33 for project 42\nDeleting pipeline with id 34 for project 42\nDeleting pipeline with id 35 for project 42\n\u001b[32mPipelines deleted\u001b[39m';
-        assert.equal(actual, expected);
+
+        t.is(actual, expected);
     }),
 );
 
-test(
+test.serial(
     'fails with the response error message when a GitLab delete request fails',
-    withGitLabServer({ failOnDelete: true }, async (url) => {
+    withGitLabServer({ failOnDelete: true }, async (t, url) => {
         const { lastFrame, frames } = renderApp(url);
         await waitUntilDeleted(frames);
 
         const actual = lastFrame();
         const expected =
             "35 pipelines found\nDeleting pipeline with id 36 for project 42\nDeleting pipeline with id 37 for project 42\nDeleting pipeline with id 38 for project 42\nDeleting pipeline with id 39 for project 42\nDeleting pipeline with id 40 for project 42\nDeleting pipeline with id 41 for project 42\n\u001b[31mThere was an error while deleting the pipelines: Response code 418 (I'm a Teapot)\u001b[39m";
-        assert.equal(actual, expected);
+
+        t.is(actual, expected);
     }),
 );
-
-test.run();

test/integration/gitlabServer.ts

@@ -5,7 +5,7 @@ import { Factory } from 'fishery';
 import { subDays, formatISO, parseISO } from 'date-fns';
 import { IncomingHttpHeaders } from 'http';
 import { Pipeline } from '../../src/network';
-import { Callback } from 'uvu';
+import { ExecutionContext, ImplementationFn } from 'ava';
 
 interface PipelineTransientParams {
     readonly startDate: Date;
@@ -59,13 +59,17 @@ function createRoutes(config: Config): RequestHandler[] {
     ];
 }
 
-export function withGitLabServer(config: Config, test: (url: string) => void | Promise<void>): Callback {
-    return async () => {
+export function withGitLabServer(
+    config: Config,
+    test: (t: ExecutionContext<unknown>, url: string) => void | Promise<void>,
+): ImplementationFn<[]> {
+    return async (t) => {
         const routes = createRoutes(config);
         const server = micro(router(...routes));
         try {
             const url = await listen(server);
-            await test(url);
+
+            await test(t, url);
         } finally {
             server.close();
         }

test/unit/App.test.tsx

@@ -1,6 +1,5 @@
 import React from 'react';
-import { test } from 'uvu';
-import * as assert from 'uvu/assert';
+import test from 'ava';
 import { render, cleanup } from 'ink-testing-library';
 import sinon from 'sinon';
 import delay from 'delay';
@@ -9,7 +8,7 @@ import { App, AppProps } from '../../src/App';
 import { Pipeline } from '../../src/network';
 import { createAppProps } from './factory';
 
-test.after.each(cleanup);
+test.afterEach(cleanup);
 
 const pipelineFactory = Factory.define<Pipeline>(({ sequence }) => {
     return {
@@ -37,34 +36,35 @@ function renderApp(overrides: Partial<AppProps> = {}) {
     );
 }
 
-test('renders initially a loading spinner', async () => {
+test.serial('renders initially a loading spinner', async (t) => {
     const { frames } = renderApp();
     await delay(1);
 
     const actual = frames[0];
     const expected = '⠋';
-    assert.equal(actual, expected);
+
+    t.is(actual, expected);
 });
 
-test('shows how many pipelines are found in the beginning', async () => {
+test.serial('shows how many pipelines are found in the beginning', async (t) => {
     const { lastFrame } = renderApp();
     await delay(1);
 
     const actual = lastFrame()?.startsWith('0 pipelines found\n');
-    const expected = true;
-    assert.equal(actual, expected);
+
+    t.true(actual);
 });
 
-test("shows the success message 'Pipelines deleted' when deletion is finished", async () => {
+test.serial("shows the success message 'Pipelines deleted' when deletion is finished", async (t) => {
     const { lastFrame } = renderApp();
     await delay(1);
 
     const actual = lastFrame()?.endsWith('\u001b[32mPipelines deleted\u001b[39m');
-    const expected = true;
-    assert.equal(actual, expected);
+
+    t.true(actual);
 });
 
-test('shows the delete progress while it deletes the pipelines', async () => {
+test.serial('shows the delete progress while it deletes the pipelines', async (t) => {
     const pipelines = pipelineFactory.buildList(5);
     const { lastFrame } = renderApp({
         filterPipelinesByDate: sinon.fake.returns(pipelines),
@@ -74,10 +74,11 @@ test('shows the delete progress while it deletes the pipelines', async () => {
     const actual = lastFrame();
     const expected =
         '5 pipelines found\nDeleting pipeline with id 1 for project 42\nDeleting pipeline with id 2 for project 42\nDeleting pipeline with id 3 for project 42\nDeleting pipeline with id 4 for project 42\nDeleting pipeline with id 5 for project 42\n\u001b[32mPipelines deleted\u001b[39m';
-    assert.equal(actual, expected);
+
+    t.is(actual, expected);
 });
 
-test('deletes pipelines of multiple projects', async () => {
+test.serial('deletes pipelines of multiple projects', async (t) => {
     const { lastFrame } = renderApp({
         filterPipelinesByDate: sinon
             .stub()
@@ -94,21 +95,23 @@ test('deletes pipelines of multiple projects', async () => {
     const actual = lastFrame();
     const expected =
         '3 pipelines found\nDeleting pipeline with id 6 for project 1\nDeleting pipeline with id 7 for project 3\nDeleting pipeline with id 8 for project 3\n\u001b[32mPipelines deleted\u001b[39m';
-    assert.equal(actual, expected);
+
+    t.is(actual, expected);
 });
 
-test('renders an error message when an error occurred', async () => {
+test.serial('renders an error message when an error occurred', async (t) => {
     const { lastFrame } = renderApp({
         listPipelines: sinon.fake.rejects(new Error('Test Error')),
     });
     await delay(1);
 
     const actual = lastFrame();
     const expected = '\u001b[31mThere was an error while deleting the pipelines: Test Error\u001b[39m';
-    assert.equal(actual, expected);
+
+    t.is(actual, expected);
 });
 
-test('renders an error message when a delete request fails', async () => {
+test.serial('renders an error message when a delete request fails', async (t) => {
     const pipelines = pipelineFactory.buildList(1);
     const { lastFrame } = renderApp({
         filterPipelinesByDate: sinon.fake.returns(pipelines),
@@ -119,21 +122,24 @@ test('renders an error message when a delete request fails', async () => {
     const actual = lastFrame();
     const expected =
         '1 pipelines found\nDeleting pipeline with id 9 for project 42\n\u001b[31mThere was an error while deleting the pipelines: Failed to delete\u001b[39m';
-    assert.equal(actual, expected);
-});
-
-test('renders an error message with stack trace when an error occurred and showStackTraces is true', async () => {
-    const error = new Error('Test Error');
-    error.stack = 'the-stack-trace';
-    const { lastFrame } = renderApp({
-        listPipelines: sinon.fake.rejects(error),
-        showStackTraces: true,
-    });
-    await delay(1);
 
-    const actual = lastFrame();
-    const expected = '\u001b[31mThere was an error while deleting the pipelines: the-stack-trace\u001b[39m';
-    assert.equal(actual, expected);
+    t.is(actual, expected);
 });
 
-test.run();
+test.serial(
+    'renders an error message with stack trace when an error occurred and showStackTraces is true',
+    async (t) => {
+        const error = new Error('Test Error');
+        error.stack = 'the-stack-trace';
+        const { lastFrame } = renderApp({
+            listPipelines: sinon.fake.rejects(error),
+            showStackTraces: true,
+        });
+        await delay(1);
+
+        const actual = lastFrame();
+        const expected = '\u001b[31mThere was an error while deleting the pipelines: the-stack-trace\u001b[39m';
+
+        t.is(actual, expected);
+    },
+);

test/unit/Error.test.tsx

@@ -1,11 +1,10 @@
 import React from 'react';
-import { test } from 'uvu';
-import * as assert from 'uvu/assert';
+import test from 'ava';
 import sinon from 'sinon';
 import { render, cleanup } from 'ink-testing-library';
 import { Error, ErrorProps } from '../../src/Error';
 
-test.after.each(cleanup);
+test.afterEach(cleanup);
 
 function renderError(text: string, overrides: Partial<ErrorProps> = {}) {
     const props: ErrorProps = {
@@ -24,18 +23,21 @@ function renderError(text: string, overrides: Partial<ErrorProps> = {}) {
     );
 }
 
-test('renders a red error message', () => {
+test.serial('renders a red error message', (t) => {
     const { lastFrame } = renderError('Test error');
+
     const actual = lastFrame();
     const expected = '\u001b[31mTest error\u001b[39m';
-    assert.equal(actual, expected);
+
+    t.is(actual, expected);
 });
 
-test('calls given exit() callback after it was rendered', () => {
+test.serial('calls given exit() callback after it was rendered', (t) => {
     const exit = sinon.fake();
+
     const { unmount } = renderError('Test error', { exit });
     unmount();
+
     sinon.assert.calledOnce(exit);
+    t.pass();
 });
-
-test.run();