spring-batch-rs 0.3.4

A toolkit for building enterprise-grade batch applications
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
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
//! # FTP Integration Tests
//!
//! This module contains integration tests for FTP tasklets using testcontainers
//! to spin up a real FTP server for comprehensive testing.

#[cfg(feature = "ftp")]
mod ftp_tests {
    use spring_batch_rs::{
        core::{
            job::{Job, JobBuilder},
            step::{Step, StepBuilder},
        },
        tasklet::ftp::{
            FtpGetFolderTaskletBuilder, FtpGetTaskletBuilder, FtpPutFolderTaskletBuilder,
            FtpPutTaskletBuilder,
        },
    };
    use std::{
        fs::{self, File},
        io::Write,
        path::Path,
        time::Duration,
    };
    #[allow(unused_imports)]
    use testcontainers::{
        GenericImage, ImageExt,
        core::{ContainerPort, WaitFor},
        runners::AsyncRunner,
    };

    #[allow(unused_imports)]
    use tokio::time::sleep;

    /// Shared FTP container information
    #[derive(Debug, Clone)]
    pub struct FtpServerInfo {
        pub host: String,
        pub port: u16,
        pub username: String,
        pub password: String,
    }

    /// Create a new FTP server for testing
    async fn create_ftp_server() -> Result<FtpServerInfo, Box<dyn std::error::Error>> {
        let _ = env_logger::try_init();

        // Use a random port to avoid conflicts
        let random_port = 21000 + (std::process::id() % 1000) as u16;

        let ftp_container = GenericImage::new("delfer/alpine-ftp-server", "latest")
            .with_wait_for(WaitFor::seconds(5))
            .with_exposed_port(ContainerPort::Tcp(21))
            .with_mapped_port(random_port, ContainerPort::Tcp(21))
            .with_mapped_port(random_port + 1, ContainerPort::Tcp(random_port + 1))
            .with_env_var("USERS", "testuser|testpass123|/home/testuser|1000")
            .with_env_var("ADDRESS", "127.0.0.1")
            .with_env_var("MIN_PORT", (random_port + 1).to_string())
            .with_env_var("MAX_PORT", (random_port + 1).to_string())
            .start()
            .await?;

        let ftp_port = ftp_container.get_host_port_ipv4(21).await?;
        let ftp_host = ftp_container.get_host().await?;

        let server_info = FtpServerInfo {
            host: ftp_host.to_string(),
            port: ftp_port,
            username: "testuser".to_string(),
            password: "testpass123".to_string(),
        };

        println!(
            "FTP Server started at {}:{}",
            server_info.host, server_info.port
        );

        // Add a small delay to ensure the FTP server is fully ready
        tokio::time::sleep(tokio::time::Duration::from_secs(3)).await;

        // Keep the container alive by leaking it
        std::mem::forget(ftp_container);

        Ok(server_info)
    }

    /// Helper function to create unique test directories to avoid conflicts
    fn create_unique_test_dir(test_name: &str) -> std::path::PathBuf {
        let timestamp = std::time::SystemTime::now()
            .duration_since(std::time::UNIX_EPOCH)
            .unwrap()
            .as_nanos();
        std::env::temp_dir().join(format!("{}_{}", test_name, timestamp))
    }

    /// Helper function to create unique remote file/folder names to avoid conflicts
    fn create_unique_remote_name(prefix: &str) -> String {
        let timestamp = std::time::SystemTime::now()
            .duration_since(std::time::UNIX_EPOCH)
            .unwrap()
            .as_nanos();
        format!("./{}_{}_{}", prefix, std::process::id(), timestamp)
    }

