クラウド Mac で iOS UserDefaults の既定値とリセット動作を検証する
リモート Mac のデスクトップで「既定の設定に戻す」動作をテストしているのに、スイッチの値が残っている。テストの実行順を変えると、結果も変わってしまう。そんなときは、待機時間を追加したり、強制的に同期したりする前に、読み取り元を確認しましょう。UserDefaults から取得した値は、登録された既定値である可能性があり、永続データが残っているとは限りません。まずはクラウド Mac 上で独立した Swift スクリプトを実行し、その後、同じ契約を iOS テストに移して、既定値、明示的な上書き、リセットの境界を切り分けます。
まず設定の読み取り契約を定義する
「ヒントを表示」は既定でオン、「再試行回数」は既定で 3 回と定めます。ユーザーが明示的にヒントをオフにしたり、再試行回数を 0 回にしたりした場合は、その値が既定値に優先しなければなりません。設定キーを削除した後は、再び既定値が使われる必要があります。
register(defaults:) は登録ドメインにフォールバック値を用意するもので、その値をアプリの永続ドメインに書き込むわけではありません。通常の読み取りは複数のドメインを検索しますが、persistentDomain(forName:) が調べるのは指定した永続ドメインだけです。それぞれ確認できることが異なるため、検証では別々にアサーションを設けます。
「読み取れる」ことと「永続的に保存されている」ことは同じではありません。
dictionaryRepresentation()は検索対象のドメインを統合したビューであり、ディスクに保存された証拠にはなりません。
まず、初期状態でのフォールバック、明示的な上書き、単一キーの削除、ドメイン全体のリセットという 4 つの状態をテストケースに盛り込みます。画面上のスイッチの状態だけで判断しないようにしましょう。
独立した suite で基本動作を検証する
ターミナルで xcrun swift --version を実行し、ツールが利用できることを確認します。次の内容を defaults-contract.swift として保存し、xcrun swift defaults-contract.swift を実行してください。何も出力されず、終了コードがゼロなら、すべての事前条件が満たされています。条件を満たさない場合は、その時点で実行が停止します。
suite 名をランダムにすることで、長期間稼働しているマシンに残った古いデータを避けます。キー名も個別に生成し、同一プロセス内で登録ドメインのキーが衝突する可能性を抑えます。このスクリプトが操作するのは専用の永続ドメインだけで、実際のアプリ設定には触れません。
import Foundation
let token = UUID().uuidString
let suite = "local.defaults.contract." + token
guard let defaults = UserDefaults(suiteName: suite) else {
fatalError("Unable to create defaults suite")
}
let enabled = token + ".hintsEnabled"
let retries = token + ".retryCount"
defer {
defaults.removePersistentDomain(forName: suite)
}
defaults.register(defaults: [
enabled: true,
retries: 3
])
precondition(defaults.bool(forKey: enabled))
precondition(defaults.integer(forKey: retries) == 3)
precondition(defaults.persistentDomain(forName: suite)?[enabled] == nil)
defaults.set(false, forKey: enabled)
defaults.set(0, forKey: retries)
precondition(!defaults.bool(forKey: enabled))
precondition(defaults.integer(forKey: retries) == 0)
precondition(
defaults.persistentDomain(forName: suite)?[enabled] as? Bool == false
)
defaults.removeObject(forKey: enabled)
precondition(defaults.bool(forKey: enabled))
precondition(defaults.persistentDomain(forName: suite)?[enabled] == nil)
precondition(defaults.integer(forKey: retries) == 0)
defaults.removePersistentDomain(forName: suite)
precondition(defaults.bool(forKey: enabled))
precondition(defaults.integer(forKey: retries) == 3)
precondition(defaults.persistentDomain(forName: suite)?[retries] == nil)
このスクリプトで検証できるのは、現在のプロセス内における Foundation の動作です。プロセスをまたぐディスクへの書き込みタイミングは検証していません。この結果だけでアプリ再起動後の読み取りまで確認済みとは言えず、iOS のサンドボックス内での実行を代替することもできません。
ビジネスロジック層にストレージを注入する
ビジネスロジックが UserDefaults.standard を直接使っていると、テストの分離が難しくなります。設定リポジトリが UserDefaults インスタンスを受け取る設計にし、本番環境では所定のストレージを、テストでは新しく作成した suite を渡します。既定値の登録はリポジトリの初期化時にまとめて行い、各画面のライフサイクル処理に分散させないようにします。
明示的なオフをフォールバックで上書きしない
「読み取った値が false なら true にする」といった処理は避けます。bool(forKey:) はキーが存在しない場合にも false を返すことがあるため、真偽値だけではキーの有無を判定できません。既定値を登録しておけば、通常の読み取りで契約どおりのフォールバック値を取得できます。
同様に、再試行回数 0 回も有効な設定です。ゼロを「未設定」とみなしてはいけません。ユーザーがある項目を保存したことがあるかを調べる場合は、対象の永続ドメインにキーが存在するかを確認します。object(forKey:) も登録ドメインを検索するため、この判定には使えません。
すべての設定をリセットするのか、画面の表示設定だけをリセットするのかも、リポジトリのインターフェースで明確にします。同じ永続ドメインにほかの業務用フラグが保存されている場合、本番コードでは許可リストに沿ってキーを削除する必要があります。テストで使ったドメイン全体の削除を、そのまま流用してはいけません。
iOS テストでライフサイクルの境界も検証する
上記の事前条件を XCTest のアサーションに置き換え、iOS のテストターゲットで実行します。各テストケースには専用の suite を用意し、終了時にクリーンアップします。ランダムなキー名は、アプリが実際に使う設定キーの代わりにはなりません。ビジネスロジックのテストでは、引き続きリポジトリのインターフェースを通じて実際のキーを操作します。
テストを並列実行する場合にも注意が必要です。登録ドメインは、suite ごとに完全に独立したコピーが用意されるわけではありません。同一プロセス内で同名の登録キーを使うと、互いに影響する可能性があります。suite 名が異なるだけで、完全に分離されていると判断してはいけません。同名のキーを使うテストケースを直列実行するか、テスト用リポジトリにキーのプレフィックスを注入する方法が考えられます。
アプリの再起動を伴う動作については、別途、統合テストを作成します。設定を書き込み、正常終了させ、再起動した後に値を確認します。テストプロセスの suite が、そのままアプリプロセスの使用する suite になるわけではないため、明示的なテスト用の入口が必要です。完了条件のない処理を固定の待機時間で済ませたり、ストレージの選択ミスを synchronize() でごまかしたりしないようにしましょう。
失敗の特徴から原因を絞り込む
リセット後も既定値が読み取れる場合は、まず永続ドメインが空になっているかを確認します。多くの場合、これは正しいフォールバック動作です。明示的に設定した false が true に戻ってしまう場合は、真偽値に基づいて初期化する処理がないかを調べます。単独実行では成功し、テスト全体を実行すると失敗する場合は、登録キーの衝突と standard の共有を優先して確認します。
失敗時の記録には、suite 名、テスト用キー、期待する型だけを残し、設定辞書全体は出力しないでください。最終的な検証では、「何を削除したか」と「削除後に何が読み取れるか」の両方を確認します。さらに、リセットを繰り返すテストケースを追加し、2 回目の実行も安全であることを確かめます。こうして得られるのは、たまたま正しく見えた画面の状態ではなく、再利用できる設定の契約です。
よくある質問
register(defaults:) は既定値をディスクに保存しますか?
保存しません。登録ドメインにフォールバック値を用意します。永続データは dictionaryRepresentation() ではなく persistentDomain(forName:) で確認してください。
永続ドメインを削除しても設定値が読めるのはなぜですか?
読み取りが登録済みの既定値に戻るためです。永続ドメインから業務キーが消えたことと、読み取り結果が想定した既定値になったことを別々に検証します。
専用 Mac でワークフローを検証
モデル、ノード、利用期間を確認してから、まずは1日単位でお試しください。実際の利用可否はコントロールパネルに表示される最新状況をご確認ください。