Not only my views appear in the generated file

[lalka-anka]

Hi! We have a multi-module project, I upload dependencies via tuist, everything works correctly: PrefireTestsPlugin is installed for the desired target, but during the test run, snapshots for authView, circleImage and others also appear in the PreviewTests.geneated file. Can you tell me why this is happening?
At the same time, if you abstract and use dependencies in a small sample project, then everything works great.

This is my generated file:

// Generated using Sourcery 2.1.3 — https://github.com/krzysztofzablocki/Sourcery
// DO NOT EDIT
// swiftlint:disable all
// swiftformat:disable all

import XCTest
import SwiftUI
import Prefire
@testable import SnapshotTesting
#if canImport(AccessibilitySnapshot)
    import AccessibilitySnapshot
#endif
@testable import MyTarget

class PreviewTests: XCTestCase {
    private let deviceConfig: ViewImageConfig = .iPhoneX
    private var simulatorDevice: String? = "iPhone15"
    private var requiredOSVersion: Int?

    private var file: StaticString { .init(stringLiteral: "somePath") }

    override func setUp() {
        super.setUp()

        checkEnvironments()
        UIView.setAnimationsEnabled(false)
    }

    // MARK: - PreviewProvider

    func test_authView_Preview() {
        for preview in AuthView_Preview._allPreviews {
            if let failure = assertSnapshots(matching: preview) {
                XCTFail(failure)
            }
        }
    }

    func test_circleImage() {
        for preview in CircleImage_Previews._allPreviews {
            if let failure = assertSnapshots(matching: preview) {
                XCTFail(failure)
            }
        }
    }

    func test_greenButton() {
        for preview in GreenButton_Previews._allPreviews {
            if let failure = assertSnapshots(matching: preview) {
                XCTFail(failure)
            }
        }
    }

    func test_prefireView_Preview() {
        for preview in PrefireView_Preview._allPreviews {
            if let failure = assertSnapshots(matching: preview) {
                XCTFail(failure)
            }
        }
    }

    func test_testViewWithoutState() {
        for preview in TestViewWithoutState_Previews._allPreviews {
            if let failure = assertSnapshots(matching: preview) {
                XCTFail(failure)
            }
        }
    }

    func test_testView() {
        for preview in TestView_Previews._allPreviews {
            if let failure = assertSnapshots(matching: preview) {
                XCTFail(failure)
            }
        }
    }
    // MARK: Private

    private func assertSnapshots(matching preview: _Preview, testName: String = #function) -> String? {
        assertSnapshots(
            matching: AnyView(preview.content),
            name: preview.displayName,
            isScreen: preview.layout == .device,
            device: preview.device?.snapshotDevice() ?? deviceConfig,
            testName: testName
        )
    }

    private func assertSnapshots(matching view: AnyView, name: String?, isScreen: Bool, device: ViewImageConfig, testName: String = #function) -> String? {
        var delay: TimeInterval = 0
        var precision: Float = 1
        var perceptualPrecision: Float = 1

        let view = view
            .onPreferenceChange(DelayPreferenceKey.self) { delay = $0 }
            .onPreferenceChange(PrecisionPreferenceKey.self) { precision = $0 }
            .onPreferenceChange(PerceptualPrecisionPreferenceKey.self) { perceptualPrecision = $0 }

        let matchingView = isScreen ? AnyView(view) : AnyView(view
            .frame(width: device.size?.width)
            .fixedSize(horizontal: false, vertical: true)
        )

        let failure = verifySnapshot(
            of: matchingView,
            as: .prefireImage(precision: { precision }, perceptualPrecision: { perceptualPrecision }, duration: { delay }, layout: isScreen ? .device(config: device) : .sizeThatFits),
            named: name,
            file: file,
            testName: testName
        )

        #if canImport(AccessibilitySnapshot)
            let vc = UIHostingController(rootView: matchingView)
            vc.view.frame = UIScreen.main.bounds
            assertSnapshot(
                matching: vc,
                as: .wait(for: delay, on: .accessibilityImage(showActivationPoints: .always)),
                named: name.flatMap { $0 + ".accessibility" },
                file: file,
                testName: testName
            )
        #endif
        return failure
    }

    /// Check environments to avoid problems with snapshots on different devices or OS.
    private func checkEnvironments() {
        if let simulatorDevice {
            let deviceModel = ProcessInfo().environment["SIMULATOR_MODEL_IDENTIFIER"]
            guard deviceModel?.contains(simulatorDevice) ?? false else {
                fatalError("Switch to using \(simulatorDevice) for these tests.")
            }
        }

        if let requiredOSVersion {
            let osVersion = ProcessInfo().operatingSystemVersion
            guard osVersion.majorVersion == requiredOSVersion else {
                fatalError("Switch to iOS \(requiredOSVersion) for these tests.")
            }
        }
    }
}

// MARK: - SnapshotTesting + Extensions

private extension PreviewDevice {
    func snapshotDevice() -> ViewImageConfig? {
        switch rawValue {
        case "iPhone 15", "iPhone 14", "iPhone 13", "iPhone 12", "iPhone 11", "iPhone 10":
            return .iPhoneX
        case "iPhone 6", "iPhone 6s", "iPhone 7", "iPhone 8":
            return .iPhone8
        case "iPhone 6 Plus", "iPhone 6s Plus", "iPhone 8 Plus":
            return .iPhone8Plus
        case "iPhone SE (1st generation)", "iPhone SE (2nd generation)":
            return .iPhoneSe
        default: return nil
        }
    }
}

