File: attr_backDeployed_evolution.swift

package info (click to toggle)
swiftlang 6.0.3-2
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 2,519,992 kB
  • sloc: cpp: 9,107,863; ansic: 2,040,022; asm: 1,135,751; python: 296,500; objc: 82,456; f90: 60,502; lisp: 34,951; pascal: 19,946; sh: 18,133; perl: 7,482; ml: 4,937; javascript: 4,117; makefile: 3,840; awk: 3,535; xml: 914; fortran: 619; cs: 573; ruby: 573
file content (214 lines) | stat: -rw-r--r-- 8,600 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
//
// At a high level, this test is designed to verify that use of declarations
// annotated with @backDeployed behave as expected when running a client binary
// on an older OS that does not have the back deployed APIs. The
// BackDeployHelper framework has a number of APIs that are available in the
// OSes identified by the "BackDeploy 1.0" availability macro and are back
// deployed before OSes identified "BackDeploy 2.0". Verification is performed
// the following way:
//
//  1. Build the helper framework with both BackDeploy 1.0 defined to an
//     OS version before Swift ABI stability and 2.0 defined to an OS version
//     after Swift ABI stability. Note that stradling ABI stability is not
//     a necessary requirement of this test; it's just convenient to use OS
//     versions that correspond to existing lit substitutions.
//  2. Build the client executable with a deployment target set to the same
//     OS version as BackDeploy 2.0.
//  3. Run the client executable, verifying that the copies of the functions in
//     the framework are used (verified by runtime logic using #dsohandle).
//  4. Build a new copy of the helper framework, this time with BackDeploy 2.0
//     set to a distant future OS version.
//  5. Build a new copy of the client executable using the new framework and
//     the deployment target set to the same OS version as BackDeploy 1.0.
//  6. Run the new executable, verifying with #dsohandle that client copies of
//     the APIs are used.
//  7. Re-build the framework in place, this time stripping the definitions of
//     the back deployed APIs entirely.
//  8. Re-run the unmodified executable, with the same expectations as in (6).
//     However, this time we're also verifying that the executable can run even
//     without the original API symbols present in the linked dylib.
//

// REQUIRES: executable_test
// REQUIRES: OS=macosx

// The deployment targets and availability versions hardcoded into this test
// aren't compatible with the environment of the back deployment CI bots.
// UNSUPPORTED: back_deployment_runtime

// Remote test execution does not support dynamically loaded libraries.
// UNSUPPORTED: remote_run

// ---- (0) Prepare SDK
// RUN: %empty-directory(%t)
// RUN: %empty-directory(%t/SDK_ABI)
// RUN: %empty-directory(%t/SDK_BD)

// ---- (1) Build framework with BackDeploy 2.0 in the past
// RUN: mkdir -p %t/SDK_ABI/Frameworks/BackDeployHelper.framework/Modules/BackDeployHelper.swiftmodule
// RUN: %target-build-swift-dylib(%t/SDK_ABI/Frameworks/BackDeployHelper.framework/BackDeployHelper) \
// RUN:   -emit-module-path %t/SDK_ABI/Frameworks/BackDeployHelper.framework/Modules/BackDeployHelper.swiftmodule/%module-target-triple.swiftmodule \
// RUN:   -module-name BackDeployHelper -emit-module %S/Inputs/BackDeployHelper.swift \
// RUN:   -target %target-cpu-apple-macosx10.15 \
// RUN:   -Xfrontend -define-availability \
// RUN:     -Xfrontend 'BackDeploy 1.0:macOS 10.14.3' \
// RUN:   -Xfrontend -define-availability \
// RUN:     -Xfrontend 'BackDeploy 2.0:macOS 10.15' \
// RUN:   -Xlinker -install_name -Xlinker @rpath/BackDeployHelper.framework/BackDeployHelper \
// RUN:   -enable-library-evolution

// ---- (2) Build executable
// RUN: %target-build-swift -emit-executable %s -g -o %t/test_ABI \
// RUN:   -target %target-cpu-apple-macosx10.14.3 \
// RUN:   -Xfrontend -define-availability \
// RUN:     -Xfrontend 'BackDeploy 1.0:macOS 10.14.3' \
// RUN:   -Xfrontend -define-availability \
// RUN:     -Xfrontend 'BackDeploy 2.0:macOS 10.15' \
// RUN:   -F %t/SDK_ABI/Frameworks/ -framework BackDeployHelper \
// RUN:   %target-rpath(@executable_path/SDK_ABI/Frameworks)

// ---- (3) Run executable
// RUN: %target-codesign %t/test_ABI
// RUN: %target-run %t/test_ABI | %FileCheck --check-prefix=CHECK --check-prefix=CHECK-ABI %s

// ---- (4) Build framework with BackDeploy 2.0 in the future
// RUN: mkdir -p %t/SDK_BD/Frameworks/BackDeployHelper.framework/Modules/BackDeployHelper.swiftmodule
// RUN: %target-build-swift-dylib(%t/SDK_BD/Frameworks/BackDeployHelper.framework/BackDeployHelper) \
// RUN:   -emit-module-path %t/SDK_BD/Frameworks/BackDeployHelper.framework/Modules/BackDeployHelper.swiftmodule/%module-target-triple.swiftmodule \
// RUN:   -module-name BackDeployHelper -emit-module %S/Inputs/BackDeployHelper.swift \
// RUN:   -target %target-cpu-apple-macosx10.15 \
// RUN:   -Xfrontend -define-availability \
// RUN:     -Xfrontend 'BackDeploy 1.0:macOS 10.14.3' \
// RUN:   -Xfrontend -define-availability \
// RUN:     -Xfrontend 'BackDeploy 2.0:macOS 999.0' \
// RUN:   -Xlinker -install_name -Xlinker @rpath/BackDeployHelper.framework/BackDeployHelper \
// RUN:   -enable-library-evolution

