migratex 0.2.2

Agnostic migration toolkit library.
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
585
// This file is part of "Migratex - A Migrations Toolkit".
//
// This source code is licensed under the MIT license, please view the LICENSE
// file distributed with this source code. For the full
// information and documentation: https://github.com/nicolab/migratex
// -----------------------------------------------------------------------------

// -- Tests for Migratex core functionality.

#![cfg(feature = "json")]

mod common;

use migratex::{MetaStatus, Metadata, Migratex};
use okerr::Result;

use common::{TempDir, TestContext, TestMetadata, create_test_migrations};

#[tokio::test]
async fn test_migratex_new() -> Result<()> {
    let temp = TempDir::new()?;
    let path = temp.metadata_path();

    let mut ctx = TestContext::new();
    let mut meta = TestMetadata::load_or_init(&path)?;
    let migrations = create_test_migrations(3);

    let mx = Migratex::new(&mut ctx, &mut meta, migrations);

    assert_eq!(mx.metadata().version(), 0);
    assert_eq!(mx.latest_version(), 3);

    Ok(())
}

#[tokio::test]
async fn test_migrate_to_latest() -> Result<()> {
    let temp = TempDir::new()?;
    let path = temp.metadata_path();

    let mut ctx = TestContext::new();
    let mut meta = TestMetadata::load_or_init(&path)?;
    let migrations = create_test_migrations(5);

    let mut mx = Migratex::new(&mut ctx, &mut meta, migrations);

    // Migrate to latest
    mx.migrate_to_latest().await?;

    assert_eq!(meta.version(), 5);
    assert_eq!(meta.status(), MetaStatus::Clean);
    assert_eq!(ctx.applied_migrations, vec![1, 2, 3, 4, 5]);

    Ok(())
}

#[tokio::test]
async fn test_migrate_to_specific_version() -> Result<()> {
    let temp = TempDir::new()?;
    let path = temp.metadata_path();

    let mut ctx = TestContext::new();
    let mut meta = TestMetadata::load_or_init(&path)?;
    let migrations = create_test_migrations(10);

    let mut mx = Migratex::new(&mut ctx, &mut meta, migrations);

    // Migrate to version 3
    mx.migrate_to(3).await?;

    assert_eq!(meta.version(), 3);
    assert_eq!(meta.status(), MetaStatus::Clean);
    assert_eq!(ctx.applied_migrations, vec![1, 2, 3]);

    Ok(())
}

#[tokio::test]
async fn test_migrate_to_same_version_is_noop() -> Result<()> {
    let temp = TempDir::new()?;
    let path = temp.metadata_path();

    let mut ctx = TestContext::new();
    let mut meta = TestMetadata::load_or_init(&path)?;
    let migrations = create_test_migrations(5);

    let mut mx = Migratex::new(&mut ctx, &mut meta, migrations);

    // Migrate to version 3
    mx.migrate_to(3).await?;

    // Drop mx to release borrows
    drop(mx);

    let initial_updated = meta.updated_at().to_string();
    assert_eq!(meta.version(), 3);
    assert_eq!(ctx.applied_migrations, vec![1, 2, 3]);

    // Wait a bit
    std::thread::sleep(std::time::Duration::from_millis(10));

    // Create new Migratex instance
    let migrations2 = create_test_migrations(5);
    let mut mx = Migratex::new(&mut ctx, &mut meta, migrations2);

    // Migrate to same version should be no-op
    mx.migrate_to(3).await?;

    drop(mx);

    assert_eq!(meta.version(), 3);
    assert_eq!(ctx.applied_migrations, vec![1, 2, 3]);
    // updated_at should not have changed
    assert_eq!(meta.updated_at(), initial_updated);

    Ok(())
}

#[tokio::test]
async fn test_migrate_next() -> Result<()> {
    let temp = TempDir::new()?;
    let path = temp.metadata_path();

    let mut ctx = TestContext::new();
    let mut meta = TestMetadata::load_or_init(&path)?;
    let migrations = create_test_migrations(5);

    let mut mx = Migratex::new(&mut ctx, &mut meta, migrations);

    // Start at version 0, migrate next
    mx.migrate_next().await?;
    drop(mx);
    assert_eq!(meta.version(), 1);
    assert_eq!(ctx.applied_migrations, vec![1]);

    let migrations2 = create_test_migrations(5);
    let mut mx = Migratex::new(&mut ctx, &mut meta, migrations2);
    mx.migrate_next().await?;
    drop(mx);
    assert_eq!(meta.version(), 2);
    assert_eq!(ctx.applied_migrations, vec![1, 2]);

    let migrations3 = create_test_migrations(5);
    let mut mx = Migratex::new(&mut ctx, &mut meta, migrations3);
    mx.migrate_next().await?;
    drop(mx);
    assert_eq!(meta.version(), 3);
    assert_eq!(ctx.applied_migrations, vec![1, 2, 3]);

    Ok(())
}

