rwf2
/
Rocket
mirror of https://github.com/rwf2/Rocket.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Rename 'Rocket::configure()' to 'reconfigure()'.

This commit is contained in:
Sergio Benitez 2024-04-25 13:21:59 -07:00
parent b34085392d
commit 836e64fec3
10 changed files with 47 additions and 43 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
core/lib/src/local/asynchronous/response.rs
View File

@ -30,7 +30,7 @@ use crate::{Request, Response};
/// #[launch] /// #[launch]
/// fn rocket() -> _ { /// fn rocket() -> _ {
/// rocket::build().mount("/", routes![hello_world]) /// rocket::build().mount("/", routes![hello_world])
/// # .configure(rocket::Config::debug_default()) /// # .reconfigure(rocket::Config::debug_default())
/// } /// }
/// ///
/// # async fn read_body_manually() -> io::Result<()> { /// # async fn read_body_manually() -> io::Result<()> {

2
core/lib/src/local/blocking/response.rs
View File

@ -27,7 +27,7 @@ use super::Client;
/// #[launch] /// #[launch]
/// fn rocket() -> _ { /// fn rocket() -> _ {
/// rocket::build().mount("/", routes![hello_world]) /// rocket::build().mount("/", routes![hello_world])
/// # .configure(rocket::Config::debug_default()) /// # .reconfigure(rocket::Config::debug_default())
/// } /// }
/// ///
/// # fn read_body_manually() -> io::Result<()> { /// # fn read_body_manually() -> io::Result<()> {

2
core/lib/src/local/client.rs
View File

@ -141,7 +141,7 @@ macro_rules! pub_client_impl {
.merge((config::Config::LOG_LEVEL, config::LogLevel::Debug)) .merge((config::Config::LOG_LEVEL, config::LogLevel::Debug))
.select(config::Config::DEBUG_PROFILE); .select(config::Config::DEBUG_PROFILE);
Self::tracked(rocket.configure(figment)) $(.$suffix)? Self::tracked(rocket.reconfigure(figment)) $(.$suffix)?
} }
/// Returns a reference to the `Rocket` this client is creating requests /// Returns a reference to the `Rocket` this client is creating requests

22
core/lib/src/rocket.rs
View File

