backbone-orm 2.7.36

Backbone Framework ORM - Database layer with PostgreSQL support
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
//! Integration tests for Seeding module

use backbone_orm::{
    SeedManager, Seed, SeedType
};
use sqlx::PgPool;

// Test entity for seeding integration tests
#[derive(Debug, Clone, serde::Serialize, serde::Deserialize)]
struct TestCountry {
    id: String,
    code: String,
    name: String,
    iso3: String,
    currency: String,
}

// Programmatic seed implementation
struct CountriesSeed;

impl Seed for CountriesSeed {
    fn name(&self) -> &str {
        "countries_reference_data"
    }

    fn seed_type(&self) -> SeedType {
        SeedType::Reference
    }

    fn up(&self) -> &str {
        r#"
        INSERT INTO countries (id, code, name, iso3, currency) VALUES
        ('US', 'US', 'United States', 'USA', 'USD'),
        ('CA', 'CA', 'Canada', 'CAN', 'CAD'),
        ('GB', 'GB', 'United Kingdom', 'GBR', 'GBP'),
        ('DE', 'DE', 'Germany', 'DEU', 'EUR'),
        ('FR', 'FR', 'France', 'FRA', 'EUR');
        "#
    }

    fn down(&self) -> &str {
        "DELETE FROM countries WHERE code IN ('US', 'CA', 'GB', 'DE', 'FR');"
    }
}

// Test user seed data structure
#[derive(Debug, Clone, serde::Serialize, serde::Deserialize)]
struct TestUserSeed {
    name: String,
    email: String,
    role: String,
}

// Test user seed
struct TestUsersSeed;

impl Seed for TestUsersSeed {
    fn name(&self) -> &str {
        "test_users"
    }

    fn seed_type(&self) -> SeedType {
        SeedType::Test
    }

    fn up(&self) -> &str {
        r#"
        INSERT INTO users (id, name, email, role, created_at, updated_at) VALUES
        ('test-user-1', 'Test User 1', 'user1@test.local', 'user', NOW(), NOW()),
        ('test-user-2', 'Test User 2', 'user2@test.local', 'moderator', NOW(), NOW()),
        ('test-admin', 'Test Admin', 'admin@test.local', 'admin', NOW(), NOW());
        "#
    }

    fn down(&self) -> &str {
        "DELETE FROM users WHERE email LIKE '%@test.local';"
    }
}

// Setup test tables for seeding
async fn setup_seeding_test_database(database_url: &str) -> anyhow::Result<PgPool> {
    let pool = PgPool::connect(database_url).await?;

    // Create test tables
    sqlx::query(
        r#"
        CREATE TABLE IF NOT EXISTS countries (
            id VARCHAR(2) PRIMARY KEY,
            code VARCHAR(2) NOT NULL UNIQUE,
            name TEXT NOT NULL,
            iso3 VARCHAR(3) NOT NULL,
            currency VARCHAR(3) NOT NULL,
            created_at TIMESTAMP WITH TIME ZONE DEFAULT NOW(),
            updated_at TIMESTAMP WITH TIME ZONE DEFAULT NOW()
        )
        "#
    )
    .execute(&pool)
    .await?;

    sqlx::query(
        r#"
        CREATE TABLE IF NOT EXISTS users (
            id UUID PRIMARY KEY,
            name TEXT NOT NULL,
            email TEXT NOT NULL UNIQUE,
            role TEXT NOT NULL,
            created_at TIMESTAMP WITH TIME ZONE DEFAULT NOW(),
            updated_at TIMESTAMP WITH TIME ZONE DEFAULT NOW()
        )
        "#
    )
    .execute(&pool)
    .await?;

    // Clean up any existing test data
    sqlx::query("DELETE FROM countries").execute(&pool).await?;
    sqlx::query("DELETE FROM users").execute(&pool).await?;

    Ok(pool)
}

async fn cleanup_seeding_test_database(pool: &PgPool) -> anyhow::Result<()> {
    sqlx::query("DROP TABLE IF EXISTS users").execute(pool).await?;
    sqlx::query("DROP TABLE IF EXISTS countries").execute(pool).await?;
    Ok(())
}

