rullst-orm 13.0.0-alpha.2

Fast, un-opinionated, database-agnostic ORM and query builder for Rust
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
use super::*;

struct MockSubquery {
    sql: String,
    bindings: Vec<crate::RullstValue>,
}

impl SubqueryBuilder for MockSubquery {
    fn to_sql(&self) -> String {
        self.sql.clone()
    }
    fn bindings(&self) -> &Vec<crate::RullstValue> {
        &self.bindings
    }
}

#[test]
fn test_subquery_builder_trait() {
    let sq = MockSubquery {
        sql: "SELECT * FROM users WHERE id = ?".to_string(),
        bindings: vec![42.into()],
    };
    assert_eq!(sq.to_sql(), "SELECT * FROM users WHERE id = ?");
    assert_eq!(sq.bindings().len(), 1);
}

#[test]
fn test_enable_disable_query_log() {
    disable_query_log();
    assert!(!is_query_log_enabled());
    enable_query_log();
    assert!(is_query_log_enabled());
    disable_query_log();
    assert!(!is_query_log_enabled());
}

#[test]
fn test_join_clause() {
    let mut jc = JoinClause::new("users");
    jc.on("users.id", "=", "posts.user_id");
    assert_eq!(jc.to_sql(), "users.id = posts.user_id");
}

#[test]
fn schema_constructors_accept_owned_strings_and_reject_invalid_join_tables() {
    let column = Column::new(String::from("display_name"), String::from("TEXT"));
    assert_eq!(column.name, "display_name");
    assert_eq!(column.col_type, "TEXT");

    let valid = JoinClause::new(String::from("users"));
    assert!(valid.errors.is_empty());

    let invalid = JoinClause::new(String::from("users; DROP TABLE users"));
    assert_eq!(invalid.errors.len(), 1);
}

#[test]
fn test_validate_table_name() {
    assert!(validate_table_name("users").is_ok());
    assert!(validate_table_name("user_posts").is_ok());
    assert!(validate_table_name("DROP TABLE users").is_err());
    assert!(validate_table_name("../../../etc/shadow").is_err());
    assert!(validate_table_name("user-posts").is_err());
    // dots not allowed in table names
    assert!(validate_table_name("users.id").is_err());
    assert!(validate_table_name("").is_err()); // Empty table name
}

#[test]
fn test_validate_identifier() {
    assert!(validate_identifier("users").is_ok());
    assert!(validate_identifier("users.id").is_ok());
    assert!(validate_identifier("user_posts").is_ok());
    assert!(validate_identifier("user-posts").is_err());
    assert!(validate_identifier("users.post-id").is_err());
    assert!(validate_identifier("").is_err());
    assert!(validate_identifier("users.posts.id").is_err()); // two dots
    assert!(validate_identifier("DROP TABLE users").is_err());
    assert!(validate_identifier("id; DROP TABLE users--").is_err());
    // Length check
    assert!(validate_identifier(&"a".repeat(64)).is_ok());
    assert!(validate_identifier(&"a".repeat(65)).is_err());
    // Leading/trailing dot edge cases — all now rejected
    assert!(validate_identifier(".").is_err()); // bare dot: starts AND ends with dot
    assert!(validate_identifier(".users").is_err()); // leading dot
    assert!(validate_identifier("users.").is_err()); // trailing dot
    assert!(validate_identifier("user name").is_err()); // Spaces not allowed
    assert!(validate_identifier("admin'--").is_err()); // Quotes not allowed
    assert!(validate_identifier("users()").is_err()); // Parentheses not allowed
    assert!(validate_identifier("a*b").is_err()); // Asterisk not allowed

    // Extensive error tests
    assert!(validate_identifier("SELECT * FROM users").is_err());
    assert!(validate_identifier("users\nWHERE").is_err());
    assert!(validate_identifier("users\t").is_err());
    assert!(validate_identifier("\\").is_err());
}

#[test]
fn test_join_clause_on_invalid_operator() {
    let mut jc = JoinClause::new("posts");
    jc.on("posts.user_id", "OR 1=1 --", "users.id");
    assert!(!jc.errors.is_empty());
    assert!(jc.errors[0].to_string().contains("invalid operator"));
}

#[test]
fn test_join_clause_on_invalid_column() {
    let mut jc = JoinClause::new("posts");
    jc.on("users.id; DROP TABLE users--", "=", "posts.user_id");
    assert!(!jc.errors.is_empty());
    assert!(jc.errors[0].to_string().contains("invalid identifier"));
}

