nautilus-orm-codegen 1.0.1

Code generator for Nautilus ORM schema files
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
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
//! Integration tests for `writer.rs` — verifies that generated file trees are
//! created correctly on disk using a temporary directory.

use nautilus_codegen::{
    composite_type_gen::generate_all_composite_types,
    enum_gen::generate_all_enums,
    generator::generate_all_models,
    python::{
        generate_all_python_models, generate_python_client, generate_python_enums,
        python_runtime_files,
    },
    writer::{write_python_code, write_rust_code},
};
use nautilus_schema::validate_schema_source;

fn validate(source: &str) -> nautilus_schema::ir::SchemaIr {
    validate_schema_source(source)
        .expect("validation failed")
        .ir
}

const SIMPLE_SCHEMA: &str = r#"
model User {
  id   Int    @id @default(autoincrement())
  name String
}
"#;

const ENUM_SCHEMA: &str = r#"
enum Status {
  ACTIVE
  INACTIVE
}

model User {
  id     Int    @id @default(autoincrement())
  status Status
}
"#;

const RELATION_SCHEMA: &str = r#"
model User {
  id    Int    @id @default(autoincrement())
  email String @unique @map("user_email")
  posts Post[]
}

model Post {
  id     Int    @id @default(autoincrement())
  title  String
  userId Int    @map("user_id")
  user   User   @relation(fields: [userId], references: [id])
}
"#;

const COMPOSITE_ENUM_SCHEMA: &str = r#"
type Address {
  street String
  city   String
}

enum Status {
  ACTIVE
  INACTIVE
}

model User {
  id      Int     @id @default(autoincrement())
  address Address?
  status  Status
}
"#;

/// Non-standalone mode creates src/lib.rs and src/<model>.rs but no Cargo.toml.
#[test]
fn test_write_rust_code_creates_model_and_lib_files() {
    let ir = validate(SIMPLE_SCHEMA);
    let models = generate_all_models(&ir, false);
    let tmp = tempfile::TempDir::new().expect("failed to create temp dir");
    let path = tmp.path().to_str().unwrap();

    write_rust_code(path, &models, None, None, SIMPLE_SCHEMA, false)
        .expect("write_rust_code failed");

    assert!(
        tmp.path().join("src").join("lib.rs").exists(),
        "src/lib.rs not created"
    );
    assert!(
        tmp.path().join("src").join("user.rs").exists(),
        "src/user.rs not created"
    );
    assert!(
        tmp.path().join("src").join("runtime.rs").exists(),
        "src/runtime.rs not created"
    );
    assert!(
        !tmp.path().join("Cargo.toml").exists(),
        "Cargo.toml should not be created in non-standalone mode"
    );
}

/// Standalone mode additionally creates a Cargo.toml at the output root.
#[test]
fn test_write_rust_code_standalone_creates_cargo_toml() {
    let ir = validate(SIMPLE_SCHEMA);
    let models = generate_all_models(&ir, false);
    let tmp = tempfile::TempDir::new().expect("failed to create temp dir");
    let path = tmp.path().to_str().unwrap();

    write_rust_code(path, &models, None, None, SIMPLE_SCHEMA, true)
        .expect("write_rust_code (standalone) failed");

    assert!(
        tmp.path().join("Cargo.toml").exists(),
        "Cargo.toml not created in standalone mode"
    );
    let cargo_content = std::fs::read_to_string(tmp.path().join("Cargo.toml")).unwrap();
    assert!(
        cargo_content.contains("[package]"),
        "Cargo.toml missing [package] section:\n{cargo_content}"
    );
}

/// When enums are present an enums.rs file is written to src/.
#[test]
fn test_write_rust_code_writes_enums_file() {
    let ir = validate(ENUM_SCHEMA);
    let models = generate_all_models(&ir, false);
    let enums_code = Some(generate_all_enums(&ir.enums));
    let tmp = tempfile::TempDir::new().expect("failed to create temp dir");
    let path = tmp.path().to_str().unwrap();

    write_rust_code(path, &models, enums_code, None, ENUM_SCHEMA, false)
        .expect("write_rust_code failed");

    assert!(
        tmp.path().join("src").join("enums.rs").exists(),
        "src/enums.rs not created"
    );
}

