satay-codegen 0.12.1

Generate Rust client code from OpenAPI 3.1 documents
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
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
use std::fs;

use crate::ast::*;
use crate::common::*;

#[test]
fn simple_fixture_generates_expected_file_structure() {
    let files = satay_codegen::generate(SIMPLE).expect("generate simple fixture");

    let users_source = find_file(&files, "users.rs");
    assert!(users_source.contents.starts_with("// @generated by satay."));
    assert!(!users_source.contents.contains("//! @generated by satay."));

    let mod_rs = parse_rust(find_file(&files, "mod.rs"));
    assert!(is_pub(&find_const(&mod_rs, "SERVER_URL").vis));
    assert!(is_pub(&find_mod(&mod_rs, "types").vis));
    let api_mod = find_mod(&mod_rs, "api");
    assert!(!is_pub(&api_mod.vis));
    assert!(has_cfg_feature(&api_mod.attrs, "json"));
    assert!(!is_pub(&find_mod(&mod_rs, "get_user").vis));
    assert!(!is_pub(&find_mod(&mod_rs, "update_user").vis));
    assert!(is_pub(&find_mod(&mod_rs, "operations").vis));
    let users_mod = find_mod(&mod_rs, "users");
    assert!(is_pub(&users_mod.vis));
    assert!(has_cfg_feature(&users_mod.attrs, "json"));

    assert!(!files.iter().any(|file| file.relative_path == "lib.rs"));

    assert!(!files.iter().any(|file| file.relative_path == "client.rs"));
    let api_rs = parse_rust(find_file(&files, "api.rs"));
    find_struct(&api_rs, "Api");
    find_struct(&api_rs, "GetUserAction");
    find_method(&api_rs, "Api", "users");
    assert!(!has_method(&api_rs, "Api", "get_user"));
    find_method(&api_rs, "GetUserAction", "request");
    find_method(&api_rs, "GetUserAction", "decode");

    let users_rs = parse_rust(find_file(&files, "users.rs"));
    find_struct(&users_rs, "Api");
    find_method(&users_rs, "Api", "get_user");
    find_method(&users_rs, "Api", "update_user");

    let types_rs = parse_rust(find_file(&files, "types.rs"));
    find_struct(&types_rs, "ErrorBody");
    find_struct(&types_rs, "UpdateUserRequest");
    find_struct(&types_rs, "User");
    find_enum(&types_rs, "UserStatus");

    let parts = parse_rust(find_file(&files, "get_user/parts.rs"));
    find_struct(&parts, "GetUserInput");
    let new_fn = find_method(&parts, "GetUserInput", "new");
    assert!(is_pub(&new_fn.vis));
    assert_eq!(
        norm(&new_fn.sig),
        norm_str("fn new(user_id: impl Into<String>) -> Self")
    );
    find_method(&parts, "GetUserInput", "include_details");
    find_enum(&parts, "GetUserResponse");
    find_fn(&parts, "get_user_parts");
    assert!(!contains_tokens(&parts, r#"#[cfg(feature = "json")]"#));

    let json = parse_rust(find_file(&files, "get_user/json.rs"));
    find_fn(&json, "encode_get_user");
    find_fn(&json, "decode_get_user_response");
    assert!(!contains_tokens(&json, r#"#[cfg(feature = "json")]"#));

    let parts = parse_rust(find_file(&files, "update_user/parts.rs"));
    find_struct(&parts, "UpdateUserInput");
    find_enum(&parts, "UpdateUserResponse");
    find_fn(&parts, "update_user_parts");

    let json = parse_rust(find_file(&files, "update_user/json.rs"));
    find_fn(&json, "encode_update_user");
    find_fn(&json, "decode_update_user_response");
}

#[test]
fn operation_tags_generate_namespaced_api_groups() {
    let files = satay_codegen::generate(GROUPED).expect("generate grouped fixture");

    let root = parse_rust(find_file(&files, "mod.rs"));
    for group in ["realtime", "bus", "untagged"] {
        let module = find_mod(&root, group);
        assert!(is_pub(&module.vis));
        assert!(has_cfg_feature(&module.attrs, "json"));
    }
    assert_doc(&find_mod(&root, "bus").attrs, "Bus operations.");

    let api = parse_rust(find_file(&files, "api.rs"));
    for group in ["realtime", "bus", "untagged"] {
        find_method(&api, "Api", group);
    }
    assert!(!has_method(&api, "Api", "get_bus_arrival"));
    assert!(!has_method(&api, "Api", "list_bus_stops"));
    let action = find_struct(&api, "GetBusArrivalAction");
    assert_doc(
        &action.attrs,
        "Use the chainable methods to configure optional request settings, then call [`Self::request`] or use a transport adapter.",
    );
    assert_attr_contains(
        &action.attrs,
        "must_use",
        r#""configure this action and execute it or call `.request()`""#,
    );
    let service_no = find_method(&api, "GetBusArrivalAction", "service_no");
    assert_doc(&service_no.attrs, "Optional bus service number filter.");
    assert_attr_contains(
        &service_no.attrs,
        "must_use",
        r#""builder methods return the configured action""#,
    );
    let include_metadata = find_method(&api, "GetBusArrivalAction", "include_metadata");
    assert_doc(&include_metadata.attrs, "Include response metadata.");

    let bus = parse_rust(find_file(&files, "bus.rs"));
    find_struct(&bus, "Api");
    assert_doc(&find_struct(&bus, "Api").attrs, "Bus operations.");
    let get_arrival = find_method(&bus, "Api", "get_arrival");
    assert_eq!(
        norm(&get_arrival.sig),
        norm_str("fn get_arrival(&self, bus_stop_code: u32) -> GetBusArrivalAction<'a>",),
    );
    assert_doc(&get_arrival.attrs, "Get the next arrival.");
    assert_doc(&get_arrival.attrs, "# Arguments");
    assert_doc(
        &get_arrival.attrs,
        "- `bus_stop_code`: Bus stop reference code.",
    );
    assert_doc(&get_arrival.attrs, "# Optional request settings");
    assert_doc(
        &get_arrival.attrs,
        "- [`service_no`](GetBusArrivalAction::service_no): Optional bus service number filter.",
    );
    assert_doc(
        &get_arrival.attrs,
        "- [`include_metadata`](GetBusArrivalAction::include_metadata): Include response metadata.",
    );
    let get_arrival_docs = doc_lines(&get_arrival.attrs);
    let example = get_arrival_docs
        .iter()
        .skip_while(|line| *line != "# Example")
        .cloned()
        .collect::<Vec<_>>()
        .join("\n");
    assert!(example.contains(".bus()"));
    assert!(example.contains(".get_arrival(bus_stop_code)"));
    assert!(example.contains(".service_no(service_no)"));
    assert!(!example.contains(".include_metadata(include_metadata)"));
    find_method(&bus, "Api", "list_stops");

    let realtime = parse_rust(find_file(&files, "realtime.rs"));
    find_method(&realtime, "Api", "get_bus_arrival");

    let untagged = parse_rust(find_file(&files, "untagged.rs"));
    find_method(&untagged, "Api", "health");
}

#[test]
fn lib_root_module_option_emits_lib_rs_instead_of_mod_rs() {
    use satay_codegen::{GenerateOptions, RootModule};
    let options = GenerateOptions {
        root_module: RootModule::LibRs,
    };
    let files = satay_codegen::generate_with(SIMPLE, options).expect("generate simple fixture");

    let lib_rs = parse_rust(find_file(&files, "lib.rs"));
    assert!(is_pub(&find_const(&lib_rs, "SERVER_URL").vis));
    assert!(!files.iter().any(|file| file.relative_path == "mod.rs"));
    assert!(
        files
            .iter()
            .any(|file| file.relative_path == "get_user/mod.rs")
    );
}

#[test]
fn descriptions_generate_rustdoc_comments() {
    let files = satay_codegen::generate(
        r#"
openapi: 3.1.0
info:
  title: Test API
  version: 1.0.0
paths:
  /users/{userId}:
    get:
      operationId: getUser
      description: Fetch a user.
      parameters:
        - name: userId
          in: path
          required: true
          description: User identifier.
          schema:
            type: string
        - name: includeDetails
          in: query
          description: Include detailed fields.
          schema:
            type: boolean
      responses:
        '200':
          description: User found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/User'
components:
  schemas:
    User:
      type: object
      description: A user record.
      required:
        - id
        - code
        - home_code
      properties:
        id:
          type: string
          description: Stable ID.
        name:
          type: string
          description: Display name.
        code:
          $ref: '#/components/schemas/UserCode'
        home_code:
          $ref: '#/components/schemas/UserCode'
          description: Home user code.
    UserCode:
      type: string
      description: Reusable user code.
      maxLength: 32
"#,
    )
    .expect("generate descriptions fixture");

    let api_rs = parse_rust(find_file(&files, "untagged.rs"));
    assert_doc(
        &find_method(&api_rs, "Api", "get_user").attrs,
        "Fetch a user.",
    );

    let types_rs = parse_rust(find_file(&files, "types.rs"));
    let user = find_struct(&types_rs, "User");
    assert_doc(&user.attrs, "A user record.");
    assert_doc(&field(user, "id").attrs, "Stable ID.");
    assert_field(user, "id", "String");
    assert_doc(&field(user, "name").attrs, "Display name.");
    assert_field(user, "name", "Option<String>");
    assert_doc(&field(user, "code").attrs, "Reusable user code.");
    assert_field(user, "code", "UserCode");
    assert_doc(&field(user, "home_code").attrs, "Home user code.");
    assert_field(user, "home_code", "UserCode");

    let parts_rs = parse_rust(find_file(&files, "get_user/parts.rs"));
    let input = find_struct(&parts_rs, "GetUserInput");
    assert_doc(&input.attrs, "Fetch a user.");
    assert_doc(&field(input, "user_id").attrs, "User identifier.");
    assert_field(input, "user_id", "String");
    assert_doc(
        &field(input, "include_details").attrs,
        "Include detailed fields.",
    );
    let response = find_enum(&parts_rs, "GetUserResponse");
    let ok = variant(response, "Ok");
    assert_doc(&ok.attrs, "User found.");
    assert_eq!(norm(&ok.fields), norm_str("(User)"));
}

#[test]
fn server_security_and_api_action_helpers_are_generated() {
    let files = satay_codegen::generate(
        r#"
openapi: 3.1.0
info:
  title: Test API
  version: 1.0.0
servers:
  - url: https://api.example.test/v1
paths:
  /users/{userId}:
    get:
      operationId: getUser
      parameters:
        - name: userId
          in: path
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/User'
components:
  securitySchemes:
    accountKeyAuth:
      type: apiKey
      in: header
      name: AccountKey
    apiKeyQuery:
      type: apiKey
      in: query
      name: api_key
  schemas:
    User:
      type: object
      required:
        - id
      properties:
        id:
          type: string
"#,
    )
    .expect("generate secured fixture");

    let mod_rs = parse_rust(find_file(&files, "mod.rs"));
    assert_eq!(
        norm(find_const(&mod_rs, "SERVER_URL")),
        norm_str(r#"pub const SERVER_URL: &str = "https://api.example.test/v1";"#)
    );

    let api_rs = parse_rust(find_file(&files, "api.rs"));
    find_method(&api_rs, "Api", "account_key");
    find_method(&api_rs, "Api", "api_key");
    find_method(&api_rs, "Api", "untagged");
    find_struct(&api_rs, "GetUserAction");
    assert!(contains_tokens(&api_rs, "satay_runtime::insert_header"));
    assert!(contains_tokens(&api_rs, r#""AccountKey""#));
    assert!(contains_tokens(&api_rs, "satay_runtime::append_query_pair"));
    assert!(contains_tokens(&api_rs, r#""api_key""#));
    assert!(contains_tokens(&api_rs, "parts.uri = format!"));
    assert!(!contains_ident(&api_rs, "reqwest"));

    let temp = tempfile::tempdir().expect("create temp crate");
    let crate_dir = temp.path();
    let generated_dir = crate_dir.join("src/generated");

    let runtime_path = runtime_path_toml();

    write_manifest(crate_dir, &runtime_path, false, false);
    write_generated_files(&generated_dir, &files);
    let lib_contents = r##"pub mod generated;

#[cfg(test)]
mod tests {
    use super::generated::*;

    #[test]
    fn action_applies_base_url_and_api_keys() {
        let request = Api::new()
            .account_key("secret")
            .api_key("query secret")
            .untagged()
            .get_user("42")
            .request()
            .expect("action request");

        assert_eq!(
            request.uri().to_string(),
            "https://api.example.test/v1/users/42?api_key=query%20secret"
        );
        let account_key = http::header::HeaderName::from_bytes(b"AccountKey").unwrap();
        assert_eq!(request.headers().get(account_key).unwrap(), "secret");
    }
}
"##;
    fs::write(crate_dir.join("src/lib.rs"), lib_contents).expect("write lib");

    run_temp_cargo(crate_dir, "test", &[], "secured generated crate tests");
}

#[test]
fn simple_fixture_endpoint_modules_have_cfg_gated_json() {
    let files = satay_codegen::generate(SIMPLE).expect("generate simple fixture");

    let mod_rs = parse_rust(find_file(&files, "get_user/mod.rs"));
    assert!(has_cfg_feature(&find_mod(&mod_rs, "json").attrs, "json"));
    assert!(contains_tokens(
        &mod_rs,
        r#"#[cfg(feature = "json")] pub use json::*;"#
    ));

    let mod_rs = parse_rust(find_file(&files, "update_user/mod.rs"));
    assert!(has_cfg_feature(&find_mod(&mod_rs, "json").attrs, "json"));
    assert!(contains_tokens(
        &mod_rs,
        r#"#[cfg(feature = "json")] pub use json::*;"#
    ));

    let parts = parse_rust(find_file(&files, "get_user/parts.rs"));
    assert!(!contains_tokens(&parts, r#"#[cfg(feature = "json")]"#));

    let json = parse_rust(find_file(&files, "get_user/json.rs"));
    assert!(!contains_tokens(&json, r#"#[cfg(feature = "json")]"#));
}

#[test]
fn petstore_minimal_fixture_generates_client_core() {
    let files = satay_codegen::generate(PETSTORE_MINIMAL).expect("generate petstore fixture");

    let types_rs = parse_rust(find_file(&files, "types.rs"));
    find_struct(&types_rs, "Pet");

    let parts = parse_rust(find_file(&files, "list_pets/parts.rs"));
    find_fn(&parts, "list_pets_parts");

    let json = parse_rust(find_file(&files, "create_pet/json.rs"));
    find_fn(&json, "encode_create_pet");

    let json = parse_rust(find_file(&files, "get_pet/json.rs"));
    find_fn(&json, "decode_get_pet_response");
}