#[tokio::test]
#[ignore] // Requires database connection
async fn test_seed_manager_basic_operations() -> anyhow::Result<()> {
    let database_url = "postgresql://localhost/test_db";
    let pool = setup_seeding_test_database(database_url).await?;

    // Create seed manager
    let seed_manager = SeedManager::new(pool);

    // Test that we can create a seed manager
    assert!(!pool.is_closed());

    // Test seed status on empty database
    let status = seed_manager.status().await?;
    assert_eq!(status.total_seeds, 0);

    cleanup_seeding_test_database(&seed_manager.pool()).await?;
    Ok(())
}

#[tokio::test]
#[ignore] // Requires database connection
async fn test_programmatic_seeds() -> anyhow::Result<()> {
    let database_url = "postgresql://localhost/test_db";
    let pool = setup_seeding_test_database(database_url).await?;

    // Create seed manager
    let seed_manager = SeedManager::new(pool.clone());

    // Create programmatic seed
    let countries_seed = CountriesSeed;

    // Apply the seed
    sqlx::query(countries_seed.up())
        .execute(&pool)
        .await?;

    // Verify data was inserted
    let count: i64 = sqlx::query_scalar("SELECT COUNT(*) FROM countries")
        .fetch_one(&pool)
        .await?;

    assert_eq!(count, 5);

    // Test rollback
    sqlx::query(countries_seed.down())
        .execute(&pool)
        .await?;

    // Verify data was removed
    let count_after_rollback: i64 = sqlx::query_scalar("SELECT COUNT(*) FROM countries")
        .fetch_one(&pool)
        .await?;

    assert_eq!(count_after_rollback, 0);

    cleanup_seeding_test_database(&pool).await?;
    Ok(())
}

#[tokio::test]
#[ignore] // Requires database connection
async fn test_seed_data_loading() -> anyhow::Result<()> {
    let database_url = "postgresql://localhost/test_db";
    let pool = setup_seeding_test_database(database_url).await?;

    // Create seed manager
    let seed_manager = SeedManager::new(pool);

    // Create test seed data
    let test_users = vec![
        TestUserSeed {
            name: "Test User 1".to_string(),
            email: "user1@test.local".to_string(),
            role: "user".to_string(),
        },
        TestUserSeed {
            name: "Test User 2".to_string(),
            email: "user2@test.local".to_string(),
            role: "moderator".to_string(),
        },
        TestUserSeed {
            name: "Test Admin".to_string(),
            email: "admin@test.local".to_string(),
            role: "admin".to_string(),
        },
    ];

    // Test bulk insert
    let json_data: Vec<serde_json::Value> = test_users
        .into_iter()
        .map(|user| serde_json::to_value(user).unwrap())
        .collect();

    let rows_inserted = seed_manager.bulk_insert("users", &json_data).await?;
    assert_eq!(rows_inserted, 3);

    // Verify data was inserted correctly
    let users: Vec<serde_json::Value> = sqlx::query_as("SELECT name, email, role FROM users ORDER BY name")
        .fetch_all(&seed_manager.pool())
        .await?;

    assert_eq!(users.len(), 3);

    // Verify specific user data
    let admin_user: Option<serde_json::Value> = sqlx::query_as("SELECT * FROM users WHERE role = 'admin'")
        .fetch_optional(&seed_manager.pool())
        .await?;

    assert!(admin_user.is_some());

    cleanup_seeding_test_database(&seed_manager.pool()).await?;
    Ok(())
}

