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
111
112
113
114
115
116
117
118
119
120
121
122
123

// 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 serde::{Deserialize, Serialize};
use serde_json::Value;
use std::collections::HashMap;
use clap::ValueEnum;

#[derive(ValueEnum, Clone, Debug, Serialize, Deserialize)]
#[serde(rename_all = "lowercase")]
pub enum Method {
    #[serde(alias = "Get", alias = "GET")]
    Get,
    #[serde(alias = "Post", alias = "POST")]
    Post,
    #[serde(alias = "Put", alias = "PUT")]
    Put,
    #[serde(alias = "Delete", alias = "DELETE")]
    Delete,
    #[serde(alias = "Patch", alias = "PATCH")]
    Patch,
}

#[derive(ValueEnum, Clone, Debug, Serialize, Deserialize)]
#[serde(rename_all = "lowercase")]
pub enum Scheme {
    #[serde(alias = "Http", alias = "HTTP")]
    Http,
    #[serde(alias = "Https", alias = "HTTPS")]
    Https,
}

impl std::fmt::Display for Scheme {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        match self {
            Scheme::Http => write!(f, "http"),
            Scheme::Https => write!(f, "https"),
        }
    }
}

#[derive(Serialize, Deserialize, Debug)]
pub struct Config {
    pub capture: Option<Capture>,
    pub run: Vec<Run>,
}

#[derive(Serialize, Deserialize, Debug)]
pub struct Capture {
    pub env_file: Option<std::path::PathBuf>,
    pub environment_variables: Option<HashMap<String, String>>,
    pub request: Option<Vec<CaptureRequest>>,
}

#[derive(Serialize, Deserialize, Debug)]
#[serde(rename = "request")]
pub struct CaptureRequest {
    pub name: Option<String>,
    pub headers: Option<HashMap<String, String>>,
    pub method: Method,
    pub scheme: Scheme,
    pub host: String,
    pub port: Option<u16>,
    pub path: Option<String>,
    pub body: Option<String>,
    pub capture: Option<HashMap<String, String>>,
}

// holds multiple requests, contents are blocking
#[derive(Serialize, Deserialize, Debug)]
pub struct Run {
    pub name: String,
    // These fields are the defaults for all requests in the run
    pub headers: Option<HashMap<String, String>>,
    pub method: Option<Method>,
    pub scheme: Option<Scheme>,
    pub host: Option<String>,
    pub port: Option<u16>,
    pub path: Option<String>,
    pub body: Option<String>,

    pub request: Vec<Request>,
}

#[derive(Serialize, Deserialize, Debug)]
pub struct Request {
    pub name: String,
    pub headers: Option<HashMap<String, String>>,
    pub method: Option<Method>,
    pub scheme: Option<Scheme>,
    pub host: Option<String>,
    pub port: Option<u16>,
    pub path: Option<String>,
    pub body: Option<String>,

    pub capture: Option<HashMap<String, String>>,
    pub assert: Option<Assert>,
}

#[derive(Serialize, Deserialize, Debug)]
pub struct Assert {
    #[serde(default)]
    pub breaking: bool,
    pub status: Option<u16>,
    pub body_matches: Option<HashMap<String, Value>>,
    pub subset_matches: Option<HashMap<String, Value>>,
    pub subset_includes: Option<Vec<String>>,
    pub subset_regex: Option<HashMap<String, Value>>,
}