Add integration tests

examples/10_request_shutdown.rs

@@ -22,7 +22,7 @@ impl CountdownSubsystem {
 
     async fn run(self, subsys: SubsystemHandle) -> Result<()> {
         match self.countdown().cancel_on_shutdown(&subsys).await {
-            Ok(()) => subsys.initiate_shutdown(),
+            Ok(()) => subsys.request_shutdown(),
             Err(CancelledByShutdown) => tracing::info!("Countdown cancelled."),
         }
 

src/into_subsystem.rs

@@ -33,7 +33,7 @@ type SubsystemFunction<Err, ErrWrapper> =
 /// #[async_trait::async_trait]
 /// impl IntoSubsystem<miette::Report> for MySubsystem {
 ///     async fn run(self, subsys: SubsystemHandle) -> Result<()> {
-///         subsys.initiate_shutdown();
+///         subsys.request_shutdown();
 ///         Ok(())
 ///     }
 /// }

src/lib.rs

@@ -37,7 +37,7 @@
 //!             tracing::info!("Countdown cancelled.");
 //!         },
 //!         _ = countdown() => {
-//!             subsys.initiate_shutdown();
+//!             subsys.request_shutdown();
 //!         }
 //!     };
 //!

src/subsystem/subsystem_handle.rs

@@ -288,18 +288,18 @@ impl<ErrType: ErrTypeTraits> SubsystemHandle<ErrType> {
     ///     sleep(Duration::from_millis(1000)).await;
     ///
     ///     // Shut down the entire subsystem tree
-    ///     subsys.initiate_shutdown();
+    ///     subsys.request_shutdown();
     ///
     ///     Ok(())
     /// }
     /// ```
-    pub fn initiate_shutdown(&self) {
+    pub fn request_shutdown(&self) {
         self.inner.toplevel_cancellation_token.cancel();
     }
 
     /// Triggers a shutdown of the current subsystem and all
     /// of its children.
-    pub fn initiate_local_shutdown(&self) {
+    pub fn request_local_shutdown(&self) {
         self.inner.cancellation_token.cancel();
     }
 

src/toplevel.rs

@@ -24,7 +24,7 @@ use crate::{
 /// use tokio_graceful_shutdown::{SubsystemBuilder, SubsystemHandle, Toplevel};
 ///
 /// async fn my_subsystem(subsys: SubsystemHandle) -> Result<()> {
-///     subsys.initiate_shutdown();
+///     subsys.request_shutdown();
 ///     Ok(())
 /// }
 ///
@@ -165,7 +165,7 @@ impl<ErrType: ErrTypeTraits> Toplevel<ErrType> {
                 tracing::info!("All subsystems finished.");
 
                 // Not really necessary, but for good measure.
-                self.root_handle.initiate_shutdown();
+                self.root_handle.request_shutdown();
 
                 let errors = collect_errors();
                 let result = if errors.is_empty() {
@@ -203,7 +203,8 @@ impl<ErrType: ErrTypeTraits> Toplevel<ErrType> {
     }
 
     #[doc(hidden)]
-    pub fn get_shutdown_token(&self) -> &CancellationToken {
+    // Only for unit tests; not intended for public use
+    pub fn _get_shutdown_token(&self) -> &CancellationToken {
         self.root_handle.get_cancellation_token()
     }
 }

tests/common/event.rs

@@ -1,5 +1,3 @@
-#![allow(unused)]
-
 use tokio::sync::watch;
 
 pub struct Event {