Consider the following ViewModifier:

@available(iOS 13.0, macOS 10.15, tvOS 13.0, *)
private struct InspectableTestModifier: ViewModifier, Inspectable {
    
    @Binding var flag: Bool
    
    var didAppear: ((Self.Body) -> Void)?
    
    func body(content: Self.Content) -> some View {
        HStack {
            content
            Button(
                action: { self.flag.toggle() },
                label: { Text(flag ? "true" : "false") }
            )
        }
        .onAppear { self.didAppear?(self.body(content: content)) }
    }
}

And the following test:

    func testViewModifierOnFunction() throws {
        @Binding var flag = false
        var sut = InspectableTestModifier(flag: $flag)
        let exp = sut.on(\.didAppear) { body in
            let text1 = try body.find(relation: .child, traversal: .breadthFirst, skipFound: 0) {
                try $0.text().string() == "false"
            }
            let text2 = try body.find(relation: .child, traversal: .breadthFirst, skipFound: 1) {
                try $0.text().string() == "false"
            }
            
            var label1 = try body.hStack()
                .button(1).labelView().text().string()
            var label2 = try body.hStack().modifier(InspectableTestModifier.self).hStack()
                .button(1).labelView().text().string()
            print("\(text1.pathToRoot) = \(label1)")
            print("\(text2.pathToRoot) = \(label2)")
            
            try body.hStack().button(1).tap()
            
            label1 = try body.hStack()
                .button(1).labelView().text().string()
            label2 = try body.hStack().modifier(InspectableTestModifier.self).hStack()
                .button(1).labelView().text().string()
            print("\(text1.pathToRoot) = \(label1)")
            print("\(text2.pathToRoot) = \(label2)")
        }
        ViewHosting.host(view: Circle().modifier(sut))
        wait(for: [exp], timeout: 3.2)
    }

Here's a result of running the test:

Test Suite 'Selected tests' started at 2021-05-08 15:58:43.465
Test Suite 'ViewInspectorTests.xctest' started at 2021-05-08 15:58:43.466
Test Suite 'InspectionEmissaryTests' started at 2021-05-08 15:58:43.466
Test Case '-[ViewInspectorTests.InspectionEmissaryTests testViewModifierOnFunction]' started.
hStack().button(1).labelView().text() = false
hStack().modifier(InspectableTestModifier.self).hStack().button(1).labelView().text() = false
hStack().button(1).labelView().text() = false
hStack().modifier(InspectableTestModifier.self).hStack().button(1).labelView().text() = true
Test Case '-[ViewInspectorTests.InspectionEmissaryTests testViewModifierOnFunction]' passed (0.177 seconds).
Test Suite 'InspectionEmissaryTests' passed at 2021-05-08 15:58:43.644.
	 Executed 1 test, with 0 failures (0 unexpected) in 0.177 (0.178) seconds
Test Suite 'ViewInspectorTests.xctest' passed at 2021-05-08 15:58:43.644.
	 Executed 1 test, with 0 failures (0 unexpected) in 0.177 (0.179) seconds
Test Suite 'Selected tests' passed at 2021-05-08 15:58:43.645.
	 Executed 1 test, with 0 failures (0 unexpected) in 0.177 (0.180) seconds
Program ended with exit code: 0

I've been chasing this for a couple weeks and cannot unravel this mystery.

Question #1, do you have any idea why the view generates the second instance of the label?

Question #2, do you have any idea why the second instance of the label has the root-to-path that it has?

Question #3, why does the button tap change the second instance of the label, but not the first?

@nalexn I have created this PR with the changes I made to InspectionEmissary to support view modifiers. It works great. However, the testViewModifierOnFunction test fails. I left it this way on purpose in order that you can look at the difference between this and the InspectionEmissaryForViewModifier. I do not see a difference. I dumped the body of the modifier in the debugger, and they seem identical and cannot ascertain why the ViewInspector would treat them differently.

Hi! Awesome work here, thank you! Given this view and its test:

struct DetailView: View {
    var body: some View {
        EmptyView()
        .navigationBarItems(trailing: Text("Done")) // commenting this makes the test run fine.
    }
}

