Rework the installation examples #8289

tgoyne · 2023-06-30T22:38:37Z

The installation examples were originally created when there was just iOS and macOS and cross-platform Apps weren't a thing, and the approach that worked then has turned into a giant mess. Consolidating (almost) all the installation tests into a single codebase with separate project files per installation method cuts the amount of code involved by 90% and makes adding more platforms relatively painles cuts the amount of code involved by 90% and makes adding more platforms relatively painless.

Separate obj-c and Swift tests have not proven to have any value. We've never had any bugs caught specifically by the obj-c test which wasn't also caught by the swift test other than ones specifically related to the obj-c release zip, so now everything except for the obj-c only iOS static framework is tested only via Swift.

Some of the tests ended up just plain being redundant; we had separate XCFramework and fat framework tests, but then the fat framework tests had to be ported to use XCFrameworks.

Running the smoke tests in the simulator has never actually caught a bug and doubles the amount of things to build (and adds the requirement to reset the simulators, which takes a while), so ditch that and only test archiving the app for device.

The CocoaPods transitive dependency test is now done as part of the normal cocoapods tests rather than a separate one.

All platforms are now tested via Xcode SPM rather than only iOS. tvOS is now tested for all installation methods (previously it was not tested at all due to how much of a hassle adding platforms was).

visionOS is now tested when using Xcode 15 (i.e. it still isn't actually tested on CI). Currently only the SPM installation method supports visionOS. Cocoapods is actively working on adding support, and XCFramework support is only blocked on us cutting a release with it.

This was using a very, very old version of ReactiveCocoa from 2015 and hasn't been applicable to any maintained versions of it for a very long time.

tgoyne · 2023-07-03T16:12:18Z

.jenkins.yml

@@ -17,7 +17,7 @@ target:
 - swiftpm-debug
 - swiftpm-address
 - swiftpm-thread
- - swiftpm-ios
+ - ios-xcode-spm


This renaming is a lazy way to get it to stop installing baas for these tests.

tgoyne · 2023-07-03T16:13:55Z

build.sh

        cd examples/installation
-        sh build.sh "test-osx-swift-xcframework"
+        REALM_XCODE_VERSION=$REALM_XCODE_LATEST_VERSION ./build.rb osx xcframework


The XCFramework test now uses the framework sitting in the build directory if it's not asked to fetch a release, so we can reuse it for this test rather than needing a separate target.

tgoyne · 2023-07-03T16:14:25Z

build.sh

        ;;

    verify-cocoapods-ios-dynamic)
-        PLATFORM=$(echo "$COMMAND" | cut -d - -f 3)
-        # https://github.com/CocoaPods/CocoaPods/issues/7708
-        export EXPANDED_CODE_SIGN_IDENTITY=''


The bug this was working around was fixed a while ago.

tgoyne · 2023-07-03T16:15:02Z

build.sh

@@ -735,21 +706,6 @@ case "$COMMAND" in
        exit 0
        ;;

-    "verify-osx-swift")


All these verify- targets which just forward to the test- target are now covered by a verify-* target.

The installation examples were originally created when there was just iOS and macOS and cross-platform Apps weren't a thing, and the approach that worked then has turned into a giant mess. Consolidating (almost) all the installation tests into a single codebase with separate project files per installation method cuts the amount of code involved by 90% and makes adding more platforms relatively painles cuts the amount of code involved by 90% and makes adding more platforms relatively painless. Separate obj-c and Swift tests have not proven to have any value. We've never had any bugs caught specifically by the obj-c test which wasn't also caught by the swift test other than ones specifically related to the obj-c release zip, so now everything except for the obj-c only iOS static framework is tested only via Swift. Some of the tests ended up just plain being redundant; we had separate XCFramework and fat framework tests, but then the fat framework tests had to be ported to use XCFrameworks. Running the smoke tests in the simulator has never actually caught a bug and doubles the amount of things to build (and adds the requirement to reset the simulators, which takes a while), so ditch that and only test archiving the app for device. The CocoaPods transitive dependency test is now done as part of the normal cocoapods tests rather than a separate one. All platforms are now tested via Xcode SPM rather than only iOS. tvOS is now tested for all installation methods (previously it was not tested at all due to how much of a hassle adding platforms was). visionOS is now tested when using Xcode 15 (i.e. it still isn't actually tested on CI).

tgoyne · 2023-07-04T05:14:30Z

Passing release pipeline with these changes: https://ci.realm.io/blue/organizations/jenkins/cocoa-pipeline/detail/cocoa-pipeline/2090/pipeline

dianaafanador3

LGTM! Great work, the new build installation script is easier to understand now, and reworking the installation example removes a lot of files which is also nice. Some questions and minor comments.

dianaafanador3 · 2023-07-06T15:26:43Z

examples/installation/SwiftPackageManager.notxcodeproj/project.pbxproj

If we use notxcodeproj so Carthage cannot see it. But how we later test the projec (installation method)t specifically?

build.rb symlinks SwiftPackageManager.notxcodeproj to SwiftPackageManager.xcodeproj, which is gitignored so that we don't accidentally commit it.

dianaafanador3 · 2023-07-10T14:40:37Z

