alixt 0.8.0

A command line http API testing utility with TOML configuration
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

// This file is part of alixt.
// Copyright (C) 2025 Devon Harley Offutt
//
// alixt 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 <http://www.gnu.org/licenses/>.


use std::time::Duration;

use serde::{Serialize, Serializer};

#[derive(Default, Debug, Serialize)]
pub struct TestData {
    #[serde(rename = "runs")]
    pub run_data: Vec<RunData>,
}

impl TestData {
    pub fn new() -> Self {
        Self {
            run_data: Vec::new(),
        }
    }
}

#[derive(Debug, Serialize)]
pub struct RunData {
    pub name: String,
    #[serde(rename = "requests")]
    pub outcomes: Vec<RequestOutcome>,
}

impl RunData {
    pub fn new(name: String) -> Self {
        Self {
            name,
            outcomes: Vec::new(),
        }
    }
}

#[derive(Debug, Serialize)]
pub struct RequestOutcome {
    pub name: String,
    pub method: String,
    pub url: String,

    pub passing: AssertionOutcome,
    pub breaking: bool,

    pub status: Option<u16>,
    pub response_body: Option<String>,
    #[serde(serialize_with = "serialize_duration_as_seconds", rename = "duration_seconds")]
    pub duration: Duration,
}


fn serialize_duration_as_seconds<S: Serializer>(duration: &Duration, serializer: S) -> Result<S::Ok, S::Error> {
    serializer.serialize_f64(duration.as_secs_f64())
}

#[derive(Debug, Serialize)]
pub enum AssertionOutcome {
    Passed,
    Failed(Vec<FailureType>),
}
impl AssertionOutcome {
    pub fn push(&mut self, failure: FailureType) {
        match self {
            Self::Passed => *self = Self::Failed(vec![failure]),
            Self::Failed(fails) => fails.push(failure),
        }
    }
    pub fn is_passing(&self) -> bool {
        match self {
            Self::Passed => true,
            Self::Failed(_) => false,
        }
    }
    pub fn take(&mut self) -> Self {
        match self {
            Self::Passed => {
                std::mem::replace(self, AssertionOutcome::Passed)
            },
            Self::Failed(_) => {
                std::mem::replace(self, AssertionOutcome::Failed(Vec::new()))
            },
        }
    }
}
#[derive(Debug, Serialize)]
pub enum FailureType {
    StatusMismatch{ expected: u16, found: Option<u16> },
    InvalidJson(),
    JsonMissingField { path: String },
    JsonExtraField { path: String },
    JsonValueMismatch { path: String, expected: String, found: String },
    JsonRegexMismatch { path: String, pattern: String, found: String },
    JsonNotString { path: String },
}