#[tokio::test]
async fn test_migrate_next_at_latest_is_noop() -> Result<()> {
    let temp = TempDir::new()?;
    let path = temp.metadata_path();

    let mut ctx = TestContext::new();
    let mut meta = TestMetadata::load_or_init(&path)?;
    let migrations = create_test_migrations(3);

    let mut mx = Migratex::new(&mut ctx, &mut meta, migrations);

    // Migrate to latest
    mx.migrate_to_latest().await?;
    drop(mx);
    assert_eq!(meta.version(), 3);

    // Migrate next should be no-op
    let migrations2 = create_test_migrations(3);
    let mut mx = Migratex::new(&mut ctx, &mut meta, migrations2);
    mx.migrate_next().await?;
    drop(mx);
    assert_eq!(meta.version(), 3);
    assert_eq!(ctx.applied_migrations, vec![1, 2, 3]);

    Ok(())
}

#[tokio::test]
async fn test_migrate_prev() -> Result<()> {
    let temp = TempDir::new()?;
    let path = temp.metadata_path();

    let mut ctx = TestContext::new();
    let mut meta = TestMetadata::load_or_init(&path)?;
    let migrations = create_test_migrations(5);

    let mut mx = Migratex::new(&mut ctx, &mut meta, migrations);

    // Migrate to latest
    mx.migrate_to_latest().await?;
    drop(mx);
    assert_eq!(meta.version(), 5);

    // Migrate prev
    let migrations2 = create_test_migrations(5);
    let mut mx = Migratex::new(&mut ctx, &mut meta, migrations2);
    mx.migrate_prev().await?;
    drop(mx);
    assert_eq!(meta.version(), 4);
    assert_eq!(ctx.applied_migrations, vec![1, 2, 3, 4]);

    let migrations3 = create_test_migrations(5);
    let mut mx = Migratex::new(&mut ctx, &mut meta, migrations3);
    mx.migrate_prev().await?;
    drop(mx);
    assert_eq!(meta.version(), 3);
    assert_eq!(ctx.applied_migrations, vec![1, 2, 3]);

    Ok(())
}

#[tokio::test]
async fn test_migrate_prev_at_zero_is_noop() -> Result<()> {
    let temp = TempDir::new()?;
    let path = temp.metadata_path();

    let mut ctx = TestContext::new();
    let mut meta = TestMetadata::load_or_init(&path)?;
    let migrations = create_test_migrations(3);

    let mut mx = Migratex::new(&mut ctx, &mut meta, migrations);

    // Migrate prev should be no-op
    mx.migrate_prev().await?;
    drop(mx);
    assert_eq!(meta.version(), 0);
    assert!(ctx.applied_migrations.is_empty());

    Ok(())
}

#[tokio::test]
async fn test_migrate_to_zero() -> Result<()> {
    let temp = TempDir::new()?;
    let path = temp.metadata_path();

    let mut ctx = TestContext::new();
    let mut meta = TestMetadata::load_or_init(&path)?;
    let migrations = create_test_migrations(5);

    let mut mx = Migratex::new(&mut ctx, &mut meta, migrations);

    // Migrate to latest
    mx.migrate_to_latest().await?;
    drop(mx);
    assert_eq!(meta.version(), 5);
    assert_eq!(ctx.applied_migrations, vec![1, 2, 3, 4, 5]);

    // Rollback everything
    let migrations2 = create_test_migrations(5);
    let mut mx = Migratex::new(&mut ctx, &mut meta, migrations2);
    mx.migrate_to_zero().await?;
    drop(mx);
    assert_eq!(meta.version(), 0);
    assert_eq!(meta.status(), MetaStatus::Clean);
    assert!(ctx.applied_migrations.is_empty());

    Ok(())
}

#[tokio::test]
async fn test_migrate_down() -> Result<()> {
    let temp = TempDir::new()?;
    let path = temp.metadata_path();

    let mut ctx = TestContext::new();
    let mut meta = TestMetadata::load_or_init(&path)?;
    let migrations = create_test_migrations(5);

    let mut mx = Migratex::new(&mut ctx, &mut meta, migrations);

    // Migrate to latest
    mx.migrate_to_latest().await?;
    drop(mx);
    assert_eq!(meta.version(), 5);

    // Migrate down to version 2
    let migrations2 = create_test_migrations(5);
    let mut mx = Migratex::new(&mut ctx, &mut meta, migrations2);
    mx.migrate_to(2).await?;
    drop(mx);
    assert_eq!(meta.version(), 2);
    assert_eq!(meta.status(), MetaStatus::Clean);
    assert_eq!(ctx.applied_migrations, vec![1, 2]);

    Ok(())
}

