From 8b29b2feb9b5a76f09d046f79fb712cc1d980c6c Mon Sep 17 00:00:00 2001
From: Mathieu <60658558+enitrat@users.noreply.github.com>
Date: Mon, 30 Sep 2024 13:24:22 +0200
Subject: [PATCH] dev: use native in ci (#992)

* dev: use native in ci

* remove outdated gas reports

* fix fmt

* fix runtime location

* avoid clearing the ssj checkout

* use correct working dir

* update stack size when running rust ef-tests

* update workflows

* simplify workflows by avoiding re-building runtimes

* rework workflow structure
---
 .github/workflows/build.yml        |  32 +++++
 .github/workflows/ci.yml           | 116 ++----------------
 .github/workflows/ef-tests.yml     | 129 ++++++++++++++++++++
 .github/workflows/gas_reports.yml  |  43 -------
 .github/workflows/gas_snapshot.yml |  34 ------
 .github/workflows/test.yml         |  25 ++--
 .github/workflows/tests-unit.yml   |  26 ++++
 .gitignore                         |   2 +
 scripts/setup_cairo_native.sh      | 185 +++++++++++++++++++++++++++++
 9 files changed, 400 insertions(+), 192 deletions(-)
 create mode 100644 .github/workflows/build.yml
 create mode 100644 .github/workflows/ef-tests.yml
 delete mode 100644 .github/workflows/gas_reports.yml
 delete mode 100644 .github/workflows/gas_snapshot.yml
 create mode 100644 .github/workflows/tests-unit.yml
 create mode 100755 scripts/setup_cairo_native.sh

diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml
new file mode 100644
index 000000000..7cca4d20d
--- /dev/null
+++ b/.github/workflows/build.yml
@@ -0,0 +1,32 @@
+name: Reusable Build Workflow
+
+on:
+  workflow_call:
+    inputs:
+      artifact-name:
+        required: true
+        type: string
+
+permissions: read-all
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    env:
+      CI_COMMIT_MESSAGE: CI Formatting Auto Commit
+      CI_COMMIT_AUTHOR: ${{ github.event.repository.name }} CI
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      - name: Set up Scarb
+        uses: software-mansion/setup-scarb@v1
+
+      - name: Build contracts
+        run: scarb build -p contracts
+
+      - name: Upload artifacts
+        uses: actions/upload-artifact@v3
+        with:
+          name: ${{ inputs.artifact-name }}
+          path: target/dev
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
index 92fd8de84..b99ecd358 100644
--- a/.github/workflows/ci.yml
+++ b/.github/workflows/ci.yml
@@ -16,118 +16,24 @@ permissions: read-all
 
 jobs:
   build:
-    runs-on: ubuntu-latest
-    env:
-      CI_COMMIT_MESSAGE: CI Formatting Auto Commit
-      CI_COMMIT_AUTHOR: ${{ github.event.repository.name }} CI
-    steps:
-      - name: Checkout code
-        uses: actions/checkout@v4
-
-      - name: Set up Scarb
-        uses: software-mansion/setup-scarb@v1
-
-      - name: Build contracts
-        run: scarb build -p contracts
-
-      - name: Upload artifacts
-        uses: actions/upload-artifact@v3
-        with:
-          name: kakarot-ssj-build
-          path: target/dev
+    uses: ./.github/workflows/build.yml
+    with:
+      artifact-name: kakarot-ssj-build
 
   tests-unit:
-    # trunk-ignore(actionlint/runner-label)
-    runs-on: ubuntu-latest-16-cores
-    steps:
-      - uses: actions/checkout@v3
-      - uses: foundry-rs/setup-snfoundry@v3
-      - uses: software-mansion/setup-scarb@v1
-      - run: scarb fmt --check
-      - run: scarb build
-      - run: scarb test
+    uses: ./.github/workflows/tests-unit.yml
+    with:
+      run-fmt-check: false
 
   ef-tests:
-    # trunk-ignore(actionlint/runner-label)
-    runs-on: ubuntu-latest-32-cores
-    needs: build
-    steps:
-      - name: Checkout ef-tests
-        uses: actions/checkout@v4
-        with:
-          repository: kkrt-labs/ef-tests
-
-      - name: Checkout local skip file
-        uses: actions/checkout@v4
-        with:
-          sparse-checkout: |
-            blockchain-tests-skip.yml
-          sparse-checkout-cone-mode: false
-          path: skip-file
-
-      - name: Replace the skip files
-        run: mv skip-file/blockchain-tests-skip.yml blockchain-tests-skip.yml
-
-      - name: Rust cache
-        uses: Swatinem/rust-cache@v2
-        with:
-          cache-on-failure: "true"
-
-      - name: Setup
-        run: |
-          mkdir -p build/common
-          make setup setup-kakarot-v0
-
-      - name: Install nextest
-        uses: taiki-e/install-action@nextest
-
-      - name: Download Kakarot-SSJ build artifacts in v1
-        uses: actions/download-artifact@v3
-        with:
-          name: kakarot-ssj-build
-          path: ./build/v1
-
-      - name: Move Cairo1Helpers
-        run:
-          mv build/v1/contracts_Cairo1Helpers.compiled_contract_class.json
-          build/common/cairo1_helpers.json
-
-      - name: Set up Python
-        uses: actions/setup-python@v4
-        with:
-          python-version: 3.10.14
-
-      - name: Run tests
-        run: |
-          set -o pipefail
-          make ef-test-v1 | tee data.txt
-          set +o pipefail
-
-      - name: Retrieve ef-tests execution resources
-        run: python scripts/compute_resources.py
-        env:
-          KAKAROT_VERSION: v1
-
-      - name: Upload resources
-        uses: actions/upload-artifact@v3
-        with:
-          path: resources
-          name: resources
-
-      - name: Generate blockchain-tests-skip.yml file
-        if: github.event_name == 'workflow_dispatch'
-        run: make generate-skip-file
-
-      - name: Upload skip file
-        if: github.event_name == 'workflow_dispatch'
-        uses: actions/upload-artifact@v3
-        with:
-          path: blockchain-tests-skip.yml
-          name: blockchain-tests-skip
+    uses: ./.github/workflows/ef-tests.yml
+    needs: [build]
+    with:
+      artifact-name: kakarot-ssj-build
 
   resources:
     runs-on: ubuntu-latest
-    needs: ef-tests
+    needs: [ef-tests]
     steps:
       - uses: actions/checkout@v4
 
diff --git a/.github/workflows/ef-tests.yml b/.github/workflows/ef-tests.yml
new file mode 100644
index 000000000..5957d20fc
--- /dev/null
+++ b/.github/workflows/ef-tests.yml
@@ -0,0 +1,129 @@
+name: EF-Tests
+
+on:
+  workflow_call:
+    inputs:
+      artifact-name:
+        required: true
+        type: string
+
+permissions: read-all
+
+jobs:
+  ef-tests:
+    # trunk-ignore(actionlint/runner-label)
+    runs-on: ubuntu-latest-16-cores
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      - name: Cache cairo-native setup
+        id: cache-cairo-native
+        uses: actions/cache@v3
+        with:
+          path: |
+            ~/.cargo/bin/
+            ~/.cargo/registry/index/
+            ~/.cargo/registry/cache/
+            ~/.cargo/git/db/
+            target/
+            ./libcairo_native_runtime.a
+          key:
+            ${{ runner.os }}-cairo-native-${{ hashFiles('**/Cargo.lock',
+            'scripts/setup_cairo_native.sh') }}
+
+      - name: Make setup script executable
+        run: chmod +x ./scripts/setup_cairo_native.sh
+
+      - name: Setup Cairo Native
+        run: |
+          if [[ "${{ steps.cache-cairo-native.outputs.cache-hit }}" == 'true' ]]; then
+            sudo ./scripts/setup_cairo_native.sh -s
+          else
+            sudo ./scripts/setup_cairo_native.sh
+          fi
+
+      - name: Set Environment Variables
+        run: |
+          echo "MLIR_SYS_190_PREFIX=/usr/lib/llvm-19/" >> $GITHUB_ENV
+          echo "LLVM_SYS_191_PREFIX=/usr/lib/llvm-19/" >> $GITHUB_ENV
+          echo "TABLEGEN_190_PREFIX=/usr/lib/llvm-19/" >> $GITHUB_ENV
+          echo "CAIRO_NATIVE_RUNTIME_LIBRARY=$(pwd)/libcairo_native_runtime.a" >> $GITHUB_ENV
+
+      - name: Checkout ef-tests
+        uses: actions/checkout@v4
+        with:
+          repository: kkrt-labs/ef-tests
+          ref: feat/cairo-native
+          path: ef-tests # Check out to a subdirectory to avoid cleaning the kakarot-ssj directory
+
+      - name: Checkout local skip file
+        uses: actions/checkout@v4
+        with:
+          sparse-checkout: |
+            blockchain-tests-skip.yml
+          sparse-checkout-cone-mode: false
+          path: skip-file
+
+      - name: Setup ef-tests
+        run: |
+          mv skip-file/blockchain-tests-skip.yml ef-tests/blockchain-tests-skip.yml
+          cd ef-tests
+          mkdir -p build/common
+          make setup setup-kakarot-v0
+
+      - name: Install nextest
+        uses: taiki-e/install-action@nextest
+
+      - name: Download Kakarot-SSJ build artifacts in v1
+        uses: actions/download-artifact@v3
+        with:
+          name: ${{ inputs.artifact-name }}
+          path: ef-tests/build/v1
+
+      - name: Move Cairo1Helpers
+        run: |
+          mv ef-tests/build/v1/contracts_Cairo1Helpers.compiled_contract_class.json \
+          ef-tests/build/common/cairo1_helpers.json
+
+      - name: Set up Python
+        uses: actions/setup-python@v4
+        with:
+          python-version: 3.10.14
+
+      # Add this step to verify the file exists
+      - name: Verify libcairo_native_runtime.a
+        run: |
+          echo $CAIRO_NATIVE_RUNTIME_LIBRARY
+          ls -l $CAIRO_NATIVE_RUNTIME_LIBRARY
+
+      - name: Run tests
+        working-directory: ef-tests
+        run: |
+          set -o pipefail
+          RUST_MIN_STACK=1342177280 make ef-test-v1-native | tee data.txt
+          set +o pipefail
+
+      - name: Retrieve ef-tests execution resources
+        working-directory: ef-tests
+        run: python scripts/compute_resources.py
+        env:
+          KAKAROT_VERSION: v1
+
+      - name: Upload resources
+        uses: actions/upload-artifact@v3
+        with:
+          path: ef-tests/resources
+          name: resources
+
+      - name: Generate blockchain-tests-skip.yml file
+        if: github.event_name == 'workflow_dispatch'
+        working-directory: ef-tests
+        run: make generate-skip-file
+
+      - name: Upload skip file
+        if: github.event_name == 'workflow_dispatch'
+        uses: actions/upload-artifact@v3
+        with:
+          path: ef-tests/blockchain-tests-skip.yml
+          name: blockchain-tests-skip
diff --git a/.github/workflows/gas_reports.yml b/.github/workflows/gas_reports.yml
deleted file mode 100644
index 6200d6329..000000000
--- a/.github/workflows/gas_reports.yml
+++ /dev/null
@@ -1,43 +0,0 @@
-name: Compare Snapshot
-
-on: pull_request
-
-concurrency:
-  group: ${{ github.workflow }}-${{ github.ref }}
-  cancel-in-progress: true
-
-permissions:
-  pull-requests: write
-
-jobs:
-  compare-snapshot:
-    permissions: write-all
-    # trunk-ignore(actionlint/runner-label)
-    runs-on: ubuntu-latest-16-cores
-
-    steps:
-      - name: Checkout code
-        uses: actions/checkout@v3
-
-      - name: Set up Python
-        uses: actions/setup-python@v4
-        with:
-          python-version: 3.9
-
-      - name: Set up Scarb
-        uses: software-mansion/setup-scarb@v1
-
-      - name: Run compare_snapshot script
-        id: run-script
-        env:
-          GITHUB_TOKEN: ${{secrets.GITHUB_TOKEN}}
-        continue-on-error: true
-        run: |
-          result=$(python scripts/compare_snapshot.py 2>&1)
-          status=$(echo "$result" | tail -n 1 | awk -F ':' '{print $1}')
-          echo "$result" >> "$GITHUB_STEP_SUMMARY"
-          echo "status=$status" >> "$GITHUB_OUTPUT"
-
-      - name: Exit step based on status
-        if: steps.run-script.outputs.status == 'ERROR'
-        run: exit 1
diff --git a/.github/workflows/gas_snapshot.yml b/.github/workflows/gas_snapshot.yml
deleted file mode 100644
index 3e8ffa6cf..000000000
--- a/.github/workflows/gas_snapshot.yml
+++ /dev/null
@@ -1,34 +0,0 @@
-name: Generate and Upload Gas Snapshot
-
-permissions: read-all
-
-on:
-  push:
-    branches:
-      - main
-  workflow_dispatch: {}
-
-jobs:
-  build:
-    # trunk-ignore(actionlint/runner-label)
-    runs-on: ubuntu-latest-16-cores
-
-    steps:
-      - name: Checkout code
-        uses: actions/checkout@v3
-
-      - name: Set up Python
-        uses: actions/setup-python@v4
-        with:
-          python-version: 3.x
-      - name: Set up Scarb
-        uses: software-mansion/setup-scarb@v1
-
-      - name: Generate gas snapshot
-        run: python scripts/gen_snapshot.py
-
-      - name: Upload gas snapshot to GitHub Artifacts
-        uses: actions/upload-artifact@v2
-        with:
-          name: gas-snapshot
-          path: gas_snapshot.json
diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml
index 32c1a450a..cc095668a 100644
--- a/.github/workflows/test.yml
+++ b/.github/workflows/test.yml
@@ -9,13 +9,18 @@ concurrency:
   cancel-in-progress: true
 
 jobs:
-  tests:
-    # trunk-ignore(actionlint/runner-label)
-    runs-on: ubuntu-latest-16-cores
-    steps:
-      - uses: actions/checkout@v3
-      - uses: foundry-rs/setup-snfoundry@v3
-      - uses: software-mansion/setup-scarb@v1
-      - run: scarb fmt --check
-      - run: scarb build
-      - run: scarb test
+  build:
+    uses: ./.github/workflows/build.yml
+    with:
+      artifact-name: kakarot-ssj-build
+
+  tests-unit:
+    uses: ./.github/workflows/tests-unit.yml
+    with:
+      run-fmt-check: true
+
+  ef-tests:
+    uses: ./.github/workflows/ef-tests.yml
+    needs: [build]
+    with:
+      artifact-name: kakarot-ssj-build
diff --git a/.github/workflows/tests-unit.yml b/.github/workflows/tests-unit.yml
new file mode 100644
index 000000000..2ff0ef28d
--- /dev/null
+++ b/.github/workflows/tests-unit.yml
@@ -0,0 +1,26 @@
+name: Reusable Unit Tests Workflow
+
+on:
+  workflow_call:
+    inputs:
+      run-fmt-check:
+        type: boolean
+        default: false
+        required: false
+
+permissions: read-all
+
+jobs:
+  unit-tests:
+    runs-on: ubuntu-latest-16-cores # trunk-ignore(actionlint/runner-label)
+    steps:
+      - uses: actions/checkout@v4
+      - uses: foundry-rs/setup-snfoundry@v3
+      - uses: software-mansion/setup-scarb@v1
+
+      - name: Run format check
+        if: inputs.run-fmt-check
+        run: scarb fmt --check
+
+      - name: Run tests
+        run: scarb test
diff --git a/.gitignore b/.gitignore
index 0469dd3ad..bcdcc22c4 100644
--- a/.gitignore
+++ b/.gitignore
@@ -5,3 +5,5 @@ target
 node_modules/
 *.snfoundry_cache
 cache/
+
+scripts/libcairo_native_runtime.a
diff --git a/scripts/setup_cairo_native.sh b/scripts/setup_cairo_native.sh
new file mode 100755
index 000000000..8b74c612c
--- /dev/null
+++ b/scripts/setup_cairo_native.sh
@@ -0,0 +1,185 @@
+#!/bin/bash
+
+install_essential_deps_linux() {
+	apt-get update -y
+	apt-get install -y \
+		curl \
+		jq \
+		ripgrep \
+		wget \
+		ca-certificates \
+		gnupg \
+		git
+}
+
+setup_llvm_deps() {
+	case "$(uname)" in
+	Darwin)
+		brew update
+		brew install llvm@19
+
+		LIBRARY_PATH=/opt/homebrew/lib
+		MLIR_SYS_190_PREFIX="$(brew --prefix llvm@19)"
+		LLVM_SYS_191_PREFIX="${MLIR_SYS_190_PREFIX}"
+		TABLEGEN_190_PREFIX="${MLIR_SYS_190_PREFIX}"
+
+		export LIBRARY_PATH
+		export MLIR_SYS_190_PREFIX
+		export LLVM_SYS_191_PREFIX
+		export TABLEGEN_190_PREFIX
+		;;
+	Linux)
+		export DEBIAN_FRONTEND=noninteractive
+		export TZ=America/New_York
+
+		# shellcheck disable=SC2312
+		CODENAME=$(grep VERSION_CODENAME /etc/os-release | cut -d= -f2)
+		if [[ -z ${CODENAME} ]]; then
+			echo "Error: Unable to determine OS codename"
+			exit 1
+		fi
+
+		# shellcheck disable=SC2312
+		echo "deb http://apt.llvm.org/${CODENAME}/ llvm-toolchain-${CODENAME}-19 main" >/etc/apt/sources.list.d/llvm-19.list
+		echo "deb-src http://apt.llvm.org/${CODENAME}/ llvm-toolchain-${CODENAME}-19 main" >>/etc/apt/sources.list.d/llvm-19.list
+		# shellcheck disable=SC2312
+		if ! wget -O - https://apt.llvm.org/llvm-snapshot.gpg.key | apt-key add -; then
+			echo "Error: Failed to add LLVM GPG key"
+			exit 1
+		fi
+
+		if ! apt-get update && apt-get upgrade -y; then
+			echo "Error: Failed to update and upgrade packages"
+			exit 1
+		fi
+		if ! apt-get install -y llvm-19 llvm-19-dev llvm-19-runtime clang-19 clang-tools-19 lld-19 libpolly-19-dev libmlir-19-dev mlir-19-tools; then
+			echo "Error: Failed to install LLVM packages"
+			exit 1
+		fi
+
+		MLIR_SYS_190_PREFIX=/usr/lib/llvm-19/
+		LLVM_SYS_191_PREFIX=/usr/lib/llvm-19/
+		TABLEGEN_190_PREFIX=/usr/lib/llvm-19/
+
+		export MLIR_SYS_190_PREFIX
+		export LLVM_SYS_191_PREFIX
+		export TABLEGEN_190_PREFIX
+
+		{
+			echo "MLIR_SYS_190_PREFIX=${MLIR_SYS_190_PREFIX}"
+			echo "LLVM_SYS_191_PREFIX=${LLVM_SYS_191_PREFIX}"
+			echo "TABLEGEN_190_PREFIX=${TABLEGEN_190_PREFIX}"
+		} >>"${GITHUB_ENV}"
+		;;
+	*)
+		echo "Error: Unsupported operating system"
+		exit 1
+		;;
+	esac
+
+	# GitHub Actions specific
+	[[ -n ${GITHUB_ACTIONS} ]] && {
+		{
+			echo "MLIR_SYS_190_PREFIX=${MLIR_SYS_190_PREFIX}"
+			echo "LLVM_SYS_191_PREFIX=${LLVM_SYS_191_PREFIX}"
+			echo "TABLEGEN_190_PREFIX=${TABLEGEN_190_PREFIX}"
+		} >>"${GITHUB_ENV}"
+	}
+}
+
+install_rust() {
+	if command -v cargo >/dev/null 2>&1; then
+		echo "Rust is already installed with cargo available in PATH."
+		return 0
+	fi
+
+	echo "cargo not found. Installing Rust..."
+	# shellcheck disable=SC2312
+	if ! curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh -s -- -y --default-toolchain 1.81.0 --no-modify-path; then
+		echo >&2 "Failed to install Rust. Aborting."
+		return 1
+	fi
+
+	# shellcheck disable=SC1091
+	if [[ -f "${HOME}/.cargo/env" ]]; then
+		. "${HOME}/.cargo/env"
+	else
+		echo >&2 "Failed to find Rust environment file. Aborting."
+		return 1
+	fi
+
+	echo "Rust installed successfully."
+}
+
+install_cairo_native_runtime() {
+	install_rust || {
+		echo "Error: Failed to install Rust"
+		exit 1
+	}
+
+	git clone https://github.com/lambdaclass/cairo_native.git
+	pushd ./cairo_native || exit 1
+	make deps
+	make runtime
+	cp libcairo_native_runtime.a ../libcairo_native_runtime.a
+	popd || exit 1
+
+	rm -rf ./cairo_native
+
+	CAIRO_NATIVE_RUNTIME_LIBRARY=$(pwd)/libcairo_native_runtime.a
+	if [[ -z ${CAIRO_NATIVE_RUNTIME_LIBRARY} ]]; then
+		echo "Error: Failed to set CAIRO_NATIVE_RUNTIME_LIBRARY"
+		exit 1
+	fi
+	export CAIRO_NATIVE_RUNTIME_LIBRARY
+
+	echo "CAIRO_NATIVE_RUNTIME_LIBRARY=${CAIRO_NATIVE_RUNTIME_LIBRARY}"
+
+	[[ -n ${GITHUB_ACTIONS} ]] && echo "CAIRO_NATIVE_RUNTIME_LIBRARY=${CAIRO_NATIVE_RUNTIME_LIBRARY}" >>"${GITHUB_ENV}"
+}
+
+main() {
+	# New argument parsing
+	SKIP_RUNTIME=false
+	while getopts ":s" opt; do
+		case ${opt} in
+		s)
+			SKIP_RUNTIME=true
+			;;
+		\?)
+			echo "Invalid option: ${OPTARG}" 1>&2
+			exit 1
+			;;
+		*)
+			echo "Error: Unhandled option" 1>&2
+			exit 1
+			;;
+		esac
+	done
+	shift $((OPTIND - 1))
+
+	# shellcheck disable=SC2312
+	[[ "$(uname)" == "Linux" ]] && install_essential_deps_linux
+
+	setup_llvm_deps
+
+	if [[ ${SKIP_RUNTIME} == false ]]; then
+		install_cairo_native_runtime
+	else
+		echo "Skipping Cairo native runtime installation"
+		# Set the environment variable if the library file exists
+		# shellcheck disable=SC2312
+		if [[ -f "$(pwd)/libcairo_native_runtime.a" ]]; then
+			CAIRO_NATIVE_RUNTIME_LIBRARY=$(pwd)/libcairo_native_runtime.a
+			export CAIRO_NATIVE_RUNTIME_LIBRARY
+			echo "CAIRO_NATIVE_RUNTIME_LIBRARY=${CAIRO_NATIVE_RUNTIME_LIBRARY}"
+			[[ -n ${GITHUB_ACTIONS} ]] && echo "CAIRO_NATIVE_RUNTIME_LIBRARY=${CAIRO_NATIVE_RUNTIME_LIBRARY}" >>"${GITHUB_ENV}"
+		else
+			echo "Warning: libcairo_native_runtime.a not found. CAIRO_NATIVE_RUNTIME_LIBRARY not set."
+		fi
+	fi
+
+	echo "LLVM and Cairo native runtime dependencies setup completed."
+}
+
+main "$@"