PlaybookAccessibilitySnapshot 0.2.1

PlaybookAccessibilitySnapshot 0.2.1

Maintained by ra1028, Jiayi Zhou.



 
Depends on:
PlaybookSnapshot~> 0.3.0
AccessibilitySnapshot/Core~> 0.4.1
 

  • By
  • jiayi-zhou and ra1028

Playbook

PlaybookAccessibilitySnapshot

Swift5 CI Status Lincense
Release CocoaPods

PlaybookAccessibilitySnapshot is an extension to Playbook that uses AccessibilitySnapshot to produce snapshots with accessibility information such as activation points and labels.


Usage


AccessibilitySnapshot

final class AccessibilitySnapshotTests: XCTestCase {
    func testTakeAccessibilitySnapshot() throws {
        let directory = ProcessInfo.processInfo.environment["SNAPSHOT_DIR"]!

        try Playbook.default.run(
            AccessibilitySnapshot(
                directory: URL(fileURLWithPath: directory),
                clean: true,
                format: .png,
                keyWindow: UIApplication.shared.windows.first { $0.isKeyWindow },
                devices: [.iPhone11Pro(.portrait)]
            )
        )
    }
}

snapshot

Sample Before After
sample before after

Integration with Third-party Tools

The generated snapshot images with accessibility information can be used for more advanced visual regression testing by using a variety of third party tools.

percy

percy


Requirements

  • Swift 5.3+
  • Xcode 12.2+
  • iOS 12.0+

Installation

CocoaPods

Add the following to your Podfile:

target 'YourPlaybook' do
  pod 'Playbook'

  target 'YourPlaybookTests' do
    inherit! :search_paths

    pod 'PlaybookAccessibilitySnapshot'
  end
end

Development

  1. Run make proj at the root of this repository.
  2. Open Example/Example.xcworkspace via Xcode.
  3. Develop a PlaybookAccessibilitySnapshot installed as a development pods.

License

Playbook is released under the Apache 2.0 License.


Playbook