Add SPM support with XCF #789

julepka · 2021-03-12T13:53:36Z

Introducing Swift Package Manager support with xcframework.

Details:

Created a script create_xcframewok.sh to build an xcframwork for Swift for iOS, iOSSimulator, MacOS. Basically, took it from AppSpector tutorial. The xcframework is created in the build folder. When releasing a new version, we'll need to add the generated xcframework to the release assets to have a direct link to it. Related documentation will be updated.
Added Package.swift file to support SPM. It should be placed in the root of the repo. It contains a link to the xcframework. When releasing a new version, the link should be updated with a proper version (future version you are going to release, pretty similar to carthage). So, when you create a release/tag on a GitHub you can reference a corresponding commit.
Example projects will be added in the upcoming version together with updated OpenSSL version.
I had to remove OpenSSL from SPM inside Themis.xcodeproj because of the signature issues. It failed our Carthage tests. It seems to be resolved with Xcode 12.5 that is not available for Github actions yet.

Checklist

Change is covered by automated tests – will be covered separately, added to our TODO list
The coding guidelines are followed
Example projects and code samples are up-to-date (in case of API changes) – will be covered separatly
Changelog is updated (in case of notable or breaking changes) – TODO when links are updated

vixentael · 2021-03-12T14:34:05Z

Themis.xcodeproj/project.pbxproj

+			repositoryURL = "https://github.com/julepka/openssl-apple";
+			requirement = {
+				kind = upToNextMajorVersion;
+				minimumVersion = 1.1.1080202;


Suggested change

minimumVersion = 1.1.1080202;

minimumVersion = 1.1.108203;

TODO: re-define version after merging cossacklabs/openssl-apple#22

yeah, and the link will point to the cosacklabs repo.

ilammy · 2021-03-13T04:17:04Z

Also, I should probably move the create_xcframeworks.sh script to some folder. I believe the scripts one should be good. Correct me if I'm wrong.

I think that scripts/create_xcframeworks.sh would be the right location, yes.

ilammy

Overall, looks good! Thank you, @julepka, for your brain tissue donation to the Apple Gods. I'm sorry you had to do this.

My questions from cossacklabs/openssl-apple#22 applies here as well: regarding the static/dynamic divide. Just in case Themis would need to become a static framework, or switch to shared dynamic OpenSSL, it's interesting to know how painful that would be.

Also, there are some new for Themis future specifically:

Since there is no precedent of attaching binaries to Themis releases, how that would play out in the general release flow?
Given that CLOpenSSL serves as a model example of making binary-only releases, what would become to CocoaPods and Carthage publications of Themis? Will they eventually migrate to using the same binaries as SPM, or continue building Themis from source?

ilammy · 2021-03-13T04:21:15Z

Package.swift

+            name: "themis",
+            targets: ["themis"]),
+    ],
+    dependencies: [],


At first I wanted to ask, “Where is cl-openssl?“ But then I realized that it's not here because themis.xcframework will be statically linked to openssl.xcframework, hence users of themis.xcframework don't need to install shared OpenSSL.

Package.swift

Themis.xcodeproj/project.pbxproj

create_xcframeworks.sh

ilammy · 2021-03-13T04:57:25Z

Oh, and one more thing: it would be cool to exercise the script on CI, just to be sure it will work in the time of need.

julepka · 2021-03-15T14:41:38Z

@ilammy

My questions from cossacklabs/openssl-apple#22 applies here as well: regarding the static/dynamic divide. Just in case Themis would need to become a static framework, or switch to shared dynamic OpenSSL, it's interesting to know how painful that would be.

The only thing I can say, it is very unpredictable. I've tried the most straightforward and recommended solution. I hope to make it work as an MVP for out XCF and SPM support. Then. we'll see what we can do with the linking type.

Since there is no precedent of attaching binaries to Themis releases, how that would play out in the general release flow?

Yeah, looks like we'll need to describe XCF flow in our releasing checklist. In a perfect world, CI will do everything for us, but for now, we will build and attach XCF manually. We will make XCF work and then improve whats missing.

Given that CLOpenSSL serves as a model example of making binary-only releases, what would become to CocoaPods and Carthage publications of Themis? Will they eventually migrate to using the same binaries as SPM, or continue building Themis from source?

It may be possible, but I can't say for sure right now.

Package.swift

scripts/create_xcframeworks.sh

…tra comments

julepka · 2021-04-26T14:25:04Z

I had to remove cl-openssl SPM packege from the Themis.xcodeproj because Xcode 12 has signing issues if you have a complex structure if binary frameworks dependencies. https://developer.apple.com/forums/thread/656367

It looks like the issue is fixed in Xcode 12.5 but github actions do not support it yet.

ilammy · 2021-04-27T13:01:45Z

I had to remove cl-openssl SPM packege from the Themis.xcodeproj

