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 matrix_sdk_common::cross_process_lock::CrossProcessLockConfig;
20use ruma::{UserId, owned_user_id};
21
22use crate::{
23 BaseClient, DmRoomDefinition, SessionMeta,
24 client::ThreadingSupport,
25 store::{RoomLoadSettings, StoreConfig},
26};
27
28/// Create a [`BaseClient`] with the given user id, if provided, or an hardcoded
29/// one otherwise.
30pub(crate) async fn logged_in_base_client(user_id: Option<&UserId>) -> BaseClient {
31 let client = BaseClient::new(
32 StoreConfig::new(CrossProcessLockConfig::multi_process(
33 "cross-process-store-locks-holder-name",
34 )),
35 ThreadingSupport::Disabled,
36 DmRoomDefinition::default(),
37 );
38 let user_id =
39 user_id.map(|user_id| user_id.to_owned()).unwrap_or_else(|| owned_user_id!("@u:e.uk"));
40 client
41 .activate(
42 SessionMeta { user_id: user_id.to_owned(), device_id: "FOOBAR".into() },
43 RoomLoadSettings::default(),
44 #[cfg(feature = "e2e-encryption")]
45 None,
46 )
47 .await
48 .expect("`activate` failed!");
49 client
50}