func testNavigationBarItems() {
  expect {
    // expected to not throw any error, got <notSupported("Please use \'navigationBarItems()\' for unwrapping the underlying view hierarchy.")>
    try detailView.body.inspect().emptyView()
  }.notTo(throwError())
  expect {
    // expected to not throw any error, got <modifierNotFound(parent: "DetailView", modifier: "navigationBarItems")>
    try detailView.inspect().navigationBarItems().emptyView()
  }.notTo(throwError())
}

Is this not supported, or am I missing something?

I am on Xcode 12.2 beta and I could not install the package. After following the steps described in the documentation the "Finish" button did not become highlighted. Is this a known issue?

Thanks

Hi @nalexn do you know if it is possible to click on an alert view button

struct ContentView: View {
    
    @State private var showingAlert = false

    var body: some View {
        Button("Show Alert") {
            showingAlert = true
        }
        .alert(isPresented: $showingAlert) {
            Alert(title: Text("Important message"), message: Text("Wear sunscreen"), dismissButton: .default(Text("Got it!")))
        }
    }

}

what I've tried

    func testClickOnAlertButton() throws {
        // Given
        let view = ContentView()
        ViewHosting.host(view: view)
        
        let button = try view.inspect()
            .find(ContentView.self)
            .find(text: "Got it!")
            
        print(button)
    }

How do I click on the Got it! button?

Hello,

I've experiencing an issue writing SwiftUI unit tests on macOS 10.5.7 and 11.2.1, Xcode Version 12.4 (12D4e).

A simple view:

import SwiftUI

struct ContentView: View {
    var body: some View {
        Text("Hello, World!")
    }
}

with a simple test case:

import XCTest
import ViewInspector

@testable import ViewInspectorIssue

extension ContentView: Inspectable { }

class ContentViewTests: XCTestCase {

    func testExample() throws {
        let sut = ContentView()
    }

}

fails to compile with the error:

xctest (19241) encountered an error...
...Underlying Error: The bundle “ViewInspectorIssueTests” couldn’t be loaded. The bundle couldn’t be loaded...
...Symbol not found: _$s7SwiftUI16PageTabViewStyleV16IndexDisplayModeVM...

So, I cloned the repository and discovered those struct's are not being marked unavailable or ignored for macOS builds.

I think the lines with:

@available(iOS 14.0, tvOS 14.0, *)
@available(macOS, unavailable)
...

Should be:

#if canImport(UIKit)
@available(iOS 14.0, tvOS 14.0, *)
...
#endif

To test that theory, I've made those modifications locally and added the local repository using Xcode package manager with expected build results. :)

After I'd added ViewInspector, Live Preview on Device stopped working, it seems:

linker command failed with exit code 1 (use -v to see invocation)

Build target ViewInspector:
note: Set ENABLE_PREVIEWS=NO because SWIFT_OPTIMIZATION_LEVEL=-O, expected -Onone (in target 'ViewInspector' from project 'Pods')


Link ViewInspector (arm64):
ld: '/Applications/Xcode.app/Contents/Developer/Platforms/iPhoneOS.platform/Developer/Library/Frameworks/XCTest.framework/XCTest' does not contain bitcode. You must rebuild it with bitcode enabled (Xcode setting ENABLE_BITCODE), obtain an updated library from the vendor, or disable bitcode for this target. file '/Applications/Xcode.app/Contents/Developer/Platforms/iPhoneOS.platform/Developer/Library/Frameworks/XCTest.framework/XCTest' for architecture arm64
clang: error: linker command failed with exit code 1 (use -v to see invocation)

The regular Live Preview is working fine though

Xcode version: 11.4 Swift version: 5.1 Cocoapods version: 1.9.1

Hello there!!

I'm trying add this package into my project to SwiftUI tests targets, and I've found the error below:

I tried use this package with Swift package manager and with Cocoapods, and the library is not found with both package managers. I've tried import this package in two targets: Unit and UI Tests, and the problem is the same for both.

