arcula 1.0.6

Arcula - MongoDB database synchronization tool
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

# MongoDB Importer Tests

This directory contains integration tests for the MongoDB Importer tool. The tests focus on realistic testing of the tool's functionality with actual MongoDB instances.

## Test Files

- **docker_tests.rs**: Integration tests that use real MongoDB instances
  - Tests the connection to MongoDB
  - Tests database export/import functionality
  - Tests backup and restore
  - Tests the full synchronization workflow

## Running Tests

Run all tests with:

```bash
cargo test
```

Run only the MongoDB integration tests:

```bash
cargo test --test docker_tests
```

## Test Configuration Options

The Docker tests are designed to be flexible and can operate in various environments:

### Using Docker Containers (Default)

By default, the tests will:
1. Start MongoDB containers on ports 27118 and 27119
2. Run tests against these containers
3. Clean up the containers when done

### Using External MongoDB Instances

You can provide MongoDB connection strings via environment variables to test against existing databases:

```bash
# Use existing MongoDB instances
export TEST_MONGO_SOURCE_URI=mongodb://localhost:27017
export TEST_MONGO_TARGET_URI=mongodb://localhost:27018
cargo test --test docker_tests
```

This is particularly useful in CI environments where MongoDB might be provided as a service.

### Test Behavior

The tests will automatically:

1. Check if MongoDB URIs are provided via environment variables
2. If URIs are available, use those for testing
3. If URIs are not available, create Docker containers for testing
4. Run all tests against the provided/created MongoDB instances
5. Clean up any resources when done

## CI Integration

For CI environments, use the external MongoDB option:

```yaml
# Example GitHub Actions configuration
jobs:
  test:
    runs-on: ubuntu-latest
    services:
      mongodb-source:
        image: mongo
        ports:
          - 27017:27017
      mongodb-target:
        image: mongo
        ports:
          - 27018:27017
    steps:
      - uses: actions/checkout@v2
      - name: Run tests
        run: |
          export TEST_MONGO_SOURCE_URI=mongodb://localhost:27017
          export TEST_MONGO_TARGET_URI=mongodb://localhost:27018
          cargo test
```

## Test Structure

Each test follows the same pattern:
1. Check if tests should be skipped
2. Determine if Docker containers are needed
3. Set up test environment (Docker or external)
4. Execute test operations against MongoDB
5. Verify results
6. Clean up resources

This flexible approach ensures tests can run in various environments while providing realistic testing of the application's functionality.