felixctl 0.6.0

Command-line tool for Felix: publish, subscribe, read caches, manage the control plane and run benchmarks
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

//! The binary without a cluster: help, exit statuses for bad input and for
//! endpoints that do not answer, and contexts.

use std::path::Path;
use std::process::{Command, Output};

fn felixctl(home: &Path, args: &[&str]) -> Output {
    Command::new(env!("CARGO_BIN_EXE_felixctl"))
        .args(args)
        .env_clear()
        .env("HOME", home)
        .env("FELIX_CLI_CONFIG", home.join("config.toml"))
        .output()
        .expect("run felixctl")
}

fn stdout(output: &Output) -> String {
    String::from_utf8_lossy(&output.stdout).into_owned()
}

#[test]
fn no_arguments_prints_the_overview() {
    let home = tempfile::tempdir().unwrap();
    let output = felixctl(home.path(), &[]);
    assert!(output.status.success());
    assert!(
        stdout(&output).contains("Get started:"),
        "{}",
        stdout(&output)
    );
}

#[test]
fn help_works_both_ways_for_every_command() {
    let home = tempfile::tempdir().unwrap();
    for command in [
        "context",
        "pub",
        "sub",
        "cache",
        "topology",
        "group",
        "counter",
        "tenant",
        "namespace",
        "stream",
        "node",
        "shard",
        "placement",
        "inspect",
        "bench",
        "completions",
    ] {
        let by_flag = felixctl(home.path(), &[command, "--help"]);
        let by_help = felixctl(home.path(), &["help", command]);
        assert!(by_flag.status.success(), "{command} --help failed");
        assert!(by_help.status.success(), "help {command} failed");
        assert_eq!(stdout(&by_flag), stdout(&by_help), "{command}");
        assert!(stdout(&by_flag).contains("Examples:"), "{command}");
    }
}

#[test]
fn a_destructive_group_command_off_a_terminal_needs_yes() {
    let home = tempfile::tempdir().unwrap();
    // stdin is not a terminal here, so nothing can be asked. The refusal
    // comes before any broker is contacted; port 9 would not answer anyway.
    for args in [
        &["group", "rm", "orders", "billing"][..],
        &[
            "group",
            "dead-letters",
            "discard",
            "orders",
            "billing",
            "0:3",
        ],
    ] {
        let mut args = args.to_vec();
        args.extend(["--brokers", "127.0.0.1:9", "--tenant", "t1", "--token", "x"]);
        let output = felixctl(home.path(), &args);
        assert_eq!(output.status.code(), Some(2), "{args:?}");
        let stderr = String::from_utf8_lossy(&output.stderr);
        assert!(stderr.contains("--yes"), "{stderr}");
    }
}

#[test]
fn a_usage_error_exits_2() {
    let home = tempfile::tempdir().unwrap();
    assert_eq!(felixctl(home.path(), &["pub"]).status.code(), Some(2));
    assert_eq!(
        felixctl(home.path(), &["sub", "s", "--from", "x"])
            .status
            .code(),
        Some(2)
    );
    // Nothing says where the brokers are.
    assert_eq!(
        felixctl(home.path(), &["pub", "s", "x"]).status.code(),
        Some(2)
    );
}

#[test]
fn an_unreachable_control_plane_exits_3() {
    let home = tempfile::tempdir().unwrap();
    // Port 9 (discard) on loopback: nothing listens there in CI.
    let output = felixctl(
        home.path(),
        &[
            "--json",
            "stream",
            "ls",
            "--tenant",
            "t",
            "--controlplane-url",
            "http://127.0.0.1:9",
        ],
    );
    assert_eq!(output.status.code(), Some(3));
    let error: serde_json::Value =
        serde_json::from_slice(&output.stderr).expect("a JSON error on stderr");
    assert_eq!(error["exit"], 3);
}