#[test]
fn test_timestamps_adds_columns() {
    let mut bp = Blueprint::new();
    bp.timestamps();
    assert_eq!(bp.columns.len(), 2);
    for (column, name) in bp.columns.iter().zip(["created_at", "updated_at"]) {
        assert_eq!(column.name, name);
        assert_eq!(column.col_type, "TIMESTAMPTZ");
        assert!(column.is_nullable);
        assert_eq!(column.default_value, Some(ColumnDefault::CurrentTimestamp));
    }
}

#[test]
fn timestamps_use_a_mysql_expression_default_and_keep_other_drivers() {
    // The SQLx `Any` pool keeps the alpha.1 TEXT timestamps.
    let mut bp = Blueprint::new();
    bp.id();
    bp.timestamps();

    let mysql = bp.render(None, "mysql", true).expect("MySQL DDL");
    assert!(
        mysql.contains("created_at TEXT DEFAULT (CURRENT_TIMESTAMP)"),
        "{mysql}"
    );
    assert!(
        mysql.contains("updated_at TEXT DEFAULT (CURRENT_TIMESTAMP)"),
        "{mysql}"
    );
    assert!(!mysql.contains("TEXT DEFAULT CURRENT_TIMESTAMP"), "{mysql}");

    for driver in ["sqlite", "postgres"] {
        let sql = bp.render(None, driver, true).expect("DDL");
        assert!(
            sql.contains("created_at TEXT DEFAULT CURRENT_TIMESTAMP"),
            "{driver}: {sql}"
        );
        assert!(
            sql.contains("updated_at TEXT DEFAULT CURRENT_TIMESTAMP"),
            "{driver}: {sql}"
        );
    }
}

#[test]
fn mysql_text_like_defaults_are_expressions_and_other_defaults_are_literals() {
    let mut bp = Blueprint::new();
    bp.string("status")
        .not_null()
        .default(ColumnDefault::Text("draft".to_string()));
    bp.string("note").default(ColumnDefault::Null);
    bp.integer("attempts")
        .not_null()
        .default(ColumnDefault::Integer(0));
    bp.enum_col("kind", vec!["a", "b"])
        .default(ColumnDefault::Text("a".to_string()));
    bp.columns.push({
        let mut payload = Column::new("payload", "json");
        payload.default(ColumnDefault::Text("{}".to_string()));
        payload
    });

    let mysql = bp.build_for_driver("mysql").expect("MySQL DDL");
    assert!(
        mysql.contains("status TEXT NOT NULL DEFAULT ('draft')"),
        "{mysql}"
    );
    assert!(mysql.contains("note TEXT DEFAULT NULL"), "{mysql}");
    assert!(
        mysql.contains("attempts INTEGER NOT NULL DEFAULT 0"),
        "{mysql}"
    );
    assert!(
        mysql.contains("kind TEXT CHECK(kind IN ('a', 'b')) DEFAULT ('a')"),
        "{mysql}"
    );
    assert!(mysql.contains("payload json DEFAULT ('{}')"), "{mysql}");

    let sqlite = bp.build_for_driver("sqlite").expect("SQLite DDL");
    assert!(
        sqlite.contains("status TEXT NOT NULL DEFAULT 'draft'"),
        "{sqlite}"
    );
    assert!(sqlite.contains("payload json DEFAULT '{}'"), "{sqlite}");
}

#[test]
fn ddl_text_literals_reject_backslashes_and_control_characters() {
    // A trailing backslash would escape the closing quote on MySQL/MariaDB.
    for text in ["x\\", "a\\'b", "line\nfeed", "nul\0"] {
        let mut defaults = Blueprint::new();
        defaults
            .string("status")
            .default(ColumnDefault::Text(text.to_string()));
        let mut variants = Blueprint::new();
        variants.enum_col("kind", vec!["ok", text]);
        for driver in ["mysql", "postgres", "sqlite"] {
            for blueprint in [&defaults, &variants] {
                assert!(
                    matches!(
                        blueprint.build_for_driver(driver),
                        Err(crate::Error::Validation(_))
                    ),
                    "{driver}: {text:?}"
                );
            }
        }
    }

    let mut blueprint = Blueprint::new();
    blueprint
        .string("note")
        .default(ColumnDefault::Text("owner's não".to_string()));
    blueprint.enum_col("kind", vec!["it's"]);
    let mysql = blueprint
        .build_for_driver("mysql")
        .expect("quoted literals");
    assert!(mysql.contains("DEFAULT ('owner''s não')"), "{mysql}");
    assert!(mysql.contains("CHECK(kind IN ('it''s'))"), "{mysql}");
}

