forked from microsoft/azure-pipelines-tasks
-
Notifications
You must be signed in to change notification settings - Fork 0
/
xcode.ts
514 lines (437 loc) · 23.9 KB
/
xcode.ts
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
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
import path = require('path');
import tl = require('azure-pipelines-task-lib/task');
import sign = require('ios-signing-common/ios-signing-common');
import utils = require('./xcodeutils');
import { ToolRunner } from 'azure-pipelines-task-lib/toolrunner';
async function run() {
const telemetryData: { [key: string]: any; } = {};
try {
tl.setResourcePath(path.join(__dirname, 'task.json'));
//--------------------------------------------------------
// Tooling
//--------------------------------------------------------
let xcodeVersionSelection: string = tl.getInput('xcodeVersion', true);
telemetryData.xcodeVersionSelection = xcodeVersionSelection;
if (xcodeVersionSelection === 'specifyPath') {
let devDir = tl.getInput('xcodeDeveloperDir', true);
tl.setVariable('DEVELOPER_DIR', devDir);
}
else if (xcodeVersionSelection !== 'default') {
// resolve the developer dir for a version like "8" or "9".
let devDir = utils.findDeveloperDir(xcodeVersionSelection);
tl.setVariable('DEVELOPER_DIR', devDir);
}
let tool: string = tl.which('xcodebuild', true);
tl.debug('Tool selected: ' + tool);
let workingDir: string = tl.getPathInput('cwd');
tl.cd(workingDir);
//--------------------------------------------------------
// Xcode args
//--------------------------------------------------------
let ws: string = tl.getPathInput('xcWorkspacePath', false, false);
if (tl.filePathSupplied('xcWorkspacePath')) {
let workspaceMatches = tl.findMatch(workingDir, ws, { allowBrokenSymbolicLinks: false, followSpecifiedSymbolicLink: false, followSymbolicLinks: false });
tl.debug("Found " + workspaceMatches.length + ' workspaces matching.');
if (workspaceMatches.length > 0) {
ws = workspaceMatches[0];
if (workspaceMatches.length > 1) {
tl.warning(tl.loc('MultipleWorkspacesFound', ws));
}
}
else {
throw new Error(tl.loc('WorkspaceDoesNotExist', ws));
}
}
let isProject = false;
if (ws && ws.trim().toLowerCase().endsWith('.xcodeproj')) {
isProject = true;
}
let scheme: string = tl.getInput('scheme', false);
// If we have a workspace argument but no scheme, see if there's
// single shared scheme we can use.
if (!scheme && !isProject && ws && tl.filePathSupplied('xcWorkspacePath')) {
try {
let schemes: string[] = await utils.getWorkspaceSchemes(tool, ws);
if (schemes.length > 1) {
tl.warning(tl.loc('MultipleSchemesFound'));
}
else if (schemes.length === 0) {
tl.warning(tl.loc('NoSchemeFound'));
}
else {
scheme = schemes[0];
console.log(tl.loc('SchemeSelected', scheme));
}
}
catch (err) {
tl.warning(tl.loc('FailedToFindScheme'));
}
}
let destinations: string[];
let platform: string = tl.getInput('destinationPlatformOption', false);
if (platform === 'custom') {
// Read the custom platform from the text input.
platform = tl.getInput('destinationPlatform', false);
}
if (platform === 'macOS') {
destinations = ['platform=macOS'];
}
else if (platform && platform !== 'default') {
// To be yaml friendly, destinationTypeOption is optional and we default to simulators.
let destinationType: string = tl.getInput('destinationTypeOption', false);
let targetingSimulators: boolean = destinationType !== 'devices';
let devices: string[];
if (targetingSimulators) {
// Only one simulator for now.
devices = [tl.getInput('destinationSimulators')];
}
else {
// Only one device for now.
devices = [tl.getInput('destinationDevices')];
}
destinations = utils.buildDestinationArgs(platform, devices, targetingSimulators);
}
let sdk: string = tl.getInput('sdk', false);
let configuration: string = tl.getInput('configuration', false);
let useXcpretty: boolean = tl.getBoolInput('useXcpretty', false);
let actions: string[] = tl.getDelimitedInput('actions', ' ', true);
let packageApp: boolean = tl.getBoolInput('packageApp', true);
let args: string = tl.getInput('args', false);
telemetryData.actions = actions;
telemetryData.packageApp = packageApp;
//--------------------------------------------------------
// Exec Tools
//--------------------------------------------------------
// --- Xcode Version ---
let xcv: ToolRunner = tl.tool(tool);
xcv.arg('-version');
let xcodeMajorVersion: number = 0;
xcv.on('stdout', (data) => {
const match = data.toString().trim().match(/Xcode (.+)/g);
tl.debug('match = ' + match);
if (match) {
const versionString = match.toString().replace('Xcode', '').trim();
const majorVersion: number = parseInt(versionString);
tl.debug('majorVersion = ' + majorVersion);
telemetryData.xcodeVersion = versionString;
if (!isNaN(majorVersion)) {
xcodeMajorVersion = majorVersion;
}
}
});
await xcv.exec();
tl.debug('xcodeMajorVersion = ' + xcodeMajorVersion);
// --- Xcode build arguments ---
let xcb: ToolRunner = tl.tool(tool);
xcb.argIf(sdk, ['-sdk', sdk]);
xcb.argIf(configuration, ['-configuration', configuration]);
if (ws && tl.filePathSupplied('xcWorkspacePath')) {
xcb.argIf(isProject, '-project');
xcb.argIf(!isProject, '-workspace');
xcb.arg(ws);
}
xcb.argIf(scheme, ['-scheme', scheme]);
// Add a -destination argument for each device and simulator.
if (destinations) {
destinations.forEach(destination => {
xcb.arg(['-destination', destination]);
});
}
xcb.arg(actions);
if (args) {
xcb.line(args);
}
//--------------------------------------------------------
// iOS signing and provisioning
//--------------------------------------------------------
let signingOption: string = tl.getInput('signingOption', true);
let xcode_codeSigningAllowed: string;
let xcode_codeSignStyle: string;
let xcode_otherCodeSignFlags: string;
let xcode_codeSignIdentity: string;
let xcode_provProfile: string;
let xcode_provProfileSpecifier: string;
let xcode_devTeam: string;
telemetryData.signingOption = signingOption;
if (signingOption === 'nosign') {
xcode_codeSigningAllowed = 'CODE_SIGNING_ALLOWED=NO';
}
else if (signingOption === 'manual') {
xcode_codeSignStyle = 'CODE_SIGN_STYLE=Manual';
const signIdentity: string = tl.getInput('signingIdentity');
if (signIdentity) {
xcode_codeSignIdentity = 'CODE_SIGN_IDENTITY=' + signIdentity;
}
let provProfileUUID: string = tl.getInput('provisioningProfileUuid');
let provProfileName: string = tl.getInput('provisioningProfileName');
if (!provProfileUUID) {
provProfileUUID = "";
}
if (!provProfileName) {
provProfileName = "";
}
//-----------------------------------------------------------------------
// Bastian Armada Interactive:
//
// We have updated the code below to change 'PROVISIONING_PROFILE' to
// 'PROVISIONING_PROFILE_APP' and 'PROVISIONING_PROFILE_SPECIFIER' to
// 'PROVISIONING_PROFILE_SPECIFIER_APP'.
//
// Reason is Unity starting from version 2019.3 is including a new framework
// 'UnityFramework.framework' and that does not support signing. Using
// the 'APP' suffix makes sure it only applies to the application target
// and not all targets.
//
// More information can be found in the Unity manual:
// https://docs.unity3d.com/Manual/StructureOfXcodeProject.html
//
//-----------------------------------------------------------------------
console.log("[Armada Interactive] Using '_APP' suffix after provisioning profile arg");
// PROVISIONING_PROFILE_SPECIFIER takes predence over PROVISIONING_PROFILE,
// so it's important to pass it to Xcode even if it's empty. That way Xcode
// will ignore any specifier in the project file and honor the specifier
// or uuid we passed on the commandline. If the user wants to use the specifier
// in the project file, they should choose the "Project Defaults" signing style.
xcode_provProfile = `PROVISIONING_PROFILE_APP=${provProfileUUID}`;
xcode_provProfileSpecifier = `PROVISIONING_PROFILE_SPECIFIER_APP=${provProfileName}`;
}
else if (signingOption === 'auto') {
xcode_codeSignStyle = 'CODE_SIGN_STYLE=Automatic';
let teamId: string = tl.getInput('teamId');
if (teamId) {
xcode_devTeam = 'DEVELOPMENT_TEAM=' + teamId;
}
}
xcb.argIf(xcode_codeSigningAllowed, xcode_codeSigningAllowed);
xcb.argIf(xcode_codeSignStyle, xcode_codeSignStyle);
xcb.argIf(xcode_codeSignIdentity, xcode_codeSignIdentity);
xcb.argIf(xcode_provProfile, xcode_provProfile);
xcb.argIf(xcode_provProfileSpecifier, xcode_provProfileSpecifier);
xcb.argIf(xcode_devTeam, xcode_devTeam);
//--- Enable Xcpretty formatting ---
if (useXcpretty && !tl.which('xcpretty')) {
// user wants to enable xcpretty but it is not installed, fallback to xcodebuild raw output
useXcpretty = false;
tl.warning(tl.loc("XcprettyNotInstalled"));
}
if (useXcpretty) {
let xcPrettyPath: string = tl.which('xcpretty', true);
let xcPrettyTool: ToolRunner = tl.tool(xcPrettyPath);
xcPrettyTool.arg(['-r', 'junit', '--no-color']);
const xcPrettyArgs: string = tl.getInput('xcprettyArgs');
if (xcPrettyArgs) {
xcPrettyTool.line(xcPrettyArgs);
}
const logFile: string = utils.getUniqueLogFileName('xcodebuild');
xcb.pipeExecOutputToTool(xcPrettyTool, logFile);
utils.setTaskState('XCODEBUILD_LOG', logFile);
}
//--- Xcode Build ---
let buildOnlyDeviceErrorFound: boolean;
xcb.on('errline', (line: string) => {
if (!buildOnlyDeviceErrorFound && line.includes('build only device cannot be used to run this target')) {
buildOnlyDeviceErrorFound = true;
}
});
try {
await xcb.exec();
} catch (err) {
if (buildOnlyDeviceErrorFound) {
// Tell the user they need to change Destination platform to fix this build error.
tl.warning(tl.loc('NoDestinationPlatformWarning'));
}
throw err;
}
//--------------------------------------------------------
// Package app to generate .ipa
//--------------------------------------------------------
if (packageApp && sdk !== 'iphonesimulator') {
// use xcodebuild to create the app package
if (!scheme) {
throw new Error(tl.loc("SchemeRequiredForArchive"));
}
if (!ws || !tl.filePathSupplied('xcWorkspacePath')) {
throw new Error(tl.loc("WorkspaceOrProjectRequiredForArchive"));
}
// create archive
let xcodeArchive: ToolRunner = tl.tool(tl.which('xcodebuild', true));
if (ws && tl.filePathSupplied('xcWorkspacePath')) {
xcodeArchive.argIf(isProject, '-project');
xcodeArchive.argIf(!isProject, '-workspace');
xcodeArchive.arg(ws);
}
xcodeArchive.argIf(scheme, ['-scheme', scheme]);
xcodeArchive.arg('archive'); //archive action
xcodeArchive.argIf(sdk, ['-sdk', sdk]);
xcodeArchive.argIf(configuration, ['-configuration', configuration]);
let archivePath: string = tl.getInput('archivePath');
let archiveFolderRoot: string;
if (!archivePath.endsWith('.xcarchive')) {
archiveFolderRoot = archivePath;
archivePath = tl.resolve(archivePath, scheme);
} else {
//user specified a file path for archivePath
archiveFolderRoot = path.dirname(archivePath);
}
xcodeArchive.arg(['-archivePath', archivePath]);
xcodeArchive.argIf(xcode_otherCodeSignFlags, xcode_otherCodeSignFlags);
xcodeArchive.argIf(xcode_codeSigningAllowed, xcode_codeSigningAllowed);
xcodeArchive.argIf(xcode_codeSignStyle, xcode_codeSignStyle);
xcodeArchive.argIf(xcode_codeSignIdentity, xcode_codeSignIdentity);
xcodeArchive.argIf(xcode_provProfile, xcode_provProfile);
xcodeArchive.argIf(xcode_provProfileSpecifier, xcode_provProfileSpecifier);
xcodeArchive.argIf(xcode_devTeam, xcode_devTeam);
if (args) {
xcodeArchive.line(args);
}
if (useXcpretty) {
let xcPrettyTool: ToolRunner = tl.tool(tl.which('xcpretty', true));
xcPrettyTool.arg('--no-color');
const xcPrettyArgs: string = tl.getInput('xcprettyArgs');
if (xcPrettyArgs) {
xcPrettyTool.line(xcPrettyArgs);
}
const logFile: string = utils.getUniqueLogFileName('xcodebuild_archive');
xcodeArchive.pipeExecOutputToTool(xcPrettyTool, logFile);
utils.setTaskState('XCODEBUILD_ARCHIVE_LOG', logFile);
}
await xcodeArchive.exec();
let archiveFolders: string[] = tl.findMatch(archiveFolderRoot, '**/*.xcarchive', { allowBrokenSymbolicLinks: false, followSpecifiedSymbolicLink: false, followSymbolicLinks: false });
if (archiveFolders && archiveFolders.length > 0) {
tl.debug(archiveFolders.length + ' archives found for exporting.');
//export options plist
let exportOptions: string = tl.getInput('exportOptions');
let exportMethod: string;
let exportTeamId: string;
let exportOptionsPlist: string;
let archiveToCheck: string = archiveFolders[0];
let macOSEmbeddedProfilesFound: boolean;
telemetryData.exportOptions = exportOptions;
// iOS provisioning profiles use the .mobileprovision suffix. macOS profiles have the .provisionprofile suffix.
let embeddedProvProfiles: string[] = tl.findMatch(archiveToCheck, '**/embedded.mobileprovision', { allowBrokenSymbolicLinks: false, followSpecifiedSymbolicLink: false, followSymbolicLinks: false });
if (embeddedProvProfiles && embeddedProvProfiles.length > 0) {
tl.debug(`${embeddedProvProfiles.length} iOS embedded.mobileprovision file(s) found.`);
} else {
embeddedProvProfiles = tl.findMatch(archiveToCheck, '**/embedded.provisionprofile', { allowBrokenSymbolicLinks: false, followSpecifiedSymbolicLink: false, followSymbolicLinks: false });
if (embeddedProvProfiles && embeddedProvProfiles.length > 0) {
tl.debug(`${embeddedProvProfiles.length} macOS embedded.provisionprofile file(s) found.`);
macOSEmbeddedProfilesFound = true;
}
}
if (exportOptions === 'auto') {
// Automatically try to detect the export-method to use from the provisioning profile
// embedded in the .xcarchive file
if (embeddedProvProfiles && embeddedProvProfiles.length > 0) {
tl.debug('embedded prov profile = ' + embeddedProvProfiles[0]);
if (macOSEmbeddedProfilesFound) {
exportMethod = await sign.getmacOSProvisioningProfileType(embeddedProvProfiles[0]);
} else {
exportMethod = await sign.getiOSProvisioningProfileType(embeddedProvProfiles[0]);
}
tl.debug('Using export method = ' + exportMethod);
}
// If you create a simple macOS app with automatic signing and no entitlements, it won't have an embedded profile.
// And export for that app will work with an empty exportOptionsPlist.
if (!exportMethod && sdk && sdk !== 'macosx') {
tl.warning(tl.loc('ExportMethodNotIdentified'));
}
} else if (exportOptions === 'specify') {
exportMethod = tl.getInput('exportMethod', true);
exportTeamId = tl.getInput('exportTeamId');
} else if (exportOptions === 'plist') {
exportOptionsPlist = tl.getInput('exportOptionsPlist');
if (!tl.filePathSupplied('exportOptionsPlist') || !utils.pathExistsAsFile(exportOptionsPlist)) {
throw new Error(tl.loc('ExportOptionsPlistInvalidFilePath', exportOptionsPlist));
}
}
if (exportOptions !== 'plist') {
// As long as the user didn't provide a plist, start with an empty one.
// Xcode 7 warns "-exportArchive without -exportOptionsPlist is deprecated"
// Xcode 8+ will error if a plist isn't provided.
let plist: string = tl.which('/usr/libexec/PlistBuddy', true);
exportOptionsPlist = '_XcodeTaskExportOptions.plist';
tl.tool(plist).arg(['-c', 'Clear', exportOptionsPlist]).execSync();
// Add the teamId if provided.
if (exportTeamId) {
tl.tool(plist).arg(['-c', 'Add teamID string ' + exportTeamId, exportOptionsPlist]).execSync();
}
// Add the export method if provided or determined above.
if (exportMethod) {
tl.tool(plist).arg(['-c', 'Add method string ' + exportMethod, exportOptionsPlist]).execSync();
}
// For auto export, conditionally add entitlements, signingStyle and provisioning profiles.
if (xcodeMajorVersion >= 9 && exportOptions === 'auto') {
// Propagate any iCloud entitlement.
if (embeddedProvProfiles && embeddedProvProfiles.length > 0) {
const cloudEntitlement = await sign.getCloudEntitlement(embeddedProvProfiles[0], exportMethod);
if (cloudEntitlement) {
tl.debug("Adding cloud entitlement");
tl.tool(plist).arg(['-c', `Add iCloudContainerEnvironment string ${cloudEntitlement}`, exportOptionsPlist]).execSync();
}
}
let signingOptionForExport = signingOption;
// If we're using the project defaults, scan the pbxProject file for the type of signing being used.
if (signingOptionForExport === 'default') {
signingOptionForExport = await utils.getProvisioningStyle(ws);
if (!signingOptionForExport) {
tl.warning(tl.loc('CantDetermineProvisioningStyle'));
}
}
if (signingOptionForExport === 'manual') {
// Xcode 9 manual signing, set code sign style = manual
tl.tool(plist).arg(['-c', 'Add signingStyle string ' + 'manual', exportOptionsPlist]).execSync();
// add provisioning profiles to the exportOptions plist
// find bundle Id from Info.plist and prov profile name from the embedded profile in each .app package
tl.tool(plist).arg(['-c', 'Add provisioningProfiles dict', exportOptionsPlist]).execSync();
for (let i = 0; i < embeddedProvProfiles.length; i++) {
let embeddedProvProfile: string = embeddedProvProfiles[i];
let profileName: string = await sign.getProvisioningProfileName(embeddedProvProfile);
tl.debug('embedded provisioning profile = ' + embeddedProvProfile + ', profile name = ' + profileName);
let embeddedInfoPlist: string = tl.resolve(path.dirname(embeddedProvProfile), 'Info.plist');
let bundleId: string = await sign.getBundleIdFromPlist(embeddedInfoPlist);
tl.debug('embeddedInfoPlist path = ' + embeddedInfoPlist + ', bundle identifier = ' + bundleId);
if (!profileName || !bundleId) {
throw new Error(tl.loc('FailedToGenerateExportOptionsPlist'));
}
tl.tool(plist).arg(['-c', 'Add provisioningProfiles:' + bundleId + ' string ' + profileName, exportOptionsPlist]).execSync();
}
}
}
}
//export path
let exportPath: string = tl.getInput('exportPath');
for (let i = 0; i < archiveFolders.length; i++) {
let archive: string = archiveFolders.pop();
//export the archive
let xcodeExport: ToolRunner = tl.tool(tl.which('xcodebuild', true));
xcodeExport.arg(['-exportArchive', '-archivePath', archive]);
xcodeExport.arg(['-exportPath', exportPath]);
xcodeExport.argIf(exportOptionsPlist, ['-exportOptionsPlist', exportOptionsPlist]);
let exportArgs: string = tl.getInput('exportArgs');
xcodeExport.argIf(exportArgs, exportArgs);
if (useXcpretty) {
let xcPrettyTool: ToolRunner = tl.tool(tl.which('xcpretty', true));
xcPrettyTool.arg('--no-color');
const xcPrettyArgs: string = tl.getInput('xcprettyArgs');
if (xcPrettyArgs) {
xcPrettyTool.line(xcPrettyArgs);
}
const logFile: string = utils.getUniqueLogFileName('xcodebuild_export');
xcodeExport.pipeExecOutputToTool(xcPrettyTool, logFile);
utils.setTaskState('XCODEBUILD_EXPORT_LOG', logFile);
}
await xcodeExport.exec();
}
}
}
tl.setResult(tl.TaskResult.Succeeded, tl.loc('XcodeSuccess'));
}
catch (err) {
tl.setResult(tl.TaskResult.Failed, err);
}
finally {
// Publish telemetry
utils.emitTelemetry('TaskHub', 'Xcode', telemetryData);
}
}
run();