1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536
// This file is part of Gear.
// Copyright (C) 2021-2024 Gear Technologies Inc.
// SPDX-License-Identifier: GPL-3.0-or-later WITH Classpath-exception-2.0
// This program is free software: you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
// This program is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
// GNU General Public License for more details.
// You should have received a copy of the GNU General Public License
// along with this program. If not, see <https://www.gnu.org/licenses/>.
//! # Testing with `gtest`
//!
//! `gtest` simulates a real network by providing mockups of the user, program,
//! balances, mailbox, etc. Since it does not include parts of the actual
//! blockchain, it is fast and lightweight. But being a model of the blockchain
//! network, `gtest` cannot be a complete reflection of the latter.
//!
//! As we said earlier, `gtest` is excellent for unit and integration testing.
//! It is also helpful for debugging Gear program logic. Nothing other than the
//! Rust compiler is required for running tests based on `gtest`. It is
//! predictable and robust when used in continuous integration.
//!
//! ## Main concepts
//!
//! `gtest` is a library that provides a set of tools for testing Gear programs.
//! The most important structures are:
//!
//! - [`System`] — a structure that represents the environment of the Gear
//! network. It contains the current block number, timestamp, and other
//! parameters. It also stores the mailbox and the list of programs.
//! - [`Program`] — a structure that represents a Gear program. It contains the
//! information about program and allows sending messages to other programs.
//! - [`Log`] — a structure that represents a message log. It allows checking
//! the result of the program execution.
//!
//! Let's take a closer look at how to write tests using `gtest`.
//!
//! ## Import `gtest` lib
//!
//! To use the `gtest` library, you must import it into your `Cargo.toml` file
//! in the `[dev-dependencies]` block to fetch and compile it for tests only:
//!
//! ```toml
//! [package]
//! name = "my-gear-app"
//! version = "0.1.0"
//! authors = ["Your Name"]
//! edition = "2021"
//!
//! [dependencies]
//! gstd = { git = "https://github.com/gear-tech/gear.git", tag = "v1.0.1" }
//!
//! [build-dependencies]
//! gear-wasm-builder = { git = "https://github.com/gear-tech/gear.git", tag = "v1.0.1" }
//!
//! [dev-dependencies]
//! gtest = { git = "https://github.com/gear-tech/gear.git", tag = "v1.0.1" }
//! ```
//!
//! ## Program example
//!
//! Let's write a simple program that will receive a message and reply to it.
//!
//! `lib.rs`:
//!
//! ```ignore
//! #![no_std]
//! use gstd::msg;
//!
//! #[no_mangle]
//! extern "C" fn handle() {
//! let payload = msg::load_bytes().expect("Failed to load payload");
//!
//! if payload == b"PING" {
//! msg::reply_bytes(b"PONG", 0).expect("Failed to send reply");
//! }
//! }
//! ```
//!
//! `build.rs`:
//!
//! ```ignore
//! fn main() {
//! gear_wasm_builder::build();
//! }
//! ```
//!
//! We will add a test that will check the program's behavior. To do this, we
//! will use the `gtest` library.
//!
//! Our test will consist of the following steps:
//!
//! 1. Initialize the `System` structure.
//! 2. Initialize the `Program` structure.
//! 3. Send an init message to the program. Even though we don't have the `init`
//! function in our program, the first message to the program sent via
//! `gtest` is always the init one.
//! 4. Send a handle message to the program.
//! 5. Check the result of the program execution.
//!
//! Add these lines to the bottom of the `lib.rs` file:
//!
//! ```no_run
//! #[cfg(test)]
//! mod tests {
//! use gtest::{Log, Program, System};
//!
//! const USER_ID: u64 = 100001;
//!
//! #[test]
//! fn test_ping_pong() {
//! // Initialization of the common environment for running programs.
//! let sys = System::new();
//!
//! // Initialization of the current program structure.
//! let prog = Program::current(&sys);
//!
//! // Send an init message to the program.
//! let res = prog.send_bytes(USER_ID, b"Doesn't matter");
//!
//! // Check whether the program was initialized successfully.
//! assert!(!res.main_failed());
//!
//! // Send a handle message to the program.
//! let res = prog.send_bytes(USER_ID, b"PING");
//!
//! // Check the result of the program execution.
//! // 1. Create a log pattern with the expected result.
//! let log = Log::builder()
//! .source(prog.id())
//! .dest(USER_ID)
//! .payload_bytes(b"PONG");
//!
//! // 2. Check whether the program was executed successfully.
//! assert!(!res.main_failed());
//!
//! // 3. Make sure the log entry is in the result.
//! assert!(res.contains(&log));
//! }
//! }
//! ```
//!
//! To run the test, use the following command:
//!
//! ```bash
//! cargo test
//! ```
//!
//! # `gtest` capabilities
//!
//! Let's take a closer look at the `gtest` capabilities.
//!
//! ## Initialization of the network environment for running programs
//!
//! ```no_run
//! # use gtest::System;
//! let sys = System::new();
//! ```
//!
//! This emulates node's and chain's behavior. By default, the [`System::new`]
//! function sets the following parameters:
//!
//! - current block equals `0`
//! - current timestamp equals UNIX timestamp of your system
//! - starting message id equals `0x010000..`
//! - starting program id equals `0x010000..`
//!
//! ## Program initialization
//!
//! There are a few ways to initialize a program:
//!
//! - Initialize the current program using the [`Program::current`] function:
//!
//! ```no_run
//! # use gtest::Program;
//! # let sys = gtest::System::new();
//! let prog = Program::current(&sys);
//! ```
//!
//! - Initialize a program from a Wasm-file with a default id using the
//! [`Program::from_file`] function:
//!
//! ```no_run
//! # use gtest::Program;
//! # let sys = gtest::System::new();
//! let prog = Program::from_file(
//! &sys,
//! "./target/wasm32-unknown-unknown/release/demo_ping.wasm",
//! );
//! ```
//!
//! - Initialize a program via builder:
//!
//! ```no_run
//! # use gtest::ProgramBuilder;
//! # let sys = gtest::System::new();
//! let prog = ProgramBuilder::from_file("your_gear_program.wasm")
//! .with_id(105)
//! .build(&sys);
//! ```
//!
//! Every place in this lib, where you need to specify some ids, it requires
//! generic type `ID`, which implements ``Into<ProgramIdWrapper>``.
//!
//! `ProgramIdWrapper` may be built from:
//! - `u64`
//! - `[u8; 32]`
//! - `String`
//! - `&str`
//! - [`ProgramId`](https://docs.gear.rs/gear_core/ids/struct.ProgramId.html)
//! (from `gear_core` one's, not from `gstd`).
//!
//! `String` implementation means the input as hex (with or without "0x").
//!
//! ## Getting the program from the system
//!
//! If you initialize program not in this scope, in cycle, in other conditions,
//! where you didn't save the structure, you may get the object from the system
//! by id.
//!
//! ```no_run
//! # let sys = gtest::System::new();
//! let prog = sys.get_program(105).unwrap();
//! ```
//!
//! ## Initialization of styled `env_logger`
//!
//! Initialization of styled `env_logger` to print logs (only from `gwasm` by
//! default) into stdout:
//!
//! ```no_run
//! # let sys = gtest::System::new();
//! sys.init_logger();
//! ```
//!
//! To specify printed logs, set the env variable `RUST_LOG`:
//!
//! ```bash
//! RUST_LOG="target_1=logging_level,target_2=logging_level" cargo test
//! ```
//!
//! ## Sending messages
//!
//! To send message to the program need to call one of two program's functions:
//!
//! - [`Program::send`] (or [`Program::send_with_value`] if you need to send a
//! message with attached funds).
//! - [`Program::send_bytes`] (or [`Program::send_bytes_with_value`] if you need
//! to send a message with attached funds).
//!
//! Both of the methods require sender id as the first argument and the payload
//! as second.
//!
//! The difference between them is pretty simple and similar to [`gstd`](https://docs.gear.rs/gstd/) functions [`msg::send`](https://docs.gear.rs/gstd/msg/fn.send.html) and [`msg::send_bytes`](https://docs.gear.rs/gstd/msg/fn.send_bytes.html).
//!
//! The first one requires payload to be CODEC Encodable, while the second
//! requires payload implement `AsRef<[u8]>`, that means to be able to represent
//! as bytes.
//!
//! [`Program::send`] uses [`Program::send_bytes`] under the hood with bytes
//! from `payload.encode()`.
//!
//! First message to the initialized program structure is always the init
//! message.
//!
//! ```no_run
//! # let sys = gtest::System::new();
//! # let prog = gtest::Program::current(&sys);
//! let res = prog.send_bytes(100001, "INIT MESSAGE");
//! ```
//!
//! ## Processing the result of the program execution
//!
//! Any sending functions in the lib returns [`RunResult`] structure.
//!
//! It contains the final result of the processing message and others, which
//! were created during the execution.
//!
//! It has 4 main functions:
//!
//! - [`RunResult::log`] — returns the reference to the Vec produced to users
//! messages. You may assert them as you wish, iterating through them.
//! - [`RunResult::main_failed`] — returns bool which shows that there was panic
//! during the execution of the main message.
//! - [`RunResult::others_failed`] — returns bool which shows that there was
//! panic during the execution of the created messages during the main
//! execution. Equals false if no others were called.
//! - [`RunResult::contains`] — returns bool which shows that logs contain a
//! given log. Syntax sugar around `res.log().iter().any(|v| v == arg)`.
//!
//! To build a log for assertion you need to use [`Log`] structure with its
//! builders. All fields here are optional. Assertion with `Log`s from core are
//! made on the `Some(..)` fields. You will run into panic if you try to set the
//! already specified field.
//!
//! ```no_run
//! # use gtest::Log;
//! # use gear_core_errors::ErrorReplyReason;
//! // Constructor for success log.
//! let log = Log::builder();
//!
//! // Constructor for error reply log.
//! let log = Log::error_builder(ErrorReplyReason::InactiveActor);
//! # let sys = gtest::System::new();
//! # let prog = gtest::Program::current(&sys);
//! // Other fields are set optionally by `dest()`, `source()`, `payload()`, `payload_bytes()`.
//! let log = Log::builder()
//! .source(prog.id())
//! .dest(100001)
//! .payload_bytes("PONG");
//! ```
//!
//! Log also has `From` implementations from `(ID, T)` and from `(ID_1, ID_2,
//! T)`, where `ID: Into<ProgramIdWrapper>`, `T: AsRef<[u8]>`.
//!
//! ```no_run
//! # use gtest::Log;
//! let x = Log::builder().dest(5).payload_bytes("A");
//! let x_from: Log = (5, "A").into();
//! assert_eq!(x, x_from);
//!
//! let y = Log::builder().dest(5).source(15).payload_bytes("A");
//! let y_from: Log = (15, 5, "A").into();
//! assert_eq!(y, y_from);
//! ```
//!
//! ## Spending blocks
//!
//! You may control time in the system by spending blocks.
//!
//! It adds the amount of blocks passed as arguments to the current block of the
//! system. Same for the timestamp. Note, that for now 1 block in Gear-based
//! network is 3 sec duration.
//!
//! ```no_run
//! # let sys = gtest::System::new();
//! // Spend 150 blocks (7.5 mins for 3 sec block).
//! sys.spend_blocks(150);
//! ```
//!
//! Note that processing messages (e.g. by using
//! [`Program::send`]/[`Program::send_bytes`] methods) doesn't spend blocks, nor
//! changes the timestamp. If you write time dependent logic, you should spend
//! blocks manually.
//!
//! ## Balance:
//!
//! ```no_run
//! # use gtest::Program;
//! # let sys = gtest::System::new();
//! // If you need to send a message with value you have to mint balance for the message sender:
//! let user_id = 42;
//! sys.mint_to(user_id, 5000);
//! assert_eq!(sys.balance_of(user_id), 5000);
//!
//! // To give the balance to the program you should use `mint` method:
//! let mut prog = Program::current(&sys);
//! prog.mint(1000);
//! assert_eq!(prog.balance(), 1000);
//! ```
//!
//! <!--
//! - Reading the program state:
//! ```ignore
//! // To read the program state you need to call one of two program's functions:
//! // `meta_state()` or `meta_state_with_bytes()`.
//! //
//! // The methods require the payload as the input argument.
//! //
//! // The first one requires payload to be CODEC Encodable, while the second requires payload
//! // implement `AsRef<[u8]>`, that means to be able to represent as bytes.
//! //
//! // Let we have the following program state and `meta_state` function:
//! #[derive(Encode, Decode, TypeInfo)]
//! pub struct ProgramState {
//! a: u128,
//! b: u128,
//! }
//!
//! pub enum State {
//! A,
//! B,
//! }
//!
//! pub enum StateReply {
//! A(u128),
//! B(u128),
//! }
//!
//! #[no_mangle]
//! unsafe extern "C" fn meta_state() -> *mut [i32; 2] {
//! let query: State = msg::load().expect("Unable to decode `State`");
//! let encoded = match query {
//! State::A => StateReply::A(STATE.a),
//! State::B => StateReply::B(STATE.b),
//! }
//! .encode();
//! gstd::util::to_leak_ptr(encoded)
//! }
//!
//! // Let's send a query from gtest:
//! let reply: StateReply = self.meta_state(&State::A).expect("Meta_state failed");
//! let expected_reply = StateReply::A(10);
//! assert_eq!(reply, expected_reply);
//!
//! // If your `meta_state` function doesn't require input payloads,
//! // you can use `meta_state_empty` or `meta_state_empty_with_bytes` functions
//! // without any arguments.
//! ```
//! -->
#![deny(missing_docs)]
#![doc(html_logo_url = "https://docs.gear.rs/logo.svg")]
#![doc(html_favicon_url = "https://gear-tech.io/favicons/favicon.ico")]
mod blocks;
mod error;
mod gas_tree;
mod log;
mod mailbox;
mod manager;
mod program;
mod system;
pub use crate::log::{CoreLog, Log, RunResult};
pub use codec;
pub use error::{Result, TestError};
pub use mailbox::ActorMailbox;
pub use program::{
calculate_program_id, gbuild::ensure_gbuild, Gas, Program, ProgramBuilder, ProgramIdWrapper,
WasmProgram,
};
pub use system::System;
pub(crate) use constants::*;
/// Module containing constants of Gear protocol.
pub mod constants {
/* Constant types */
use gear_common::GasMultiplier;
/// Numeric type representing value in Gear protocol.
pub type Value = u128;
/// Numeric type representing gas in Gear protocol.
pub type Gas = u64;
/// Numeric type representing blocks in Gear protocol.
pub type Block = u32;
/* Gas logic related constants */
/// Gas allowance for executing user dispatch and set of generated
/// by programs dispatches from execution of the user dispatch.
pub const GAS_ALLOWANCE: Gas = 750_000_000_000;
/// Gas multiplier used to calculate equivalence of gas in token value.
pub const GAS_MULTIPLIER: GasMultiplier<Value, Gas> = GasMultiplier::ValuePerGas(6);
/* Currency-related constants */
/// Value per token.
pub const UNITS: Value = 1_000_000_000_000;
/// Minimal amount of value able to be sent. Defines accounts existence
/// requirement.
pub const EXISTENTIAL_DEPOSIT: Value = UNITS;
/// Value per gas.
pub const VALUE_PER_GAS: Value = 6;
/// Duration of one block in msecs.
pub const BLOCK_DURATION_IN_MSECS: u64 = 3000;
/// Duration of one epoch.
pub const EPOCH_DURATION_IN_BLOCKS: Block = 600;
/* Storage-related constants */
// TODO: use proper weights of db accesses (#3509).
/// Minimal amount of gas required to be inserted into Mailbox.
pub const MAILBOX_THRESHOLD: Gas = 3_000;
/// Extra amount of blocks must be reserved for storing in storage.
pub const RESERVE_FOR: Block = 1;
/// Cost of read access into storage.
pub const READ_COST: Gas = 25;
/// Per-byte extra cost of read access into storage.
pub const READ_PER_BYTE_COST: Gas = 10;
/// Cost of write access into storage.
pub const WRITE_COST: Gas = 100;
/// Per-byte extra cost of write access into storage.
pub const WRITE_PER_BYTE_COST: Gas = 10;
/* Rent-related constants */
/// Cost of storing waitlisted message per block.
pub const WAITLIST_COST: Gas = 100;
/// Cost of storing reservation per block.
pub const RESERVATION_COST: Gas = 100;
/// Cost of storing delayed message per block.
pub const DISPATCH_HOLD_COST: Gas = 100;
/* Execution-related constants */
// TODO: use proper weights of instantiation and instrumentation (#3509).
/// Maximal amount of reservations program may have.
pub const MAX_RESERVATIONS: u64 = 256;
/// Cost of wasm module code section instantiation before execution per byte
/// of code.
pub const MODULE_CODE_SECTION_INSTANTIATION_BYTE_COST: Gas = 192;
/// Cost of wasm module data section instantiation before execution per byte
/// of code.
pub const MODULE_DATA_SECTION_INSTANTIATION_BYTE_COST: Gas = 452;
/// Cost of wasm module global section instantiation before execution per
/// byte of code.
pub const MODULE_GLOBAL_SECTION_INSTANTIATION_BYTE_COST: Gas = 2360;
/// Cost of wasm module table section instantiation before execution per
/// byte of code.
pub const MODULE_TABLE_SECTION_INSTANTIATION_BYTE_COST: Gas = 350;
/// Cost of wasm module element section instantiation before execution per
/// byte of code.
pub const MODULE_ELEMENT_SECTION_INSTANTIATION_BYTE_COST: Gas = 18492;
/// Cost of wasm module type section instantiation before execution per byte
/// of code.
pub const MODULE_TYPE_SECTION_INSTANTIATION_BYTE_COST: Gas = 254;
/// Cost of instrumenting wasm code on upload.
pub const MODULE_INSTRUMENTATION_COST: Gas = 297;
/// Cost of instrumenting wasm code on upload per byte of code.
pub const MODULE_INSTRUMENTATION_BYTE_COST: Gas = 13;
/// Initial random seed for testing environment.
pub const INITIAL_RANDOM_SEED: u64 = 42;
}