#[tokio::test]
#[ignore] // Requires database connection
async fn test_seed_file_creation() -> anyhow::Result<()> {
    let database_url = "postgresql://localhost/test_db";
    let pool = PgPool::connect(database_url).await?;

    // Create seed manager
    let seed_manager = SeedManager::new(pool);

    // Test creating different types of seed files
    seed_manager.create_seed("reference_countries", SeedType::Reference).await?;
    seed_manager.create_seed("test_users", SeedType::Test).await?;
    seed_manager.create_seed("initial_data", SeedType::Data).await?;

    // Verify seed files were created
    assert!(std::path::Path::new("seeds").exists());

    // Count seed files (excluding revert files)
    let seed_count = std::fs::read_dir("seeds")?
        .filter_map(|entry| entry.ok())
        .filter(|entry| {
            entry.path().extension().and_then(|ext| ext.to_str()) == Some("sql") &&
            !entry.path().file_name().unwrap().to_string_lossy().contains("_revert")
        })
        .count();

    assert_eq!(seed_count, 3);
    assert_eq!(seed_count, 3); // 3 regular seeds + 3 revert files = 6 total

    // Clean up test seed files
    std::fs::remove_dir_all("seeds")?;

    Ok(())
}

#[tokio::test]
#[ignore] // Requires database connection
async fn test_seed_history_and_status() -> anyhow::Result<()> {
    let database_url = "postgresql://localhost/test_db";
    let pool = setup_seeding_test_database(database_url).await?;

    // Create seed manager
    let seed_manager = SeedManager::new(pool.clone());

    // Apply a test seed manually to track history
    let test_users_seed = TestUsersSeed;

    // Manually execute and track the seed
    sqlx::query(test_users_seed.up())
        .execute(&pool)
        .await?;

    // Record the seed in our tracking table
    sqlx::query("INSERT INTO schema_seeds (name, seed_type) VALUES ($1, $2)")
        .bind(test_users_seed.name())
        .bind("test") // This would normally be derived from SeedType enum
        .execute(&pool)
        .await?;

    // Test history
    let history = seed_manager.history().await?;
    assert_eq!(history.len(), 1);
    assert_eq!(history[0].name, "test_users");
    assert_eq!(history[0].seed_type, "test");

    // Test status
    let status = seed_manager.status().await?;
    assert_eq!(status.total_seeds, 1);
    assert_eq!(status.applied_seeds.len(), 1);
    assert!(status.pending_seeds.is_empty());
    assert_eq!(status.last_seed, Some("test_users".to_string()));

    cleanup_seeding_test_database(&pool).await?;
    Ok(())
}

#[tokio::test]
#[ignore] // Requires database connection
async fn test_seed_reversion() -> anyhow::Result<()> {
    let database_url = "postgresql://localhost/test_db";
    let pool = setup_seeding_test_database(database_url).await?;

    // Create seed manager
    let seed_manager = SeedManager::new(pool.clone());

    // Apply test seeds
    let countries_seed = CountriesSeed;
    let test_users_seed = TestUsersSeed;

    // Apply seeds manually (simulating the seed manager behavior)
    sqlx::query(countries_seed.up())
        .execute(&pool)
        .await?;

    sqlx::query(test_users_seed.up())
        .execute(&pool)
        .await?;

    // Track seeds in database
    sqlx::query("INSERT INTO schema_seeds (name, seed_type) VALUES ($1, $2)")
        .bind(countries_seed.name())
        .bind("reference")
        .execute(&pool)
        .await?;

    sqlx::query("INSERT INTO schema_seeds (name, seed_type) VALUES ($1, $2)")
        .bind(test_users_seed.name())
        .bind("test")
        .execute(&pool)
        .await?;

    // Verify data exists
    let country_count: i64 = sqlx::query_scalar("SELECT COUNT(*) FROM countries")
        .fetch_one(&pool)
        .await?;
    let user_count: i64 = sqlx::query_scalar("SELECT COUNT(*) FROM users")
        .fetch_one(&pool)
        .await?;

    assert_eq!(country_count, 5);
    assert_eq!(user_count, 3);

    // Revert seeds (in reverse order)
    sqlx::query(test_users_seed.down())
        .execute(&pool)
        .await?;

    sqlx::query(countries_seed.down())
        .execute(&pool)
        .await?;

    // Remove from tracking
    sqlx::query("DELETE FROM schema_seeds WHERE name = $1")
        .bind(test_users_seed.name())
        .execute(&pool)
        .await?;

    sqlx::query("DELETE FROM schema_seeds WHERE name = $1")
        .bind(countries_seed.name())
        .execute(&pool)
        .await?;

    // Verify data was removed
    let country_count_after: i64 = sqlx::query_scalar("SELECT COUNT(*) FROM countries")
        .fetch_one(&pool)
        .await?;
    let user_count_after: i64 = sqlx::query_scalar("SELECT COUNT(*) FROM users")
        .fetch_one(&pool)
        .await?;

    assert_eq!(country_count_after, 0);
    assert_eq!(user_count_after, 0);

    cleanup_seeding_test_database(&pool).await?;
    Ok(())
}

