2 Mock Tauri API

  3 分钟阅读  

原文链接: https://tauri.app/develop/tests/mocking/

在编写前端测试时，通常需要一个“假的” Tauri 环境来模拟窗口或拦截 IPC 调用，也就是所谓的_模拟（mocking）_。 @tauri-apps/api/mocks 模块提供了一些实用工具，让它对你来说更简单：

IPC 请求

最常见的是你想拦截 IPC 请求；这在多种场景下都很有用：

  • 确保发起了正确的后端调用
  • 模拟后端函数返回不同的结果

Tauri 提供了 mockIPC 函数来拦截 IPC 请求。你可以在这里找到关于该具体 API 的更多细节。

为 invoke 模拟命令

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27

import { beforeAll, expect, test } from "vitest";
import { randomFillSync } from "crypto";

import { mockIPC } from "@tauri-apps/api/mocks";
import { invoke } from "@tauri-apps/api/core";

// jsdom 不带 WebCrypto 实现
beforeAll(() => {
  Object.defineProperty(window, 'crypto', {
    value: {
      // @ts-ignore
      getRandomValues: (buffer) => {
        return randomFillSync(buffer);
      },
    },
  });
});


test("invoke simple", async () => {
  mockIPC((cmd, args) => {
    // 模拟一个名为 "add" 的 rust 命令，只把两个数相加
    if(cmd === "add") {
      return (args.a as number) + (args.b as number);
    }
  });
});

有时你想跟踪一次 IPC 调用的更多信息：该命令被调用了多少次？到底有没有被调用？ 你可以把 mockIPC() 与其它监视和模拟工具一起使用来测试：

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33

import { beforeAll, expect, test, vi } from "vitest";
import { randomFillSync } from "crypto";

import { mockIPC } from "@tauri-apps/api/mocks";
import { invoke } from "@tauri-apps/api/core";

// jsdom 不带 WebCrypto 实现
beforeAll(() => {
  Object.defineProperty(window, 'crypto', {
    value: {
      // @ts-ignore
      getRandomValues: (buffer) => {
        return randomFillSync(buffer);
      },
    },
  });
});


test("invoke", async () => {
  mockIPC((cmd, args) => {
    // 模拟一个名为 "add" 的 rust 命令，只把两个数相加
    if(cmd === "add") {
      return (args.a as number) + (args.b as number);
    }
  });

  // 我们可以使用 vitest 提供的监视工具来跟踪被模拟的函数
  const spy = vi.spyOn(window.__TAURI_INTERNALS__, "invoke");

  expect(invoke("add", { a: 12, b: 15 })).resolves.toBe(27);
  expect(spy).toHaveBeenCalled();
});

要模拟对 sidecar 或 shell 命令的 IPC 请求，你需要在调用 spawn() 或 execute() 时取得事件处理器的 ID，并用这个 ID 发出后端会回传的事件：

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21

mockIPC(async (cmd, args) => {
  if (args.message.cmd === 'execute') {
    const eventCallbackId = `_${args.message.onEventFn}`;
    const eventEmitter = window[eventCallbackId];

    // 'Stdout' 事件可以被多次调用
    eventEmitter({
      event: 'Stdout',
      payload: 'some data sent from the process',
    });

    // 'Terminated' 事件必须在最后调用，以兑现 promise
    eventEmitter({
      event: 'Terminated',
      payload: {
        code: 0,
        signal: 'kill',
      },
    });
  }
});

模拟事件

需要 2.7.0 或更高版本。

通过 shouldMockEvents 选项，可以部分支持用事件系统模拟 Rust 代码发出的事件：

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16

import { mockIPC, clearMocks } from '@tauri-apps/api/mocks';
import { emit, listen } from '@tauri-apps/api/event';
import { afterEach, expect, test, vi } from 'vitest';

test('mocked event', () => {
  mockIPC(() => {}, { shouldMockEvents: true }); // 启用事件模拟

  const eventHandler = vi.fn();
  listen('test-event', eventHandler);

  emit('test-event', { foo: 'bar' });
  expect(eventHandler).toHaveBeenCalledWith({
    event: 'test-event',
    payload: { foo: 'bar' },
  });
});

emitTo 和 emit_filter 目前不支持。

窗口

有时你有窗口特定的代码（例如启动画面窗口），因此需要模拟不同的窗口。 你可以用 mockWindows() 方法创建假的窗口标签。第一个字符串标识“当前”窗口（也就是你的 JavaScript 认为自己所在的窗口），其它所有字符串都被视为额外窗口。

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25

import { beforeAll, expect, test } from 'vitest';
import { randomFillSync } from 'crypto';

import { mockWindows } from '@tauri-apps/api/mocks';

// jsdom 不带 WebCrypto 实现
beforeAll(() => {
  Object.defineProperty(window, 'crypto', {
    value: {
      // @ts-ignore
      getRandomValues: (buffer) => {
        return randomFillSync(buffer);
      },
    },
  });
});

test('invoke', async () => {
  mockWindows('main', 'second', 'third');

  const { getCurrent, getAll } = await import('@tauri-apps/api/webviewWindow');

  expect(getCurrent()).toHaveProperty('label', 'main');
  expect(getAll().map((w) => w.label)).toEqual(['main', 'second', 'third']);
});
最后修改 September 25, 2026: 更新 (4c0ee2db0)