feat: allow ignoring test failures from foreign calls #6660
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,29 +1,42 @@ | ||
| use std::path::PathBuf; | ||
|
|
||
| use acvm::{ | ||
| acir::{ | ||
| brillig::ForeignCallResult, | ||
| native_types::{WitnessMap, WitnessStack}, | ||
| }, | ||
| pwg::ForeignCallWaitInfo, | ||
| AcirField, BlackBoxFunctionSolver, FieldElement, | ||
| }; | ||
| use noirc_abi::Abi; | ||
| use noirc_driver::{compile_no_check, CompileError, CompileOptions}; | ||
| use noirc_errors::{debug_info::DebugInfo, FileDiagnostic}; | ||
| use noirc_frontend::hir::{def_map::TestFunction, Context}; | ||
| use noirc_printable_type::ForeignCallError; | ||
| use rand::Rng; | ||
| use serde::{Deserialize, Serialize}; | ||
|
|
||
| use crate::{ | ||
| errors::try_to_diagnose_runtime_error, | ||
| foreign_calls::{ | ||
| mocker::MockForeignCallExecutor, print::PrintForeignCallExecutor, | ||
| rpc::RPCForeignCallExecutor, DefaultForeignCallExecutor, ForeignCall, ForeignCallExecutor, | ||
| }, | ||
| NargoError, | ||
| }; | ||
|
|
||
| use super::execute_program; | ||
|
|
||
| pub enum TestStatus { | ||
| Pass, | ||
| Fail { message: String, error_diagnostic: Option<FileDiagnostic> }, | ||
| Skipped, | ||
| CompileError(FileDiagnostic), | ||
| } | ||
|
|
||
| impl TestStatus { | ||
| pub fn failed(&self) -> bool { | ||
| !matches!(self, TestStatus::Pass | TestStatus::Skipped) | ||
| } | ||
| } | ||
|
|
||
|
|
@@ -50,23 +63,42 @@ pub fn run_test<B: BlackBoxFunctionSolver<FieldElement>>( | |
| if test_function_has_no_arguments { | ||
| // Run the backend to ensure the PWG evaluates functions like std::hash::pedersen, | ||
| // otherwise constraints involving these expressions will not error. | ||
| let mut foreign_call_executor = TestForeignCallExecutor::new( | ||
| show_output, | ||
| foreign_call_resolver_url, | ||
| root_path, | ||
| package_name, | ||
| ); | ||
|
|
||
| let circuit_execution = execute_program( | ||
| &compiled_program.program, | ||
| WitnessMap::new(), | ||
| blackbox_solver, | ||
| &mut foreign_call_executor, | ||
| ); | ||
|
|
||
| let status = test_status_program_compile_pass( | ||
| test_function, | ||
| compiled_program.abi, | ||
| compiled_program.debug, | ||
| circuit_execution, | ||
| ); | ||
|
|
||
| let ignore_foreign_call_failures = | ||
| std::env::var("NARGO_IGNORE_TEST_FAILURES_FROM_FOREIGN_CALLS") | ||
| .is_ok_and(|var| &var == "true"); | ||
|
|
||
| if let TestStatus::Fail { .. } = status { | ||
| if ignore_foreign_call_failures | ||
| && foreign_call_executor.encountered_unknown_foreign_call | ||
| { | ||
| TestStatus::Skipped | ||
| } else { | ||
| status | ||
| } | ||
| } else { | ||
| status | ||
| } | ||
| } else { | ||
| #[cfg(target_arch = "wasm32")] | ||
| { | ||
|
|
@@ -217,3 +249,93 @@ fn check_expected_failure_message( | |
| error_diagnostic, | ||
| } | ||
| } | ||
|
|
||
| /// A specialized foreign call executor which tracks whether it has encountered any unknown foreign calls | ||
| struct TestForeignCallExecutor<F> { | ||
| /// The executor for any [`ForeignCall::Print`] calls. | ||
| printer: Option<PrintForeignCallExecutor>, | ||
| mocker: MockForeignCallExecutor<F>, | ||
| external: Option<RPCForeignCallExecutor>, | ||
|
|
||
| encountered_unknown_foreign_call: bool, | ||
| } | ||
|
|
||
| impl<F: Default> TestForeignCallExecutor<F> { | ||
| fn new( | ||
| show_output: bool, | ||
| resolver_url: Option<&str>, | ||
| root_path: Option<PathBuf>, | ||
| package_name: Option<String>, | ||
| ) -> Self { | ||
| let id = rand::thread_rng().gen(); | ||
| let printer = if show_output { Some(PrintForeignCallExecutor) } else { None }; | ||
| let external_resolver = resolver_url.map(|resolver_url| { | ||
| RPCForeignCallExecutor::new(resolver_url, id, root_path, package_name) | ||
| }); | ||
| TestForeignCallExecutor { | ||
| printer, | ||
| mocker: MockForeignCallExecutor::default(), | ||
| external: external_resolver, | ||
| encountered_unknown_foreign_call: false, | ||
| } | ||
| } | ||
| } | ||
|
|
||
| impl<F: AcirField + Serialize + for<'a> Deserialize<'a>> ForeignCallExecutor<F> | ||
| for TestForeignCallExecutor<F> | ||
| { | ||
| fn execute( | ||
| &mut self, | ||
| foreign_call: &ForeignCallWaitInfo<F>, | ||
| ) -> Result<ForeignCallResult<F>, ForeignCallError> { | ||
| // If the circuit has reached a new foreign call opcode then it must have | ||
TomAFrench marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
TomAFrench marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| self.encountered_unknown_foreign_call = false; | ||
|
|
||
| let foreign_call_name = foreign_call.function.as_str(); | ||
| match ForeignCall::lookup(foreign_call_name) { | ||
| Some(ForeignCall::Print) => { | ||
| if let Some(printer) = &mut self.printer { | ||
| printer.execute(foreign_call) | ||
| } else { | ||
| Ok(ForeignCallResult::default()) | ||
| } | ||
| } | ||
|
|
||
| Some( | ||
| ForeignCall::CreateMock | ||
| | ForeignCall::SetMockParams | ||
| | ForeignCall::GetMockLastParams | ||
| | ForeignCall::SetMockReturns | ||
| | ForeignCall::SetMockTimes | ||
| | ForeignCall::ClearMock, | ||
| ) => self.mocker.execute(foreign_call), | ||
|
|
||
| None => { | ||
| // First check if there's any defined mock responses for this foreign call. | ||
| match self.mocker.execute(foreign_call) { | ||
| Err(ForeignCallError::NoHandler(_)) => (), | ||
| response_or_error => return response_or_error, | ||
| }; | ||
|
|
||
| if let Some(external_resolver) = &mut self.external { | ||
| // If the user has registered an external resolver then we forward any remaining oracle calls there. | ||
| match external_resolver.execute(foreign_call) { | ||
| Err(ForeignCallError::NoHandler(_)) => (), | ||
| response_or_error => return response_or_error, | ||
| }; | ||
| } | ||
|
|
||
| self.encountered_unknown_foreign_call = true; | ||
|
Contributor
There was a problem hiding this comment. Maybe it would be helpful to allow a message to be attached to the test failure status, so that it can hint at why something has been skipped, e.g. the foreign function that could not be found. |
||
|
|
||
| // If all executors have no handler for the given foreign call then we cannot | ||
| // return a correct response to the ACVM. The best we can do is to return an empty response, | ||
| // this allows us to ignore any foreign calls which exist solely to pass information from inside | ||
| // the circuit to the environment (e.g. custom logging) as the execution will still be able to progress. | ||
| // | ||
| // We optimistically return an empty response for all oracle calls as the ACVM will error | ||
| // should a response have been required. | ||
| Ok(ForeignCallResult::default()) | ||
| } | ||
| } | ||
| } | ||
| } | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.