Added a github workflow for running examples as integration tests (#138)

* added Docker flow to justfile

* Added a github workflow for running examples as integration tests (#140)

* added CI for docker workflow

* simplified workflow, reused just commands

* doubled timeout

* use ubuntu-latest directly for Docker suppor

* added docker check

* simplify docker verification

* trigger workflow on ci_cd branch pushes

* add protobuf-compiler dependency

* add libclang dependency

* add wasm32 target for runtime compilation

* add rust-src component for wasm compilation

* use host networking for IPFS Docker on Linux/CI

* fix Docker networking and add zombienet debugging

* fix: use absolute paths for zombienet and bulletin binary

* renamed

* removed docker verification step - not needed anymore

* Update .github/workflows/integration-test.yml

Co-authored-by: Branislav Kontur <[email protected]>

* Update .github/workflows/integration-test.yml

Co-authored-by: Branislav Kontur <[email protected]>

* added another test as step

* updated on push branches

* removed branhces from on pull_request

* added ci_cd back, modified network_args (added ports)

* removed flag in wget

* added docker setup

* added missing dependency

* commented out first test - debugging second

* fixed commit

* reverted import, increased node version to 22

* uncommented first test

* reverted branches

* Update .github/workflows/integration-test.yml

Co-authored-by: Branislav Kontur <[email protected]>

* removed local set-up

* Update examples/justfile

* parametrized run-authorize-and-store

* removed duplicate

* Update examples/justfile

Co-authored-by: Branislav Kontur <[email protected]>

* Removed older TODO

* Extract node version

* Actually use CI_IMAGE and align with check.yml

---------

Co-authored-by: Branislav Kontur <[email protected]>

---------

Co-authored-by: Branislav Kontur <[email protected]>

Author: x3c41a

.github/workflows/check.yml

@@ -34,7 +34,7 @@ jobs:
         run: echo "CI_IMAGE=${{ env.CI_IMAGE }}" >> $GITHUB_OUTPUT
 
   check-fmt:
-    runs-on: ubuntu-latest
+    runs-on: parity-default
     timeout-minutes: 20
     needs: [set-image]
     container:
@@ -57,7 +57,6 @@ jobs:
 
   check:
     name: Cargo check
-    # TODO: replace `parity-default` with `ubuntu-latest` when the repo becomes public.
     runs-on: parity-default
     needs: [set-image, check-fmt]
     container:
@@ -77,7 +76,6 @@ jobs:
 
   check-benchmarking:
     name: Cargo check (benchmarking)
-    # TODO: replace `parity-default` with `ubuntu-latest` when the repo becomes public.
     runs-on: parity-default
     needs: [set-image, check]
     container:
@@ -98,7 +96,6 @@ jobs:
 
   clippy:
     name: Cargo clippy
-    # TODO: replace `parity-default` with `ubuntu-latest` when the repo becomes public.
     runs-on: parity-default
     needs: [set-image, check]
     container:
@@ -123,7 +120,6 @@ jobs:
 
   test:
     name: Test
-    # TODO: replace `parity-default` with `ubuntu-latest` when the repo becomes public.
     runs-on: parity-default
     timeout-minutes: 60
     needs: [set-image, check]

.github/workflows/integration-test.yml

@@ -0,0 +1,80 @@
+name: Integration Tests
+
+# Controls when the action will run.
+on:
+  # Triggers the workflow on push or pull request events but only for the master branch
+  push:
+    branches: [main]
+  pull_request:
+    branches: [main]
+
+  # Allows you to run this workflow manually from the Actions tab
+  workflow_dispatch:
+
+# Cancel previous runs
+concurrency:
+  group: ${{ github.workflow }}-${{ github.event.pull_request.number || github.ref }}
+  cancel-in-progress: true
+
+# Parity CI image to use
+# Common variable is defined in the workflow
+# Repo env variable doesn't work for PRs from forks
+env:
+  CI_IMAGE: "paritytech/ci-unified:bullseye-1.88.0-2025-06-27-v202507112050"
+  NODE_VERSION: 22
+
+jobs:
+  set-image:
+    # This workaround sets the container image for each job using 'set-image' job output.
+    # env variables don't work for PRs from forks, so we need to use outputs.
+    runs-on: ubuntu-latest
+    outputs:
+      CI_IMAGE: ${{ steps.set_image.outputs.CI_IMAGE }}
+    steps:
+      - id: set_image
+        run: echo "CI_IMAGE=${{ env.CI_IMAGE }}" >> $GITHUB_OUTPUT
+
+  integration-tests:
+    name: Integration Tests
+    runs-on: parity-default
+    timeout-minutes: 60
+    needs: [ set-image ]
+    container:
+      image: ${{ needs.set-image.outputs.CI_IMAGE }}
+
+    steps:
+      - name: Checkout sources
+        uses: actions/checkout@v4
+
+      - name: Rust cache
+        uses: Swatinem/rust-cache@v2
+        with:
+          cache-on-failure: true
+          cache-all-crates: true
+
+      - name: Setup Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: ${{ env.NODE_VERSION }}
+          cache: 'npm'
+          cache-dependency-path: examples/package.json
+
+      - name: Install just
+        run: cargo install just --locked || true
+
+      - name: Download zombienet
+        run: |
+          curl -L \
+            -H "Authorization: token ${{ github.token }}" \
+            -o zombienet-linux-x64 \
+            "https://github.com/paritytech/zombienet/releases/download/v1.3.138/zombienet-linux-x64"
+          chmod +x zombienet-linux-x64
+          echo "ZOMBIENET_BINARY=$GITHUB_WORKSPACE/zombienet-linux-x64" >> $GITHUB_ENV
+
+      - name: Run authorize and store (PAPI, smoldot)
+        working-directory: examples
+        run: just run-authorize-and-store "smoldot"
+
+      - name: Run authorize and store (PAPI, RPC node)
+        working-directory: examples
+        run: just run-authorize-and-store "ws"

examples/README.md

@@ -75,7 +75,7 @@ tar -xvzf kubo_v0.38.1_darwin-arm64.tar.gz
 
 #### Use Docker
 
-* Use `172.17.0.1` or  `host.docker.internal` for swarm connections
+* Use `host.docker.internal` (macOS/Windows) or `172.17.0.1` (Linux) for swarm connections
 
 ```shell
 docker pull ipfs/kubo:latest
@@ -107,7 +107,11 @@ POLKADOT_BULLETIN_BINARY_PATH=./target/release/polkadot-bulletin-chain \
 ```
 
 ```shell
-# Uses Docker (replace 127.0.0.1 with 172.17.0.1)
+# Uses Docker on macOS/Windows (use dns4/host.docker.internal)
+docker exec -it ipfs-node ipfs swarm connect /dns4/host.docker.internal/tcp/10001/ws/p2p/12D3KooWQCkBm1BYtkHpocxCwMgR8yjitEeHGx8spzcDLGt2gkBm
+docker exec -it ipfs-node ipfs swarm connect /dns4/host.docker.internal/tcp/12347/ws/p2p/12D3KooWRkZhiRhsqmrQ28rt73K7V3aCBpqKrLGSXmZ99PTcTZby
+
+# Uses Docker on Linux (use ip4/172.17.0.1)
 docker exec -it ipfs-node ipfs swarm connect /ip4/172.17.0.1/tcp/10001/ws/p2p/12D3KooWQCkBm1BYtkHpocxCwMgR8yjitEeHGx8spzcDLGt2gkBm
 docker exec -it ipfs-node ipfs swarm connect /ip4/172.17.0.1/tcp/12347/ws/p2p/12D3KooWRkZhiRhsqmrQ28rt73K7V3aCBpqKrLGSXmZ99PTcTZby
 ```