faucet-source-xml 1.3.0

XML API source connector for the faucet-stream ecosystem
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
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283

//! Integration tests for the first-class `soap:` ergonomics block against a
//! wiremock server: request-header injection (SOAPAction / Content-Type) per
//! SOAP version, the assembled envelope body the server receives,
//! `Envelope.Body.`-relative record extraction (including a namespace-prefixed
//! record element), SOAP `<Fault>` handling (error vs zero-records), and a
//! regression asserting the raw-`body` path is unchanged when `soap` is absent.

use faucet_core::FaucetError;
use faucet_source_xml::{SoapConfig, SoapVersion, XmlAuth, XmlStream, XmlStreamConfig};
use reqwest::Method;
use wiremock::matchers::{body_string_contains, header, method, path};
use wiremock::{Mock, MockServer, ResponseTemplate};

/// A default-namespaced SOAP success envelope wrapping the given `Users` markup.
fn soap_users_response(users: &str) -> String {
    format!(
        "<Envelope xmlns=\"http://schemas.xmlsoap.org/soap/envelope/\"><Body>\
         <GetUsersResponse xmlns=\"urn:example\"><Users>{users}</Users></GetUsersResponse>\
         </Body></Envelope>"
    )
}

#[tokio::test]
async fn soap11_injects_soapaction_header_and_text_xml_content_type() {
    let server = MockServer::start().await;
    Mock::given(method("POST"))
        .and(path("/ws"))
        .and(header("soapaction", "\"urn:example:GetUsers\""))
        .and(header("content-type", "text/xml; charset=utf-8"))
        // The assembled envelope wraps the body_inner inside <soap:Body>.
        .and(body_string_contains(
            "<soap:Envelope xmlns:soap=\"http://schemas.xmlsoap.org/soap/envelope/\">",
        ))
        .and(body_string_contains(
            "<soap:Body><GetUsers xmlns=\"urn:example\"/></soap:Body>",
        ))
        .respond_with(
            ResponseTemplate::new(200)
                .insert_header("Content-Type", "text/xml")
                .set_body_string(soap_users_response(
                    "<User><Name>Alice</Name></User><User><Name>Bob</Name></User>",
                )),
        )
        .expect(1)
        .mount(&server)
        .await;

    let config = XmlStreamConfig::new(server.uri(), "/ws")
        .method(Method::POST)
        .records_element_path("GetUsersResponse.Users.User")
        .with_soap(SoapConfig {
            version: SoapVersion::Soap11,
            action: Some("urn:example:GetUsers".into()),
            body_inner: Some("<GetUsers xmlns=\"urn:example\"/>".into()),
            ..Default::default()
        });
    let records = XmlStream::new(config).fetch_all().await.unwrap();
    assert_eq!(records.len(), 2);
    assert_eq!(records[0]["Name"], "Alice");
    assert_eq!(records[1]["Name"], "Bob");
}

#[tokio::test]
async fn soap12_carries_action_in_content_type_and_sends_no_soapaction_header() {
    let server = MockServer::start().await;
    Mock::given(method("POST"))
        .and(path("/ws"))
        .and(header(
            "content-type",
            "application/soap+xml; charset=utf-8; action=\"urn:example:GetUsers\"",
        ))
        .and(body_string_contains(
            "<soap:Envelope xmlns:soap=\"http://www.w3.org/2003/05/soap-envelope\">",
        ))
        .respond_with(
            ResponseTemplate::new(200)
                .insert_header("Content-Type", "application/soap+xml")
                .set_body_string(soap_users_response("<User><Name>Carol</Name></User>")),
        )
        .expect(1)
        .mount(&server)
        .await;

    let config = XmlStreamConfig::new(server.uri(), "/ws")
        .method(Method::POST)
        .records_element_path("GetUsersResponse.Users.User")
        .with_soap(SoapConfig {
            version: SoapVersion::Soap12,
            action: Some("urn:example:GetUsers".into()),
            body_inner: Some("<GetUsers xmlns=\"urn:example\"/>".into()),
            ..Default::default()
        });
    let records = XmlStream::new(config).fetch_all().await.unwrap();
    assert_eq!(records.len(), 1);
    assert_eq!(records[0]["Name"], "Carol");
}

