Skip to content

Commit cede2ae

Browse files
authored
Merge pull request #10269 from The-OpenROAD-Project-staging/update-testing-md
doc: Add a new guide for creating issue reproduction test case
2 parents e6afe2a + 5357bca commit cede2ae

1 file changed

Lines changed: 10 additions & 4 deletions

File tree

docs/agents/testing.md

Lines changed: 10 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6,10 +6,10 @@ OpenROAD has two types of tests: **integration tests** (Tcl) and **unit tests**
66

77
**Every new test MUST be registered in BOTH build systems. Missing either one is a build break.**
88

9-
| Build System | Registration File | Block/Macro |
10-
|-------------|-------------------|-------------|
11-
| **CMake** | `src/<module>/test/CMakeLists.txt` | `or_integration_tests(...)` |
12-
| **Bazel** | `src/<module>/test/BUILD` | `regression_test(...)` |
9+
| Build System | Registration File | Block/Macro |
10+
| ------------ | ---------------------------------- | --------------------------- |
11+
| **CMake** | `src/<module>/test/CMakeLists.txt` | `or_integration_tests(...)` |
12+
| **Bazel** | `src/<module>/test/BUILD` | `regression_test(...)` |
1313

1414
Forgetting the Bazel `BUILD` file is the most common mistake -- CMake-only registration
1515
silently passes local `make test` but the **test will be missing from Bazel CI**.
@@ -37,6 +37,12 @@ ctest -R "rsz\.buffer_ports1\.tcl"
3737

3838
Best practice reference: `src/rsz/test/repair_tie12_hier.tcl`
3939

40+
#### Issue Reproduction Tests
41+
42+
For issue reproductions, keep the test case minimal and focused on the failing tool behavior. When floorplanning or placement is not part of the bug, encode the small problem design directly in DEF and use `read_def` after loading the necessary LEF and Liberty files instead of running floorplanning or global placement. This keeps the test simpler and more stable across unrelated OpenROAD behavior changes. Use floorplanning or placement steps when those stages are part of the behavior under test.
43+
44+
#### Checklist
45+
4046
1. **Header comment**: First line must explain the test purpose
4147
```tcl
4248
# [Brief description of the test]

0 commit comments

Comments
 (0)