ocre-cli 0.2.0

Command-line tool for Ocre: create, generate, migrate, run and deploy apps.
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

//! `ocre new` in a real pseudo-terminal: the guided setup, as a human sees it.

#[path = "../support/mod.rs"]
mod support;

use std::fs;

use rexpect::{
    process::WaitStatus,
    session::{PtySession, spawn_command},
};
use support::{Sandbox, ocre_crate};

const DOWN: &str = "\x1b[B";
const ENTER: &str = "\r";

fn start(sandbox: &Sandbox, args: &[&str]) -> PtySession {
    let mut command = sandbox.command(args, &sandbox.work);
    command.env("TERM", "xterm-256color");
    spawn_command(command, Some(60_000)).unwrap()
}

/// Waits for exit; returns the remaining output and the exit code.
fn finish(mut session: PtySession) -> (String, i32) {
    let rest = session.exp_eof().unwrap();
    match session.process().wait().unwrap() {
        WaitStatus::Exited(_, code) => (rest, code),
        other => panic!("unexpected exit: {other:?}"),
    }
}

fn press(session: &mut PtySession, keys: &str) {
    session.send(keys).unwrap();
    session.flush().unwrap();
}

#[test]
fn guided_setup_logs_in_and_deploys() {
    let sandbox = Sandbox::new();
    sandbox.accounts_after_login(&[("acc1", "Main")]);
    let ocre = ocre_crate();
    let mut s = start(&sandbox, &["new", "--ocre-path", ocre.to_str().unwrap()]);

    s.exp_string("What is your app called?").unwrap();
    press(&mut s, &format!("Bad_Name{ENTER}"));
    s.exp_string("invalid app name `Bad_Name`").unwrap();
    press(&mut s, &format!("{}blog{ENTER}", "\x7f".repeat(8)));

    s.exp_string("What are you building?").unwrap();
    press(&mut s, ENTER);
    s.exp_string("Pick a starter").unwrap();
    // Full-stack starters: Empty, Live Q&A, Blog.
    press(&mut s, &format!("{DOWN}{DOWN}{ENTER}"));
    s.exp_string("Connect your Cloudflare account?").unwrap();
    press(&mut s, ENTER);
    s.exp_string("Logged in to Cloudflare").unwrap();
    s.exp_string("Initialize a git repository?").unwrap();
    press(&mut s, "y");
    s.exp_string("Deploy it now?").unwrap();
    press(&mut s, ENTER);
    s.exp_string("Your app is live at https://blog.example.workers.dev").unwrap();
    let (_, code) = finish(s);

    assert_eq!(code, 0);
    let root = sandbox.work.join("blog");
    assert!(root.join("src/posts.rs").is_file(), "blog starter");
    assert!(root.join(".git").is_dir());
    assert_eq!(
        sandbox.calls(),
        [
            "cf auth whoami",
            "cf auth whoami",
            "cf auth login",
            "cf auth whoami",
            "npm install",
            "cf d1 list --name blog",
            "cf d1 create --name blog",
            "cf workers secrets list --worker blog",
            "cf d1 migrations apply uuid-blog",
            "cf deploy --secrets-file .wrangler/ocre-secrets.json",
            "secrets file ok",
            "build --release",
        ]
    );
}

#[test]
fn guided_setup_asks_which_account_when_there_are_several() {
    let sandbox = Sandbox::new();
    sandbox.login_as(&[("acc1", "Main"), ("acc2", "Side")]);
    let mut s = start(&sandbox, &["new"]);

    s.exp_string("What is your app called?").unwrap();
    press(&mut s, &format!("shop{ENTER}"));
    s.exp_string("What are you building?").unwrap();
    press(&mut s, ENTER);
    s.exp_string("Pick a starter").unwrap();
    press(&mut s, ENTER);
    s.exp_string("Logged in to Cloudflare as dev@example.com").unwrap();
    s.exp_string("Which Cloudflare account should host it?").unwrap();
    press(&mut s, &format!("{DOWN}{ENTER}"));
    s.exp_string("Initialize a git repository?").unwrap();
    press(&mut s, "n");
    s.exp_string("Deploy it now?").unwrap();
    press(&mut s, "n");
    s.exp_string("Happy building!").unwrap();
    let (_, code) = finish(s);

    assert_eq!(code, 0);
    let config = fs::read_to_string(sandbox.work.join("shop/cloudflare.config.ts")).unwrap();
    assert!(config.contains("\taccountId: \"acc2\",\n\tworker: {"), "{config}");
    assert!(!sandbox.work.join("shop/.git").exists());
    assert!(!sandbox.work.join("shop/src/posts.rs").exists(), "empty starter");
}

