orcs 0.0.8

Microservices monorepo orchestration 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
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
use assert_cmd::prelude::*;
use predicates::prelude::*;
use std::fs::File;
use std::io::prelude::*;
use std::process::Command;
use tempfile::TempDir;

mod common;

mod one_one {
    use super::*;

    /// Create a simple project with one service and one stage.
    ///
    fn create_project(
        service_name: &str,
        stage_name: &str,
    ) -> Result<TempDir, Box<dyn std::error::Error>> {
        // Create a project with a single service
        let root_dir = common::create_project("one-service-one-stage")?;
        let folder = root_dir.path();
        common::create_service(&folder, &service_name)?;

        // Update the project config
        let mut cfg_file = File::create(folder.join("orcs.toml"))?;
        let cfg_data = format!("[stages.{}]", stage_name);
        cfg_file.write_all(cfg_data.as_bytes())?;

        // Update the service config
        let mut cfg_file = File::create(folder.join("srv").join(&service_name).join("orcs.toml"))?;
        let cfg_data = format!(
            "stages.{}.actions = \"echo Hello from $ORCS_SERVICE > $ORCS_ROOT/test.txt\"",
            stage_name
        );
        cfg_file.write_all(cfg_data.as_bytes())?;

        Ok(root_dir)
    }

    /// Run a project with a single service and stage
    #[test]
    fn run_all() -> Result<(), Box<dyn std::error::Error>> {
        // Create the project
        let root_dir = create_project("my-service", "my_stage")?;
        let folder = root_dir.path();

        // Run the command
        let mut cmd = Command::cargo_bin("orcs")?;
        cmd.arg("-d").arg("-p").arg(&folder).arg("run").arg("all");

        cmd.assert().success();

        // Check the output file
        let mut test_file = File::open(folder.join("test.txt"))?;
        let mut test_data = String::new();
        test_file.read_to_string(&mut test_data)?;

        assert!(predicate::str::contains("Hello from my-service").eval(&test_data));

        Ok(())
    }

    /// Run the stage of a project with a single service and stage
    #[test]
    fn run_stage() -> Result<(), Box<dyn std::error::Error>> {
        // Create the project
        let root_dir = create_project("my-service", "my_stage")?;
        let folder = root_dir.path();

        // Run the command
        let mut cmd = Command::cargo_bin("orcs")?;
        cmd.arg("-d")
            .arg("-p")
            .arg(&folder)
            .arg("run")
            .arg("my_stage");

        cmd.assert().success();

        // Check the output file
        let mut test_file = File::open(folder.join("test.txt"))?;
        let mut test_data = String::new();
        test_file.read_to_string(&mut test_data)?;

        assert!(predicate::str::contains("Hello from my-service").eval(&test_data));

        Ok(())
    }

    #[test]
    fn run_stage_service() -> Result<(), Box<dyn std::error::Error>> {
        // Create the project
        let root_dir = create_project("my-service", "my_stage")?;
        let folder = root_dir.path();

        // Run the command
        let mut cmd = Command::cargo_bin("orcs")?;
        cmd.arg("-d")
            .arg("-p")
            .arg(&folder)
            .arg("run")
            .arg("my_stage")
            .arg("my-service");

        cmd.assert().success();

        // Check the output file
        let mut test_file = File::open(folder.join("test.txt"))?;
        let mut test_data = String::new();
        test_file.read_to_string(&mut test_data)?;

        assert!(predicate::str::contains("Hello from my-service").eval(&test_data));

        Ok(())
    }

    #[test]
    fn run_all_failing() -> Result<(), Box<dyn std::error::Error>> {
        // Create the project
        let root_dir = create_project("my-service", "my_stage")?;
        let folder = root_dir.path();

        // Update the service config
        let mut cfg_file = File::create(folder.join("srv").join("my-service").join("orcs.toml"))?;
        let cfg_data = "stages.my_stage.actions = \"\"\"false\ntrue\"\"\"";
        cfg_file.write_all(cfg_data.as_bytes())?;

        // Run the command
        let mut cmd = Command::cargo_bin("orcs")?;
        cmd.arg("-d").arg("-p").arg(&folder).arg("run").arg("all");

        cmd.assert().failure();

        Ok(())
    }

