Rocket/core/lib/tests/nested-fairing-attaches.rs
Sergio Benitez 4e06ee64aa Test 'secret_key' validation, now on pre-launch.
Prior to this commit, it was not possible to test Rocket crates in
production mode without setting a global secret key or bypassing secret
key checking - the testing script did the latter. The consequence is
that it became impossible to test secret key related failures because
the tests passed regardless.

This commit undoes this. As a consequence, all tests are now aware of
the difference between debug and release configurations, the latter of
which validates 'secret_key' by default. New 'Client::debug()' and
'Client::debug_with()' simplify creating an instance of 'Client' with
configuration in debug mode to avoid undesired test failures.

The summary of changes in this commit are:

  * Config 'secret_key' success and failure are now tested.
  * 'secret_key' validation was moved to pre-launch from 'Config:from()'.
  * 'Config::from()' only extracts the config.
  * Added 'Config::try_from()' for non-panicking extraction.
  * 'Config' now knows the profile it was extracted from.
  * The 'Config' provider sets a profile of 'Config.profile'.
  * 'Rocket', 'Client', 'Fairings', implement 'Debug'.
  * 'fairing::Info' implements 'Copy', 'Clone'.
  * 'Fairings' keeps track of, logs attach fairings.
  * 'Rocket::reconfigure()' was added to allow modifying a config.

Internally, the testing script was refactored to properly test the
codebase with the new changes. In particular, it no longer sets a rustc
'cfg' to avoid secret-key checking.

Resolves #1543.
Fixes #1564.
2021-03-09 21:57:26 -08:00

62 lines
1.8 KiB
Rust

#[macro_use] extern crate rocket;
use std::sync::atomic::{AtomicUsize, Ordering};
use rocket::State;
use rocket::fairing::AdHoc;
use rocket::http::Method;
#[derive(Default)]
struct Counter {
attach: AtomicUsize,
get: AtomicUsize,
}
#[get("/")]
fn index(counter: State<'_, Counter>) -> String {
let attaches = counter.attach.load(Ordering::Relaxed);
let gets = counter.get.load(Ordering::Acquire);
format!("{}, {}", attaches, gets)
}
fn rocket() -> rocket::Rocket {
rocket::ignite()
.mount("/", routes![index])
.attach(AdHoc::on_attach("Outer", |rocket| async {
let counter = Counter::default();
counter.attach.fetch_add(1, Ordering::Relaxed);
let rocket = rocket.manage(counter)
.attach(AdHoc::on_request("Inner", |req, _| {
Box::pin(async move {
if req.method() == Method::Get {
let counter = req.guard::<State<'_, Counter>>()
.await.unwrap();
counter.get.fetch_add(1, Ordering::Release);
}
})
}));
Ok(rocket)
}))
}
mod nested_fairing_attaches_tests {
use super::*;
use rocket::local::blocking::Client;
#[test]
fn test_counts() {
let client = Client::debug(rocket()).unwrap();
let response = client.get("/").dispatch();
assert_eq!(response.into_string(), Some("1, 1".into()));
let response = client.get("/").dispatch();
assert_eq!(response.into_string(), Some("1, 2".into()));
client.get("/").dispatch();
client.get("/").dispatch();
let response = client.get("/").dispatch();
assert_eq!(response.into_string(), Some("1, 5".into()));
}
}