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

use assert_cmd::prelude::*;
use predicates::prelude::*;
use std::fs::{create_dir_all, File};
use std::io::prelude::*;
use std::process::Command;

mod common;

/// Retrieve a parameter value set at the global level
#[test]
fn get_global() -> Result<(), Box<dyn std::error::Error>> {
    // Create a temporary project
    let root_dir = common::create_project("get-global")?;
    let folder = root_dir.path();

    // Create a configuration file with a global parameter
    let mut cfg_file = File::create(folder.join("orcs.toml"))?;
    let cfg_data = "global.params.my_param = \"my_value\"";
    cfg_file.write_all(cfg_data.as_bytes())?;

    // Run the command
    let mut cmd = Command::cargo_bin("orcs")?;
    cmd.arg("-p").arg(&folder).arg("get").arg("my_param");
    cmd.assert()
        .success()
        .stdout(predicate::str::contains("my_value"));

    Ok(())
}

/// Retrieve a parameter value set by a stage
#[test]
fn get_stage() -> Result<(), Box<dyn std::error::Error>> {
    // Create a temporary project
    let root_dir = common::create_project("get-stage")?;
    let folder = root_dir.path();

    // Write a configuration file with a stage parameter
    let mut cfg_file = File::create(folder.join("orcs.toml"))?;
    let cfg_data = "stages.my_stage.params.my_param = \"my_value\"";
    cfg_file.write_all(cfg_data.as_bytes())?;

    // Run the command
    let mut cmd = Command::cargo_bin("orcs")?;
    cmd.env("ORCS_SERVICE", "my_service")
        .env("ORCS_STAGE", "my_stage")
        .arg("-p")
        .arg(&folder)
        .arg("get")
        .arg("my_param");

    cmd.assert()
        .success()
        .stdout(predicate::str::contains("my_value"));

    Ok(())
}

/// Retrieve a parameter value set by another service
#[test]
fn get_service() -> Result<(), Box<dyn std::error::Error>> {
    // Create a temporary project and services
    let root_dir = common::create_project("get-stage")?;
    let folder = root_dir.path();
    common::create_service(folder, "service-a")?;
    common::create_service(folder, "service-b")?;

    // Override the project file
    let mut cfg_file = File::create(folder.join("orcs.toml"))?;
    let cfg_data = "[stages.my_stage]";
    cfg_file.write_all(cfg_data.as_bytes())?;

    // Override service B file
    // We need to mark service-a as a dependency of service-b, otherwise
    // we'll get a permission denied error.
    let mut cfg_file = File::create(folder.join("srv").join("service-b").join("orcs.toml"))?;
    let cfg_data = "stages.my_stage.depends_on = [\"service-a\"]";
    cfg_file.write_all(cfg_data.as_bytes())?;

    // Create the parameter store
    create_dir_all(&folder.join(".store"))?;
    let mut file = File::create(&folder.join(".store").join("store.json"))?;
    let data = "{\"service-a:my_param\":\"my-param-value\"}";
    file.write_all(data.as_bytes())?;

    // Run the command
    let mut cmd = Command::cargo_bin("orcs")?;
    cmd.env("ORCS_SERVICE", "service-b")
        .env("ORCS_STAGE", "my_stage")
        .arg("-p")
        .arg(&folder)
        .arg("get")
        .arg("service-a:my_param");

    cmd.assert()
        .success()
        .stdout(predicate::str::contains("my-param-value"));

    Ok(())
}