#[test]
fn test_write_rust_code_lib_rs_contains_template_exports() {
    let ir = validate(COMPOSITE_ENUM_SCHEMA);
    let models = generate_all_models(&ir, false);
    let enums_code = Some(generate_all_enums(&ir.enums));
    let composite_types_code = generate_all_composite_types(&ir);
    let tmp = tempfile::TempDir::new().expect("failed to create temp dir");
    let path = tmp.path().to_str().unwrap();

    write_rust_code(
        path,
        &models,
        enums_code,
        composite_types_code,
        COMPOSITE_ENUM_SCHEMA,
        false,
    )
    .expect("write_rust_code failed");

    let lib_content =
        std::fs::read_to_string(tmp.path().join("src").join("lib.rs")).expect("missing lib.rs");

    assert!(
        lib_content.contains("pub(crate) const SCHEMA_SOURCE: &str = "),
        "lib.rs should contain the embedded schema source:\n{lib_content}"
    );
    assert!(
        lib_content.contains("pub mod types;"),
        "lib.rs should declare the composite types module:\n{lib_content}"
    );
    assert!(
        lib_content.contains("pub mod enums;"),
        "lib.rs should declare the enums module:\n{lib_content}"
    );
    assert!(
        lib_content.contains("pub mod user;"),
        "lib.rs should declare model modules:\n{lib_content}"
    );
    assert!(
        lib_content.contains("pub use types::*;"),
        "lib.rs should re-export composite types:\n{lib_content}"
    );
    assert!(
        lib_content.contains("pub use enums::*;"),
        "lib.rs should re-export enums:\n{lib_content}"
    );
    assert!(
        lib_content.contains("pub use user::*;"),
        "lib.rs should re-export models:\n{lib_content}"
    );

    let types_idx = lib_content
        .find("pub mod types;")
        .expect("missing types module declaration");
    let enums_idx = lib_content
        .find("pub mod enums;")
        .expect("missing enums module declaration");
    let user_idx = lib_content
        .find("pub mod user;")
        .expect("missing user module declaration");
    assert!(
        types_idx < enums_idx && enums_idx < user_idx,
        "lib.rs module declarations should be ordered types -> enums -> models:\n{lib_content}"
    );
}

/// Multiple models each get their own snake_case .rs file.
#[test]
fn test_write_rust_code_multiple_models() {
    let ir = validate(
        r#"
model User {
  id   Int    @id @default(autoincrement())
  name String
}
model Post {
  id    Int    @id @default(autoincrement())
  title String
}
"#,
    );
    let models = generate_all_models(&ir, false);
    let tmp = tempfile::TempDir::new().expect("failed to create temp dir");
    let path = tmp.path().to_str().unwrap();

    write_rust_code(
        path,
        &models,
        None,
        None,
        r#"
model User {
  id   Int    @id @default(autoincrement())
  name String
}
model Post {
  id    Int    @id @default(autoincrement())
  title String
}
"#,
        false,
    )
    .expect("write_rust_code failed");

    assert!(
        tmp.path().join("src").join("user.rs").exists(),
        "src/user.rs not created"
    );
    assert!(
        tmp.path().join("src").join("post.rs").exists(),
        "src/post.rs not created"
    );
}

/// A generated standalone Rust client with relations should compile as a crate.
#[test]
fn test_write_rust_code_standalone_generated_client_compiles() {
    let ir = validate(RELATION_SCHEMA);
    let models = generate_all_models(&ir, false);
    let workspace_root = std::env::current_dir().expect("failed to get current directory");
    let tmp = tempfile::tempdir_in(workspace_root).expect("failed to create temp dir");
    let path = tmp.path().to_str().unwrap();

    write_rust_code(path, &models, None, None, RELATION_SCHEMA, true)
        .expect("write_rust_code failed");

    let status = std::process::Command::new("cargo")
        .args(["check", "--quiet", "--offline", "--manifest-path"])
        .arg(tmp.path().join("Cargo.toml"))
        .status()
        .expect("failed to run cargo check on generated client");

    assert!(
        status.success(),
        "cargo check failed for generated Rust client"
    );
}