#[tokio::test]
async fn soap_namespace_prefixed_record_element_is_extracted() {
    // The response uses a `usr:User` prefixed record element; the relative path
    // must name it verbatim (prefixes are preserved by XML→JSON conversion).
    let server = MockServer::start().await;
    let response = "<Envelope xmlns=\"http://schemas.xmlsoap.org/soap/envelope/\"><Body>\
         <GetUsersResponse xmlns:usr=\"urn:example:users\"><Users>\
         <usr:User><usr:Name>Dana</usr:Name></usr:User>\
         <usr:User><usr:Name>Erin</usr:Name></usr:User>\
         </Users></GetUsersResponse></Body></Envelope>";
    Mock::given(method("POST"))
        .and(path("/ws"))
        .respond_with(
            ResponseTemplate::new(200)
                .insert_header("Content-Type", "text/xml")
                .set_body_string(response),
        )
        .expect(1)
        .mount(&server)
        .await;

    let config = XmlStreamConfig::new(server.uri(), "/ws")
        .method(Method::POST)
        .records_element_path("GetUsersResponse.Users.usr:User")
        .with_soap(SoapConfig {
            body_inner: Some("<GetUsers/>".into()),
            ..Default::default()
        });
    let records = XmlStream::new(config).fetch_all().await.unwrap();
    assert_eq!(records.len(), 2);
    assert_eq!(records[0]["usr:Name"], "Dana");
    assert_eq!(records[1]["usr:Name"], "Erin");
}

#[tokio::test]
async fn soap_absolute_path_override_bypasses_body_prepend() {
    let server = MockServer::start().await;
    Mock::given(method("POST"))
        .and(path("/ws"))
        .respond_with(
            ResponseTemplate::new(200)
                .insert_header("Content-Type", "text/xml")
                .set_body_string(soap_users_response("<User><Name>Fred</Name></User>")),
        )
        .expect(1)
        .mount(&server)
        .await;

    let config = XmlStreamConfig::new(server.uri(), "/ws")
        .method(Method::POST)
        .records_element_path("Envelope.Body.GetUsersResponse.Users.User")
        .with_soap(SoapConfig {
            body_inner: Some("<GetUsers/>".into()),
            path_relative_to_body: false,
            ..Default::default()
        });
    let records = XmlStream::new(config).fetch_all().await.unwrap();
    assert_eq!(records.len(), 1);
    assert_eq!(records[0]["Name"], "Fred");
}

#[tokio::test]
async fn soap_fault_as_error_surfaces_source_error() {
    let server = MockServer::start().await;
    let fault = "<Envelope xmlns=\"http://schemas.xmlsoap.org/soap/envelope/\"><Body>\
         <Fault><faultcode>Server</faultcode>\
         <faultstring>Account not found</faultstring></Fault></Body></Envelope>";
    Mock::given(method("POST"))
        .and(path("/ws"))
        .respond_with(
            ResponseTemplate::new(200)
                .insert_header("Content-Type", "text/xml")
                .set_body_string(fault),
        )
        .mount(&server)
        .await;

    let config = XmlStreamConfig::new(server.uri(), "/ws")
        .method(Method::POST)
        .records_element_path("GetUsersResponse.Users.User")
        .with_soap(SoapConfig {
            body_inner: Some("<GetUsers/>".into()),
            ..Default::default()
        });
    let err = XmlStream::new(config).fetch_all().await.unwrap_err();
    assert!(
        matches!(&err, FaucetError::Source(m) if m.contains("SOAP fault") && m.contains("Account not found")),
        "got {err:?}"
    );
}