    /// Helper function to create test files in a directory
    fn create_test_files(base_dir: &Path) -> Result<(), std::io::Error> {
        fs::create_dir_all(base_dir)?;

        // Create some test files
        let files = vec![
            ("file1.txt", "Content of file 1\nLine 2 of file 1"),
            ("file2.txt", "Content of file 2\nLine 2 of file 2"),
            ("data.json", r#"{"name": "test", "value": 42}"#),
        ];

        for (filename, content) in files {
            let file_path = base_dir.join(filename);
            let mut file = File::create(file_path)?;
            file.write_all(content.as_bytes())?;
        }

        Ok(())
    }

    #[tokio::test]
    async fn test_ftp_tasklet_builders() -> Result<(), Box<dyn std::error::Error>> {
        // Test FTP PUT tasklet builder
        let temp_dir = std::env::temp_dir().join("ftp_builder_test");
        fs::create_dir_all(&temp_dir)?;

        let test_file = temp_dir.join("test.txt");
        fs::write(&test_file, "test content")?;

        let put_tasklet = FtpPutTaskletBuilder::new()
            .host("localhost")
            .port(21)
            .username("testuser")
            .password("testpass")
            .local_file(&test_file)
            .remote_file("/test.txt")
            .passive_mode(true)
            .timeout(Duration::from_secs(30))
            .build()?;

        // Test FTP GET tasklet builder
        let download_file = temp_dir.join("download.txt");
        let get_tasklet = FtpGetTaskletBuilder::new()
            .host("localhost")
            .port(21)
            .username("testuser")
            .password("testpass")
            .remote_file("/test.txt")
            .local_file(&download_file)
            .passive_mode(true)
            .timeout(Duration::from_secs(30))
            .build()?;

        // Test FTP PUT FOLDER tasklet builder
        let upload_dir = temp_dir.join("upload");
        create_test_files(&upload_dir)?;

        let put_folder_tasklet = FtpPutFolderTaskletBuilder::new()
            .host("localhost")
            .port(21)
            .username("testuser")
            .password("testpass")
            .local_folder(&upload_dir)
            .remote_folder("/upload")
            .passive_mode(true)
            .create_directories(true)
            .recursive(true)
            .timeout(Duration::from_secs(60))
            .build()?;

        // Test FTP GET FOLDER tasklet builder
        let download_dir = temp_dir.join("download");
        let get_folder_tasklet = FtpGetFolderTaskletBuilder::new()
            .host("localhost")
            .port(21)
            .username("testuser")
            .password("testpass")
            .remote_folder("/upload")
            .local_folder(&download_dir)
            .passive_mode(true)
            .create_directories(true)
            .recursive(true)
            .timeout(Duration::from_secs(60))
            .build()?;

        // Cleanup
        fs::remove_dir_all(&temp_dir).ok();

        // All builders should succeed - tasklets don't have name() method
        // Just verify they were created successfully by checking they exist
        assert!(!std::ptr::addr_of!(put_tasklet).is_null());
        assert!(!std::ptr::addr_of!(get_tasklet).is_null());
        assert!(!std::ptr::addr_of!(put_folder_tasklet).is_null());
        assert!(!std::ptr::addr_of!(get_folder_tasklet).is_null());

        Ok(())
    }

    #[tokio::test]
    async fn test_ftp_tasklet_validation() -> Result<(), Box<dyn std::error::Error>> {
        // Test missing required fields
        let result = FtpPutTaskletBuilder::new().build();
        assert!(
            result.is_err(),
            "Builder should fail without required fields"
        );

        // Test invalid file paths
        let invalid_put = FtpPutTaskletBuilder::new()
            .host("localhost")
            .port(21)
            .username("test")
            .password("test")
            .local_file("/nonexistent/file.txt")
            .remote_file("/test.txt")
            .build();

        assert!(
            invalid_put.is_err(),
            "Builder should fail with nonexistent local file"
        );

        Ok(())
    }

    #[tokio::test]
    async fn test_ftp_job_creation() -> Result<(), Box<dyn std::error::Error>> {
        // Create a temporary file for testing
        let temp_dir = std::env::temp_dir().join("ftp_job_test");
        fs::create_dir_all(&temp_dir)?;

        let test_file = temp_dir.join("job_test.txt");
        fs::write(&test_file, "job test content")?;

        // Create FTP tasklet (this won't actually connect, just test job creation)
        let ftp_tasklet = FtpPutTaskletBuilder::new()
            .host("invalid.host") // Use invalid host so it fails quickly
            .port(21)
            .username("test")
            .password("test")
            .local_file(&test_file)
            .remote_file("/test.txt")
            .timeout(Duration::from_secs(1)) // Very short timeout
            .build()?;

        // Create job with FTP step
        let step = StepBuilder::new("ftp-test-step")
            .tasklet(&ftp_tasklet)
            .build();

        let job = JobBuilder::new().start(&step).build();

        // Job creation should succeed even if execution would fail
        // Jobs don't have a public name() method, just verify it was created
        assert!(!std::ptr::addr_of!(job).is_null());

        // Cleanup
        fs::remove_dir_all(&temp_dir).ok();

        Ok(())
    }

    #[tokio::test]
    async fn test_ftp_connection_error_handling() -> Result<(), Box<dyn std::error::Error>> {
        // Create a temporary file
        let temp_dir = std::env::temp_dir().join("ftp_error_test");
        fs::create_dir_all(&temp_dir)?;

        let test_file = temp_dir.join("error_test.txt");
        fs::write(&test_file, "error test content")?;

        // Create tasklet with invalid connection details
        let ftp_tasklet = FtpPutTaskletBuilder::new()
            .host("invalid.nonexistent.host.example")
            .port(21)
            .username("invalid")
            .password("invalid")
            .local_file(&test_file)
            .remote_file("/test.txt")
            .timeout(Duration::from_secs(2)) // Short timeout for quick failure
            .build()?;

        let step = StepBuilder::new("ftp-error-step")
            .tasklet(&ftp_tasklet)
            .build();

        let job = JobBuilder::new().start(&step).build();
        let result = job.run();

        // Should fail due to invalid connection
        assert!(
            result.is_err(),
            "Job should fail with invalid FTP connection"
        );

        // Cleanup
        fs::remove_dir_all(&temp_dir).ok();

        Ok(())
    }

    #[tokio::test]
    async fn test_ftp_folder_operations_validation() -> Result<(), Box<dyn std::error::Error>> {
        // Test folder tasklet with nonexistent directory
        let nonexistent_dir = std::env::temp_dir().join("nonexistent_folder_12345");

        let result = FtpPutFolderTaskletBuilder::new()
            .host("localhost")
            .port(21)
            .username("test")
            .password("test")
            .local_folder(&nonexistent_dir)
            .remote_folder("/test")
            .build();

        assert!(result.is_err(), "Should fail with nonexistent local folder");

        // Test with valid empty directory
        let empty_dir = std::env::temp_dir().join("empty_ftp_test");
        fs::create_dir_all(&empty_dir)?;

        let tasklet = FtpPutFolderTaskletBuilder::new()
            .host("localhost")
            .port(21)
            .username("test")
            .password("test")
            .local_folder(&empty_dir)
            .remote_folder("/test")
            .build()?;

        // Tasklet created successfully
        assert!(!std::ptr::addr_of!(tasklet).is_null());

        // Cleanup
        fs::remove_dir_all(&empty_dir).ok();

        Ok(())
    }

    #[tokio::test]
    async fn test_ftp_configuration_options() -> Result<(), Box<dyn std::error::Error>> {
        let temp_dir = std::env::temp_dir().join("ftp_config_test");
        fs::create_dir_all(&temp_dir)?;

        let test_file = temp_dir.join("config_test.txt");
        fs::write(&test_file, "config test")?;

        // Test different configuration options
        let tasklet_active = FtpPutTaskletBuilder::new()
            .host("localhost")
            .port(2121) // Non-standard port
            .username("testuser")
            .password("testpass")
            .local_file(&test_file)
            .remote_file("/test.txt")
            .passive_mode(false) // Active mode
            .timeout(Duration::from_secs(45))
            .build()?;

        let tasklet_passive = FtpPutTaskletBuilder::new()
            .host("ftp.example.com")
            .port(21)
            .username("user")
            .password("pass")
            .local_file(&test_file)
            .remote_file("/upload/test.txt")
            .passive_mode(true) // Passive mode
            .timeout(Duration::from_secs(120))
            .build()?;

        // Both configurations should be valid
        assert!(!std::ptr::addr_of!(tasklet_active).is_null());
        assert!(!std::ptr::addr_of!(tasklet_passive).is_null());

        // Cleanup
        fs::remove_dir_all(&temp_dir).ok();

        Ok(())
    }

    #[tokio::test]
    async fn test_ftp_complete_workflow_with_real_server() -> Result<(), Box<dyn std::error::Error>>
    {
        let server_info = create_ftp_server().await?;

        // Create test directory structure with unique names
        let temp_dir = create_unique_test_dir("ftp_complete_workflow_test");
        fs::create_dir_all(&temp_dir)?;

        // Create source data
        let source_dir = temp_dir.join("source");
        create_test_files(&source_dir)?;

        let single_file = temp_dir.join("single_test.txt");
        fs::write(&single_file, "Single file test content")?;

        // Create destination directories
        let download_single = temp_dir.join("download_single");
        let download_folder = temp_dir.join("download_folder");

        // Use unique remote names
        let remote_single_file = create_unique_remote_name("workflow_single");
        let remote_folder_name = create_unique_remote_name("workflow_folder");

        // Build all tasklets
        let put_file_tasklet = FtpPutTaskletBuilder::new()
            .host(&server_info.host)
            .port(server_info.port)
            .username(&server_info.username)
            .password(&server_info.password)
            .local_file(&single_file)
            .remote_file(&remote_single_file)
            .passive_mode(true)
            .timeout(Duration::from_secs(10))
            .build()?;

        let put_folder_tasklet = FtpPutFolderTaskletBuilder::new()
            .host(&server_info.host)
            .port(server_info.port)
            .username(&server_info.username)
            .password(&server_info.password)
            .local_folder(&source_dir)
            .remote_folder(&remote_folder_name)
            .passive_mode(true)
            .create_directories(true)
            .recursive(false)
            .timeout(Duration::from_secs(30))
            .build()?;

        let get_file_tasklet = FtpGetTaskletBuilder::new()
            .host(&server_info.host)
            .port(server_info.port)
            .username(&server_info.username)
            .password(&server_info.password)
            .remote_file(&remote_single_file)
            .local_file(download_single.join("retrieved_single.txt"))
            .passive_mode(true)
            .timeout(Duration::from_secs(10))
            .build()?;

        let get_folder_tasklet = FtpGetFolderTaskletBuilder::new()
            .host(&server_info.host)
            .port(server_info.port)
            .username(&server_info.username)
            .password(&server_info.password)
            .remote_folder(&remote_folder_name)
            .local_folder(&download_folder)
            .passive_mode(true)
            .create_directories(true)
            .recursive(false)
            .timeout(Duration::from_secs(30))
            .build()?;

        // Create steps
        let put_file_step = StepBuilder::new("put-file-step")
            .tasklet(&put_file_tasklet)
            .build();

        let put_folder_step = StepBuilder::new("put-folder-step")
            .tasklet(&put_folder_tasklet)
            .build();

        let get_file_step = StepBuilder::new("get-file-step")
            .tasklet(&get_file_tasklet)
            .build();

        let get_folder_step = StepBuilder::new("get-folder-step")
            .tasklet(&get_folder_tasklet)
            .build();

        // Create and run complete workflow job
        let workflow_job = JobBuilder::new()
            .start(&put_file_step)
            .next(&put_folder_step)
            .next(&get_file_step)
            .next(&get_folder_step)
            .build();

        let result = workflow_job.run();

        // Verify complete workflow succeeded
        assert!(result.is_ok(), "Complete FTP workflow should succeed");

        // Verify downloaded files exist and have correct content
        let retrieved_single = download_single.join("retrieved_single.txt");
        assert!(
            retrieved_single.exists(),
            "Retrieved single file should exist"
        );

        let single_content = fs::read_to_string(&retrieved_single)?;
        assert_eq!(
            single_content, "Single file test content",
            "Single file content should match"
        );

        assert!(download_folder.exists(), "Download folder should exist");
        let downloaded_files = fs::read_dir(&download_folder)?;
        assert!(
            downloaded_files.count() > 0,
            "Should have downloaded folder files"
        );

        // Cleanup
        fs::remove_dir_all(&temp_dir).ok();

        Ok(())
    }

    #[tokio::test]
    async fn test_ftp_integration_comprehensive() -> Result<(), Box<dyn std::error::Error>> {
        // This test validates the complete integration without requiring Docker
        // It tests tasklet creation, job building, and error handling

        let temp_dir = std::env::temp_dir().join("ftp_integration_test");
        if temp_dir.exists() {
            fs::remove_dir_all(&temp_dir)?;
        }
        fs::create_dir_all(&temp_dir)?;

        // Create test files and directories
        let test_file = temp_dir.join("integration_test.txt");
        fs::write(&test_file, "Integration test content")?;

        let test_folder = temp_dir.join("test_folder");
        create_test_files(&test_folder)?;

        // Test all four tasklet types
        let put_tasklet = FtpPutTaskletBuilder::new()
            .host("test.example.com")
            .port(21)
            .username("testuser")
            .password("testpass")
            .local_file(&test_file)
            .remote_file("/test.txt")
            .passive_mode(true)
            .timeout(Duration::from_secs(30))
            .build()?;

        let get_tasklet = FtpGetTaskletBuilder::new()
            .host("test.example.com")
            .port(21)
            .username("testuser")
            .password("testpass")
            .remote_file("/test.txt")
            .local_file(temp_dir.join("downloaded.txt"))
            .passive_mode(true)
            .timeout(Duration::from_secs(30))
            .build()?;

        let put_folder_tasklet = FtpPutFolderTaskletBuilder::new()
            .host("test.example.com")
            .port(21)
            .username("testuser")
            .password("testpass")
            .local_folder(&test_folder)
            .remote_folder("/upload")
            .passive_mode(true)
            .create_directories(true)
            .recursive(true)
            .timeout(Duration::from_secs(60))
            .build()?;

        let get_folder_tasklet = FtpGetFolderTaskletBuilder::new()
            .host("test.example.com")
            .port(21)
            .username("testuser")
            .password("testpass")
            .remote_folder("/upload")
            .local_folder(temp_dir.join("download"))
            .passive_mode(true)
            .create_directories(true)
            .recursive(true)
            .timeout(Duration::from_secs(60))
            .build()?;

        // Create steps for each tasklet
        let put_step = StepBuilder::new("ftp-put-step")
            .tasklet(&put_tasklet)
            .build();

        let get_step = StepBuilder::new("ftp-get-step")
            .tasklet(&get_tasklet)
            .build();

        let put_folder_step = StepBuilder::new("ftp-put-folder-step")
            .tasklet(&put_folder_tasklet)
            .build();

        let get_folder_step = StepBuilder::new("ftp-get-folder-step")
            .tasklet(&get_folder_tasklet)
            .build();

        // Verify all steps were created successfully
        assert_eq!(put_step.get_name(), "ftp-put-step");
        assert_eq!(get_step.get_name(), "ftp-get-step");
        assert_eq!(put_folder_step.get_name(), "ftp-put-folder-step");
        assert_eq!(get_folder_step.get_name(), "ftp-get-folder-step");

        // Test job creation with multiple steps
        let job = JobBuilder::new()
            .start(&put_step)
            .next(&put_folder_step)
            .next(&get_step)
            .next(&get_folder_step)
            .build();

        // Job should be created successfully (even though execution would fail without real FTP server)
        assert!(!std::ptr::addr_of!(job).is_null());

        // Cleanup
        fs::remove_dir_all(&temp_dir).ok();

        Ok(())
    }
}