#[test]
fn a_destructive_command_off_a_terminal_needs_yes() {
    let home = tempfile::tempdir().unwrap();
    // The control plane is unreachable, so exit 3 would mean a request was
    // sent; 2 means it stopped first.
    let reach = ["--tenant", "t", "--controlplane-url", "http://127.0.0.1:9"];
    for command in [
        &["stream", "rm", "orders"][..],
        &["cache", "rm", "sessions"],
        &["namespace", "rm", "payments"],
        &["tenant", "rm", "acme"],
        &["node", "drain", "broker-2"],
        &["node", "deregister", "broker-2"],
        &["placement", "abandon", "orders", "0"],
    ] {
        let args: Vec<&str> = command.iter().chain(&reach).copied().collect();
        let output = felixctl(home.path(), &args);
        assert_eq!(output.status.code(), Some(2), "{command:?}");
        let stderr = String::from_utf8_lossy(&output.stderr);
        assert!(stderr.contains("--yes"), "{command:?}: {stderr}");
    }
    let mut args = vec!["stream", "rm", "orders", "--yes"];
    args.extend(reach);
    assert_eq!(felixctl(home.path(), &args).status.code(), Some(3));
}

#[test]
fn a_missing_context_exits_5() {
    let home = tempfile::tempdir().unwrap();
    let output = felixctl(home.path(), &["context", "use", "nope"]);
    assert_eq!(output.status.code(), Some(5));
}

#[test]
fn contexts_are_saved_listed_and_removed() {
    let home = tempfile::tempdir().unwrap();
    let add = felixctl(
        home.path(),
        &[
            "context",
            "add",
            "dev",
            "--brokers",
            "127.0.0.1:5000",
            "--tenant",
            "t1",
        ],
    );
    assert!(add.status.success());
    let ls = felixctl(home.path(), &["context", "ls"]);
    assert!(stdout(&ls).contains("*  dev"), "{}", stdout(&ls));
    assert!(
        felixctl(home.path(), &["context", "rm", "dev"])
            .status
            .success()
    );
    let ls = felixctl(home.path(), &["context", "ls", "--json"]);
    let value: serde_json::Value = serde_json::from_slice(&ls.stdout).unwrap();
    assert_eq!(value["contexts"], serde_json::json!([]));
}

#[test]
fn completions_and_man_pages_are_generated() {
    let home = tempfile::tempdir().unwrap();
    let zsh = felixctl(home.path(), &["completions", "zsh"]);
    assert!(stdout(&zsh).starts_with("#compdef felixctl"));
    let dir = home.path().join("man");
    let man = felixctl(home.path(), &["man", "--out-dir", dir.to_str().unwrap()]);
    assert!(man.status.success());
    assert!(dir.join("felixctl.1").exists());
    assert!(dir.join("felixctl-cache-watch.1").exists());
}

/// A target that is neither NAME nor TENANT/NAMESPACE/NAME is a usage error,
/// found before anything is dialled.
#[test]
fn inspect_refuses_a_malformed_target() {
    let home = tempfile::tempdir().unwrap();
    let output = felixctl(
        home.path(),
        &[
            "inspect",
            "shard",
            "acme/orders",
            "--brokers",
            "127.0.0.1:1",
        ],
    );
    assert_eq!(output.status.code(), Some(2), "{output:?}");
    assert!(
        String::from_utf8_lossy(&output.stderr).contains("TENANT/NAMESPACE/NAME"),
        "{output:?}"
    );
}

/// A cursor felixctl did not print, or one without the broker it belongs to,
/// is a usage error found before anything is dialled.
#[test]
fn inspect_subs_refuses_a_cursor_it_cannot_use() {
    let home = tempfile::tempdir().unwrap();
    for args in [
        &[
            "inspect",
            "subs",
            "--cursor",
            "abc",
            "--brokers",
            "127.0.0.1:1",
        ][..],
        &[
            "inspect",
            "subs",
            "--node",
            "broker-a",
            "--cursor",
            "abc",
            "--brokers",
            "127.0.0.1:1",
        ][..],
        &[
            "inspect",
            "subs",
            "--shard",
            "0",
            "--brokers",
            "127.0.0.1:1",
        ][..],
    ] {
        let output = felixctl(home.path(), args);
        assert_eq!(output.status.code(), Some(2), "{args:?}: {output:?}");
    }
}