Generated PreviewModels swift file has no access to preview files from Swift local packages

[woutergoossens]

Context 🕵️‍♀️

We have rather big project with some local SPM local packages. In those packages we have SwiftUI screens and components.
I added Prefire to the project and package and updated a SwiftUI preview in the local package to use PrefireProvider.
But then the project generated the PreviewModels file but it has no access to

AppointmentDetailsScreen_Previews is part of Presentation package and that package isn't imported or cannot be accessed.. How can I do that?
Can I update the PreviewModels template file?

[woutergoossens]

It seems PR 21 is a possible solution? Any ETA on this?
#21

[BarredEwe]

I'm currently working on a new major release #29 with a lot of improvements. In particular, the ability to install custom imports has been added:

test_configuration:
  - target: PrefireExample
  - simulator_device: "iPhone15,2"
  - required_os: 17

playbook_configuration:
  - imports:
      - UIKit
      - Foundation

⚠️ The branch is currently under active development, but the main work has already been done and the general interface has already been fixed.

[woutergoossens]

Sounds great!
Can I already test this via SPM with your specific branch?

Our packages also have tests, is that supported? So we run the test in the main project and snapshot tests from the packages are verified?

So in test_configuration target would be just our main target?

When do you think it could be released?
I am working for a big Belgian banking company and we have more then > 100 screens and components in SwiftUi that we like to have snapshots from (and tested) :)

so would be a good usecase to test v2, right?

[BarredEwe]

I think it's really possible to use a branch now.
According to the plans, there is not much left to finish. About 1-2 weeks before the full release.
In general, it sounds great for a test and a quick revision :)

[woutergoossens]

Sounds good. Happy to test :)

I added that branch via SPM but when I run the tests I get this

[BarredEwe]

I can't reproduce it ):
Could you clear spm cache?

[woutergoossens]

Tried cleaning everything.. Same issue..
Will try in the example project later today...

[woutergoossens]

I have the same issue when I run the example app.. Let me try again clearing everything :D

Nope.. doesn't work. Should I do something extra?

[BarredEwe]

I've added a couple of changes, can you check on the new version of the branch?

[woutergoossens]

Thanks. That works :) I added it to my project and a package with SwiftUI screens.
But now I have an issue with the new macro previews.

For example it wants to generate the PreviewTests.generated file like this -->

We create that screen with a private PreviewViewModel (the VM is our ObservableObject with state and events,...)
But the generated file has no access to it.. Also we add an environmentObject to it, which is part of another package. How can I add that import for the tests? How can I fix that without making all those classes public? :)

In the old way of creating previews, it's also created like this and that works without making the VM public.

static var previews: some View {
        SplashScreen(viewModel: PreviewViewModel())
    }

[woutergoossens]

So.. tested now in the Project itself.

So in our project we have SwiftUI files in different packages (for example Presentation, DesignSwiftUI,...)

In the custom config I added extra import Presentation

playbook_configuration:
  - imports:
      - UIKit
      - Foundation
      - Presentation

PreviewModels -->
So that is working. The file is found.

• BUT the SplashScreen_Previews struct should be public, otherwise it doesn't find the file..
• Macro previews are not showed?

PreviewTests -->
Macro Previews:

• I had to remove the private from the PreviewViewModel (see previous comment).
• I get Invalid redeclaration of tests.. Those previews are only declared once.. Already cleaned all..
  It seems it cached the tests and doesn't remove/update them when I update the preview declaration?
  For example I changed/renamed the environmentObject but it keeps track of it

[BarredEwe]

I have added a new configuration:

prefire_configuration:
  - imports:
    - UIKit
    - Foundation
  - testable_imports:
    - SwiftUI

And I fixed a few bugs.

[woutergoossens]

Thanks!

Playbook (PreviewModels.generated) is working now with @testable import Presentation
But doesn't show the Macro previews?

PreviewTests is still failing because of Invalid redeclaration of 'test_SelectCoHolderTestPreview_Preview()'
Already tried to remove the SwiftUI file but it keeps the test..

What can I do to fix that? Already cleaned DerrivedData/SPM cache/...

[BarredEwe]

I hope I fixed it)

[woutergoossens]

Worked once, then it was cleaned and the method was only there once.
Then I did a change. Changed the preview macro to old PreviewProvider and the old macro stays in the PreviewTests file..

Do you need some logs or more info?

[woutergoossens]

And I tried to build it via our CI and got this issue

error: “PrefirePlaybookPlugin” must be enabled before it can be used

On Xcode I get a popup to trust the plugin.. But hmm how should we do that on CI? :)

[woutergoossens]

And I tried to build it via our CI and got this issue

error: “PrefirePlaybookPlugin” must be enabled before it can be used

On Xcode I get a popup to trust the plugin.. But hmm how should we do that on CI? :)

I think I found it.
I should use defaults write com.apple.dt.Xcode IDESkipPackagePluginFingerprintValidatation -bool YES

[BarredEwe]

Thanks! It's working!! 🥳

But I think I found an issue regarding the Macro's.

I updated the test_configuration target to AppName_STUB_Debug as this is the main App module for the tests. And so it would create the snapshots in the AppName_STUB_Debug folder, instead of the Presentation folder.

So I have 2 testable imports (via the config) + 1 import added via the target

@testable import Argenta_STUB_Debug @testable import Presentation @testable import DesignSwiftUI

But when I do that, the macro previews are not included in the PreviewTests file, only the ones from PreviewProvider. When I update the target to DesignSwiftUI or Presentation, the macro previews from the chosen package are included.

