Merge pull request #1174 from rajatjindal/fix-arm

allow running e2e tests with aarch64

Author: rajatjindal

.github/workflows/build.yml

@@ -170,4 +170,4 @@ jobs:
       - name: Run e2e tests
         run: |
           chmod +x `pwd`/target/release/spin
-          docker compose -f e2e-tests-docker-compose.yml run e2e-tests
+          docker compose -f e2e-tests-docker-compose.yml run -v `pwd`/target/release/spin:/usr/local/bin/spin e2e-tests 

e2e-tests-aarch64.Dockerfile

@@ -1,5 +1,8 @@
 FROM ubuntu:22.04
 
+ARG BUILD_SPIN=false
+ARG SPIN_VERSION=canary
+
 WORKDIR /root
 RUN apt-get update && apt-get install -y wget sudo xz-utils gcc git pkg-config
 
@@ -21,42 +24,48 @@ RUN wget https://ziglang.org/download/0.10.0/zig-linux-aarch64-0.10.0.tar.xz &&
     tar -xf zig-linux-aarch64-0.10.0.tar.xz
 ENV PATH="$PATH:/root/zig-linux-aarch64-0.10.0"
 
-# # grain
+# # grain - disabled as no arm build
 # RUN wget https://github.com/grain-lang/grain/releases/download/grain-v0.5.4/grain-linux-x64 && \
 #     mv grain-linux-x64 /usr/local/bin/grain && chmod +x /usr/local/bin/grain
 
-# spin
-RUN wget https://github.com/fermyon/spin/releases/download/canary/spin-canary-linux-aarch64.tar.gz && \
-    tar -xvf spin-canary-linux-aarch64.tar.gz && \
-    ls -ltr && \
-    mv spin /usr/local/bin/spin
-
 # # rust
 ENV RUSTUP_HOME=/usr/local/rustup \
     CARGO_HOME=/usr/local/cargo \
     PATH=/usr/local/cargo/bin:$PATH
 
-RUN url="https://static.rust-lang.org/rustup/dist/aarch64-unknown-linux-gnu/rustup-init"; \
-    wget "$url"; \
-    chmod +x rustup-init; \
-    ./rustup-init -y --no-modify-path --default-toolchain 1.66 --default-host aarch64-unknown-linux-gnu; \
-    rm rustup-init; \
-    chmod -R a+w $RUSTUP_HOME $CARGO_HOME; \
-    rustup --version; \
-    cargo --version; \
-    rustc --version; \
+RUN url="https://static.rust-lang.org/rustup/dist/aarch64-unknown-linux-gnu/rustup-init";                       \
+    wget "$url";                                                                                                \
+    chmod +x rustup-init;                                                                                       \
+    ./rustup-init -y --no-modify-path --default-toolchain 1.66 --default-host aarch64-unknown-linux-gnu;        \
+    rm rustup-init;                                                                                             \
+    chmod -R a+w $RUSTUP_HOME $CARGO_HOME;                                                                      \
+    rustup --version;                                                                                           \
+    cargo --version;                                                                                            \
+    rustc --version;                                                                                            \
     rustup target add wasm32-wasi;
 
 ## check versions
-RUN tinygo version
-RUN go version
-# RUN grain --version
-RUN spin --version
-RUN zig version
-RUN rustc --version
-RUN node --version
+RUN tinygo version;   \
+    go version;       \
+    zig version;      \
+    rustc --version;  \
+    node --version;
 
 WORKDIR /e2e-tests
 COPY . .
 
+# spin
+RUN if [ "${BUILD_SPIN}" != "true" ]; then                                                                                      \
+        wget https://github.com/fermyon/spin/releases/download/${SPIN_VERSION}/spin-${SPIN_VERSION}-linux-aarch64.tar.gz &&     \
+        tar -xvf spin-${SPIN_VERSION}-linux-aarch64.tar.gz &&                                                                   \
+        ls -ltr &&                                                                                                              \
+        mv spin /usr/local/bin/spin;                                                                                            \
+    else                                                                                                                        \
+        cargo build --release &&                                                                                                \
+        cp target/release/spin /usr/local/bin/spin;                                                                             \
+    fi
+
+RUN spin --version
+
+
 CMD cargo test spinup_tests --features new-e2e-tests --no-fail-fast -- --nocapture

e2e-tests-docker-compose.yml

@@ -2,7 +2,7 @@ version: "3.9"
 
 services:
   mysql:
-    image: mysql:8.0.22
+    image: ${MYSQL_IMAGE:-mysql:8.0.22}
     ports:
       - "3306:3306"
     volumes:
@@ -19,8 +19,6 @@ services:
       - mysql
     image: spin-e2e-tests
     entrypoint: cargo test spinup_tests --features new-e2e-tests --no-fail-fast -- --nocapture
-    volumes:
-      - ./target/release/spin:/usr/local/bin/spin
 
 volumes:
   db_data: {}

tests/README.md

@@ -20,6 +20,26 @@ docker build -t spin-e2e-tests -f e2e-tests.Dockerfile .
 docker compose -f e2e-tests-docker-compose.yml run e2e-tests
 ```
 
+## How to run e2e tests on aarch64
+```
+## go to root dir of the project, e2e-tests-aarch64.Dockerfile is located there
+docker build -t spin-e2e-tests -f e2e-tests-aarch64.Dockerfile .
+MYSQL_IMAGE=arm64v8/mysql:8.0.32 docker compose         \
+    -f e2e-tests-docker-compose.yml run                 \
+    e2e-tests
+```
+
+## How to use `spin` binary with your local changes
+
+By default tests use the canary build of `spin` downloaded at docker image creation time. If you want to test it with your changes, you can use `--build-arg BUILD_SPIN=true`
+
+```
+docker build --build-arg BUILD_SPIN=true -t spin-e2e-tests -f e2e-tests.Dockerfile .
+docker compose                                          \
+    -f e2e-tests-docker-compose.yml run                 \
+    e2e-tests
+```
+
 ## Important files and their function
 
 `crates/e2e-testing`     - All the test framework/utilities that are required for `e2e-tests`