catalyst 0.2.9

A lightweight API testing tool
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

use super::{variables, verify};
use crate::debug;
use crate::http::client::{HttpClient, RequestData};
use crate::models::test::Test;
use crate::utils::{file::load_body_from_file, string::replace_variables};
use serde_json::Value;
use std::collections::HashMap;
use std::path::Path;
use std::time::Instant;

pub struct ExecutionResult {
    pub success: bool,
    pub status: (u16, u16),
    pub time_ms: u64,
    pub body: Option<Value>,
    pub headers: HashMap<String, String>,
    pub errors: Vec<String>,
}

pub async fn run(
    client: &HttpClient,
    test: &Test,
    test_file_dir: &Path,
    vars: &mut HashMap<String, String>,
) -> ExecutionResult {
    let start = Instant::now();

    let headers = test
        .headers
        .as_ref()
        .map(|h| {
            h.iter()
                .map(|(k, v)| (k.clone(), replace_variables(v, vars)))
                .collect()
        })
        .unwrap_or_default();

    let params = test
        .query_params
        .as_ref()
        .map(|p| {
            p.iter()
                .map(|(k, v)| (k.clone(), replace_variables(v, vars)))
                .collect()
        })
        .unwrap_or_default();

    let body = if let Some(inline_body) = &test.body {
        match variables::replace_variables_in_json_with_files(inline_body, vars, test_file_dir) {
            Ok(processed_body) => Some(processed_body),
            Err(e) => {
                eprintln!("Error processing body with file references: {e}");
                Some(variables::replace_variables_in_json(inline_body, vars))
            }
        }
    } else if let Some(body_file) = &test.body_file {
        match load_body_from_file(body_file, test_file_dir, vars) {
            Ok(content) => Some(content),
            Err(e) => {
                eprintln!("Error loading body file '{body_file}': {e}");
                None
            }
        }
    } else {
        None
    };

    let request = RequestData {
        method: test.method.clone(),
        url: replace_variables(&test.endpoint, vars),
        headers,
        params,
        body,
    };

    debug!(
        "Request for '{}': headers = {:?}, body = {:?}",
        test.name, request.headers, request.body
    );

    match client.execute(request).await {
        Ok((status, body, mut headers)) => {
            let time_ms = start.elapsed().as_millis() as u64;

            let header_keys: Vec<String> = headers.keys().cloned().collect();
            for key in header_keys {
                if let Some(value) = headers.get(&key) {
                    headers.insert(key.to_lowercase(), value.clone());
                }
            }

            debug!("Response headers: {:?}", headers);

            if let Some(cookie_map) = &test.get_cookie {
                debug!("Attempting to extract cookies: {:?}", cookie_map);
                variables::store_variables(
                    &body,
                    &HashMap::new(),
                    &headers,
                    &Some(cookie_map.clone()),
                    time_ms,
                    vars,
                );
                debug!("Variables after cookie extraction: {:?}", vars);
            }

            let validation = verify::check(test, status, &body, time_ms, vars);

            if validation.ok && test.store.is_some() {
                variables::store_variables(
                    &body,
                    test.store.as_ref().unwrap(),
                    &headers,
                    &None,
                    time_ms,
                    vars,
                );
            }

            ExecutionResult {
                success: validation.ok,
                status: (test.expected_status, status),
                time_ms,
                body: Some(body),
                headers,
                errors: validation.errors,
            }
        }
        Err(err) => ExecutionResult {
            success: false,
            status: (test.expected_status, 0),
            time_ms: 0,
            body: None,
            headers: HashMap::new(),
            errors: vec![err.to_string()],
        },
    }
}