wip: added tests and general polish

[ci skip]

Author: tegefaulkes

Cargo.toml

@@ -8,7 +8,7 @@ exclude = ["index.node"]
 
 [lib]
 crate-type = ["cdylib"]
-path = "src/native/napi/lib.rs"
+path = "src/napi/lib.rs"
 
 [dependencies]
 napi = { version = "2", features = ["async", "napi6", "serde-json"] }

package.json

@@ -26,8 +26,8 @@
     "prepublishOnly": "node ./scripts/prepublishOnly.js",
     "ts-node": "ts-node",
     "test": "jest",
-    "lint": "eslint '{src,tests,scripts}/**/*.{js,ts,json}' 'benches/**/*.{js,ts}'",
-    "lintfix": "eslint '{src,tests,scripts}/**/*.{js,ts,json}' 'benches/**/*.{js,ts}' --fix",
+    "lint": "eslint '{src,tests,scripts}/**/*.{js,ts,json}'",
+    "lintfix": "eslint '{src,tests,scripts}/**/*.{js,ts,json}' --fix",
     "lint-shell": "find ./src ./tests ./scripts -type f -regextype posix-extended -regex '.*\\.(sh)' -exec shellcheck {} +",
     "docs": "shx rm -rf ./docs && typedoc --gitRevision master --tsconfig ./tsconfig.build.json --out ./docs src"
   },

src/native/exec.ts src/exec.tssrc/native/exec.ts renamed to src/exec.ts

@@ -1,17 +1,16 @@
 /**
- * JS binding to NAPI quiche dynamic library.
+ * JS binding to NAPI uapi.
  * This code was derived from the auto-generated binding and declaration
  * files provided by napi-rs.
  */
 import process from 'process';
 import path from 'path';
 
 interface Exec {
-  test(tings: Array<string>): undefined;
-  execvpe(cmd: string, argv: Array<string>): undefined;
+  execvpe(cmd: string, argv: Array<string>, envv: Array<string>): undefined;
 }
 
-const projectRoot = path.join(__dirname, '../../');
+const projectRoot = path.join(__dirname, '../');
 const prebuildPath = path.join(projectRoot, 'prebuild');
 
 /**
@@ -47,25 +46,10 @@ function requireBinding(targets: Array<string>): Exec {
 let nativeBinding: Exec;
 
 /**
- * For desktop we only support win32, darwin and linux.
+ * For desktop we only support darwin and linux.
  * Mobile OS support is pending.
  */
 switch (process.platform) {
-  case 'win32':
-    switch (process.arch) {
-      case 'x64':
-        nativeBinding = requireBinding(['win32-x64']);
-        break;
-      case 'ia32':
-        nativeBinding = requireBinding(['win32-ia32']);
-        break;
-      case 'arm64':
-        nativeBinding = requireBinding(['win32-arm64']);
-        break;
-      default:
-        throw new Error(`Unsupported architecture on Windows: ${process.arch}`);
-    }
-    break;
   case 'darwin':
     switch (process.arch) {
       case 'x64':

src/native/index.ts src/index.tssrc/native/index.ts renamed to src/index.ts

@@ -16,21 +16,14 @@ fn set_fd_cloexec() -> uapi::Result<()> {
   Ok(())
 }
 
-#[napi(ts_args_type="things: Array<string>")]
-pub fn test(things: Array) -> () {
-  match things.get::<String>(0) {
-    Ok(Some(thing)) => println!("thinggy {:?}", thing),
-    _ => println!("failed"),
-  }
-}
-
-#[napi(ts_args_type="cmd: string, argv: Array<string>")]
-pub fn execvpe(cmd: String, argv: Array) -> napi::Result<()> {
+#[napi(ts_args_type="cmd: string, argv: Array<string>, envp: Array<string>")]
+pub fn execvpe(cmd: String, argv: Array, envp: Array) -> napi::Result<()> {
   // Before making the call we need to configure the stdio. This ensures we get the output of the exec'ed program.
   set_fd_cloexec().or_else(
     |e| Err(napi::Error::from_reason(e.to_string()))
   )?;
 
+  // Setting up the arg parameters
   let mut argv_ = uapi::UstrPtr::new();
   argv_.push(cmd.clone());
   for i in 0..argv.len() {
@@ -43,12 +36,24 @@ pub fn execvpe(cmd: String, argv: Array) -> napi::Result<()> {
       _ => Ok(()),
     }?;
   }
-  let envv = uapi::UstrPtr::new();
+
+  // Setting up the env parameters
+  let mut envp_ = uapi::UstrPtr::new();
+  for i in 0..envp.len() {
+    match envp.get::<String>(i) {
+      Ok(Some(value)) => {
+        envp_.push(value);
+        Ok(())
+      },
+      Err(e) => Err(napi::Error::from_reason(e.to_string())),
+      _ => Ok(()),
+    }?;
+  }
 
   uapi::execvpe(
     cmd,
     &argv_,
-    &envv,
+    &envp_,
   ).or_else(
     |e| Err(napi::Error::from_reason(e.to_string()))
   )

src/native/napi/lib.rs src/napi/lib.rssrc/native/napi/lib.rs renamed to src/napi/lib.rs

@@ -1,7 +1,15 @@
-import { exec } from '@/native'
+import child_process from 'child_process';
+import { exec } from '@';
 
-test('asd', async () => {
-
-  console.log('doing test!');
-  console.log(exec.test());
-})
+test('execvpe should provide environment variables', async () => {
+  const output = child_process.execFileSync('./tests/callExecvpe.ts');
+  const jsonOut = JSON.parse(output.toString());
+  expect(jsonOut).toMatchObject({
+    test: 'asd',
+    best: 'bsd',
+  });
+});
+test('execvpe should throw when call fails', async () => {
+  // Code 2 corresponds to `ENOENT`
+  expect(() => exec.execvpe('invalidCommand', [], [])).toThrow('2');
+});

tests/Exec.test.ts

@@ -0,0 +1,8 @@
+#!/usr/bin/env ts-node
+
+import { exec } from '@';
+// This executes `printEnv.js` while setting environment variables
+// eslint-disable-next-line no-console
+console.log(
+  exec.execvpe('node', ['./tests/printEnv.js'], ['test=asd', 'best=bsd']),
+);

tests/callExecvpe.ts

@@ -0,0 +1,5 @@
+#!/usr/bin/env node
+
+// Only need to print out the current environment
+// eslint-disable-next-line no-console
+console.log(JSON.stringify(process.env, undefined, 1));