private var file: StaticString { .init(stringLiteral: "/Users/gowo/Development/**/mobile-ios/AppName_STUB_Debug/PreviewTests.swift") }

How can we fix that? :)

Almost there! Thanks for the great work and effort!

EDIT: I think we should combine all the preview bodies, not only from specified target but also from the testable import targets?

I understood the problem. I've redesigned the macro filtering system. Now it will enable all macros along the path of the main target.

[woutergoossens]

Hi,

Thanks for the update. But now it doesn't include any macro previews.. Should I update the config?
Only when I change the target name to a package name, I see the macros..

Our app folder structure. Every package has a folder in the root.

/AppName
/Presentation
/DesignSwiftUI
/...

And our main Target is something like AppName_STUB_Debug which hasn't a folder in this stucture.
AppName_STUB_Debug folder is only created to put the snapshots..

When I remove target from the config it will use "App" target. But then I get this -->

App is the target name but AppName_STUB_Debug is our product/module name for testing..

Almost there! How can I make this work?

Wouter

[woutergoossens]

Let me try create a sample app :)

[woutergoossens]

So I created an example app with 2 Swift Packages.

Presentation has an AuthView and Design has PrefireView

But here also have an issue ==>
When it creates the PreviewTests file the first time, it contains the preview macro (but only 1 per View).
But when I add some more macro previews, the PreviewTests file is not updated.. It only adds the first one from a file?

Good thing is that it adds the preview macro's from the packages

PrefireExample.zip

[BarredEwe]

Thanks for the example project! I found the problem and posted a fix.

[woutergoossens]

Thanks. Working great now. It generated 300 snapshots now of our SwiftUI Screens :)

What is the progress on the 2.0?

[BarredEwe]

Version 2.0 is almost ready. It remains to complete the tests and documentation)

[woutergoossens]

@BarredEwe Hi, thanks for version 2!

Works great locally but having issues to run it on our CI.

What am I doing wrong? I also want to look for an iphoneos folder instead of the iphonesimulator folder?

Always get this issue
Error: error: '/Users/***/actions-runner/_work/mobile-ios/mobile-ios/DerivedData/stub/Build/Intermediates.noindex/ArchiveIntermediates/Argenta stub/BuildProductsPath/STUB-Debug-iphoneos/Argenta.app' does not exist or is not readable. ** TEST INTERRUPTED ** The following build commands failed: Apply build tool plug-in “PrefireTestsPlugin” to target “AppTests” in project “Argenta” eyJ0eXBlIjp7IndvcmtzcGFjZSI6e319fQ==

[woutergoossens]

Our CI is using fastlane scan to run tests.

We also see this issue now..
So related to the plugin..

We use a custom derived_data_path https://docs.fastlane.tools/actions/run_tests/ - maybe that is the issue?

❌  error: '/Users/gowo/Development/Argenta/mobile-ios/SourcePackages/checkouts/Nimble-SnapshotTesting/_Pods.xcodeproj' does not exist or is not readable.


** TEST INTERRUPTED **


The following build commands failed:
	Apply build tool plug-in “PrefireTestsPlugin” to target “AppTests” in project “Argenta”
	eyJ0eXBlIjp7IndvcmtzcGFjZSI6e319fQ==

[woutergoossens]

I updated the example app with Fastlane support

and it seems the generated file does not use the .prefire.yml file? It doesn't contained the testable imports..
PreviewTests.generated.swift.zip

Full project with Fastlane.
Run bundle exec fastlane test
PrefireExample.zip

Testing failed:
	Cannot find 'DesignPrefireView_Preview' in scope
	Cannot find 'PresentationAuthView_Preview' in scope
	Cannot find 'DesignPrefireView' in scope
	Cannot find 'DesignPrefireView' in scope
	Cannot find 'PresentationAuthView' in scope
	Cannot find 'DesignPrefireView' in scope
	Cannot find 'PresentationAuthView' in scope
	Testing cancelled because the build failed.

Running it in Xcode works perfect..

[woutergoossens]

I think I found an initial problem. When we use Fastlane, we fetch SPM packages in a SourcePackages folder + we use a custom DerivedData folder in the root of the project. So we can clean/cache those afterwards.
The Argenta.app in DerrivedData/*... and Nimble-SnapshotTesting/_Pods.xcodeprojare aliases (that are not readable or corrupted it seems).

But the build tool plugin has issues with those files. When I update the paths (outside of the root of the project or just the default ones) it continues to build and then I have the same issue as in the example test project. The generated file does not seems to use the .prefile.yml config file (so target and testable_imports are not used..) and the test build fails.

Any idea how to make this work via Fastlane?

[woutergoossens]

Extra log:

So it looks in another DerivedData folder (in the root of the project).
Having a list of excluded folders would be the easiest I think?

[woutergoossens]

_Pods.xcodeproj.zip

If you add this file (unzipped) somewhere in the root, you will get the error.

[BarredEwe]

I'm not sure yet, but maybe this fix can help: #35 (comment)

[woutergoossens]

@BarredEwe Found a solution for my initial problem (when I run the tests via fastlane it did not find the .prefire.yml file (or didn't use it))

==> Via Fastlane I was running the tests via my App scheme but to make it work we need to run the AppTests scheme and move the .prefire.yml file to the AppTests folder. And then it works..

So only "issue" that remains is defining the correct Source folder or excluding a folder.

Thanks!