gsadmin/rustfs
1
0
Fork 0
mirror of https://github.com/rustfs/rustfs.git synced 2026-08-31 17:28:12 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs(e2e): contributor guide for the e2e_test crate (backlog#1153 infra-10) (#4705)

Browse Source 
docs(e2e): write contributor guide for e2e_test crate (backlog#1153 infra-10)

Turn the e2e_test README skeleton into a dense, link-heavy contributor guide:
crate overview + grouped module map, how to run (whole crate / one module /
e2e-smoke profile / ILM serial lane / protocols suite), #[ignore] semantics as
a pointer to live sources, how to add a test (RustFSTestEnvironment +
RustFSTestClusterEnvironment, common.rs/chaos.rs helper inventory, isolation
rules, #[serial]-vs-nextest reality), a CI subset map table, and a
troubleshooting section (stale binary / RUSTFS_TEST_PORT / orphan processes).

Keeps the ci-4 "CI smoke subset" section intact and restructures around it.
Adds a reciprocal link from crates/e2e_test/AGENTS.md.

Refs rustfs/backlog#1153 (infra-10), #1155.
This commit is contained in:
Zhengchao An
2026-07-11 09:27:30 +08:00
committed by GitHub
parent 3f25426534
commit c41a813a31
2 changed files with 232 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files
crates/e2e_test/AGENTS.md
+5
View File
@@ -2,6 +2,11 @@
Applies to `crates/e2e_test/`.
Contributor guide (how to run suites, add a test, the harness/fixture
inventory, `#[ignore]` classes, and the CI map) lives in
[`README.md`](README.md). This file holds the crate rules that agents must
follow.
## Test Reliability
- Keep end-to-end tests deterministic and environment-aware.