matrix_sdk_base/
test_utils.rs

1// Copyright 2024 The Matrix.org Foundation C.I.C.
2//
3// Licensed under the Apache License, Version 2.0 (the "License");
4// you may not use this file except in compliance with the License.
5// You may obtain a copy of the License at
6//
7//     http://www.apache.org/licenses/LICENSE-2.0
8//
9// Unless required by applicable law or agreed to in writing, software
10// distributed under the License is distributed on an "AS IS" BASIS,
11// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12// See the License for the specific language governing permissions and
13// limitations under the License.
14
15//! Testing utilities - DO NOT USE IN PRODUCTION.
16
17#![allow(dead_code)]
18
19use ruma::{UserId, owned_user_id};
20
21use crate::{
22    BaseClient, SessionMeta,
23    client::ThreadingSupport,
24    store::{RoomLoadSettings, StoreConfig},
25};
26
27/// Create a [`BaseClient`] with the given user id, if provided, or an hardcoded
28/// one otherwise.
29pub(crate) async fn logged_in_base_client(user_id: Option<&UserId>) -> BaseClient {
30    let client = BaseClient::new(
31        StoreConfig::new("cross-process-store-locks-holder-name".to_owned()),
32        ThreadingSupport::Disabled,
33    );
34    let user_id =
35        user_id.map(|user_id| user_id.to_owned()).unwrap_or_else(|| owned_user_id!("@u:e.uk"));
36    client
37        .activate(
38            SessionMeta { user_id: user_id.to_owned(), device_id: "FOOBAR".into() },
39            RoomLoadSettings::default(),
40            #[cfg(feature = "e2e-encryption")]
41            None,
42        )
43        .await
44        .expect("`activate` failed!");
45    client
46}