#[test]
fn mysql_native_enum_defaults_remain_literals() {
    let mut blueprint = Blueprint::new();
    blueprint
        .native_enum::<AccountStatus>("status")
        .default(ColumnDefault::Text("owners_active".to_string()));

    let mysql = blueprint.build_for_driver("mysql").expect("MySQL enum DDL");
    assert!(
        mysql.contains("status ENUM('awaiting_review', 'owners_active') DEFAULT 'owners_active'"),
        "{mysql}"
    );
}

#[test]
fn test_soft_deletes_adds_nullable_column() {
    let mut bp = Blueprint::new();
    bp.soft_deletes();
    assert_eq!(bp.columns.len(), 1);
    assert_eq!(bp.columns[0].name, "deleted_at");
    assert!(bp.columns[0].is_nullable);
}

#[test]
fn test_blueprint_build_produces_valid_sql() {
    let mut bp = Blueprint::new();
    bp.id();
    bp.string("name").not_null();
    bp.integer("age");
    bp.big_integer("epoch_seconds");
    let sql = bp
        .build_for_driver("sqlite")
        .expect("build should succeed for valid columns");
    assert!(sql.contains("id INTEGER PRIMARY KEY"));
    assert!(sql.contains("name TEXT NOT NULL"));
    assert!(sql.contains("age INTEGER"));
    assert!(sql.contains("epoch_seconds BIGINT"));
}

#[test]
fn test_column_default_to_sql_escaping() {
    let default_text = ColumnDefault::Text("O'Reilly".to_string());
    assert_eq!(default_text.to_sql(), "'O''Reilly'");
}

#[test]
fn test_validate_identifier_multiple_dots() {
    assert!(validate_identifier("table.column").is_ok()); // one dot
    assert!(validate_identifier("schema.table.column").is_err()); // multiple dots
}

#[test]
fn test_column_default_sql_rendering() {
    assert_eq!(
        ColumnDefault::CurrentTimestamp.to_sql(),
        "CURRENT_TIMESTAMP"
    );
    assert_eq!(ColumnDefault::Null.to_sql(), "NULL");
    assert_eq!(ColumnDefault::Integer(42).to_sql(), "42");
    assert_eq!(ColumnDefault::Float(1.23).to_sql(), "1.23");
    assert_eq!(ColumnDefault::Text("hello".to_string()).to_sql(), "'hello'");
    // SQL injection via embedded quote must be escaped
    assert_eq!(ColumnDefault::Text("it's".to_string()).to_sql(), "'it''s'");
}

#[test]
fn test_join_clause_on_eq_binds_value() {
    let mut jc = JoinClause::new("orders");
    jc.on_eq("orders.user_id", 42i32);
    assert_eq!(jc.to_sql(), "orders.user_id = ?");
    assert_eq!(jc.bindings.len(), 1);
}

#[test]
fn test_join_clause_multiple_conditions() {
    let mut jc = JoinClause::new("posts");
    jc.on("posts.user_id", "=", "users.id");
    jc.on("posts.status", ">", "users.min_status");
    assert_eq!(
        jc.to_sql(),
        "posts.user_id = users.id AND posts.status > users.min_status"
    );
}

#[test]
fn test_column_builder_methods() {
    let mut col = Column::new("age", "INTEGER");
    assert_eq!(col.name, "age");
    assert_eq!(col.col_type, "INTEGER");
    assert!(col.is_nullable); // default is true
    assert!(!col.is_primary_key);
    assert!(!col.is_auto_increment);
    assert_eq!(col.default_value, None);

    col.not_null();
    assert!(!col.is_nullable);

    col.nullable();
    assert!(col.is_nullable);

    col.primary();
    assert!(col.is_primary_key);

    col.default(ColumnDefault::Integer(18));
    assert_eq!(col.default_value, Some(ColumnDefault::Integer(18)));

    assert!(!col.is_unique);
    col.unique();
    assert!(col.is_unique);
}