#[tokio::test]
async fn test_seeding_types() {
    // Test that all seeding types can be constructed and used

    // Test SeedType enum
    let data_seed = SeedType::Data;
    let test_seed = SeedType::Test;
    let reference_seed = SeedType::Reference;

    // Verify all types can be created
    let _ = (data_seed, test_seed, reference_seed);

    // Test Seed trait implementation with our mock seeds
    let countries_seed = CountriesSeed;
    let test_users_seed = TestUsersSeed;

    // Test trait methods
    assert_eq!(countries_seed.name(), "countries_reference_data");
    match countries_seed.seed_type() {
        SeedType::Reference => assert!(true),
        _ => assert!(false),
    }
    assert!(countries_seed.up().contains("INSERT INTO countries"));
    assert!(countries_seed.down().contains("DELETE FROM countries"));

    assert_eq!(test_users_seed.name(), "test_users");
    match test_users_seed.seed_type() {
        SeedType::Test => assert!(true),
        _ => assert!(false),
    }
    assert!(test_users_seed.up().contains("INSERT INTO users"));
    assert!(test_users_seed.down().contains("@test.local"));
}

#[tokio::test]
async fn test_seed_data_structures() {
    // Test seed data structures can be created and serialized

    let test_user = TestUserSeed {
        name: "Test User".to_string(),
        email: "test@test.local".to_string(),
        role: "user".to_string(),
    };

    let test_country = TestCountry {
        id: "US".to_string(),
        code: "US".to_string(),
        name: "United States".to_string(),
        iso3: "USA".to_string(),
        currency: "USD".to_string(),
    };

    // Test serialization
    let user_json = serde_json::to_string(&test_user).unwrap();
    let country_json = serde_json::to_string(&test_country).unwrap();

    assert!(user_json.contains("test@test.local"));
    assert!(country_json.contains("United States"));

    // Test deserialization
    let user_deserialized: TestUserSeed = serde_json::from_str(&user_json).unwrap();
    let country_deserialized: TestCountry = serde_json::from_str(&country_json).unwrap();

    assert_eq!(user_deserialized.name, test_user.name);
    assert_eq!(user_deserialized.email, test_user.email);
    assert_eq!(country_deserialized.id, test_country.id);
    assert_eq!(country_deserialized.name, test_country.name);
}

#[tokio::test]
async fn test_seeding_file_naming() {
    // Test seed file naming conventions
    let timestamp = "20231201_120000";
    let seed_names = vec![
        format!("{}_{}_data.sql", timestamp, "initial_data"),
        format!("{}_{}_test.sql", timestamp, "test_users"),
        format!("{}_{}_reference.sql", timestamp, "countries"),
        format!("{}_{}_revert.sql", timestamp, "initial_data"),
    ];

    for name in &seed_names {
        // Verify naming pattern
        assert!(name.starts_with(&format!("{}_", timestamp)));
        assert!(name.ends_with(".sql"));

        // Verify no consecutive dots
        assert!(!name.contains(".."));
    }

    // Verify revert file naming
    let revert_files: Vec<&String> = seed_names
        .iter()
        .filter(|name| name.contains("_revert"))
        .collect();

    assert_eq!(revert_files.len(), 1);
    assert!(revert_files[0].ends_with("_revert.sql"));
}