#[tokio::test]
async fn soap_fault_not_error_yields_zero_records() {
    let server = MockServer::start().await;
    let fault = "<Envelope xmlns=\"http://schemas.xmlsoap.org/soap/envelope/\"><Body>\
         <Fault><faultstring>transient</faultstring></Fault></Body></Envelope>";
    Mock::given(method("POST"))
        .and(path("/ws"))
        .respond_with(
            ResponseTemplate::new(200)
                .insert_header("Content-Type", "text/xml")
                .set_body_string(fault),
        )
        .mount(&server)
        .await;

    let config = XmlStreamConfig::new(server.uri(), "/ws")
        .method(Method::POST)
        .records_element_path("GetUsersResponse.Users.User")
        .with_soap(SoapConfig {
            body_inner: Some("<GetUsers/>".into()),
            fault_as_error: false,
            ..Default::default()
        });
    let records = XmlStream::new(config).fetch_all().await.unwrap();
    assert!(records.is_empty());
}

#[tokio::test]
async fn soap_headers_injected_alongside_real_bearer_auth() {
    // The SOAP headers are set regardless of the auth variant, so genuine
    // bearer auth is applied in addition to SOAPAction / Content-Type.
    let server = MockServer::start().await;
    Mock::given(method("POST"))
        .and(path("/ws"))
        .and(header("authorization", "Bearer tok-123"))
        .and(header("soapaction", "\"urn:Op\""))
        .and(header("content-type", "text/xml; charset=utf-8"))
        .respond_with(
            ResponseTemplate::new(200)
                .insert_header("Content-Type", "text/xml")
                .set_body_string(soap_users_response("<User><Name>Gwen</Name></User>")),
        )
        .expect(1)
        .mount(&server)
        .await;

    let config = XmlStreamConfig::new(server.uri(), "/ws")
        .method(Method::POST)
        .auth(XmlAuth::Bearer {
            token: "tok-123".into(),
        })
        .records_element_path("GetUsersResponse.Users.User")
        .with_soap(SoapConfig {
            action: Some("urn:Op".into()),
            body_inner: Some("<Op/>".into()),
            ..Default::default()
        });
    let records = XmlStream::new(config).fetch_all().await.unwrap();
    assert_eq!(records.len(), 1);
    assert_eq!(records[0]["Name"], "Gwen");
}

#[tokio::test]
async fn raw_body_path_is_unchanged_when_soap_absent() {
    // Regression: with no `soap` block, the request is byte-for-byte the legacy
    // raw-`body` path — the body is sent verbatim, Content-Type is text/xml,
    // and no SOAPAction header is added by the source.
    let server = MockServer::start().await;
    let raw_envelope =
        "<soap:Envelope><soap:Body><GetUsers/></soap:Body></soap:Envelope>".to_string();
    Mock::given(method("POST"))
        .and(path("/ws"))
        .and(header("content-type", "text/xml; charset=utf-8"))
        .and(body_string_contains(&raw_envelope))
        .respond_with(
            ResponseTemplate::new(200)
                .insert_header("Content-Type", "text/xml")
                .set_body_string(
                    "<soap:Envelope xmlns:soap=\"http://schemas.xmlsoap.org/soap/envelope/\">\
                     <soap:Body><GetUsersResponse><User><Name>Ivy</Name></User>\
                     </GetUsersResponse></soap:Body></soap:Envelope>",
                ),
        )
        .expect(1)
        .mount(&server)
        .await;

    let config = XmlStreamConfig::new(server.uri(), "/ws")
        .method(Method::POST)
        .body(raw_envelope.clone())
        .records_element_path("soap:Envelope.soap:Body.GetUsersResponse.User");
    let records = XmlStream::new(config).fetch_all().await.unwrap();
    assert_eq!(records.len(), 1);
    assert_eq!(records[0]["Name"], "Ivy");
}