firebase-ios-sdk/FirebaseAI/Tests/Unit/PartsRepresentableTests.swift

// Copyright 2024 Google LLC
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//      http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

import CoreGraphics
import XCTest
#if canImport(UIKit)
  import UIKit
#elseif canImport(AppKit)
  import AppKit
#endif
#if canImport(CoreImage)
  import CoreImage
#endif // canImport(CoreImage)

@testable import FirebaseAI

@available(iOS 15.0, macOS 12.0, macCatalyst 15.0, tvOS 15.0, watchOS 8.0, *)
final class PartsRepresentableTests: XCTestCase {
  #if !os(watchOS)
    func testModelContentFromCGImageIsNotEmpty() throws {
      // adapted from https://forums.swift.org/t/creating-a-cgimage-from-color-array/18634/2
      var srgbArray = [UInt32](repeating: 0xFFFF_FFFF, count: 8 * 8)
      let image = srgbArray.withUnsafeMutableBytes { ptr -> CGImage in
        let ctx = CGContext(
          data: ptr.baseAddress,
          width: 8,
          height: 8,
          bitsPerComponent: 8,
          bytesPerRow: 4 * 8,
          space: CGColorSpace(name: CGColorSpace.sRGB)!,
          bitmapInfo: CGBitmapInfo.byteOrder32Little.rawValue +
            CGImageAlphaInfo.premultipliedFirst.rawValue
        )!
        return ctx.makeImage()!
      }
      let modelContent = image.partsValue
      XCTAssert(modelContent.count > 0, "Expected non-empty model content for CGImage: \(image)")
    }
  #endif // !os(watchOS)

  #if canImport(CoreImage)
    func testModelContentFromCIImageIsNotEmpty() throws {
      let image = CIImage(color: CIColor.red)
        .cropped(to: CGRect(origin: CGPointZero, size: CGSize(width: 16, height: 16)))
      let modelContent = image.partsValue
      XCTAssert(modelContent.count > 0, "Expected non-empty model content for CGImage: \(image)")
    }

    func testModelContentFromInvalidCIImageThrows() throws {
      let image = CIImage.empty()
      let modelContent = image.partsValue
      let part = try XCTUnwrap(modelContent.first)
      let errorPart = try XCTUnwrap(part as? ErrorPart, "Expected ErrorPart.")
      let imageError = try XCTUnwrap(
        errorPart.error as? ImageConversionError,
        "Got unexpected error type: \(errorPart.error)"
      )
      guard case .couldNotConvertToJPEG = imageError else {
        XCTFail("Expected JPEG conversion error, got \(imageError) instead.")
        return
      }
    }
  #endif // canImport(CoreImage)

  #if canImport(UIKit) && !os(visionOS) // These tests are stalling in CI on visionOS.
    func testModelContentFromInvalidUIImageThrows() throws {
      let image = UIImage()
      let modelContent = image.partsValue
      let part = try XCTUnwrap(modelContent.first)
      let errorPart = try XCTUnwrap(part as? ErrorPart, "Expected ErrorPart.")
      let imageError = try XCTUnwrap(
        errorPart.error as? ImageConversionError,
        "Got unexpected error type: \(errorPart.error)"
      )
      guard case .couldNotConvertToJPEG = imageError else {
        XCTFail("Expected JPEG conversion error, got \(imageError) instead.")
        return
      }
    }

    func testModelContentFromUIImageIsNotEmpty() throws {
      let image = try XCTUnwrap(UIImage(systemName: "star.fill"))
      let modelContent = image.partsValue
      XCTAssert(modelContent.count > 0, "Expected non-empty model content for UIImage: \(image)")
    }

  #elseif canImport(AppKit)
    func testModelContentFromNSImageIsNotEmpty() throws {
      let coreImage = CIImage(color: CIColor.red)
        .cropped(to: CGRect(origin: CGPointZero, size: CGSize(width: 16, height: 16)))
      let rep = NSCIImageRep(ciImage: coreImage)
      let image = NSImage(size: rep.size)
      image.addRepresentation(rep)
      let modelContent = image.partsValue
      XCTAssert(modelContent.count > 0, "Expected non-empty model content for NSImage: \(image)")
    }

    func testModelContentFromInvalidNSImageThrows() throws {
      let image = NSImage()
      let modelContent = image.partsValue
      let part = try XCTUnwrap(modelContent.first)
      let errorPart = try XCTUnwrap(part as? ErrorPart, "Expected ErrorPart.")
      let imageError = try XCTUnwrap(
        errorPart.error as? ImageConversionError,
        "Got unexpected error type: \(errorPart.error)"
      )
      guard case .invalidUnderlyingImage = imageError else {
        XCTFail("Expected invalid underlying image conversion error, got \(imageError) instead.")
        return
      }
    }
  #endif

  func testMixedParts() throws {
    let text = "This is a test"
    let data = try XCTUnwrap("This is some data".data(using: .utf8))
    let inlineData = InlineDataPart(data: data, mimeType: "text/plain")

    let parts: [any PartsRepresentable] = [text, inlineData]
    let modelContent = ModelContent(parts: parts)

    XCTAssertEqual(modelContent.parts.count, 2)
    let textPart = try XCTUnwrap(modelContent.parts[0] as? TextPart)
    XCTAssertEqual(textPart.text, text)
    let dataPart = try XCTUnwrap(modelContent.parts[1] as? InlineDataPart)
    XCTAssertEqual(dataPart, inlineData)
  }

  #if canImport(UIKit)
    func testMixedParts_withImage() throws {
      let text = "This is a test"
      let image = try XCTUnwrap(UIImage(systemName: "star"))
      let parts: [any PartsRepresentable] = [text, image]
      let modelContent = ModelContent(parts: parts)

      XCTAssertEqual(modelContent.parts.count, 2)
      let textPart = try XCTUnwrap(modelContent.parts[0] as? TextPart)
      XCTAssertEqual(textPart.text, text)
      let imagePart = try XCTUnwrap(modelContent.parts[1] as? InlineDataPart)
      XCTAssertEqual(imagePart.mimeType, "image/jpeg")
      XCTAssertFalse(imagePart.data.isEmpty)
    }

  #elseif canImport(AppKit)
    func testMixedParts_withImage() throws {
      let text = "This is a test"
      let coreImage = CIImage(color: CIColor.blue)
        .cropped(to: CGRect(origin: CGPoint.zero, size: CGSize(width: 16, height: 16)))
      let rep = NSCIImageRep(ciImage: coreImage)
      let image = NSImage(size: rep.size)
      image.addRepresentation(rep)

      let parts: [any PartsRepresentable] = [text, image]
      let modelContent = ModelContent(parts: parts)

      XCTAssertEqual(modelContent.parts.count, 2)
      let textPart = try XCTUnwrap(modelContent.parts[0] as? TextPart)
      XCTAssertEqual(textPart.text, text)
      let imagePart = try XCTUnwrap(modelContent.parts[1] as? InlineDataPart)
      XCTAssertEqual(imagePart.mimeType, "image/jpeg")
      XCTAssertFalse(imagePart.data.isEmpty)
    }
  #endif
}