Jenkinsfile.releasability

@@ -5,30 +5,23 @@ platformNames = ['osx': 'macOS', 'ios': 'iOS', 'watchos': 'watchOS', 'tvos': 'tv
 carthageXcodeVersion = '14.3.1'
 docsSwiftVersion = '5.8.1'

-def installationTest(platform, test, language) {


I know you tested this for a release, how do you do it without actually posting a release?

This is part of the cocoa-pipeline job, so it happens after building the release but before publishing it, so I just ran it on this branch. There's also post-release testing which validates that the published release works, and that'll probably need some fiddling to fix after merging this since it's hard to validate now.

dianaafanador3 · 2023-07-10T15:11:49Z

Jenkinsfile.releasability

-      for (def test in ["dynamic", "cocoapods", "carthage"]) {
-        parallelBuilds["Installation - ${platformName} Swift ${test}"] = installationTest(platform, test, 'swift')
-      }
+    parallelBuilds['Installation - iOS Static'] = installationTest('ios', 'xcframework', carthageXcodeVersion, 'objc', 'static')


Seems like this the only installation test we are doing for obj-s, is that what we are supposed to be doing?

Installing the Swift SDK only works if the obj-c SDK successfully installs, so in practice every time we've had something break the obj-c installation it's been caught by the Swift tests and separately testing obj-c as well hasn't been useful. The static framework needs to test obj-c directly because we don't ship a static Swift framework.

dianaafanador3 · 2023-07-10T15:34:16Z

Jenkinsfile.releasability

-      }
+    parallelBuilds['Installation - iOS Static'] = installationTest('ios', 'xcframework', carthageXcodeVersion, 'objc', 'static')
+    parallelBuilds['Installation - XCFramework Evolution'] = xcframeworkEvolutionTest()
+    for (def version in xcodeVersions) {


Isn't this duplicating testing

installationTest('osx', 'xcframework', version, 'swift', ‘dynamic’)
where version == carthageXcodeVersion

dianaafanador3 · 2023-07-10T15:37:33Z

examples/installation/build.rb

+    test platform, 'cocoapods', 'static' unless platform == 'visionos'
+  end
+
+  test 'ios', 'xcframework', 'static'


Any reason to test this in only one platform?

For historical reasons we ship an iOS-specific static framework (iOS 7 didn't support dynamic frameworks, and we just kept shipping it even after dropping iOS 7). These changes generalize the build so that the static framework isn't iOS-specific but we're still only shipping it for iOS.

dianaafanador3 · 2023-07-10T16:01:21Z

.jenkins.yml

 - cocoapods-watchos
+ - cocoapods-tvos


Would be nice to distinguish which targets are building the framework and which are installation test

tgoyne added 2 commits June 29, 2023 09:41

Delete the old ReactiveCocoa example

4f1c91e

This was using a very, very old version of ReactiveCocoa from 2015 and hasn't been applicable to any maintained versions of it for a very long time.

Bump the deployment target on examples to iOS 12

b591e0f

tgoyne self-assigned this Jun 30, 2023

cla-bot bot added the cla: yes label Jun 30, 2023

tgoyne force-pushed the tg/installation-examples branch 7 times, most recently from 7ea724f to 97d4797 Compare July 3, 2023 15:24

tgoyne commented Jul 3, 2023

View reviewed changes

tgoyne force-pushed the tg/installation-examples branch 14 times, most recently from 2acd667 to 679e0ab Compare July 4, 2023 00:27

tgoyne force-pushed the tg/installation-examples branch from 679e0ab to 7cc3b60 Compare July 4, 2023 03:48

tgoyne marked this pull request as ready for review July 4, 2023 05:14

tgoyne requested a review from dianaafanador3 July 4, 2023 05:14

dianaafanador3 approved these changes Jul 10, 2023

View reviewed changes

tgoyne merged commit 2df4354 into master Jul 10, 2023
49 of 55 checks passed

tgoyne deleted the tg/installation-examples branch July 10, 2023 23:45

github-actions bot locked as resolved and limited conversation to collaborators Mar 14, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Rework the installation examples #8289

Rework the installation examples #8289

tgoyne commented Jun 30, 2023 •

edited

Loading

tgoyne Jul 3, 2023

tgoyne Jul 3, 2023

tgoyne Jul 3, 2023

tgoyne Jul 3, 2023

tgoyne commented Jul 4, 2023

dianaafanador3 left a comment •

edited

Loading

dianaafanador3 Jul 6, 2023

tgoyne Jul 10, 2023

dianaafanador3 Jul 10, 2023

tgoyne Jul 10, 2023

dianaafanador3 Jul 10, 2023

tgoyne Jul 10, 2023

dianaafanador3 Jul 10, 2023

dianaafanador3 Jul 10, 2023

tgoyne Jul 10, 2023

dianaafanador3 Jul 10, 2023

Rework the installation examples #8289

Rework the installation examples #8289

Conversation

tgoyne commented Jun 30, 2023 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

tgoyne commented Jul 4, 2023

dianaafanador3 left a comment • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

tgoyne commented Jun 30, 2023 •

edited

Loading

dianaafanador3 left a comment •

edited

Loading