Hacktoberfest 2026：维护者为十月标记出来的 issue，仍然开放、适合新手。 浏览 Hacktoberfest issue

Consolidate test harness helpers and replace global stdout/stderr patching

未关闭
  • 哪里不对？
#737 0 条评论 0 个 reaction 已指派 0 人 在 GitHub 查看

维护者通常 1 天内回复

还没有人认领这个 Issue。

评估

难度
4/5
预计耗时
3-5 天
新手友好度
35/100
Issue 类型
重构
描述清晰度
基本清楚
活跃度
活跃
技术栈
nodejs, typescript
领域
testing

调研方向

Start with the duplicated helpers the issue lists: test/es/helpers/bulk-ingest.test.ts, watch.test.ts, scroll-search.test.ts and msearch.test.ts, plus test/factory.test.ts and test/config/text-output.test.ts. Run rg -n 'process\.(stdout|stderr)\.write = ' test to confirm the baseline. Done means one shared capture and transport helper under test/helpers/ that uses t.mock.method, with the grep returning 0 and npm test passing. The helper signatures differ between files, so decide on a shared signature with the maintainers before migrating.

由索引模型根据 Issue 内容生成。

描述

Problem

Tests patch global streams by hand and copy the same harness helpers between files.

  1. Global stream patching. rg -n 'process\.(stdout|stderr)\.write = ' test finds 82 assignments in 19 files (rg -l ... | wc -l). Examples: test/config/text-output.test.ts, test/config/loader.test.ts, test/docs/chat.test.ts:138-158. If a test skips its restore, runner output is lost and later tests see the stub.
  2. Duplicated helpers (rg -n 'function <name>\b|const <name>\b' test):
    • mockTransport: 4 files (test/es/helpers/{bulk-ingest,scroll-search,watch,msearch}.test.ts)
    • makeDeps: 5 files (the four above plus test/es/handler.test.ts:40)
    • runCommand: 4; captureOutput: 4 in 3 files; captureStdout: 2 (test/factory.test.ts:2059,2364,4188, test/es/search-schema.test.ts:33, test/es/helpers/watch.test.ts:49)
    • makeClient: 4 in 2 files (test/lib/es-client.test.ts, test/lib/kibana-client.test.ts)
    • mkdtemp: 24 files. ELASTIC_CLI_CONFIG_FILE used: 9 files.

The copies have different signatures:

  • bulk-ingest.test.ts:18 mockTransport(responses: Array<{ errors: boolean, items: ... }>) vs watch.test.ts:32 mockTransport(responses: MockResponse[])
  • factory.test.ts:2059 captureOutput(fn: () => Promise<void>) vs watch.test.ts:49 captureOutput() (takes no arguments and returns a sink)

Note: test/docs/chat.test.ts patches process.stderr.write on purpose. The test checks that the chat loop never writes to the real stderr (assert.deepEqual(realWrites, [])). It does not show a bypass in src/docs/*.

Proposal

Add test/helpers/{capture,transport,tmp-config}.ts. capture(t) uses t.mock.method(process.stdout, 'write', ...), which node:test restores automatically. Migrate in small PRs: the four test/es/helpers tests first, then factory.test.ts. Keep the chat.test.ts guard, but switch it to t.mock.method.

Acceptance criteria

  • rg 'process\.(stdout|stderr)\.write = ' test returns 0 matches
  • Only one mockTransport / captureOutput definition exists, in test/helpers/
  • Temporary config setup (mkdtemp + ELASTIC_CLI_CONFIG_FILE) goes through one helper with automatic cleanup
  • npm test passes on all supported Node versions

Related: #733 (DI for _test* seams).

authored by Pi Coding Agent (Claude Opus 5.5)

主要语言
TypeScript
星标
47
派生
27
平均合并
2 天 6 小时
30 天内合并 PR
52

环境准备

  • 没有 Dockerfile 或 Docker Compose 文件
  • 没有 Pull Request 模板
  • 阅读贡献指南

从这里开始

  1. 先读完整个 Issue，再读项目的贡献指南。
  2. 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
  3. Fork 仓库，在一个分支上完成修改。
  4. 提交 Pull Request，并在描述里引用这个 Issue 编号。

elastic/cli 的其他 Issue

查看 elastic/cli 的全部 Issue

相似的 Issue

更多 TypeScript Issue

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。