spiegel-keyman/ios/engine/KMEI/KeymanEngineTests/FileManagementTests.swift

//
//  KeymanEngineTests.swift
//  KeymanEngineTests
//
//  Created by Joshua Horton on 2020-02-19.
//  Copyright © 2020 SIL International. All rights reserved.
//

import XCTest

@testable import KeymanEngine
import DeviceKit


class FileManagementTests: XCTestCase {
  override func setUp() {
    TestUtils.setupAndDeinitManager()
  }
  
  override func tearDown() {
    TestUtils.standardTearDown()
  }

  func testKeyboardInstallation() throws {
    let kmp = try ResourceFileManager.shared.prepareKMPInstall(from: TestUtils.Keyboards.khmerAngkorKMP)
    XCTAssertNotNil(kmp, "Failed to prepare KMP for installation")
    XCTAssertNotNil(kmp as? KeyboardKeymanPackage, "KMP resource type improperly recognized - expected a keyboard package!")

    try ResourceFileManager.shared.finalizePackageInstall(kmp, isCustom: true)

    let installURL = Storage.active.keyboardURL(for: TestUtils.Keyboards.khmer_angkor)

    XCTAssertTrue(FileManager.default.fileExists(atPath: installURL.path),
                  "Could not find installed keyboard file")

    let keyboards = Storage.active.userDefaults.userKeyboards!

    XCTAssertEqual(keyboards.count, 1, "Unexpected number of keyboards were installed")
    XCTAssertEqual(keyboards[0].id, "khmer_angkor", "Installed keyboard ID mismatch")

    let fontURL = Storage.active.fontURL(forResource: TestUtils.Keyboards.khmer_angkor, filename: "Mondulkiri-R.ttf")!
    XCTAssertTrue(FileManager.default.fileExists(atPath: fontURL.path))
  }

  func testLexicalModelInstallation() throws {
    let kmp = try ResourceFileManager.shared.prepareKMPInstall(from: TestUtils.LexicalModels.mtntKMP)
    XCTAssertNotNil(kmp, "Failed to prepare KMP for installation")
    XCTAssertNotNil(kmp as? LexicalModelKeymanPackage, "KMP resource type improperly recognized - expected a lexical model package!")

    try ResourceFileManager.shared.finalizePackageInstall(kmp, isCustom: true)

    let installURL = Storage.active.lexicalModelURL(for: TestUtils.LexicalModels.mtnt)

    XCTAssertTrue(FileManager.default.fileExists(atPath: installURL.path),
                  "Could not find installed lexical model file")

    let models = Storage.active.userDefaults.userLexicalModels!

    // Yep, the model auto-installs for all language ids, even when there's no matching keyboard.
    // That's the current state of affairs in Keyman Engine for iOS.
    XCTAssertEqual(models.count, 3, "Unexpected number of models were installed")
    XCTAssertEqual(models[0].id, "nrc.en.mtnt", "Installed lexical model ID mismatch")
  }

  func testInstallKeyboardFromPackage() throws {
    // Standard installation
    let rawKMP = try ResourceFileManager.shared.prepareKMPInstall(from: TestUtils.Keyboards.khmerAngkorKMP)
    XCTAssertNotNil(rawKMP, "Failed to prepare KMP for installation")
    guard let kmp = rawKMP as? KeyboardKeymanPackage else {
      XCTFail("KMP resource type improperly recognized - expected a keyboard package!")
      return
    }

    do {
      try ResourceFileManager.shared.install(resourceWithID: TestUtils.Keyboards.khmer_angkor.fullID, from: kmp)
    } catch {
      XCTFail("Unexpected error during KeyboardPackage install")
    }

    let installURL = Storage.active.keyboardURL(for: TestUtils.Keyboards.khmer_angkor)

    XCTAssertTrue(FileManager.default.fileExists(atPath: installURL.path),
                  "Could not find installed keyboard file")

    let keyboards = Storage.active.userDefaults.userKeyboards!

    XCTAssertEqual(keyboards.count, 1, "Unexpected number of keyboards were installed")
    XCTAssertEqual(keyboards[0].id, "khmer_angkor", "Installed keyboard ID mismatch")

    // While the LanguageResource definition we provided lacks font definitions, the
    // KMP's definition has that data.  By default, the KMP's definition takes precedence.
    let fontURL = Storage.active.fontURL(forResource: TestUtils.Keyboards.khmer_angkor, filename: "Mondulkiri-R.ttf")!
    XCTAssertTrue(FileManager.default.fileExists(atPath: fontURL.path))
  }

  func testInstallLexicalModelFromPackage() throws {
    let rawKMP = try ResourceFileManager.shared.prepareKMPInstall(from: TestUtils.LexicalModels.mtntKMP)
    XCTAssertNotNil(rawKMP, "Failed to prepare KMP for installation")
    guard let kmp = rawKMP as? LexicalModelKeymanPackage else {
      XCTFail("KMP resource type improperly recognized - expected a lexical model package!")
      return
    }

    do {
      try ResourceFileManager.shared.install(resourceWithID: TestUtils.LexicalModels.mtnt.fullID, from: kmp)
    } catch {
      XCTFail("Unexpected error during LexicalModelPackage install")
    }

    let installURL = Storage.active.lexicalModelURL(for: TestUtils.LexicalModels.mtnt)

    XCTAssertTrue(FileManager.default.fileExists(atPath: installURL.path),
                  "Could not find installed lexical model file")

    let models = Storage.active.userDefaults.userLexicalModels!

    // This variant is selective - only a single pairing should be installed for the model.
    XCTAssertEqual(models.count, 1, "Unexpected number of models were installed")
    XCTAssertEqual(models[0].id, "nrc.en.mtnt", "Installed lexical model ID mismatch")
  }
}