如何使用 XCTest 测试线程安全性

Question

假设我们有以下具有可变状态的类：

class Machine {
   var state = 0
}

现在，假设有一些控制状态的内部机制。但是，任何线程或队列都可能发生状态更改，因此state必须在线程安全的环境中执行对属性的读写。为了实现这一点，我们将使用简单的sync(:_)方法dispatch_queue_t来同步对state变量的访问。（这不是唯一的方法，但这是一个例子）

现在，我们可以创建一个保存状态值的私有变量和另一个使用dispatch_sync(_:)方法的自定义 setter 和 getter 公共变量。

class Machine {
    private var internalState = 0

    var state: Int {
        get {
            var value: Int?
            dispatch_sync(dispatch_get_main_queue()) {
                value = self.internalState
            }
            return value!
        }

        set(newState) {
            dispatch_sync(dispatch_get_main_queue()) {
                self.internalState = newState
            }
        }
    }
}

state 现在可以从任何队列或线程进行安全的同步访问 - 它是线程安全的。

现在问题来了。

如何使用XCTest?

由于类Machine可以有一个复杂的状态机，我们需要测试它在任何环境中的表现：

• 测试对state任何队列或线程的访问
• 测试state从任何队列或线程写入

成功测试这种行为的最佳方法是什么？

目前，我正在创建自定义调度队列数组和定义状态数组。然后我使用dispatch_async方法来改变状态并测试它的值。这引入了新的XCTest执行问题，因为我需要跟踪所有状态突变何时完成。该解决方案似乎相当复杂且无法维护。

我可以做哪些不同的事情来实现更好的测试？

Answer 1

在考虑测试这样的线程安全代码时，有两个重要的移动部分：

1. 状态访问器仅在锁的上下文中运行
2. 锁定机制实际上是线程安全的。

虽然第一个可以通过使用模拟技术进行相对可测试，但后一个很难测试，主要是因为验证某些代码是否是线程安全的涉及对同时访问线程安全资源的多个线程的代码进行单元测试。即使这种技术也不是防弹的，因为我们无法完全控制从单元测试创​​建的线程的执行顺序，也无法完全控制每个线程分配的时间以确保我们捕获可能发生的所有可能的竞争条件。

考虑到上述情况，我建议编写一个提供锁定机制的小类/结构，并在state访问器中使用它。像这样分离职责可以更轻松地通过代码审查来评估锁定机制的正确性。

因此，我的建议是将线程安全代码移至专用包装器中，并使用类中的该包装器Machine：

/// A struct that just wraps a value and access it in a thread safe manner
public struct ThreadSafeBox<T> {
    private var _value: T

    /// Thread safe value, uses the main thread to synchronize the accesses
    public var value: T {
        get {
            if Thread.isMainThread { return _value }
            else { return DispatchQueue.main.sync { _value } }
        }
        set {
            if Thread.isMainThread { _value = newValue }
            else { DispatchQueue.main.sync { _value = newValue } }
        }
    }

    /// Initializes the box with the given value
    init(_ value: T) {
        _value = value
    }
}

代码ThreadSafeBox相对较小，任何设计缺陷都可以在代码审查时发现，因此理论上可以通过代码分析来证明其线程安全性。一旦我们证明了 的可靠性ThreadSafeBox，那么我们就可以保证Machine其属性也是线程安全的state。

如果您确实想测试属性访问器，您可以验证 get/set 操作仅在主线程上运行这一事实，这应该足以验证线程安全性。请注意，锁定机制与该类的实现细节相关，而单元测试实现细节的缺点是单元和单元测试紧密耦合。如果实现细节发生变化，这可能会导致需要更新测试，从而降低测试的可靠性。