test(utils): improve test and mock naming, clean up tests

Tlacenka · Tlacenka · commit fd176bbfc623 · 2024-01-05T18:20:57.000+01:00
diff --git a/packages/models/src/lib/audit.unit.test.ts b/packages/models/src/lib/audit.unit.test.ts
@@ -1,16 +1,16 @@
 import { describe, expect, it } from 'vitest';
-import { report } from '../../test';
+import { reportMock } from '../../test';
 import { pluginConfigSchema } from './plugin-config';
 import { auditOutputsSchema } from './plugin-process-output';
 
 describe('auditOutputsSchema', () => {
   it('should pass if output audits are valid', () => {
-    const auditOutputs = report().plugins[0].audits;
+    const auditOutputs = reportMock().plugins[0].audits;
     expect(() => auditOutputsSchema.parse(auditOutputs)).not.toThrow();
   });
 
   it('should throw if slugs of audits are invalid', () => {
-    const auditOutputs = report().plugins[0].audits;
+    const auditOutputs = reportMock().plugins[0].audits;
     auditOutputs[0].slug = '-invalid-audit-slug';
 
     expect(() => auditOutputsSchema.parse(auditOutputs)).toThrow(
@@ -19,7 +19,7 @@ describe('auditOutputsSchema', () => {
   });
 
   it('should throw if slugs of audits are duplicated', () => {
-    const audits = report().plugins[0].audits;
+    const audits = reportMock().plugins[0].audits;
     const auditOutputs = [...audits, audits[0]];
     expect(() => auditOutputsSchema.parse(auditOutputs)).toThrow(
       'In plugin audits the slugs are not unique',
@@ -28,7 +28,7 @@ describe('auditOutputsSchema', () => {
 
   it('should throw if plugin groups refs contain invalid slugs', () => {
     const invalidAuditRef = '-invalid-audit-ref';
-    const pluginConfig = report().plugins[1];
+    const pluginConfig = reportMock().plugins[1];
     const groups = pluginConfig.groups;
     groups[0].refs[0].slug = invalidAuditRef;
     pluginConfig.groups = groups;
diff --git a/packages/models/test/fixtures/report.mock.ts b/packages/models/test/fixtures/report.mock.ts
@@ -3,7 +3,7 @@ import { categoryConfigs } from './categories.mock';
 import { eslintPluginReport } from './eslint-plugin.mock';
 import { lighthousePluginReport } from './lighthouse-plugin.mock';
 
-export function report(): Report {
+export function reportMock(): Report {
   return reportSchema.parse({
     packageName: '@code-pushup/core',
     version: '0.0.1',
diff --git a/packages/models/test/index.ts b/packages/models/test/index.ts
@@ -1,16 +1,16 @@
 export { config, minimalConfig, minimalReport } from './fixtures/config.mock';
-export { report } from './fixtures/report.mock';
+export { reportMock } from './fixtures/report.mock';
 export * from './memfs';
 
 export { eslintPluginConfig } from './fixtures/eslint-plugin.mock';
 export { lighthousePluginConfig } from './fixtures/lighthouse-plugin.mock';
 
-export { echoRunnerConfig } from './fixtures/runner-config.mock';
+export { categoryConfig } from './fixtures/categories.mock';
 export { persistConfig } from './fixtures/persist-config.mock';
 export {
   auditConfig,
   auditReport,
   pluginConfig,
 } from './fixtures/plugin-config.mock';
+export { echoRunnerConfig } from './fixtures/runner-config.mock';
 export { uploadConfig } from './fixtures/upload-config.mock';
-export { categoryConfig } from './fixtures/categories.mock';
diff --git a/packages/utils/src/index.ts b/packages/utils/src/index.ts
@@ -18,7 +18,6 @@ export {
   pluginWorkDir,
   readJsonFile,
   readTextFile,
-  toUnixPath,
 } from './lib/file-system';
 export {
   formatBytes,
@@ -58,5 +57,6 @@ export {
   objectToEntries,
   objectToKeys,
   toArray,
+  toUnixPath,
 } from './lib/transform';
 export { verboseUtils } from './lib/verbose-utils';
diff --git a/packages/utils/src/lib/__snapshots__/report-to-md.integration.test.ts.snap b/packages/utils/src/lib/__snapshots__/report-to-md.integration.test.ts.snap
@@ -420,7 +420,7 @@ ESLint rule **prefer-arrow-callback**. [📖 Docs](https://eslint.org/docs/lates
 
 ## About
 
-Report was created by [Code PushUp](https://github.com/flowup/quality-metrics-cli#readme) on Sat Jan 01 2000 00:00:00 GMT+0000 (Coordinated Universal Time).
+Report was created by [Code PushUp](https://github.com/flowup/quality-metrics-cli#readme) on Wed Sep 15 2021 00:00:00 GMT+0000 (Coordinated Universal Time).
 
 |Commit|Version|Duration|Plugins|Categories|Audits|
 |:--|:--:|:--:|:--:|:--:|:--:|
diff --git a/packages/utils/src/lib/git.integration.test.ts b/packages/utils/src/lib/git.integration.test.ts
@@ -0,0 +1,18 @@
+import { expect } from 'vitest';
+import { getLatestCommit } from './git';
+
+const gitCommitDateRegex =
+  /^(Mon|Tue|Wed|Thu|Fri|Sat|Sun) (Jan|Feb|Mar|Apr|May|Jun|Jul|Aug|Sep|Oct|Nov|Dec) \d{1,2} \d{2}:\d{2}:\d{2} \d{4} [+|-]\d{4}$/;
+
+describe('getLatestCommit', () => {
+  it('should log latest commit', async () => {
+    await expect(getLatestCommit()).resolves.toEqual(
+      expect.objectContaining({
+        hash: expect.stringMatching(/^[0-9a-f]{40}$/),
+        message: expect.stringMatching(/.+/),
+        author: expect.stringMatching(/.+/),
+        date: expect.stringMatching(gitCommitDateRegex),
+      }),
+    );
+  });
+});
diff --git a/packages/utils/src/lib/git.unit.test.ts b/packages/utils/src/lib/git.unit.test.ts
diff --git a/packages/utils/src/lib/log-results.unit.test.ts b/packages/utils/src/lib/log-results.unit.test.ts
@@ -1,33 +1,10 @@
-import chalk from 'chalk';
-import { afterEach, beforeEach, describe, expect, it, vi } from 'vitest';
+import { describe, expect, it, vi } from 'vitest';
 import { FileResult } from './file-system';
-import { formatBytes } from './formatting';
 import { logMultipleResults, logPromiseResults } from './log-results';
 
-const succeededCallback = (result: PromiseFulfilledResult<FileResult>) => {
-  const [fileName, size] = result.value;
-  console.info(
-    `- ${chalk.bold(fileName)}` +
-      (size ? ` (${chalk.gray(formatBytes(size))})` : ''),
-  );
-};
-
-const failedCallback = (result: PromiseRejectedResult) => {
-  console.warn(`- ${chalk.bold(result.reason)}`);
-};
-
 describe('logMultipleResults', () => {
-  const succeededCallbackMock = vi.fn().mockImplementation(succeededCallback);
-  const failedCallbackMock = vi.fn().mockImplementation(failedCallback);
-
-  beforeEach(() => {
-    succeededCallbackMock.mockClear();
-    failedCallbackMock.mockClear();
-  });
-
-  afterEach(() => {
-    vi.restoreAllMocks();
-  });
+  const succeededCallbackMock = vi.fn();
+  const failedCallbackMock = vi.fn();
 
   it('should call logPromiseResults with successfull plugin result', async () => {
     logMultipleResults(
@@ -72,8 +49,8 @@ describe('logMultipleResults', () => {
       failedCallbackMock,
     );
 
-    expect(succeededCallbackMock).toHaveBeenCalled();
-    expect(failedCallbackMock).toHaveBeenCalled();
+    expect(succeededCallbackMock).toHaveBeenCalledOnce();
+    expect(failedCallbackMock).toHaveBeenCalledOnce();
   });
 });
 
@@ -86,30 +63,32 @@ describe('logPromiseResults', () => {
           value: ['out.json'],
         } as PromiseFulfilledResult<FileResult>,
       ],
-      'Uploaded reports successfully: ',
-      succeededCallback,
+      'Uploaded reports successfully:',
+      result => {
+        console.info(result.value);
+      },
     );
 
-    expect(console.info).toHaveBeenCalledWith(
-      expect.stringContaining('Uploaded reports successfully: '),
-    );
-    expect(console.info).toHaveBeenCalledWith(
-      expect.stringContaining('- [1mout.json[22m'),
+    expect(console.info).toHaveBeenNthCalledWith(
+      1,
+      'Uploaded reports successfully:',
     );
+    expect(console.info).toHaveBeenNthCalledWith(2, ['out.json']);
   });
 
   it('should log on fail', async () => {
     logPromiseResults(
       [{ status: 'rejected', reason: 'fail' } as PromiseRejectedResult],
-      'Generated reports failed: ',
-      failedCallback,
+      'Generated reports failed:',
+      result => {
+        console.warn(result.reason);
+      },
     );
 
-    expect(console.warn).toHaveBeenCalledWith(
-      expect.stringContaining('Generated reports failed: '),
-    );
-    expect(console.warn).toHaveBeenCalledWith(
-      expect.stringContaining('- [1mfail[22m'),
+    expect(console.warn).toHaveBeenNthCalledWith(
+      1,
+      'Generated reports failed:',
     );
+    expect(console.warn).toHaveBeenNthCalledWith(2, 'fail');
   });
 });
diff --git a/packages/utils/src/lib/md/font-style.unit.test.ts b/packages/utils/src/lib/md/font-style.unit.test.ts
@@ -26,12 +26,12 @@ describe('style', () => {
     expect(result).toBe('~**_Hello World_**~');
   });
 
-  it('should handle empty styles array', () => {
+  it('should return unchanged text for an empty styles array', () => {
     const result = style('Hello World', []);
     expect(result).toBe('Hello World');
   });
 
-  it('should handle empty text', () => {
+  it('should apply formatting on empty string', () => {
     const result = style('', ['i', 'b']);
     expect(result).toBe('**__**');
   });
diff --git a/packages/utils/src/lib/md/headline.unit.test.ts b/packages/utils/src/lib/md/headline.unit.test.ts
@@ -31,7 +31,7 @@ describe('headline', () => {
     expect(result).toBe('###### Hello World');
   });
 
-  it('should handle empty text', () => {
+  it('should still insert heading for empty string', () => {
     const result = headline('', 3);
     expect(result).toBe('### ');
   });
diff --git a/packages/utils/src/lib/md/link.unit.test.ts b/packages/utils/src/lib/md/link.unit.test.ts
@@ -11,22 +11,22 @@ describe('link', () => {
     expect(result).toBe('[https://example.com](https://example.com)');
   });
 
-  it('should handle empty string as href', () => {
+  it('should return an empty formatted link for empty string', () => {
     const result = link('');
     expect(result).toBe('[]()');
   });
 
-  it('should handle empty string as text', () => {
+  it('should insert link as text for empty string', () => {
     const result = link('https://example.com', '');
     expect(result).toBe('[https://example.com](https://example.com)');
   });
 
-  it('should handle undefined as text', () => {
+  it('should insert link as text for undefined text', () => {
     const result = link('https://example.com', undefined);
     expect(result).toBe('[https://example.com](https://example.com)');
   });
 
-  it('should correctly handle special characters', () => {
+  it('should include special characters', () => {
     const result = link('https://example.com/query?a=b&c=d', 'Query Example');
     expect(result).toBe('[Query Example](https://example.com/query?a=b&c=d)');
   });
diff --git a/packages/utils/src/lib/md/list.unit.test.ts b/packages/utils/src/lib/md/list.unit.test.ts
@@ -11,17 +11,17 @@ describe('li', () => {
     expect(result).toBe('- [ ] Hello World');
   });
 
-  it('should handle empty text', () => {
+  it('should return an empty list item for empty string', () => {
     const result = li('');
     expect(result).toBe('- ');
   });
 
-  it('should handle empty text with checkbox order', () => {
+  it('should return an empty checkbox item for empty string', () => {
     const result = li('', 'checkbox');
     expect(result).toBe('- [ ] ');
   });
 
-  it('should correctly handle special characters', () => {
+  it('should include special characters', () => {
     const result = li('Hello *World*', 'checkbox');
     expect(result).toBe('- [ ] Hello *World*');
   });
diff --git a/packages/utils/src/lib/md/table.unit.test.ts b/packages/utils/src/lib/md/table.unit.test.ts
@@ -25,19 +25,19 @@ describe('table function', () => {
     expect(result).toBe(expected);
   });
 
-  it('should handle empty data', () => {
+  it('should throw for empty data', () => {
     const data: (string | number)[][] = [];
     expect(() => tableMd(data)).toThrow("Data can't be empty");
   });
 
-  it('should handle single row data', () => {
+  it('should create a table with a single row', () => {
     const data: (string | number)[][] = [['Header 1', 'Header 2']];
     const result = tableMd(data);
     const expected = `|Header 1|Header 2|`;
     expect(result).toContain(expected);
   });
 
-  it('should handle number values', () => {
+  it('should include number values', () => {
     const data: (string | number)[][] = [
       ['Header 1', 'Header 2'],
       [1, 2],
diff --git a/packages/utils/src/lib/report-to-md.integration.test.ts b/packages/utils/src/lib/report-to-md.integration.test.ts
@@ -1,5 +1,5 @@
 import { describe } from 'vitest';
-import { report } from '@code-pushup/models/testing';
+import { reportMock } from '@code-pushup/models/testing';
 import { reportToMd } from './report-to-md';
 import { scoreReport } from './scoring';
 
@@ -13,15 +13,15 @@ describe('report-to-md', () => {
   });
 
   it('should contain all sections when using the fixture report', () => {
-    const date = new Date(2000, 0, 1, 0);
+    const date = new Date('2021-09-15');
     vi.setSystemTime(date);
     const commit = {
       hash: '41682a2fec1d4ece81c696a26c08984baeb4bcf3',
       message: 'refactor(cli): fix exec target',
       author: 'BioPhoton',
       date: 'Sat Sep 10 12:00:00 2021 +0200',
     };
-    const mdReport = reportToMd(scoreReport(report()), commit);
+    const mdReport = reportToMd(scoreReport(reportMock()), commit);
     expect(mdReport).toContain(
       `${commit.message} (${commit.hash.slice(0, 7)})`,
     );
diff --git a/packages/utils/src/lib/report-to-stdout.integration.test.ts b/packages/utils/src/lib/report-to-stdout.integration.test.ts
@@ -1,11 +1,11 @@
 import { describe } from 'vitest';
-import { report } from '@code-pushup/models/testing';
+import { reportMock } from '@code-pushup/models/testing';
 import { reportToStdout } from './report-to-stdout';
 import { scoreReport } from './scoring';
 
 describe('report-to-stdout', () => {
   it('should contain all sections when using the fixture report', () => {
-    const logOutput = reportToStdout(scoreReport(report()));
+    const logOutput = reportToStdout(scoreReport(reportMock()));
     // logOutput.replace(/\u001B\[\d+m/g, '') removes all color codes from the output
     // for snapshot readability
     // eslint-disable-next-line no-control-regex
diff --git a/packages/utils/src/lib/report-to-stdout.ts b/packages/utils/src/lib/report-to-stdout.ts
diff --git a/packages/utils/src/lib/report.unit.test.ts b/packages/utils/src/lib/report.unit.test.ts
diff --git a/packages/utils/src/lib/transform.ts b/packages/utils/src/lib/transform.ts
diff --git a/packages/utils/src/lib/transform.unit.test.ts b/packages/utils/src/lib/transform.unit.test.ts
diff --git a/packages/utils/vite.config.unit.ts b/packages/utils/vite.config.unit.ts