Hm... So it still depends on that package, but hides it so that Xcode stops eating glue? 🤔

It looks like the issue is fixed in Xcode 12.5 but github actions do not support it yet.

Well, they seem to support it in their macOS 11 image, but that one has been in “private preview mode” for quite a while.

Now that you've mentioned it, I'm kinda sad because Xcode 12.5 requires macOS 11. I'm in for a painful upgrade.

vixentael · 2021-04-27T14:21:06Z

Now that you've mentioned it, I'm kinda sad because Xcode 12.5 requires macOS 11. I'm in for a painful upgrade.

all of us... all of us 💀

CHANGELOG.md

Co-authored-by: vixentael <[email protected]>

* add SPM support with XCF * add swift SPM test project * add macOS swift SPM example, updated iOS one * updates per pr comments * removed cl-openssl from Themis.xcodeproj + edits per pr comments + extra comments * removed example projects * updated xcodeproj version * updated Package.swift * updated changelog * Update CHANGELOG.md Co-authored-by: vixentael <[email protected]> Co-authored-by: vixentael <[email protected]>

* Add SPM support with XCF (#789) * add SPM support with XCF * add swift SPM test project * add macOS swift SPM example, updated iOS one * updates per pr comments * removed cl-openssl from Themis.xcodeproj + edits per pr comments + extra comments * removed example projects * updated xcodeproj version * updated Package.swift * updated changelog * Update CHANGELOG.md Co-authored-by: vixentael <[email protected]> Co-authored-by: vixentael <[email protected]> * fixed automerge issue * fixed typo Co-authored-by: vixentael <[email protected]>

add SPM support with XCF

8bb38e1

julepka requested review from vixentael and ilammy March 12, 2021 13:53

vixentael added W-SwiftThemis 🔶 Wrapper: SwiftThemis, Swift API M-SPM Package manager: Swift Package Manager, Swift, iOS and macOS labels Mar 12, 2021

vixentael reviewed Mar 12, 2021

View reviewed changes

vixentael mentioned this pull request Mar 12, 2021

Swift Package Manager support #530

Closed

1 task

ilammy reviewed Mar 13, 2021

View reviewed changes

julepka added 4 commits April 21, 2021 18:19

add swift SPM test project

42d29fd

add macOS swift SPM example, updated iOS one

f7c8b8d

updates per pr comments

ef2db35

Merge branch 'master' into spm-xcf-support

d2967bf

julepka force-pushed the spm-xcf-support branch from 3478887 to d2967bf Compare April 23, 2021 14:16

ilammy reviewed Apr 24, 2021

View reviewed changes

removed cl-openssl from Themis.xcodeproj + edits per pr comments + ex…

f81f9e8

…tra comments

vixentael requested review from ilammy and vixentael April 27, 2021 10:32

julepka added 2 commits April 27, 2021 17:37

removed example projects

acd55c6

updated xcodeproj version

7f1bfd3

julepka changed the base branch from master to release/0.13 April 27, 2021 14:50

julepka changed the base branch from release/0.13 to master April 27, 2021 14:52

julepka added 2 commits April 28, 2021 11:25

updated Package.swift

5b3f333

updated changelog

055dd49

julepka marked this pull request as ready for review April 28, 2021 08:50

julepka requested a review from shadinua as a code owner April 28, 2021 08:50

vixentael approved these changes Apr 28, 2021

View reviewed changes

CHANGELOG.md Outdated Show resolved Hide resolved

Update CHANGELOG.md

3bcd864

Co-authored-by: vixentael <[email protected]>

julepka merged commit dbe70f2 into cossacklabs:master Apr 28, 2021

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add SPM support with XCF #789

Add SPM support with XCF #789

julepka commented Mar 12, 2021 •

edited

Loading

vixentael Mar 12, 2021

julepka Mar 12, 2021

ilammy commented Mar 13, 2021

ilammy left a comment

ilammy Mar 13, 2021

ilammy commented Mar 13, 2021

julepka commented Mar 15, 2021

julepka commented Apr 26, 2021

ilammy commented Apr 27, 2021

vixentael commented Apr 27, 2021

Add SPM support with XCF #789

Add SPM support with XCF #789

Conversation

julepka commented Mar 12, 2021 • edited Loading

Checklist

vixentael Mar 12, 2021

Choose a reason for hiding this comment

julepka Mar 12, 2021

Choose a reason for hiding this comment

ilammy commented Mar 13, 2021

ilammy left a comment

Choose a reason for hiding this comment

ilammy Mar 13, 2021

Choose a reason for hiding this comment

ilammy commented Mar 13, 2021

julepka commented Mar 15, 2021

julepka commented Apr 26, 2021

ilammy commented Apr 27, 2021

vixentael commented Apr 27, 2021

julepka commented Mar 12, 2021 •

edited

Loading