Add +CROSS (#47)

Fixes #42
earthly · Feb 14, 2024 · 99ff06a · 99ff06a
1 parent d67913f
commit 99ff06a
Show file tree

Hide file tree

Showing 2 changed files with 81 additions and 17 deletions.
diff --git a/rust/Earthfile b/rust/Earthfile
@@ -1,11 +1,11 @@
-VERSION --global-cache 0.7
+VERSION 0.8
 # INIT sets some configuration in the environment (used by following functions), and installs required dependencies.
 # Arguments:
 #   - cache_prefix: Overrides cache prefix for cache IDS. Its value is exported to the build environment under the entry: $EARTHLY_CACHE_PREFIX. By default ${EARTHLY_TARGET_PROJECT_NO_TAG}#${OS_RELEASE}#earthly-cargo-cache
 #   - keep_fingerprints (false): Instructs the following +CARGO calls to don't remove the Cargo fingerprints of the source packages. Use only when source packages have been COPYed with --keep-ts option.
 #   - sweep_days (4): +CARGO uses cargo-sweep to clean build artifacts that haven't been accessed for this number of days.
 INIT:
-    COMMAND
+    FUNCTION
     RUN if [ -n "$EARTHLY_CACHE_PREFIX" ]; then \
       echo "+INIT has already been called in this build environment" ; \
       exit 1; \
@@ -48,7 +48,7 @@ INIT:
 #     Use this argument when you want to SAVE an ARTIFACT from the target folder (mounted cache), always trying to minimize the total size of the copied fileset.
 #     For example --output="release/[^\./]+" would keep all the files in /target/release that don't have any extension.
 CARGO:
-    COMMAND
+    FUNCTION
     DO +CHECK_INITED
     ARG --required args
     ARG output
@@ -75,7 +75,7 @@ CARGO:
 #   DO rust+SET_CACHE_MOUNTS_ENV
 #   RUN --mount=$EARTHLY_RUST_CARGO_HOME_CACHE --mount=$EARTHLY_RUST_TARGET_CACHE cargo build --release
 SET_CACHE_MOUNTS_ENV:
-    COMMAND
+    FUNCTION
     DO +CHECK_INITED
     ARG target_cache_suffix
     ARG TARGETPLATFORM
@@ -93,7 +93,7 @@ SET_CACHE_MOUNTS_ENV:
 #   RUN --mount=$EARTHLY_RUST_CARGO_HOME_CACHE --mount=$EARTHLY_RUST_TARGET_CACHE cargo build --release
 #   DO rust+COPY_OUTPUT --output="release/[^\./]+" # Keep all the files in /target/release that don't have any extension.
 COPY_OUTPUT:
-    COMMAND
+    FUNCTION
     ARG --required output
     ARG TMP_FOLDER="/tmp/earthly/lib/rust"
     RUN  if [ ! -n "$EARTHLY_RUST_TARGET_CACHE" ]; then \
@@ -109,7 +109,38 @@ COPY_OUTPUT:
             cd ..;  \
         fi;
     RUN mkdir -p target; \
-        mv $TMP_FOLDER/* target 2>/dev/null || echo "no files found within ./target matching the provided output regexp" ;
+        mv $TMP_FOLDER/* target 2>/dev/null || echo "no files found within ./target matching the provided output regexp";
+
+# CROSS runs the [cross](https://github.com/cross-rs/cross) command "cross $args --target $target".
+# Notice that in order to run this function, +INIT must be called first.
+# Arguments:
+#   - target: Cross [target](https://github.com/cross-rs/cross?tab=readme-ov-file#supported-targets). Required.
+#   - args: Cross subcommand and its arguments. By default: "build --release"
+#   - output: Regex matching output artifacts files to be copied to ./target folder in the caller filesystem (image layers). By default: "$target/release/[^\./]+"
+# Example:
+#   DO rust+SET_CACHE_MOUNTS_ENV
+#   DO rust+CROSS --target aarch64-unknown-linux-gnu
+CROSS:
+    FUNCTION
+    ARG --required target
+    ARG args="build --release"
+    ARG output="$target/release/[^\./]+"
+    ARG version=0.2.5
+    DO +SET_CACHE_MOUNTS_ENV --target_cache_suffix="$target"
+    RUN echo "$EARTHLY_RUST_TARGET_CACHE"
+    COPY (+get-cross/cross --version=$version) /tmp/earthly/cross
+    WITH DOCKER  --pull ghcr.io/cross-rs/$target:$version
+        RUN --mount=$EARTHLY_RUST_CARGO_HOME_CACHE \
+            --mount=$EARTHLY_RUST_TARGET_CACHE \
+           /tmp/earthly/cross $args --target=$target;
+    END
+    DO +COPY_OUTPUT --output="$output"
+
+get-cross:
+    FROM alpine:3.18.3
+    ARG --required version
+    RUN wget -nv -O- "https://github.com/cross-rs/cross/releases/download/v${version}/cross-x86_64-unknown-linux-musl.tar.gz" | tar -xzf - -C .
+    SAVE ARTIFACT cross
 
 get-tomljson:
     FROM alpine:3.18.3
@@ -129,14 +160,14 @@ get-jq:
     SAVE ARTIFACT jq
 
 INSTALL_CARGO_SWEEP:
-    COMMAND
+    FUNCTION
     RUN if [ ! -f $CARGO_HOME/bin/cargo-sweep ]; then \
           echo "Installing cargo sweep" ; \
           cargo install cargo-sweep --root $CARGO_HOME; \
         fi;
 
 REMOVE_SOURCE_FINGERPRINTS:
-    COMMAND
+    FUNCTION
     DO +CHECK_INITED
     COPY +get-tomljson/tomljson /tmp/tomljson
     COPY +get-jq/jq /tmp/jq
@@ -156,7 +187,7 @@ REMOVE_SOURCE_FINGERPRINTS:
          done;
 
 CHECK_INITED:
-    COMMAND
+    FUNCTION
     RUN  if [ ! -n "$EARTHLY_CACHE_PREFIX" ]; then \
           echo "+INIT has not been called yet in this build environment" ; \
           exit 1; \

diff --git a/rust/README.md b/rust/README.md
@@ -6,10 +6,9 @@ Earthly's official collection of Rust [functions](https://docs.earthly.dev/docs/
 
 First, import the library up in your Earthfile:
 ```earthfile
-VERSION --global-cache 0.7
+VERSION 0.8
 IMPORT github.com/earthly/lib/rust:<version/commit> AS rust
 ```
-> :warning: Due to [this issue](https://github.com/earthly/earthly/issues/3490), make sure to enable `--global-cache` in the calling Earthfile, as shown above.
 
 ## +INIT
 
@@ -82,13 +81,12 @@ Optional cache suffix for the target folder cache ID.
 ### Example
 
 ```earthfile
-cross:
+clean-target:
   ...
   DO rust+SET_CACHE_MOUNTS_ENV
-  WITH DOCKER
-    RUN --mount=$EARTHLY_RUST_CARGO_HOME_CACHE --mount=$EARTHLY_RUST_TARGET_CACHE  cross build --target $TARGET --release
-  END
+  RUN --mount=$EARTHLY_RUST_TARGET_CACHE rm -rf target
 ```
+
 ## +COPY_OUTPUT
 This function copies files out of the target cache into the image layers.
 Use it function when you want to `SAVE ARTIFACT` from the target folder (mounted cache), always trying to minimize the total size of the copied fileset.
@@ -105,6 +103,34 @@ DO rust+SET_RUST_CACHE_MOUNTS
 RUN --mount=$EARTHLY_RUST_CARGO_HOME_CACHE --mount=$EARTHLY_RUST_TARGET_CACHE cargo build --release
 DO rust+COPY_OUTPUT --output="release/[^\./]+" # Keep all the files in /target/release that don't have any extension.
 ```
+## +CROSS 
+
+Runs the [cross](https://github.com/cross-rs/cross) command: `cross $args --target $target` .
+
+Notice that:
+- This function makes use of `WITH DOCKER`, and hence parallelization might be tricky to achieve ([earthly#3808](https://github.com/earthly/earthly/issues/3808)). 
+- In order to run this function, [+INIT](#init) must be called first.
+
+### Arguments
+
+#### `target`
+Cross [target](https://github.com/cross-rs/cross?tab=readme-ov-file#supported-targets). Required.
+
+#### `args`
+Cross subcommand and its arguments. By default: `build --release`
+
+#### `output`
+Regex matching output artifacts files to be copied to `./target` folder in the caller filesystem (image layers). By default: `$target/release/[^\./]+`
+
+### Example
+
+```earthfile
+cross:
+  ...
+  DO rust+SET_CACHE_MOUNTS_ENV
+  DO rust+CROSS --target aarch64-unknown-linux-gnu
+  DO rust+COPY_OUTPUT --output="release/[^\./]+" # Keep all the files in /target/release that don't have any extension.
+```
 
 ## Complete example
 
@@ -128,7 +154,7 @@ Suppose the following project:
 The Earthfile would look like:
 
 ```earthfile
-VERSION --global-cache 0.7
+VERSION 0.8
 
 # Imports the library definition from default branch (in a real case, specify version or commit to guarantee immutability)
 IMPORT github.com/earthly/lib/rust AS rust
@@ -175,7 +201,14 @@ lint:
 check-dependencies:
   FROM +source
   DO rust+CARGO --args="deny --all-features check --deny warnings bans license sources"
-  
+
+# cross performs cross compilation
+cross:
+  FROM +source
+  ARG --required target
+  DO rust+CROSS --target=$target
+  SAVE ARTIFACT target/$target AS LOCAL dist/$target
+    
 # all runs all other targets in parallel
 all:
   BUILD +lint