Implement check command for cairo plugins (#1148)

commit-id:1299f0be

---

**Stack**:
- #1161
- #1159
- #1157
- #1143
- #1151
- #1150
- #1155
- #1148 ⬅


⚠️ *Part of a stack created by [spr](https://github.com/ejoffe/spr). Do
not merge manually using the UI - doing so may have unexpected results.*

Author: maciektr

scarb/src/compiler/plugin/proc_macro/compilation.rs

@@ -45,31 +45,50 @@ impl SharedLibraryProvider for Package {
 }
 
 pub fn compile_unit(unit: CompilationUnit, ws: &Workspace<'_>) -> Result<()> {
+    run_cargo(CargoAction::Build, unit, ws)
+}
+
+pub fn check_unit(unit: CompilationUnit, ws: &Workspace<'_>) -> Result<()> {
+    run_cargo(CargoAction::Check, unit, ws)
+}
+
+fn run_cargo(action: CargoAction, unit: CompilationUnit, ws: &Workspace<'_>) -> Result<()> {
     let main_package = unit.components.first().unwrap().package.clone();
     let cmd = CargoCommand {
+        action,
         current_dir: main_package.root().to_path_buf(),
         target_dir: main_package
             .target_path(ws.config())
             .path_unchecked()
             .to_path_buf(),
     };
     {
-        let _ = trace_span!("compile_proc_macro").enter();
+        let _ = trace_span!("proc_macro").enter();
         exec(&mut cmd.into(), ws.config())?;
     }
     Ok(())
 }
 
+enum CargoAction {
+    Build,
+    Check,
+}
+
 struct CargoCommand {
     current_dir: Utf8PathBuf,
     target_dir: Utf8PathBuf,
+    action: CargoAction,
 }
 
 impl From<CargoCommand> for Command {
     fn from(args: CargoCommand) -> Self {
         let mut cmd = Command::new("cargo");
         cmd.current_dir(args.current_dir);
-        cmd.args(["build", "--release"]);
+        match args.action {
+            CargoAction::Build => cmd.arg("build"),
+            CargoAction::Check => cmd.arg("check"),
+        };
+        cmd.arg("--release");
         cmd.arg("--target-dir");
         cmd.arg(args.target_dir);
         cmd

scarb/src/compiler/plugin/proc_macro/mod.rs

@@ -2,6 +2,6 @@ pub mod compilation;
 mod ffi;
 mod host;
 
-pub use compilation::compile_unit;
+pub use compilation::{check_unit, compile_unit};
 pub use ffi::*;
 pub use host::*;

scarb/src/ops/compile.rs

@@ -125,23 +125,27 @@ fn check_unit(unit: CompilationUnit, ws: &Workspace<'_>) -> Result<()> {
         .ui()
         .print(Status::new("Checking", &unit.name()));
 
-    let db = build_scarb_root_database(&unit, ws)?;
+    if unit.is_cairo_plugin() {
+        proc_macro::check_unit(unit, ws)?;
+    } else {
+        let db = build_scarb_root_database(&unit, ws)?;
 
-    check_starknet_dependency(&unit, ws, &db, &package_name);
+        check_starknet_dependency(&unit, ws, &db, &package_name);
 
-    let mut compiler_config = build_compiler_config(&unit, ws);
+        let mut compiler_config = build_compiler_config(&unit, ws);
 
-    compiler_config
-        .diagnostics_reporter
-        .ensure(&db)
-        .map_err(|err| {
-            let valid_error = err.into();
-            if !suppress_error(&valid_error) {
-                ws.config().ui().anyhow(&valid_error);
-            }
+        compiler_config
+            .diagnostics_reporter
+            .ensure(&db)
+            .map_err(|err| {
+                let valid_error = err.into();
+                if !suppress_error(&valid_error) {
+                    ws.config().ui().anyhow(&valid_error);
+                }
 
-            anyhow!("could not check `{package_name}` due to previous error")
-        })?;
+                anyhow!("could not check `{package_name}` due to previous error")
+            })?;
+    }
 
     Ok(())
 }

scarb/tests/build_cairo_plugin.rs

@@ -119,6 +119,32 @@ fn compile_cairo_plugin() {
     assert_matches(r#"[..]Finished release [optimized] target(s) in[..]"#, last);
 }
 
+#[test]
+fn check_cairo_plugin() {
+    let t = TempDir::new().unwrap();
+    simple_project(&t);
+    let output = Scarb::quick_snapbox()
+        .arg("check")
+        // Disable colors in Cargo output.
+        .env("CARGO_TERM_COLOR", "never")
+        .current_dir(&t)
+        .output()
+        .unwrap();
+    assert!(
+        output.status.success(),
+        "{}",
+        String::from_utf8_lossy(&output.stderr)
+    );
+    let stdout = String::from_utf8_lossy(&output.stdout).to_string();
+    assert!(stdout.contains("Checking hello v1.0.0"));
+    let lines = stdout.lines().map(ToString::to_string).collect::<Vec<_>>();
+    let (last, lines) = lines.split_last().unwrap();
+    assert_matches(r#"[..] Finished checking release target(s) in [..]"#, last);
+    let (last, _lines) = lines.split_last().unwrap();
+    // Line from Cargo output
+    assert_matches(r#"[..]Finished release [optimized] target(s) in[..]"#, last);
+}
+
 #[test]
 fn compile_cairo_plugin_with_lib_target() {
     let t = TempDir::new().unwrap();