ARTICLE DETAIL

建站实战干货

来自一线的建站与推广经验沉淀,每一条都经过真实交付验证。

Azure Data Studio 单元测试运行指南:Electron、浏览器与 Node 三套测试环境的完整使用手册

2026/9/29 2:19:13 拓冰建站 浏览量
Azure Data Studio 单元测试运行指南:Electron、浏览器与 Node 三套测试环境的完整使用手册 数据库客户端桌面应用数据分析【免费下载链接】azuredatastudioAzure Data Studio is a data management and development tool with connectivity to popular cloud and on-premises databases. Azure Data Studio supports Windows, macOS, and Linux, with immediate capability to connect to Azure SQL and SQL Server. Browse the extension library for more database support options including MySQL, PostgreSQL, and MongoDB.项目地址https://gitcode.com/gh_mirrors/az/azuredatastudio点击查看免费下载本篇技术指南围绕 Azure Data Studiogh_mirrors/az/azuredatastudio开源仓库中 test/unit/README.md 文档系统讲解该项目单元测试的三种运行方式——Electron 渲染进程内运行、Playwright 驱动的浏览器内运行、以及纯 Node 环境运行并深入覆盖测试筛选、调试、覆盖率统计等实战配置。阅读完本文你将掌握 Azure Data Studio 开发者日常使用的全部测试命令、参数语义与底层执行原理能够独立定位并修复单元测试问题。三种测试环境总览Azure Data Studio 的单元测试基础设施位于仓库的 test/unit 目录其下分为browser、electron、node三个子目录分别对应三种执行环境运行环境入口文件启动方式特点Electron 渲染进程test/unit/electron/index.js./scripts/test.sh/.\scripts\test.bat拥有 DOM 与 Node.js API最接近产品实际运行环境浏览器Playwrighttest/unit/browser/index.jsyarn test-browser --browser webkit --browser chromium覆盖 chromium、webkit 等更多平台纯 Nodetest/unit/node/index.jsyarn run mocha --ui tdd --run 文件轻量快速用于无需 DOM 的 common 层测试三套环境的运行脚本由 package.json 中的test-browser指向node test/unit/browser/index.js与 scripts/test.sh / scripts/test.bat 统一编排。测试框架统一采用 Mochaui: tdd并共享 test/unit/reporter.js 中的 reporter 加载逻辑与 test/unit/coverage.js 中的覆盖率逻辑。在 Electron 内运行单元测试这是官方推荐的默认方式所有单元测试都运行在 Electron 渲染进程环境中可以同时访问 DOM 与 Node.js API与 Azure Data Studio 产品本身同样是 Electron 应用的运行环境最接近。基本命令# Linux / macOS ./scripts/test.sh # Windows .\scripts\test.bat从 scripts/test.sh 源码可以看到脚本会先检查node_modules与 Electron 是否就绪不存在时自动执行yarn与yarn electron然后以test/unit/electron/index.js作为入口启动 Electron 应用执行测试。在 Linux 容器环境如 Docker CI下脚本还会自动附加--no-sandbox --disable-dev-shm-usage --use-glswiftshader等参数规避容器内沙箱权限、/dev/shm分区过小导致的 OOM 等问题——这是 Azure Data Studio 在 Linux 上跑测试的常见前置处理。常用调试与筛选选项README 给出的三个核心建议分别对应 test/unit/electron/index.js 中通过optimist解析的命令行参数--debug打开带开发者工具的 Electron 窗口便于打断点调试。对应源码中的dev参数别名dev-tools/devTools开启后会显示窗口、自动打开 DevTools并复用应用数据目录同时失败测试的堆栈会直接打印到控制台见 test/unit/electron/renderer.js 中runTests对opts.dev的处理。--run file只运行指定文件中的测试对应源码run参数。--glob pattern按文件 glob 模式筛选测试对应源码runGlob参数别名glob/runGrep。典型组合示例# 只运行 extHost 相关测试文件并开启调试 ./scripts/test.sh --debug --glob **/extHost*.test.js更精细的参数矩阵除 README 提及的三个参数外test/unit/electron/index.js 还支持以下参数便于在 CI 与本地调试之间灵活切换参数别名作用--grep pattern-g/-f只运行名称匹配该正则的测试用例--invert-i取--grep匹配的反集Azure Data Studio 特有扩展--build-使用构建产物out-build而非out目录运行--coverage-生成覆盖率报告--reporter name-指定 Mocha reporter默认spec--reporter-options opts-向 reporter 传入选项--timeout ms-覆盖 Mocha 默认超时时间--tfs name-CI 场景下额外生成 JUnit XML 测试结果--crash-reporter-directory dir-指定崩溃转储目录特别值得注意的是 Azure Data Studio 对默认测试范围的定制在 scripts/test.sh 中如果未显式设置ADS_TEST_GREP环境变量脚本会默认设置ADS_TEST_GREPUNSTABLE且ADS_TEST_INVERT_GREP1即默认只运行稳定测试、排除带UNSTABLE标记的用例。同时 test/unit/electron/index.js 中约定仅当用户手动指定--grep时才会忽略这些环境变量——这意味着手动指定 grep 即表示用户有明确筛选意图。Electron 环境的运行细节从源码层面看Electron 测试的完整链路是主进程 test/unit/electron/index.js 创建BrowserWindow加载 test/unit/electron/renderer.html渲染进程中的 test/unit/electron/renderer.js 完成模块加载与 Mocha 运行再通过IPCReporter见 test/unit/electron/renderer.js 中的serializeSuite/serializeRunnable序列化逻辑把结果回传给主进程的IPCRunner汇总输出。几个值得了解的工程细节主进程会先为BrowserWindow注入与 VS Code 一致的 preload 脚本和--vscode-window-config参数保证测试环境与产品沙箱环境一致见 test/unit/electron/index.js 中webPreferences配置渲染进程会拦截fs模块的 19 个常用方法readFileSync、openSync、watch、unlink等实现文件系统访问日志可配合beginLoggingFS/endLoggingFS定位测试中的意外文件操作见 test/unit/electron/renderer.js 顶部自执行函数渲染页面禁止window.open、window.alert、window.confirm——测试运行环境可能没有显示器任何弹出窗口都可能让测试崩溃因此直接抛异常见 test/unit/electron/renderer.html 中注释!!! DO NOT CHANGE !!!的代码块渲染进程若崩溃如render-process-gone事件主进程会立即以退出码 1 结束避免无谓等待见 test/unit/electron/index.js。在浏览器内运行单元测试浏览器运行环境是对 Electron 测试的补充来自common和browser层的单元测试会通过 Playwright 在chromium、webkit、很快也会支持firefox中执行从而覆盖更多受支持平台尤其能提前发现仅在特定浏览器/操作系统组合下才暴露的问题。基本命令# 在 webkit 与 chromium 中运行README 推荐组合 yarn test-browser --browser webkit --browser chromiumyarn test-browser实际执行的是 test/unit/browser/index.js见 package.json 的test-browser脚本。源码中浏览器参数默认值为[chromium, firefox, webkit]可多次指定以选择多个浏览器。注意事项与调试CI 环境下的平台差异这些测试属于持续构建continuous build的一部分因此你可能遇到只在Windows 上的 webkit或Linux 上的 chromium出现的偶发失败。排查时可针对性只跑出问题的浏览器组合。本地运行yarn test-browser --browser chromium --browser webkit即可在本地复现。手工调试入口在浏览器中直接打开test/unit/browser/renderer.html并通过 URL 查询参数?mamd_module指定要加载的 AMD 模块。例如file:///.../test/unit/browser/renderer.html?mvs/base/test/common/strings.test会运行strings.test.ts中的全部测试。该逻辑在 test/unit/browser/renderer.html 中实现页面读取 URL 上的m参数支持多个直接调用loadAndRun(modules, true)手工执行?buildtrue时改用out-build产物?citrue时把 Mocha 超时从 5 秒放宽到 30 秒。子集筛选与 Electron 环境一致同样支持--run与--glob选项。注意浏览器环境无法运行node、electron-sandbox、electron-main层的测试test/unit/browser/index.js 会通过excludeGlob **/{node,electron-sandbox,electron-main}/**/*.test.js自动丢弃这些模块显式指定--run时还会打印DROPPONG ...警告。浏览器运行的实现要点从 test/unit/browser/index.js 源码看其工作流程为先通过 glob 收集out或out-build目录下的**/*.test.js测试模块 → 用 Playwright 以 headless 模式启动所选浏览器 → 打开renderer.html→ 通过page.exposeFunction把mocha_report、__readFileInTests、__writeFileInTests等宿主函数暴露给页面 → 页面内运行 Mocha 并把结果经PlaywrightReporter回传见 test/unit/browser/renderer.html。两个实用参数--debug可关闭 headless 并打开 devtools 便于人工调试--sequential让多个浏览器逐个串行运行而非并行默认是Promise.all并行在资源受限的机器上更稳妥。测试失败后脚本会汇总失败用例清单并生成一条可直接粘贴到浏览器地址栏的调试 URL带?m参数直达失败模块。用 Node 直接运行对于不依赖 DOM 的common层测试可以直接用 Node 运行 Mocha无需启动 Electron速度更快yarn run mocha --ui tdd --run src/vs/editor/test/browser/controller/cursor.test.ts入口为 test/unit/node/index.js。从源码看该入口会做几件事使用_VSCODE_NODE_MODULES、_VSCODE_PRODUCT_JSON、_VSCODE_PACKAGE_JSON等全局变量模拟 VS Code 运行时环境校验当前 Node 大版本与仓库要求一致读取remote/.yarnrc中 target 版本通过 AMD loader配置了baseUrl、sql路径映射以及 Angular 等nodeModules这是 Azure Data Studio 相对上游 VS Code 的 SQL 定制加载测试模块。需要注意的是Node 环境会通过excludeGlobs主动排除浏览器/Electron 沙箱/Electron 主进程层的测试以及依赖原生模块的测试如nativeModules.test.js、依赖 sqlite 原生模块的storage.test.js——这些测试必须回到 Electron 环境运行。覆盖率统计覆盖率命令会在工作区根目录的.build文件夹下生成coverage目录# OS X 与 Linux ./scripts/test.sh --coverage # Windows .\scripts\test.bat --coverage底层实现位于 test/unit/coverage.js通过istanbul-lib-instrument对加载的模块做插桩**/test/**目录下的测试文件本身不插桩收集全局__coverage__数据后用istanbul-lib-source-maps结合 sourcemap 还原源码位置最后在.build/coverage单文件运行则为.build/coverage-single目录下输出报告。非单文件模式会同时生成json、lcov、html、cobertura四种格式方便接入 CI 聚合Azure Data Studio 在 test/unit/coverage.js 中特意添加了json与cobertura输出用于覆盖率合并。README 特别提示了一个本地运行的坑默认情况下 sourcemap 是内联inline的导致本地生成的覆盖率只对应.js文件而非 TypeScript 源码。解决办法是设置环境变量SQL_NO_INLINE_SOURCEMAP1重新执行编译/watch 任务后再带--coverage跑测试SQL_NO_INLINE_SOURCEMAP1 yarn watch # 重新编译产物带外部 sourcemap ./scripts/test.sh --coverage # 重新运行测试另外从源码看覆盖率报告默认会跳过vs/目录下的上游 VS Code 文件见 test/unit/coverage.js 中fixPath后的过滤逻辑因此统计口径聚焦于 Azure Data Studio 自身的 SQL 相关代码。常见问题与排障思路测试结果不一致若只在某个浏览器/平台失败优先用--browser参数收窄到对应组合复现浏览器测试与 Electron 测试环境隔离不能用浏览器运行的结果替代 Electron 验证。测试被跳过Azure Data Studio 默认排除带UNSTABLE标记的用例通过ADS_TEST_GREP/ADS_TEST_INVERT_GREP环境变量控制若想运行全部测试可显式修改这两个环境变量后重新执行。渲染进程崩溃检查是否有测试意外调用了window.open/alert/confirm渲染页面会直接抛异常或查看--crash-reporter-directory指定的崩溃转储目录中的记录。覆盖率只有 .js 没有 .ts按上文设置SQL_NO_INLINE_SOURCEMAP1并重新编译。调试单个文件Electron 环境用./scripts/test.sh --debug --glob pattern浏览器环境用renderer.html?mmodule手工打开Node 环境用yarn run mocha --ui tdd --run file。相关文件索引运行脚本scripts/test.sh、scripts/test.bat、package.jsontest-browser脚本Electron 环境test/unit/electron/index.js、test/unit/electron/renderer.js、test/unit/electron/renderer.html浏览器环境test/unit/browser/index.js、test/unit/browser/renderer.htmlNode 环境test/unit/node/index.js公共设施test/unit/reporter.js、test/unit/coverage.js、test/unit/assert.js、test/unit/fullJsonStreamReporter.js通过本文介绍的三种运行环境与参数组合你可以像 Azure Data Studio 的 CI 一样完整地验证common、browser、electron-sandbox各层代码并在本地快速复现、调试与统计覆盖率。赞分享数据库客户端桌面应用数据分析【免费下载链接】azuredatastudioAzure Data Studio is a data management and development tool with connectivity to popular cloud and on-premises databases. Azure Data Studio supports Windows, macOS, and Linux, with immediate capability to connect to Azure SQL and SQL Server. Browse the extension library for more database support options including MySQL, PostgreSQL, and MongoDB.项目地址https://gitcode.com/gh_mirrors/az/azuredatastudio点击查看免费下载相关推荐Void 编辑器单元测试体系实战指南Electron、浏览器与 Node 三套测试运行器及覆盖率分析Void 编辑器单元测试体系实战指南Electron、浏览器与 Node 三套测试运行器及覆盖率分析 本篇指南以仓库中 test/unit/README.md代码编辑器开发工具AI Agent人工智能browserify测试环境搭建在Node和浏览器中运行测试的完整指南browserify测试环境搭建在Node和浏览器中运行测试的完整指南 想要在Node.js和浏览器中无缝运行JavaScript测试吗browserify文档教程CoffeeScript 浏览器端测试指南在 Node 与浏览器中运行语言测试套件CoffeeScript 浏览器端测试指南在 Node 与浏览器中运行语言测试套件 CoffeeScript 仓库自带一整套覆盖语法、编译输出与运行时行为的测编程语言编译器上一篇实用Python列表操作切片、排序与搜索技巧完全指南下一篇终极PDF翻译解决方案6倍速智能翻译完美保留原版格式创作声明:本文部分内容由AI辅助生成(AIGC),仅供参考