Xcode error "No such module 'CSQLite'" when embedding GRDB as a Swift package

[janine-knowink]

What did you do?

Added GRDB to my iOS app via the Swift package manager and added one "import GRDB" (nothing else). The project builds fine, but the tests fail to link with the error "Missing required module 'CSQLite'" on every file which includes "@testable import "

I made a demo project where I just added GRDB and imported it into ContentView.swift. This exhibited the problem. I then found and installed the CSQLite package and imported that also into ContentView.swift, but the problem remains.

What did you expect to happen?

If the main project builds ok, the tests should also.

What happened instead?

Described above.

Environment

GRDB flavor(s): (GRDB, SQLCipher, Custom SQLite build?)

Just GRDB

GRDB version:

4.5.0 "up to next major"

Installation method: (CocoaPods, SPM, manual?)

SPM

Xcode version:

11.1

Swift version:

5

Platform(s) running GRDB: (iOS, macOS, watchOS?)

iOS

macOS version running Xcode:

10.15.1

Demo Project

GRDBTest.zip

[groue]

Hello @janine-knowink,

Thanks for the report and the demo project. The solution is to remove CSQLite from the packages of your Xcode project.

[janine-knowink]

Sorry if I was not clear - the problem happens without CSQLite installed. I had installed it only to see if it would help, but it did not.

My co-worker worked around the problem by adding GRDB to the "Link Binary With Libraries" build rule for our test target, but it seems like that should not be required? GRDB isn't even used in any of the tests, it's only coming in via the testable import of the main project. And I haven't needed to add any of the packages which are used in the tests, so this seems wrong to me.

[groue]

Sorry if I was not clear

The attached demo projets starts successfully compile (both app target, and test target) after I have removed CSQLite from SPM packages.

My co-worker worked around the problem by adding GRDB to the "Link Binary With Libraries" build rule for our test target. but it seems like that should not be required?

GRDB has to be linked to the target(s) that uses it. That is normal.

Now I don't know if you talk about your application or test target. It your tests needs some objects that need GRDB indirectly, then yes your tests need GRDB.

But let's focus: the Missing required module 'CSQLite' error means that something is still referring to CSQLite. But whatever is referring to CSQLite should stop:

• GRDB 4.5.0 does not refer to CSQLite.
• Your app may still refer to CSQLite (see my previous comment).
• Some Xcode caches may also still refer to CSQLite: clean up everything, erase your Derived Data folder.

Make sure nothing at all refers to CSQLite, anywhere. This should remove your issue.

[janine-knowink]

There must be something different between your setup and mine. I tried again to build my sample app:

I deleted derived data:

janine@casey DerivedData % ls -d GRDBTest*
GRDBTest-gbrvwpmiukkzeidfvbfvrdyztjly	GRDBTest-gcxqjzigycqhyzbevkrwyhbcvuoe
janine@casey DerivedData % rm -rf GRDBTest*
janine@casey DerivedData % !ls
ls -d GRDBTest*
zsh: no matches found: GRDBTest*

Checked for references to CSQLite:

janine@casey GRDBTest % cd ~/Desktop/GRDBTest
janine@casey GRDBTest % find . -type f -exec fgrep CSQLite {} \;

Also verified that it's not being included by the package manager.

Closed the app window in Xcode and reopened it so that the package manager would check out GRDB again, and then built. Building the app works, but building the tests still fails with "Missing required module 'CSQLite'".

In order to get the tests to build, I have to comment out the setup function, which uses GRDB, the import of GRDB, and the testable import of the main app.

In our real app, this happens even though GRDB is not used at all in the tests. We get the error about CSQLite simply from the testable import of the main app, where it is used, and the only way to get rid of it is to manually link GRDB for the tests.

I am using Xcode 11.1 and macOS 10.15.1. Are you using something different?

[groue]

All right @janine-knowink, let's reopen the issue. GRDB used to depend on a CSQLite package, and this dependency has been removed in #627. I may have not done this properly: I'll check it.

Meanwhile, I suggest you downgrade GRDB to 4.4.0.

[groue]

After further investigation, I still can not reproduce your issue. I'll keep this open a few days, in order to let you exhibit a way to reproduce the "Missing required module 'CSQLite'" error. For example, make your demo project fail with this error. Meanwhile, I personally stop doing any investigation.

[janine-knowink]

The issue seems to exist only in Xcode 11.1. Using 11.2 the tests build and run fine. I have no idea why it's different, but that is what I am seeing.

[groue]

Good! Maybe Xcode 11.1 had a bug that was solved in Xcode 11.2? We'll never know. Thanks for telling.

[groue]

For the record, this conversation may contain interesting hints, provided we are able to reproduce the "Missing required module 'CSQLite'" error. Left as an exercice for the unfortunate.

[ApplebaumIan]

I'm now receiving this bug as well on Xcode Version 11.2.1 (11B500) using the SPM.

What did you expect to happen?

If the main project builds ok, the tests should also. Tests break on the server during integration testing and on local Mac

What happened instead?

Environment

GRDB flavor(s): (GRDB, SQLCipher, Custom SQLite build?)

Just GRDB

GRDB version:

4.5.0 "up to next major"

Installation method: (CocoaPods, SPM, manual?)

SPM

Xcode version:

11.2.1

Swift version:

5

Platform(s) running GRDB: (iOS, macOS, watchOS?)

iOS

macOS version running Xcode:

10.14.5

The build only fails for testing.
Build target ColorAssistantTests_2019-11-27T18-38-16.txt
Build target ColorAssistantUITests_2019-11-27T18-38-16.txt