【swift】テストコード中のUndoManagerのundoメソッドが一回しか呼んでいなくてもregisterUndoを行った回数分呼ばれてしまう。

Question

UndoManagerのundoメソッドを含むクラスのテストを行いたいのですが、例えばテストメソッド中でregisterUndoを行うターゲットのメソッドを3回コールするとundoをした際に一回のundoメソッドのコールでundoに登録した操作が３回実行されてしまいます。

import XCTest
@testable import UnitTestProject

class UnitTestProjectTests: XCTestCase {

    func testUndo() {
        let model = TestModel()
        
        model.increment()
        XCTAssertEqual(model.count, 1)
        
        model.increment()
        XCTAssertEqual(model.count, 2)
        
        model.increment()
        XCTAssertEqual(model.count, 3)
        
        model.undo()
        XCTAssertEqual(model.count, 2)
        
    }
}

import Foundation

class TestModel {
    
    let undoManager = UndoManager()
    var count = 0
    
    func registerUndo() {
        if (undoManager.isUndoRegistrationEnabled) {
            undoManager.registerUndo(withTarget: self, handler: { _ in 
                print("undo is executed")
                self.count -= 1
            })
        }
    }
    
    func increment() {
        count += 1
        registerUndo()
    }
    
    func undo() {
        if(undoManager.canUndo){
            undoManager.undo()
        }
    }
}

ターゲットクラスのregisterUndoではundo操作に分かりやすいようprintを入れています。
テストクラスではご覧の通りundoを一回しか呼んでいませんが、コンソールには"undo is executed"が３回表示され、実際にcountも0まで戻ってしまいます。

コンソールログ

Test Case '-[UnitTestProjectTests.UnitTestProjectTests testUndo]' started.
undo is executed
undo is executed
undo is executed
/Users/project/UnitTestProject/UnitTestProjectTests/UnitTestProjectTests.swift:27: error: -[UnitTestProjectTests.UnitTestProjectTests testUndo] : XCTAssertEqual failed: ("0") is not equal to ("2")
Test Case '-[UnitTestProjectTests.UnitTestProjectTests testUndo]' failed (0.019 seconds).
Test Suite 'UnitTestProjectTests' failed at 2021-01-04 22:21:43.585.
Executed 1 test, with 1 failure (0 unexpected) in 0.019 (0.020) seconds
Test Suite 'UnitTestProjectTests.xctest' failed at 2021-01-04 22:21:43.585.
Executed 1 test, with 1 failure (0 unexpected) in 0.019 (0.021) seconds
Test Suite 'Selected tests' failed at 2021-01-04 22:21:43.586.
Executed 1 test, with 1 failure (0 unexpected) in 0.019 (0.023) seconds

どうして１回しか呼んでいないのに3回実行されてしまうのでしょうか？
また、undo操作のテストはどのように行うべきでしょうか？

Comments

[MasakiHori]

ユニットテストをきちんと行うのであればifに対するelseは必ず処理すべきと思います

[ichina]

elseの場合は何も行わないようなコードでもログ出力などした方がいいということでしょうか？

[MasakiHori]

すみません。
コードを読み間違えてました。
質問のコードでは特に必要がなかったですね。

Answer 1

コメントレベルとなりますが、おそらく下記の議論とも関連してくるのだと思います。

• How will UndoManager run loop grouping be affected in different threading contexts?

この議論を参考に、ご提示いただいているコードを下記のように変更し、UndoManager に登録されるタイミングを調べてみます。

import Foundation

class TestModel {
    
    let undoManager: UndoManager
    var count = 0
    
    init() {
        self.undoManager = UndoManager()
        
        // MARK: グループ化される時の通知を受け取る
        registerForNotifications()
    }
    
    func registerUndo() {
        if undoManager.isUndoRegistrationEnabled {
            undoManager.registerUndo(withTarget: self, handler: { _ in
                print("undo is executed")
                self.count -= 1
            })
        }
    }
    
    func increment() {
        print("increment")
        
        count += 1
        registerUndo()
    }
    
    func undo() {
        print("increment")
        
        if undoManager.canUndo {
            undoManager.undo()
        }
    }
    
    // MARK: 以下の議論を参照
    // https://stackoverflow.com/questions/47988403/how-will-undomanager-run-loop-grouping-be-affected-in-different-threading-contex
    private func registerForNotifications() {
        NotificationCenter.default.addObserver(forName: Notification.Name.NSUndoManagerDidOpenUndoGroup, object: undoManager, queue: nil) { _ in
            print("opening group at level (self.undoManager.levelsOfUndo)")
        }
        
        NotificationCenter.default.addObserver(forName: Notification.Name.NSUndoManagerDidCloseUndoGroup, object: undoManager, queue: nil) { _ in
            print("closing group at level (self.undoManager.levelsOfUndo)")
        }
    }
}

