Skip to content

Commit

Permalink
tests(beacons): clean up tests file logic and format
Browse files Browse the repository at this point in the history
  • Loading branch information
@torrybr
torrybr committed Jul 3, 2024
1 parent 48eab18 commit df93412
Showing 1 changed file with 66 additions and 86 deletions.
152 changes: 66 additions & 86 deletions crates/matrix-sdk-ui/src/timeline/tests/beacons.rs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -8,40 +8,36 @@ use ruma::{
};

use crate::timeline::{
beacons::BeaconState,
tests::{beacons::fakes::create_beacon_info, TestTimeline},
EventTimelineItem, TimelineItemContent,
beacons::BeaconState, tests::TestTimeline, EventTimelineItem, TimelineItemContent,
};

#[async_test]
async fn beacon_info_is_correctly_processed_in_timeline() {
let timeline = TestTimeline::new();
let alice_beacon = create_beacon_info("Alice's Live location", 2300);

timeline.send_beacon_info(&ALICE, alice_beacon).await;
timeline.send_beacon_info(&ALICE, fakes::beacon_info_a()).await;
let beacon_state = timeline.beacon_state().await;

assert_beacon_info(
&beacon_state.beacon_info_event_content,
&create_beacon_info("Alice's Live location", 2300),
);
assert_beacon_info(&beacon_state.beacon_info_event_content, &fakes::beacon_info_a());
assert!(beacon_state.last_location.is_none());
assert_eq!(beacon_state.user_id.as_str(), "@alice:server.name");
}

#[async_test]
async fn beacon_updates_location() {
let geo_uri = "geo:51.5008,0.1247;u=35".to_string();

let timeline = TestTimeline::new();
timeline.send_beacon_info(&ALICE, create_beacon_info("Alice's Live location", 2300)).await;
timeline.send_beacon_info(&ALICE, fakes::beacon_info_a()).await;
let beacon_info_id = timeline.beacon_info_event().await.event_id().unwrap().to_owned();

// Alice sends her location beacon
timeline.send_beacon(&ALICE, &beacon_info_id, geo_uri).await;
let beacon_state = timeline.beacon_state().await;

assert!(beacon_state.last_location.is_some());
assert!(beacon_state.beacon_info_event_content.is_live());
assert_beacon_info(&beacon_state.beacon_info_event_content, &fakes::beacon_info_a());
assert_beacon(&beacon_state.last_location.unwrap(), &fakes::location_a());
assert_eq!(beacon_state.user_id.as_str(), "@alice:server.name");
}

#[async_test]
Expand All @@ -50,31 +46,24 @@ async fn beacon_updates_location_with_multiple_beacons() {
let geo_uri2 = "geo:51.5009,0.1248;u=36";

let timeline = TestTimeline::new();
timeline.send_beacon_info(&ALICE, create_beacon_info("Alice's Live location", 2300)).await;
let beacon_info_id = timeline.beacon_info_event().await.event_id().unwrap().to_owned();

timeline.send_beacon_info(&ALICE, fakes::beacon_info_a()).await;

let beacon_info_event_id = timeline.beacon_info_event().await.event_id().unwrap().to_owned();

// Alice sends her location beacon
timeline.send_beacon(&ALICE, &beacon_info_id, geo_uri.to_string()).await;
timeline.send_beacon(&ALICE, &beacon_info_event_id, geo_uri.to_string()).await;
let beacon_state = timeline.beacon_state().await;

assert!(beacon_state.last_location.is_some());
assert_eq!(beacon_state.last_location.unwrap().uri, geo_uri);
assert_beacon_info(
&beacon_state.beacon_info_event_content,
&create_beacon_info("Alice's Live location", 2300),
);
assert!(beacon_state.beacon_info_event_content.is_live());
assert_beacon_info(&beacon_state.beacon_info_event_content, &fakes::beacon_info_a());
assert_beacon(&beacon_state.last_location.as_ref().unwrap(), &fakes::location_a());

timeline.send_beacon(&ALICE, &beacon_info_id, geo_uri2.to_string()).await;
timeline.send_beacon(&ALICE, &beacon_info_event_id, geo_uri2.to_string()).await;
let beacon_state = timeline.beacon_state().await;

assert!(beacon_state.last_location.is_some());
assert_beacon_info(&beacon_state.beacon_info_event_content, &fakes::beacon_info_a());
assert_eq!(beacon_state.last_location.unwrap().uri, geo_uri2);
assert_beacon_info(
&beacon_state.beacon_info_event_content,
&create_beacon_info("Alice's Live location", 2300),
);
assert!(beacon_state.beacon_info_event_content.is_live());
assert_eq!(beacon_state.user_id.as_str(), "@alice:server.name");
}

