Skip to content

Commit 2a7c2d7

Browse files
Add AGENTS.md file for test server
1 parent 037b0b8 commit 2a7c2d7

1 file changed

Lines changed: 28 additions & 0 deletions

File tree

temporal-test-server/AGENTS.md

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
# temporal-test-server Contributor Guide
2+
3+
This module contains an in-memory implementation of the Temporal service that is used for testing. It is typically consumed indirectly via `TestWorkflowEnvironment` from the **temporal-testing** module. The module can also be compiled into a standalone executable for use by tests written in other languages.
4+
5+
## Directory layout
6+
- `src/main/java` – Java implementation of the test service. The main entry point is `io.temporal.testserver.TestServer`.
7+
- `src/main/proto` – Protobuf definitions for the service plus a `Makefile` and `buf.yaml` for linting and code generation. Generated sources live under `build/generated`.
8+
- `src/main/resources/META-INF/native-image` – Configuration used when building a GraalVM native image.
9+
- `src/test/java` – Unit and functional tests using `SDKTestWorkflowRule`.
10+
- `src/test/resources` – Test utilities such as logging configuration.
11+
12+
## Typical tasks
13+
Run these commands from the repository root.
14+
15+
### Format and build
16+
```bash
17+
./gradlew --offline spotlessApply
18+
./gradlew :temporal-test-server:test
19+
./gradlew :temporal-test-server:build
20+
```
21+
22+
23+
## Notes for contributors
24+
- Do not depend on this module directly from applications. Instead depend on `temporal-testing`.
25+
- The code under `internal` packages is not part of the public API and may be changed freely.
26+
- Java 8 compatibility is required.
27+
- Follow repository wide guidelines in the root `AGENTS.md` for commit style and verification (`spotlessCheck`, running tests, etc.).
28+
- Testing should be done with the workflow service stub in general not the WorkflowClient

0 commit comments

Comments
 (0)