#[test]
fn guided_setup_builds_an_api_only_app_and_can_skip_cloudflare() {
    let sandbox = Sandbox::new();
    let mut s = start(&sandbox, &["new", "later"]);

    s.exp_string("What are you building?").unwrap();
    press(&mut s, &format!("{DOWN}{ENTER}"));
    s.exp_string("a status endpoint").unwrap();
    press(&mut s, &format!("{DOWN}{ENTER}"));
    s.exp_string("Connect your Cloudflare account?").unwrap();
    press(&mut s, &format!("{DOWN}{ENTER}"));
    s.exp_string("Initialize a git repository?").unwrap();
    press(&mut s, "n");
    s.exp_string("ocre login").unwrap();
    s.exp_string("Happy building!").unwrap();
    let (_, code) = finish(s);

    assert_eq!(code, 0);
    assert_eq!(sandbox.calls(), ["cf auth whoami", "npm install"], "no deploy offered without a login");
    let root = sandbox.work.join("later");
    assert!(root.join("src/posts_api.rs").is_file(), "blog starter as a JSON API");
    assert!(!root.join("templates").exists());
    assert!(fs::read_to_string(root.join("Cargo.toml")).unwrap().contains("mode = \"api\""));
}

#[test]
fn flags_answer_the_questions_in_a_terminal_too() {
    let sandbox = Sandbox::new();
    sandbox.accounts_after_login(&[("acc1", "Main")]);
    let s = start(&sandbox, &["new", "flagged", "--api", "--starter", "empty", "--login", "--no-git", "--deploy"]);
    let (output, code) = finish(s);

    assert_eq!(code, 0, "{output}");
    assert!(output.contains("Your app is live at https://flagged.example.workers.dev"), "{output}");
    assert!(!output.contains("What are you building?") && !output.contains("Deploy it now?"), "{output}");
    assert!(sandbox.work.join("flagged/src/lib.rs").is_file() && !sandbox.work.join("flagged/templates").exists());
}

#[test]
fn no_install_skips_npm_and_the_deploy_question() {
    let sandbox = Sandbox::new();
    sandbox.login_as(&[("acc1", "Main")]);
    let s = start(&sandbox, &["new", "offline", "--full-stack", "--starter", "empty", "--no-git", "--no-install"]);
    let (output, code) = finish(s);

    assert_eq!(code, 0, "{output}");
    assert!(output.contains("Happy building!") && !output.contains("Deploy it now?"), "{output}");
    assert_eq!(sandbox.calls(), ["cf auth whoami"]);
    assert!(!sandbox.work.join("offline/node_modules").exists());
}

#[test]
fn flags_can_decline_login_and_deploy() {
    let sandbox = Sandbox::new();
    fs::write(sandbox.work.join("pages.ocre"), "g controller Pages about\n").unwrap();
    let s = start(
        &sandbox,
        &["new", "quiet", "--full-stack", "--starter", "blog", "--no-login", "--git", "--template", "pages.ocre"],
    );
    let (output, code) = finish(s);
    assert_eq!(code, 0, "{output}");
    assert!(output.contains("Happy building!"));
    assert!(sandbox.work.join("quiet/.git").is_dir());
    assert!(sandbox.work.join("quiet/templates/pages/about.html").is_file(), "the template ran");

    // Logged in with an API token (no email), several accounts, account chosen by flag.
    let sandbox = Sandbox::new();
    sandbox.login_as(&[("acc1", "Main"), ("acc2", "Side")]);
    sandbox.write_state(
        "whoami.json",
        r#"{"authenticated":true,"accounts":[{"id":"acc1","name":"Main"},{"id":"acc2","name":"Side"}]}"#,
    );
    let s = start(
        &sandbox,
        &["new", "token", "--full-stack", "--starter", "empty", "--no-git", "--no-deploy", "--account-id", "acc1"],
    );
    let (output, code) = finish(s);
    assert_eq!(code, 0, "{output}");
    assert!(output.contains("Logged in to Cloudflare as an API token"), "{output}");
    let config = fs::read_to_string(sandbox.work.join("token/cloudflare.config.ts")).unwrap();
    assert!(config.contains("\taccountId: \"acc1\",\n"), "{config}");
}

#[test]
fn a_failing_deploy_shows_the_captured_cf_output() {
    let sandbox = Sandbox::new();
    sandbox.login_as(&[("acc1", "Main")]);
    sandbox.set("deploy_fails");
    let s = start(&sandbox, &["new", "broken", "--full-stack", "--starter", "empty", "--no-git", "--deploy"]);
    let (output, code) = finish(s);

    assert_eq!(code, 1);
    assert!(output.contains("error: `cf deploy --secrets-file .wrangler/ocre-secrets.json` failed"), "{output}");
    assert!(output.contains("stdout before failure") && output.contains("deploy_fails"), "{output}");
    assert!(!sandbox.work.join("broken/.wrangler/ocre-secrets.json").exists(), "secrets file deleted");
}

#[test]
fn escape_cancels_the_setup() {
    let sandbox = Sandbox::new();
    let mut s = start(&sandbox, &["new"]);
    s.exp_string("What is your app called?").unwrap();
    s.send_control('c').unwrap();
    let (output, code) = finish(s);

    assert_eq!(code, 1);
    assert!(output.contains("error: cancelled"), "{output}");
    assert!(fs::read_dir(&sandbox.work).unwrap().next().is_none(), "nothing created");
}