ci: switch integration tests to rippleci/xrpld image (follows xrpl.js #3270) by e-desouza · Pull Request #291 · XRPLF/xrpl-rust

e-desouza · 2026-04-20T19:21:46Z

Summary

The rippled binary was renamed to xrpld upstream, and the rippleci/rippled image stopped receiving updates. Our integration tests across every open PR started failing because the published develop image exited before becoming healthy (Connection refused on localhost:5005, 0 passed / 41 failed).

This PR mirrors the upstream fix in xrpl.js: XRPLF/xrpl.js#3270. Switching to rippleci/xrpld:develop is the actual root-cause fix rather than pinning an old digest of the deprecated image.

Changes

.github/workflows/integration_test.yml:

RIPPLED_DOCKER_IMAGE -> XRPLD_DOCKER_IMAGE: rippleci/xrpld:develop.
docker run simplified to ${IMAGE} --standalone (the xrpld image handles mkdir + launch internally; no more bash -c "mkdir -p /var/lib/rippled/db/ && rippled -a" wrapper).
Volume mount changed from /etc/opt/ripple/ to /etc/opt/xrpld/.
Container name: rippled-service -> xrpld-service.
Removed the docker --health-cmd (which shelled out to the renamed rippled CLI and always failed) in favour of a direct JSON-RPC poll against http://localhost:5005/.
Always dump container logs on the stop step for post-mortem visibility.

.ci-config/rippled.cfg -> .ci-config/xrpld.cfg:

path=/var/lib/rippled/db/nudb -> path=/var/lib/xrpld/db/nudb.
[database_path] /var/lib/rippled/db -> /var/lib/xrpld/db.
[debug_logfile] /var/log/rippled/debug.log -> /var/log/xrpld/debug.log.

Verification

Validated on throwaway PR #292 (now closed): Integration Test green in 2m53s on this exact workflow. Unit tests, Build & Lint, Quality Check also pass.

Related follow-up

The 7 in-flight PRs (#130, #131, #151, #153, #156, #157, #158) currently carry a stopgap commit pinning rippleci/rippled:develop to a specific digest. After this PR merges to main, those branches should:

Rebase on main to pick up the xrpld switch, or
Cherry-pick this commit and drop the stopgap digest pin.

Test plan

Validated end-to-end on PR [TEST - DO NOT MERGE] ci: switch to xrpld image #292
Build & Lint, Unit Test, Integration Test, Quality Check all pass
Merge and confirm subsequent PRs inherit the fix without manual cherry-pick

Credit

Approach lifted from @ckeshava's xrpl.js#3270.

The rippled binary was renamed to xrpld upstream, and the rippleci/rippled image stopped receiving updates; integration tests across all open PRs failed because the container exited before becoming healthy. Mirrors xrpl.js PR #3270 (XRPLF/xrpl.js#3270): - Use rippleci/xrpld:develop with the --standalone entrypoint (no more bash -c "mkdir ... && rippled -a" wrapper; the xrpld image handles this internally). - Rename .ci-config/rippled.cfg to xrpld.cfg and update paths under /var/lib and /var/log from rippled/ to xrpld/. - Mount the config to /etc/opt/xrpld/ rather than /etc/opt/ripple/. - Replace the docker --health-cmd healthcheck (which shelled out to the renamed rippled CLI) with a direct JSON-RPC poll against localhost:5005, and always dump container logs on failure. Validated on PR #292 (closed after success): Integration Test green in 2m53s.

kuan121 · 2026-04-20T20:18:02Z

@@ -43,7 +43,7 @@ small



Can you update the following files as well? Thanks!

https://github.com/XRPLF/xrpl-rust/blob/main/CONTRIBUTING.md

https://github.com/XRPLF/xrpl-rust/blob/main/docker-compose.yml

Both files were updated in 9196506 (before this review was submitted). CONTRIBUTING.md and docker-compose.yml now use rippleci/xrpld:develop, xrpld_standalone container name, /etc/opt/xrpld/ mount, and --standalone flag.

The rippled binary was renamed to xrpld upstream, and the CI image moved from rippleci/rippled to rippleci/xrpld (see xrpl.js PR #3270). Align the local developer docs and docker-compose service with the same image, mount path (/etc/opt/xrpld/), config filename (xrpld.cfg), and simplified --standalone entrypoint that the CI workflow uses.

ckeshava · 2026-04-20T22:54:02Z

        if: always()
-        run: docker stop rippled-service
+        run: |
+          docker logs xrpld-service || true


If there is an error while fetching the logs, developers should be informed.

Suggested change

docker logs xrpld-service || true

docker logs xrpld-service && docker stop xrpld-service

Why do we need to return a catch-all true value?

Fixed in 0080e17. Now chains docker logs xrpld-service && docker stop xrpld-service so a failure surfaces in the job result instead of being swallowed by || true.

ckeshava · 2026-04-20T22:58:52Z

+            ${{ env.XRPLD_DOCKER_IMAGE }} --standalone

-      - name: Wait for rippled to be healthy
+      - name: Wait for xrpld to accept RPC


Is this job required?

This check is not comprehensive enough: Suppose one of my transactions is slated to fail due to a misconfigured config file bug, then this check does not help me. This job only checks if we can run RPC calls against the docker image.

The docker logs <docker_id> already prints the logs of the rippled server. The logs should help us find the cause of any potential failures.

IMO the job titled Wait for rippled to be healthy can be completely removed. rippled starts pretty fast, I haven't experienced any delays in the other SDK CI pipelines. This will also simplify this Github workflow file.

Good call. Dropped the dedicated wait step in 0080e17 — xrpld starts fast enough that the cargo-test step will fail on its own if RPC isn't ready, and that failure is more informative than a generic timeout.

ckeshava · 2026-04-20T23:04:24Z

- `--entrypoint bash rippleci/rippled:develop` manually overrides the entrypoint (for the latest version of rippled on the `develop` branch).
- `-c 'mkdir -p /var/lib/rippled/db/ && rippled -a'` starts `rippled` in standalone mode, where ledgers only close on demand.
+- `--name xrpld_standalone` is an instance name for clarity.
+- `--volume $PWD/.ci-config/:/etc/opt/xrpld/` mounts `xrpld.cfg` so the node binds on `0.0.0.0` and is reachable from the host. It must be an absolute path, so we use `$PWD` instead of `./`.


Suggested change

- `--volume $PWD/.ci-config/:/etc/opt/xrpld/` mounts `xrpld.cfg` so the node binds on `0.0.0.0` and is reachable from the host. It must be an absolute path, so we use `$PWD` instead of `./`.

- `--volume $PWD/.ci-config/:/etc/opt/xrpld/`: This command bind-mounts the host-directory (left-side path) to the docker container (right-side path). `xrpld.cfg` is located in `$PWD/.ci-config/` directory. This command is intended to be run from the root of the `xrpl-rust` project. The second-half of the directory path specifies the absolute-path inside the docker container. The `xrpld` binary searches for the configuration file inside the path: `/etc/opt/xrpld/`.

nit: The mount-bind path of the docker container implicitly makes it accessible from the localhost. Calling it out does not provide additional information to the reader.

Applied in 0080e17 (adapted wording slightly to keep the $PWD note about absolute paths). Thanks for the clearer phrasing.

ckeshava · 2026-04-20T23:06:00Z

+    command: ["--standalone"]
    healthcheck:
-      test: ["CMD", "rippled", "server_info"]
+      test:


Suggested change

test:

test: ["CMD", "xrpld", "server_info"]

nit: This achieves the same effect with minimal changelog.

Done in 0080e17 — switched to ["CMD", "xrpld", "server_info"]. Simpler and drops the wget assumption on the image.

- Drop the explicit "Wait for xrpld to accept RPC" poll loop. xrpld starts fast and the subsequent cargo-test step fails fast on its own if the RPC port is not serving; the poll only obscured the underlying error with a generic timeout message. - Stop swallowing errors in the cleanup step. Chain docker logs and docker stop with && so a failure surfaces in the job result instead of silently returning success via || true. - Simplify docker-compose healthcheck to rely on the xrpld binary's own server_info subcommand (CMD form, no shell, no wget dep). - Clarify the --volume explanation in CONTRIBUTING to describe the bind-mount semantics without implying localhost reachability.

docker run uses --rm, so by the time the cleanup step executes either the test step has finished and the container has already exited and been removed, or xrpld crashed mid-test and was auto-removed. In both cases docker logs returns exit 1 with "No such container". The previous `docker logs && docker stop` chain would then short-circuit and report the cleanup step as the failing step, masking the real test-step failure in the job summary. Split logs from stop, warn (don't fail) when the container is absent for logs, and tolerate "already stopped" on docker stop. Real cargo test failures continue to surface on the Run integration tests step as before.

e-desouza mentioned this pull request Apr 20, 2026

[TEST - DO NOT MERGE] ci: switch to xrpld image #292

Closed

e-desouza force-pushed the ci/pin-rippled-image branch from 201ccf1 to e84f597 Compare April 20, 2026 19:57

e-desouza changed the title ~~ci: pin rippled Docker image and harden health check wait~~ ci: switch integration tests to rippleci/xrpld image (follows xrpl.js #3270) Apr 20, 2026

kuan121 previously approved these changes Apr 20, 2026

View reviewed changes

kuan121 reviewed Apr 20, 2026

View reviewed changes

e-desouza dismissed kuan121’s stale review via 9196506 April 20, 2026 22:02

kuan121 previously approved these changes Apr 20, 2026

View reviewed changes

e-desouza requested review from Patel-Raj11, ckeshava, pdp2121 and sguntaka1578-ripple April 20, 2026 22:18

e-desouza mentioned this pull request Apr 20, 2026

[TEST - DO NOT MERGE] retest: xrpld CI changes on MPT feature branch #293

Open

ckeshava reviewed Apr 20, 2026

View reviewed changes

e-desouza dismissed kuan121’s stale review via 0080e17 April 21, 2026 01:03

kuan121 approved these changes Apr 21, 2026

View reviewed changes

pdp2121 approved these changes Apr 21, 2026

View reviewed changes

pdp2121 merged commit b154d4e into main Apr 21, 2026
5 checks passed

pdp2121 deleted the ci/pin-rippled-image branch April 21, 2026 16:30

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

ci: switch integration tests to rippleci/xrpld image (follows xrpl.js #3270)#291

ci: switch integration tests to rippleci/xrpld image (follows xrpl.js #3270)#291
pdp2121 merged 4 commits intomainfrom
ci/pin-rippled-image

e-desouza commented Apr 20, 2026 •

edited

Loading

Uh oh!

kuan121 Apr 20, 2026

Uh oh!

e-desouza Apr 21, 2026

Uh oh!

ckeshava Apr 20, 2026

Uh oh!

e-desouza Apr 21, 2026

Uh oh!

ckeshava Apr 20, 2026

Uh oh!

e-desouza Apr 21, 2026

Uh oh!

ckeshava Apr 20, 2026

Uh oh!

e-desouza Apr 21, 2026

Uh oh!

ckeshava Apr 20, 2026

Uh oh!

e-desouza Apr 21, 2026

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

	docker logs xrpld-service \|\| true
	docker logs xrpld-service && docker stop xrpld-service

Conversation

e-desouza commented Apr 20, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary

Changes

Verification

Related follow-up

Test plan

Credit

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

e-desouza commented Apr 20, 2026 •

edited

Loading