#[tokio::test]
async fn test_migrate_up_then_down_then_up() -> Result<()> {
    let temp = TempDir::new()?;
    let path = temp.metadata_path();

    let mut ctx = TestContext::new();
    let mut meta = TestMetadata::load_or_init(&path)?;
    let migrations = create_test_migrations(5);

    let mut mx = Migratex::new(&mut ctx, &mut meta, migrations);

    // Up to 3
    mx.migrate_to(3).await?;
    drop(mx);
    assert_eq!(meta.version(), 3);
    assert_eq!(ctx.applied_migrations, vec![1, 2, 3]);

    // Down to 1
    let migrations2 = create_test_migrations(5);
    let mut mx = Migratex::new(&mut ctx, &mut meta, migrations2);
    mx.migrate_to(1).await?;
    drop(mx);
    assert_eq!(meta.version(), 1);
    assert_eq!(ctx.applied_migrations, vec![1]);

    // Up to 5
    let migrations3 = create_test_migrations(5);
    let mut mx = Migratex::new(&mut ctx, &mut meta, migrations3);
    mx.migrate_to(5).await?;
    drop(mx);
    assert_eq!(meta.version(), 5);
    assert_eq!(ctx.applied_migrations, vec![1, 2, 3, 4, 5]);

    Ok(())
}

#[tokio::test]
async fn test_migration_failure_marks_failed() -> Result<()> {
    let temp = TempDir::new()?;
    let path = temp.metadata_path();

    // Create context that will fail at version 3
    let mut ctx = TestContext::with_fail_at(3);
    let mut meta = TestMetadata::load_or_init(&path)?;
    let migrations = create_test_migrations(5);

    let mut mx = Migratex::new(&mut ctx, &mut meta, migrations);

    // Try to migrate to latest, should fail at version 3
    let result = mx.migrate_to_latest().await;
    assert!(result.is_err());

    // Metadata should be marked as failed
    assert_eq!(meta.status(), MetaStatus::Failed);

    // Version should be at 2 (last successful migration)
    assert_eq!(meta.version(), 2);
    assert_eq!(ctx.applied_migrations, vec![1, 2]);

    Ok(())
}

#[tokio::test]
async fn test_migration_failure_during_down() -> Result<()> {
    let temp = TempDir::new()?;
    let path = temp.metadata_path();

    let mut ctx = TestContext::new();
    let mut meta = TestMetadata::load_or_init(&path)?;
    let migrations = create_test_migrations(5);

    let mut mx = Migratex::new(&mut ctx, &mut meta, migrations);

    // Migrate up successfully
    mx.migrate_to_latest().await?;
    drop(mx);
    assert_eq!(meta.version(), 5);

    // Now create new context with failure
    let mut ctx2 = TestContext::with_fail_at(3);
    ctx2.applied_migrations = ctx.applied_migrations.clone();

    // Try to migrate down, should fail at version 3
    let migrations2 = create_test_migrations(5);
    let mut mx = Migratex::new(&mut ctx2, &mut meta, migrations2);
    let result = mx.migrate_to(1).await;
    assert!(result.is_err());
    drop(mx);

    // Status should be failed
    assert_eq!(meta.status(), MetaStatus::Failed);

    Ok(())
}

#[tokio::test]
async fn test_latest_version_with_empty_migrations() -> Result<()> {
    let temp = TempDir::new()?;
    let path = temp.metadata_path();

    let mut ctx = TestContext::new();
    let mut meta = TestMetadata::load_or_init(&path)?;
    let migrations: Vec<migratex::BoxMigration<TestContext>> = vec![];

    let mx = Migratex::new(&mut ctx, &mut meta, migrations);

    assert_eq!(mx.latest_version(), 0);

    Ok(())
}

#[tokio::test]
async fn test_migrate_to_latest_with_no_migrations() -> Result<()> {
    let temp = TempDir::new()?;
    let path = temp.metadata_path();

    let mut ctx = TestContext::new();
    let mut meta = TestMetadata::load_or_init(&path)?;
    let migrations: Vec<migratex::BoxMigration<TestContext>> = vec![];

    let mut mx = Migratex::new(&mut ctx, &mut meta, migrations);

    mx.migrate_to_latest().await?;

    assert_eq!(meta.version(), 0);
    assert_eq!(meta.status(), MetaStatus::Clean);

    Ok(())
}

#[tokio::test]
async fn test_migrate_to_future_version_beyond_latest() -> Result<()> {
    let temp = TempDir::new()?;
    let path = temp.metadata_path();

    let mut ctx = TestContext::new();
    let mut meta = TestMetadata::load_or_init(&path)?;
    let migrations = create_test_migrations(3);

    let mut mx = Migratex::new(&mut ctx, &mut meta, migrations);

    // Try to migrate to version 10 (beyond latest which is 3)
    mx.migrate_to(10).await?;

    // Should only migrate to latest (3)
    assert_eq!(meta.version(), 3);
    assert_eq!(ctx.applied_migrations, vec![1, 2, 3]);

    Ok(())
}

