✅ add test for the cli script

This commit adds a test for the cli script. Also I take the opportunity to:
- Reorganize the tests folder by creating a dedicated file for the
execute function and to import the fixtures
- Add a pre npm script to build the project before running the tests as it
is required to run the cli script

Author: imqdee

.github/workflows/release-package.yml

@@ -33,8 +33,8 @@ jobs:
           node-version: 18
           registry-url: https://npm.pkg.github.com/
       - run: npm ci
+      # the test command starts by building the package
       - run: npm run test
-      - run: npm run build
       - run: npm publish
         env:
           NODE_AUTH_TOKEN: ${{secrets.GITHUB_TOKEN}}

package.json

@@ -23,6 +23,7 @@
     "build": "parcel build",
     "build:verbose": "npm run build -- --detailed-report",
     "watch": "parcel watch",
+    "pretest": "npm run build -- --log-level=none",
     "test": "jest --testPathIgnorePatterns=tests/differential",
     "test:coverage": "npm run test -- --coverage",
     "test:verbose": "npm run test -- --verbose",

tests/cli.test.ts

@@ -0,0 +1,18 @@
+import execute from "./utils/execute";
+import fixtures from "./fixtures";
+
+describe("cli", () => {
+  it("test the cli script works as expected", async () => {
+    // get a random fixture data from the list
+    const { pubkey, points: referencePoints } =
+      fixtures.data[Math.floor(Math.random() * fixtures.data.length)];
+
+    // precompute the points using the cli script by providing the public key
+    const precomputedPoints = (await execute(
+      `node ./cli.mjs ${pubkey.x} ${pubkey.y}`
+    )) as string;
+
+    // check the precomputed points are the same than the reference points
+    expect(precomputedPoints.trim()).toEqual(referencePoints);
+  });
+});

tests/differential/index.spec.ts

@@ -1,39 +1,6 @@
-import childProcess from "child_process";
 import { secp256r1 } from "@noble/curves/p256";
 import precomputePoints from "../../src";
-
-/**
- * Executes a shell command and returns its output as a string.
- *
- * @param {string} command A shell command to execute
- * @return {Promise<string>} A promise that resolve to the output of the shell command, or an error
- *
- * @example
- * const output = await execute("ls -alh");
- */
-function execute(command) {
-    return new Promise(function (resolve, reject) {
-        /**
-         * @param {Error} error An error triggered during the execution of the childProcess.exec command
-         * @param {string|Buffer} standardOutput The result of the shell command execution
-         * @param {string|Buffer} standardError The error resulting of the shell command execution
-         * @see https://nodejs.org/api/child_process.html#child_process_child_process_exec_command_options_callback
-         */
-        childProcess.exec(command, function (error, standardOutput, standardError) {
-            if (error) {
-                reject();
-                return;
-            }
-
-            if (standardError) {
-                reject(standardError);
-                return;
-            }
-
-            resolve(standardOutput);
-        });
-    });
-}
+import execute from "../utils/execute";
 
 describe("differential testing", () => {
     const NUMBER_OF_TESTS = 15;

tests/fixtures.ts

@@ -0,0 +1,7 @@
+import data from "./fixtures.json";
+
+// cast the JSON to the expected types
+type Fixture = { data: { pubkey: { x: string; y: string }; points: string }[] };
+const fixtures = data as Fixture;
+
+export default fixtures;

tests/index.test.ts

@@ -1,11 +1,7 @@
 import precomputePoints from "../src";
 import { secp256r1 } from "@noble/curves/p256";
 import isPointOnCurve from "./utils/isPointOnCurve";
-import data from "./fixtures.json";
-
-// cast the JSON to the expected types
-type Fixture = { data: { pubkey: { x: string; y: string }; points: string }[] };
-const fixtures = data as Fixture;
+import fixtures from "./fixtures";
 
 /**
  * Splits a concatenated string of x and y coordinates into an array of {x, y} points.

tests/utils/execute.test.ts

@@ -0,0 +1,14 @@
+import execute from "./execute";
+
+describe("execute", () => {
+    it("Trigger an error during the execution of the childProcess.exec command", async () => {
+        await expect(execute("addawafafafafawdf")).rejects.toBe(undefined);
+    });
+    // @DEV: This test is not working, it doesn't pass into the expected branch
+    xit("Trigger an error in the shell command", async () => {
+        await expect(execute("echo hello | grep \"asdf\"")).rejects.toBe(undefined);
+    });
+    it("ok", async () => {
+        await expect(execute("echo yo")).resolves.toMatch("yo");
+    });
+});

tests/utils/execute.ts

@@ -0,0 +1,36 @@
+import childProcess from "child_process";
+
+/**
+ * Executes a shell command and returns its output as a string.
+ *
+ * @param {string} command A shell command to execute
+ * @return {Promise<string>} A promise that resolve to the output of the shell command, or an error
+ *
+ * @example
+ * const output = await execute("ls -alh");
+ */
+function execute(command) {
+    return new Promise(function (resolve, reject) {
+        /**
+         * @param {Error} error An error triggered during the execution of the childProcess.exec command
+         * @param {string|Buffer} standardOutput The result of the shell command execution
+         * @param {string|Buffer} standardError The error resulting of the shell command execution
+         * @see https://nodejs.org/api/child_process.html#child_process_child_process_exec_command_options_callback
+         */
+        childProcess.exec(command, function (error, standardOutput, standardError) {
+            if (error) {
+                reject();
+                return;
+            }
+
+            if (standardError) {
+                reject(standardError);
+                return;
+            }
+
+            resolve(standardOutput);
+        });
+    });
+}
+
+export default execute;