#[test]
fn test_column_nullable_and_not_null_flips() {
    let mut col = Column::new("status", "TEXT");
    assert!(col.is_nullable);
    col.not_null();
    assert!(!col.is_nullable);
    col.nullable();
    assert!(col.is_nullable);
}

#[test]
fn test_blueprint_float_and_boolean_columns() {
    let mut bp = Blueprint::new();
    let col_float = bp.float("price");
    assert_eq!(col_float.name, "price");
    assert_eq!(col_float.col_type, "REAL");
    assert!(col_float.is_nullable);

    let col_bool = bp.boolean("is_active");
    assert_eq!(col_bool.name, "is_active");
    assert_eq!(col_bool.col_type, "INTEGER");
    assert!(col_bool.is_nullable);
}

#[test]
fn test_blueprint_enum_column() {
    let mut bp = Blueprint::new();
    let col = bp.enum_col("status", vec!["Active", "Pending", "Canceled"]);
    assert_eq!(col.name, "status");
    assert_eq!(
        col.col_type,
        "TEXT CHECK(status IN ('Active', 'Pending', 'Canceled'))"
    );
    assert!(col.is_nullable);
}

struct AccountStatus;

impl DatabaseEnum for AccountStatus {
    const TYPE_NAME: &'static str = "account_status";
    const VARIANTS: &'static [&'static str] = &["awaiting_review", "owners_active"];
}

#[test]
fn native_enum_ddl_is_driver_specific_and_escaped() {
    let mut blueprint = Blueprint::new();
    blueprint.native_enum::<AccountStatus>("status").not_null();

    assert!(
        blueprint
            .build_for_driver("postgres")
            .expect("PostgreSQL enum DDL")
            .contains("status \"account_status\" NOT NULL")
    );
    assert!(
        blueprint
            .build_for_driver("mysql")
            .expect("MySQL enum DDL")
            .contains("status ENUM('awaiting_review', 'owners_active') NOT NULL")
    );
    assert!(
        blueprint
            .build_for_driver("sqlite")
            .expect("SQLite enum DDL")
            .contains("status TEXT CHECK(status IN ('awaiting_review', 'owners_active')) NOT NULL")
    );
}

struct ConflictingAccountStatus;

impl DatabaseEnum for ConflictingAccountStatus {
    const TYPE_NAME: &'static str = "account_status";
    const VARIANTS: &'static [&'static str] = &["Different"];
}

#[test]
fn native_enum_metadata_rejects_conflicting_named_types() {
    let mut blueprint = Blueprint::new();
    blueprint.native_enum::<AccountStatus>("primary_status");
    blueprint.native_enum::<ConflictingAccountStatus>("secondary_status");
    assert!(blueprint.postgres_enum_definitions().is_err());
}

#[test]
fn test_blueprint_boolean_column() {
    let mut bp = Blueprint::new();
    let col = bp.boolean("verified");
    assert_eq!(col.name, "verified");
    assert_eq!(col.col_type, "INTEGER");
    assert!(col.is_nullable);
    assert!(!col.is_primary_key);
    assert!(!col.is_auto_increment);
    assert_eq!(col.default_value, None);
}

#[tokio::test]
async fn test_db_migration_error_state_invalid_blueprint() {
    let result = Schema::create("invalid; DROP TABLE users", |bp| {
        bp.id();
    })
    .await;

    assert!(result.is_err());
}

#[tokio::test]
async fn test_drop_if_exists_invalid_table() {
    let result = Schema::drop_if_exists("invalid; name").await;
    assert!(result.is_err());
    assert!(matches!(result, Err(crate::Error::Internal(_))));
}

#[test]
fn test_max_query_limit_and_timeout_globals() {
    // Test limit
    set_max_query_limit(50);
    assert_eq!(get_max_query_limit(), Some(50));
    set_max_query_limit(0);
    assert_eq!(get_max_query_limit(), None);

    // Test timeout
    set_query_timeout(10);
    assert_eq!(
        get_query_timeout(),
        Some(std::time::Duration::from_secs(10))
    );
    set_query_timeout(0);
    assert_eq!(get_query_timeout(), None);
}

#[tokio::test]
async fn test_run_artisan_entrypoint() {
    // Calling run_artisan with empty lists. It parses std::env::args() and prints help
    // Note: we can't easily mock std::env::args here, so we just run it and let it fall through.
    let result = run_artisan(vec![], vec![]).await;
    assert!(result.is_ok());
}