4b278a9fd1
* Use `.info` logging in most places. * Remove old objc logging support. * Fix table view controller. * Make sure timeline item content isn't logged. * Add tests.
337 lines
15 KiB
Swift
337 lines
15 KiB
Swift
//
|
|
// Copyright 2022 New Vector Ltd
|
|
//
|
|
// Licensed under the Apache License, Version 2.0 (the "License");
|
|
// you may not use this file except in compliance with the License.
|
|
// You may obtain a copy of the License at
|
|
//
|
|
// http://www.apache.org/licenses/LICENSE-2.0
|
|
//
|
|
// Unless required by applicable law or agreed to in writing, software
|
|
// distributed under the License is distributed on an "AS IS" BASIS,
|
|
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
// See the License for the specific language governing permissions and
|
|
// limitations under the License.
|
|
//
|
|
|
|
@testable import ElementX
|
|
@testable import MatrixRustSDK
|
|
import XCTest
|
|
|
|
class LoggingTests: XCTestCase {
|
|
private enum Constants {
|
|
static let genericFailure = "Test failed"
|
|
}
|
|
|
|
override func setUpWithError() throws {
|
|
MXLogger.deleteLogFiles()
|
|
}
|
|
|
|
override func tearDownWithError() throws {
|
|
// Put teardown code here. This method is called after the invocation of each test method in the class.
|
|
}
|
|
|
|
func testFileLogging() throws {
|
|
XCTAssertTrue(MXLogger.logFiles.isEmpty)
|
|
|
|
let log = UUID().uuidString
|
|
|
|
let configuration = MXLogConfiguration()
|
|
configuration.redirectLogsToFiles = true
|
|
MXLog.configure(configuration)
|
|
MXLog.info(log)
|
|
guard let logFile = MXLogger.logFiles.first else {
|
|
XCTFail(Constants.genericFailure)
|
|
return
|
|
}
|
|
|
|
let content = try String(contentsOf: logFile)
|
|
XCTAssert(content.contains(log))
|
|
}
|
|
|
|
func testFileRotationOnLaunch() throws {
|
|
// Given a fresh launch with no logs.
|
|
XCTAssertTrue(MXLogger.logFiles.isEmpty)
|
|
|
|
// When launching the app 5 times.
|
|
let launchCount = 5
|
|
for index in 0..<launchCount {
|
|
let configuration = MXLogConfiguration()
|
|
configuration.redirectLogsToFiles = true
|
|
MXLog.configure(configuration) // This call is only made at app launch.
|
|
MXLog.info("Launch \(index + 1)")
|
|
}
|
|
|
|
// Then 5 log files should be created each with the correct contents.
|
|
let logFiles = MXLogger.logFiles
|
|
|
|
XCTAssertEqual(logFiles.count, launchCount, "The number of log files should match the number of launches.")
|
|
try verifyContents(of: logFiles, after: launchCount)
|
|
}
|
|
|
|
func testMaxLogFileCount() throws {
|
|
// Given a fresh launch with no logs.
|
|
XCTAssertTrue(MXLogger.logFiles.isEmpty)
|
|
|
|
// When launching the app 10 times, with a maxLogCount of 5.
|
|
let launchCount = 10
|
|
let logFileCount = 5
|
|
for index in 0..<launchCount {
|
|
let configuration = MXLogConfiguration()
|
|
configuration.maxLogFilesCount = UInt(logFileCount)
|
|
configuration.redirectLogsToFiles = true
|
|
MXLog.configure(configuration) // This call is only made at app launch.
|
|
MXLog.info("Launch \(index + 1)")
|
|
}
|
|
|
|
// Then only 5 log files should be stored on disk, with the contents of launches 6 to 10.
|
|
let logFiles = MXLogger.logFiles
|
|
|
|
XCTAssertEqual(logFiles.count, logFileCount, "The number of log files should match the number of launches.")
|
|
try verifyContents(of: logFiles, after: launchCount)
|
|
}
|
|
|
|
func testLogFileSizeLimit() throws {
|
|
// Given a fresh launch with no logs.
|
|
XCTAssertTrue(MXLogger.logFiles.isEmpty)
|
|
|
|
// When launching the app 10 times, with a max total log size of 25KB and logging ~5KB data each time.
|
|
let launchCount = 10
|
|
let logFileSizeLimit = 25 * 1024
|
|
for index in 0..<launchCount {
|
|
let configuration = MXLogConfiguration()
|
|
configuration.logFilesSizeLimit = UInt(logFileSizeLimit)
|
|
configuration.redirectLogsToFiles = true
|
|
MXLog.configure(configuration) // This call is only made at app launch.
|
|
MXLog.info("Launch \(index + 1)")
|
|
|
|
// Add ~5KB of logs
|
|
for _ in 0..<5 {
|
|
let string = [String](repeating: "a", count: 1024).joined()
|
|
MXLog.info(string)
|
|
}
|
|
}
|
|
|
|
// Then only the most recent log files should be stored on disk.
|
|
let logFiles = MXLogger.logFiles
|
|
|
|
XCTAssertGreaterThan(logFiles.count, 0, "There should be at least one log file created.")
|
|
XCTAssertLessThan(logFiles.count, launchCount, "Some of the log files should have been removed trimmed.")
|
|
try verifyContents(of: logFiles, after: launchCount)
|
|
}
|
|
|
|
/// Verifies that the log files all contain the correct `Launch #` based on the index
|
|
/// in the file name and the number of launches of the app.
|
|
func verifyContents(of logFiles: [URL], after launchCount: Int) throws {
|
|
for logFile in logFiles {
|
|
let regex = /\d+/
|
|
let fileIndex = logFile.lastPathComponent.firstMatch(of: regex)?.0 ?? "0"
|
|
|
|
guard let index = Int(fileIndex) else {
|
|
XCTFail(Constants.genericFailure)
|
|
return
|
|
}
|
|
|
|
let content = try String(contentsOf: logFile)
|
|
XCTAssertTrue(content.contains("Launch \(launchCount - index)"), "The log files should be for the most recent launches in reverse chronological order.")
|
|
}
|
|
}
|
|
|
|
func testLogLevels() throws {
|
|
XCTAssert(MXLogger.logFiles.isEmpty)
|
|
|
|
let log = UUID().uuidString
|
|
|
|
let configuration = MXLogConfiguration()
|
|
configuration.logLevel = .error
|
|
configuration.redirectLogsToFiles = true
|
|
MXLog.configure(configuration)
|
|
MXLog.info(log)
|
|
guard let logFile = MXLogger.logFiles.first else {
|
|
XCTFail(Constants.genericFailure)
|
|
return
|
|
}
|
|
|
|
let content = try String(contentsOf: logFile)
|
|
XCTAssertFalse(content.contains(log))
|
|
}
|
|
|
|
func testSubLogName() {
|
|
XCTAssert(MXLogger.logFiles.isEmpty)
|
|
|
|
let subLogName = "nse"
|
|
|
|
let configuration = MXLogConfiguration()
|
|
configuration.subLogName = subLogName
|
|
configuration.redirectLogsToFiles = true
|
|
MXLog.configure(configuration)
|
|
MXLog.info(UUID().uuidString)
|
|
guard let logFile = MXLogger.logFiles.first else {
|
|
XCTFail(Constants.genericFailure)
|
|
return
|
|
}
|
|
|
|
XCTAssertTrue(logFile.lastPathComponent.contains(subLogName))
|
|
}
|
|
|
|
func testRoomSummaryContentIsRedacted() throws {
|
|
// Given a room summary that contains sensitive information
|
|
let roomName = "Private Conversation"
|
|
let lastMessage = "Secret information"
|
|
let roomSummary = RoomSummaryDetails(id: "myroomid",
|
|
name: roomName,
|
|
isDirect: true,
|
|
avatarURLString: nil,
|
|
lastMessage: AttributedString(lastMessage),
|
|
lastMessageTimestamp: .now,
|
|
unreadNotificationCount: 0)
|
|
|
|
// When logging that value
|
|
XCTAssert(MXLogger.logFiles.isEmpty)
|
|
let configuration = MXLogConfiguration()
|
|
configuration.logLevel = .info
|
|
configuration.redirectLogsToFiles = true
|
|
MXLog.configure(configuration)
|
|
MXLog.info(roomSummary)
|
|
|
|
// Then the log file should not include the sensitive information
|
|
guard let logFile = MXLogger.logFiles.first else {
|
|
XCTFail(Constants.genericFailure)
|
|
return
|
|
}
|
|
|
|
let content = try String(contentsOf: logFile)
|
|
XCTAssertTrue(content.contains(roomSummary.id))
|
|
XCTAssertFalse(content.contains(roomName))
|
|
XCTAssertFalse(content.contains(lastMessage))
|
|
}
|
|
|
|
// swiftlint:disable function_body_length
|
|
func testTimelineContentIsRedacted() throws {
|
|
// Given timeline items that contain text
|
|
let textAttributedString = "TextAttributed"
|
|
let textMessage = TextRoomTimelineItem(id: "mytextmessage", text: "TextString",
|
|
attributedComponents: [.init(attributedString: AttributedString(textAttributedString),
|
|
isBlockquote: false)],
|
|
timestamp: "", groupState: .single, isOutgoing: false, isEditable: false, senderId: "sender")
|
|
let noticeAttributedString = "NoticeAttributed"
|
|
let noticeMessage = NoticeRoomTimelineItem(id: "mynoticemessage", text: "NoticeString",
|
|
attributedComponents: [.init(attributedString: AttributedString(noticeAttributedString),
|
|
isBlockquote: false)],
|
|
timestamp: "", groupState: .single, isOutgoing: false, isEditable: false, senderId: "sender")
|
|
let emoteAttributedString = "EmoteAttributed"
|
|
let emoteMessage = EmoteRoomTimelineItem(id: "myemotemessage", text: "EmoteString",
|
|
attributedComponents: [.init(attributedString: AttributedString(emoteAttributedString),
|
|
isBlockquote: false)],
|
|
timestamp: "", groupState: .single, isOutgoing: false, isEditable: false, senderId: "sender")
|
|
let imageMessage = ImageRoomTimelineItem(id: "myimagemessage", text: "ImageString",
|
|
timestamp: "", groupState: .single, isOutgoing: false, isEditable: false,
|
|
senderId: "sender", source: nil)
|
|
let videoMessage = VideoRoomTimelineItem(id: "myvideomessage", text: "VideoString",
|
|
timestamp: "", groupState: .single, isOutgoing: false, isEditable: false,
|
|
senderId: "sender", duration: 0, source: nil, thumbnailSource: nil)
|
|
let fileMessage = FileRoomTimelineItem(id: "myfilemessage", text: "FileString",
|
|
timestamp: "", groupState: .single, isOutgoing: false, isEditable: false,
|
|
senderId: "sender", source: nil, thumbnailSource: nil)
|
|
|
|
// When logging that value
|
|
XCTAssert(MXLogger.logFiles.isEmpty)
|
|
let configuration = MXLogConfiguration()
|
|
configuration.logLevel = .info
|
|
configuration.redirectLogsToFiles = true
|
|
MXLog.configure(configuration)
|
|
MXLog.info(textMessage)
|
|
MXLog.info(noticeMessage)
|
|
MXLog.info(emoteMessage)
|
|
MXLog.info(imageMessage)
|
|
MXLog.info(videoMessage)
|
|
MXLog.info(fileMessage)
|
|
|
|
// Then the log file should not include the text content
|
|
guard let logFile = MXLogger.logFiles.first else {
|
|
XCTFail(Constants.genericFailure)
|
|
return
|
|
}
|
|
|
|
let content = try String(contentsOf: logFile)
|
|
XCTAssertTrue(content.contains(textMessage.id))
|
|
XCTAssertFalse(content.contains(textMessage.text))
|
|
XCTAssertFalse(content.contains(textAttributedString))
|
|
|
|
XCTAssertTrue(content.contains(noticeMessage.id))
|
|
XCTAssertFalse(content.contains(noticeMessage.text))
|
|
XCTAssertFalse(content.contains(noticeAttributedString))
|
|
|
|
XCTAssertTrue(content.contains(emoteMessage.id))
|
|
XCTAssertFalse(content.contains(emoteMessage.text))
|
|
XCTAssertFalse(content.contains(emoteAttributedString))
|
|
|
|
XCTAssertTrue(content.contains(imageMessage.id))
|
|
XCTAssertFalse(content.contains(imageMessage.text))
|
|
|
|
XCTAssertTrue(content.contains(videoMessage.id))
|
|
XCTAssertFalse(content.contains(videoMessage.text))
|
|
|
|
XCTAssertTrue(content.contains(fileMessage.id))
|
|
XCTAssertFalse(content.contains(fileMessage.text))
|
|
}
|
|
|
|
// swiftlint:enable function_body_length
|
|
|
|
func testRustMessageContentIsRedacted() throws {
|
|
// Given message content that contain text
|
|
let textString = "TextString"
|
|
let textMessage = TextMessageContent(body: "",
|
|
formatted: FormattedBody(format: .html, body: "<b>\(textString)</b>"))
|
|
let noticeString = "NoticeString"
|
|
let noticeMessage = NoticeMessageContent(body: noticeString,
|
|
formatted: FormattedBody(format: .html, body: "<b>\(noticeString)</b>"))
|
|
let emoteString = "EmoteString"
|
|
let emoteMessage = EmoteMessageContent(body: emoteString,
|
|
formatted: FormattedBody(format: .html, body: "<b>\(emoteString)</b>"))
|
|
|
|
let pointer = Unmanaged.passRetained(NSURL(fileURLWithPath: "/tmp/file")).toOpaque()
|
|
let imageMessage = ImageMessageContent(body: "ImageString", source: MediaSource(unsafeFromRawPointer: pointer), info: nil)
|
|
let videoMessage = VideoMessageContent(body: "VideoString", source: MediaSource(unsafeFromRawPointer: pointer), info: nil)
|
|
let fileMessage = FileMessageContent(body: "FileString", source: MediaSource(unsafeFromRawPointer: pointer), info: nil)
|
|
|
|
// When logging that value
|
|
XCTAssert(MXLogger.logFiles.isEmpty)
|
|
let configuration = MXLogConfiguration()
|
|
configuration.logLevel = .info
|
|
configuration.redirectLogsToFiles = true
|
|
MXLog.configure(configuration)
|
|
MXLog.info(textMessage)
|
|
MXLog.info(noticeMessage)
|
|
MXLog.info(emoteMessage)
|
|
MXLog.info(imageMessage)
|
|
MXLog.info(videoMessage)
|
|
MXLog.info(fileMessage)
|
|
|
|
// Then the log file should not include the text content
|
|
guard let logFile = MXLogger.logFiles.first else {
|
|
XCTFail(Constants.genericFailure)
|
|
return
|
|
}
|
|
|
|
let content = try String(contentsOf: logFile)
|
|
XCTAssertTrue(content.contains(String(describing: TextMessageContent.self)))
|
|
XCTAssertFalse(content.contains(textString))
|
|
|
|
XCTAssertTrue(content.contains(String(describing: NoticeMessageContent.self)))
|
|
XCTAssertFalse(content.contains(noticeString))
|
|
|
|
XCTAssertTrue(content.contains(String(describing: EmoteMessageContent.self)))
|
|
XCTAssertFalse(content.contains(emoteString))
|
|
|
|
XCTAssertTrue(content.contains(String(describing: ImageMessageContent.self)))
|
|
XCTAssertFalse(content.contains(imageMessage.body))
|
|
|
|
XCTAssertTrue(content.contains(String(describing: VideoMessageContent.self)))
|
|
XCTAssertFalse(content.contains(videoMessage.body))
|
|
|
|
XCTAssertTrue(content.contains(String(describing: FileMessageContent.self)))
|
|
XCTAssertFalse(content.contains(fileMessage.body))
|
|
}
|
|
}
|