aquavm/crates/test-utils/src/lib.rs

/*
 * Copyright 2020 Fluence Labs Limited
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

#![warn(rust_2018_idioms)]
#![deny(
    dead_code,
    nonstandard_style,
    unused_imports,
    unused_mut,
    unused_variables,
    unused_unsafe,
    unreachable_patterns
)]

pub mod executed_state;

pub use avm_server::ne_vec::NEVec;
pub use avm_server::AVMConfig;
pub use avm_server::AVMError;
pub use avm_server::CallServiceClosure;
pub use avm_server::IType;
pub use avm_server::IValue;
pub use avm_server::InterpreterOutcome;
pub use avm_server::ParticleParameters;
pub use avm_server::AVM;

pub use air::execution_trace::ExecutionTrace;

use std::collections::HashMap;
use std::path::PathBuf;

pub(self) type JValue = serde_json::Value;

pub fn create_avm(call_service: CallServiceClosure, current_peer_id: impl Into<String>) -> AVM {
    let tmp_dir = std::env::temp_dir();

    let config = AVMConfig {
        air_wasm_path: PathBuf::from("../target/wasm32-wasi/debug/air_interpreter_server.wasm"),
        call_service,
        current_peer_id: current_peer_id.into(),
        vault_dir: tmp_dir.join("vault"),
        particle_data_store: tmp_dir,
        logging_mask: i32::MAX,
    };

    AVM::new(config).expect("vm should be created")
}

pub fn unit_call_service() -> CallServiceClosure {
    Box::new(|_| -> Option<IValue> {
        Some(IValue::Record(
            NEVec::new(vec![
                IValue::S32(0),
                IValue::String(String::from("\"test\"")),
            ])
            .unwrap(),
        ))
    })
}

pub fn echo_string_call_service() -> CallServiceClosure {
    Box::new(|args| -> Option<IValue> {
        let arg = match &args.function_args[2] {
            IValue::String(str) => str,
            _ => unreachable!(),
        };

        let arg: Vec<String> = serde_json::from_str(arg).unwrap();
        let arg = serde_json::to_string(&arg[0]).unwrap();

        Some(IValue::Record(
            NEVec::new(vec![IValue::S32(0), IValue::String(arg)]).unwrap(),
        ))
    })
}

pub fn echo_number_call_service() -> CallServiceClosure {
    Box::new(|args| -> Option<IValue> {
        let arg = match &args.function_args[2] {
            IValue::String(str) => str,
            _ => unreachable!(),
        };

        let arg: Vec<String> = serde_json::from_str(arg).unwrap();

        Some(IValue::Record(
            NEVec::new(vec![IValue::S32(0), IValue::String(arg[0].clone())]).unwrap(),
        ))
    })
}

pub fn set_variable_call_service(json: impl Into<String>) -> CallServiceClosure {
    let json = json.into();
    Box::new(move |_| -> Option<IValue> {
        Some(IValue::Record(
            NEVec::new(vec![IValue::S32(0), IValue::String(json.clone())]).unwrap(),
        ))
    })
}

pub fn set_variables_call_service(ret_mapping: HashMap<String, String>) -> CallServiceClosure {
    Box::new(move |args| -> Option<IValue> {
        let arg_name = match &args.function_args[2] {
            IValue::String(json_str) => {
                let json = serde_json::from_str(json_str).expect("a valid json");
                match json {
                    JValue::Array(array) => match array.first() {
                        Some(JValue::String(str)) => str.to_string(),
                        _ => String::from("default"),
                    },
                    _ => String::from("default"),
                }
            }
            _ => String::from("default"),
        };

        let result = ret_mapping
            .get(&arg_name)
            .cloned()
            .unwrap_or_else(|| String::from(r#""test""#));

        Some(IValue::Record(
            NEVec::new(vec![IValue::S32(0), IValue::String(result)]).unwrap(),
        ))
    })
}

pub fn fallible_call_service(fallible_service_id: impl Into<String>) -> CallServiceClosure {
    let fallible_service_id = fallible_service_id.into();

    Box::new(move |args| -> Option<IValue> {
        let builtin_service = match &args.function_args[0] {
            IValue::String(str) => str,
            _ => unreachable!(),
        };

        // return a error for service with such id
        if builtin_service == &fallible_service_id {
            Some(IValue::Record(
                NEVec::new(vec![IValue::S32(1), IValue::String(String::from("error"))]).unwrap(),
            ))
        } else {
            // return success for services with other ids
            Some(IValue::Record(
                NEVec::new(vec![
                    IValue::S32(0),
                    IValue::String(String::from(r#""res""#)),
                ])
                .unwrap(),
            ))
        }
    })
}

#[macro_export]
macro_rules! call_vm {
    ($vm:expr, $init_peer_id:expr, $script:expr, $prev_data:expr, $data:expr) => {
        match $vm.call_with_prev_data($init_peer_id, $script, $prev_data, $data) {
            Ok(v) => v,
            Err(err) => panic!("VM call failed: {}", err),
        }
    };
}