oysteikt/mpvipc-async
oysteikt
/
mpvipc-async
1
0
Fork 0
Code Issues 4 Pull Requests Actions Releases 1 Activity

Add comments for `integration_tests::event_property_parser`

This commit is contained in:
Oystein Kristoffer Tveit 2024-08-03 15:36:53 +02:00
parent 93366593c7
commit bb050d7a6d
Signed by: oysteikt
GPG Key ID: 9F2F7D8250F35146
1 changed files with 12 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
tests/integration_tests/event_property_parser.rs
View File

@ -19,6 +19,11 @@ enum PropertyCheckingThreadError {
MpvError(#[from] MpvError), MpvError(#[from] MpvError),
} }
/// This function will create an ongoing tokio task that collects [`Event::PropertyChange`] events,
/// and parses them into [`mpvipc::Property`]s. It will then run the property through the provided
/// closure, and return an error if the closure returns false.
///
/// The returned cancellation token can be used to stop the task.
fn create_interruptable_event_property_checking_thread<T>( fn create_interruptable_event_property_checking_thread<T>(
mut events: impl Stream<Item = Result<Event, MpvError>> + Unpin + Send + 'static, mut events: impl Stream<Item = Result<Event, MpvError>> + Unpin + Send + 'static,
on_property: T, on_property: T,
@ -61,6 +66,9 @@ where
(handle, cancellation_token) (handle, cancellation_token)
} }
/// This helper function will gracefully shut down both the event checking thread and the mpv process.
/// It will also return an error if the event checking thread happened to panic, or if it times out
/// The timeout is hardcoded to 500ms.
async fn graceful_shutdown( async fn graceful_shutdown(
cancellation_token: tokio_util::sync::CancellationToken, cancellation_token: tokio_util::sync::CancellationToken,
handle: tokio::task::JoinHandle<Result<(), PropertyCheckingThreadError>>, handle: tokio::task::JoinHandle<Result<(), PropertyCheckingThreadError>>,
@ -103,6 +111,7 @@ async fn graceful_shutdown(
Ok(()) Ok(())
} }
/// Test correct parsing of different values of the "pause" property
#[test(tokio::test)] #[test(tokio::test)]
#[cfg(target_family = "unix")] #[cfg(target_family = "unix")]
async fn test_highlevel_event_pause() -> Result<(), MpvError> { async fn test_highlevel_event_pause() -> Result<(), MpvError> {
@ -131,6 +140,7 @@ async fn test_highlevel_event_pause() -> Result<(), MpvError> {
Ok(()) Ok(())
} }
/// Test correct parsing of different values of the "volume" property
#[test(tokio::test)] #[test(tokio::test)]
#[cfg(target_family = "unix")] #[cfg(target_family = "unix")]
async fn test_highlevel_event_volume() -> Result<(), MpvError> { async fn test_highlevel_event_volume() -> Result<(), MpvError> {
@ -160,6 +170,7 @@ async fn test_highlevel_event_volume() -> Result<(), MpvError> {
Ok(()) Ok(())
} }
/// Test correct parsing of different values of the "mute" property
#[test(tokio::test)] #[test(tokio::test)]
#[cfg(target_family = "unix")] #[cfg(target_family = "unix")]
async fn test_highlevel_event_mute() -> Result<(), MpvError> { async fn test_highlevel_event_mute() -> Result<(), MpvError> {
@ -187,6 +198,7 @@ async fn test_highlevel_event_mute() -> Result<(), MpvError> {
Ok(()) Ok(())
} }
/// Test correct parsing of different values of the "duration" property
#[test(tokio::test)] #[test(tokio::test)]
#[cfg(target_family = "unix")] #[cfg(target_family = "unix")]
async fn test_highlevel_event_duration() -> Result<(), MpvError> { async fn test_highlevel_event_duration() -> Result<(), MpvError> {