base on Runtime introspection and unit testing of SwiftUI views <h1 align="center">ViewInspector 🕵️‍♂️ for SwiftUI</h1> <span align="center"> ![Platform](https://img.shields.io/badge/platform-iOS%20%7C%20macOS%20%7C%20tvOS%20%7C%20watchOS%20%7C%20visionOS-lightgrey) [![codecov](https://codecov.io/gh/nalexn/ViewInspector/branch/master/graph/badge.svg)](https://codecov.io/gh/nalexn/ViewInspector) </span> **ViewInspector** is a library for unit testing SwiftUI views. It allows for traversing a view hierarchy at runtime providing direct access to the underlying `View` structs. ## Why? SwiftUI view is a function of state. We could provide it with the input but could not verify the output... Until now! ## Helpful links * **[Inspection guide](guide.md)** * **[SwiftUI API coverage](readiness.md)** ## Use cases ### 1. Search the view of a specific type or condition Use one of the `find` functions to quickly locate a specific view or assert there are none of such: ```swift try sut.inspect().find(button: "Back") try sut.inspect().findAll(ViewType.Text.self, where: { try $0.attributes().isBold() }) ``` Check out [this section](guide.md#dynamic-query-with-find) in the guide for the reference. ### 2. Read the inner state of the standard views Standard SwiftUI views are no longer a black box: ```swift let sut = Text("Completed by \(72.51, specifier: "%.1f")%").font(.caption) let string = try sut.inspect().text().string(locale: Locale(identifier: "es")) XCTAssertEqual(string, "Completado por 72,5%") XCTAssertEqual(try sut.inspect().text().attributes().font(), .caption) ``` Each view has its own set of inspectable parameters, you can refer to the [API coverage](readiness.md) document to see what's available for a particular SwiftUI view. ### 3. Verify your custom view's state Obtain a copy of your custom view with actual state and references from the hierarchy of any depth: ```swift let sut = try view.inspect().find(CustomView.self).actualView() XCTAssertTrue(sut.viewModel.isUserLoggedIn) ``` The library can operate with various types of the view's state, such as `@Binding`, `@State`, `@ObservedObject` and `@EnvironmentObject`. ### 4. Trigger side effects You can simulate user interaction by programmatically triggering system-control callbacks: ```swift try sut.inspect().find(button: "Close").tap() let list = try view.inspect().list() try list[5].view(RowItemView.self).callOnAppear() ``` The library provides helpers for writing asynchronous tests for views with callbacks. ## FAQs ### Which views and modifiers are supported? Check out the [API coverage](readiness.md). ### Is it using private APIs? **ViewInspector** is using the official Swift reflection API to dissect the view structures. So it'll be production-friendly even if you could somehow ship the test target to the production. ### How do I add it to my Xcode project? Assure you're adding the framework to your unit-test target. **Do NOT** add it to the main build target. #### Swift Package Manager `https://github.com/nalexn/ViewInspector` #### Carthage `github "nalexn/ViewInspector"` #### CocoaPods `pod 'ViewInspector'` ### How do I use it in my project? Please refer to the [Inspection guide](guide.md). You can also check out my other [project](https://github.com/nalexn/clean-architecture-swiftui) that harnesses the **ViewInspector** for testing the entire UI. ### Contributions Contributions are welcomed! If you see an unsupported view or modifier, you can either open an issue (so I could prioritize such SwiftUI APIs over the rest), or try to crack it yourself: use the `print("\(Inspector.print(<#view#>) as AnyObject)")` as the starting point of the investigation. ", Assign "at most 3 tags" to the expected json: {"id":"10864","tags":[]} "only from the tags list I provide: [{"id":77,"name":"3d"},{"id":89,"name":"agent"},{"id":17,"name":"ai"},{"id":54,"name":"algorithm"},{"id":24,"name":"api"},{"id":44,"name":"authentication"},{"id":3,"name":"aws"},{"id":27,"name":"backend"},{"id":60,"name":"benchmark"},{"id":72,"name":"best-practices"},{"id":39,"name":"bitcoin"},{"id":37,"name":"blockchain"},{"id":1,"name":"blog"},{"id":45,"name":"bundler"},{"id":58,"name":"cache"},{"id":21,"name":"chat"},{"id":49,"name":"cicd"},{"id":4,"name":"cli"},{"id":64,"name":"cloud-native"},{"id":48,"name":"cms"},{"id":61,"name":"compiler"},{"id":68,"name":"containerization"},{"id":92,"name":"crm"},{"id":34,"name":"data"},{"id":47,"name":"database"},{"id":8,"name":"declarative-gui "},{"id":9,"name":"deploy-tool"},{"id":53,"name":"desktop-app"},{"id":6,"name":"dev-exp-lib"},{"id":59,"name":"dev-tool"},{"id":13,"name":"ecommerce"},{"id":26,"name":"editor"},{"id":66,"name":"emulator"},{"id":62,"name":"filesystem"},{"id":80,"name":"finance"},{"id":15,"name":"firmware"},{"id":73,"name":"for-fun"},{"id":2,"name":"framework"},{"id":11,"name":"frontend"},{"id":22,"name":"game"},{"id":81,"name":"game-engine "},{"id":23,"name":"graphql"},{"id":84,"name":"gui"},{"id":91,"name":"http"},{"id":5,"name":"http-client"},{"id":51,"name":"iac"},{"id":30,"name":"ide"},{"id":78,"name":"iot"},{"id":40,"name":"json"},{"id":83,"name":"julian"},{"id":38,"name":"k8s"},{"id":31,"name":"language"},{"id":10,"name":"learning-resource"},{"id":33,"name":"lib"},{"id":41,"name":"linter"},{"id":28,"name":"lms"},{"id":16,"name":"logging"},{"id":76,"name":"low-code"},{"id":90,"name":"message-queue"},{"id":42,"name":"mobile-app"},{"id":18,"name":"monitoring"},{"id":36,"name":"networking"},{"id":7,"name":"node-version"},{"id":55,"name":"nosql"},{"id":57,"name":"observability"},{"id":46,"name":"orm"},{"id":52,"name":"os"},{"id":14,"name":"parser"},{"id":74,"name":"react"},{"id":82,"name":"real-time"},{"id":56,"name":"robot"},{"id":65,"name":"runtime"},{"id":32,"name":"sdk"},{"id":71,"name":"search"},{"id":63,"name":"secrets"},{"id":25,"name":"security"},{"id":85,"name":"server"},{"id":86,"name":"serverless"},{"id":70,"name":"storage"},{"id":75,"name":"system-design"},{"id":79,"name":"terminal"},{"id":29,"name":"testing"},{"id":12,"name":"ui"},{"id":50,"name":"ux"},{"id":88,"name":"video"},{"id":20,"name":"web-app"},{"id":35,"name":"web-server"},{"id":43,"name":"webassembly"},{"id":69,"name":"workflow"},{"id":87,"name":"yaml"}]" returns me the "expected json"