/// A generated async Rust client can execute count/group_by via the embedded engine.
#[test]
fn test_write_rust_code_generated_client_runs_count_and_group_by() {
    let schema = r#"
datasource db {
  provider = "sqlite"
  url      = "sqlite::memory:"
}

enum Role {
  ADMIN
  MEMBER
}

model User {
  id          Int    @id @default(autoincrement()) @map("user_id")
  displayName String @map("display_name")
  role        Role
  views       Int

  @@map("users")
}
"#;
    let ir = validate(schema);
    let models = generate_all_models(&ir, true);
    let enums_code = Some(generate_all_enums(&ir.enums));
    let workspace_root = std::env::current_dir().expect("failed to get current directory");
    let tmp = tempfile::tempdir_in(workspace_root).expect("failed to create temp dir");
    let path = tmp.path().to_str().unwrap();

    write_rust_code(path, &models, enums_code, None, schema, true).expect("write_rust_code failed");

    let tests_dir = tmp.path().join("tests");
    std::fs::create_dir_all(&tests_dir).expect("failed to create generated tests dir");
    std::fs::write(
        tests_dir.join("aggregates.rs"),
        r#"
use nautilus_client::{
    Client, Role, TransactionOptions, User, UserCountAggregateInput, UserCountArgs,
    UserCreateInput, UserGroupByArgs, UserGroupByOrderBy, UserMinAggregateInput,
    UserScalarField, UserSortOrder, UserSumAggregateInput,
};

fn core_to_connector(err: nautilus_core::Error) -> nautilus_connector::ConnectorError {
    nautilus_connector::ConnectorError::database_msg(err.to_string())
}

#[tokio::test(flavor = "multi_thread")]
async fn generated_client_supports_count_and_group_by() -> Result<(), Box<dyn std::error::Error>> {
    let db_path = std::env::temp_dir().join(format!("nautilus-generated-aggregates-{}.db", uuid::Uuid::new_v4()));
    std::fs::File::create(&db_path)?;
    let url = format!("sqlite:{}", db_path.to_string_lossy().replace('\\', "/"));

    let db = Client::sqlite(&url).await?;
    let users = User::nautilus(&db);

    users
        .raw_query(
            "CREATE TABLE users (
                user_id INTEGER PRIMARY KEY AUTOINCREMENT,
                display_name TEXT NOT NULL,
                role TEXT NOT NULL,
                views INTEGER NOT NULL
            )",
        )
        .await?;

    users
        .create(UserCreateInput {
            display_name: Some("Alice".to_string()),
            role: Some(Role::ADMIN),
            views: Some(12),
            ..Default::default()
        })
        .await?;
    users
        .create(UserCreateInput {
            display_name: Some("Bob".to_string()),
            role: Some(Role::MEMBER),
            views: Some(7),
            ..Default::default()
        })
        .await?;

    let admin_count = users
        .count(UserCountArgs {
            where_: Some(User::role().eq(Role::ADMIN)),
            ..Default::default()
        })
        .await?;
    assert_eq!(admin_count, 1);

    let grouped = users
        .group_by(UserGroupByArgs {
            by: vec![UserScalarField::Role],
            count: Some(UserCountAggregateInput {
                _all: true,
                display_name: true,
                ..Default::default()
            }),
            sum: Some(UserSumAggregateInput {
                views: true,
                ..Default::default()
            }),
            min: Some(UserMinAggregateInput {
                display_name: true,
                ..Default::default()
            }),
            order_by: vec![UserGroupByOrderBy::Field {
                field: UserScalarField::Role,
                direction: UserSortOrder::Asc,
            }],
            ..Default::default()
        })
        .await?;

    assert_eq!(grouped.len(), 2);
    let admin_group = grouped
        .iter()
        .find(|row| row.role == Some(Role::ADMIN))
        .expect("missing ADMIN group");
    assert_eq!(admin_group._count.as_ref().and_then(|count| count._all), Some(1));
    assert_eq!(
        admin_group
            ._count
            .as_ref()
            .and_then(|count| count.display_name),
        Some(1)
    );
    assert_eq!(admin_group._sum.as_ref().and_then(|sum| sum.views), Some(12));
    assert_eq!(
        admin_group
            ._min
            .as_ref()
            .and_then(|min| min.display_name.clone()),
        Some("Alice".to_string())
    );

    db.transaction(TransactionOptions::default(), |tx| async move {
        let tx_users = User::nautilus(&tx);
        tx_users
            .create(UserCreateInput {
                display_name: Some("Cara".to_string()),
                role: Some(Role::ADMIN),
                views: Some(5),
                ..Default::default()
            })
            .await
            .map_err(core_to_connector)?;

        let tx_count = tx_users
            .count(UserCountArgs {
                where_: Some(User::role().eq(Role::ADMIN)),
                ..Default::default()
            })
            .await
            .map_err(core_to_connector)?;
        assert_eq!(tx_count, 2);

        let tx_groups = tx_users
            .group_by(UserGroupByArgs {
                by: vec![UserScalarField::Role],
                count: Some(UserCountAggregateInput {
                    _all: true,
                    display_name: true,
                    ..Default::default()
                }),
                sum: Some(UserSumAggregateInput {
                    views: true,
                    ..Default::default()
                }),
                order_by: vec![UserGroupByOrderBy::Field {
                    field: UserScalarField::Role,
                    direction: UserSortOrder::Asc,
                }],
                ..Default::default()
            })
            .await
            .map_err(core_to_connector)?;

        let admin_group = tx_groups
            .iter()
            .find(|row| row.role == Some(Role::ADMIN))
            .expect("missing ADMIN group inside transaction");
        assert_eq!(admin_group._count.as_ref().and_then(|count| count._all), Some(2));
        assert_eq!(
            admin_group
                ._count
                .as_ref()
                .and_then(|count| count.display_name),
            Some(2)
        );
        assert_eq!(admin_group._sum.as_ref().and_then(|sum| sum.views), Some(17));

        Ok(())
    })
    .await?;

    let committed_count = users
        .count(UserCountArgs {
            where_: Some(User::role().eq(Role::ADMIN)),
            ..Default::default()
        })
        .await?;
    assert_eq!(committed_count, 2);

    Ok(())
}
"#,
    )
    .expect("failed to write generated aggregate smoke test");

    let status = std::process::Command::new("cargo")
        .args(["test", "--quiet", "--offline", "--manifest-path"])
        .arg(tmp.path().join("Cargo.toml"))
        .status()
        .expect("failed to run cargo test on generated client");

    assert!(
        status.success(),
        "cargo test failed for generated Rust client aggregate smoke test"
    );
}

