Feat: add information about the ability to use --max-n-steps (#2869)

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

Closes #2853 

## Introduced changes

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

- Updated error to suggest using “--max-n-steps” in case of cairo_vm
error

## 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`

---------

Co-authored-by: kkawula <[email protected]>
Co-authored-by: ddoktorski <[email protected]>
Co-authored-by: Artur Michałek <[email protected]>

Author: 4 people

CHANGELOG.md

@@ -9,6 +9,12 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ### Forge
 
+#### Added
+
+- Added a suggestion for using the `--max-n-steps` flag when the Cairo VM returns the error: `Could not reach the end of the program. RunResources has no remaining steps`.
+
+### Forge
+
 #### Fixed
 
 - coverage validation now supports comments in `Scarb.toml`

crates/forge-runner/src/running.rs

@@ -8,6 +8,7 @@ use blockifier::execution::entry_point::EntryPointExecutionContext;
 use blockifier::state::cached_state::CachedState;
 use cairo_lang_runner::{RunResult, SierraCasmRunner};
 use cairo_vm::vm::errors::cairo_run_errors::CairoRunError;
+use cairo_vm::vm::errors::vm_errors::VirtualMachineError;
 use cairo_vm::vm::runners::cairo_runner::ExecutionResources;
 use camino::{Utf8Path, Utf8PathBuf};
 use casm::{get_assembled_program, run_assembled_program};
@@ -306,22 +307,31 @@ fn extract_test_case_summary(
                     versioned_program_path,
                 ),
                 // CairoRunError comes from VirtualMachineError which may come from HintException that originates in TestExecutionSyscallHandler
-                Err(error) => TestCaseSummary::Failed {
-                    name: case.name.clone(),
-                    msg: Some(format!(
+                Err(error) => {
+                    let mut message = format!(
                         "\n    {}\n",
                         error.to_string().replace(" Custom Hint Error: ", "\n    ")
-                    ))
-                    .map(|msg| {
-                        add_backtrace_footer(
-                            msg,
-                            contracts_data,
-                            &result_with_info.encountered_errors,
-                        )
-                    }),
-                    arguments: args,
-                    test_statistics: (),
-                },
+                    );
+                    if let CairoRunError::VirtualMachine(VirtualMachineError::UnfinishedExecution) =
+                        *error
+                    {
+                        message.push_str(
+                                "\n    Suggestion: Consider using the flag `--max-n-steps` to increase allowed limit of steps",
+                            );
+                    }
+                    TestCaseSummary::Failed {
+                        name: case.name.clone(),
+                        msg: Some(message).map(|msg| {
+                            add_backtrace_footer(
+                                msg,
+                                contracts_data,
+                                &result_with_info.encountered_errors,
+                            )
+                        }),
+                        arguments: args,
+                        test_statistics: (),
+                    }
+                }
             }
         }
         // `ForkStateReader.get_block_info`, `get_fork_state_reader, `calculate_used_gas` may return an error

crates/forge/tests/e2e/running.rs

@@ -1052,11 +1052,13 @@ fn incompatible_snforge_std_version_warning() {
 
         Failure data:
             Could not reach the end of the program. RunResources has no remaining steps.
+            Suggestion: Consider using the flag `--max-n-steps` to increase allowed limit of steps
 
         [FAIL] steps::tests::steps_much_more_than_10000000
 
         Failure data:
             Could not reach the end of the program. RunResources has no remaining steps.
+            Suggestion: Consider using the flag `--max-n-steps` to increase allowed limit of steps
 
         [PASS] steps::tests::steps_less_than_10000000 [..]
         Tests: 2 passed, 2 failed, 0 skipped, 0 ignored, 0 filtered out

crates/forge/tests/e2e/steps.rs

@@ -26,21 +26,25 @@ fn should_allow_less_than_default() {
 
                 Failure data:
                     Could not reach the end of the program. RunResources has no remaining steps.
+                    Suggestion: Consider using the flag `--max-n-steps` to increase allowed limit of steps
 
                 [FAIL] steps::tests::steps_less_than_10000000
 
                 Failure data:
                     Could not reach the end of the program. RunResources has no remaining steps.
+                    Suggestion: Consider using the flag `--max-n-steps` to increase allowed limit of steps
 
                 [FAIL] steps::tests::steps_much_more_than_10000000
 
                 Failure data:
                     Could not reach the end of the program. RunResources has no remaining steps.
+                    Suggestion: Consider using the flag `--max-n-steps` to increase allowed limit of steps
 
                 [FAIL] steps::tests::steps_much_less_than_10000000
 
                 Failure data:
                     Could not reach the end of the program. RunResources has no remaining steps.
+                    Suggestion: Consider using the flag `--max-n-steps` to increase allowed limit of steps
 
                 Tests: 0 passed, 4 failed, 0 skipped, 0 ignored, 0 filtered out