// ---- (5) Build executable
// RUN: %target-build-swift -emit-executable %s -g -o %t/test_BD \
// RUN:   -target %target-cpu-apple-macosx10.14.3 \
// RUN:   -Xfrontend -define-availability \
// RUN:     -Xfrontend 'BackDeploy 1.0:macOS 10.14.3' \
// RUN:   -Xfrontend -define-availability \
// RUN:     -Xfrontend 'BackDeploy 2.0:macOS 999.0' \
// RUN:   -F %t/SDK_BD/Frameworks/ -framework BackDeployHelper \
// RUN:   %target-rpath(@executable_path/SDK_BD/Frameworks)

// ---- (6) Run executable
// RUN: %target-codesign %t/test_BD
// RUN: %target-run %t/test_BD | %FileCheck --check-prefix=CHECK --check-prefix=CHECK-BD %s

// ---- (7) Re-build framework with the back deployed APIs stripped
// RUN: %empty-directory(%t/SDK_BD)
// RUN: mkdir -p %t/SDK_BD/Frameworks/BackDeployHelper.framework/Modules/BackDeployHelper.swiftmodule
// RUN: %target-build-swift-dylib(%t/SDK_BD/Frameworks/BackDeployHelper.framework/BackDeployHelper) \
// RUN:   -emit-module-path %t/SDK_BD/Frameworks/BackDeployHelper.framework/Modules/BackDeployHelper.swiftmodule/%module-target-triple.swiftmodule \
// RUN:   -module-name BackDeployHelper -emit-module %S/Inputs/BackDeployHelper.swift \
// RUN:   -target %target-cpu-apple-macosx10.15 \
// RUN:   -Xfrontend -define-availability \
// RUN:     -Xfrontend 'BackDeploy 1.0:macOS 10.14.3' \
// RUN:   -Xfrontend -define-availability \
// RUN:     -Xfrontend 'BackDeploy 2.0:macOS 999.0' \
// RUN:   -Xlinker -install_name -Xlinker @rpath/BackDeployHelper.framework/BackDeployHelper \
// RUN:   -enable-library-evolution -DSTRIP_V2_APIS

// ---- (8) Re-run executable
// RUN: %target-codesign %t/test_BD
// RUN: %target-run %t/test_BD | %FileCheck --check-prefix=CHECK --check-prefix=CHECK-BD %s

import BackDeployHelper

// CHECK: client: check
testPrint(handle: #dsohandle, "check")
// CHECK: library: check
testPrint(handle: libraryHandle(), "check")

if isV2OrLater() {
  precondition(!v2APIsAreStripped())
}

// CHECK-ABI: library: trivial
// CHECK-BD: client: trivial
trivial()

precondition(try! pleaseThrow(false))
do {
  _ = try pleaseThrow(true)
  fatalError("Should have thrown")
} catch {
  precondition(error as? BadError == BadError.bad)
}

precondition(BadError(fromEmoji: "💥") == nil)
precondition(BadError(fromEmoji: "❗️") == .bad)
precondition(BadError(fromEmoji: "‼️") == .reallyBad)

do {
  let defaulted = IntArray()
  precondition(defaulted.values == [])

  let empty = IntArray.empty
  precondition(empty.values == [])
  precondition(empty[keyPath: \.values] == [])

  var array = IntArray([5])

  // CHECK-ABI: library: [5]
  // CHECK-BD: client: [5]
  array.print()

  array.append(42)
  genericAppend(&array, 3)
  let countable = array.toCountable()
  precondition(existentialCount(countable) == 3)
  array[1] += 1
  precondition(array[1] == 43)

  // CHECK-ABI: library: [5, 43, 3]
  // CHECK-BD: client: [5, 43, 3]
  array.print()
  
  // CHECK-ABI: library: [5, 43, 3]
  // CHECK-BD: client: [5, 43, 3]
  array.rawValues.print()

  precondition(array.removeLast() == 3)
}

do {
  let defaulted = ReferenceIntArray()
  precondition(defaulted.values == [])
  precondition(defaulted[keyPath: \.values] == [])

  let empty = ReferenceIntArray.empty
  precondition(empty.values == [])

  var array = ReferenceIntArray([7])

  // CHECK-ABI: library: [7]
  // CHECK-BD: client: [7]
  array.print()

  do {
    let copy = array.copy()
    precondition(array !== copy)
    precondition(copy.values == [7])
  }

  array.append(39)
  genericAppend(&array, 1)
  let countable = array.toCountable()
  precondition(existentialCount(countable) == 3)
  array[1] += 1
  precondition(array[1] == 40)

  // CHECK-ABI: library: [7, 40, 1]
  // CHECK-BD: client: [7, 40, 1]
  array.print()
  
  // CHECK-ABI: library: [7, 40, 1]
  // CHECK-BD: client: [7, 40, 1]
  array.rawValues.print()

  precondition(array.removeLast() == 1)
}