|
| 1 | +use crate::builders::CrateBuilder; |
| 2 | +use crate::util::{ChaosProxy, FreshSchema}; |
| 3 | +use anyhow::Error; |
| 4 | +use cargo_registry::models::{NewUser, User}; |
| 5 | +use diesel::prelude::*; |
| 6 | +use reqwest::blocking::{Client, Response}; |
| 7 | +use std::collections::HashMap; |
| 8 | +use std::io::{BufRead, BufReader, Read}; |
| 9 | +use std::process::{Child, Command, Stdio}; |
| 10 | +use std::sync::{mpsc::Sender, Arc}; |
| 11 | +use std::time::Duration; |
| 12 | + |
| 13 | +const SERVER_BOOT_TIMEOUT_SECONDS: u64 = 30; |
| 14 | + |
| 15 | +#[test] |
| 16 | +fn normal_startup() -> Result<(), Error> { |
| 17 | + let server_bin = ServerBin::prepare()?; |
| 18 | + initialize_dummy_crate(&server_bin.db()?); |
| 19 | + |
| 20 | + let running_server = server_bin.start()?; |
| 21 | + |
| 22 | + // Ensure the application correctly responds to download requests |
| 23 | + let resp = running_server.get("api/v1/crates/FOO/1.0.0/download")?; |
| 24 | + assert!(resp.status().is_redirection()); |
| 25 | + assert!(resp |
| 26 | + .headers() |
| 27 | + .get("location") |
| 28 | + .unwrap() |
| 29 | + .to_str()? |
| 30 | + .ends_with("/crates/foo/foo-1.0.0.crate")); |
| 31 | + |
| 32 | + Ok(()) |
| 33 | +} |
| 34 | + |
| 35 | +#[test] |
| 36 | +fn startup_without_database() -> Result<(), Error> { |
| 37 | + let server_bin = ServerBin::prepare()?; |
| 38 | + initialize_dummy_crate(&server_bin.db()?); |
| 39 | + |
| 40 | + // Break the networking *before* starting the binary, to ensure the binary can fully startup |
| 41 | + // without a database connection. Most of crates.io should not work when started without a |
| 42 | + // database, but unconditional redirects will work. |
| 43 | + server_bin.chaosproxy.break_networking(); |
| 44 | + |
| 45 | + let running_server = server_bin.start()?; |
| 46 | + |
| 47 | + // Ensure unconditional redirects work. |
| 48 | + let resp = running_server.get("api/v1/crates/FOO/1.0.0/download")?; |
| 49 | + assert!(resp.status().is_redirection()); |
| 50 | + assert!(resp |
| 51 | + .headers() |
| 52 | + .get("location") |
| 53 | + .unwrap() |
| 54 | + .to_str()? |
| 55 | + .ends_with("/crates/FOO/FOO-1.0.0.crate")); |
| 56 | + |
| 57 | + Ok(()) |
| 58 | +} |
| 59 | + |
| 60 | +fn initialize_dummy_crate(conn: &PgConnection) { |
| 61 | + use cargo_registry::schema::users; |
| 62 | + |
| 63 | + let user: User = diesel::insert_into(users::table) |
| 64 | + .values(NewUser { |
| 65 | + gh_id: 0, |
| 66 | + gh_login: "user", |
| 67 | + ..NewUser::default() |
| 68 | + }) |
| 69 | + .get_result(conn) |
| 70 | + .expect("failed to create dummy user"); |
| 71 | + |
| 72 | + CrateBuilder::new("foo", user.id) |
| 73 | + .version("1.0.0") |
| 74 | + .build(conn) |
| 75 | + .expect("failed to create dummy crate"); |
| 76 | +} |
| 77 | + |
| 78 | +struct ServerBin { |
| 79 | + chaosproxy: Arc<ChaosProxy>, |
| 80 | + db_url: String, |
| 81 | + env: HashMap<String, String>, |
| 82 | + fresh_schema: FreshSchema, |
| 83 | +} |
| 84 | + |
| 85 | +impl ServerBin { |
| 86 | + fn prepare() -> Result<Self, Error> { |
| 87 | + let mut env = dotenv::vars().collect::<HashMap<_, _>>(); |
| 88 | + // Bind a random port every time the server is started. |
| 89 | + env.insert("PORT".into(), "0".into()); |
| 90 | + // Avoid creating too many database connections. |
| 91 | + env.insert("DB_POOL_SIZE".into(), "2".into()); |
| 92 | + env.remove("DB_MIN_SIZE"); |
| 93 | + // Other configuration variables needed for the application to boot. |
| 94 | + env.insert("WEB_ALLOWED_ORIGINS".into(), "http://localhost:8888".into()); |
| 95 | + env.insert( |
| 96 | + "SESSION_KEY".into(), |
| 97 | + std::iter::repeat('a').take(32).collect(), |
| 98 | + ); |
| 99 | + env.insert("GH_CLIENT_ID".into(), String::new()); |
| 100 | + env.insert("GH_CLIENT_SECRET".into(), String::new()); |
| 101 | + |
| 102 | + // Use a proxied fresh schema as the database url. |
| 103 | + let fresh_schema = FreshSchema::new(env.get("TEST_DATABASE_URL").unwrap()); |
| 104 | + let (chaosproxy, db_url) = ChaosProxy::proxy_database_url(fresh_schema.database_url())?; |
| 105 | + env.remove("TEST_DATABASE_URL"); |
| 106 | + env.insert("DATABASE_URL".into(), db_url.clone()); |
| 107 | + env.insert("READ_ONLY_REPLICA_URL".into(), db_url.clone()); |
| 108 | + |
| 109 | + Ok(ServerBin { |
| 110 | + chaosproxy, |
| 111 | + db_url, |
| 112 | + env, |
| 113 | + fresh_schema, |
| 114 | + }) |
| 115 | + } |
| 116 | + |
| 117 | + fn db(&self) -> Result<PgConnection, Error> { |
| 118 | + Ok(PgConnection::establish(&self.db_url)?) |
| 119 | + } |
| 120 | + |
| 121 | + fn start(self) -> Result<RunningServer, Error> { |
| 122 | + let mut process = Command::new(env!("CARGO_BIN_EXE_server")) |
| 123 | + .env_clear() |
| 124 | + .envs(self.env.into_iter()) |
| 125 | + .stdout(Stdio::piped()) |
| 126 | + .stderr(Stdio::piped()) |
| 127 | + .spawn()?; |
| 128 | + |
| 129 | + let (port_send, port_recv) = std::sync::mpsc::channel(); |
| 130 | + stream_processor(process.stdout.take().unwrap(), "stdout", Some(port_send)); |
| 131 | + stream_processor(process.stderr.take().unwrap(), "stderr", None); |
| 132 | + |
| 133 | + // Possible causes for this to fail: |
| 134 | + // - the server binary failed to start |
| 135 | + // - the server binary requires a database connection now |
| 136 | + // - the server binary doesn't print "listening on port {port}" anymore |
| 137 | + let port: u16 = port_recv |
| 138 | + .recv_timeout(Duration::from_secs(SERVER_BOOT_TIMEOUT_SECONDS)) |
| 139 | + .map_err(|_| anyhow::anyhow!("the server took too much time to initialize"))? |
| 140 | + .parse()?; |
| 141 | + |
| 142 | + let http = Client::builder() |
| 143 | + .redirect(reqwest::redirect::Policy::none()) |
| 144 | + .build()?; |
| 145 | + |
| 146 | + Ok(RunningServer { |
| 147 | + process, |
| 148 | + port, |
| 149 | + http, |
| 150 | + _chaosproxy: self.chaosproxy, |
| 151 | + _fresh_schema: self.fresh_schema, |
| 152 | + }) |
| 153 | + } |
| 154 | +} |
| 155 | + |
| 156 | +struct RunningServer { |
| 157 | + process: Child, |
| 158 | + port: u16, |
| 159 | + http: Client, |
| 160 | + |
| 161 | + // Keep these two items at the bottom in this order to drop everything in the correct order. |
| 162 | + _chaosproxy: Arc<ChaosProxy>, |
| 163 | + _fresh_schema: FreshSchema, |
| 164 | +} |
| 165 | + |
| 166 | +impl RunningServer { |
| 167 | + fn get(&self, url: &str) -> Result<Response, Error> { |
| 168 | + Ok(self |
| 169 | + .http |
| 170 | + .get(format!("http://127.0.0.1:{}/{}", self.port, url)) |
| 171 | + .header("User-Agent", "crates.io test suite") |
| 172 | + .send()?) |
| 173 | + } |
| 174 | +} |
| 175 | + |
| 176 | +impl Drop for RunningServer { |
| 177 | + fn drop(&mut self) { |
| 178 | + self.process |
| 179 | + .kill() |
| 180 | + .expect("failed to kill the server binary"); |
| 181 | + } |
| 182 | +} |
| 183 | + |
| 184 | +fn stream_processor<R>(stream: R, kind: &'static str, port_send: Option<Sender<String>>) |
| 185 | +where |
| 186 | + R: Read + Send + 'static, |
| 187 | +{ |
| 188 | + std::thread::spawn(move || { |
| 189 | + let stream = BufReader::new(stream); |
| 190 | + for line in stream.lines() { |
| 191 | + let line = match line { |
| 192 | + Ok(line) => line, |
| 193 | + // We receive an EOF when the process terminates |
| 194 | + Err(err) if err.kind() == std::io::ErrorKind::UnexpectedEof => break, |
| 195 | + Err(err) => panic!("unexpected error while reading process {}: {}", kind, err), |
| 196 | + }; |
| 197 | + |
| 198 | + // If we expect the port number to be logged into this stream, look for it and send it |
| 199 | + // over the channel as soon as it's found. |
| 200 | + if let Some(port) = &port_send { |
| 201 | + if let Some(port_str) = line.strip_prefix("listening on port ") { |
| 202 | + port.send(port_str.into()) |
| 203 | + .expect("failed to send the port to the test thread") |
| 204 | + } |
| 205 | + } |
| 206 | + |
| 207 | + println!("[server {}] {}", kind, line); |
| 208 | + } |
| 209 | + }); |
| 210 | +} |
0 commit comments