fvm_integration_tests 4.8.2

Filecoin Virtual Machine integration tests framework
Documentation
// Copyright 2021-2023 Protocol Labs
// SPDX-License-Identifier: Apache-2.0, MIT
use fvm::call_manager::backtrace::Cause;
use fvm::executor::{ApplyFailure, ApplyKind, Executor};
use fvm_integration_tests::dummy::DummyExterns;
use fvm_integration_tests::tester::{Account, Tester};
use fvm_ipld_blockstore::MemoryBlockstore;
use fvm_ipld_encoding::RawBytes;
use fvm_ipld_encoding::tuple::*;
use fvm_shared::address::Address;
use fvm_shared::econ::TokenAmount;
use fvm_shared::error::ErrorNumber;
use fvm_shared::message::Message;
use fvm_shared::state::StateTreeVersion;
use fvm_shared::version::NetworkVersion;
use fvm_test_actors::wasm_bin::MALFORMED_SYSCALL_ACTOR_BINARY;
use num_traits::Zero;

mod bundles;
use bundles::*;

const WAT_UNKNOWN_SYSCALL: &str = r#"
    (module
        (type $t0 (func))
        (type $t1 (func (param i32) (result i32)))
        ;; Non existing syscall
        (import "vm" "do_not_exist" (func $fvm_sdk::sys::vm::do_not_exist::syscall (type $t0)))
        (func $invoke (export "invoke") (type $t1) (param $p0 i32) (result i32)
            (call $fvm_sdk::sys::vm::do_not_exist::syscall)
            (unreachable))
        (memory $memory (export "memory") 16)
        (global $__data_end (export "__data_end") i32 (i32.const 1048576))
        (global $__heap_base (export "__heap_base") i32 (i32.const 1048576)))
    "#;

#[derive(Serialize_tuple, Deserialize_tuple, Clone, Debug, Default)]
pub struct State {
    pub count: i64,
}

// Utility function to instantiation integration tester
fn instantiate_tester(
    wasm_bin: &[u8],
) -> (Account, Tester<MemoryBlockstore, DummyExterns>, Address) {
    // Instantiate tester
    let mut tester = new_tester(
        NetworkVersion::V21,
        StateTreeVersion::V5,
        MemoryBlockstore::default(),
    )
    .unwrap();

    let sender: [Account; 1] = tester.create_accounts().unwrap();

    // Set actor state
    let actor_state = State::default();
    let state_cid = tester.set_state(&actor_state).unwrap();

    // Set actor
    let actor_address = Address::new_id(10000);

    tester
        .set_actor_from_bin(wasm_bin, state_cid, actor_address, TokenAmount::zero())
        .unwrap();

    (sender[0], tester, actor_address)
}

#[test]
fn non_existing_syscall() {
    // Get wasm bin
    let wasm_bin = wat::parse_str(WAT_UNKNOWN_SYSCALL).unwrap();

    // Instantiate tester
    let (sender, mut tester, actor_address) = instantiate_tester(&wasm_bin);

    // Instantiate machine
    tester.instantiate_machine(DummyExterns).unwrap();

    // Params setup
    let params = RawBytes::new(Vec::<u8>::new());

    // Send message to set
    let message = Message {
        from: sender.1,
        to: actor_address,
        gas_limit: 1000000000,
        method_num: 1,
        params,
        ..Message::default()
    };

    // Set inner state value
    let res = tester
        .executor
        .as_mut()
        .unwrap()
        .execute_message(message, ApplyKind::Explicit, 100)
        .unwrap();

    // Should be an internal VM assertion failed exit code
    assert_eq!(
        res.msg_receipt.exit_code.value(),
        10,
        "exit code should be internal VM assertion failed"
    );

    // Should be unknown import
    match res.failure_info.as_ref().unwrap() {
        ApplyFailure::MessageBacktrace(backtrace) => {
            assert!(
                backtrace
                    .cause
                    .as_ref()
                    .unwrap()
                    .to_string()
                    .contains("unknown import"),
                "error cause should be unknown import"
            );
        }
        _ => panic!("transaction result should have a backtrace"),
    }
}

#[test]
fn malformed_syscall_parameter() {
    // Get wasm bin
    let wasm_bin = MALFORMED_SYSCALL_ACTOR_BINARY;

    // Instantiate tester
    let (sender, mut tester, actor_address) = instantiate_tester(wasm_bin);

    // Instantiate machine
    tester.instantiate_machine(DummyExterns).unwrap();

    // Params setup
    let params = RawBytes::new(Vec::<u8>::new());

    // Send message to set
    let message = Message {
        from: sender.1,
        to: actor_address,
        gas_limit: 1000000000,
        method_num: 1,
        params,
        ..Message::default()
    };

    // Set inner state value
    let res = tester
        .executor
        .as_mut()
        .unwrap()
        .execute_message(message, ApplyKind::Explicit, 100)
        .unwrap();

    // Actor should panic
    assert_eq!(res.msg_receipt.exit_code.value(), 4);

    // Should have failed with an invalid proof type message.
    match res.failure_info.as_ref().unwrap() {
        ApplyFailure::MessageBacktrace(backtrace) => match backtrace.cause.as_ref().unwrap() {
            Cause::Syscall { error, message, .. } => {
                assert!(message.contains("invalid proof type"));

                match error {
                    ErrorNumber::IllegalArgument => {}
                    _ => panic!("error type should be IllegalArgument"),
                }
            }
            _ => panic!("failure cause should be syscall"),
        },
        _ => panic!("transaction result should have a backtrace"),
    }
}