test: add unit tests for converters

src/converters/assimp.ts

@@ -1,4 +1,5 @@
-import { execFile } from "node:child_process";
+import { execFile as execFileOriginal } from "node:child_process";
+import { ExecFileFn } from "./types";
 
 export const properties = {
   from: {
@@ -116,8 +117,8 @@ export async function convert(
   fileType: string,
   convertTo: string,
   targetPath: string,
-  // eslint-disable-next-line @typescript-eslint/no-unused-vars
   options?: unknown,
+  execFile: ExecFileFn = execFileOriginal, // to make it mockable
 ): Promise<string> {
   return new Promise((resolve, reject) => {
     execFile("assimp", ["export", filePath, targetPath], (error, stdout, stderr) => {

src/converters/calibre.ts

@@ -1,4 +1,5 @@
-import { execFile } from "node:child_process";
+import { execFile as execFileOriginal } from "node:child_process";
+import { ExecFileFn } from "./types";
 
 export const properties = {
   from: {
@@ -62,8 +63,8 @@ export async function convert(
   fileType: string,
   convertTo: string,
   targetPath: string,
-  // eslint-disable-next-line @typescript-eslint/no-unused-vars
   options?: unknown,
+  execFile: ExecFileFn = execFileOriginal, // to make it mockable
 ): Promise<string> {
   return new Promise((resolve, reject) => {
     execFile("ebook-convert", [filePath, targetPath], (error, stdout, stderr) => {

src/converters/dvisvgm.ts

@@ -1,4 +1,5 @@
-import { execFile } from "node:child_process";
+import { execFile as execFileOriginal } from "node:child_process";
+import { ExecFileFn } from "./types";
 
 export const properties = {
   from: {
@@ -14,8 +15,8 @@ export function convert(
   fileType: string,
   convertTo: string,
   targetPath: string,
-  // eslint-disable-next-line @typescript-eslint/no-unused-vars
   options?: unknown,
+  execFile: ExecFileFn = execFileOriginal, // to make it mockable
 ): Promise<string> {
   const inputArgs: string[] = [];
   if (fileType === "eps") {

src/converters/ffmpeg.ts

@@ -1,4 +1,5 @@
-import { execFile } from "node:child_process";
+import { execFile as execFileOriginal } from "node:child_process";
+import { ExecFileFn } from "./types";
 
 // This could be done dynamically by running `ffmpeg -formats` and parsing the output
 export const properties = {
@@ -691,8 +692,8 @@ export async function convert(
   fileType: string,
   convertTo: string,
   targetPath: string,
-  // eslint-disable-next-line @typescript-eslint/no-unused-vars
   options?: unknown,
+  execFile: ExecFileFn = execFileOriginal, // to make it mockable
 ): Promise<string> {
   let extraArgs: string[] = [];
   let message = "Done";

src/converters/graphicsmagick.ts

@@ -1,4 +1,5 @@
-import { execFile } from "node:child_process";
+import { execFile as execFileOriginal } from "node:child_process";
+import { ExecFileFn } from "./types";
 
 export const properties = {
   from: {
@@ -313,8 +314,8 @@ export function convert(
   fileType: string,
   convertTo: string,
   targetPath: string,
-  // eslint-disable-next-line @typescript-eslint/no-unused-vars
   options?: unknown,
+  execFile: ExecFileFn = execFileOriginal, // to make it mockable
 ): Promise<string> {
   return new Promise((resolve, reject) => {
     execFile("gm", ["convert", filePath, targetPath], (error, stdout, stderr) => {

src/converters/imagemagick.ts

@@ -1,4 +1,5 @@
-import { execFile } from "node:child_process";
+import { execFile as execFileOriginal } from "node:child_process";
+import { ExecFileFn } from "./types";
 
 // declare possible conversions
 export const properties = {
@@ -445,8 +446,8 @@ export function convert(
   fileType: string,
   convertTo: string,
   targetPath: string,
-  // eslint-disable-next-line @typescript-eslint/no-unused-vars
   options?: unknown,
+  execFile: ExecFileFn = execFileOriginal, // to make it mockable
 ): Promise<string> {
   let outputArgs: string[] = [];
   let inputArgs: string[] = [];

src/converters/inkscape.ts

@@ -1,4 +1,5 @@
-import { execFile } from "node:child_process";
+import { execFile as execFileOriginal } from "node:child_process";
+import { ExecFileFn } from "./types";
 
 export const properties = {
   from: {
@@ -32,8 +33,8 @@ export function convert(
   fileType: string,
   convertTo: string,
   targetPath: string,
-  // eslint-disable-next-line @typescript-eslint/no-unused-vars
   options?: unknown,
+  execFile: ExecFileFn = execFileOriginal, // to make it mockable
 ): Promise<string> {
   return new Promise((resolve, reject) => {
     execFile("inkscape", [filePath, "-o", targetPath], (error, stdout, stderr) => {

src/converters/libheif.ts

@@ -1,4 +1,5 @@
-import { execFile } from "child_process";
+import { execFile as execFileOriginal } from "child_process";
+import { ExecFileFn } from "./types";
 
 export const properties = {
   from: {
@@ -14,8 +15,8 @@ export function convert(
   fileType: string,
   convertTo: string,
   targetPath: string,
-  // eslint-disable-next-line @typescript-eslint/no-unused-vars
   options?: unknown,
+  execFile: ExecFileFn = execFileOriginal, // to make it mockable
 ): Promise<string> {
   return new Promise((resolve, reject) => {
     execFile("heif-convert", [filePath, targetPath], (error, stdout, stderr) => {

src/converters/libjxl.ts

@@ -1,4 +1,5 @@
-import { execFile } from "node:child_process";
+import { execFile as execFileOriginal } from "node:child_process";
+import { ExecFileFn } from "./types";
 
 // declare possible conversions
 export const properties = {
@@ -17,8 +18,8 @@ export function convert(
   fileType: string,
   convertTo: string,
   targetPath: string,
-  // eslint-disable-next-line @typescript-eslint/no-unused-vars
   options?: unknown,
+  execFile: ExecFileFn = execFileOriginal, // to make it mockable
 ): Promise<string> {
   let tool = "";
   if (fileType === "jxl") {

src/converters/libreoffice.ts

@@ -1,4 +1,5 @@
-import { execFile } from "node:child_process";
+import { execFile as execFileOriginal } from "node:child_process";
+import { ExecFileFn } from "./types";
 
 export const properties = {
   from: {
@@ -136,8 +137,8 @@ export function convert(
   fileType: string,
   convertTo: string,
   targetPath: string,
-  // eslint-disable-next-line @typescript-eslint/no-unused-vars
   options?: unknown,
+  execFile: ExecFileFn = execFileOriginal,
 ): Promise<string> {
   const outputPath = targetPath.split("/").slice(0, -1).join("/").replace("./", "") ?? targetPath;
 

src/converters/msgconvert.ts

@@ -1,4 +1,5 @@
-import { execFile } from "node:child_process";
+import { execFile as execFileOriginal } from "node:child_process";
+import { ExecFileFn } from "./types";
 
 export const properties = {
   from: {
@@ -14,8 +15,8 @@ export function convert(
   fileType: string,
   convertTo: string,
   targetPath: string,
-  // eslint-disable-next-line @typescript-eslint/no-unused-vars
   options?: unknown,
+  execFile: ExecFileFn = execFileOriginal,
 ): Promise<string> {
   return new Promise((resolve, reject) => {
     if (fileType === "msg" && convertTo === "eml") {

src/converters/pandoc.ts

@@ -1,4 +1,5 @@
-import { execFile } from "node:child_process";
+import { execFile as execFileOriginal } from "node:child_process";
+import { ExecFileFn } from "./types";
 
 export const properties = {
   from: {
@@ -124,8 +125,8 @@ export function convert(
   fileType: string,
   convertTo: string,
   targetPath: string,
-  // eslint-disable-next-line @typescript-eslint/no-unused-vars
   options?: unknown,
+  execFile: ExecFileFn = execFileOriginal,
 ): Promise<string> {
   // set xelatex here
   const xelatex = ["pdf", "latex"];

src/converters/potrace.ts

@@ -1,4 +1,5 @@
-import { execFile } from "node:child_process";
+import { execFile as execFileOriginal } from "node:child_process";
+import { ExecFileFn } from "./types";
 
 export const properties = {
   from: {
@@ -26,8 +27,8 @@ export function convert(
   fileType: string,
   convertTo: string,
   targetPath: string,
-  // eslint-disable-next-line @typescript-eslint/no-unused-vars
   options?: unknown,
+  execFile: ExecFileFn = execFileOriginal, // to make it mockable
 ): Promise<string> {
   return new Promise((resolve, reject) => {
     execFile("potrace", [filePath, "-o", targetPath, "-b", convertTo], (error, stdout, stderr) => {

src/converters/resvg.ts

@@ -1,4 +1,5 @@
-import { execFile } from "node:child_process";
+import { execFile as execFileOriginal } from "node:child_process";
+import { ExecFileFn } from "./types";
 
 export const properties = {
   from: {
@@ -14,8 +15,8 @@ export function convert(
   fileType: string,
   convertTo: string,
   targetPath: string,
-  // eslint-disable-next-line @typescript-eslint/no-unused-vars
   options?: unknown,
+  execFile: ExecFileFn = execFileOriginal, // to make it mockable
 ): Promise<string> {
   return new Promise((resolve, reject) => {
     execFile("resvg", [filePath, targetPath], (error, stdout, stderr) => {

src/converters/types.ts

@@ -0,0 +1,15 @@
+export type ExecFileFn = (
+  cmd: string,
+  args: string[],
+  callback: (err: Error | null, stdout: string, stderr: string) => void,
+  options?: import("child_process").ExecFileOptions,
+) => void;
+
+export type ConvertFnWithExecFile = (
+  filePath: string,
+  fileType: string,
+  convertTo: string,
+  targetPath: string,
+  options: unknown,
+  execFileOverride?: ExecFileFn,
+) => Promise<string>;

src/converters/vips.ts

@@ -1,4 +1,5 @@
-import { execFile } from "node:child_process";
+import { execFile as execFileOriginal } from "node:child_process";
+import { ExecFileFn } from "./types";
 
 // declare possible conversions
 export const properties = {
@@ -94,8 +95,8 @@ export function convert(
   fileType: string,
   convertTo: string,
   targetPath: string,
-  // eslint-disable-next-line @typescript-eslint/no-unused-vars
   options?: unknown,
+  execFile: ExecFileFn = execFileOriginal,
 ): Promise<string> {
   // if (fileType === "svg") {
   //   const scale = options.scale || 1;

src/converters/xelatex.ts

@@ -1,4 +1,5 @@
-import { execFile } from "node:child_process";
+import { execFile as execFileOriginal } from "node:child_process";
+import { ExecFileFn } from "./types";
 
 export const properties = {
   from: {
@@ -14,8 +15,8 @@ export function convert(
   fileType: string,
   convertTo: string,
   targetPath: string,
-  // eslint-disable-next-line @typescript-eslint/no-unused-vars
   options?: unknown,
+  execFile: ExecFileFn = execFileOriginal,
 ): Promise<string> {
   return new Promise((resolve, reject) => {
     // const fileName: string = (targetPath.split("/").pop() as string).replace(".pdf", "")

tests/converters/assimp.test.ts

@@ -0,0 +1,7 @@
+import { test } from "bun:test";
+import { convert } from "../../src/converters/assimp";
+import { runCommonTests } from "./helpers/commonTests";
+
+runCommonTests(convert);
+
+test.skip("dummy - required to trigger test detection", () => {});

tests/converters/calibre.test.ts

@@ -0,0 +1,7 @@
+import { test } from "bun:test";
+import { convert } from "../../src/converters/calibre";
+import { runCommonTests } from "./helpers/commonTests";
+
+runCommonTests(convert);
+
+test.skip("dummy - required to trigger test detection", () => {});

tests/converters/dvisvgm.test.ts

@@ -0,0 +1,91 @@
+import type { ExecFileException } from "node:child_process";
+import { beforeEach, expect, test } from "bun:test";
+import { convert } from "../../src/converters/dvisvgm";
+import { ExecFileFn } from "../../src/converters/types";
+import { runCommonTests } from "./helpers/commonTests";
+
+let calls: string[][] = [];
+
+beforeEach(() => {
+  calls = [];
+});
+
+runCommonTests(convert);
+
+test("convert respects eps filetype", async () => {
+  const originalConsoleLog = console.log;
+
+  let loggedMessage = "";
+  console.log = (msg) => {
+    loggedMessage = msg;
+  };
+
+  const mockExecFile: ExecFileFn = (
+    _cmd: string,
+    _args: string[],
+    callback: (err: ExecFileException | null, stdout: string, stderr: string) => void,
+  ) => {
+    calls.push(_args);
+    callback(null, "Fake stdout", "");
+  };
+
+  const result = await convert("input.eps", "eps", "stl", "output.stl", undefined, mockExecFile);
+
+  console.log = originalConsoleLog;
+
+  expect(result).toBe("Done");
+  expect(calls[0]).toEqual(expect.arrayContaining(["--eps", "input.eps", "output.stl"]));
+  expect(loggedMessage).toBe("stdout: Fake stdout");
+});
+
+test("convert respects pdf filetype", async () => {
+  const originalConsoleLog = console.log;
+
+  let loggedMessage = "";
+  console.log = (msg) => {
+    loggedMessage = msg;
+  };
+
+  const mockExecFile: ExecFileFn = (
+    _cmd: string,
+    _args: string[],
+    callback: (err: ExecFileException | null, stdout: string, stderr: string) => void,
+  ) => {
+    calls.push(_args);
+    callback(null, "Fake stdout", "");
+  };
+
+  const result = await convert("input.pdf", "pdf", "stl", "output.stl", undefined, mockExecFile);
+
+  console.log = originalConsoleLog;
+
+  expect(result).toBe("Done");
+  expect(calls[0]).toEqual(expect.arrayContaining(["--pdf", "input.pdf", "output.stl"]));
+  expect(loggedMessage).toBe("stdout: Fake stdout");
+});
+
+test("convert respects svgz conversion target type", async () => {
+  const originalConsoleLog = console.log;
+
+  let loggedMessage = "";
+  console.log = (msg) => {
+    loggedMessage = msg;
+  };
+
+  const mockExecFile: ExecFileFn = (
+    _cmd: string,
+    _args: string[],
+    callback: (err: ExecFileException | null, stdout: string, stderr: string) => void,
+  ) => {
+    calls.push(_args);
+    callback(null, "Fake stdout", "");
+  };
+
+  const result = await convert("input.obj", "eps", "svgz", "output.svgz", undefined, mockExecFile);
+
+  console.log = originalConsoleLog;
+
+  expect(result).toBe("Done");
+  expect(calls[0]).toEqual(expect.arrayContaining(["-z", "input.obj", "output.svgz"]));
+  expect(loggedMessage).toBe("stdout: Fake stdout");
+});