# @crabnebula/tauri-driver 中文文档

规范地址：https://npmcn.com/package/%40crabnebula/tauri-driver/

版本：2\.0\.9
npm 元数据更新时间：2026-02-12T12:01:56.468Z
中文译文更新时间：2026-11-10T22:48:28.433Z
软件包许可：MIT

本文由上游 README 翻译，可能存在偏差，请结合原文核对 API、命令与配置。版权与许可归原作者所有。

原始 npm 页面：https://www.npmjs.com/package/%40crabnebula/tauri-driver
原文对照：https://npmcn.com/package/%40crabnebula/tauri-driver/?lang=original

## 关键信息（来自 npm 元数据）

- 包体积（解压后）：22.9 kB，12 个文件
- 模块格式：CommonJS
- TypeScript 类型：包内自带
- Node.js 要求：\>= 10
- 运行依赖：0 个
- 首次发布：2025-06-05T01:08:14.680Z
- 最新版本发布：2026-02-12T12:01:56.338Z
- 近 30 天下载量：42270（2026-10-11 至 2026-11-09，npm 官方下载统计）
- 已发布版本数：10（近 12 个月 1 个）

## 中文简介

Tauri应用软件通过Webdriver进行端到端测试.

## 安装

```sh
npm install @crabnebula/tauri-driver
```

也可以使用：`pnpm add @crabnebula/tauri-driver`、`yarn add @crabnebula/tauri-driver`、`bun add @crabnebula/tauri-driver`

## README

# 克拉尼布拉·陶里驾驶员

Tauri应用软件通过Webdriver进行端到端测试.

@crabnebula/tauri-driver作为Webdriver客户端定义集成测试与目标平台的Webdriver执行之间的桥梁.

目前支持的平台:

-   为Tauri通过CrabNebula网络司机的macOS
-   Linux 通过 Webkit2gtk- driver 或 CrabNebula 网络driver 程序
-   通过嵌入器或CrabNebula Webdriver的窗口

## 先决条件

-   你的Tauri应用程序必须拥有 [tauri-plugin-自定义](https://crates.io/crates/tauri-plugin-automation) 为运行 MacOS 的集成测试而安装的插件
-   Linux: Webkit2gtk- driver 必须安装在您的系统中并在 PATH 中可用
-   Windows: msedgriver.exe 必须安装在您的系统中,并在 PATH 中可用

或者对 Linux 和 Windows 来说,您也可以使用 Tauri- plugin- automation 并配置您的测试来执行测试跑取后端 .

## 安装

安装您最喜欢的软件包管理器 :

```sh
npm install --save-dev @crabnebula/tauri-driver
yarn install -D @crabnebula/tauri-driver
pnpm install -D @crabnebula/tauri-driver
```

此外,你应该安装 [@ crabnebula/ test-runner-后端](https://www.npmjs.com/package/@crabnebula/test-runner-backend) 如果你想在本地进行macOS测试 [@crabnebula/webdriverio-cloud-reporter (英语)](https://www.npmjs.com/package/@crabnebula/webdriverio-cloud-reporter) 上传测试结果到 [蟹状云](https://docs.crabnebula.dev/cloud)。 。 。 .

## 使用量

### 网络司机

让我们定义一个 [WebdriverIO 配置](https://webdriver.io/docs/configurationfile/) 这样它就可以进行你的整合测试.

1.  导入包

```js
import path from"path";
import { spawn, spawnSync } from "child_process";
import { CrabNebulaCloudReporter } from "@crabnebula/webdriverio-cloud-reporter";
import { waitTauriDriverReady } from "@crabnebula/tauri-driver";
import { waitTestRunnerBackendReady } from "@crabnebula/test-runner-backend";
```

2.  设置您的应用程序路径

对于macOS,你可以选择使用 `.app` 而不是仅仅你的应用程序可执行文件.

```js
const applicationPath = process.platform === "darwin"
  ? "path/to/src-tauri/target/debug/bundle/macos/<app-name>.app"
  : process.platform === "win32"
  ? "path/to/src-tauri/target/debug/<app-name>.exe"
  : "path/to/src-tauri/target/debug/<app-name>"
```

注意你必须使用合适的 `target` 相对于您的 WebdriverIO 配置文件的文件夹路径 替换 `<app-name>` 与正确的值.

3.  创建全局变量

```js
// keep track of the `tauri-driver` child process
let tauriDriver;
let killedTauriDriver = false;
// keep track of the `test-runner-backend` child process
let testRunnerBackend;
let killedTestRunnerBackend = false;
```

4.  定义 WebdriverIO 配置

注意此示例假设您正在使用 `pnpm`,如果使用不同的软件包管理器,请调整脚本.

```js
exports.config = {
  host: "127.0.0.1",
  port: 4444,
  specs: ["./test/specs/**/*.js"],
  maxInstances: 1,

  capabilities: [
    {
      maxInstances: 1,
      "tauri:options": {
        application: applicationPath,
      },
    },
  ],
  reporters: [CrabNebulaCloudReporter],
  framework: "mocha",
  mochaOpts: {
    ui: "bdd",
    timeout: 60000,
  },
  connectionRetryCount: 0,

  onPrepare: async () => {
    // ensure the Tauri app is built since we expect this binary to exist for the webdriver sessions
    spawnSync("pnpm", ["tauri", "build", "--debug"], {
      cwd: path.resolve(__dirname, "path/to/src-tauri"), // TODO: use actual path to the Tauri app directory
      stdio: "inherit",
      shell: true,
    });

    // skip this if condition to use the CrabNebula Webdriver on all platforms
    if (process.platform === "darwin") {
      // CN_API_KEY is required to run macOS tests via CrabNebula Webdriver for Tauri
      if (!process.env.CN_API_KEY) {
        console.error(
          "CN_API_KEY is not set, required for CrabNebula Webdriver"
        );
        process.exit(1);
      }

      testRunnerBackend = spawn("pnpm", ["test-runner-backend"], {
        stdio: "inherit",
        shell: true,
      });

      testRunnerBackend.on("error", (error) => {
        console.error("test-runner-backend error:", error);
        process.exit(1);
      });
      testRunnerBackend.on("exit", (code) => {
        if (!killedTestRunnerBackend) {
          console.error("test-runner-backend exited with code:", code);
          process.exit(1);
        }
      });

      await waitTestRunnerBackendReady();

      // instruct tauri-driver to connect to the test-runner-backend
      process.env.REMOTE_WEBDRIVER_URL = `http://127.0.0.1:3000`;
    }
  },

  // ensure we are running `tauri-driver` before the session starts so that we can proxy the webdriver requests
  beforeSession: async () => {
    tauriDriver = spawn("pnpm", ["tauri-driver"], {
      stdio: [null, process.stdout, process.stderr],
      shell: true,
    });
    tauriDriver.on("error", (error) => {
      console.error("tauri-driver error:", error);
      process.exit(1);
    });
    tauriDriver.on("exit", (code) => {
      if (!killedTauriDriver) {
        console.error("tauri-driver exited with code:", code);
        process.exit(1);
      }
    });

    // wait for tauri-driver to initialize its proxy server
    await waitTauriDriverReady();
  },

  // clean up the `tauri-driver` process we spawned at the start of the session
  afterSession: () => {
    closeTauriDriver();
  },

  onComplete: () => {
    killedTestRunnerBackend = true;
    testRunnerBackend?.kill();
  },
};

