Extract integration helpers to separate package (#912)

<!-- Reference any GitHub issues resolved by this PR -->

Closes #911 

## Introduced changes

<!-- A brief description of the changes -->

- Moved helper code from integration tests to `utils` crate within
`forge` so it can be reused for benchmarks.

## Breaking changes

<!-- List of all breaking changes, if applicable -->

## Checklist

<!-- Make sure all of these are complete -->

- [x] Linked relevant issue
- [x] Updated relevant documentation
- [x] Added relevant tests
- [x] Performed self-review of the code
- [x] Added changes to `CHANGELOG.md`

crates/forge/Cargo.toml

@@ -68,3 +68,6 @@ name = "forge"
 [[bin]]
 name = "snforge"
 path = "src/main.rs"
+
+[dev-dependencies]
+test_utils = { path = "test_utils" }

crates/forge/test_utils/Cargo.toml

@@ -0,0 +1,27 @@
+[package]
+name = "test_utils"
+version = "0.1.0"
+edition = "2021"
+
+# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
+
+[dependencies]
+anyhow.workspace = true
+assert_fs.workspace = true
+camino.workspace = true
+indoc.workspace = true
+scarb-metadata = { git = "https://github.com/software-mansion/scarb.git", rev = "58cc88e" }
+cairo-lang-runner.workspace = true
+cairo-lang-casm.workspace = true
+cairo-lang-sierra-to-casm.workspace = true
+cairo-lang-sierra.workspace = true
+cairo-lang-utils.workspace = true
+cairo-lang-starknet.workspace = true
+cairo-lang-compiler.workspace = true
+cairo-lang-filesystem.workspace = true
+serde_json.workspace = true
+serde.workspace = true
+tempfile.workspace = true
+tokio.workspace = true
+forge = { path = "../../forge" }
+test-collector = { path = "../../test-collector" }

crates/forge/tests/integration/common/corelib.rs → crates/forge/test_utils/src/corelib.rs

@@ -6,6 +6,7 @@ use indoc::indoc;
 use scarb_metadata::MetadataCommand;
 
 #[allow(clippy::module_name_repetitions)]
+#[must_use]
 pub fn corelib_path() -> Utf8PathBuf {
     // create an empty scarb project to extract corelib location from metadata
     let dir = TempDir::new().unwrap();
@@ -34,6 +35,7 @@ pub fn corelib_path() -> Utf8PathBuf {
     corelib_for_package(&scarb_metadata, package).unwrap()
 }
 
+#[must_use]
 pub fn predeployed_contracts() -> TempDir {
     let predeployed_contracts = TempDir::new().unwrap();
     predeployed_contracts

crates/forge/tests/integration/common/runner.rs → crates/forge/test_utils/src/runner.rs

@@ -27,6 +27,7 @@ pub struct Contract {
 }
 
 impl Contract {
+    #[must_use]
     pub fn new(name: &str, code: &str) -> Self {
         Self {
             name: name.to_string(),
@@ -109,6 +110,7 @@ impl<'a> TestCase {
         self.enviroment_variables.insert(key.into(), value.into());
     }
 
+    #[must_use]
     pub fn env(&self) -> &HashMap<String, String> {
         &self.enviroment_variables
     }
@@ -118,6 +120,7 @@ impl<'a> TestCase {
             .map_err(|_| anyhow!("Failed to convert TestCase path to Utf8PathBuf"))
     }
 
+    #[must_use]
     pub fn linked_libraries(&self) -> Vec<LinkedLibrary> {
         let snforge_std_path = PathBuf::from_str("../../snforge_std")
             .unwrap()
@@ -151,6 +154,7 @@ impl<'a> TestCase {
             .collect()
     }
 
+    #[must_use]
     pub fn find_test_result(results: &[TestCrateSummary]) -> &TestCrateSummary {
         results
             .iter()
@@ -162,11 +166,11 @@ impl<'a> TestCase {
 #[macro_export]
 macro_rules! test_case {
     ( $test_code:expr ) => ({
-        use $crate::integration::common::runner::TestCase;
+        use $crate::runner::TestCase;
         TestCase::from($test_code, vec![]).unwrap()
     });
     ( $test_code:expr, $( $contract:expr ),*) => ({
-        use $crate::integration::common::runner::TestCase;
+        use $crate::runner::TestCase;
 
         let contracts = vec![$($contract,)*];
         TestCase::from($test_code, contracts).unwrap()
@@ -177,7 +181,7 @@ macro_rules! test_case {
 macro_rules! assert_passed {
     ($result:expr) => {{
         use forge::test_case_summary::TestCaseSummary;
-        use $crate::integration::common::runner::TestCase;
+        use $crate::runner::TestCase;
 
         let result = TestCase::find_test_result(&$result);
         assert!(
@@ -199,7 +203,7 @@ macro_rules! assert_failed {
     ($result:expr) => {{
         use forge::test_case_summary::TestCaseSummary;
 
-        use $crate::integration::common::runner::TestCase;
+        use $crate::runner::TestCase;
 
         let result = TestCase::find_test_result(&$result);
         assert!(
@@ -221,7 +225,7 @@ macro_rules! assert_case_output_contains {
     ($result:expr, $test_case_name:expr, $asserted_msg:expr) => {{
         use forge::test_case_summary::TestCaseSummary;
 
-        use $crate::integration::common::runner::TestCase;
+        use $crate::runner::TestCase;
 
         let test_case_name = $test_case_name;
         let test_name_suffix = format!("::{test_case_name}");

crates/forge/tests/integration/common/running_tests.rs → crates/forge/test_utils/src/running_tests.rs

@@ -1,7 +1,7 @@
 use std::sync::Arc;
 
-use crate::integration::common::corelib::{corelib_path, predeployed_contracts};
-use crate::integration::common::runner::TestCase;
+use crate::corelib::{corelib_path, predeployed_contracts};
+use crate::runner::TestCase;
 use camino::Utf8PathBuf;
 
 use forge::{run, CancellationTokens, RunnerConfig, RunnerParams, TestCrateSummary};
@@ -10,6 +10,7 @@ use std::path::PathBuf;
 use tempfile::tempdir;
 use tokio::runtime::Runtime;
 
+#[must_use]
 pub fn run_test_case(test: &TestCase) -> Vec<TestCrateSummary> {
     let rt = Runtime::new().expect("Could not instantiate Runtime");
 

crates/forge/tests/integration/cheat_fork.rs

@@ -1,6 +1,6 @@
-use crate::integration::common::running_tests::run_test_case;
-use crate::{assert_passed, test_case};
 use indoc::formatdoc;
+use test_utils::running_tests::run_test_case;
+use test_utils::{assert_passed, test_case};
 
 static CHEATNET_RPC_URL: &str = "http://188.34.188.184:9545/rpc/v0.4";
 

crates/forge/tests/integration/declare.rs

@@ -1,8 +1,8 @@
-use crate::integration::common::runner::Contract;
-use crate::integration::common::running_tests::run_test_case;
-use crate::{assert_passed, test_case};
 use indoc::indoc;
 use std::path::Path;
+use test_utils::runner::Contract;
+use test_utils::running_tests::run_test_case;
+use test_utils::{assert_passed, test_case};
 
 #[test]
 fn simple_declare() {

crates/forge/tests/integration/deploy.rs

@@ -1,8 +1,8 @@
-use crate::integration::common::runner::Contract;
-use crate::integration::common::running_tests::run_test_case;
-use crate::{assert_passed, test_case};
 use indoc::indoc;
 use std::path::Path;
+use test_utils::runner::Contract;
+use test_utils::running_tests::run_test_case;
+use test_utils::{assert_passed, test_case};
 
 #[test]
 fn error_handling() {

crates/forge/tests/integration/deploy_at.rs

@@ -1,8 +1,8 @@
-use crate::integration::common::runner::Contract;
-use crate::integration::common::running_tests::run_test_case;
-use crate::{assert_case_output_contains, assert_failed, assert_passed, test_case};
 use indoc::indoc;
 use std::path::Path;
+use test_utils::runner::Contract;
+use test_utils::running_tests::run_test_case;
+use test_utils::{assert_case_output_contains, assert_failed, assert_passed, test_case};
 
 #[test]
 fn deploy_at_correct_address() {

crates/forge/tests/integration/dispatchers.rs

@@ -1,9 +1,8 @@
-use crate::integration::common::runner::Contract;
-use crate::integration::common::running_tests::run_test_case;
-use crate::{assert_case_output_contains, assert_failed, assert_passed, test_case};
 use indoc::indoc;
 use std::path::Path;
-use std::string::ToString;
+use test_utils::runner::Contract;
+use test_utils::running_tests::run_test_case;
+use test_utils::{assert_case_output_contains, assert_failed, assert_passed, test_case};
 
 #[test]
 fn simple_call_and_invoke() {

crates/forge/tests/integration/env.rs

@@ -1,8 +1,8 @@
-use crate::integration::common::running_tests::run_test_case;
-use crate::{assert_case_output_contains, assert_failed, assert_passed, test_case};
 use cairo_felt::Felt252;
 use indoc::indoc;
 use num_bigint::BigUint;
+use test_utils::running_tests::run_test_case;
+use test_utils::{assert_case_output_contains, assert_failed, assert_passed, test_case};
 
 #[test]
 fn read_short_string() {

crates/forge/tests/integration/fuzzing.rs

@@ -1,6 +1,6 @@
-use crate::integration::common::running_tests::run_test_case;
-use crate::{assert_passed, test_case};
 use indoc::indoc;
+use test_utils::running_tests::run_test_case;
+use test_utils::{assert_passed, test_case};
 
 #[test]
 fn fuzzed_argument() {

crates/forge/tests/integration/get_class_hash.rs

@@ -1,8 +1,8 @@
-use crate::integration::common::runner::Contract;
-use crate::integration::common::running_tests::run_test_case;
-use crate::{assert_passed, test_case};
 use indoc::indoc;
 use std::path::Path;
+use test_utils::runner::Contract;
+use test_utils::running_tests::run_test_case;
+use test_utils::{assert_passed, test_case};
 
 #[test]
 fn get_class_hash() {

crates/forge/tests/integration/l1_handler_executor.rs

@@ -1,8 +1,8 @@
-use crate::integration::common::runner::Contract;
-use crate::integration::common::running_tests::run_test_case;
-use crate::{assert_passed, test_case};
 use indoc::indoc;
 use std::path::Path;
+use test_utils::runner::Contract;
+use test_utils::running_tests::run_test_case;
+use test_utils::{assert_passed, test_case};
 
 #[test]
 fn l1_handler_executor() {

crates/forge/tests/integration/mock_call.rs

@@ -1,8 +1,8 @@
-use crate::integration::common::runner::Contract;
-use crate::integration::common::running_tests::run_test_case;
-use crate::{assert_passed, test_case};
 use indoc::indoc;
 use std::path::Path;
+use test_utils::runner::Contract;
+use test_utils::running_tests::run_test_case;
+use test_utils::{assert_passed, test_case};
 
 #[test]
 fn mock_call_simple() {

crates/forge/tests/integration/mod.rs

@@ -1,5 +1,4 @@
 mod cheat_fork;
-pub(crate) mod common;
 mod declare;
 mod deploy;
 mod deploy_at;

crates/forge/tests/integration/prank.rs

@@ -1,8 +1,8 @@
-use crate::integration::common::runner::Contract;
-use crate::integration::common::running_tests::run_test_case;
-use crate::{assert_passed, test_case};
 use indoc::indoc;
 use std::path::Path;
+use test_utils::runner::Contract;
+use test_utils::running_tests::run_test_case;
+use test_utils::{assert_passed, test_case};
 
 #[test]
 fn prank() {

crates/forge/tests/integration/precalculate_address.rs

@@ -1,8 +1,8 @@
-use crate::integration::common::runner::Contract;
-use crate::integration::common::running_tests::run_test_case;
-use crate::{assert_passed, test_case};
 use indoc::indoc;
 use std::path::Path;
+use test_utils::runner::Contract;
+use test_utils::running_tests::run_test_case;
+use test_utils::{assert_passed, test_case};
 
 #[test]
 fn precalculate_address() {

crates/forge/tests/integration/pure_cairo.rs

@@ -1,6 +1,6 @@
-use crate::integration::common::running_tests::run_test_case;
-use crate::{assert_failed, assert_passed, test_case};
 use indoc::indoc;
+use test_utils::running_tests::run_test_case;
+use test_utils::{assert_failed, assert_passed, test_case};
 
 #[test]
 fn simple() {

crates/forge/tests/integration/roll.rs

@@ -1,8 +1,8 @@
-use crate::integration::common::runner::Contract;
-use crate::integration::common::running_tests::run_test_case;
-use crate::{assert_passed, test_case};
 use indoc::indoc;
 use std::path::Path;
+use test_utils::runner::Contract;
+use test_utils::running_tests::run_test_case;
+use test_utils::{assert_passed, test_case};
 
 #[test]
 fn roll() {

crates/forge/tests/integration/setup_fork.rs

@@ -1,21 +1,22 @@
-use crate::integration::common::running_tests::run_test_case;
-use crate::{assert_case_output_contains, assert_failed, assert_passed, test_case};
+use std::path::Path;
+use std::path::PathBuf;
+use std::sync::Arc;
 
-use crate::integration::common::corelib::{corelib_path, predeployed_contracts};
-use crate::integration::common::runner::Contract;
 use camino::Utf8PathBuf;
-use forge::scarb::config::{ForgeConfig, ForkTarget};
-use forge::{run, CancellationTokens, RunnerConfig, RunnerParams};
 use indoc::formatdoc;
 use starknet::core::types::BlockId;
 use starknet::core::types::BlockTag::Latest;
-use std::path::Path;
-use std::path::PathBuf;
-use std::sync::Arc;
 use tempfile::tempdir;
-use test_collector::RawForkParams;
 use tokio::runtime::Runtime;
 
+use forge::scarb::config::{ForgeConfig, ForkTarget};
+use forge::{run, CancellationTokens, RunnerConfig, RunnerParams};
+use test_collector::RawForkParams;
+use test_utils::corelib::{corelib_path, predeployed_contracts};
+use test_utils::runner::Contract;
+use test_utils::running_tests::run_test_case;
+use test_utils::{assert_case_output_contains, assert_failed, assert_passed, test_case};
+
 static CHEATNET_RPC_URL: &str = "http://188.34.188.184:9545/rpc/v0.4";
 
 #[test]

crates/forge/tests/integration/should_panic.rs

@@ -1,6 +1,6 @@
-use crate::integration::common::running_tests::run_test_case;
-use crate::{assert_passed, test_case};
 use indoc::indoc;
+use test_utils::running_tests::run_test_case;
+use test_utils::{assert_passed, test_case};
 
 #[test]
 fn should_panic() {

crates/forge/tests/integration/signing.rs

@@ -1,6 +1,6 @@
-use crate::integration::common::running_tests::run_test_case;
-use crate::{assert_passed, test_case};
 use indoc::indoc;
+use test_utils::running_tests::run_test_case;
+use test_utils::{assert_passed, test_case};
 
 #[test]
 fn simple_signing_flow() {