Support testing via SPM #935

HeMet · 2021-04-02T17:22:57Z

This patch adds support for testing via Xcode + SPM or SPM.

Minimum changes made for Xcode project and project structure.

SourceryLib target introduced since the linker has problem to link tests against sourcery executable.

Since SPM has no support for running scripts as part of build process, code generation for TemplatesTests moved to the test itself. That means what code generated for LinuxMain.swift is not compiled as a part of the target. This affect SPM only.

…ourcery but library, not executable. Reason: linker has problems linking test target against executable.

…abled since it needs additional configuration

…ore. Re-enable JS spec.

krzysztofzablocki · 2021-04-02T18:16:22Z

this is great 👏🙇‍♂️
it was on my list to do so we can kill the app project 🔥

krzysztofzablocki · 2021-04-02T18:37:24Z

@HeMet might need to add this setup https://github.com/muter-mutation-testing/muter/blob/master/Package.swift#L105 so that tests when run through Xcode project rather than just from console work correctly

HeMet · 2021-04-02T18:51:09Z

@HeMet might need to add this setup https://github.com/muter-mutation-testing/muter/blob/master/Package.swift#L105 so that tests when run through Xcode project rather than just from console work correctly

Thanks. I'll try.

krzysztofzablocki · 2021-04-02T19:27:53Z

Package.swift

+/// We need to manually add an -rpath to the project so the tests can run via Xcode
+/// If we are running from console (swift build & friend) we don't need to do it
+func hookInternalSwiftSyntaxParser() {
+    let isFromTerminal = ProcessInfo.processInfo.environment.values.contains("/usr/bin/swift")


use this approach of having the flag but don't use /usr/bin/swift, link to the one that's bundled in the repo as this is proper way to do it, that way the SDK matches the dylib regardless of toolchain user has

What should it check then if not /usr/bin/swift?

we don't really care about user setup for the generic sourcery use, that's why we bundle our own stuff so we don't need to rely, their setup can only affect Swift templates and there are some checks there as far as I remember

@krzysztofzablocki I understand that. I have already fixed the path the hook adds to -rpath so it points to bundled version of the library.
But what about isFromTerminal flag? You said /usr/bin/swift should not be used. So what should we check to determine if -rpath should be modified?

this use is fine, it just checks if its using swift build but it's not pulling anything from it

HeMet · 2021-04-03T20:43:00Z

Package.swift

+    if !isFromTerminal {
+        package
+            .targets
+            .filter(\.isTest)


-rpath to the bundled version of SwiftSyntax should be added to the Sourcery target too. Otherwise it won't find the library when launched during TemplatesTests.
Strangely, the same executable runs normally when launched from terminal.

…when launched during TemplatesTests.

HeMet · 2021-04-04T10:43:21Z

I don't get why CI failed. Package.swift is not part of the build process run by CI currently.

HeMet · 2021-04-08T07:05:18Z

@krzysztofzablocki Is there something I can do to push the PR forward?

krzysztofzablocki · 2021-04-08T07:23:07Z

@HeMet this is all great work 👌 and it will get merged soon, I'm just literally spending 100% of my free time on Sourcery Pro companion app atm, should be live in a week or so and then I'll get back on track on this and other pr's and issues https://twitter.com/merowing_/status/1379708785476968449?s=21

krzysztofzablocki · 2021-04-13T13:32:14Z

@HeMet there is an issue with Swift templates crashing in tests after those changes, and one blocker there which I don't think is necessarily related to tests failing is that we package Swift Runtime files into a single file for Swift Templates since they are compiled swift programs, I tried moving that logic to Package.swift but it seems I can't write to file there (permission denied).

Would you mind taking a look at those 2 things?

HeMet · 2021-04-13T15:16:56Z

Would you mind taking a look at those 2 things?

Yes, I'll investigate these issues.

krzysztofzablocki · 2021-04-13T15:24:13Z

@HeMet I spoke with someone that knows SPM really well and it seems package is sandboxed so that step will have to be manual, we can put it in rake, so if you can figure out why tests fail on swift templates we can probably move along with this pr

Add 'import Foundation'

HeMet · 2021-04-13T16:13:32Z

There was compilation issue with SourceryLibTests target, but I don't see any test failing on my machine.

that step will have to be manual, we can put it in rake,

That step is a part of Rakefile already, isn't it? task :generate_internal_boilerplate_code

krzysztofzablocki · 2021-04-13T16:15:53Z

@HeMet i think you are right in regards to tests, they fail on older commits too on my new m1 so just local config issue, as for the rake no, we need to copy code from Swift template build phase in normal Xcode project, take a look there is a script call there that generates it

SourceryBot · 2021-04-13T16:50:48Z

	1 Warning
⚠️	Big PR

Generated by 🚫 Danger

HeMet · 2021-04-13T16:59:11Z

take a look there is a script call there that generates it

Yeah, I've realized I missed that step while porting tests to SPM.

Also, I think that will help with scripting in the future https://github.com/apple/swift-evolution/blob/main/proposals/0303-swiftpm-extensible-build-tools.md For now, maybe it is too early to drop Xcode Project and switch to SPM entirely.

krzysztofzablocki · 2021-04-13T17:24:06Z

@HeMet nah, let's kill workspace and pods because it's such a hassle, can you just move that script to boilerplate rake step? I think that's all we need

HeMet · 2021-04-13T17:35:23Z

@HeMet nah, let's kill workspace and pods because it's such a hassle, can you just move that script to boilerplate rake step? I think that's all we need

Sorry, I have no experience with the rake :)

krzysztofzablocki · 2021-04-13T17:37:30Z

@HeMet that's fine I can do it, thanks for contributing this 🙇

HeMet · 2021-04-13T17:42:06Z

@HeMet that's fine I can do it, thanks for contributing this 🙇

Thanks for the great tool :)