function closeTauriDriver() {
  killedTauriDriver = true;
  tauriDriver?.kill();
  killedTestRunnerBackend = true;
  testRunnerBackend?.kill();
}

export function onShutdown(fn) {
  const cleanup = () => {
    try {
      fn();
    } finally {
      process.exit();
    }
  };

  process.on("exit", cleanup);
  process.on("SIGINT", cleanup);
  process.on("SIGTERM", cleanup);
  process.on("SIGHUP", cleanup);
  process.on("SIGBREAK", cleanup);
}

onShutdown(closeTauriDriver);
```

## 常见问题

### @crabnebula/tauri-driver 是什么？

Tauri应用软件通过Webdriver进行端到端测试\.

### 如何安装 @crabnebula/tauri-driver？

在项目目录运行 npm install @crabnebula/tauri-driver，或使用 pnpm add / yarn add / bun add。它还提供命令行工具 tauri-driver，可以用 npx tauri-driver 直接运行。

### @crabnebula/tauri-driver 支持 TypeScript 吗？

支持。包内自带 TypeScript 类型声明（package\.json 声明了 types 入口），安装后即可获得类型提示，无需再安装 @types 包。

### @crabnebula/tauri-driver 支持 ESM 还是 CommonJS？

以 CommonJS 形式发布，可以直接 require\(\)；在 ES Module 项目中也可以用 import 引入（Node\.js 会把 module\.exports 作为默认导出）。

### @crabnebula/tauri-driver 需要什么版本的 Node\.js？

package\.json 的 engines 字段要求 Node\.js \>= 10。版本不符时 npm 默认只给出警告，开启 engine-strict 后会拒绝安装。

### @crabnebula/tauri-driver 可以商用吗？

@crabnebula/tauri-driver 使用 MIT 许可。宽松许可：允许商业使用、修改和再分发，通常只需在分发时保留原版权与许可声明。以上为概括，不构成法律意见，请以许可原文为准。

### @crabnebula/tauri-driver 的下载量有多少？

根据 npm 官方下载统计，@crabnebula/tauri-driver 在 2026/10/11 – 2026/11/09 这 30 天内被下载 42,270 次，日均约 1,409 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入，适合横向比较热度，不能直接等同于使用人数。

### @crabnebula/tauri-driver 还在维护吗？

最新版本 2\.0\.9 发布于 2026/02/12（8 个月前）；至今共发布 10 个版本，其中过去 12 个月发布了 1 个；首次发布于 2025/06/05。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。