Apply code review suggestions

Author: franciszekjob

CHANGELOG.md

@@ -11,7 +11,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 #### Added
 
-- `get_current_step` function to get the current step from Cairo VM during test execution. For more see [docs](https://foundry-rs.github.io/starknet-foundry/snforge-library/testing/get_current_step.html)
+- `get_current_vm_step` function to get the current step from Cairo VM during test execution. For more see [docs](https://foundry-rs.github.io/starknet-foundry/snforge-library/testing/get_current_vm_step.html)
 
 #### Changed
 

crates/cheatnet/src/runtime_extensions/forge_runtime_extension/mod.rs

@@ -554,26 +554,28 @@ impl<'a> ExtensionLogic for ForgeExtension<'a> {
                     .cheat_block_hash(block_number, operation);
                 Ok(CheatcodeHandlingResult::from_serializable(()))
             }
-            "get_current_step" => {
+            "get_current_vm_step" => {
                 let top_call = extended_runtime
                     .extended_runtime
                     .extension
                     .cheatnet_state
                     .trace_data
                     .current_call_stack
                     .top();
-
+                let vm_steps_from_calls = calculate_vm_steps_from_calls(&top_call);
                 let top_call_syscalls = &extended_runtime
                     .extended_runtime
                     .extended_runtime
                     .hint_handler
                     .base
                     .syscalls_usage;
+                let vm_steps_from_syscalls = &VersionedConstants::latest_constants()
+                    .get_additional_os_syscall_resources(top_call_syscalls)
+                    .n_steps;
+                let total_vm_steps =
+                    vm_steps_from_calls + vm_steps_from_syscalls + vm.get_current_step();
 
-                let steps_from_calls = calculate_steps_from_calls(&top_call, top_call_syscalls);
-                let total_steps = steps_from_calls + vm.get_current_step();
-
-                Ok(CheatcodeHandlingResult::from_serializable(total_steps))
+                Ok(CheatcodeHandlingResult::from_serializable(total_vm_steps))
             }
             _ => Ok(CheatcodeHandlingResult::Forwarded),
         }
@@ -882,9 +884,9 @@ pub fn get_all_used_resources(
     }
 }
 
-fn calculate_steps_from_calls(
+fn calculate_vm_steps_from_calls(
     top_call: &Rc<RefCell<CallTrace>>,
-    top_call_syscalls: &SyscallUsageMap,
+    // top_call_syscalls: &SyscallUsageMap,
 ) -> usize {
     // Resources from inner calls already include syscall resources used in them
     let used_resources =
@@ -898,9 +900,9 @@ fn calculate_steps_from_calls(
                 }
                 CallTraceNode::DeployWithoutConstructor => acc,
             });
-    let total_syscalls_exeucution_resources = &VersionedConstants::latest_constants()
-        .get_additional_os_syscall_resources(&top_call_syscalls);
-    let resources_from_calls = used_resources + total_syscalls_exeucution_resources;
+    // let total_syscalls_exeucution_resources = &VersionedConstants::latest_constants()
+    //     .get_additional_os_syscall_resources(&top_call_syscalls);
+    // let resources_from_calls = used_resources + total_syscalls_exeucution_resources;
 
-    resources_from_calls.n_steps
+    used_resources.n_steps
 }

crates/forge/tests/integration/get_current_step.rs renamed to crates/forge/tests/integration/get_current_vm_step.rs

@@ -6,21 +6,21 @@ use test_utils::running_tests::run_test_case;
 use test_utils::test_case;
 
 #[test]
-fn test_get_current_step() {
+fn test_get_current_vm_step() {
     let test = test_case!(
         indoc!(
             r#"
-            use snforge_std::testing::get_current_step;
+            use snforge_std::testing::get_current_vm_step;
             use snforge_std::{ContractClassTrait, DeclareResultTrait, declare};
 
             #[test]
             fn check_current_step() {
-                let step_start = get_current_step();
+                let step_start = get_current_vm_step();
 
                 let contract = declare("HelloStarknet").unwrap().contract_class().clone();
                 let _ = contract.deploy(@ArrayTrait::new()).unwrap();
 
-                let step_end = get_current_step();
+                let step_end = get_current_vm_step();
 
                 assert!(step_end > step_start);
             }

crates/forge/tests/integration/mod.rs

@@ -18,7 +18,7 @@ mod gas;
 mod generate_random_felt;
 mod get_available_gas;
 mod get_class_hash;
-mod get_current_step;
+mod get_current_vm_step;
 mod interact_with_state;
 mod l1_handler_executor;
 mod message_to_l1;

docs/listings/testing_reference/tests/tests.cairo

@@ -1,4 +1,4 @@
-use snforge_std::testing::get_current_step;
+use snforge_std::testing::get_current_vm_step;
 use snforge_std::{ContractClassTrait, DeclareResultTrait, declare};
 use testing_reference::{ICounterSafeDispatcher, ICounterSafeDispatcherTrait};
 
@@ -21,9 +21,9 @@ fn setup() {
 
 #[test]
 fn test_setup_steps() {
-    let steps_start = get_current_step();
+    let steps_start = get_current_vm_step();
     setup();
-    let steps_end = get_current_step();
+    let steps_end = get_current_vm_step();
 
     // Assert that setup used no more than 100 steps
     assert!(steps_end - steps_start <= 100);

docs/src/SUMMARY.md

@@ -130,7 +130,7 @@
     * [signature](appendix/snforge-library/signature.md)
     * [fuzzable](appendix/snforge-library/fuzzable.md)
     * [testing](appendix/snforge-library/testing.md)
-        * [get_current_step](appendix/snforge-library/testing/get_current_step.md)
+        * [get_current_vm_step](appendix/snforge-library/testing/get_current_vm_step.md)
 * [`sncast` Commands](appendix/sncast.md)
     * [common flags](appendix/sncast/common.md)
     * [account](appendix/sncast/account/account.md)

docs/src/appendix/snforge-library/testing.md

@@ -4,4 +4,4 @@ Module containing functions useful for testing.
 
 ## Functions
 
-* [`get_current_step`](./testing/get_current_step.md)
+* [`get_current_vm_step`](./testing/get_current_vm_step.md)

docs/src/appendix/snforge-library/testing/get_current_step.md renamed to docs/src/appendix/snforge-library/testing/get_current_vm_step.md

@@ -1,9 +1,9 @@
-# `get_current_step`
+# `get_current_vm_step`
 
 Gets the current step from Cairo VM during test execution.
 
 ```rust
-fn get_current_step() -> u32;
+fn get_current_vm_step() -> u32;
 ```
 
 ## Example

snforge_std/src/testing.cairo

@@ -1,6 +1,6 @@
 use crate::cheatcode::execute_cheatcode_and_deserialize;
 
 /// Gets the current step from Cairo VM during test execution
-pub fn get_current_step() -> u32 {
-    execute_cheatcode_and_deserialize::<'get_current_step', u32>(array![].span())
+pub fn get_current_vm_step() -> u32 {
+    execute_cheatcode_and_deserialize::<'get_current_vm_step', u32>(array![].span())
 }