#[tokio::test]
async fn test_migrate_to_negative_version() -> Result<()> {
    let temp = TempDir::new()?;
    let path = temp.metadata_path();

    let mut ctx = TestContext::new();
    let mut meta = TestMetadata::load_or_init(&path)?;
    let migrations = create_test_migrations(5);

    let mut mx = Migratex::new(&mut ctx, &mut meta, migrations);

    // Migrate up first
    mx.migrate_to(3).await?;
    drop(mx);
    assert_eq!(meta.version(), 3);

    // Try to migrate to negative version
    let migrations2 = create_test_migrations(5);
    let mut mx = Migratex::new(&mut ctx, &mut meta, migrations2);
    mx.migrate_to(-1).await?;
    drop(mx);

    // Should migrate to 0
    assert_eq!(meta.version(), 0);
    assert!(ctx.applied_migrations.is_empty());

    Ok(())
}

#[tokio::test]
async fn test_status_transitions() -> Result<()> {
    let temp = TempDir::new()?;
    let path = temp.metadata_path();

    let mut ctx = TestContext::new();
    let mut meta = TestMetadata::load_or_init(&path)?;
    let migrations = create_test_migrations(3);

    let mut mx = Migratex::new(&mut ctx, &mut meta, migrations);

    // During migration, status should transition
    mx.migrate_to(2).await?;
    drop(mx);

    // After successful migration, should be clean
    assert_eq!(meta.status(), MetaStatus::Clean);

    Ok(())
}

#[tokio::test]
async fn test_context_getter() -> Result<()> {
    let temp = TempDir::new()?;
    let path = temp.metadata_path();

    let mut ctx = TestContext::new();
    ctx.applied_migrations.push(99);

    let mut meta = TestMetadata::load_or_init(&path)?;
    let migrations = create_test_migrations(3);

    let mx = Migratex::new(&mut ctx, &mut meta, migrations);

    // Test context getter
    assert_eq!(mx.context().applied_migrations, vec![99]);

    Ok(())
}

#[tokio::test]
async fn test_metadata_getter() -> Result<()> {
    let temp = TempDir::new()?;
    let path = temp.metadata_path();

    let mut ctx = TestContext::new();
    let mut meta = TestMetadata::load_or_init(&path)?;
    meta.set_version(42);

    let migrations = create_test_migrations(3);

    let mx = Migratex::new(&mut ctx, &mut meta, migrations);

    // Test metadata getter
    assert_eq!(mx.metadata().version(), 42);

    Ok(())
}

#[tokio::test]
async fn test_multiple_sequential_migrations() -> Result<()> {
    let temp = TempDir::new()?;
    let path = temp.metadata_path();

    let mut ctx = TestContext::new();
    let mut meta = TestMetadata::load_or_init(&path)?;
    let migrations = create_test_migrations(10);

    let mut mx = Migratex::new(&mut ctx, &mut meta, migrations);

    // Migrate all at once
    mx.migrate_to(10).await?;
    drop(mx);

    assert_eq!(meta.version(), 10);
    assert_eq!(meta.status(), MetaStatus::Clean);
    assert_eq!(ctx.applied_migrations, vec![1, 2, 3, 4, 5, 6, 7, 8, 9, 10]);

    Ok(())
}

#[tokio::test]
async fn test_rollback_and_reapply() -> Result<()> {
    let temp = TempDir::new()?;
    let path = temp.metadata_path();

    let mut ctx = TestContext::new();
    let mut meta = TestMetadata::load_or_init(&path)?;
    let migrations = create_test_migrations(5);

    let mut mx = Migratex::new(&mut ctx, &mut meta, migrations);

    // Apply all
    mx.migrate_to_latest().await?;
    drop(mx);
    assert_eq!(meta.version(), 5);

    // Rollback to 2
    let migrations2 = create_test_migrations(5);
    let mut mx = Migratex::new(&mut ctx, &mut meta, migrations2);
    mx.migrate_to(2).await?;
    drop(mx);
    assert_eq!(meta.version(), 2);
    assert_eq!(ctx.applied_migrations, vec![1, 2]);

    // Reapply to 5
    let migrations3 = create_test_migrations(5);
    let mut mx = Migratex::new(&mut ctx, &mut meta, migrations3);
    mx.migrate_to_latest().await?;
    drop(mx);
    assert_eq!(meta.version(), 5);
    assert_eq!(ctx.applied_migrations, vec![1, 2, 3, 4, 5]);

    Ok(())
}