Add navigator UI tests

Author: mickael-menu

.github/workflows/checks.yml

@@ -40,6 +40,23 @@ jobs:
           set -eo pipefail
           xcodebuild test-without-building -scheme "$scheme" -destination "platform=$platform,name=$device" | if command -v xcpretty &> /dev/null; then xcpretty; else cat; fi
 
+  navigator-ui-tests:
+    name: Navigator UI Tests
+    runs-on: macos-14
+    if: ${{ !github.event.pull_request.draft }}
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+      - name: Install dependencies
+        run: |
+          brew update
+          brew install xcodegen
+      - name: Test
+        run: |
+          set -eo pipefail
+          make navigator-ui-tests-project
+          xcodebuild test -project Tests/NavigatorTests/UITests/NavigatorUITests.xcodeproj -scheme NavigatorTestHost -destination "platform=$platform,name=$device" | if command -v xcpretty &> /dev/null; then xcpretty; else cat; fi
+
   lint:
     name: Lint
     runs-on: macos-14

Makefile

@@ -15,6 +15,10 @@ carthage-project:
 	rm -rf $(SCRIPTS_PATH)/node_modules/
 	xcodegen -s Support/Carthage/project.yml --use-cache --cache-path Support/Carthage/.xcodegen
 
+.PHONY: navigator-ui-tests-project
+navigator-ui-tests-project:
+	xcodegen -s Tests/NavigatorTests/UITests/project.yml
+
 .PHONY: scripts
 scripts:
 	@which corepack >/dev/null 2>&1 || (echo "ERROR: corepack is required, please install it first\nhttps://pnpm.io/installation#using-corepack"; exit 1)
@@ -32,11 +36,6 @@ update-scripts:
 	@which corepack >/dev/null 2>&1 || (echo "ERROR: corepack is required, please install it first\nhttps://pnpm.io/installation#using-corepack"; exit 1)
 	pnpm install --dir "$(SCRIPTS_PATH)"
 
-.PHONY: test
-test:
-	# To limit to a particular test suite: -only-testing:ReadiumSharedTests
-	xcodebuild test -scheme "Readium-Package" -destination "platform=iOS Simulator,name=iPhone 15" | xcbeautify -q
-
 .PHONY: lint-format
 lint-format:
 	swift run --package-path BuildTools swiftformat --lint .

Package.swift

