Skip to content

Commit 5ce629b

Browse files
committed
docs: describe ignored integration tests
1 parent aeb3d2a commit 5ce629b

2 files changed

Lines changed: 36 additions & 0 deletions

File tree

README.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -75,6 +75,24 @@ model: RK3562
7575
Partition metadata saved to: ./out/partition-metadata.txt
7676
```
7777

78+
### Run Ignored Integration Suites
79+
80+
Some integration-style tests exercise the full CLI binary and are marked with
81+
`#[ignore]` to avoid running them on every `cargo test`. You can run these
82+
targeted suites when you have the mocked firmware files available:
83+
84+
```bash
85+
# Advanced scenarios from tests/advanced_tests.rs
86+
cargo test advanced_tests -- --ignored
87+
88+
# CLI level assertions from tests/cli_tests.rs
89+
cargo test cli_tests -- --ignored
90+
```
91+
92+
The helpers in `tests/advanced_tests.rs` and `tests/cli_tests.rs` will generate
93+
temporary RKFW/RKAF mock artifacts under `tests/data/integration`, so no
94+
additional setup is required beyond ensuring the output directory is writable.
95+
7896
### Packing
7997

8098
**Pack RKFW firmware:**

README_CN.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -100,6 +100,24 @@ cargo test
100100
cargo test -- --include-ignored
101101
```
102102

103+
### 运行被忽略的集成测试
104+
105+
部分集成测试会调用完整的命令行可执行文件,因此通过 `#[ignore]`
106+
标记避免在每次 `cargo test` 时运行。若需要验证这些场景,可以在有
107+
模拟固件文件的情况下单独执行:
108+
109+
```bash
110+
# tests/advanced_tests.rs 中的高级场景
111+
cargo test advanced_tests -- --ignored
112+
113+
# tests/cli_tests.rs 中的 CLI 级断言
114+
cargo test cli_tests -- --ignored
115+
```
116+
117+
`tests/advanced_tests.rs``tests/cli_tests.rs` 中的辅助函数会在
118+
`tests/data/integration` 目录下生成临时的 RKFW/RKAF 模拟文件,因此只
119+
需确保输出目录可写,无需额外准备数据。
120+
103121
### 运行特定测试
104122

105123
```bash

0 commit comments

Comments
 (0)