Require disabled gas in executable target compilation

commit-id:671bf5e1
software-mansion · Jan 29, 2025 · 55a1c95 · 55a1c95
1 parent ef4fb73
commit 55a1c95
Show file tree

Hide file tree

Showing 4 changed files with 74 additions and 6 deletions.
diff --git a/extensions/scarb-execute/tests/arguments.rs b/extensions/scarb-execute/tests/arguments.rs
@@ -13,6 +13,9 @@ fn can_take_big_number_as_arg() {
         .version("0.1.0")
         .manifest_extra(indoc! {r#"
             [executable]
+            
+            [cairo]
+            enable-gas = false
         "#})
         .dep_cairo_execute()
         .lib_cairo(indoc! {r#"
@@ -51,6 +54,9 @@ fn can_read_arguments_from_file() {
         .version("0.1.0")
         .manifest_extra(indoc! {r#"
             [executable]
+            
+            [cairo]
+            enable-gas = false
         "#})
         .dep_cairo_execute()
         .lib_cairo(indoc! {r#"

diff --git a/extensions/scarb-execute/tests/build.rs b/extensions/scarb-execute/tests/build.rs
@@ -15,8 +15,11 @@ fn executable_project_builder() -> ProjectBuilder {
         .version("0.1.0")
         .dep_cairo_execute()
         .manifest_extra(indoc! {r#"
-                [executable]
-            "#})
+            [executable]
+
+            [cairo]
+            enable-gas = false
+        "#})
         .lib_cairo(indoc! {r#"
             #[executable]
             fn main() -> felt252 {
@@ -136,8 +139,11 @@ fn fails_when_attr_missing() {
         .version("0.1.0")
         .dep_cairo_execute()
         .manifest_extra(indoc! {r#"
-                [executable]
-            "#})
+            [executable]
+
+            [cairo]
+            enable-gas = false
+        "#})
         .lib_cairo(indoc! {r#"
             fn main() -> felt252 {
                 42

diff --git a/scarb/src/compiler/compilers/executable.rs b/scarb/src/compiler/compilers/executable.rs
@@ -1,10 +1,11 @@
 use crate::compiler::helpers::write_json;
 use crate::compiler::helpers::{build_compiler_config, collect_main_crate_ids};
 use crate::compiler::{CairoCompilationUnit, CompilationUnitAttributes, Compiler};
-use crate::core::{TargetKind, Workspace};
-use anyhow::Result;
+use crate::core::{TargetKind, Utf8PathWorkspaceExt, Workspace};
+use anyhow::{ensure, Result};
 use cairo_lang_compiler::db::RootDatabase;
 use cairo_lang_executable::executable::Executable;
+use indoc::formatdoc;
 use tracing::trace_span;
 
 pub struct ExecutableCompiler;
@@ -20,6 +21,18 @@ impl Compiler for ExecutableCompiler {
         db: &mut RootDatabase,
         ws: &Workspace<'_>,
     ) -> Result<()> {
+        ensure!(
+            !unit.compiler_config.enable_gas,
+            formatdoc! {r#"
+                executable target cannot be compiled with enabled gas calculation
+                help: if you want to diable gas calculation, consider adding following
+                excerpt to your package manifest
+                    -> {scarb_toml}
+                        [cairo]
+                        enable-gas = false
+                "#, scarb_toml=unit.main_component().package.manifest_path().workspace_relative(ws)}
+        );
+
         let target_dir = unit.target_dir(ws);
         let main_crate_ids = collect_main_crate_ids(&unit, db);
         let compiler_config = build_compiler_config(db, &unit, &main_crate_ids, ws);

diff --git a/scarb/tests/build_targets.rs b/scarb/tests/build_targets.rs
@@ -1101,6 +1101,9 @@ fn test_executable_compiler_creates_output_files() {
         .dep_cairo_execute()
         .manifest_extra(indoc! {r#"
             [[target.executable]]
+
+            [cairo]
+            enable-gas = false
         "#})
         .lib_cairo(indoc! {r#"
             #[executable]
@@ -1130,6 +1133,9 @@ fn compile_executable_target_can_use_short_declaration() {
         .dep_cairo_execute()
         .manifest_extra(indoc! {r#"
             [executable]
+
+            [cairo]
+            enable-gas = false
         "#})
         .lib_cairo(indoc! {r#"
             #[executable]
@@ -1148,3 +1154,40 @@ fn compile_executable_target_can_use_short_declaration() {
     t.child("target/dev/executable_test.executable.json")
         .assert(predicates::path::exists());
 }
+
+#[test]
+fn executable_target_requires_disabled_gas() {
+    let t = TempDir::new().unwrap();
+    ProjectBuilder::start()
+        .name("executable_test")
+        .dep_cairo_execute()
+        .manifest_extra(indoc! {r#"
+            [executable]
+        "#})
+        .lib_cairo(indoc! {r#"
+            #[executable]
+            fn main() -> felt252 {
+                42
+            }
+        "#})
+        .build(&t);
+
+    Scarb::quick_snapbox()
+        .arg("build")
+        .current_dir(&t)
+        .assert()
+        .failure()
+        .stdout_matches(indoc! {r#"
+        [..]Compiling executable_test v1.0.0 ([..]Scarb.toml)
+        error: executable target cannot be compiled with enabled gas calculation
+        help: if you want to diable gas calculation, consider adding following
+        excerpt to your package manifest
+            -> Scarb.toml
+                [cairo]
+                enable-gas = false
+        error: could not compile `executable_test` due to previous error
+        "#});
+
+    t.child("target/dev/executable_test.executable.json")
+        .assert(predicates::path::exists().not());
+}