1
1
mirror of https://github.com/kean/Nuke.git synced 2024-11-28 12:04:01 +03:00

Update ImageCacheTests

This commit is contained in:
kean 2024-11-17 13:39:19 -05:00
parent 52771a052b
commit 4e0bca9161

View File

@ -2,422 +2,397 @@
//
// Copyright (c) 2015-2024 Alexander Grebenyuk (github.com/kean).
import XCTest
import Foundation
import Testing
@testable import Nuke
#if canImport(UIKit)
import UIKit
#endif
@Suite struct ImageCacheTests {
let cache = ImageCache()
init() {
cache.entryCostLimit = 2
}
// MARK: - Basics
@Test func cacheCreation() {
#expect(cache.totalCount == 0)
#expect(cache[Test.request] == nil)
}
@Test func imageIsStored() {
// When
cache[Test.request] = Test.container
// Then
#expect(cache.totalCount == 1)
#expect(cache[Test.request] != nil)
}
// MARK: - Subscript
@Test func imageIsStoredUsingSubscript() {
// When
cache[Test.request] = Test.container
// Then
#expect(cache[Test.request] != nil)
}
// MARK: - Count
@Test func totalCountChanges() {
#expect(cache.totalCount == 0)
cache[request1] = Test.container
#expect(cache.totalCount == 1)
cache[request2] = Test.container
#expect(cache.totalCount == 2)
cache[request2] = nil
#expect(cache.totalCount == 1)
cache[request1] = nil
#expect(cache.totalCount == 0)
}
@Test func countLimitChanges() {
// When
cache.countLimit = 1
// Then
#expect(cache.countLimit == 1)
}
@Test func ttlChanges() {
// when
cache.ttl = 1
// Then
#expect(cache.ttl == 1)
}
@Test func itemsAreRemoveImmediatelyWhenCountLimitIsReached() {
// Given
cache.countLimit = 1
// When
cache[request1] = Test.container
cache[request2] = Test.container
// Then
#expect(cache[request1] == nil)
#expect(cache[request2] != nil)
}
@Test func trimToCount() {
// Given
cache[request1] = Test.container
cache[request2] = Test.container
// When
cache.trim(toCount: 1)
// Then
#expect(cache[request1] == nil)
#expect(cache[request2] != nil)
}
@Test func imagesAreRemovedOnCountLimitChange() {
// Given
cache.countLimit = 2
cache[request1] = Test.container
cache[request2] = Test.container
// When
cache.countLimit = 1
// Then
#expect(cache[request1] == nil)
#expect(cache[request2] != nil)
}
// MARK: Cost
#if canImport(UIKit)
@Test func defaultImageCost() {
#expect(cache.cost(for: ImageContainer(image: Test.image)) == 1228800)
}
@Test func totalCostChanges() {
let imageCost = cache.cost(for: ImageContainer(image: Test.image))
#expect(cache.totalCost == 0)
cache[request1] = Test.container
#expect(cache.totalCost == imageCost)
cache[request2] = Test.container
#expect(cache.totalCost == 2 * imageCost)
cache[request2] = nil
#expect(cache.totalCost == imageCost)
cache[request1] = nil
#expect(cache.totalCost == 0)
}
@Test func costLimitChanged() {
// Given
let cost = cache.cost(for: ImageContainer(image: Test.image))
// When
cache.costLimit = Int(Double(cost) * 1.5)
// Then
#expect(cache.costLimit == Int(Double(cost) * 1.5))
}
@Test func itemsAreRemoveImmediatelyWhenCostLimitIsReached() {
// Given
let cost = cache.cost(for: ImageContainer(image: Test.image))
cache.costLimit = Int(Double(cost) * 1.5)
// When/Then
cache[request1] = Test.container
// LRU item is released
cache[request2] = Test.container
#expect(cache[request1] == nil)
#expect(cache[request2] != nil)
}
@Test func entryCostLimitEntryStored() {
// Given
let container = ImageContainer(image: Test.image)
let cost = cache.cost(for: container)
cache.costLimit = Int(Double(cost) * 15)
cache.entryCostLimit = 0.1
// When
cache[Test.request] = container
// Then
#expect(cache[Test.request] != nil)
#expect(cache.totalCount == 1)
}
@Test func entryCostLimitEntryNotStored() {
// Given
let container = ImageContainer(image: Test.image)
let cost = cache.cost(for: container)
cache.costLimit = Int(Double(cost) * 3)
cache.entryCostLimit = 0.1
// When
cache[Test.request] = container
// Then
#expect(cache[Test.request] == nil)
#expect(cache.totalCount == 0)
}
@Test func trimToCost() {
// Given
cache.costLimit = Int.max
cache[request1] = Test.container
cache[request2] = Test.container
// When
let cost = cache.cost(for: ImageContainer(image: Test.image))
cache.trim(toCost: Int(Double(cost) * 1.5))
// Then
#expect(cache[request1] == nil)
#expect(cache[request2] != nil)
}
@Test func imagesAreRemovedOnCostLimitChange() {
// Given
let cost = cache.cost(for: ImageContainer(image: Test.image))
cache.costLimit = Int(Double(cost) * 2.5)
cache[request1] = Test.container
cache[request2] = Test.container
// When
cache.costLimit = cost
// Then
#expect(cache[request1] == nil)
#expect(cache[request2] != nil)
}
@Test func imageContainerWithoutAssociatedDataCost() {
// Given
let data = Test.data(name: "cat", extension: "gif")
let image = PlatformImage(data: data)!
let container = ImageContainer(image: image, data: nil)
// Then
#expect(cache.cost(for: container) == 558000)
}
@Test func imageContainerWithAssociatedDataCost() {
// Given
let data = Test.data(name: "cat", extension: "gif")
let image = PlatformImage(data: data)!
let container = ImageContainer(image: image, data: data)
// Then
#expect(cache.cost(for: container) == 558000 + 427672)
}
#endif
// MARK: LRU
@Test func leastRecentItemsAreRemoved() {
// Given
let cost = cache.cost(for: ImageContainer(image: Test.image))
cache.costLimit = Int(Double(cost) * 2.5)
cache[request1] = Test.container
cache[request2] = Test.container
cache[request3] = Test.container
// Then
#expect(cache[request1] == nil)
#expect(cache[request2] != nil)
#expect(cache[request3] != nil)
}
@Test func itemsAreTouched() {
// Given
let cost = cache.cost(for: ImageContainer(image: Test.image))
cache.costLimit = Int(Double(cost) * 2.5)
cache[request1] = Test.container
cache[request2] = Test.container
_ = cache[request1] // Touched image
// When
cache[request3] = Test.container
// Then
#expect(cache[request1] != nil)
#expect(cache[request2] == nil)
#expect(cache[request3] != nil)
}
// MARK: Misc
@Test func removeAll() {
// GIVEN
cache[request1] = Test.container
cache[request2] = Test.container
// WHEN
cache.removeAll()
// THEN
#expect(cache.totalCount == 0)
#expect(cache.totalCost == 0)
}
#if canImport(UIKit)
@Test @MainActor func someImagesAreRemovedOnDidEnterBackground() async {
// GIVEN
cache.costLimit = Int.max
cache.countLimit = 10 // 1 out of 10 images should remain
for i in 0..<10 {
cache[_request(index: i)] = Test.container
}
#expect(cache.totalCount == 10)
// WHEN
let task = Task { @MainActor in
NotificationCenter.default.post(name: UIApplication.didEnterBackgroundNotification, object: nil)
// THEN
#expect(cache.totalCount == 1)
}
await task.value
}
@Test @MainActor func someImagesAreRemovedBasedOnCostOnDidEnterBackground() async {
// GIVEN
let cost = cache.cost(for: ImageContainer(image: Test.image))
cache.costLimit = cost * 10
cache.countLimit = Int.max
for index in 0..<10 {
let request = ImageRequest(url: URL(string: "http://example.com/img\(index)")!)
cache[request] = Test.container
}
#expect(cache.totalCount == 10)
// WHEN
let task = Task { @MainActor in
NotificationCenter.default.post(name: UIApplication.didEnterBackgroundNotification, object: nil)
// THEN
#expect(cache.totalCount == 1)
}
await task.value
}
#endif
}
@Suite struct InternalCacheTTLTests {
let cache = Cache<Int, Int>(costLimit: 1000, countLimit: 1000)
// MARK: TTL
@Test func ttl() {
// Given
cache.set(1, forKey: 1, cost: 1, ttl: 0.05) // 50 ms
#expect(cache.value(forKey: 1) != nil)
// When
usleep(55 * 1000)
// Then
#expect(cache.value(forKey: 1) == nil)
}
@Test func defaultTTLIsUsed() {
// Given
cache.conf.ttl = 0.05// 50 ms
cache.set(1, forKey: 1, cost: 1)
#expect(cache.value(forKey: 1) != nil)
// When
usleep(55 * 1000)
// Then
#expect(cache.value(forKey: 1) == nil)
}
@Test func defaultToNonExpiringEntries() {
// Given
cache.set(1, forKey: 1, cost: 1)
#expect(cache.value(forKey: 1) != nil)
// When
usleep(55 * 1000)
// Then
#expect(cache.value(forKey: 1) != nil)
}
}
private func _request(index: Int) -> ImageRequest {
return ImageRequest(url: URL(string: "http://example.com/img\(index)")!)
}
private let request1 = _request(index: 1)
private let request2 = _request(index: 2)
private let request3 = _request(index: 3)
class ImageCacheTests: XCTestCase, @unchecked Sendable {
var cache: ImageCache!
override func setUp() {
super.setUp()
cache = ImageCache()
cache.entryCostLimit = 2
}
// MARK: - Basics
@MainActor
func testCacheCreation() {
XCTAssertEqual(cache.totalCount, 0)
XCTAssertNil(cache[Test.request])
}
@MainActor
func testThatImageIsStored() {
// When
cache[Test.request] = Test.container
// Then
XCTAssertEqual(cache.totalCount, 1)
XCTAssertNotNil(cache[Test.request])
}
// MARK: - Subscript
@MainActor
func testThatImageIsStoredUsingSubscript() {
// When
cache[Test.request] = Test.container
// Then
XCTAssertNotNil(cache[Test.request])
}
// MARK: - Count
@MainActor
func testThatTotalCountChanges() {
XCTAssertEqual(cache.totalCount, 0)
cache[request1] = Test.container
XCTAssertEqual(cache.totalCount, 1)
cache[request2] = Test.container
XCTAssertEqual(cache.totalCount, 2)
cache[request2] = nil
XCTAssertEqual(cache.totalCount, 1)
cache[request1] = nil
XCTAssertEqual(cache.totalCount, 0)
}
@MainActor
func testThatCountLimitChanges() {
// When
cache.countLimit = 1
// Then
XCTAssertEqual(cache.countLimit, 1)
}
@MainActor
func testThatTTLChanges() {
//when
cache.ttl = 1
// Then
XCTAssertEqual(cache.ttl, 1)
}
@MainActor
func testThatItemsAreRemoveImmediatelyWhenCountLimitIsReached() {
// Given
cache.countLimit = 1
// When
cache[request1] = Test.container
cache[request2] = Test.container
// Then
XCTAssertNil(cache[request1])
XCTAssertNotNil(cache[request2])
}
@MainActor
func testTrimToCount() {
// Given
cache[request1] = Test.container
cache[request2] = Test.container
// When
cache.trim(toCount: 1)
// Then
XCTAssertNil(cache[request1])
XCTAssertNotNil(cache[request2])
}
@MainActor
func testThatImagesAreRemovedOnCountLimitChange() {
// Given
cache.countLimit = 2
cache[request1] = Test.container
cache[request2] = Test.container
// When
cache.countLimit = 1
// Then
XCTAssertNil(cache[request1])
XCTAssertNotNil(cache[request2])
}
// MARK: Cost
#if !os(macOS)
@MainActor
func testDefaultImageCost() {
XCTAssertEqual(cache.cost(for: ImageContainer(image: Test.image)), 1228800)
}
@MainActor
func testThatTotalCostChanges() {
let imageCost = cache.cost(for: ImageContainer(image: Test.image))
XCTAssertEqual(cache.totalCost, 0)
cache[request1] = Test.container
XCTAssertEqual(cache.totalCost, imageCost)
cache[request2] = Test.container
XCTAssertEqual(cache.totalCost, 2 * imageCost)
cache[request2] = nil
XCTAssertEqual(cache.totalCost, imageCost)
cache[request1] = nil
XCTAssertEqual(cache.totalCost, 0)
}
@MainActor
func testThatCostLimitChanged() {
// Given
let cost = cache.cost(for: ImageContainer(image: Test.image))
// When
cache.costLimit = Int(Double(cost) * 1.5)
// Then
XCTAssertEqual(cache.costLimit, Int(Double(cost) * 1.5))
}
@MainActor
func testThatItemsAreRemoveImmediatelyWhenCostLimitIsReached() {
// Given
let cost = cache.cost(for: ImageContainer(image: Test.image))
cache.costLimit = Int(Double(cost) * 1.5)
// When/Then
cache[request1] = Test.container
// LRU item is released
cache[request2] = Test.container
XCTAssertNil(cache[request1])
XCTAssertNotNil(cache[request2])
}
@MainActor
func testEntryCostLimitEntryStored() {
// Given
let container = ImageContainer(image: Test.image)
let cost = cache.cost(for: container)
cache.costLimit = Int(Double(cost) * 15)
cache.entryCostLimit = 0.1
// When
cache[Test.request] = container
// Then
XCTAssertNotNil(cache[Test.request])
XCTAssertEqual(cache.totalCount, 1)
}
@MainActor
func testEntryCostLimitEntryNotStored() {
// Given
let container = ImageContainer(image: Test.image)
let cost = cache.cost(for: container)
cache.costLimit = Int(Double(cost) * 3)
cache.entryCostLimit = 0.1
// When
cache[Test.request] = container
// Then
XCTAssertNil(cache[Test.request])
XCTAssertEqual(cache.totalCount, 0)
}
@MainActor
func testTrimToCost() {
// Given
cache.costLimit = Int.max
cache[request1] = Test.container
cache[request2] = Test.container
// When
let cost = cache.cost(for: ImageContainer(image: Test.image))
cache.trim(toCost: Int(Double(cost) * 1.5))
// Then
XCTAssertNil(cache[request1])
XCTAssertNotNil(cache[request2])
}
@MainActor
func testThatImagesAreRemovedOnCostLimitChange() {
// Given
let cost = cache.cost(for: ImageContainer(image: Test.image))
cache.costLimit = Int(Double(cost) * 2.5)
cache[request1] = Test.container
cache[request2] = Test.container
// When
cache.costLimit = cost
// Then
XCTAssertNil(cache[request1])
XCTAssertNotNil(cache[request2])
}
@MainActor
func testImageContainerWithoutAssociatedDataCost() {
// Given
let data = Test.data(name: "cat", extension: "gif")
let image = PlatformImage(data: data)!
let container = ImageContainer(image: image, data: nil)
// Then
XCTAssertEqual(cache.cost(for: container), 558000)
}
@MainActor
func testImageContainerWithAssociatedDataCost() {
// Given
let data = Test.data(name: "cat", extension: "gif")
let image = PlatformImage(data: data)!
let container = ImageContainer(image: image, data: data)
// Then
XCTAssertEqual(cache.cost(for: container), 558000 + 427672)
}
#endif
// MARK: LRU
@MainActor
func testThatLeastRecentItemsAreRemoved() {
// Given
let cost = cache.cost(for: ImageContainer(image: Test.image))
cache.costLimit = Int(Double(cost) * 2.5)
cache[request1] = Test.container
cache[request2] = Test.container
cache[request3] = Test.container
// Then
XCTAssertNil(cache[request1])
XCTAssertNotNil(cache[request2])
XCTAssertNotNil(cache[request3])
}
@MainActor
func testThatItemsAreTouched() {
// Given
let cost = cache.cost(for: ImageContainer(image: Test.image))
cache.costLimit = Int(Double(cost) * 2.5)
cache[request1] = Test.container
cache[request2] = Test.container
_ = cache[request1] // Touched image
// When
cache[request3] = Test.container
// Then
XCTAssertNotNil(cache[request1])
XCTAssertNil(cache[request2])
XCTAssertNotNil(cache[request3])
}
// MARK: Misc
@MainActor
func testRemoveAll() {
// GIVEN
cache[request1] = Test.container
cache[request2] = Test.container
// WHEN
cache.removeAll()
// THEN
XCTAssertEqual(cache.totalCount, 0)
XCTAssertEqual(cache.totalCost, 0)
}
#if os(iOS) || os(tvOS) || os(visionOS)
@MainActor
func testThatSomeImagesAreRemovedOnDidEnterBackground() async {
// GIVEN
cache.costLimit = Int.max
cache.countLimit = 10 // 1 out of 10 images should remain
for i in 0..<10 {
cache[_request(index: i)] = Test.container
}
XCTAssertEqual(cache.totalCount, 10)
// WHEN
let task = Task { @MainActor in
NotificationCenter.default.post(name: UIApplication.didEnterBackgroundNotification, object: nil)
// THEN
XCTAssertEqual(cache.totalCount, 1)
}
await task.value
}
@MainActor
func testThatSomeImagesAreRemovedBasedOnCostOnDidEnterBackground() async {
// GIVEN
let cost = cache.cost(for: ImageContainer(image: Test.image))
cache.costLimit = cost * 10
cache.countLimit = Int.max
for index in 0..<10 {
let request = ImageRequest(url: URL(string: "http://example.com/img\(index)")!)
cache[request] = Test.container
}
XCTAssertEqual(cache.totalCount, 10)
// WHEN
let task = Task { @MainActor in
NotificationCenter.default.post(name: UIApplication.didEnterBackgroundNotification, object: nil)
// THEN
XCTAssertEqual(cache.totalCount, 1)
}
await task.value
}
#endif
}
class InternalCacheTTLTests: XCTestCase {
let cache = Cache<Int, Int>(costLimit: 1000, countLimit: 1000)
// MARK: TTL
@MainActor
func testTTL() {
// Given
cache.set(1, forKey: 1, cost: 1, ttl: 0.05) // 50 ms
XCTAssertNotNil(cache.value(forKey: 1))
// When
usleep(55 * 1000)
// Then
XCTAssertNil(cache.value(forKey: 1))
}
@MainActor
func testDefaultTTLIsUsed() {
// Given
cache.conf.ttl = 0.05// 50 ms
cache.set(1, forKey: 1, cost: 1)
XCTAssertNotNil(cache.value(forKey: 1))
// When
usleep(55 * 1000)
// Then
XCTAssertNil(cache.value(forKey: 1))
}
@MainActor
func testDefaultToNonExpiringEntries() {
// Given
cache.set(1, forKey: 1, cost: 1)
XCTAssertNotNil(cache.value(forKey: 1))
// When
usleep(55 * 1000)
// Then
XCTAssertNotNil(cache.value(forKey: 1))
}
}