これを、下記のようなテストケースで実行すると

    func testUndo() {
        let model = TestModel()

        model.increment()
        XCTAssertEqual(model.count, 1)

        model.increment()
        XCTAssertEqual(model.count, 2)

        model.increment()
        XCTAssertEqual(model.count, 3)

        model.undo()
        XCTAssertEqual(model.count, 2)
    }

デバッグコンソールにはつぎのような表示が出てきます。

increment
opening group at level 0
increment
increment
increment
closing group at level 0
undo is executed
undo is executed
undo is executed

本来であれば、インクリメントのたびにグルーピングしてくれれば良いのですが、上記のログをみると3回分ののインクリメントをひとまとめにしてグルーピングされています。

なので、undo() を実行した時に3回分まとめて呼び出されているのだと推測されます（どこに記載されていたか見失ってしまいましたが、登録されるタイミングについては UndoManager のリファレンスのどこかに記載されていました）。

では、逐一登録するためにはどのようにすれば良いかというと、自動登録を解除し、毎回グルーピングさせることになるようです。

簡単に説明すると、groupsByEvent を false に設定し、登録したいタイミングで beginUndoGrouping() や endUndoGrouping() を呼び出すことになります。

class Counter {
    private let manager: UndoManager
    
    init() {
        self.manager = UndoManager()
        self.manager.groupsByEvent = false
        
        registerForNotifications()
    }
    
    var count = 0
    
    func redo() {
        if manager.canRedo {
            print("Redo")
            manager.redo()
        } else {
            print("Cannot redo")
        }
    }
    
    func undo() {
        if manager.canUndo {
            print("Undo")
            manager.undo()
        }else {
            print("Cannot undo")
        }
    }
    
    @objc func increment() {
        print(#function)
        
        count += 1
        
        manager.beginUndoGrouping()
        self.manager.registerUndo(withTarget: self, selector: #selector(decrement), object: nil)
        manager.endUndoGrouping()
        
    }
    @objc func decrement() {
        print(#function)
        
        count -= 1
        
        manager.beginUndoGrouping()
        self.manager.registerUndo(withTarget: self, selector: #selector(increment), object: nil)
        manager.endUndoGrouping()
    }
    
    func registerForNotifications() {
        NotificationCenter.default.addObserver(forName: Notification.Name.NSUndoManagerDidOpenUndoGroup, object: manager, queue: nil) { _ in
            print("opening group at level (self.manager.levelsOfUndo)")
        }
        
        NotificationCenter.default.addObserver(forName: Notification.Name.NSUndoManagerDidCloseUndoGroup, object: manager, queue: nil) { _ in
            print("closing group at level (self.manager.levelsOfUndo)")
        }
    }
}

ちなみに、上記のコードだと Undo だけでなく、Redo についても登録できるようになっています

公式マニュアル

• [registerUndo(withTarget:selector:object:)

Registers the selector of the specified target to implement a single undo operation that the target receives.](https://developer.apple.com/documentation/foundation/undomanager/1414001-registerundo)

でも同じような例が紹介されています。

これを、下記のようなテストケースで実行させてみます。

class UnitTestProjectTests: XCTestCase {

    func testCounter() {
        let counter = Counter()
        
        counter.increment()
        XCTAssertEqual(counter.count, 1)
        
        counter.increment()
        XCTAssertEqual(counter.count, 2)
        
        counter.decrement()
        XCTAssertEqual(counter.count, 1)

        counter.undo()
        XCTAssertEqual(counter.count, 2)

        counter.undo()
        XCTAssertEqual(counter.count, 1)

        counter.undo()
        XCTAssertEqual(counter.count, 0)

        counter.redo()
        XCTAssertEqual(counter.count, 1)

        counter.redo()
        XCTAssertEqual(counter.count, 2)
        
        counter.increment()
        XCTAssertEqual(counter.count, 3)
        
        counter.redo()
        XCTAssertEqual(counter.count, 3)
        
        counter.undo()
        XCTAssertEqual(counter.count, 2)
    }
}

こちらだと、テストは全て成功し、当然ですが動作も想定通りとなります。

increment()
opening group at level 0
closing group at level 0
increment()
opening group at level 0
closing group at level 0
decrement()
opening group at level 0
closing group at level 0
Undo
increment()
Undo
decrement()
Undo
decrement()
Redo
increment()
Redo
increment()
increment()
opening group at level 0
closing group at level 0
Cannot redo
Undo
decrement()

動作としては想定通りなのですが、なぜこのような処理を必要なのかという根本的な理由としては、私としても納得できない部分は残ってますし、それについては調べてみたのですが十分な確証は得られませんでした。

なので、あくまでも参考程度に見ていただければと思います。
冒頭の議論やこの結果などを参考にしていただくと、何か解決法がみつかるかもしれません。

Comments

[ichina]

毎回ありがとうございます。グルーピングの制御が入ってるとは思わず、公式をあまり読み込んでいませんでした。おかげさまでテスト成功しました。ありがとうございました。