krzysztofzablocki · 2021-05-02T09:38:09Z

included in #951

HeMet added 28 commits March 30, 2021 02:11

WIP

17cc18b

Fix path to the resources of test target

ac14a7f

Introduce SourceryLib target for testing purpose. It is the same as S…

6c965f3

…ourcery but library, not executable. Reason: linker has problems linking test target against executable.

Import main target as SourceryLib when appropriate

aa0a5d0

Re-enable specs that cause linker errors previously. JS spec left dis…

e1d462c

…abled since it needs additional configuration

Add instruction how to fix error while running tests from Xcode

095875d

No need to set ejsPath manually when framework is built with SPM anym…

a35e51e

…ore. Re-enable JS spec.

Fix file references and build settings

18df4f7

Use single define SPM that is set when the project is built by SPM

6cd1247

Add CodableContextTests

e3ecc51

Fix build when building with SPM alone

d2cb069

WIP TemplatesTests

24d77d5

Fix executable name

053c61b

Update TemplatesTests

895dd74

Fix compilation of Xcode's project

26e02d7

Add note

562dd5b

Replace SPM flag with SWIFT_PACKAGE

17af675

Revert Code signing settings

6026175

Use release version of Nimble

df18702

Point Quick to 3.0.0 version

87b2414

Optimize imports

3381803

Exclude some files

34fb840

Fix error message

be41da7

Update template

4425c59

Change wording

52e10c8

Add entry to CHANGELOG

cc48ac3

Rakefile: fix path to ejs.js

f7e3345

Rakefile: fix path to ejs.js krzysztofzablocki#2

4c76ed8

Add location of lib_InternalSwiftSyntaxParser.dylib to the -rpath

238d210

krzysztofzablocki reviewed Apr 2, 2021

View reviewed changes

HeMet added 2 commits April 2, 2021 23:56

Use bundled version of lib_InternalSwiftSyntaxParser.dylib

130c0ec

