Merge pull request #767 from 0xMiden/greenhat/i764-new-mpt-test

chore: add a smoke test for `cargo miden new`

Author: greenhat

.github/workflows/ci.yml

@@ -197,8 +197,39 @@ jobs:
             cargo install cargo-make --force
           fi
       - name: Test
+        # Skip running the `new_project_integration_tests_pass` test since it
+        # is a disc space hog.
         run: |
-          cargo make test -E 'package(cargo-miden)'
+          cargo make test -E 'package(cargo-miden) - test(new_project_integration_tests_pass)'
+
+  cargo_miden_tests_mpt:
+    name: cargo-miden test Miden project template
+    runs-on: ubuntu-latest
+    # We only want to run the integration tests if the unit tests pass, and that has the added
+    # benefit that we can re-use the cache from the unit test job for all integration tests
+    needs: [unit_tests]
+    steps:
+      - uses: actions/checkout@v5
+      - name: Install Rust
+        run: |
+          rustup update --no-self-update
+          rustc --version
+      - name: Cache Cargo
+        uses: Swatinem/rust-cache@v2
+        with:
+          shared-key: ${{ github.workflow }}-shared-tests
+          prefix-key: ${{ env.RUST_CACHE_KEY }}
+          # Do not persist the cache, leave that to the unit tests, we just use the cache here
+          save-if: false
+      - name: Install cargo-make
+        run: |
+          if ! cargo make --version 2>/dev/null; then
+            cargo install cargo-make --force
+          fi
+      - name: Test
+        run: |
+          cargo make test -E 'test(new_project_integration_tests_pass)'
+
 
   miden_integration_node_tests:
     name: miden integration node tests

tools/cargo-miden/tests/build.rs

@@ -433,3 +433,74 @@ fn build_new_project_from_template(template: &str) -> Package {
     fs::remove_dir_all(new_project_path).unwrap();
     package
 }
+
+#[test]
+fn new_project_integration_tests_pass() {
+    let _ = env_logger::Builder::from_env("MIDENC_TRACE")
+        .is_test(true)
+        .format_timestamp(None)
+        .try_init();
+    env::set_var("TEST", "1");
+
+    let restore_dir = env::current_dir().unwrap();
+    let temp_dir = env::temp_dir().join(format!(
+        "cargo_miden_integration_{}",
+        std::time::SystemTime::now()
+            .duration_since(std::time::UNIX_EPOCH)
+            .unwrap()
+            .as_millis()
+    ));
+    if temp_dir.exists() {
+        fs::remove_dir_all(&temp_dir).unwrap();
+    }
+    fs::create_dir_all(&temp_dir).unwrap();
+    env::set_current_dir(&temp_dir).unwrap();
+
+    let project_name = format!(
+        "integration_project_{}",
+        std::time::SystemTime::now()
+            .duration_since(std::time::UNIX_EPOCH)
+            .unwrap()
+            .as_micros()
+    );
+    let args = new_project_args(&project_name, "");
+
+    let output = run(args.into_iter(), OutputType::Masm)
+        .expect("Failed to create project with `cargo miden new`")
+        .expect("'cargo miden new' should return Some(CommandOutput)");
+    let project_path = match output {
+        cargo_miden::CommandOutput::NewCommandOutput { project_path } => {
+            project_path.canonicalize().unwrap()
+        }
+        other => panic!("Expected NewCommandOutput, got {other:?}"),
+    };
+    assert!(project_path.exists());
+
+    let integration_dir = project_path.join("integration");
+    assert!(
+        integration_dir.exists(),
+        "expected integration workspace at {}",
+        integration_dir.display()
+    );
+
+    let output = std::process::Command::new("cargo")
+        .arg("test")
+        .current_dir(&integration_dir)
+        .output()
+        .expect("failed to spawn `cargo test` inside integration directory");
+    if !output.status.success() {
+        panic!(
+            "`cargo test` failed in {} with status {:?}\nstdout:\n{}\nstderr:\n{}",
+            integration_dir.display(),
+            output.status.code(),
+            String::from_utf8_lossy(&output.stdout),
+            String::from_utf8_lossy(&output.stderr)
+        );
+    }
+
+    env::set_current_dir(restore_dir).unwrap();
+    fs::remove_dir_all(&project_path).unwrap();
+    if temp_dir.exists() {
+        fs::remove_dir_all(&temp_dir).unwrap();
+    }
+}