private extension Snapshotting where Value: SwiftUI.View, Format == UIImage {
    static func prefireImage(
        drawHierarchyInKeyWindow: Bool = false,
        precision: @escaping () -> Float,
        perceptualPrecision: @escaping () -> Float,
        duration: @escaping () -> TimeInterval,
        layout: SwiftUISnapshotLayout = .sizeThatFits,
        traits: UITraitCollection = .init()
    ) -> Snapshotting {
        let config: ViewImageConfig

        switch layout {
        #if os(iOS) || os(tvOS)
        case let .device(config: deviceConfig):
            config = deviceConfig
        #endif
        case .sizeThatFits:
            config = .init(safeArea: .zero, size: nil, traits: traits)
        case let .fixed(width: width, height: height):
            let size = CGSize(width: width, height: height)
            config = .init(safeArea: .zero, size: size, traits: traits)
        }

        return SimplySnapshotting<UIImage>(pathExtension: "png", diffing: .prefireImage(precision: precision, perceptualPrecision: perceptualPrecision, scale: traits.displayScale))
            .asyncPullback { view in
                var config = config

                let controller: UIViewController

                if config.size != nil {
                    controller = UIHostingController(rootView: view)
                } else {
                    let hostingController = UIHostingController(rootView: view)

                    let maxSize = CGSize.zero
                    config.size = hostingController.sizeThatFits(in: maxSize)

                    controller = hostingController
                }

                return Async<UIImage> { callback in
                    let strategy = snapshotView(
                        config: config,
                        drawHierarchyInKeyWindow: drawHierarchyInKeyWindow,
                        traits: traits,
                        view: controller.view,
                        viewController: controller
                    )

                    let duration = duration()
                    if duration != .zero {
                        let expectation = XCTestExpectation(description: "Wait")
                        DispatchQueue.main.asyncAfter(deadline: .now() + duration) {
                            expectation.fulfill()
                        }
                        _ = XCTWaiter.wait(for: [expectation], timeout: duration + 1)
                    }
                    strategy.run(callback)
                }
            }
    }
}

private extension Diffing where Value == UIImage {
    static func prefireImage(precision: @escaping () -> Float, perceptualPrecision: @escaping () -> Float, scale: CGFloat?) -> Diffing {
        lazy var originalDiffing = Diffing.image(precision: precision(), perceptualPrecision: perceptualPrecision(), scale: scale)
        return Diffing(
            toData: { originalDiffing.toData($0) },
            fromData: { originalDiffing.fromData($0) },
            diff: { originalDiffing.diff($0, $1) }
        )
    }
}

[woutergoossens]

I had the same issue. When we build our project via Fastlane the DerivedData + SourcePackages folder is created in the root of the project. The PrefireTestsPlugin seems to use those files and add it to the generated PreviewTests file.

[lalka-anka]

How did you fix this? via .prefire.yml file?

[woutergoossens]

How did you fix this? via .prefire.yml file?

Our .prefire.yml file is not used when I use Fastlane (see other discussion).
But can you check if no source files other other things are downloaded to the root of your project? These are picked up by the plugin..

@BarredEwe Maybe you can add an excluded_folders config?

[BarredEwe]

Sourcery does not support setting exclude_path via commands, only via config. Of course, we can implement config generation for Sourcery, but I would like a simpler solution)

[woutergoossens]

Ok no problem. I think I found another solution so the proposed fix in PR works and can me merged.
I need to add plugin support (in the test target) to every SPM package and add those to the original test plan and then it seems to work and it builds to correct tests.

Thanks!

[BarredEwe]

Can you please attach the log file?

Logs can be taken here:

[BarredEwe]

Can you try to use a pre-fix (only for PrefireTestsPlugin) from exactSourceInstallation branch?

[BarredEwe]

I have updated the branch, can you please attach such a log?

[woutergoossens]

@BarredEwe Updated.
Now it only checks the App/Source folder..
➜ Sources path: /Users/gowo/Development/Argenta/mobile-ios/Argenta/App/Source/

But the root of my project also contains other folders (from local packages etc) which it included before..

I think searching in the full directory as before was OK but we need to exclude some folders..

Now it includes

/App/Sources (main app)

But also need

/Design
/Presentation

...

[woutergoossens]

I used that branch in the test project ==>

Sources path: /Users/gowo/Downloads/PrefireExample/PrefireExample/

Only /PrefireExample folder was included

Test project ==>
PrefireExample.zip

[woutergoossens]

Let me know if I can help, so we can make this work on the CI/Fastlane :)
Already > 300 preview snapshots ready so would be a great tool for us!

[lalka-anka]

Do I understand correctly that in order for the test plugin to work correctly, I just need to take the exactSourceInstallation branch and not do any additional work? I just did that, but I keep sprouting views from example

update: we discussed the details of my problem in the messages, I hope that we will soon understand what is the matter

[lalka-anka]

I solved my problem by creating a local dependency and deleting the Example folder
Thank you all for your help!