mitm2openapi 0.5.2

Convert mitmproxy flow dumps and HAR files to OpenAPI 3.0 specs — fast Rust rewrite of mitmproxy2swagger
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

use assert_cmd::Command;
use tempfile::TempDir;

fn fixture(name: &str) -> std::path::PathBuf {
    std::path::PathBuf::from(env!("CARGO_MANIFEST_DIR"))
        .join("testdata")
        .join("flows")
        .join(name)
}

#[test]
fn report_written_on_success() {
    let dir = TempDir::new().unwrap();
    let templates = dir.path().join("templates.yaml");
    let report_path = dir.path().join("report.json");

    Command::cargo_bin("mitm2openapi")
        .unwrap()
        .args([
            "discover",
            "-i",
            fixture("simple_get.flow").to_str().unwrap(),
            "-o",
            templates.to_str().unwrap(),
            "-p",
            "https://api.example.com",
            "--report",
            report_path.to_str().unwrap(),
        ])
        .assert()
        .success();

    assert!(report_path.exists(), "report file should be written");

    let content = std::fs::read_to_string(&report_path).unwrap();
    let report: serde_json::Value = serde_json::from_str(&content).unwrap();

    assert_eq!(report["report_version"], 1);
    assert!(report["tool_version"].is_string());
    assert!(report["input"]["path"].is_string());
    assert!(report["result"]["paths_in_spec"].is_number());
}

#[test]
fn report_written_on_corrupt_input() {
    let dir = TempDir::new().unwrap();
    let templates = dir.path().join("templates.yaml");
    let report_path = dir.path().join("report.json");

    Command::cargo_bin("mitm2openapi")
        .unwrap()
        .args([
            "discover",
            "-i",
            fixture("corrupt.flow").to_str().unwrap(),
            "-o",
            templates.to_str().unwrap(),
            "-p",
            "https://api.example.com",
            "--report",
            report_path.to_str().unwrap(),
        ])
        .assert()
        .success();

    assert!(
        report_path.exists(),
        "report file should be written even on corrupt input"
    );

    let content = std::fs::read_to_string(&report_path).unwrap();
    let report: serde_json::Value = serde_json::from_str(&content).unwrap();

    assert_eq!(report["report_version"], 1);
    assert!(report["tool_version"].is_string());
}

#[test]
fn report_not_written_without_flag() {
    let dir = TempDir::new().unwrap();
    let templates = dir.path().join("templates.yaml");

    Command::cargo_bin("mitm2openapi")
        .unwrap()
        .args([
            "discover",
            "-i",
            fixture("simple_get.flow").to_str().unwrap(),
            "-o",
            templates.to_str().unwrap(),
            "-p",
            "https://api.example.com",
        ])
        .assert()
        .success();

    let report_path = dir.path().join("report.json");
    assert!(
        !report_path.exists(),
        "report should not be written without --report flag"
    );
}