feat(ci): integration test

Author: Karrq

.github/workflows/integration.yml

@@ -0,0 +1,100 @@
+name: Project integration tests
+
+on:
+  pull_request:
+    branches:
+      - main
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.head_ref || github.ref }}
+  cancel-in-progress: true
+
+jobs:
+  # Build images and publish as artifacts
+  build:
+    name: Build images
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+
+      - name: Set up Docker Buildx
+        uses: docker/setup-buildx-action@v2
+
+      - name: Set up Rust
+        uses: actions/setup-rust@v1
+
+      - name: Install Just
+        uses: taiki-e/install-action@just
+
+      - name: Build Docker images
+        run: |
+          just build
+        
+      - name: Save Docker images to tarballs
+        run: |
+          mkdir -p artifacts
+          just ci export-images $(realpath ./artifacts)
+
+      - name: Upload images artifacts
+        uses: actions/upload-artifact@v4
+        with:
+          name: based-op-images
+          path: artifacts
+
+  # Use published artifacts and run nodes
+  test:
+    name: Configure nodes & run tests
+    runs-on: ubuntu-latest
+    needs: build
+    env:
+      BASED_ENV: dev
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+
+      - name: Install Just
+        uses: taiki-e/install-action@just
+
+      - name: Set up Foundry (for Ethereum tests)
+        uses: foundry-rs/setup-foundry@v1
+        with:
+          version: latest
+
+      - name: Download images artifacts
+        uses: actions/download-artifact@v4
+        with:
+          name: based-op-images
+          path: ./artifacts
+
+      - name: Load Docker images
+        run: |
+          set -euo pipefail
+          find ./artifacts -f -exec gunzip -c {} | docker load \;
+
+      - name: Prepare configuration
+        run: |
+          set -euo pipefail
+          just ci prepare
+
+      - name: Publish configuration artifact
+        uses: actions/upload-artifact@v4
+        with:
+          name: config
+          path: |
+            .local/ 
+
+      - name: Start Based OP services
+        run: |
+          set -euo pipefail
+          just ci run
+
+      - name: Run tests
+        run: |
+          set -euo pipefail
+          just ci test
+      
+      - run: |
+          just ci stop

based/docker/Justfile

@@ -9,6 +9,10 @@ build image *args:
     docker build -t local_based_{{image}} -f ./{{image}}.Dockerfile ../ {{args}} \
     {{quiet}}
 
+save image dest:
+    echo "Exporting {{image}}..."
+    docker save local_based{{image}} | gzip > {{dest}}/based-{{image}}.tar.gz
+
 build-portal: (build "portal")
 build-registry: (build "registry")
 build-gateway: (build "gateway")
@@ -18,6 +22,9 @@ build-metrics-exporter: (build "metrics-exporter" "--load")
 [parallel]
 all: build-portal build-registry build-gateway build-txproxy build-metrics-exporter
 
+[parallel]
+export-all dest: (save "portal" dest) (save "registry" dest) (save "gateway" dest) (save "txproxy" dest) (save "metrics-exporter" dest)
+
 # Creates the docker network `name` if it doesn't already exist
 create-network name="based_op_net":
     docker network inspect {{name}} > /dev/null 2>&1 || docker network create {{name}}

scripts/ci.just

@@ -2,6 +2,8 @@ root := join(justfile_directory(), "..")
 assets := canonicalize(join(root, ".github", "assets"))
 
 parent := "just -f " + join(root, "Justfile")
+based := "just -f " + join(root, "based", "docker", "Justfile")
+deps := "just -f " + join(root, "deps", "Justfile")
 
 # Prepare chain config from known values 
 prepare:
@@ -25,6 +27,25 @@ prepare:
 
     echo "*** Main Node and Follower Node configured! Use \`run\` to start both"
 
+# Run the configured chain
 @run: (prepare)
     {{parent}} main-node start
     {{parent}} follower-node start-dev
+
+# Run tests on the configured chain
+test: 
+    {{parent}} test tx
+
+# Stop the configured chain
+@stop:
+    {{parent}} main-node stop
+    {{parent}} follower-node stop
+    
+# Save the built images of the used services
+export-images dest:
+    docker save local_based_op_node | gzip > {{dest}}/based-op-node.tar.gz
+    docker save local_based_op_deployer | gzip > {{dest}}/based-op-deployer.tar.gz
+    docker save local_based_op_geth | gzip > {{dest}}/based-op-geth.tar.gz
+    {{based}} export-all {{dest}}
+
+