gtest 1.5.1

Testing utils for developing Gear programs.
Documentation 
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

// This file is part of Gear.

// Copyright (C) 2022-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/>.

use codec::Error as CodecError;
use gear_core::{ids::ProgramId, pages::WasmPage};
use gear_core_errors::ExtError;

/// Type alias for the testing functions running result.
pub type Result<T, E = TestError> = core::result::Result<T, E>;

/// List of general errors.
#[derive(Debug, derive_more::Display, derive_more::From)]
pub enum TestError {
    /// Invalid return type after execution.
    #[display(fmt = "Invalid return type after execution")]
    InvalidReturnType,

    /// Function not found in executor.
    #[from(ignore)]
    #[display(fmt = "Function not found in executor: `{_0}`")]
    FunctionNotFound(String),

    /// Actor not found.
    #[from(ignore)]
    #[display(fmt = "Actor not found: `{_0}`")]
    ActorNotFound(ProgramId),

    /// Actor is not executable.
    #[from(ignore)]
    #[display(fmt = "Actor is not executable: `{_0}`")]
    ActorIsNotExecutable(ProgramId),

    /// Meta WASM binary hasn't been provided.
    #[display(fmt = "Meta WASM binary hasn't been provided")]
    MetaBinaryNotProvided,

    /// Insufficient memory.
    #[display(fmt = "Insufficient memory: available {_0:?} < requested {_1:?}")]
    InsufficientMemory(WasmPage, WasmPage),

    /// Invalid import module.
    #[from(ignore)]
    #[display(fmt = "Invalid import module: `{_0}` instead of `env`")]
    InvalidImportModule(String),

    /// Failed to call unsupported function.
    #[from(ignore)]
    #[display(fmt = "Failed to call unsupported function: `{_0}`")]
    UnsupportedFunction(String),

    /// Wrapper for [`ExtError`].
    #[display(fmt = "{_0}")]
    ExecutionError(ExtError),

    /// Wrapper for [`wasmi::Error`](https://paritytech.github.io/wasmi/wasmi/enum.Error.html).
    #[display(fmt = "{_0}")]
    MemoryError(gear_core_errors::MemoryError),

    /// Wrapper for [`parity_scale_codec::Error`](https://docs.rs/parity-scale-codec/latest/parity_scale_codec/struct.Error.html).
    #[display(fmt = "{_0}")]
    ScaleCodecError(CodecError),

    /// Instrumentation of binary code failed.
    #[display(fmt = "Instrumentation of binary code failed.")]
    Instrumentation,

    /// Reading of program state failed.
    #[display(fmt = "Reading of program state failed: `{_0}`")]
    ReadStateError(String),

    /// Searching gbuild artifact failed.
    #[from(ignore)]
    #[display(fmt = "Reading of program state failed: `{_0}`")]
    GbuildArtifactNotFound(String),
}