added block explorer image in integration test by farooqazamwasimnl · Pull Request #273 · hyperledger/fabric-x

farooqazamwasimnl · 2026-07-07T17:16:42Z

Type of change

Test update

Description

Adds a non-blocking block explorer smoke check to the E2E integration test.

The explorer (ghcr.io/lf-decentralized-trust-labs/fabric-x-block-explorer:latest)
is an independently released component — it is not co-versioned with fabric-x.
The integration follows these principles:

The image is pulled as :latest from GHCR in build-e2e.sh (best-effort).
If the pull fails the core E2E test is unaffected.
Two new non-blocking steps are added to run-e2e.sh after step_9_verify_results:
- Step 10 — starts postgres + explorer compose services, polls /healthz
- Step 11 — polls GET /blocks/height to confirm at least one block was ingested
Both steps always return 0. step_9_verify_results owns the pass/fail decision.
No changes to .github/workflows/e2e.yml — it delegates fully to the shell scripts.

Files changed:

integration/test/refs.conf — added EXPLORER_IMAGE_NAME + EXPLORER_REPO
integration/test/build-e2e.sh — best-effort image pull, writes explorer_available to GITHUB_OUTPUT
integration/test/docker-compose.yaml — added postgres and explorer services
integration/test/explorerconfig/explorer.yaml — new explorer config (DB + sidecar + REST)
integration/test/run-e2e.sh — added step_10_smoke_explorer, step_11_verify_explorer
integration/test/README.md — updated image table, steps list, directory structure

Related issues

LF-Decentralized-Trust-labs/fabric-x-block-explorer#18

Signed-off-by: farooqazamwasimnl <Farooq.Azm.Wasim-CIC.Netherlands@ibm.com>

cendhu · 2026-07-09T05:38:23Z

+# ──────────────────────────────────────────────────────────────────────────────
+# Pull explorer image (:latest — independently released, non-blocking)
+# If the pull fails the E2E test continues without the explorer smoke check.
+# ──────────────────────────────────────────────────────────────────────────────
+EXPLORER_IMAGE="${EXPLORER_REPO:-}/${EXPLORER_IMAGE_NAME:-}:latest"
+EXPLORER_AVAILABLE="false"
+if [[ -n "${EXPLORER_REPO:-}" && -n "${EXPLORER_IMAGE_NAME:-}" ]]; then
+  echo "Pulling explorer image: ${EXPLORER_IMAGE}..."
+  if docker pull "${EXPLORER_IMAGE}" 2>/dev/null; then
+    EXPLORER_AVAILABLE="true"
+    echo "  ✅ ${EXPLORER_IMAGE}"
+  else
+    echo "  ⚠️  Explorer image unavailable — smoke check will be skipped"
+  fi
+fi
+
+if [ -n "${GITHUB_OUTPUT:-}" ]; then
+  echo "explorer_image=${EXPLORER_IMAGE}" >> "${GITHUB_OUTPUT}"
+  echo "explorer_available=${EXPLORER_AVAILABLE}" >> "${GITHUB_OUTPUT}"
+fi


We support three ways to do this.

refs.conf holds the url and branch/tag to be used for all dependencies.

override the same with a flag while running build script.

provide branch/tag as input via github action to workflow to test the integration on the CI.

Hence, we need to do the same for explorer too. Given that the docker image PR is merged, we can create a tag at the explorer and update this integration test.

@cendhu I have applied the changes , please have a review

Signed-off-by: farooqazamwasimnl <Farooq.Azm.Wasim-CIC.Netherlands@ibm.com>

cendhu · 2026-07-10T08:52:52Z

        required: false
        default: ""
+      explorer-ref:
+        description: "fabric-x-block-explorer image tag. Empty=use refs.conf default"


for consistency with other refs.

Suggested change

description: "fabric-x-block-explorer image tag. Empty=use refs.conf default"

description: "fabric-x-block-explorer ref. Empty=use refs.conf default"

@cendhu
Pin EXPLORER_REF to a real tag in refs.conf (e.g. v0.1.0) once a tag is cut in the explorer repo?
In explorer repo , every tag also get an image with latest tag as well.
What you recommend?

cendhu · 2026-07-10T08:53:30Z

          COMMITTER_IMAGE: ${{ steps.images.outputs.committer_image }}
          LOADGEN_IMAGE: ${{ steps.images.outputs.loadgen_image }}
+          EXPLORER_IMAGE: ${{ steps.images.outputs.explorer_image }}
+          EXPLORER_AVAILABLE: ${{ steps.images.outputs.explorer_available }}


Why do we have Explorer available?

@cendhu it was added to check availability of the image, now that we will be adding repo , so it will be removed

cendhu · 2026-07-10T08:56:50Z

