ci(coverage): add tests (#440)

* ci(coverage): add tests * ci: debug * ci: debug * chore: remove comments * ci: remove debug
wellwelwel · Jun 22, 2024 · 23d0b92 · 23d0b92
1 parent 1ab72ed
commit 23d0b92
Show file tree

Hide file tree

Showing 21 changed files with 277 additions and 96 deletions.
diff --git a/src/helpers/parse-assertion.ts b/src/helpers/parse-assertion.ts
@@ -1,18 +1,16 @@
+/* c8 ignore next */
+import type { ParseAssertionOptions } from '../@types/assert.js';
 import { cwd as processCWD, env, exit } from 'node:process';
 import path from 'node:path';
 import assert from 'node:assert';
 import { format } from './format.js';
 import { hr } from './hr.js';
 import { findFile } from './find-file.js';
-/* c8 ignore next */
 import { each } from '../configs/each.js';
-/* c8 ignore next */
 import { indentation } from '../configs/indentation.js';
 import { fromEntries, entries } from '../polyfills/object.js';
 import { nodeVersion } from './get-runtime.js';
 import { write } from './logs.js';
-/* c8 ignore next */
-import type { ParseAssertionOptions } from '../@types/assert.js';
 
 const cwd = processCWD();
 
@@ -93,6 +91,7 @@ export const parseAssertion = async (
  isPoku &&
  !indentation.hasDescribe &&
  !indentation.hasIt &&
+ /* c8 ignore next */ // c8 bug?
  !indentation.hasTest
  ? /* c8 ignore next */
  `${preIdentation}${format(`${format(`✔ ${options.message}`).bold()} ${format(`› ${FILE}`).success().dim()}`).success()}`

diff --git a/src/modules/assert-promise.ts b/src/modules/assert-promise.ts
@@ -1,8 +1,8 @@
+/* c8 ignore next */
+import type { ParseAssertionOptions } from '../@types/assert.js';
 import nodeAssert from 'node:assert';
 import { parseAssertion } from '../helpers/parse-assertion.js';
 import { nodeVersion } from '../helpers/get-runtime.js';
-/* c8 ignore next */
-import type { ParseAssertionOptions } from '../@types/assert.js';
 
 const ok = async (
  value: unknown,
@@ -144,7 +144,9 @@ function doesNotThrow(
 ): Promise<void>;
 async function doesNotThrow(
  block: () => unknown,
- errorOrMessage?: nodeAssert.AssertPredicate | string | Error,
+ errorOrMessage?:
+ | nodeAssert.AssertPredicate
+ | ParseAssertionOptions['message'],
  message?: ParseAssertionOptions['message']
 ): Promise<void> {
  await parseAssertion(
@@ -210,17 +212,19 @@ async function throws(
 
 function rejects(
  block: (() => Promise<unknown>) | Promise<unknown>,
- message?: string | Error
+ message?: ParseAssertionOptions['message']
 ): Promise<void>;
 function rejects(
  block: (() => Promise<unknown>) | Promise<unknown>,
  error: nodeAssert.AssertPredicate,
- message?: string | Error
+ message?: ParseAssertionOptions['message']
 ): Promise<void>;
 async function rejects(
  block: (() => Promise<unknown>) | Promise<unknown>,
- errorOrMessage?: nodeAssert.AssertPredicate | string | Error,
- message?: string | Error
+ errorOrMessage?:
+ | nodeAssert.AssertPredicate
+ | ParseAssertionOptions['message'],
+ message?: ParseAssertionOptions['message']
 ): Promise<void> {
  await parseAssertion(
  async () => {
@@ -247,17 +251,19 @@ async function rejects(
 
 function doesNotReject(
  block: (() => Promise<unknown>) | Promise<unknown>,
- message?: string | Error
+ message?: ParseAssertionOptions['message']
 ): Promise<void>;
 function doesNotReject(
  block: (() => Promise<unknown>) | Promise<unknown>,
  error: nodeAssert.AssertPredicate,
- message?: string | Error
+ message?: ParseAssertionOptions['message']
 ): Promise<void>;
 async function doesNotReject(
  block: (() => Promise<unknown>) | Promise<unknown>,
- errorOrMessage?: nodeAssert.AssertPredicate | string | Error,
- message?: string | Error
+ errorOrMessage?:
+ | nodeAssert.AssertPredicate
+ | ParseAssertionOptions['message'],
+ message?: ParseAssertionOptions['message']
 ): Promise<void> {
  await parseAssertion(
  async () => {
@@ -338,5 +344,5 @@ export const assertPromise = Object.assign(
  fail,
  rejects,
  }
- /* c8 ignore next */
+ /* c8 ignore next */ // c8 bug
 );
diff --git a/src/modules/assert.ts b/src/modules/assert.ts
@@ -1,8 +1,8 @@
+/* c8 ignore next */
+import type { ParseAssertionOptions } from '../@types/assert.js';
 import nodeAssert from 'node:assert';
 import { parseAssertion } from '../helpers/parse-assertion.js';
 import { nodeVersion } from '../helpers/get-runtime.js';
-/* c8 ignore next */
-import type { ParseAssertionOptions } from '../@types/assert.js';
 
 const ok = (
  value: unknown,
@@ -136,7 +136,9 @@ function doesNotThrow(
 ): void;
 function doesNotThrow(
  block: () => unknown,
- errorOrMessage?: nodeAssert.AssertPredicate | string | Error,
+ errorOrMessage?:
+ | nodeAssert.AssertPredicate
+ | ParseAssertionOptions['message'],
  message?: ParseAssertionOptions['message']
 ): void {
  parseAssertion(
@@ -202,17 +204,19 @@ function throws(
 
 function rejects(
  block: (() => Promise<unknown>) | Promise<unknown>,
- message?: string | Error
+ message?: ParseAssertionOptions['message']
 ): Promise<void>;
 function rejects(
  block: (() => Promise<unknown>) | Promise<unknown>,
  error: nodeAssert.AssertPredicate,
- message?: string | Error
+ message?: ParseAssertionOptions['message']
 ): Promise<void>;
 async function rejects(
  block: (() => Promise<unknown>) | Promise<unknown>,
- errorOrMessage?: nodeAssert.AssertPredicate | string | Error,
- message?: string | Error
+ errorOrMessage?:
+ | nodeAssert.AssertPredicate
+ | ParseAssertionOptions['message'],
+ message?: ParseAssertionOptions['message']
 ): Promise<void> {
  await parseAssertion(
  async () => {
@@ -239,17 +243,19 @@ async function rejects(
 
 function doesNotReject(
  block: (() => Promise<unknown>) | Promise<unknown>,
- message?: string | Error
+ message?: ParseAssertionOptions['message']
 ): Promise<void>;
 function doesNotReject(
  block: (() => Promise<unknown>) | Promise<unknown>,
  error: nodeAssert.AssertPredicate,
- message?: string | Error
+ message?: ParseAssertionOptions['message']
 ): Promise<void>;
 async function doesNotReject(
  block: (() => Promise<unknown>) | Promise<unknown>,
- errorOrMessage?: nodeAssert.AssertPredicate | string | Error,
- message?: string | Error
+ errorOrMessage?:
+ | nodeAssert.AssertPredicate
+ | ParseAssertionOptions['message'],
+ message?: ParseAssertionOptions['message']
 ): Promise<void> {
  await parseAssertion(
  async () => {
@@ -330,5 +336,5 @@ export const assert = Object.assign(
  fail,
  rejects,
  }
- /* c8 ignore next */
+ /* c8 ignore next */ // c8 bug
 );
diff --git a/src/modules/create-service.ts b/src/modules/create-service.ts
@@ -1,15 +1,15 @@
-import process from 'node:process';
-import { spawn } from 'node:child_process';
-import { isWindows, runner, scriptRunner } from '../helpers/runner.js';
-import { normalize } from 'node:path';
-import { sanitizePath } from './list-files.js';
-import { kill } from './processes.js';
 /* c8 ignore next */
 import type {
  End,
  StartScriptOptions,
  StartServiceOptions,
 } from '../@types/background-process.js';
+import process from 'node:process';
+import { spawn } from 'node:child_process';
+import { isWindows, runner, scriptRunner } from '../helpers/runner.js';
+import { normalize } from 'node:path';
+import { sanitizePath } from './list-files.js';
+import { kill } from './processes.js';
 import { write } from '../helpers/logs.js';
 
 const runningProcesses: Map<number, { end: End; port?: number | number[] }> =
@@ -37,10 +37,8 @@ const backgroundProcess = (
  stdio: ['inherit', 'pipe', 'pipe'],
  /* c8 ignore next */
  shell: isWindows,
- cwd: options?.cwd
- ? sanitizePath(normalize(options.cwd))
- : /* c8 ignore next */
- undefined,
+ /* c8 ignore next */
+ cwd: options?.cwd ? sanitizePath(normalize(options.cwd)) : undefined,
  env: process.env,
  /* c8 ignore next */
  detached: !isWindows,
@@ -166,6 +164,7 @@ const backgroundProcess = (
  }
  }, options.startAfter);
  }
+ /* c8 ignore next */ // c8 bug
  } catch {}
  });
 
@@ -191,6 +190,7 @@ export const startService = async (
  );
 };
 
+/* c8 ignore start */ // c8 bug
 /**
  *
  * Starts a script (package.json) or task (deno.json) in a background process
@@ -203,6 +203,8 @@ export const startScript = async (
  script: string,
  options?: StartScriptOptions
 ): Promise<{ end: End }> => {
+ /* c8 ignore stop */
+ /* c8 ignore next */
  const runner = options?.runner || 'npm';
  const runtimeOptions = scriptRunner(runner);
  const runtime = runtimeOptions.shift()!;

diff --git a/src/modules/describe.ts b/src/modules/describe.ts
@@ -1,13 +1,11 @@
 /* c8 ignore next */
+import type { DescribeOptions } from '../@types/describe.js';
 import { hrtime, env } from 'node:process';
 import { format } from '../helpers/format.js';
 import { write } from '../helpers/logs.js';
-/* c8 ignore next */
 import { indentation } from '../configs/indentation.js';
-/* c8 ignore next */
-import type { DescribeOptions } from '../@types/describe.js';
 
-/* c8 ignore start */
+/* c8 ignore start */ // c8 bug
 /**
  * On **Poku**, `describe` also can be used just as a pretty `console.log` to title your test suites in the terminal.
  */
@@ -41,12 +39,11 @@ export async function describe(
  options = arg2 as DescribeOptions;
  }
 
- /* c8 ignore start */
  if (title) {
  indentation.hasDescribe = true;
 
  const { background, icon } = options || {};
- const message = `${cb ? format('◌').dim() : icon || '☰'} ${cb ? format(isPoku ? `${title} › ${format(`${FILE}`).italic().gray()}` : title).dim() : format(title).bold() || ''}`;
+ const message = `${cb ? format('◌').dim() : icon || '☰'} ${cb ? format(isPoku ? `${title} › ${format(`${FILE}`).italic().gray()}` : /* c8 ignore next */ title).dim() : format(title).bold() || ''}`;
  const noBackground = !background;
 
  if (noBackground) write(format(message).bold());
@@ -58,7 +55,6 @@ export async function describe(
  );
  }
  }
- /* c8 ignore stop */
 
  if (typeof cb !== 'function') return;
 
@@ -69,7 +65,6 @@ export async function describe(
  if (resultCb instanceof Promise) await resultCb;
  const end = hrtime(start);
 
- /* c8 ignore start */
  if (title) {
  const total = (end[0] * 1e3 + end[1] / 1e6).toFixed(6);
 
@@ -78,5 +73,4 @@ export async function describe(
  `${format(`● ${title}`).success().bold()} ${format(`› ${total}ms`).success().dim()}`
  );
  }
- /* c8 ignore stop */
 }
diff --git a/src/modules/each.ts b/src/modules/each.ts
@@ -52,6 +52,7 @@ export const beforeEach = (
  return { pause, continue: continueFunc, reset };
 };
 
+/* c8 ignore start */ // c8 bug
 /**
  * - ✅ Handling **global** and **external** services (_preparing a database, for example_)
  * - ✅ It's made for **exclusive use** in combination with **Poku**'s **`assert`** methods
@@ -77,6 +78,7 @@ export const afterEach = (
  callback: () => unknown,
  options?: Omit<EachOptions, 'immediate'>
 ): Control => {
+ /* c8 ignore stop */
  each.after.test = typeof options?.test === 'boolean' ? options.test : true;
  each.after.assert =
  typeof options?.assert === 'boolean' ? options.assert : false;

diff --git a/src/modules/it.ts b/src/modules/it.ts
@@ -1,13 +1,11 @@
-/* c8 ignore next */
+/* c8 ignore next */ // c8 bug
 import { hrtime, env } from 'node:process';
-/* c8 ignore next */
 import { each } from '../configs/each.js';
-/* c8 ignore next */
 import { indentation } from '../configs/indentation.js';
 import { format } from '../helpers/format.js';
 import { write } from '../helpers/logs.js';
 
-/* c8 ignore start */
+/* c8 ignore start */ // c8 bug
 export async function it(
  message: string,
  cb: () => Promise<unknown>
@@ -40,16 +38,15 @@ export async function it(
  cb = args[1] as () => unknown | Promise<unknown>;
  } else cb = args[0] as () => unknown | Promise<unknown>;
 
- /* c8 ignore start */
  if (message) {
  indentation.hasIt = true;
  write(
  isPoku && !indentation.hasDescribe
- ? `${indentation.hasDescribe ? ' ' : ''}${format(`◌ ${message} › ${format(`${FILE}`).italic().gray()}`).dim()}`
- : `${indentation.hasDescribe ? ' ' : ''}${format(`◌ ${message}`).dim()}`
+ ? `${indentation.hasDescribe ? ' ' : ''}${format(`◌ ${message} › ${format(`${FILE}`).italic().gray()}`).dim()}` /* c8 ignore next */ // c8 bug
+ : /* c8 ignore next */
+ `${indentation.hasDescribe ? ' ' : ''}${format(`◌ ${message}`).dim()}`
  );
  }
- /* c8 ignore end */
 
  const start = hrtime();
  const resultCb = cb();
@@ -64,7 +61,6 @@ export async function it(
  if (afterResult instanceof Promise) await afterResult;
  }
 
- /* c8 ignore start */
  if (message) {
  const total = (end[0] * 1e3 + end[1] / 1e6).toFixed(6);
 
@@ -73,5 +69,4 @@ export async function it(
  `${indentation.hasDescribe ? ' ' : ''}${format(`● ${message}`).success().bold()} ${format(`› ${total}ms`).success().dim()}`
  );
  }
- /* c8 ignore stop */
 }
diff --git a/src/modules/list-files.ts b/src/modules/list-files.ts
@@ -1,9 +1,8 @@
 /* c8 ignore next */
+import type { Configs } from '../@types/list-files.js';
 import { env } from 'node:process';
 import { sep, join } from 'node:path';
 import { readdir, stat as fsStat } from '../polyfills/fs.js';
-/* c8 ignore next */
-import type { Configs } from '../@types/list-files.js';
 
 export const sanitizePath = (input: string, ensureTarget?: boolean): string => {
  const sanitizedPath = input
@@ -83,7 +82,7 @@ export const getAllFiles = async (
  return files;
 };
 
-/* c8 ignore start */
+/* c8 ignore start */ // c8 bug
 export const listFiles = async (
  targetDir: string,
  configs?: Configs

diff --git a/src/modules/poku.ts b/src/modules/poku.ts
@@ -1,4 +1,4 @@
-/* c8 ignore start */
+/* c8 ignore start */ // c8 bug (incompatibility) =>
 /**
  * Both CLI, API, noExit, sequential and parallel runs are strictly tested, but these tests use deep child process for it
  */