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

Unify the copy-to-container methods and add reading a file from a container

未关闭
#1,547 0 条评论 0 个 reaction 已指派 0 人 在 GitHub 查看

维护者通常 1 天内回复

还没有人认领这个 Issue。

评估

难度
5/5
预计耗时
一周以上
新手友好度
42/100
Issue 类型
功能
描述清晰度
基本清楚
活跃度
活跃
技术栈
docker, node.js, typescript
领域
api, backend

调研方向

Start with the four listed files and trace how copy methods, options, and StartedTestContainer are implemented and forwarded. Review #1522 and coordinate with #1518 before changing the shared copy API. Done means unified before and after start copy methods with matching options and behavior, a way to read one file, and deprecated aliases for existing methods.

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

描述

enhancement minor

What happens

Copying into a container is spread over nine methods with slightly different shapes.

Before start:

  • withCopyFilesToContainer(files[])
  • withCopyDirectoriesToContainer(directories[])
  • withCopyContentToContainer(contents[])
  • withCopyArchivesToContainer(archives[])
  • withCopyToContainerOptions(options)

After start:

  • copyFilesToContainer(files[])
  • copyDirectoriesToContainer(directories[])
  • copyContentToContainer(contents[])
  • copyArchiveToContainer(tar, target?, options?)

The two sides do not behave the same (from reading the code):

  • DirectoryToCopy.mode is applied before start and ignored after start.
  • CopyToContainerOptions applies to every copy before start, but after start only copyArchiveToContainer accepts it.
  • The archive method is plural with an array before start, singular with positional arguments after.

Copying out is limited to copyArchiveFromContainer(path), which resolves to a tar stream. Reading one file's content means bringing a tar parser.

Expected

  • One withCopyToContainer and one copyToContainer that accept a list of entries, each a host path, inline content or an archive, with target and mode. The same options and behaviour on both sides.
  • A way to read a single file from a container, for example readFile(path): Promise<Buffer> or copyFileFromContainer(path, destination).
  • The existing methods stay as deprecated aliases.

Where

  • packages/testcontainers/src/test-container.ts
  • packages/testcontainers/src/generic-container/generic-container.ts
  • packages/testcontainers/src/generic-container/started-generic-container.ts
  • packages/testcontainers/src/types.ts

Notes

  • Java has withCopyToContainer(Transferable, containerPath) and withCopyFileToContainer(MountableFile, containerPath), plus copyFileFromContainer(containerPath, destinationPath) and a variant that passes the file's InputStream to a function. Go has Files []ContainerFile on the request and CopyFileFromContainer, which returns the file's content.
  • Related: #1526. The mode field should say it is an octal permission.

Dependencies

  • Stack on #1522: the reuse hash has to cover copied files. Changing how copies are stored first would move that target.
  • Coordinate with #1518: for the old method names.
  • Changes StartedTestContainer, which today means the interface, StartedGenericContainer and the forwarder on AbstractStartedContainer. Several other issues do the same. The edits do not overlap, so they can go in parallel.
主要语言
TypeScript
星标
2.6k
派生
274
平均合并
1 天 14 小时
30 天内合并 PR
44

环境准备

在 Codespaces 中打开

在浏览器里用你自己的 GitHub 账号启动这个项目的开发容器。

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

从这里开始

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

testcontainers/testcontainers-node 的其他 Issue

查看 testcontainers/testcontainers-node 的全部 Issue

相似的 Issue

更多 TypeScript Issue

把新 issue 发到你的邮箱

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