feat: add build arg for cargo profile

shuttle-hq · oddgrd · Jan 23, 2023 · Jan 17, 2023 · Jan 19, 2023 · Jan 19, 2023
commit 22f54de67a15a73f696ccce93c767b1f75b3537c
diff --git a/Containerfile b/Containerfile
@@ -25,7 +25,9 @@ COPY --from=planner /build/recipe.json recipe.json
 RUN cargo chef cook --recipe-path recipe.json
 COPY --from=cache /build .
 ARG folder
-RUN cargo build --bin shuttle-${folder} --release
+ARG CARGO_PROFILE
+# if the PROD env isn't set, use default debug profile
+RUN cargo build --bin shuttle-${folder} $(if [ "$CARGO_PROFILE" = "release" ]; then echo --${CARGO_PROFILE}; fi)
 
 ARG RUSTUP_TOOLCHAIN
 FROM rust:${RUSTUP_TOOLCHAIN}-buster as shuttle-common
@@ -43,7 +45,8 @@ FROM shuttle-common
 ARG folder
 COPY ${folder}/prepare.sh /prepare.sh
 RUN /prepare.sh
-COPY --from=builder /build/target/release/shuttle-${folder} /usr/local/bin/service
+ARG CARGO_PROFILE
+COPY --from=builder /build/target/${CARGO_PROFILE}/shuttle-${folder} /usr/local/bin/service
 ARG RUSTUP_TOOLCHAIN
 ENV RUSTUP_TOOLCHAIN=${RUSTUP_TOOLCHAIN}
 ENTRYPOINT ["/usr/local/bin/service"]
diff --git a/Makefile b/Makefile
@@ -49,6 +49,7 @@ CONTAINER_REGISTRY=public.ecr.aws/shuttle
 DD_ENV=production
 # make sure we only ever go to production with `--tls=enable`
 USE_TLS=enable
+CARGO_PROFILE=release
 else
 DOCKER_COMPOSE_FILES=-f docker-compose.yml -f docker-compose.dev.yml
 STACK?=shuttle-dev
@@ -57,6 +58,7 @@ DB_FQDN=db.unstable.shuttle.rs
 CONTAINER_REGISTRY=public.ecr.aws/shuttle-dev
 DD_ENV=unstable
 USE_TLS?=disable
+CARGO_PROFILE=debug
 endif
 
 POSTGRES_EXTRA_PATH?=./extras/postgres
@@ -112,6 +114,7 @@ shuttle-%: ${SRC} Cargo.lock
 	docker buildx build \
 	       --build-arg folder=$(*) \
 		   --build-arg RUSTUP_TOOLCHAIN=$(RUSTUP_TOOLCHAIN) \
+		   --build-arg CARGO_PROFILE=$(CARGO_PROFILE) \
 	       --tag $(CONTAINER_REGISTRY)/$(*):$(COMMIT_SHA) \
 	       --tag $(CONTAINER_REGISTRY)/$(*):$(TAG) \
 	       --tag $(CONTAINER_REGISTRY)/$(*):latest \

diff --git a/proto/src/lib.rs b/proto/src/lib.rs
@@ -287,36 +287,50 @@ pub mod runtime {
         Ok((runtime, runtime_client))
     }
 
+    /// If the calling crate is cargo-shuttle, try to install shuttle-runtime from
+    /// a local version if this library is compiled in debug mode or from the production
+    /// branch of the shuttle repo if it's compiled in release mode.
+    ///
+    /// If the calling crate is deployer, use the version of shuttle-runtime installed in
+    /// deployer/prepare.sh.
+    ///
+    /// **Important:** When called by deployer, this function expects that shuttle-runtime
+    /// was installed in prepare.sh.
     fn get_runtime_executable() -> PathBuf {
-        // When this library is compiled in debug mode with `cargo run --bin cargo-shuttle`,
-        // install the checked-out local version of `shuttle-runtime
-        if cfg!(debug_assertions) {
-            // Path to calling crate root
-            let manifest_dir = env!("CARGO_MANIFEST_DIR");
-
-            // Canonicalized path to shuttle-runtime
-            let path = std::fs::canonicalize(format!("{manifest_dir}/../runtime"))
-                .expect("failed to canonicalize path to runtime");
-
-            Command::new("cargo")
-                .arg("install")
-                .arg("shuttle-runtime")
-                .arg("--path")
-                .arg(path)
-                .output()
-                .expect("failed to install the shuttle runtime");
-        // When this library is compiled in release mode with `cargo install cargo-shuttle`,
-        // install the latest released `shuttle-runtime`
-        } else {
-            Command::new("cargo")
-                .arg("install")
-                .arg("shuttle-runtime")
-                .arg("--git")
-                .arg("https://github.com/shuttle-hq/shuttle")
-                .arg("--branch")
-                .arg("production")
-                .output()
-                .expect("failed to install the shuttle runtime");
+        let current_crate = env!("CARGO_PKG_NAME");
+
+        if current_crate == "cargo-shuttle" {
+            // When this library is compiled in debug mode with `cargo run --bin cargo-shuttle`,
+            // install the checked-out local version of `shuttle-runtime
+            if cfg!(debug_assertions) {
+                // Path to calling crate root
+                let manifest_dir = env!("CARGO_MANIFEST_DIR");
+
+                // Canonicalized path to shuttle-runtime for dev to work on windows
+                let path = std::fs::canonicalize(format!("{manifest_dir}/../runtime"))
+                    .expect("path to shuttle-runtime does not exist or is invalid");
+
+                Command::new("cargo")
+                    .arg("install")
+                    .arg("shuttle-runtime")
+                    .arg("--path")
+                    .arg(path)
+                    .output()
+                    .expect("failed to install the shuttle runtime");
+
+            // When this library is compiled in release mode with `cargo install cargo-shuttle`,
+            // install the latest released `shuttle-runtime`
+            } else {
+                Command::new("cargo")
+                    .arg("install")
+                    .arg("shuttle-runtime")
+                    .arg("--git")
+                    .arg("https://github.com/shuttle-hq/shuttle")
+                    .arg("--branch")
+                    .arg("production")
+                    .output()
+                    .expect("failed to install the shuttle runtime");
+            }
         }
 
         let cargo_home = home::cargo_home().expect("failed to find cargo home directory");