Fix Nimble dependency

dec797d

HeMet commented Apr 3, 2021

View reviewed changes

Update -rpath of executable too. Otherwise it won't find the library …

6f4273a

…when launched during TemplatesTests.

HeMet requested a review from krzysztofzablocki April 6, 2021 07:20

Merge branch 'master' into spm-tests

6acf0cc

HeMet added 2 commits April 13, 2021 19:54

Fix imports

c1ba0ff

Add 'import Foundation'

Updated bundled sources

52929d5

krzysztofzablocki force-pushed the master branch from e1b75db to 8d1ff6c Compare April 14, 2021 17:12

krzysztofzablocki mentioned this pull request Apr 28, 2021

_InternalSwiftSyntaxParser error with 1.3.0 #909

Closed

krzysztofzablocki closed this May 2, 2021

HeMet deleted the spm-tests branch May 3, 2021 10:04

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Support testing via SPM #935

Support testing via SPM #935

HeMet commented Apr 2, 2021

krzysztofzablocki commented Apr 2, 2021

krzysztofzablocki commented Apr 2, 2021

HeMet commented Apr 2, 2021

krzysztofzablocki Apr 2, 2021 •

edited

Loading

HeMet Apr 2, 2021 •

edited

Loading

krzysztofzablocki Apr 3, 2021

HeMet Apr 3, 2021

krzysztofzablocki Apr 3, 2021

HeMet Apr 3, 2021

HeMet commented Apr 4, 2021

HeMet commented Apr 8, 2021

krzysztofzablocki commented Apr 8, 2021

krzysztofzablocki commented Apr 13, 2021

HeMet commented Apr 13, 2021 •

edited

Loading

krzysztofzablocki commented Apr 13, 2021

HeMet commented Apr 13, 2021

krzysztofzablocki commented Apr 13, 2021

SourceryBot commented Apr 13, 2021

HeMet commented Apr 13, 2021 •

edited

Loading

krzysztofzablocki commented Apr 13, 2021

HeMet commented Apr 13, 2021

krzysztofzablocki commented Apr 13, 2021

HeMet commented Apr 13, 2021

krzysztofzablocki commented May 2, 2021

Support testing via SPM #935

Support testing via SPM #935

Conversation

HeMet commented Apr 2, 2021

krzysztofzablocki commented Apr 2, 2021

krzysztofzablocki commented Apr 2, 2021

HeMet commented Apr 2, 2021

krzysztofzablocki Apr 2, 2021 • edited Loading

Choose a reason for hiding this comment

HeMet Apr 2, 2021 • edited Loading

Choose a reason for hiding this comment

krzysztofzablocki Apr 3, 2021

Choose a reason for hiding this comment

HeMet Apr 3, 2021

Choose a reason for hiding this comment

krzysztofzablocki Apr 3, 2021

Choose a reason for hiding this comment

HeMet Apr 3, 2021

Choose a reason for hiding this comment

HeMet commented Apr 4, 2021

HeMet commented Apr 8, 2021

krzysztofzablocki commented Apr 8, 2021

krzysztofzablocki commented Apr 13, 2021

HeMet commented Apr 13, 2021 • edited Loading

krzysztofzablocki commented Apr 13, 2021

HeMet commented Apr 13, 2021

krzysztofzablocki commented Apr 13, 2021

SourceryBot commented Apr 13, 2021

HeMet commented Apr 13, 2021 • edited Loading

krzysztofzablocki commented Apr 13, 2021

HeMet commented Apr 13, 2021

krzysztofzablocki commented Apr 13, 2021

HeMet commented Apr 13, 2021

krzysztofzablocki commented May 2, 2021

krzysztofzablocki Apr 2, 2021 •

edited

Loading

HeMet Apr 2, 2021 •

edited

Loading

HeMet commented Apr 13, 2021 •

edited

Loading

HeMet commented Apr 13, 2021 •

edited

Loading