apicize_lib 0.35.4

Library supporting Apicize request dispatch, testing and serialization
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
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

use serde::{Deserialize, Serialize};
use serde_json::{Map, Value};

use crate::{ApicizeError, ApicizeExecutionTestContext, ApicizeTestBehavior, DataContext, ExecutionResultSuccess};

#[derive(Serialize, Deserialize, PartialEq, Clone)]
#[serde(rename_all = "camelCase", tag = "entityType")]
pub enum ExecutionResultDetail {
    Request(Box<ExecutionResultDetailRequest>),
    Grouped(Box<ExecutionResultDetailGroup>),
}

/// Represents detailed execution information of a request
#[derive(Serialize, Deserialize, PartialEq, Clone)]
#[serde(rename_all = "camelCase")]
pub struct ExecutionResultDetailRequest {
    /// Execution counter/identifier (will be the same for summary and detail)
    pub exec_ctr: usize,

    /// Request ID
    pub request_id: String,

    /// Request name
    pub name: String,

    /// Method for request
    #[serde(skip_serializing_if = "Option::is_none")]
    pub method: Option<String>,

    /// Requested URL
    #[serde(skip_serializing_if = "Option::is_none")]
    pub url: Option<String>,

    /// Optional referential key
    #[serde(skip_serializing_if = "Option::is_none")]
    pub key: Option<String>,

    /// Associative tag name
    #[serde(skip_serializing_if = "Option::is_none")]
    pub tag: Option<String>,

    /// Row number (if applicable)
    #[serde(skip_serializing_if = "Option::is_none")]
    pub row_number: Option<usize>,

    // Run number (if applicable)
    #[serde(skip_serializing_if = "Option::is_none")]
    pub run_number: Option<usize>,

    /// Execution start (millisecond offset from start)
    pub executed_at: u128,

    /// Duration of execution (milliseconds)
    pub duration: u128,

    /// Variables available within test context
    pub test_context: ApicizeExecutionTestContext,

    /// Output variables for use in next request or group
    pub output_variables: Option<Map<String, Value>>,

    /// Test results (if executed)
    #[serde(skip_serializing_if = "Option::is_none")]
    pub tests: Option<Vec<ApicizeTestBehavior>>,

    /// Generated curl command to recreate the request
    #[serde(skip_serializing_if = "Option::is_none")]
    pub curl: Option<String>,

    /// Error on dispatch or error execution
    #[serde(skip_serializing_if = "Option::is_none")]
    pub error: Option<ApicizeError>,

    /// Indicates level of call success
    pub success: ExecutionResultSuccess,

    /// Number of child requests/groups with successful requests and all tests passed
    pub request_success_count: usize,

    /// Number of child requests/groups with successful requests and some tests failed
    pub request_failure_count: usize,

    /// Number of child requests/groups with successful requests and some tests failed
    pub request_error_count: usize,

    /// Number of passed tests, if request and tests are succesfully run
    pub test_pass_count: usize,

    /// Number of failed tests, if request and tests are succesfully run
    pub test_fail_count: usize,
}

/// Represents detailed execution information of a request
#[derive(Serialize, Deserialize, PartialEq, Clone)]
#[serde(rename_all = "camelCase")]
pub struct ExecutionResultDetailGroup {
    /// Execution identifier (will be the same for summary and detail)
    pub exec_ctr: usize,

    /// Request group ID
    pub group_id: String,

    /// Request name
    pub name: String,

    /// Optional referential key
    #[serde(skip_serializing_if = "Option::is_none")]
    pub key: Option<String>,

    /// Associative tag
    #[serde(skip_serializing_if = "Option::is_none")]
    pub tag: Option<String>,

    /// Row number (if applicable)
    #[serde(skip_serializing_if = "Option::is_none")]
    pub row_number: Option<usize>,

    // Run number (if applicable)
    #[serde(skip_serializing_if = "Option::is_none")]
    pub run_number: Option<usize>,

    /// Execution start (millisecond offset from start)
    pub executed_at: u128,

    /// Duration of execution (milliseconds)
    pub duration: u128,

    /// Variables available within test context
    pub data_context: DataContext,

    /// Success is true if all runs are successful
    pub success: ExecutionResultSuccess,

    /// Number of child requests/groups with successful requests and all tests passed
    pub request_success_count: usize,

    /// Number of child requests/groups with successful requests and some tests failed
    pub request_failure_count: usize,

    /// Number of child requests/groups with successful requests and some tests failed
    pub request_error_count: usize,

    /// Number of passed tests, if request and tests are succesfully run
    pub test_pass_count: usize,

    /// Number of failed tests, if request and tests are succesfully run
    pub test_fail_count: usize,
}