From fcdae2656b4ba34af87be91642d6eb30c65e1519 Mon Sep 17 00:00:00 2001
From: maciektr <maciej.tratnowiecki@swmansion.com>
Date: Fri, 23 Feb 2024 18:37:41 +0100
Subject: [PATCH] Add test case for procedural macro compilation (#1100)
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

commit-id:e457ae12

---

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


⚠️ *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.*
---
 scarb/tests/build_cairo_plugin.rs | 125 ++++++++++++++++++++++++++----
 1 file changed, 110 insertions(+), 15 deletions(-)

diff --git a/scarb/tests/build_cairo_plugin.rs b/scarb/tests/build_cairo_plugin.rs
index 382b4cadf..6314b86d7 100644
--- a/scarb/tests/build_cairo_plugin.rs
+++ b/scarb/tests/build_cairo_plugin.rs
@@ -1,27 +1,122 @@
+use assert_fs::fixture::{FileWriteStr, PathChild};
 use assert_fs::TempDir;
-use indoc::indoc;
+use camino::Utf8PathBuf;
+use indoc::{formatdoc, indoc};
+use snapbox::assert_matches;
+use std::collections::HashMap;
+use std::path::PathBuf;
 
 use scarb_test_support::command::Scarb;
+use scarb_test_support::fsx;
 use scarb_test_support::project_builder::ProjectBuilder;
 
+struct CairoPluginProjectBuilder {
+    project: ProjectBuilder,
+    src: HashMap<Utf8PathBuf, String>,
+}
+
+impl CairoPluginProjectBuilder {
+    pub fn start() -> Self {
+        Self {
+            project: ProjectBuilder::start(),
+            src: Default::default(),
+        }
+    }
+
+    pub fn scarb_project(mut self, mutate: impl FnOnce(ProjectBuilder) -> ProjectBuilder) -> Self {
+        self.project = mutate(self.project);
+        self
+    }
+
+    pub fn src(mut self, path: impl Into<Utf8PathBuf>, source: impl ToString) -> Self {
+        self.src.insert(path.into(), source.to_string());
+        self
+    }
+
+    pub fn lib_rs(self, source: impl ToString) -> Self {
+        self.src("src/lib.rs", source.to_string())
+    }
+
+    pub fn just_code(&self, t: &impl PathChild) {
+        for (path, source) in &self.src {
+            t.child(path).write_str(source).unwrap();
+        }
+    }
+
+    pub fn build(&self, t: &impl PathChild) {
+        self.project.just_manifest(t);
+        self.just_code(t);
+    }
+}
+
+fn cairo_lang_macro_lib_path() -> String {
+    let path = fsx::canonicalize(
+        PathBuf::from(env!("CARGO_MANIFEST_DIR")).join("../plugins/cairo-lang-macro/"),
+    )
+    .unwrap();
+    serde_json::to_string(&path).unwrap()
+}
+
+fn simple_project(t: &impl PathChild) {
+    let macro_lib_path = cairo_lang_macro_lib_path();
+    CairoPluginProjectBuilder::start()
+        .scarb_project(|b| {
+            b.name("hello")
+                .version("1.0.0")
+                .manifest_extra(r#"[cairo-plugin]"#)
+        })
+        .lib_rs(indoc! {r#"
+        use cairo_lang_macro::{ProcMacroResult, TokenStream, attribute_macro};
+
+        #[attribute_macro]
+        pub fn some_macro(token_stream: TokenStream) -> ProcMacroResult {
+            let _code = token_stream.to_string();
+            ProcMacroResult::Leave
+        }
+        "#})
+        .src(
+            "Cargo.toml",
+            formatdoc! {r#"
+        [package]
+        name = "proc-macro-stub"
+        version = "0.1.0"
+        edition = "2021"
+        publish = false
+
+        [lib]
+        crate-type = ["rlib","cdylib"]
+
+        [dependencies]
+        cairo-lang-macro = {{ path = {macro_lib_path}}}
+        "#},
+        )
+        .build(t);
+}
+
 #[test]
-#[ignore = "TODO(maciektr): Remove when proc-macros are implemented."]
 fn compile_cairo_plugin() {
     let t = TempDir::new().unwrap();
-    ProjectBuilder::start()
-        .name("hello")
-        .version("1.0.0")
-        .manifest_extra(r#"[cairo-plugin]"#)
-        .build(&t);
-
-    Scarb::quick_snapbox()
-        .arg("check")
+    simple_project(&t);
+    let output = Scarb::quick_snapbox()
+        .arg("build")
+        // Disable colors in Cargo output.
+        .env("CARGO_TERM_COLOR", "never")
         .current_dir(&t)
-        .assert()
-        .failure()
-        .stdout_matches(indoc! {r#"
-        error: compiling Cairo plugin packages is not possible yet
-        "#});
+        .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("Compiling 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 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]