/// Retrieve a parameter value set by another service, but the service doesn't
/// depend on it.
#[test]
fn get_service_denied() -> Result<(), Box<dyn std::error::Error>> {
    // Create a temporary project and services
    let root_dir = common::create_project("get-stage")?;
    let folder = root_dir.path();
    common::create_service(folder, "service-a")?;
    common::create_service(folder, "service-b")?;
    common::create_service(folder, "service-c")?;

    // Override the project file
    let mut cfg_file = File::create(folder.join("orcs.toml"))?;
    let cfg_data = "[stages.my_stage]";
    cfg_file.write_all(cfg_data.as_bytes())?;

    // Override service B file
    // Since we put only service-c as a dependency, and not service-a, we will
    // have an error when trying to retrieve the value.
    let mut cfg_file = File::create(folder.join("srv").join("service-b").join("orcs.toml"))?;
    let cfg_data = "stages.my_stage.depends_on = [\"service-c\"]";
    cfg_file.write_all(cfg_data.as_bytes())?;

    // Create the parameter store
    create_dir_all(&folder.join(".store"))?;
    let mut file = File::create(&folder.join(".store").join("store.json"))?;
    let data = "{\"service-a:my_param\":\"my-param-value\"}";
    file.write_all(data.as_bytes())?;

    // Run the command
    let mut cmd = Command::cargo_bin("orcs")?;
    cmd.env("ORCS_SERVICE", "service-b")
        .env("ORCS_STAGE", "my_stage")
        .arg("-p")
        .arg(&folder)
        .arg("get")
        .arg("service-a:my_param");

    cmd.assert().failure();

    Ok(())
}

/// Retrieve a parameter value set by another service that doesn't exist
#[test]
fn get_service_not_exist() -> Result<(), Box<dyn std::error::Error>> {
    // Create a temporary project and services
    let root_dir = common::create_project("get-stage")?;
    let folder = root_dir.path();
    common::create_service(folder, "service-a")?;
    common::create_service(folder, "service-b")?;

    // Override the project file
    let mut cfg_file = File::create(folder.join("orcs.toml"))?;
    let cfg_data = "[stages.my_stage]";
    cfg_file.write_all(cfg_data.as_bytes())?;

    // Override service B file
    // We need to mark service-a as a dependency of service-b, otherwise
    // we'll get a permission denied error.
    let mut cfg_file = File::create(folder.join("srv").join("service-b").join("orcs.toml"))?;
    let cfg_data = "stages.my_stage.depends_on = [\"service-a\"]";
    cfg_file.write_all(cfg_data.as_bytes())?;

    // Create the parameter store
    create_dir_all(&folder.join(".store"))?;
    let mut file = File::create(&folder.join(".store").join("store.json"))?;
    let data = "{\"service-a:my_param\":\"my-param-value\"}";
    file.write_all(data.as_bytes())?;

    // Run the command
    let mut cmd = Command::cargo_bin("orcs")?;
    cmd.env("ORCS_SERVICE", "service-b")
        .env("ORCS_STAGE", "my_stage")
        .arg("-p")
        .arg(&folder)
        .arg("get")
        .arg("service-a:my_non_existent_param");

    cmd.assert().failure();

    Ok(())
}

/// Retrieve a parameter file set by another service
#[test]
fn get_service_file() -> Result<(), Box<dyn std::error::Error>> {
    // Create a temporary project and services
    let root_dir = common::create_project("get-stage")?;
    let folder = root_dir.path();
    common::create_service(folder, "service-a")?;
    common::create_service(folder, "service-b")?;

    // Override the project file
    let mut cfg_file = File::create(folder.join("orcs.toml"))?;
    let cfg_data = "[stages.my_stage]";
    cfg_file.write_all(cfg_data.as_bytes())?;

    // Override service B file
    // We need to mark service-a as a dependency of service-b, otherwise
    // we'll get a permission denied error.
    let mut cfg_file = File::create(folder.join("srv").join("service-b").join("orcs.toml"))?;
    let cfg_data = "stages.my_stage.depends_on = [\"service-a\"]";
    cfg_file.write_all(cfg_data.as_bytes())?;

    // Store the file
    create_dir_all(&folder.join(".store"))?;
    let mut file = File::create(&folder.join(".store").join("service-a:my_param.store"))?;
    let data = "Hello, world!";
    file.write_all(data.as_bytes())?;

    // Retrieve the parameter value
    let param_filename = &folder.join("test.txt");
    let mut cmd = Command::cargo_bin("orcs")?;
    cmd.env("ORCS_SERVICE", "service-b")
        .env("ORCS_STAGE", "my_stage")
        .arg("-p")
        .arg(&folder)
        .arg("get-file")
        .arg("service-a:my_param")
        .arg(&param_filename);

    cmd.assert().success();

    // Check the parameter file
    let mut param_file = File::open(param_filename)?;
    let mut param_data = String::new();
    param_file.read_to_string(&mut param_data)?;

    assert_eq!(data, param_data);

    Ok(())
}