    #[test]
    fn run_all_output() -> Result<(), Box<dyn std::error::Error>> {
        // Create the project
        let root_dir = create_project("my-service", "my_stage")?;
        let folder = root_dir.path();

        // Update the service config
        let mut cfg_file = File::create(folder.join("srv").join("my-service").join("orcs.toml"))?;
        let cfg_data = "stages.my_stage.actions = \"echo Hello from my-service\"";
        cfg_file.write_all(cfg_data.as_bytes())?;

        // Run the command
        let mut cmd = Command::cargo_bin("orcs")?;
        cmd.arg("-d").arg("-p").arg(&folder).arg("run").arg("all");

        cmd.assert()
            .success()
            .stdout(predicate::str::contains("Hello from my-service"));

        Ok(())
    }
}

mod two_two {
    use super::*;

    /// Create a project with two services and two stages
    ///
    /// The 2nd stage depends on the 1st one and the 2nd service depends on the 1st one
    fn create_project(
        service1: &str,
        service2: &str,
        stage1: &str,
        stage2: &str,
    ) -> Result<TempDir, Box<dyn std::error::Error>> {
        // Create a project with two services
        let root_dir = common::create_project("one-service-one-stage")?;
        let folder = root_dir.path();
        common::create_service(&folder, &service1)?;
        common::create_service(&folder, &service2)?;

        // Update the project config
        let mut cfg_file = File::create(folder.join("orcs.toml"))?;
        let cfg_data = format!(
            "
[stages.{stage1}]
[stages.{stage2}]
depends_on = [\"{stage1}\"]
        ",
            stage1 = stage1,
            stage2 = stage2
        );
        cfg_file.write_all(cfg_data.as_bytes())?;

        // Update service1 config
        let mut cfg_file = File::create(folder.join("srv").join(&service1).join("orcs.toml"))?;
        let cfg_data = format!(
            "
[stages.{stage1}]
actions = \"echo Hello1 from $ORCS_SERVICE >> $ORCS_ROOT/test.txt\"
check = \"grep 'Hello1 from '$ORCS_SERVICE $ORCS_ROOT/test.txt\"

[stages.{stage2}]
actions = \"echo Hello2 from $ORCS_SERVICE >> $ORCS_ROOT/test.txt\"
check = \"grep 'Hello2 from '$ORCS_SERVICE $ORCS_ROOT/test.txt\"
        ",
            stage1 = stage1,
            stage2 = stage2
        );
        cfg_file.write_all(cfg_data.as_bytes())?;

        // Update service2 config
        let mut cfg_file = File::create(folder.join("srv").join(&service2).join("orcs.toml"))?;
        let cfg_data = format!(
            "
[stages.{stage1}]
depends_on=[\"{service1}\"]
actions = \"echo Hello1 from $ORCS_SERVICE >> $ORCS_ROOT/test.txt\"
check = \"grep 'Hello1 from '$ORCS_SERVICE $ORCS_ROOT/test.txt\"

[stages.{stage2}]
depends_on=[\"{service1}\"]
actions = \"echo Hello2 from $ORCS_SERVICE >> $ORCS_ROOT/test.txt\"
check = [
    \"env | grep ORCS\",
    \"grep 'Hello2 from '$ORCS_SERVICE $ORCS_ROOT/test.txt\"
]
        ",
            stage1 = stage1,
            stage2 = stage2,
            service1 = service1
        );
        cfg_file.write_all(cfg_data.as_bytes())?;

        Ok(root_dir)
    }

    #[test]
    fn run_all() -> Result<(), Box<dyn std::error::Error>> {
        // If something is wrong, the result is non-deterministic. Therefore run
        // this enough times to ensure the result is not just a fluke.
        for _ in 0..50 {
            // Create a project with 2 services
            let root_dir = create_project("service-a", "service-b", "stage-a", "stage-b")?;
            let folder = root_dir.path();

            // Run the command
            let mut cmd = Command::cargo_bin("orcs")?;
            cmd.arg("-d").arg("-p").arg(&folder).arg("run").arg("all");

            cmd.assert().success();

            // Check test file
            let mut test_file = File::open(folder.join("test.txt"))?;
            let mut test_data = String::new();
            test_file.read_to_string(&mut test_data)?;

            assert_eq!("Hello1 from service-a\nHello1 from service-b\nHello2 from service-a\nHello2 from service-b\n", test_data);
        }

        Ok(())
    }

    #[test]
    fn run_stage1() -> Result<(), Box<dyn std::error::Error>> {
        // Create a project with 2 services
        let root_dir = create_project("service-a", "service-b", "stage-a", "stage-b")?;
        let folder = root_dir.path();

        // Run the command
        let mut cmd = Command::cargo_bin("orcs")?;
        cmd.arg("-d")
            .arg("-p")
            .arg(&folder)
            .arg("run")
            .arg("stage-a");

        cmd.assert().success();

        // Check test file
        let mut test_file = File::open(folder.join("test.txt"))?;
        let mut test_data = String::new();
        test_file.read_to_string(&mut test_data)?;

        assert_eq!("Hello1 from service-a\nHello1 from service-b\n", test_data);

        Ok(())
    }

    #[test]
    fn run_stage2_fail() -> Result<(), Box<dyn std::error::Error>> {
        // Create a project with 2 services
        let root_dir = create_project("service-a", "service-b", "stage-a", "stage-b")?;
        let folder = root_dir.path();

        // Run the command
        let mut cmd = Command::cargo_bin("orcs")?;
        cmd.arg("-d")
            .arg("-p")
            .arg(&folder)
            .arg("run")
            .arg("stage-b");

        // Expecting a failure as we need to run stage1 first
        cmd.assert().failure();

        Ok(())
    }

    #[test]
    fn run_stage1_service1() -> Result<(), Box<dyn std::error::Error>> {
        // Create a project with 2 services
        let root_dir = create_project("service-a", "service-b", "stage-a", "stage-b")?;
        let folder = root_dir.path();

        // Run the command
        let mut cmd = Command::cargo_bin("orcs")?;
        cmd.arg("-d")
            .arg("-p")
            .arg(&folder)
            .arg("run")
            .arg("stage-a")
            .arg("service-a");

        cmd.assert().success();

        // Check test file
        let mut test_file = File::open(folder.join("test.txt"))?;
        let mut test_data = String::new();
        test_file.read_to_string(&mut test_data)?;

        assert_eq!("Hello1 from service-a\n", test_data);

        Ok(())
    }

    #[test]
    fn run_stage2_service1_fail() -> Result<(), Box<dyn std::error::Error>> {
        // Create a project with 2 services
        let root_dir = create_project("service-a", "service-b", "stage-a", "stage-b")?;
        let folder = root_dir.path();

        // Run the command
        let mut cmd = Command::cargo_bin("orcs")?;
        cmd.arg("-d")
            .arg("-p")
            .arg(&folder)
            .arg("run")
            .arg("stage-b")
            .arg("service-a");

        // Expecting failure as we need to run stage-a first
        cmd.assert().failure();

        Ok(())
    }

    #[test]
    fn run_stage1_service2_fail() -> Result<(), Box<dyn std::error::Error>> {
        // Create a project with 2 services
        let root_dir = create_project("service-a", "service-b", "stage-a", "stage-b")?;
        let folder = root_dir.path();

        // Run the command
        let mut cmd = Command::cargo_bin("orcs")?;
        cmd.arg("-d")
            .arg("-p")
            .arg(&folder)
            .arg("run")
            .arg("stage-a")
            .arg("service-b");

        // Expecting failure as we need to run service-a first
        cmd.assert().failure();

        Ok(())
    }

    #[test]
    fn run_all_failing() -> Result<(), Box<dyn std::error::Error>> {
        let root_dir = create_project("service-a", "service-b", "stage-a", "stage-b")?;
        let folder = root_dir.path();

        // Update the config for service B
        println!("yay");
        let mut cfg_file = File::create(folder.join("srv").join("service-b").join("orcs.toml"))?;
        let cfg_data = "
[stages.stage-a]
depends_on=[\"service-a\"]
actions = \"\"\"false\ntrue\"\"\"
check = \"grep 'Hello1 from '$ORCS_SERVICE $ORCS_ROOT/test.txt\"

[stages.stage-b]
depends_on=[\"service-a\"]
actions = \"echo Hello2 from $ORCS_SERVICE >> $ORCS_ROOT/test.txt\"
check = [
    \"env | grep ORCS\",
    \"grep 'Hello2 from '$ORCS_SERVICE $ORCS_ROOT/test.txt\"
]
        ";
        cfg_file.write_all(cfg_data.as_bytes())?;
        println!("nay");

        // Run the command
        let mut cmd = Command::cargo_bin("orcs")?;
        cmd.arg("-d").arg("-p").arg(&folder).arg("run").arg("all");

        cmd.assert().failure();

        // Check test file
        let mut test_file = File::open(folder.join("test.txt"))?;
        let mut test_data = String::new();
        test_file.read_to_string(&mut test_data)?;

        assert_eq!("Hello1 from service-a\n", test_data);

        Ok(())
    }
}