173b39a07f
* migrated a lot of unit tests to Swift Testing and added a new implementation for deferred fulfillment more tests migration Cleaned the code manually to establish some good patterns more code improvements some more code improvements removed empty tests update project * more pr suggestions and cleanups * removed the TestSetup pattern * fixing claude not reusing tests * pr suggestion + added indent rule to swiftformat so that we can prevent AIs to change that
191 lines
11 KiB
Swift
191 lines
11 KiB
Swift
//
|
|
// Copyright 2025 Element Creations Ltd.
|
|
// Copyright 2023-2025 New Vector Ltd.
|
|
//
|
|
// SPDX-License-Identifier: AGPL-3.0-only OR LicenseRef-Element-Commercial.
|
|
// Please see LICENSE files in the repository root for full details.
|
|
//
|
|
|
|
@testable import ElementX
|
|
import MatrixRustSDK
|
|
import Testing
|
|
|
|
@Suite
|
|
struct RoomStateEventStringBuilderTests {
|
|
private let userID: String
|
|
private let stringBuilder: RoomStateEventStringBuilder
|
|
|
|
init() {
|
|
userID = "@alice:matrix.org"
|
|
stringBuilder = RoomStateEventStringBuilder(userID: userID)
|
|
}
|
|
|
|
// MARK: - User Profiles
|
|
|
|
@Test
|
|
func displayNameChanges() {
|
|
// Changes by you.
|
|
validateDisplayNameChange(senderID: userID, oldName: "Alice", newName: "Bob",
|
|
expectedString: L10n.stateEventDisplayNameChangedFromByYou("Alice", "Bob"))
|
|
validateDisplayNameChange(senderID: userID, oldName: "Alice", newName: nil,
|
|
expectedString: L10n.stateEventDisplayNameRemovedByYou("Alice"))
|
|
validateDisplayNameChange(senderID: userID, oldName: nil, newName: "Alice",
|
|
expectedString: L10n.stateEventDisplayNameSetByYou("Alice"))
|
|
|
|
// Changes by someone else.
|
|
let senderID = "@bob:matrix.org"
|
|
validateDisplayNameChange(senderID: senderID, oldName: "Bob", newName: "Alice",
|
|
expectedString: L10n.stateEventDisplayNameChangedFrom(senderID, "Bob", "Alice"))
|
|
validateDisplayNameChange(senderID: senderID, oldName: "Bob", newName: nil,
|
|
expectedString: L10n.stateEventDisplayNameRemoved(senderID, "Bob"))
|
|
validateDisplayNameChange(senderID: senderID, oldName: nil, newName: "Bob",
|
|
expectedString: L10n.stateEventDisplayNameSet(senderID, "Bob"))
|
|
}
|
|
|
|
private func validateDisplayNameChange(senderID: String, oldName: String?, newName: String?, expectedString: String) {
|
|
let sender = TimelineItemSender(id: senderID, displayName: newName)
|
|
let string = stringBuilder.buildProfileChangeString(displayName: newName,
|
|
previousDisplayName: oldName,
|
|
avatarURLString: nil,
|
|
previousAvatarURLString: nil,
|
|
member: sender.id,
|
|
memberIsYou: sender.id == userID)
|
|
#expect(string == expectedString)
|
|
}
|
|
|
|
@Test
|
|
func avatarChanges() {
|
|
// Changes by you.
|
|
validateAvatarChange(senderID: userID, oldAvatarURL: "mxc://1", newAvatarURL: "mxc://2",
|
|
expectedString: L10n.stateEventAvatarUrlChangedByYou)
|
|
validateAvatarChange(senderID: userID, oldAvatarURL: "mxc://1", newAvatarURL: nil,
|
|
expectedString: L10n.stateEventAvatarUrlChangedByYou)
|
|
validateAvatarChange(senderID: userID, oldAvatarURL: nil, newAvatarURL: "mxc://1",
|
|
expectedString: L10n.stateEventAvatarUrlChangedByYou)
|
|
|
|
// Changes by someone else.
|
|
let senderID = "@bob:matrix.org"
|
|
let senderName = "Bob"
|
|
validateAvatarChange(senderID: senderID, senderName: senderName, oldAvatarURL: "mxc://1", newAvatarURL: "mxc://2",
|
|
expectedString: L10n.stateEventAvatarUrlChanged(senderName))
|
|
validateAvatarChange(senderID: senderID, senderName: senderName, oldAvatarURL: "mxc://1", newAvatarURL: nil,
|
|
expectedString: L10n.stateEventAvatarUrlChanged(senderName))
|
|
validateAvatarChange(senderID: senderID, senderName: senderName, oldAvatarURL: nil, newAvatarURL: "mxc://1",
|
|
expectedString: L10n.stateEventAvatarUrlChanged(senderName))
|
|
}
|
|
|
|
private func validateAvatarChange(senderID: String, senderName: String? = nil,
|
|
oldAvatarURL: String?, newAvatarURL: String?,
|
|
expectedString: String) {
|
|
let sender = TimelineItemSender(id: senderID, displayName: senderName)
|
|
let string = stringBuilder.buildProfileChangeString(displayName: senderName,
|
|
previousDisplayName: senderName,
|
|
avatarURLString: newAvatarURL,
|
|
previousAvatarURLString: oldAvatarURL,
|
|
member: sender.id,
|
|
memberIsYou: sender.id == userID)
|
|
#expect(string == expectedString)
|
|
}
|
|
|
|
// MARK: - Room Info
|
|
|
|
@Test
|
|
func topicChanges() {
|
|
let you = TimelineItemSender(id: userID, displayName: "Alice")
|
|
let other = TimelineItemSender(id: "@bob:matrix.org", displayName: "Bob")
|
|
|
|
let newTopic = "New topic"
|
|
var string = stringBuilder.buildString(for: .roomTopic(topic: newTopic), sender: you, isOutgoing: true)
|
|
#expect(string == L10n.stateEventRoomTopicChangedByYou(newTopic))
|
|
string = stringBuilder.buildString(for: .roomTopic(topic: newTopic), sender: other, isOutgoing: false)
|
|
#expect(string == L10n.stateEventRoomTopicChanged(other.displayName ?? "", newTopic))
|
|
|
|
let emptyTopic = ""
|
|
string = stringBuilder.buildString(for: .roomTopic(topic: emptyTopic), sender: you, isOutgoing: true)
|
|
#expect(string == L10n.stateEventRoomTopicRemovedByYou)
|
|
string = stringBuilder.buildString(for: .roomTopic(topic: emptyTopic), sender: other, isOutgoing: false)
|
|
#expect(string == L10n.stateEventRoomTopicRemoved(other.displayName ?? ""))
|
|
|
|
string = stringBuilder.buildString(for: .roomTopic(topic: nil), sender: you, isOutgoing: true)
|
|
#expect(string == L10n.stateEventRoomTopicRemovedByYou)
|
|
string = stringBuilder.buildString(for: .roomTopic(topic: nil), sender: other, isOutgoing: false)
|
|
#expect(string == L10n.stateEventRoomTopicRemoved(other.displayName ?? ""))
|
|
}
|
|
|
|
// MARK: - Room Membership
|
|
|
|
@Test
|
|
func kickMember() {
|
|
let you = TimelineItemSender(id: userID, displayName: "Alice")
|
|
let other = TimelineItemSender(id: "@bob:matrix.org", displayName: "Bob")
|
|
let banned = TimelineItemSender(id: "@spam:matrix.org", displayName: "I like spam")
|
|
|
|
let reason = "Spam"
|
|
var string = stringBuilder.buildString(for: .kicked,
|
|
reason: reason,
|
|
memberUserID: banned.id,
|
|
memberDisplayName: banned.displayName,
|
|
sender: you,
|
|
isOutgoing: true)
|
|
#expect(string == L10n.stateEventRoomRemoveByYouWithReason(banned.displayName ?? banned.id, reason))
|
|
string = stringBuilder.buildString(for: .kicked,
|
|
reason: nil,
|
|
memberUserID: banned.id,
|
|
memberDisplayName: banned.displayName,
|
|
sender: you,
|
|
isOutgoing: true)
|
|
#expect(string == L10n.stateEventRoomRemoveByYou(banned.displayName ?? banned.id))
|
|
string = stringBuilder.buildString(for: .kicked,
|
|
reason: reason,
|
|
memberUserID: banned.id,
|
|
memberDisplayName: banned.displayName,
|
|
sender: other,
|
|
isOutgoing: false)
|
|
#expect(string == L10n.stateEventRoomRemoveWithReason(other.displayName ?? other.id, banned.displayName ?? banned.id, reason))
|
|
string = stringBuilder.buildString(for: .kicked,
|
|
reason: nil,
|
|
memberUserID: banned.id,
|
|
memberDisplayName: banned.displayName,
|
|
sender: other,
|
|
isOutgoing: false)
|
|
#expect(string == L10n.stateEventRoomRemove(other.displayName ?? other.id, banned.displayName ?? banned.id))
|
|
}
|
|
|
|
@Test
|
|
func banMember() {
|
|
let you = TimelineItemSender(id: userID, displayName: "Alice")
|
|
let other = TimelineItemSender(id: "@bob:matrix.org", displayName: "Bob")
|
|
let banned = TimelineItemSender(id: "@spam:matrix.org", displayName: "I like spam")
|
|
|
|
let reason = "Spam"
|
|
var string = stringBuilder.buildString(for: .banned,
|
|
reason: reason,
|
|
memberUserID: banned.id,
|
|
memberDisplayName: banned.displayName,
|
|
sender: you,
|
|
isOutgoing: true)
|
|
#expect(string == L10n.stateEventRoomBanByYouWithReason(banned.displayName ?? banned.id, reason))
|
|
string = stringBuilder.buildString(for: .banned,
|
|
reason: nil,
|
|
memberUserID: banned.id,
|
|
memberDisplayName: banned.displayName,
|
|
sender: you,
|
|
isOutgoing: true)
|
|
#expect(string == L10n.stateEventRoomBanByYou(banned.displayName ?? banned.id))
|
|
string = stringBuilder.buildString(for: .banned,
|
|
reason: reason,
|
|
memberUserID: banned.id,
|
|
memberDisplayName: banned.displayName,
|
|
sender: other,
|
|
isOutgoing: false)
|
|
#expect(string == L10n.stateEventRoomBanWithReason(other.displayName ?? other.id, banned.displayName ?? banned.id, reason))
|
|
string = stringBuilder.buildString(for: .banned,
|
|
reason: nil,
|
|
memberUserID: banned.id,
|
|
memberDisplayName: banned.displayName,
|
|
sender: other,
|
|
isOutgoing: false)
|
|
#expect(string == L10n.stateEventRoomBan(other.displayName ?? other.id, banned.displayName ?? banned.id))
|
|
}
|
|
}
|