@ -197,13 +197,11 @@ impl Rocket<Build> {
rocket.attach(Shield::default()) rocket.attach(Shield::default())
} }
/// Sets the configuration provider in `self` to `provider`. /// Overrides the current configuration provider with `provider`.
/// ///
/// A [`Figment`] generated from the current `provider` can _always_ be /// The default provider, or a provider previously set with
/// retrieved via [`Rocket::figment()`]. However, because the provider can /// [`Rocket::custom()`] or [`Rocket::reconfigure()`], is overriden by
/// be changed at any point prior to ignition, a [`Config`] can only be /// `provider`.
/// retrieved in the ignite or orbit phases, or by manually extracting one
/// from a particular figment.
/// ///
/// # Example /// # Example
/// ///
@ -229,7 +227,7 @@ impl Rocket<Build> {
/// .merge((Config::IDENT, "Example")); /// .merge((Config::IDENT, "Example"));
/// ///
/// let rocket = rocket::custom(&config) /// let rocket = rocket::custom(&config)
/// .configure(figment) /// .reconfigure(figment)
/// .ignite().await?; /// .ignite().await?;
/// ///
/// assert_eq!(rocket.config().ident.as_str(), Some("Example")); /// assert_eq!(rocket.config().ident.as_str(), Some("Example"));
@ -238,7 +236,7 @@ impl Rocket<Build> {
/// # }); /// # });
/// ``` /// ```
#[must_use] #[must_use]
pub fn configure<T: Provider>(mut self, provider: T) -> Self { pub fn reconfigure<T: Provider>(mut self, provider: T) -> Self {
self.figment = Figment::from(provider); self.figment = Figment::from(provider);
self self
} }
@ -522,7 +520,7 @@ impl Rocket<Build> {
/// #[rocket::main] /// #[rocket::main]
/// async fn main() -> Result<(), rocket::Error> { /// async fn main() -> Result<(), rocket::Error> {
/// let rocket = rocket::build() /// let rocket = rocket::build()
/// # .configure(rocket::Config::debug_default()) /// # .reconfigure(rocket::Config::debug_default())
/// .attach(AdHoc::on_ignite("Manage State", |rocket| async move { /// .attach(AdHoc::on_ignite("Manage State", |rocket| async move {
/// rocket.manage(String::from("managed string")) /// rocket.manage(String::from("managed string"))
/// })); /// }));
@ -918,6 +916,12 @@ impl<P: Phase> Rocket<P> {
/// `self`. To extract a typed config, prefer to use /// `self`. To extract a typed config, prefer to use
/// [`AdHoc::config()`](crate::fairing::AdHoc::config()). /// [`AdHoc::config()`](crate::fairing::AdHoc::config()).
/// ///
/// Note; A [`Figment`] generated from the current `provider` can _always_
/// be retrieved via this method. However, because the provider can be
/// changed at any point prior to ignition, a [`Config`] can only be
/// retrieved in the ignite or orbit phases, or by manually extracting one
/// from a particular figment.
///
/// # Example /// # Example
/// ///
/// ```rust /// ```rust

4
core/lib/src/sentinel.rs
View File

@ -41,7 +41,7 @@ use crate::{Rocket, Ignite};
/// ///
/// # use rocket::{Config, error::ErrorKind}; /// # use rocket::{Config, error::ErrorKind};
/// # rocket::async_test(async { /// # rocket::async_test(async {
/// # let result = rocket().configure(Config::debug_default()).ignite().await; /// # let result = rocket().reconfigure(Config::debug_default()).ignite().await;
/// # assert!(matches!(result.unwrap_err().kind(), ErrorKind::SentinelAborts(..))); /// # assert!(matches!(result.unwrap_err().kind(), ErrorKind::SentinelAborts(..)));
/// # }) /// # })
/// ``` /// ```
@ -76,7 +76,7 @@ use crate::{Rocket, Ignite};
/// ///
/// # use rocket::{Config, error::ErrorKind}; /// # use rocket::{Config, error::ErrorKind};
/// # rocket::async_test(async { /// # rocket::async_test(async {
/// # rocket().configure(Config::debug_default()).ignite().await.unwrap(); /// # rocket().reconfigure(Config::debug_default()).ignite().await.unwrap();
/// # }) /// # })
/// ``` /// ```
/// ///

26
core/lib/tests/sentinel.rs
View File

@ -9,7 +9,7 @@ fn one_state<'r>(_three: &'r State<u8>, s: &'r str) -> &'r str { s }
#[async_test] #[async_test]
async fn state_sentinel_works() { async fn state_sentinel_works() {
let err = rocket::build() let err = rocket::build()
.configure(Config::debug_default()) .reconfigure(Config::debug_default())
.mount("/", routes![two_states]) .mount("/", routes![two_states])
.ignite().await .ignite().await
.unwrap_err(); .unwrap_err();
@ -17,7 +17,7 @@ async fn state_sentinel_works() {
assert!(matches!(err.kind(), SentinelAborts(vec) if vec.len() == 2)); assert!(matches!(err.kind(), SentinelAborts(vec) if vec.len() == 2));
let err = rocket::build() let err = rocket::build()
.configure(Config::debug_default()) .reconfigure(Config::debug_default())
.mount("/", routes![two_states]) .mount("/", routes![two_states])
.manage(String::new()) .manage(String::new())
.ignite().await .ignite().await
@ -26,7 +26,7 @@ async fn state_sentinel_works() {
assert!(matches!(err.kind(), SentinelAborts(vec) if vec.len() == 1)); assert!(matches!(err.kind(), SentinelAborts(vec) if vec.len() == 1));
let err = rocket::build() let err = rocket::build()
.configure(Config::debug_default()) .reconfigure(Config::debug_default())
.mount("/", routes![two_states]) .mount("/", routes![two_states])
.manage(1 as u32) .manage(1 as u32)
.ignite().await .ignite().await
@ -35,7 +35,7 @@ async fn state_sentinel_works() {
assert!(matches!(err.kind(), SentinelAborts(vec) if vec.len() == 1)); assert!(matches!(err.kind(), SentinelAborts(vec) if vec.len() == 1));
let result = rocket::build() let result = rocket::build()
.configure(Config::debug_default()) .reconfigure(Config::debug_default())
.mount("/", routes![two_states]) .mount("/", routes![two_states])
.manage(String::new()) .manage(String::new())
.manage(1 as u32) .manage(1 as u32)
@ -44,7 +44,7 @@ async fn state_sentinel_works() {
assert!(result.is_ok()); assert!(result.is_ok());
let err = rocket::build() let err = rocket::build()
.configure(Config::debug_default()) .reconfigure(Config::debug_default())
.mount("/", routes![one_state]) .mount("/", routes![one_state])
.ignite().await .ignite().await
.unwrap_err(); .unwrap_err();
@ -52,7 +52,7 @@ async fn state_sentinel_works() {
assert!(matches!(err.kind(), SentinelAborts(vec) if vec.len() == 1)); assert!(matches!(err.kind(), SentinelAborts(vec) if vec.len() == 1));
let result = rocket::build() let result = rocket::build()
.configure(Config::debug_default()) .reconfigure(Config::debug_default())
.mount("/", routes![one_state]) .mount("/", routes![one_state])
.manage(1 as u8) .manage(1 as u8)
.ignite().await; .ignite().await;
@ -60,7 +60,7 @@ async fn state_sentinel_works() {
assert!(result.is_ok()); assert!(result.is_ok());
let err = rocket::build() let err = rocket::build()
.configure(Config::debug_default()) .reconfigure(Config::debug_default())
.mount("/", routes![one_state, two_states]) .mount("/", routes![one_state, two_states])
.ignite().await .ignite().await
.unwrap_err(); .unwrap_err();
@ -68,7 +68,7 @@ async fn state_sentinel_works() {
assert!(matches!(err.kind(), SentinelAborts(vec) if vec.len() == 3)); assert!(matches!(err.kind(), SentinelAborts(vec) if vec.len() == 3));
let err = rocket::build() let err = rocket::build()
.configure(Config::debug_default()) .reconfigure(Config::debug_default())
.mount("/", routes![one_state, two_states]) .mount("/", routes![one_state, two_states])
.manage(1 as u32) .manage(1 as u32)
.ignite().await .ignite().await
@ -77,7 +77,7 @@ async fn state_sentinel_works() {
assert!(matches!(err.kind(), SentinelAborts(vec) if vec.len() == 2)); assert!(matches!(err.kind(), SentinelAborts(vec) if vec.len() == 2));
let err = rocket::build() let err = rocket::build()
.configure(Config::debug_default()) .reconfigure(Config::debug_default())
.mount("/", routes![one_state, two_states]) .mount("/", routes![one_state, two_states])
.manage(1 as u8) .manage(1 as u8)
.ignite().await .ignite().await
@ -86,7 +86,7 @@ async fn state_sentinel_works() {
assert!(matches!(err.kind(), SentinelAborts(vec) if vec.len() == 2)); assert!(matches!(err.kind(), SentinelAborts(vec) if vec.len() == 2));
let err = rocket::build() let err = rocket::build()
.configure(Config::debug_default()) .reconfigure(Config::debug_default())
.mount("/", routes![one_state, two_states]) .mount("/", routes![one_state, two_states])
.manage(1 as u32) .manage(1 as u32)
.manage(1 as u8) .manage(1 as u8)
@ -96,7 +96,7 @@ async fn state_sentinel_works() {
assert!(matches!(err.kind(), SentinelAborts(vec) if vec.len() == 1)); assert!(matches!(err.kind(), SentinelAborts(vec) if vec.len() == 1));
let result = rocket::build() let result = rocket::build()
.configure(Config::debug_default()) .reconfigure(Config::debug_default())
.mount("/", routes![one_state, two_states]) .mount("/", routes![one_state, two_states])
.manage(1 as u32) .manage(1 as u32)
.manage(1 as u8) .manage(1 as u8)
@ -128,7 +128,7 @@ fn with_data(_data: Data) {}
#[async_test] #[async_test]
async fn data_sentinel_works() { async fn data_sentinel_works() {
let err = rocket::build() let err = rocket::build()
.configure(Config::debug_default()) .reconfigure(Config::debug_default())
.mount("/", routes![with_data]) .mount("/", routes![with_data])
.ignite().await .ignite().await
.unwrap_err(); .unwrap_err();
@ -136,7 +136,7 @@ async fn data_sentinel_works() {
assert!(matches!(err.kind(), SentinelAborts(vec) if vec.len() == 1)); assert!(matches!(err.kind(), SentinelAborts(vec) if vec.len() == 1));
let result = rocket::build() let result = rocket::build()
.configure(Config::debug_default()) .reconfigure(Config::debug_default())
.mount("/", routes![with_data]) .mount("/", routes![with_data])
.manage(Data) .manage(Data)
.ignite().await; .ignite().await;

4
core/lib/tests/shutdown-fairings.rs
View File

@ -101,7 +101,7 @@ async fn async_slow_shutdown_doesnt_elongate_grace() {
let rocket = rocket::build() let rocket = rocket::build()
.manage(Flags::default()) .manage(Flags::default())
.configure(config) .reconfigure(config)
.attach(AdHoc::on_shutdown("Slow Shutdown", |rocket| Box::pin(async move { .attach(AdHoc::on_shutdown("Slow Shutdown", |rocket| Box::pin(async move {
tokio::time::sleep(std::time::Duration::from_secs(4)).await; tokio::time::sleep(std::time::Duration::from_secs(4)).await;
let flags = rocket.state::<Flags>().unwrap(); let flags = rocket.state::<Flags>().unwrap();
@ -141,7 +141,7 @@ fn background_tasks_dont_prevent_terminate() {
config.shutdown.grace = 1; config.shutdown.grace = 1;
config.shutdown.mercy = 1; config.shutdown.mercy = 1;
let rocket = rocket::build().configure(config).mount("/", routes![index]); let rocket = rocket::build().reconfigure(config).mount("/", routes![index]);
let client = Client::debug(rocket).unwrap(); let client = Client::debug(rocket).unwrap();
let response = client.get("/").dispatch(); let response = client.get("/").dispatch();

4
docs/guide/09-testing.md
View File

@ -180,7 +180,7 @@ testing: we _want_ our tests to panic when something goes wrong.
```rust ```rust
# #[rocket::launch] # #[rocket::launch]
# fn rocket() -> _ { # fn rocket() -> _ {
# rocket::build().configure(rocket::Config::debug_default()) # rocket::build().reconfigure(rocket::Config::debug_default())
# } # }
# use rocket::local::blocking::Client; # use rocket::local::blocking::Client;
@ -194,7 +194,7 @@ application's response:
# use rocket::uri; # use rocket::uri;
# #[rocket::launch] # #[rocket::launch]
# fn rocket() -> _ { # fn rocket() -> _ {
# rocket::build().configure(rocket::Config::debug_default()) # rocket::build().reconfigure(rocket::Config::debug_default())
# } # }
# #[rocket::get("/")] # #[rocket::get("/")]

2
examples/tls/src/tests.rs
View File

@ -75,7 +75,7 @@ fn validate_profiles(profiles: &[&str]) {
}; };
let figment = Config::figment().merge(config).select(profile); let figment = Config::figment().merge(config).select(profile);
let client = Client::tracked_secure(super::rocket().configure(figment)).unwrap(); let client = Client::tracked_secure(super::rocket().reconfigure(figment)).unwrap();
let response = client.get("/").dispatch(); let response = client.get("/").dispatch();
assert_eq!(response.into_string().unwrap(), "Hello, world!"); assert_eq!(response.into_string().unwrap(), "Hello, world!");

22
testbench/src/main.rs
View File

@ -34,28 +34,28 @@ static TLS_CONFIG: &str = r#"
trait RocketExt { trait RocketExt {
fn default() -> Self; fn default() -> Self;
fn tls_default() -> Self; fn tls_default() -> Self;
fn configure_with_toml(self, toml: &str) -> Self; fn reconfigure_with_toml(self, toml: &str) -> Self;
} }
impl RocketExt for Rocket<Build> { impl RocketExt for Rocket<Build> {
fn default() -> Self { fn default() -> Self {
rocket::build().configure_with_toml(DEFAULT_CONFIG) rocket::build().reconfigure_with_toml(DEFAULT_CONFIG)
} }
fn tls_default() -> Self { fn tls_default() -> Self {
rocket::build() rocket::build()
.configure_with_toml(DEFAULT_CONFIG) .reconfigure_with_toml(DEFAULT_CONFIG)
.configure_with_toml(TLS_CONFIG) .reconfigure_with_toml(TLS_CONFIG)
} }
fn configure_with_toml(self, toml: &str) -> Self { fn reconfigure_with_toml(self, toml: &str) -> Self {
use rocket::figment::{Figment, providers::{Format, Toml}}; use rocket::figment::{Figment, providers::{Format, Toml}};
let toml = toml.replace("{ROCKET}", rocket::fs::relative!("../")); let toml = toml.replace("{ROCKET}", rocket::fs::relative!("../"));
let config = Figment::from(self.figment()) let config = Figment::from(self.figment())
.merge(Toml::string(&toml).nested()); .merge(Toml::string(&toml).nested());
self.configure(config) self.reconfigure(config)
} }
} }
@ -139,7 +139,7 @@ fn tls_info() -> Result<()> {
let server = Server::spawn((), |(token, _)| { let server = Server::spawn((), |(token, _)| {
let rocket = rocket::build() let rocket = rocket::build()
.configure_with_toml(TLS_CONFIG) .reconfigure_with_toml(TLS_CONFIG)
.mount("/", routes![hello_world]); .mount("/", routes![hello_world]);
token.with_launch(rocket, |rocket| { token.with_launch(rocket, |rocket| {
@ -229,7 +229,7 @@ fn test_mtls(mandatory: bool) -> Result<()> {
} }
Rocket::tls_default() Rocket::tls_default()
.configure_with_toml(&mtls_config) .reconfigure_with_toml(&mtls_config)
.mount("/", routes![hello, hi]) .mount("/", routes![hello, hi])
})?; })?;
@ -318,7 +318,7 @@ fn sni_resolver() -> Result<()> {
#[get("/")] fn index() { } #[get("/")] fn index() { }
Rocket::default() Rocket::default()
.configure_with_toml(SNI_TLS_CONFIG) .reconfigure_with_toml(SNI_TLS_CONFIG)
.mount("/", routes![index]) .mount("/", routes![index])
.attach(SniResolver::fairing()) .attach(SniResolver::fairing())
}?; }?;
@ -348,7 +348,7 @@ fn sni_resolver() -> Result<()> {
fn tcp_unix_listener_fail() -> Result<()> { fn tcp_unix_listener_fail() -> Result<()> {
let server = spawn! { let server = spawn! {
Rocket::default().configure_with_toml("[default]\naddress = 123") Rocket::default().reconfigure_with_toml("[default]\naddress = 123")
}; };
if let Err(Error::Liftoff(stdout, _)) = server { if let Err(Error::Liftoff(stdout, _)) = server {
@ -359,7 +359,7 @@ fn tcp_unix_listener_fail() -> Result<()> {
} }
let server = Server::spawn((), |(token, _)| { let server = Server::spawn((), |(token, _)| {
let rocket = Rocket::default().configure_with_toml("[default]\naddress = \"unix:foo\""); let rocket = Rocket::default().reconfigure_with_toml("[default]\naddress = \"unix:foo\"");
token.launch_with::<TcpListener>(rocket) token.launch_with::<TcpListener>(rocket)
}); });