passepartout-apple/Passepartout/UITests/Extensions/XCTestCase+Extensions.swift
Davide 962361cb9f
Automate screenshots via UI tests (#960)
Ready for screenshots generation, except for the tests themselves and
the TV target.

- More customizations while UI testing
  - Act as full version user in IAPManager
  - Override layout with default to .grid if isBigDevice
  - Show module names in profile list/grid
- Improve mock Profile/ProfileManager
  - Meaningful profile names
  - iCloud/TV icons
  - Initial modules
- Improve XCTest extensions
  - Screenshot destination (attachment/temporary)
  - Screenshot target (window/sheet)
  - Print saved temporary URL at the end (may help with CI)
  - Append device name to screenshot filename
- Tests
- Refactor actions with the [Page Object
pattern](https://swiftwithmajid.com/2021/03/24/ui-testing-using-page-object-pattern-in-swift/)
  - Perform iPad screenshots in landscape
  - Split simple flow tests and screenshots
  - Add "Connect to" test

Closes #681
2024-11-28 15:51:03 +01:00

103 lines
2.7 KiB
Swift

//
// XCTestCase+Extensions.swift
// Passepartout
//
// Created by Davide De Rosa on 11/28/24.
// Copyright (c) 2024 Davide De Rosa. All rights reserved.
//
// https://github.com/passepartoutvpn
//
// This file is part of Passepartout.
//
// Passepartout is free software: you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// Passepartout is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
// GNU General Public License for more details.
//
// You should have received a copy of the GNU General Public License
// along with Passepartout. If not, see <http://www.gnu.org/licenses/>.
//
import Foundation
import SwiftUI
import XCTest
extension XCTestCase {
enum ScreenshotDestination {
case attachment
case temporary
}
enum ScreenshotTarget {
case sheet
case window
}
}
extension XCTestCase.ScreenshotDestination {
var url: URL {
switch self {
case .attachment:
fatalError("Can this be found?")
case .temporary:
return URL(fileURLWithPath: NSTemporaryDirectory())
}
}
}
@MainActor
extension XCUIApplicationProviding where Self: XCTestCase {
func snapshot(
_ name: String,
destination: ScreenshotDestination = .temporary,
target: ScreenshotTarget = .window
) throws {
let container = container(for: target)
let screenshot = container.screenshot()
switch destination {
case .attachment:
let attachment = XCTAttachment(screenshot: screenshot)
attachment.name = name
attachment.lifetime = .keepAlways
add(attachment)
case .temporary:
let filename = deviceFilename(for: name)
let url = URL(fileURLWithPath: filename, relativeTo: destination.url)
try screenshot.pngRepresentation.write(to: url)
}
}
private func deviceFilename(for name: String) -> String {
#if os(iOS)
let device = UIDevice.current.userInterfaceIdiom == .pad ? "iPad" : "iPhone"
#elseif os(macOS)
let device = "Mac"
#elseif os(tvOS)
let device = "AppleTV"
#endif
return "\(name)_\(device).png"
}
private func container(for target: ScreenshotTarget) -> XCUIElement {
#if os(iOS)
app.windows.firstMatch
#else
switch target {
case .sheet:
return app.sheets.firstMatch
case .window:
return app.windows.firstMatch
}
#endif
}
}