Dactyloidae iOS initial commit

mobile/ios/SharedTests/RollingFileLoggerTests.swift

@@ -0,0 +1,119 @@
+/* This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
+
+import Foundation
+import XCTest
+import XCGLogger
+@testable import Shared
+
+class RollingFileLoggerTests: XCTestCase {
+    var logger: RollingFileLogger!
+    var logDir: String = ""
+    var sizeLimit: Int = 5000
+
+    fileprivate lazy var formatter: DateFormatter = {
+        let formatter = DateFormatter()
+        formatter.dateFormat = "yyyyMMdd'T'HHmmssZ"
+        return formatter
+    }()
+
+    override func setUp() {
+        super.setUp()
+        logDir = (NSSearchPathForDirectoriesInDomains(.cachesDirectory, .userDomainMask, true).first!) + "/Logs"
+        do {
+            try FileManager.default.createDirectory(atPath: logDir, withIntermediateDirectories: false, attributes: nil)
+        } catch _ {
+        }
+        logger = RollingFileLogger(filenameRoot: "test", logDirectoryPath: logDir, sizeLimit: Int64(sizeLimit))
+    }
+
+    func testNewLogCreatesLogFileWithTimestamp() {
+        let date = Date()
+        let expected = "test.\(formatter.string(from: date)).log"
+        let expectedPath = "\(logDir)/\(expected)"
+        logger.newLogWithDate(date)
+        XCTAssertTrue(FileManager.default.fileExists(atPath: expectedPath), "Log file should exist")
+
+        let testMessage = "Logging some text"
+        logger.info(testMessage)
+        let logData = try? Data(contentsOf: URL(fileURLWithPath: expectedPath))
+        XCTAssertNotNil(logData, "Log data should not be nil")
+        let logString = NSString(data: logData!, encoding: String.Encoding.utf8.rawValue)
+        XCTAssertTrue(logString!.contains(testMessage), "Log should contain our test message that we wrote")
+    }
+
+    func testNewLogDeletesPreviousLogIfItsTooLarge() {
+        let manager = FileManager.default
+        let dirURL = URL(fileURLWithPath: logDir)
+        let prefix = "test"
+        let expectedPath = createNewLogFileWithSize(sizeLimit + 1)
+
+        let directorySize = try! manager.getAllocatedSizeOfDirectoryAtURL(dirURL, forFilesPrefixedWith: prefix)
+
+        // Pre-condition: Folder needs to be larger than the size limit
+        XCTAssertGreaterThan(directorySize, Int64(sizeLimit), "Log folder should be larger than size limit")
+
+        let exceedsSmaller = try! manager.allocatedSizeOfDirectoryAtURL(dirURL, forFilesPrefixedWith: prefix, isLargerThanBytes: directorySize - 1)
+        let doesNotExceedLarger = try! manager.allocatedSizeOfDirectoryAtURL(dirURL, forFilesPrefixedWith: prefix, isLargerThanBytes: Int64(sizeLimit + 2))
+        XCTAssertTrue(exceedsSmaller)
+        XCTAssertTrue(doesNotExceedLarger)
+
+        let newDate = Date().addingTimeInterval(60*60) // Create a log file using a date an hour ahead
+        let newExpected = "\(prefix).\(formatter.string(from: newDate)).log"
+        let newExpectedPath = "\(logDir)/\(newExpected)"
+        logger.newLogWithDate(newDate)
+
+        XCTAssertTrue(manager.fileExists(atPath: newExpectedPath), "New log file should exist")
+        XCTAssertTrue(manager.fileExists(atPath: expectedPath), "Old log file exists until pruned")
+        logger.deleteOldLogsDownToSizeLimit()
+        XCTAssertFalse(manager.fileExists(atPath: expectedPath), "Old log file should NOT exist")
+    }
+
+    func testNewLogDeletesOldestLogFileToMakeRoomForNewFile() {
+        let manager = FileManager.default
+        let dirURL = URL(fileURLWithPath: logDir)
+        let prefix = "test"
+
+        // Create 5 log files with spread out over 5 hours and reorder paths so oldest is first
+        let logFilePaths = [0, 1, 2, 3, 4].map { self.createNewLogFileWithSize(200, withDate: Date().addingTimeInterval(60 * 60 * $0)) }
+            .sorted { $0 < $1 }
+
+        let directorySize = try! manager.getAllocatedSizeOfDirectoryAtURL(dirURL, forFilesPrefixedWith: prefix)
+
+        // Pre-condition: Folder needs to be larger than the size limit
+        XCTAssertGreaterThan(directorySize, Int64(sizeLimit), "Log folder should be larger than size limit")
+
+        let newDate = Date().addingTimeInterval(60*60*5) // Create a log file using a date an hour ahead
+        let newExpected = "\(prefix).\(formatter.string(from: newDate)).log"
+        let newExpectedPath = "\(logDir)/\(newExpected)"
+        logger.newLogWithDate(newDate)
+
+        XCTAssertTrue(manager.fileExists(atPath: newExpectedPath), "New log file should exist")
+        XCTAssertTrue(manager.fileExists(atPath: logFilePaths.first!), "Old log file exists until pruned")
+        logger.deleteOldLogsDownToSizeLimit()
+        XCTAssertFalse(manager.fileExists(atPath: logFilePaths.first!), "Oldest log file should NOT exist")
+    }
+
+    /**
+    Create a log file using the test logger and returns the path to that log file
+
+    - parameter size: Size to make the log file
+
+    - returns: Path to log file
+    */
+    fileprivate func createNewLogFileWithSize(_ size: Int, withDate date: Date = Date()) -> String {
+        let expected = "test.\(formatter.string(from: date)).log"
+        let expectedPath = "\(logDir)/\(expected)"
+        logger.newLogWithDate(date)
+        XCTAssertTrue(FileManager.default.fileExists(atPath: expectedPath), "Log file should exist")
+
+        let logFileHandle = FileHandle(forWritingAtPath: expectedPath)
+        XCTAssertNotNil(logFileHandle, "File should exist")
+        let garbageBytes = malloc(size)
+        let blankData = Data(bytes: garbageBytes!, count: size)
+        logFileHandle!.write(blankData)
+        logFileHandle!.closeFile()
+        return expectedPath
+    }
+}