File: FormatterCacheTests.swift

package info (click to toggle)
swiftlang 6.0.3-2
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 2,519,992 kB
  • sloc: cpp: 9,107,863; ansic: 2,040,022; asm: 1,135,751; python: 296,500; objc: 82,456; f90: 60,502; lisp: 34,951; pascal: 19,946; sh: 18,133; perl: 7,482; ml: 4,937; javascript: 4,117; makefile: 3,840; awk: 3,535; xml: 914; fortran: 619; cs: 573; ruby: 573
file content (115 lines) | stat: -rw-r--r-- 3,699 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
// Copyright (c) 2014 - 2017 Apple Inc. and the Swift project authors
// Licensed under Apache License v2.0 with Runtime Library Exception
//
// See https://swift.org/LICENSE.txt for license information
// See https://swift.org/CONTRIBUTORS.txt for the list of Swift project authors
//
//===----------------------------------------------------------------------===//
//
// RUN: %target-run-simple-swift
// REQUIRES: executable_test
// REQUIRES: objc_interop

#if canImport(TestSupport)
import TestSupport
#endif

#if canImport(FoundationInternationalization)
@testable import FoundationEssentials
@testable import FoundationInternationalization
#endif

#if FOUNDATION_FRAMEWORK
@testable import Foundation
#endif

final class FormatterCacheTests: XCTestCase {

    final class TestCacheItem: Equatable, Sendable {
        static func == (lhs: FormatterCacheTests.TestCacheItem, rhs: FormatterCacheTests.TestCacheItem) -> Bool {
            return lhs.value == rhs.value
        }

        let value: Int
        let deinitBlock: @Sendable () -> Void
        init(value: Int, deinitBlock: @Sendable @escaping () -> Void) {
            self.value = value
            self.deinitBlock = deinitBlock
        }

        deinit {
            deinitBlock()
        }
    }


    func testCreateItem() {
        let cache = FormatterCache<Int, Int>()

        var initializerBlockInvocationCount = 0

        // Fill up the cache until its `countLimit`
        for i in 0...cache.countLimit {
            let item = cache.formatter(for: i) {
                initializerBlockInvocationCount += 1
                return -i
            }
            XCTAssertEqual(item, -i)
        }

        // `creator` block has been called 101 times
        XCTAssertEqual(initializerBlockInvocationCount, cache.countLimit + 1)

        // `creator` block does not get executed when the key exists
        for i in 0..<initializerBlockInvocationCount {
            let item = cache.formatter(for: i) {
                XCTFail()
                return Int.max
            }

            XCTAssertEqual(item, -i)
        }

        // Fill one more to exceed cache's limit
        let item = cache.formatter(for: 1000) {
            initializerBlockInvocationCount += 1
            return -1000
        }

        // cache has been cleared out; only the one we just filled in is present
        for i in 0..<cache.countLimit {
            XCTAssertNil(cache[i])
        }
        XCTAssertEqual(cache[1000], item)
    }

#if FOUNDATION_FRAMEWORK
    func testSynchronouslyClearingCache() {
        let cache = FormatterCache<Int, TestCacheItem>()
        let group = DispatchGroup()
        let queue = DispatchQueue(label: "formatter cache test", qos: .default, attributes: .concurrent)


        for i in 0 ..< 5 {
            queue.async(group: group) {
                let cached = cache.formatter(for: i) {
                    return .init(value: -i, deinitBlock: {
                        // Test that `removeAllObjects` beneath does not trigger `deinit` of the removed objects in the locked scope.
                        // If it does cause the deinitialization of this instance where this block is run, we would deadlock here because the subscript getter is performed in the same locked scope as the enclosing `formatter(for:creator:)`.
                        _ = cache[i]
                    })
                }
                XCTAssertEqual(cached.value, -i)
            }

            queue.async(group: group) {
                cache.removeAllObjects()
            }
        }

        XCTAssertEqual(group.wait(timeout: .now().advanced(by: .seconds(3))), .success)
    }
#endif // FOUNDATION_FRAMEWORK
}