@@ -101,7 +101,10 @@ let package = Package(
         .testTarget(
             name: "ReadiumNavigatorTests",
             dependencies: ["ReadiumNavigator"],
-            path: "Tests/NavigatorTests"
+            path: "Tests/NavigatorTests",
+            exclude: [
+                "UITests",
+            ]
         ),
 
         .target(
@@ -140,7 +143,7 @@ let package = Package(
         //     dependencies: ["ReadiumLCP"],
         //     path: "Tests/LCPTests",
         //     resources: [
-        //         .copy("Fixtures"),
+        //         .copy("../Fixtures"),
         //     ]
         // ),
 

…s/SharedTests/Fixtures/Fetcher/epub.epub Tests/Fixtures/childrens-literature.epubTests/SharedTests/Fixtures/Fetcher/epub.epub renamed to Tests/Fixtures/childrens-literature.epub Tests/SharedTests/Fixtures/Fetcher/epub.epub renamed to Tests/Fixtures/childrens-literature.epub

@@ -0,0 +1 @@
+*.xcodeproj

Tests/LCPTests/Fixtures/daisy.lcpdf Tests/Fixtures/daisy.lcpdfTests/LCPTests/Fixtures/daisy.lcpdf renamed to Tests/Fixtures/daisy.lcpdf

@@ -0,0 +1,21 @@
+//
+//  Copyright 2025 Readium Foundation. All rights reserved.
+//  Use of this source code is governed by the BSD-style license
+//  available in the top-level LICENSE file of the project.
+//
+
+import Foundation
+import SwiftUI
+
+enum AccessibilityID: String {
+    case open
+    case close
+    case allMemoryDeallocated
+    case isNavigatorReady
+}
+
+extension View {
+    func accessibilityIdentifier(_ id: AccessibilityID) -> ModifiedContent<Self, AccessibilityAttachmentModifier> {
+        accessibilityIdentifier(id.rawValue)
+    }
+}

Tests/LCPTests/Fixtures/daisy.pdf Tests/Fixtures/daisy.pdfTests/LCPTests/Fixtures/daisy.pdf renamed to Tests/Fixtures/daisy.pdf

@@ -0,0 +1,80 @@
+//
+//  Copyright 2025 Readium Foundation. All rights reserved.
+//  Use of this source code is governed by the BSD-style license
+//  available in the top-level LICENSE file of the project.
+//
+
+import ReadiumAdapterGCDWebServer
+import ReadiumNavigator
+import ReadiumShared
+import ReadiumStreamer
+import UIKit
+
+/// Shared Readium infrastructure for testing.
+@MainActor class Container {
+    static let shared = Container()
+
+    let memoryTracker = MemoryTracker()
+    let httpClient: HTTPClient
+    let httpServer: HTTPServer
+    let assetRetriever: AssetRetriever
+    let publicationOpener: PublicationOpener
+
+    init() {
+        httpClient = DefaultHTTPClient()
+        assetRetriever = AssetRetriever(httpClient: httpClient)
+        httpServer = GCDHTTPServer(assetRetriever: assetRetriever)
+
+        publicationOpener = PublicationOpener(
+            parser: DefaultPublicationParser(
+                httpClient: httpClient,
+                assetRetriever: assetRetriever,
+                pdfFactory: DefaultPDFDocumentFactory()
+            ),
+            contentProtections: []
+        )
+    }
+
+    func publication(at url: FileURL) async throws -> Publication {
+        let asset = try await assetRetriever.retrieve(url: url).get()
+        let publication = try await publicationOpener.open(
+            asset: asset,
+            allowUserInteraction: false,
+            sender: nil
+        ).get()
+
+        memoryTracker.track(publication)
+        return publication
+    }
+
+    func navigator(for publication: Publication) throws -> VisualNavigator & UIViewController {
+        if publication.conforms(to: .epub) {
+            return try epubNavigator(for: publication)
+        } else if publication.conforms(to: .pdf) {
+            return try pdfNavigator(for: publication)
+        } else {
+            fatalError("Publication not supported")
+        }
+    }
+
+    func epubNavigator(for publication: Publication) throws -> EPUBNavigatorViewController {
+        let navigator = try EPUBNavigatorViewController(
+            publication: publication,
+            initialLocation: nil,
+            config: EPUBNavigatorViewController.Configuration(),
+            httpServer: httpServer
+        )
+        memoryTracker.track(navigator)
+        return navigator
+    }
+
+    func pdfNavigator(for publication: Publication) throws -> PDFNavigatorViewController {
+        let navigator = try PDFNavigatorViewController(
+            publication: publication,
+            initialLocation: nil,
+            httpServer: httpServer
+        )
+        memoryTracker.track(navigator)
+        return navigator
+    }
+}

Tests/NavigatorTests/UITests/.gitignore

@@ -0,0 +1,103 @@
+//
+//  Copyright 2025 Readium Foundation. All rights reserved.
+//  Use of this source code is governed by the BSD-style license
+//  available in the top-level LICENSE file of the project.
+//
+
+import ReadiumShared
+import SwiftUI
+
+/// Provides a simple UI for opening publication fixtures and display memory
+/// status for UI test verification.
+struct FixtureList: View {
+    @ObservedObject private var memoryTracker: MemoryTracker
+    @StateObject private var viewModel = FixtureListViewModel()
+
+    init() {
+        memoryTracker = Container.shared.memoryTracker
+    }
+
+    var body: some View {
+        List {
+            Section {
+                fixture(.childrensLiteratureEPUB)
+                fixture(.daisyPDF)
+            }
+
+            Section {
+                Toggle(isOn: $memoryTracker.allDeallocated) {
+                    Text("All memory is deallocated")
+                }
+                .accessibilityIdentifier(.allMemoryDeallocated)
+            }
+            .disabled(true)
+        }
+        .fullScreenCover(item: $viewModel.readerViewModel) { viewModel in
+            ReaderView(viewModel: viewModel)
+        }
+    }
+
+    private func fixture(_ fixture: PublicationFixture) -> some View {
+        ListRow(action: { viewModel.open(fixture) }) {
+            VStack(alignment: .leading) {
+                Text(fixture.filename)
+                    .font(.headline)
+
+                Text(fixture.description)
+                    .font(.caption)
+            }
+
+            Spacer()
+
+            Image(systemName: "chevron.right")
+        }
+        .accessibilityIdentifier(fixture.accessibilityIdentifier)
+    }
+}
+
+@MainActor
+class FixtureListViewModel: ObservableObject {
+    @Published var readerViewModel: ReaderViewModel?
+
+    private var openTask: Task<Void, Never>?
+
+    func open(_ fixture: PublicationFixture) {
+        openTask?.cancel()
+        openTask = Task { try! await open(fixture) }
+    }
+
+    private func open(_ fixture: PublicationFixture) async throws {
+        let components = fixture.filename.split(separator: ".", maxSplits: 1)
+            .map { String($0) }
+
+        guard
+            components.count == 2,
+            let epubURL = Bundle.main.url(
+                forResource: components[0],
+                withExtension: components[1],
+                subdirectory: "Fixtures"
+            )
+        else {
+            throw FixtureError.notFound(fixture)
+        }
+
+        let fileURL = FileURL(url: epubURL)!
+
+        let container = Container.shared
+        let publication = try await container.publication(at: fileURL)
+        let navigator = try container.navigator(for: publication)
+
+        readerViewModel = ReaderViewModel(navigator: navigator)
+    }
+}
+
+enum FixtureError: LocalizedError {
+    case notFound(PublicationFixture)
+
+    var errorDescription: String? {
+        switch self {
+        case .notFound:
+            return "Test EPUB fixture not found in bundle"
+        }
+    }
+}