test: support multiple zig_modules to better organize tests

Author: typesafe

.gitignore

@@ -4,5 +4,4 @@ zig-out/
 *.o
 
 node_modules
-
-tests/node_modules/node-api-test-module/zig-module.node
+tests/zig_modules/*.node

build.zig

@@ -17,34 +17,60 @@ pub fn build(b: *std.Build) void {
 
     node_api.addSystemIncludePath(node_api_headers.path("include"));
 
-    const sample_addon = b.addLibrary(.{
-        .use_llvm = true,
-        .linkage = .dynamic,
-        .name = "sample-addon",
-        .root_module = b.createModule(.{
-            .root_source_file = b.path("tests/zig/test-module.zig"),
-            .optimize = optimize,
-            .target = target,
-        }),
-    });
-    sample_addon.root_module.addImport("node-api", node_api);
+    const install_step = b.getInstallStep();
 
-    // important
-    sample_addon.linker_allow_shlib_undefined = true;
-    sample_addon.linkLibC();
+    // zig build (test modules)
+    {
+        var dir = std.fs.cwd().openDir("tests/zig_modules", .{ .iterate = true }) catch unreachable;
+        defer dir.close();
 
-    const install_step = b.getInstallStep();
+        var it = dir.iterate();
+        while (it.next() catch unreachable) |entry| {
+            switch (entry.kind) {
+                .directory => {
+                    std.log.info("tests/zig_modules/{s}/src/root.zig", .{entry.name});
+
+                    const mod = b.addLibrary(.{
+                        // imprtant, works without on MacOS, but not on Linux
+                        .use_llvm = true,
+                        .linkage = .dynamic,
+                        .name = entry.name,
+                        .root_module = b.createModule(.{
+                            .root_source_file = b.path(std.fmt.allocPrint(b.allocator, "tests/zig_modules/{s}/src/root.zig", .{entry.name}) catch unreachable),
+                            .optimize = optimize,
+                            .target = target,
+                        }),
+                    });
+                    mod.root_module.addImport("node-api", node_api);
 
-    install_step.dependOn(
-        &b.addInstallArtifact(
-            sample_addon,
-            .{
-                // custom dir is relative to ./zig-out
-                .dest_dir = .{ .override = .{ .custom = "../tests/node_modules/node-api-test-module" } },
-                .dest_sub_path = "zig-module.node",
-            },
-        ).step,
-    );
+                    // important
+                    mod.linker_allow_shlib_undefined = true;
+                    mod.linkLibC();
+
+                    const sub_path = std.fmt.allocPrint(b.allocator, "{s}.node", .{entry.name}) catch |err| {
+                        std.log.info("{s}", .{@errorName(err)});
+                        unreachable;
+                    };
+                    std.log.info("sub path: {s}", .{sub_path});
+
+                    install_step.dependOn(
+                        &b.addInstallArtifact(
+                            mod,
+                            .{
+                                // custom dir is relative to ./zig-out
+                                .dest_dir = .{ .override = .{
+                                    .custom = "../tests/zig_modules",
+                                } },
+
+                                .dest_sub_path = sub_path,
+                            },
+                        ).step,
+                    );
+                },
+                else => {},
+            }
+        }
+    }
 
     // `zig build test`
     {

tests/callbacks.spec.ts

@@ -1,6 +1,9 @@
-import addon from "node-api-test-module";
+import requireTestModule from "./zig_modules";
+const addon = requireTestModule("test-module");
+
 import { describe, it, expect } from "bun:test";
 
+
 describe("callback parameters", () => {
   const capturedValue = 3;
 

tests/classes.spec.ts

@@ -1,6 +1,8 @@
-import addon from "node-api-test-module";
 import { describe, it, expect } from "bun:test";
 
+import requireTestModule from "./zig_modules";
+const addon = requireTestModule("test-module");
+
 describe("defineClass", () => {
   it("should define class as (constructor) function", () => {
     expect(addon.TestClass).toBeFunction();

tests/errors.spec.ts

@@ -1,6 +1,8 @@
-import addon from "node-api-test-module";
 import { describe, it, expect } from "bun:test";
 
+import requireTestModule from "./zig_modules";
+const addon = requireTestModule("test-module");
+
 describe("Import Node-API module", () => {
   it("should return module value", () => {
     expect(addon).toBeDefined();

tests/functions.spec.ts

@@ -1,6 +1,8 @@
-import addon from "node-api-test-module";
 import { describe, it, expect } from "bun:test";
 
+import requireTestModule from "./zig_modules";
+const addon = requireTestModule("test-module");
+
 describe("functions", () => {
   it("should be defined as function", () => {
     expect(addon.functions.fnWithSerializedParams).toBeFunction();

tests/import.spec.ts

@@ -1,6 +1,8 @@
-import addon from "node-api-test-module";
 import { describe, it, expect } from "bun:test";
 
+import requireTestModule from "./zig_modules";
+const addon = requireTestModule("test-module");
+
 describe("Import Zig Node-API module", () => {
   it("should return Zig struct instance with all exported members", () => {
     expect(addon).toBeDefined();

tests/index.ts

@@ -1,7 +1,9 @@
-import addon from "node-api-test-module";
 import { describe, it, expect } from "bun:test";
 import { gc, sleep } from "bun";
 
+import requireTestModule from "./zig_modules";
+const addon = requireTestModule("test-module");
+
 // this will be GC'ed (and finalized)
 new addon.TestClass(12);
 

tests/memory.spec.ts

@@ -1,6 +1,8 @@
-import addon from "node-api-test-module";
 import { describe, it, expect } from "bun:test";
 
+import requireTestModule from "./zig_modules";
+const addon = requireTestModule("test-module");
+
 describe("NodeArray", () => {
   describe("len", () => {
     it("should return zero for empty array ", () => {
@@ -20,7 +22,7 @@ describe("NodeArray", () => {
     });
   });
 
-    describe("has", () => {
+  describe("has", () => {
     it("should return true for existing element", () => {
       expect(addon.nodeArray.has([123, 456], 1)).toEqual(true);
     });