+    echo "  --fabric-x-ref=REF          Tag, branch, or commit for fabric-x tools"
+    echo "  --committer-ref=REF         Tag, branch, or commit for fabric-x-committer"
+    echo "  --orderer-ref=REF           Tag, branch, or commit for fabric-x-orderer"
+    echo "  --explorer-ref=REF          Tag for the explorer image (default: refs.conf)"


Suggested change

echo " --explorer-ref=REF Tag for the explorer image (default: refs.conf)"

echo " --explorer-ref=REF Tag, branch, or commit for fabric-x-explorer"

cendhu · 2026-07-10T08:58:03Z

+    echo "  --explorer-ref=REF          Tag for the explorer image (default: refs.conf)"
+    echo "  --fabric-x-repo=URL         Override default fabric-x GitHub repo URL"
+    echo "  --committer-repo=URL        Override default committer GitHub repo URL"
+    echo "  --orderer-repo=URL          Override default orderer GitHub repo URL"


we also need to introduce a --explorer-repo=URL to override the default one. For example, when we fix some issues, we may use our local fork and branch.

cendhu · 2026-07-10T09:00:16Z

+# If the pull fails the E2E test continues without the explorer smoke check.
+# ──────────────────────────────────────────────────────────────────────────────
+EXPLORER_IMAGE="${EXPLORER_REPO}/${EXPLORER_IMAGE_NAME}:${EXPLORER_REF}"
+EXPLORER_AVAILABLE="false"


It should always be available. Remove this available check.

cendhu · 2026-07-10T09:03:12Z

-11. Prompt user before cleanup (so they can view Grafana dashboards)
+11. Explorer smoke check — start explorer + postgres, wait for /healthz (non-blocking)
+12. Explorer block ingestion check — poll /blocks/height > 0 (non-blocking)
+13. Prompt user before cleanup (so they can view Grafana dashboards)


Suggested change

13. Prompt user before cleanup (so they can view Grafana dashboards)

13. Prompt user before cleanup (so they can view Grafana dashboards and block explorer)

cendhu · 2026-07-10T09:03:35Z

 FABRIC_X_REPO="https://github.com/hyperledger/fabric-x.git"
 ORDERER_REPO="https://github.com/hyperledger/fabric-x-orderer.git"
 COMMITTER_REPO="https://github.com/hyperledger/fabric-x-committer.git"
+EXPLORER_REPO="ghcr.io/lf-decentralized-trust-labs"


We should specify the github URL.

cendhu · 2026-07-10T09:03:52Z

+# EXPLORER_AVAILABLE is set to "true" by build-e2e.sh when the image was
+# successfully pulled. Default to "false" so the smoke check is skipped
+# when run-e2e.sh is invoked standalone without build-e2e.sh.
+EXPLORER_AVAILABLE="${EXPLORER_AVAILABLE:-false}"


rm available

cendhu · 2026-07-10T09:04:07Z

+  if [[ "${EXPLORER_AVAILABLE}" != "true" ]]; then
+    echo "⏭️  Explorer image not available — skipping smoke check"
+    return 0
+  fi


rm available

cendhu · 2026-07-10T09:07:22Z

+
+  local i height
+  for ((i = 1; i <= HEALTH_TIMEOUT; i++)); do
+    height=$(curl -sf http://127.0.0.1:8080/blocks/height 2>/dev/null \


can we count the number of transactions and it should be >= 5000? This ensures the explorer works for certain duration.

@cendhu test node generates 50 blocks. Are you referring to blocks or transactions in any of the blocks?

added block explorer image in integration test

10f5f87

Signed-off-by: farooqazamwasimnl <Farooq.Azm.Wasim-CIC.Netherlands@ibm.com>

cendhu reviewed Jul 9, 2026

View reviewed changes

addressed reviewer's comments

f5b8621

Signed-off-by: farooqazamwasimnl <Farooq.Azm.Wasim-CIC.Netherlands@ibm.com>

farooqazamwasimnl requested a review from cendhu July 9, 2026 08:09

cendhu reviewed Jul 10, 2026

View reviewed changes

	description: "fabric-x-block-explorer image tag. Empty=use refs.conf default"
	description: "fabric-x-block-explorer ref. Empty=use refs.conf default"

	echo " --explorer-ref=REF Tag for the explorer image (default: refs.conf)"
	echo " --explorer-ref=REF Tag, branch, or commit for fabric-x-explorer"

	13. Prompt user before cleanup (so they can view Grafana dashboards)
	13. Prompt user before cleanup (so they can view Grafana dashboards and block explorer)

Uh oh!

Conversation

farooqazamwasimnl commented Jul 7, 2026

Type of change

Description

Related issues

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!

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!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants