divkit/client/ios/LayoutKitSnapshotTests/SnapshotTestKit/SnapshotTestKit.swift

import CoreGraphics
import Foundation
import UIKit
import XCTest

import CommonCore

public enum TestMode {
  case record
  case update
  case verify
}

public enum SnapshotTestKit {
  public static func perform(
    on view: UIView,
    name: String,
    directory: String,
    mode: TestMode,
    size: CGSize
  ) {
    guard let referenceURL = snapshotReferenceURL(testName: name, directory: directory, size: size)
    else {
      XCTFail("Failed to create reference URL")
      return
    }

    guard let snapshot = view.makeSnapshot() else {
      XCTFail("Failed to make snapshot")
      return
    }

    let referencesURL = URL(
      fileURLWithPath: ReferenceSet.path,
      isDirectory: true
    ).appendingPathComponent(directory)

    testSnapshot(
      snapshot,
      referenceURL: referenceURL,
      diffDirPath: referencesURL.path,
      mode: mode
    )
  }

  public static func testSnapshot(
    _ snapshot: UIImage,
    referenceURL: URL,
    diffDirPath: String,
    mode: TestMode
  ) {
    let deviceModel = ProcessInfo.processInfo.environment["SIMULATOR_MODEL_IDENTIFIER"]
      ?? UIDevice.current.systemModelName
    guard allowedDevices.contains(deviceModel) else {
      XCTFail(
        "Prohibited device: '\(deviceModel)'. " +
          "Please, run snapshot tests on one of allowed device: '\(allowedDevices)'."
      )
      return
    }

    do {
      switch mode {
      case .record:
        let snapshotsDir = referenceURL.deletingLastPathComponent()
        let fileManager = FileManager.default
        if !fileManager.fileExists(atPath: snapshotsDir.path) {
          try fileManager.createDirectory(at: snapshotsDir, withIntermediateDirectories: true)
        }
        try snapshot.makePNGData().write(to: referenceURL)
        throw SnapshotTestError.recordModeEnabled
      case .update:
        let reference = try UIImage.makeWith(url: referenceURL)
        if !snapshot.compare(with: reference) {
          testSnapshot(
            snapshot,
            referenceURL: referenceURL,
            diffDirPath: diffDirPath,
            mode: .record
          )
        }
      case .verify:
        let data = try Data(contentsOf: referenceURL)
        if data == snapshot.pngData() {
          return
        }

        let reference = try UIImage.makeWith(url: referenceURL)
        if snapshot.compare(with: reference) {
          return
        }

        let diff = snapshot.makeDiff(with: reference)
        XCTContext.runActivity(named: "Diff of \(referenceURL.lastPathComponent)") {
          $0.add(.init(image: snapshot, name: "result"))
          $0.add(.init(image: reference, name: "reference"))
          $0.add(.init(image: diff, name: "diff"))
        }
        throw SnapshotTestError.comparisonFailed
      }
    } catch {
      XCTFail("Error in \(mode) mode for \(referenceURL.path): \(error.localizedDescription)")
    }
  }
}

extension UIImage {
  fileprivate func makePNGData() throws -> Data {
    guard let data = pngData() else {
      throw SnapshotTestError.nilPNGData
    }
    return data
  }

  fileprivate static func makeWith(url: URL) throws -> UIImage {
    let data = try Data(contentsOf: url)
    guard let image = UIImage(data: data, scale: UIScreen.main.scale) else {
      throw SnapshotTestError.imageCouldNotBeCreated
    }
    return image
  }
}

private enum SnapshotTestError: LocalizedError {
  case recordModeEnabled
  case comparisonFailed
  case nilPNGData
  case imageCouldNotBeCreated

  var errorDescription: String? {
    switch self {
    case .recordModeEnabled:
      return "Snapshot saved. Don't forget to change mode back to `verify`!"
    case .comparisonFailed:
      return "View snapshot is not equal to reference. Diff is attached in test result"
    case .nilPNGData:
      return "UIImage.pngData() returns nil"
    case .imageCouldNotBeCreated:
      return "UIImage could not be created with data"
    }
  }
}

private let allowedDevices: Set<String> = [
  UIDevice.Model.iPhone8,
  UIDevice.Model.iPhone8_China,
  UIDevice.Model.iPhone8Plus,
  UIDevice.Model.iPhone8Plus_China,
]

extension XCTAttachment {
  fileprivate convenience init(image: UIImage, name: String) {
    self.init(image: image)
    self.name = name
  }
}

private func snapshotReferenceURL(
  testName: String,
  directory: String,
  size: CGSize
) -> URL? {
  let baseFileName = testName
    .replacingOccurrences(of: "test_", with: "")
    .replacingOccurrences(of: "()", with: "")
  let scale = UIScreen.main.scale
  let fileName = "\(baseFileName)_\(Int(size.width))x\(Int(size.height))@\(Int(scale))x.png"
  return URL(fileURLWithPath: ReferenceSet.path, isDirectory: true)
    .appendingPathComponent(directory, isDirectory: true)
    .appendingPathComponent(fileName)
}