|
| 1 | +# 测试调试指南 |
| 2 | + |
| 3 | +本文档介绍如何在 `iotdb-sql-parser` 项目中调试测试。 |
| 4 | + |
| 5 | +## 调试方式 |
| 6 | + |
| 7 | +### 1. 使用 VS Code 调试(推荐) |
| 8 | + |
| 9 | +#### 前置条件 |
| 10 | +确保您使用的是 VS Code 编辑器,并且已经安装了项目依赖: |
| 11 | +```bash |
| 12 | +pnpm install |
| 13 | +``` |
| 14 | + |
| 15 | +#### 调试配置 |
| 16 | +项目已经预配置了多种调试选项,可以在 VS Code 的调试面板中选择: |
| 17 | + |
| 18 | +1. **Debug Jest Tests**: 调试所有测试 |
| 19 | +2. **Debug Current Jest Test**: 调试当前文件中的特定测试 |
| 20 | +3. **Debug Jest Test File**: 调试当前打开的测试文件 |
| 21 | +4. **Debug IoTDB Tree Listener Test**: 专门调试 IoTDB Tree Listener 测试 |
| 22 | +5. **Debug with pnpm (Alternative)**: 使用 pnpm 的备选调试方式 |
| 23 | + |
| 24 | +#### 使用步骤 |
| 25 | +1. 在测试文件中设置断点 |
| 26 | +2. 按 `F5` 或在调试面板中选择调试配置 |
| 27 | +3. 选择对应的调试选项 |
| 28 | +4. 调试器会在断点处停止,您可以检查变量、调用堆栈等 |
| 29 | + |
| 30 | +#### 常见问题修复 |
| 31 | +如果遇到类似这样的错误: |
| 32 | +``` |
| 33 | +SyntaxError: missing ) after argument list |
| 34 | +``` |
| 35 | +这是因为 VS Code 试图直接执行 shell 脚本。我们已经修复了调试配置,现在使用 `jest.js` 而不是 shell 脚本。 |
| 36 | + |
| 37 | +### 2. 命令行调试 |
| 38 | + |
| 39 | +#### 调试所有测试 |
| 40 | +```bash |
| 41 | +pnpm test:debug |
| 42 | +``` |
| 43 | + |
| 44 | +#### 调试特定测试文件 |
| 45 | +```bash |
| 46 | +pnpm test:debug -- test/parser/iotdb-tree/listener.test.ts |
| 47 | +``` |
| 48 | + |
| 49 | +#### 调试特定测试用例 |
| 50 | +```bash |
| 51 | +pnpm test:debug -- --testNamePattern="Listener enterFullPath" |
| 52 | +``` |
| 53 | + |
| 54 | +### 3. 监视模式调试 |
| 55 | + |
| 56 | +在开发过程中,可以使用监视模式来自动重新运行测试: |
| 57 | +```bash |
| 58 | +pnpm test:watch |
| 59 | +``` |
| 60 | + |
| 61 | +### 4. 浏览器调试 |
| 62 | + |
| 63 | +如果您喜欢在浏览器中调试: |
| 64 | + |
| 65 | +1. 运行调试命令: |
| 66 | +```bash |
| 67 | +pnpm test:debug |
| 68 | +``` |
| 69 | + |
| 70 | +2. 打开 Chrome 浏览器,访问 `chrome://inspect` |
| 71 | + |
| 72 | +3. 点击 "Open dedicated DevTools for Node" |
| 73 | + |
| 74 | +4. 设置断点并开始调试 |
| 75 | + |
| 76 | +## 调试技巧 |
| 77 | + |
| 78 | +### 1. 添加调试信息 |
| 79 | +在测试中添加 `console.log` 来输出调试信息: |
| 80 | + |
| 81 | +```typescript |
| 82 | +test('Listener enterFullPath', async () => { |
| 83 | + class MyListener extends IoTDBSqlParserListener { |
| 84 | + result = ''; |
| 85 | + enterFullPath = (ctx): void => { |
| 86 | + console.log('Context text:', ctx.getText()); // 调试输出 |
| 87 | + this.result = ctx.getText(); |
| 88 | + }; |
| 89 | + } |
| 90 | + const listener = new MyListener(); |
| 91 | + |
| 92 | + iotdbTree.listen(listener, parseTree); |
| 93 | + console.log('Final result:', listener.result); // 调试输出 |
| 94 | + expect(listener.result).toBe(expectPath); |
| 95 | +}); |
| 96 | +``` |
| 97 | + |
| 98 | +### 2. 使用 Jest 调试工具 |
| 99 | +```typescript |
| 100 | +// 在测试中使用 Jest 的调试功能 |
| 101 | +test('Debug example', () => { |
| 102 | + const result = someFunction(); |
| 103 | + |
| 104 | + // 打印结果用于调试 |
| 105 | + console.log('Result:', JSON.stringify(result, null, 2)); |
| 106 | + |
| 107 | + // 或者使用 Jest 的快照功能来查看数据结构 |
| 108 | + expect(result).toMatchSnapshot(); |
| 109 | +}); |
| 110 | +``` |
| 111 | + |
| 112 | +### 3. 断点调试 |
| 113 | +在代码中添加 `debugger` 语句: |
| 114 | + |
| 115 | +```typescript |
| 116 | +test('Listener enterFullPath', async () => { |
| 117 | + class MyListener extends IoTDBSqlParserListener { |
| 118 | + result = ''; |
| 119 | + enterFullPath = (ctx): void => { |
| 120 | + debugger; // 调试器会在这里停止 |
| 121 | + this.result = ctx.getText(); |
| 122 | + }; |
| 123 | + } |
| 124 | + // ... |
| 125 | +}); |
| 126 | +``` |
| 127 | + |
| 128 | +### 4. 测试隔离 |
| 129 | +运行单个测试用例来减少干扰: |
| 130 | + |
| 131 | +```bash |
| 132 | +# 只运行包含 "enterFullPath" 的测试 |
| 133 | +pnpm test:single -- --testNamePattern="enterFullPath" |
| 134 | + |
| 135 | +# 只运行特定文件 |
| 136 | +pnpm test:single -- test/parser/iotdb-tree/listener.test.ts |
| 137 | +``` |
| 138 | + |
| 139 | +## 常见问题解决 |
| 140 | + |
| 141 | +### 1. 调试器无法连接 |
| 142 | +- 确保没有其他 Node.js 调试进程在运行 |
| 143 | +- 检查端口 9229 是否被占用 |
| 144 | +- 重启 VS Code |
| 145 | + |
| 146 | +### 2. 断点不生效 |
| 147 | +- 确保 TypeScript 源码映射正确 |
| 148 | +- 检查 `tsconfig.json` 中的 `sourceMap` 选项 |
| 149 | +- 确保断点设置在可执行的代码行上 |
| 150 | + |
| 151 | +### 3. 测试超时 |
| 152 | +在调试模式下,Jest 可能会超时。可以增加超时时间: |
| 153 | + |
| 154 | +```typescript |
| 155 | +test('Long running test', async () => { |
| 156 | + // 增加超时时间到 30 秒 |
| 157 | + jest.setTimeout(30000); |
| 158 | + |
| 159 | + // 您的测试代码 |
| 160 | +}, 30000); |
| 161 | +``` |
| 162 | + |
| 163 | +### 4. 环境变量问题 |
| 164 | +确保调试时使用正确的环境变量: |
| 165 | + |
| 166 | +```json |
| 167 | +{ |
| 168 | + "env": { |
| 169 | + "NODE_OPTIONS": "--max_old_space_size=4096", |
| 170 | + "NODE_ENV": "test" |
| 171 | + } |
| 172 | +} |
| 173 | +``` |
| 174 | + |
| 175 | +## 调试特定组件 |
| 176 | + |
| 177 | +### 调试 Listener |
| 178 | +```typescript |
| 179 | +test('Debug listener behavior', () => { |
| 180 | + class DebugListener extends IoTDBSqlParserListener { |
| 181 | + enterEveryRule = (ctx) => { |
| 182 | + console.log(`Entering: ${ctx.constructor.name}`); |
| 183 | + }; |
| 184 | + |
| 185 | + exitEveryRule = (ctx) => { |
| 186 | + console.log(`Exiting: ${ctx.constructor.name}`); |
| 187 | + }; |
| 188 | + } |
| 189 | + |
| 190 | + const listener = new DebugListener(); |
| 191 | + iotdbTree.listen(listener, parseTree); |
| 192 | +}); |
| 193 | +``` |
| 194 | + |
| 195 | +### 调试 Parser 树 |
| 196 | +```typescript |
| 197 | +test('Debug parse tree', () => { |
| 198 | + const parseTree = iotdbTree.parse(sql); |
| 199 | + |
| 200 | + // 输出解析树结构 |
| 201 | + console.log('Parse tree:', parseTree.toStringTree()); |
| 202 | + |
| 203 | + // 或者使用 visitor 遍历树 |
| 204 | + class DebugVisitor extends IoTDBSqlParserVisitor<void> { |
| 205 | + visitChildren(node) { |
| 206 | + console.log(`Visiting: ${node.constructor.name}, Text: ${node.getText()}`); |
| 207 | + return super.visitChildren(node); |
| 208 | + } |
| 209 | + } |
| 210 | + |
| 211 | + const visitor = new DebugVisitor(); |
| 212 | + visitor.visit(parseTree); |
| 213 | +}); |
| 214 | +``` |
| 215 | + |
| 216 | +## 性能调试 |
| 217 | + |
| 218 | +### 1. 测试执行时间 |
| 219 | +```bash |
| 220 | +# 显示详细的测试执行时间 |
| 221 | +pnpm test -- --verbose |
| 222 | +``` |
| 223 | + |
| 224 | +### 2. 内存使用分析 |
| 225 | +```bash |
| 226 | +# 使用更大的内存限制并监控 |
| 227 | +NODE_OPTIONS="--max_old_space_size=8192 --trace-gc" pnpm test |
| 228 | +``` |
| 229 | + |
| 230 | +希望这个指南能帮助您有效地调试测试! |
0 commit comments