I've added another library to my Xcode 11 project/workspace and works great!

Do you know what I'm doing wrong?

I have the following view, in which an optional Text view is toggled in and out of visibility when the button is tapped:

struct MyView: View {

    @State var showErrorMessage = false

    var body: some View {
        VStack {
            Button(action: {
                self.showErrorMessage.toggle()
                print("showErrorMessage = \(self.showErrorMessage)")
            }) {
                Text("Click me.")
            }

            if showErrorMessage {
                Text("ERROR")
                    .foregroundColor(Color.red)
            }
        }
    }
}

I am trying to test the optional view with the following:

it("should show an error message when the button is pressed") {
        do {
            let view = MyView()
            let button = try view.inspect().vStack().button(0)

            try button.tap()

            let errorMessage = try view.inspect().vStack().text(1).string()

            expect(view.showErrorMessage).to(beTrue())
            expect(errorMessage).to(equal("ERROR"))
        } catch {
            fail("failure - \(error)")
        }
 }

The test fails on both assertions, as the showErrorMessage property remains false and the optional Text view remains hidden. Additionally, showErrorMessage = false is printed to the console when try button.tap() is called.

When I run the code in the UI simulator, it works as expected; the Text view is toggled in and out of visibility and the correct value of showErrorMessage is printed to the console.

Is there something I'm missing that's causing the different behavior in the test versus the UI simulator?

Hi there.

So I know there exists a way to inspect the view hierarchy for a particular UI component by specifying the view hierarchy explicitly, such as try view.inspect().vStack().button(0). However, to avoid exposing implementation details of the view hierarchy in my tests, I'd instead like to determine if there exists a UI component within a view hierarchy that matches some constraint.

For example, say there is a landing screen with a view hierarchy that contains a sign-in button along with other UI components. In my test, I'd like to verify that there exists a button with the text, "Sign In," rather than specifying the view hierarchy explicitly and thereby exposing implementation details.

Is there any way to do this? Much appreciated.

It appears that because the path for accessibilityLabel() uses elements|some, I always get a thrown error when trying to read it. In my inspection of the inspector (sorry!) I have the following modifier:

    ▿ modifier : AccessibilityAttachmentModifier
      ▿ attachment : Optional<AccessibilityAttachment>
        ▿ some : AccessibilityAttachment
          ▿ properties : AccessibilityProperties
            ▿ plist : [TypedValueKey = Optional(SwiftUI.AccessibilityValue(value: nil, description: Optional(SwiftUI.Text(storage: SwiftUI.Text.Storage.verbatim("123456789012"), modifiers: [])))), LabelKey = Optional(SwiftUI.Text(storage: SwiftUI.Text.Storage.verbatim("UPCA product code"), modifiers: [])), TraitsKey = AccessibilityTraitStorage(mask: SwiftUI.AccessibilityTraitStorage.(unknown context at $7fff2c6c4d64).TraitSet(rawValue: 288), values: SwiftUI.AccessibilityTraitStorage.(unknown context at $7fff2c6c4d64).TraitSet(rawValue: 288))]
              ▿ elements : Optional<Element>
                ▿ some : TypedValueKey = Optional(SwiftUI.AccessibilityValue(value: nil, description: Optional(SwiftUI.Text(storage: SwiftUI.Text.Storage.verbatim("123456789012"), modifiers: []))))

As you can see, LabelKey is in plist, but does not appear in plist.elements.some. Only my accessibilityValue() is in elements. Since accessibilityValue() is also in plist, I think the appropriate fix is to simply chop off elements|some in the path for accessibilityElement(_::::)

Before I get to the problem let me explain my motivation. The library I'm writing handles navigation, so the tests for it involve creating an absurd number of views that are unique to a given test. The problem is that find (and, for that matter, some other inspection methods) no longer work due to the regex check on type names.

Here is a test that reproduces the problem:

func testViewContainerWithNestedGenericParameter() throws {
    struct ViewWrapper<V: View>: View {
        @ViewBuilder var view: () -> V
        init(@ViewBuilder view: @escaping () -> V) {
            self.view = view
        }
        var body: some View {
            view()
        }
    }
    let sut = try ViewWrapper {
        ViewWrapper {
            Text("findme")
        }
    }.inspect()
    XCTAssertNoThrow(try sut.find(ViewWrapper<ViewWrapper<Text>>.self))
    XCTAssertNoThrow(try sut.find(ViewWrapper<Text>.self))
}

Here is the commit that caused the problem: https://github.com/nalexn/ViewInspector/commit/22a48cec7ca25851a79b500e91d70893f76ae462

I've verified in a fork that reverting this commit gets me back to the old, functioning behavior.

I have another problem with find and generics that likely has a similar cause, but I'm having trouble creating a minimally reproducible example.

I am developing using Xcode 14.1 on macOS 13.1. My Mac has an M1 processor. I opened the Package.swift and ran the tests (Cmd + u) for the iPhone 14 Pro simulator on the HEAD SHA of the master branch (ac7df67c4e0593470eda90a550f8493a81609745). I encounter a crash in TimelineViewTests.testEnclosedView().

Hi @nalexn

I want test code which should call in onDisappear function. But for me isn't possible to call this func from the test.

I try this here

try sut.inspect().callOnDisappear()
XCTAssertEqual(makeSUTResult.cameraSettingsDelegateSpy.storeCameraSettingsCount, 1)

But I get always this error

failed: caught error: "CameraView does not have 'onDisappear' modifier"

I added the onDisappear to my view which I'm testing.

How I can write a test for my use case?

Thank you

I have a view which has a NavigationStack around it.

var body: some View {
return NavigationStack {
            VStack {
                Text("Hello")
                ..........
            }

Now when trying to find the text "Hello" via (I use quick and nimble for testing, but XCTest gives the same result)

                expect(try homeView.inspect()
                    .find(text: "Hello")
                ).toNot(beNil())

it gives me a failed test. When removing the NavigationStack the test succeeds. Also when adding a tag to the NavigationStack as .tag property and print the output of

expect(try homeView.inspect()
                    .find(viewWithTag: "NavigationStack")

(this test also succeeds)

it gives me the whole hierarchy which clearly shows (SwiftUI.Text(storage: SwiftUI.Text.Storage.anyTextStorage(<LocalizedTextStorage: 0x00006000010656d0>: "Hello") at some point inside of it.

Am I missing something or is there a bug when traversing through Views wrapped in a NavigationStack via ViewInspector?

This is an amazing library. Wow!

I am learning how this library works and I have a question about the Inspectable protocol.

Let's say I have a toy SwiftUI view setup like this:

import SwiftUI

struct MyScreen: View {
  var body: some View {
    MyTextWrapperView(title: "Hello world")
  }
}

struct MyTextWrapperView: View {
  let title: String

  var body: some View {
    Text(title)
  }
}

And then let's say I want to verify that my screen shows the string "Hello world" somewhere at any level of the hierarchy. I'd write that test like this:

import ViewInspector
import XCTest

final class MyScreenTests: XCTestCase {
  func test_verifyTextPresence() {
    XCTAssertNoThrow(try MyScreen().inspect().find(text: "Hello world"))
  }
}

I find that for this to to pass I need to conform both MyScreen and MyTextWrapperView to Inspectable.

extension MyScreen: Inspectable { }
extension MyTextWrapperView: Inspectable { }

When building infrastructure for a large codebase it can be challenging to ensure that all of the expected views conform to Inspectable. I was hoping that ViewInspector's find(text:) would work out of the box without any view needing to be conformed to Inspectable. I don't mind needing to conform MyScreen to Inspectable; the part that is more difficult to reason about is the need to conform child view types, like MyTextWrapperView, used within the hierarchy.

I am trying to understand the reason why the Inspectable conformance is necessary. I see that the Inspectable protocol has one property and one method, and that there's a default implementation for each when Self: View. However I haven't been able to find any documentation as to why the Inspectable protocol is necessary.

Thanks again for filling this huge gap in the SwiftUI ecosystem which such a thoughtfully built library 😄