Admittedly, hermeticity is "best effort" in such cases; these environment values should be as * tied to configuration parameters as possible. * *
For example, underlying iOS toolchains require that SDKROOT resolve to an absolute system
* path, but, when selecting which SDK to resolve, the version number comes from build
* configuration.
*/
public final class XcodeLocalEnvProvider implements LocalEnvProvider {
private static final GoogleLogger logger = GoogleLogger.forEnclosingClass();
private final Map Use {@link LocalEnvProvider#forCurrentOs(Map)} to instantiate this.
*
* @param clientEnv a map of the current Bazel command's environment
*/
XcodeLocalEnvProvider(Map This spawns a subprocess to run the {@code /usr/bin/xcrun} binary to locate the target SDK.
* As this is a costly operation, always call {@link #getSdkRoot(String, String, String)} instead,
* which does caching.
*
* @param developerDir the value of {@code DEVELOPER_DIR} for the target version of xcode
* @param sdkVersion the sdk version; for example, {@code 9.1}
* @param appleSdkPlatform the sdk platform; for example, {@code iPhoneOS}
* @return an absolute path to the root of the target Apple SDK
* @throws IOException if there is an issue with obtaining the root from the spawned process,
* either because the SDK platform/version pair doesn't exist, or there was an unexpected
* issue finding or running the tool
*/
private static String querySdkRoot(
String developerDir, String sdkVersion, String appleSdkPlatform)
throws IOException, InterruptedException {
try {
String sdkString = appleSdkPlatform.toLowerCase() + sdkVersion;
Map This may delegate to {@link #querySdkRoot(String, String, String)} to obtain the path from
* external sources in the system. Values are cached in-memory throughout the lifetime of the
* Bazel server.
*
* @param developerDir the value of {@code DEVELOPER_DIR} for the target version of xcode
* @param sdkVersion the sdk version; for example, {@code 9.1}
* @param appleSdkPlatform the sdk platform; for example, {@code iPhoneOS}
* @return an absolute path to the root of the target Apple SDK
* @throws IOException if there is an issue with obtaining the root from the spawned process,
* either because the SDK platform/version pair doesn't exist, or there was an unexpected
* issue finding or running the tool
*/
private static String getSdkRoot(String developerDir, String sdkVersion, String appleSdkPlatform)
throws IOException, InterruptedException {
try {
return sdkRootCache.computeIfAbsent(
developerDir + ":" + appleSdkPlatform.toLowerCase() + ":" + sdkVersion,
(key) -> {
try {
String sdkRoot = querySdkRoot(developerDir, sdkVersion, appleSdkPlatform);
logger.atInfo().log("Queried Xcode SDK root with key %s and got %s", key, sdkRoot);
return sdkRoot;
} catch (IOException e) {
throw new UncheckedIOException(e);
} catch (InterruptedException e) {
throw new UncheckedInterruptedException(e);
}
});
} catch (UncheckedIOException e) {
throw e.getCause();
} catch (UncheckedInterruptedException e) {
throw e.getCause();
}
}
private static final class UncheckedInterruptedException extends RuntimeException {
UncheckedInterruptedException(InterruptedException e) {
super(e);
}
@Override
public synchronized InterruptedException getCause() {
return (InterruptedException) super.getCause();
}
}
/**
* Queries the path to the Xcode developer directory on the host system for the given Xcode
* version.
*
* This spawns a subprocess to run the {@code xcode-locator} binary. As this is a costly
* operation, always call {@link #getDeveloperDir(Path, DottedVersion)} instead, which does
* caching.
*
* @param binTools the {@link BinTools}, used to locate the cache file
* @param version the xcode version number to look up
* @return an absolute path to the root of the Xcode developer directory
* @throws IOException if there is an issue with obtaining the path from the spawned process,
* either because there is no installed xcode with the given version, or there was an
* unexpected issue finding or running the tool
*/
private static String queryDeveloperDir(BinTools binTools, DottedVersion version)
throws IOException, InterruptedException {
String xcodeLocatorPath = binTools.getEmbeddedPath("xcode-locator").getPathString();
try {
CommandResult xcodeLocatorResult =
new Command(new String[] {xcodeLocatorPath, version.toString()}).execute();
return new String(xcodeLocatorResult.getStdout(), StandardCharsets.UTF_8).trim();
} catch (AbnormalTerminationException e) {
TerminationStatus terminationStatus = e.getResult().getTerminationStatus();
String message;
if (e.getResult().getTerminationStatus().exited()) {
message =
String.format(
"Running '%s %s' failed with code %s.\n"
+ "This most likely indicates that xcode version %s is not available on the "
+ "host machine.\n"
+ "%s\n"
+ "stdout: %s\n"
+ "stderr: %s",
xcodeLocatorPath,
version,
terminationStatus.getExitCode(),
version,
terminationStatus.toString(),
new String(e.getResult().getStdout(), StandardCharsets.UTF_8),
new String(e.getResult().getStderr(), StandardCharsets.UTF_8));
} else {
message =
String.format(
"Running '%s %s' failed.\n" + "%s\n" + "stdout: %s\n" + "stderr: %s",
xcodeLocatorPath,
version,
e.getResult().getTerminationStatus(),
new String(e.getResult().getStdout(), StandardCharsets.UTF_8),
new String(e.getResult().getStderr(), StandardCharsets.UTF_8));
}
throw new IOException(message, e);
} catch (CommandException e) {
throw new IOException(e);
}
}
/**
* Returns the absolute root path of the xcode developer directory on the host system for the
* given Xcode version.
*
* This may delegate to {@link #queryDeveloperDir(Path, DottedVersion)} to obtain the path from
* external sources in the system. Values are cached in-memory throughout the lifetime of the
* Bazel server.
*
* @param binTools the {@link BinTools} path, used to locate the cache file
* @param version the xcode version number to look up
* @return an absolute path to the root of the Xcode developer directory
* @throws IOException if there is an issue with obtaining the path from the spawned process,
* either because there is no installed xcode with the given version, or there was an
* unexpected issue finding or running the tool
*/
private static String getDeveloperDir(BinTools binTools, DottedVersion version)
throws IOException, InterruptedException {
try {
return developerDirCache.computeIfAbsent(
version.toString(),
(key) -> {
try {
String developerDir = queryDeveloperDir(binTools, version);
logger.atInfo().log(
"Queried Xcode developer dir with key %s and got %s", key, developerDir);
return developerDir;
} catch (IOException e) {
throw new UncheckedIOException(e);
} catch (InterruptedException e) {
throw new UncheckedInterruptedException(e);
}
});
} catch (UncheckedIOException e) {
throw e.getCause();
} catch (UncheckedInterruptedException e) {
throw e.getCause();
}
}
}