/// Verifies the expected Python package directory structure is created.
#[test]
fn test_write_python_code_creates_package_structure() {
    let ir = validate(SIMPLE_SCHEMA);
    let models = generate_all_python_models(&ir, false, 0);
    let enums_code = None;
    let client_code = Some(generate_python_client(&ir.models, "schema.nautilus", false));
    let runtime_files = python_runtime_files();
    let tmp = tempfile::TempDir::new().expect("failed to create temp dir");
    let path = tmp.path().to_str().unwrap();

    write_python_code(path, &models, enums_code, None, client_code, &runtime_files)
        .expect("write_python_code failed");

    let root = tmp.path();
    assert!(root.join("__init__.py").exists(), "__init__.py missing");
    assert!(root.join("client.py").exists(), "client.py missing");
    assert!(root.join("py.typed").exists(), "py.typed missing");
    assert!(
        root.join("transaction.py").exists(),
        "transaction.py missing"
    );
    assert!(
        root.join("models").join("__init__.py").exists(),
        "models/__init__.py missing"
    );
    assert!(
        root.join("models").join("user.py").exists(),
        "models/user.py missing"
    );
    assert!(
        root.join("enums").join("__init__.py").exists(),
        "enums/__init__.py missing"
    );
    assert!(
        root.join("errors").join("__init__.py").exists(),
        "errors/__init__.py missing"
    );
    assert!(
        root.join("_internal").join("__init__.py").exists(),
        "_internal/__init__.py missing"
    );
}

/// When enums are present an enums.py file is written under enums/.
#[test]
fn test_write_python_code_with_enums() {
    let ir = validate(ENUM_SCHEMA);
    let models = generate_all_python_models(&ir, false, 0);
    let enums_code = Some(generate_python_enums(&ir.enums));
    let runtime_files = python_runtime_files();
    let tmp = tempfile::TempDir::new().expect("failed to create temp dir");
    let path = tmp.path().to_str().unwrap();

    write_python_code(path, &models, enums_code, None, None, &runtime_files)
        .expect("write_python_code failed");

    assert!(
        tmp.path().join("enums").join("enums.py").exists(),
        "enums/enums.py missing"
    );
}

/// client.py is only created when a client_code is supplied (Some).
#[test]
fn test_write_python_code_without_client_no_client_py() {
    let ir = validate(SIMPLE_SCHEMA);
    let models = generate_all_python_models(&ir, false, 0);
    let runtime_files = python_runtime_files();
    let tmp = tempfile::TempDir::new().expect("failed to create temp dir");
    let path = tmp.path().to_str().unwrap();

    write_python_code(path, &models, None, None, None, &runtime_files)
        .expect("write_python_code failed");

    assert!(
        !tmp.path().join("client.py").exists(),
        "client.py should not be created when client_code is None"
    );
}