Skip to content

Commit 9e9bafe

Browse files
wphillipmoorewphillipmoore-claude
andauthored
docs: document local MQ environment scripts for AI agents (#241)
Add Local MQ Container section to CLAUDE.md. Ref: mq-rest-admin-project/mq-rest-admin-common#124 Co-authored-by: wphillipmoore-claude <255925739+wphillipmoore-claude@users.noreply.github.com>
1 parent 315dfc9 commit 9e9bafe

1 file changed

Lines changed: 48 additions & 0 deletions

File tree

CLAUDE.md

Lines changed: 48 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -194,6 +194,54 @@ st-submit-pr --issue 42 --linkage Ref --summary "Update docs" --docs-only
194194
- `--docs-only` (optional): applies docs-only testing exception
195195
- `--dry-run` (optional): print generated PR without executing
196196

197+
### Local MQ Container
198+
199+
The MQ development environment is owned by the
200+
[mq-rest-admin-dev-environment](https://github.com/wphillipmoore/mq-rest-admin-dev-environment)
201+
repository. Clone it as a sibling directory before running lifecycle
202+
scripts:
203+
204+
```bash
205+
# Prerequisite (one-time)
206+
git clone https://github.com/wphillipmoore/mq-rest-admin-dev-environment.git ../mq-rest-admin-dev-environment
207+
208+
# Start the containerized MQ queue managers
209+
./scripts/dev/mq_start.sh
210+
211+
# Seed deterministic test objects (DEV.* prefix)
212+
./scripts/dev/mq_seed.sh
213+
214+
# Verify REST-based MQSC responses
215+
./scripts/dev/mq_verify.sh
216+
217+
# Stop the queue managers
218+
./scripts/dev/mq_stop.sh
219+
220+
# Reset to clean state (removes data volumes)
221+
./scripts/dev/mq_reset.sh
222+
```
223+
224+
The lifecycle scripts are thin wrappers that delegate to
225+
`../mq-rest-admin-dev-environment`. Override the path with `MQ_DEV_ENV_PATH`.
226+
227+
Integration tests are gated by the `MQ_REST_ADMIN_RUN_INTEGRATION`
228+
environment variable. When unset, integration tests are skipped. For local
229+
runs:
230+
231+
```bash
232+
./scripts/dev/mq_start.sh
233+
./scripts/dev/mq_seed.sh
234+
export MQ_REST_ADMIN_RUN_INTEGRATION=true
235+
./mvnw verify # Unit + integration tests
236+
```
237+
238+
Container details:
239+
- Queue managers: `QM1` and `QM2`
240+
- QM1 ports: `1424` (MQ listener), `9453` (REST API)
241+
- QM2 ports: `1425` (MQ listener), `9454` (REST API)
242+
- Admin credentials: `mqadmin` / `mqadmin`
243+
- Object prefix: `DEV.*`
244+
197245
## Architecture
198246

199247
Direct port of pymqrest's architecture, adapted to Java idioms.

0 commit comments

Comments
 (0)