antithesis-launch
Compare original and translation side by side
🇺🇸
Original
English🇨🇳
Translation
ChineseAntithesis Launch
Antithesis 运行启动
Prerequisites
前置条件
- DO NOT PROCEED if is not installed. See
snoutyfor installation options.https://raw.githubusercontent.com/antithesishq/snouty/refs/heads/main/README.md
- 如果未安装,请勿继续操作。查看
snouty获取安装选项。https://raw.githubusercontent.com/antithesishq/snouty/refs/heads/main/README.md
Goal
目标
Launch an Antithesis run in this order only:
docker compose buildsnouty validate- if validation fails, stop and report the error
snouty run
仅按以下顺序启动Antithesis运行:
docker compose buildsnouty validate- 如果验证失败,停止操作并报告错误
snouty run
Required Input
必填输入
- in minutes is required. If the user did not provide it, ask before submitting the run.
duration
- 必须提供以分钟为单位的(运行时长)。如果用户未提供,在提交运行前询问用户。
duration
Discovery
探索步骤
- Start from any user-provided path, command, or Antithesis directory name.
- Otherwise, inspect the repo to understand how the harness is wired. Check nearby ,
AGENTS.md,README*, and Antithesis-specific scripts before choosing commands.Makefile* - Find the config directory by locating the intended for Antithesis. Prefer directories like
docker-compose.yaml, but support non-standard layouts.antithesis/config - Treat these as strong Antithesis signals: nearby or
scratchbook/directories, compose content mentioningtest/,/opt/antithesisenv vars,ANTITHESIS_, or existingsetup_completeexamples.snouty - If multiple compose files look plausible, prefer the one referenced by repo docs or existing examples. If the choice is still ambiguous, ask the user instead of guessing.
snouty run - Use the directory containing as the
docker-compose.yamlandsnouty validate <CONFIG>argument.snouty run --config <CONFIG> - Build against that exact file with . If
docker compose -f <CONFIG>/docker-compose.yaml buildis unavailable, fall back todocker compose.docker-compose -f ... build
- 从用户提供的路径、命令或Antithesis目录名称开始。
- 若用户未提供上述信息,则检查代码仓库以了解测试harness的架构。在选择命令前,先查看附近的、
AGENTS.md、README*以及Antithesis专用脚本。Makefile* - 通过定位用于Antithesis的文件找到配置目录。优先选择
docker-compose.yaml这类目录,但也支持非标准布局。antithesis/config - 将以下内容视为明确的Antithesis标识:附近的或
scratchbook/目录、compose文件中提及test/、/opt/antithesis环境变量、ANTITHESIS_,或已有的setup_complete示例。snouty - 如果有多个compose文件看起来都合理,优先选择仓库文档或现有示例中引用的文件。如果仍无法确定,询问用户而非猜测。
snouty run - 将包含的目录作为
docker-compose.yaml和snouty validate <CONFIG>的参数。snouty run --config <CONFIG> - 使用命令针对该文件构建镜像。如果
docker compose -f <CONFIG>/docker-compose.yaml build不可用,回退到docker compose命令。docker-compose -f ... build
Run Arguments
运行参数
- Determine the webhook in this order: explicit user input, existing repo docs/scripts/examples, otherwise default to .
basic_test - requires
snouty run --config. Reuse the current environment if it is already set. If not, stop and ask the user for it.ANTITHESIS_REPOSITORY - Always set all of these explicitly:
- : the user-provided duration
--duration - : repo name
--source - : repo name plus branch or config name
--test-name - : short, readable description of the run, including details such as the branch name, currently goal, or what you changed since the last run.
--description
- 按以下顺序确定webhook:用户明确输入、仓库现有文档/脚本/示例、否则默认使用。
basic_test - 需要
snouty run --config参数。如果当前环境已设置该参数,则复用;否则停止操作并询问用户获取该参数。ANTITHESIS_REPOSITORY - 始终显式设置以下所有参数:
- :用户提供的运行时长
--duration - :仓库名称
--source - :仓库名称加上分支或配置名称
--test-name - :简短易懂的运行描述,包含分支名称、当前目标或自上次运行以来的更改等细节。
--description
Execution
执行步骤
- These commands can take a long time. Prefer background execution or generous timeouts instead of assuming quick completion.
- Do not run unless the build succeeded and
snouty runexited successfully.snouty validate
sh
docker compose -f "$CONFIG_DIR/docker-compose.yaml" build
snouty validate "$CONFIG_DIR"
snouty run \
--webhook "$WEBHOOK" \
--config "$CONFIG_DIR" \
--duration "$DURATION" \
--source "$SOURCE" \
--test-name "$TEST_NAME" \
--description "$DESCRIPTION"- 这些命令可能需要较长时间运行。优先选择后台执行或设置充足的超时时间,而非假设会快速完成。
- 仅在构建成功且命令执行成功后,才运行
snouty validate命令。snouty run
sh
docker compose -f "$CONFIG_DIR/docker-compose.yaml" build
snouty validate "$CONFIG_DIR"
snouty run \
--webhook "$WEBHOOK" \
--config "$CONFIG_DIR" \
--duration "$DURATION" \
--source "$SOURCE" \
--test-name "$TEST_NAME" \
--description "$DESCRIPTION"Output
输出要求
- Report the config directory, compose build command, validate command, and final command shape before submission.
snouty run - If validation fails, stop immediately and show the failing command plus the key error.
- 在提交前,报告配置目录、compose构建命令、验证命令以及最终命令的格式。
snouty run - 如果验证失败,立即停止操作并显示失败的命令以及关键错误信息。
Self-Review
自我检查
- The chosen config directory is the one that actually contains the Antithesis .
docker-compose.yaml - The build, validate, and run steps all point at the same config.
- succeeded before
snouty validatewas invoked.snouty run - The run set ,
source,test-name, anddescriptionexplicitly.duration - Missing blockers such as ,
duration, or an ambiguous config location caused a stop instead of a bad submission.ANTITHESIS_REPOSITORY
- 所选的配置目录确实包含Antithesis的文件。
docker-compose.yaml - 构建、验证和运行步骤都指向同一个配置。
- 在调用之前,
snouty run已执行成功。snouty validate - 运行命令已显式设置、
source、test-name和description参数。duration - 若存在缺失的必要项(如、
duration)或配置位置不明确的情况,已停止操作而非提交错误的运行请求。ANTITHESIS_REPOSITORY