httpgenerator 1.1.0

Generate .http files from OpenAPI specifications
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

use std::{
    fs,
    path::PathBuf,
    time::{SystemTime, UNIX_EPOCH},
};

mod support;

use httpgenerator_core::OutputType;
use support::{
    CompatibilityScenario, DotnetOracleRunner, RustCliRunner, execute_differential_plan,
    local_smoke_scenarios,
};

fn repo_root() -> PathBuf {
    PathBuf::from(env!("CARGO_MANIFEST_DIR"))
        .join("..")
        .join("..")
        .join("..")
}

fn temp_artifacts_root() -> PathBuf {
    std::env::temp_dir().join(format!(
        "httpgenerator-differential-tests-{}",
        SystemTime::now()
            .duration_since(UNIX_EPOCH)
            .unwrap()
            .as_nanos()
    ))
}

fn fixture_name(scenario: &CompatibilityScenario) -> &str {
    scenario
        .input_path
        .file_stem()
        .and_then(|name| name.to_str())
        .expect("scenario input should have a file stem")
}

fn version_name(scenario: &CompatibilityScenario) -> &str {
    scenario
        .input_path
        .parent()
        .and_then(|path| path.file_name())
        .and_then(|name| name.to_str())
        .expect("scenario input should live under a version directory")
}

fn is_default_matrix_scenario(scenario: &CompatibilityScenario) -> bool {
    scenario.output_type == OutputType::OneFile
        && scenario.no_logging
        && scenario.authorization_header.is_none()
        && !scenario.authorization_header_from_environment_variable
        && scenario.authorization_header_variable_name == "authorization"
        && scenario.content_type == "application/json"
        && scenario.base_url.as_deref() == Some("https://api.example.io/")
        && scenario.generate_intellij_tests
        && scenario.custom_headers == ["X-Custom-Header: 1234"]
        && !scenario.skip_headers
}

fn is_representative_output_mode_scenario(scenario: &CompatibilityScenario) -> bool {
    fixture_name(scenario) == "petstore"
        && matches!(version_name(scenario), "v2.0" | "v3.0")
        && matches!(
            scenario.output_type,
            OutputType::OneRequestPerFile | OutputType::OneFilePerTag
        )
        && scenario.no_logging
        && scenario.authorization_header.is_none()
        && !scenario.authorization_header_from_environment_variable
        && scenario.content_type == "application/json"
        && scenario.base_url.as_deref() == Some("https://api.example.io/")
        && scenario.generate_intellij_tests
        && scenario.custom_headers == ["X-Custom-Header: 1234"]
        && !scenario.skip_headers
}

fn is_petstore_option_variation(scenario: &CompatibilityScenario) -> bool {
    fixture_name(scenario) == "petstore"
        && matches!(version_name(scenario), "v2.0" | "v3.0")
        && scenario.output_type == OutputType::OneFile
        && (scenario.authorization_header.is_some()
            || scenario.authorization_header_from_environment_variable
            || scenario.skip_headers
            || scenario.content_type != "application/json"
            || scenario.base_url.as_deref() == Some("{{MY_BASE_URL}}"))
}

#[test]
fn parity_matrix_matches_dotnet_oracle() {
    let repo_root = repo_root();
    let artifacts_root = temp_artifacts_root();
    let scenarios = local_smoke_scenarios(&repo_root);
    let oracle_runner = DotnetOracleRunner::from_repo_root(&repo_root);
    let rust_runner = RustCliRunner::binary(
        &repo_root,
        PathBuf::from(env!("CARGO_BIN_EXE_httpgenerator")),
    );

    let scenarios_to_run = scenarios
        .iter()
        .filter(|scenario| {
            is_default_matrix_scenario(scenario)
                || is_representative_output_mode_scenario(scenario)
                || is_petstore_option_variation(scenario)
        })
        .collect::<Vec<_>>();

    assert!(
        scenarios_to_run
            .iter()
            .any(|scenario| scenario.name == "non-oauth-scopes-v3.1-json-one-file")
    );
    assert!(
        scenarios_to_run
            .iter()
            .any(|scenario| scenario.name == "callback-example-v3.0-yaml-one-file")
    );
    assert!(
        scenarios_to_run
            .iter()
            .any(|scenario| scenario.name == "petstore-v2.0-yaml-one-file-per-tag")
    );

    for scenario in scenarios_to_run {
        let plan = scenario.differential_plan(&artifacts_root);
        let result = execute_differential_plan(&plan, &oracle_runner, &rust_runner).unwrap();

        assert!(
            result.is_match(),
            "expected Rust output to match the .NET oracle for {}\n{}",
            scenario.name,
            result.mismatch_report()
        );
    }

    let _ = fs::remove_dir_all(artifacts_root);
}