#[async_test]
Expand All @@ -85,10 +74,10 @@ async fn multiple_people_sharing_location() {
let timeline = TestTimeline::new();

//Alice starts sharing her location
timeline.send_beacon_info(&ALICE, create_beacon_info("Alice's Live location", 2300)).await;
timeline.send_beacon_info(&ALICE, fakes::beacon_info_a()).await;

//Bob starts sharing his location
timeline.send_beacon_info(&BOB, create_beacon_info("Bob's Live location", 2300)).await;
timeline.send_beacon_info(&BOB, fakes::beacon_info_b()).await;

let alice_beacon_info_event_id =
timeline.event_items().await[0].clone().event_id().unwrap().to_owned();
Expand All @@ -99,54 +88,43 @@ async fn multiple_people_sharing_location() {
// Alice sends her location beacon
timeline.send_beacon(&ALICE, &alice_beacon_info_event_id, geo_uri.to_string()).await;
let alice_beacon_state = timeline.event_items().await[0].clone().beacon_state();
assert!(alice_beacon_state.last_location.is_some());
assert_beacon_info(
&alice_beacon_state.beacon_info_event_content,
&create_beacon_info("Alice's Live location", 2300),
);
assert_beacon(
alice_beacon_state.last_location.as_ref().unwrap(),
&LocationContent::new(geo_uri.to_string()),
);
assert!(alice_beacon_state.beacon_info_event_content.is_live());
assert_beacon_info(&alice_beacon_state.beacon_info_event_content, &fakes::beacon_info_a());
assert_beacon(alice_beacon_state.last_location.as_ref().unwrap(), &fakes::location_a());

//Bobs sends his location beacon
timeline.send_beacon(&BOB, &bob_beacon_info_event_id, geo_uri2.to_string()).await;
let bobs_beacon_state = timeline.event_items().await[1].clone().beacon_state();
assert!(bobs_beacon_state.last_location.is_some());
assert_beacon_info(
&bobs_beacon_state.beacon_info_event_content,
&create_beacon_info("Bob's Live location", 2300),
);
assert_beacon_info(&bobs_beacon_state.beacon_info_event_content, &fakes::beacon_info_b());
assert_beacon(
bobs_beacon_state.last_location.as_ref().unwrap(),
&LocationContent::new(geo_uri2.to_string()),
);
assert!(bobs_beacon_state.beacon_info_event_content.is_live());
}

#[async_test]
async fn beacon_info_is_stopped_by_user() {
let timeline = TestTimeline::new();

timeline.send_beacon_info(&ALICE, create_beacon_info("Alice's Live location", 2300)).await;
timeline.send_beacon_info(&ALICE, fakes::beacon_info_a()).await;
let beacon_info_id = timeline.beacon_info_event().await.event_id().unwrap().to_owned();

// Alice sends her location beacon
timeline.send_beacon(&ALICE, &beacon_info_id, "geo:51.5008,0.1247;u=35".to_string()).await;
let mut beacon_state = timeline.beacon_state().await;
let beacon_state = timeline.beacon_state().await;

// Alice stops sharing her location
beacon_state.beacon_info_event_content.stop();
// Alice sends a duplicate state event with live:false
// TODO: sending this beacon_info should update the state automatically in the
// handler
let new_beacon_state = beacon_state.update_beacon_info(&fakes::stopped_beacon_info());

assert!(!beacon_state.beacon_info_event_content.is_live());
assert_beacon_info(&new_beacon_state.beacon_info_event_content, &fakes::stopped_beacon_info());
}

#[async_test]
async fn beacon_info_is_stopped_by_timeout() {
let timeline = TestTimeline::new();

timeline.send_beacon_info(&ALICE, create_beacon_info("Alice's Live location", 0)).await;
timeline.send_beacon_info(&ALICE, fakes::create_beacon_info("Alice's Live location", 0)).await;
let beacon_info_id = timeline.beacon_info_event().await.event_id().unwrap().to_owned();

// Alice sends her location beacon
Expand Down Expand Up @@ -176,39 +154,21 @@ async fn events_received_before_start_are_not_lost() {
timeline.send_beacon(&BOB, &bob_beacon_info_id, "geo:51.5008,0.1248;u=35".to_string()).await;

// Alice starts her live location share
timeline
.send_beacon_info_with_id(
&ALICE,
&alice_beacon_info_id,
create_beacon_info("Alice's Live location", 2300),
)
.await;
timeline.send_beacon_info_with_id(&ALICE, &alice_beacon_info_id, fakes::beacon_info_a()).await;

// Bob starts his live location share
timeline
.send_beacon_info_with_id(
&BOB,
&bob_beacon_info_id,
create_beacon_info("Bob's Live location", 2300),
)
.await;
timeline.send_beacon_info_with_id(&BOB, &bob_beacon_info_id, fakes::beacon_info_b()).await;

let alice_beacon_state = timeline.event_items().await[0].clone().beacon_state();
let bob_beacon_state = timeline.event_items().await[1].clone().beacon_state();

assert_beacon_info(
&alice_beacon_state.beacon_info_event_content,
&create_beacon_info("Alice's Live location", 2300),
);
assert_beacon_info(&alice_beacon_state.beacon_info_event_content, &fakes::beacon_info_a());
assert_beacon(
&alice_beacon_state.last_location.unwrap(),
&LocationContent::new("geo:51.5008,0.1249;u=12".to_string()),
);

assert_beacon_info(
&bob_beacon_state.beacon_info_event_content,
&create_beacon_info("Bob's Live location", 2300),
);
assert_beacon_info(&bob_beacon_state.beacon_info_event_content, &fakes::beacon_info_b());
assert_beacon(
&bob_beacon_state.last_location.unwrap(),
&LocationContent::new("geo:51.5008,0.1248;u=35".to_string()),
Expand All @@ -220,27 +180,26 @@ fn assert_beacon_info(a: &BeaconInfoEventContent, b: &BeaconInfoEventContent) {
assert_eq!(a.live, b.live);
assert_eq!(a.timeout, b.timeout);
assert_eq!(a.asset, b.asset);
assert_eq!(a.is_live(), b.is_live())
}

fn assert_beacon(a: &LocationContent, b: &LocationContent) {
assert_eq!(a.uri, b.uri);
assert_eq!(a.description, b.description);
}

impl TestTimeline {
async fn send_beacon_info(&self, user: &UserId, content: BeaconInfoEventContent) {
// Send a beacon info state event to the room

let event =
self.event_builder.make_sync_state_event(user, "@example:localhost", content, None);
let event = self.event_builder.make_sync_state_event(user, user.as_str(), content, None);
self.handle_live_event(event).await;
}

async fn send_beacon(&self, user: &UserId, event_id: &EventId, geo_uri: String) {
let owner = OwnedEventId::from(event_id);

let beacon = BeaconEventContent::new(owner.clone(), geo_uri, None);

let event_content = AnyMessageLikeEventContent::Beacon(beacon.clone());
async fn send_beacon(&self, user: &UserId, event_id: &OwnedEventId, geo_uri: String) {
let event_content = AnyMessageLikeEventContent::Beacon(BeaconEventContent::new(
event_id.clone(),
geo_uri,
None,
));

self.handle_live_message_event(user, event_content).await;
}
Expand Down Expand Up @@ -281,7 +240,28 @@ impl EventTimelineItem {
mod fakes {
use std::time::Duration;

use ruma::events::beacon_info::BeaconInfoEventContent;
use ruma::events::{beacon_info::BeaconInfoEventContent, location::LocationContent};

pub fn location_a() -> LocationContent {
LocationContent::new("geo:51.5008,0.1247;u=35".to_string())
}

pub fn beacon_info_a() -> BeaconInfoEventContent {
create_beacon_info("Alice's Live Location", 2300)
}

pub fn beacon_info_b() -> BeaconInfoEventContent {
create_beacon_info("Bob's Live Location", 2300)
}

pub fn stopped_beacon_info() -> BeaconInfoEventContent {
BeaconInfoEventContent::new(
Option::from("Alice's Live Location".to_string()),
Duration::from_millis(2400),
false,
None,
)
}

pub fn create_beacon_info(desc: &str, duration: u64) -> BeaconInfoEventContent {
BeaconInfoEventContent::new(
Expand Down

0 comments on commit df93412

Please sign in to comment.