使用zig test测试Wasm项目时extern函数链接错误的解决方案咨询

我有一个编译为WebAssembly的Zig代码库，build.zig配置如下：

const std = @import("std");

pub fn build(b: *std.build.Builder) void {
  const mode = b.standardReleaseOptions();
  const lib = b.addSharedLibrary("main", "src/main.zig", b.version(0, 0, 0));
  lib.setBuildMode(mode);
  lib.setTarget(.{.cpu_arch = .wasm32, .os_tag = .freestanding});
  lib.setOutputDir("web/dist");
  b.default_step.dependOn(&lib.step);
}

src/main.zig中包含一个标记为extern的printString函数，由WebAssembly导入提供，在浏览器中运行正常。但执行zig test src/main.zig时，即便测试代码未调用该extern函数，仍出现链接错误：

MachO Flush... error(link): undefined reference to symbol '_printString'

需要找到测试时链接extern函数替代实现的合理方式，或其他测试变通方案。

解决方案 #

1. 用条件编译提供测试专用的mock实现 #

在src/main.zig中，利用Zig的builtin模块判断是否处于测试模式，为printString提供mock实现：

const std = @import("std");
const builtin = @import("builtin");

// 生产环境下的extern声明
extern "env" fn printString(str: [*:0]const u8) void;

// 测试模式下覆盖实现
comptime {
    if (builtin.is_test) {
        @export(printString, .{ .name = "printString", .linkage = .Strong });
        fn printString(str: [*:0]const u8) void {
            std.debug.print("Mock printString: {s}\n", .{str});
        }
    }
}

测试时会自动使用mock实现，避免链接错误；Wasm构建时则保留原extern声明。

2. 在build.zig中添加测试目标并链接mock代码 #

创建src/test_mocks.zig文件实现mock函数：

const std = @import("std");

pub export fn printString(str: [*:0]const u8) void {
    std.debug.print("Mock print: {s}\n", .{str});
}

修改build.zig，添加测试目标并链接mock代码：

const std = @import("std");

pub fn build(b: *std.build.Builder) void {
    // 原有Wasm构建逻辑
    const mode = b.standardReleaseOptions();
    const lib = b.addSharedLibrary("main", "src/main.zig", b.version(0, 0, 0));
    lib.setBuildMode(mode);
    lib.setTarget(.{.cpu_arch = .wasm32, .os_tag = .freestanding});
    lib.setOutputDir("web/dist");
    b.default_step.dependOn(&lib.step);

    // 新增测试目标
    const test_step = b.step("test", "Run tests");
    const test_exe = b.addTest("src/main.zig");
    test_exe.setBuildMode(mode);
    test_exe.addSourceFile("src/test_mocks.zig");
    test_step.dependOn(&test_exe.step);
}

运行zig build test即可执行带mock的测试。

3. 隔离依赖extern的代码 #

将依赖printString的逻辑封装到单独模块src/wasm_io.zig：

extern "env" fn printString(str: [*:0]const u8) void;

pub fn print(str: []const u8) void {
    printString(str.ptr);
}

src/main.zig中调用该模块：

const wasm_io = @import("wasm_io.zig");

pub fn doSomething() void {
    wasm_io.print("Hello Wasm!\n");
}

测试时创建mock模块src/test_mock_io.zig：

const std = @import("std");

pub fn print(str: []const u8) void {
    std.debug.print("Mock print: {s}\n", .{str});
}

测试文件src/main_test.zig中替换依赖：

const main = @import("main.zig");
const wasm_io = @import("test_mock_io.zig");

test "doSomething" {
    main.doSomething();
}

这种方式通过模块替换，让测试代码完全脱离Wasm extern依赖。

内容的提问来源于stack exchange，提问作者Dan Prince