Don't directly link to the private Xcode framework, instead find it at runtime

testing/iossim/iossim.mm

 // Copyright (c) 2012 The Chromium Authors. All rights reserved.
 // Use of this source code is governed by a BSD-style license that can be
 // found in the LICENSE file.
 
 #import <Foundation/Foundation.h>
 #include <asl.h>
 #include <libgen.h>
 #include <stdarg.h>
 #include <stdio.h>
 
@@ skipping 25 matching lines @@
        didStart:(BOOL)started
       withError:(NSError*)error;
 @end
 
 #import "iPhoneSimulatorRemoteClient.h"
 
 // An undocumented system log key included in messages from launchd. The value
 // is the PID of the process the message is about (as opposed to launchd's PID).
 #define ASL_KEY_REF_PID "RefPID"
 
+// The path within the developer dir of the private Simulator frameworks.
+#define kSimulatorFrameworkPathLeaf \

[stuartmorgan, 2012/07/30 19:34:21]

s/PathLeaf/RelativePath/ ? PathLeaf sounds like it should be only the last
component to me.

Also, change both #defines to NSString* const

[TVL, 2012/07/30 20:10:17]

Done.

+  @"Platforms/iPhoneSimulator.platform/Developer/Library/PrivateFrameworks/iPhoneSimulatorRemoteClient.framework"
+#define kDevToolsFoundationPathLeaf \
+  @"../OtherFrameworks/DevToolsFoundation.framework"
+
 namespace {
 
 // Name of environment variables that control the user's home directory in the
 // simulator.
 const char* const kUserHomeEnvVariable = "CFFIXED_USER_HOME";
 const char* const kHomeEnvVariable = "HOME";
 
 // Device family codes for iPhone and iPad.
 const int kIPhoneFamily = 1;
 const int kIPadFamily = 2;
@@ skipping 185 matching lines @@
   if (entryFound) {
     LogError(@"Simulated app crashed or exited with non-zero status");
     exit(EXIT_FAILURE);
   }
   exit(EXIT_SUCCESS);
 }
 @end
 
 namespace {
 
+// Finds the developer dir via xcode-select or the DEVELOPER_DIR environment
+// variable.
+NSString* FindDeveloperDir() {
+  // Check the env first.
+  NSDictionary* env = [[NSProcessInfo processInfo] environment];
+  NSString* devDir = [env objectForKey:@"DEVELOPER_DIR"];

[stuartmorgan, 2012/07/30 19:34:21]

developerDir

[TVL, 2012/07/30 20:10:17]

Done.

+  if ([devDir length] > 0) {
+    return devDir;
+  }

[stuartmorgan, 2012/07/30 19:34:21]

No {} for one-line statements, per Chromium style.

[TVL, 2012/07/30 20:10:17]

Done.

+
+  // Go look for it via xcode-select.
+  NSTask* task;

[stuartmorgan, 2012/07/30 19:34:21]

xcodeSelectTask

[TVL, 2012/07/30 20:10:17]

Done.

+  task = [[[NSTask alloc] init] autorelease];
+  [task setLaunchPath:@"/usr/bin/xcode-select"];
+  [task setArguments:[NSArray arrayWithObject:@"-print-path"]];
+
+  NSPipe* pipe = [NSPipe pipe];

[stuartmorgan, 2012/07/30 19:34:21]

outputPipe

[TVL, 2012/07/30 20:10:17]

Done.

+  [task setStandardOutput: pipe];
+  NSFileHandle* file = [pipe fileHandleForReading];

[stuartmorgan, 2012/07/30 19:34:21]

outputFile

[TVL, 2012/07/30 20:10:17]

Done.

+
+  [task launch];
+  NSData* output = [file readDataToEndOfFile];
+  [task terminate];
+
+  NSString* outputStr =

[stuartmorgan, 2012/07/30 19:34:21]

Seems like outputData and then output would make more sense that output and
outputStr, since the string is the output in the format we really want?

[TVL, 2012/07/30 20:10:17]

Done.

+      [[[NSString alloc] initWithData:output
+                             encoding:NSUTF8StringEncoding] autorelease];
+  NSCharacterSet* wsNLSet = [NSCharacterSet whitespaceAndNewlineCharacterSet];

[stuartmorgan, 2012/07/30 19:34:21]

Ugh. Inlining the char set would be much less ugly than this name, even with
having to line-break after the :

[TVL, 2012/07/30 20:10:17]

Done.

+  outputStr = [outputStr stringByTrimmingCharactersInSet:wsNLSet];
+  if ([outputStr length] == 0) {
+    outputStr = nil;
+  }

[stuartmorgan, 2012/07/30 19:34:21]

No {}

[TVL, 2012/07/30 20:10:17]

Done.

+  return outputStr;
+}
+
+// Loads the Simulator framework from the given developer dir.
+NSBundle* LoadSimulatorFramework(NSString* developerDir) {
+  // The Simulator framework depends on some of the other Xcode private
+  // frameworks, manually load them first so everything can be linked up.

[stuartmorgan, 2012/07/30 19:34:21]

s/,/;/

[TVL, 2012/07/30 20:10:17]

Done.

+  NSString* devToolsFoundationPath =
+      [developerDir stringByAppendingPathComponent:kDevToolsFoundationPathLeaf];
+  NSBundle* devToolsFoundationBundle =
+      [NSBundle bundleWithPath:devToolsFoundationPath];
+  if (![devToolsFoundationBundle load])
+    return nil;
+  NSString* simBundlePath =
+      [developerDir stringByAppendingPathComponent:kSimulatorFrameworkPathLeaf];
+  NSBundle* simBundle = [NSBundle bundleWithPath:simBundlePath];
+  if (![simBundle load])
+    return nil;
+  return simBundle;
+}
+
+// Helper to find a class by name and die if it isn't found.
+Class FindClassByName(NSString* clazzName) {

[stuartmorgan, 2012/07/30 19:34:21]

Is className as an identifier really protected? I thought it was just a method
name.

If we have to use something else, how about nameOfClass; it's not great, but
clazzName burns my eyes :)

[TVL, 2012/07/30 20:10:17]

I thought i'd hit it before.  renamed.

+  Class theClass = NSClassFromString(clazzName);
+  if (!theClass) {
+    LogError(@"Failed to find class %@ at runtime.", clazzName);
+    exit(EXIT_FAILURE);
+  }
+  return theClass;
+}
+
 // Converts the given app path to an application spec, which requires an
 // absolute path.
 DTiPhoneSimulatorApplicationSpecifier* BuildAppSpec(NSString* appPath) {
+  Class applicationSpecifierClass =
+      FindClassByName(@"DTiPhoneSimulatorApplicationSpecifier");
   if (![appPath isAbsolutePath]) {
     NSString* cwd = [[NSFileManager defaultManager] currentDirectoryPath];
     appPath = [cwd stringByAppendingPathComponent:appPath];
   }
   appPath = [appPath stringByStandardizingPath];
-  return [DTiPhoneSimulatorApplicationSpecifier
-      specifierWithApplicationPath:appPath];
+  return [applicationSpecifierClass specifierWithApplicationPath:appPath];
 }
 
 // Returns the system root for the given SDK version. If sdkVersion is nil, the
 // default system root is returned.  Will return nil if the sdkVersion is not
 // valid.
 DTiPhoneSimulatorSystemRoot* BuildSystemRoot(NSString* sdkVersion) {
-  DTiPhoneSimulatorSystemRoot* systemRoot =
-      [DTiPhoneSimulatorSystemRoot defaultRoot];
+  Class systemRootClass = FindClassByName(@"DTiPhoneSimulatorSystemRoot");
+  DTiPhoneSimulatorSystemRoot* systemRoot = [systemRootClass defaultRoot];
   if (sdkVersion)
-    systemRoot = [DTiPhoneSimulatorSystemRoot rootWithSDKVersion:sdkVersion];
+    systemRoot = [systemRootClass rootWithSDKVersion:sdkVersion];
 
   return systemRoot;
 }
 
 // Builds a config object for starting the specified app.
 DTiPhoneSimulatorSessionConfig* BuildSessionConfig(
     DTiPhoneSimulatorApplicationSpecifier* appSpec,
     DTiPhoneSimulatorSystemRoot* systemRoot,
     NSString* stdoutPath,
     NSString* stderrPath,
     NSArray* appArgs,
     NSDictionary* appEnv,
     NSNumber* deviceFamily) {
+  Class sessionConfigClass = FindClassByName(@"DTiPhoneSimulatorSessionConfig");
   DTiPhoneSimulatorSessionConfig* sessionConfig =
-      [[[DTiPhoneSimulatorSessionConfig alloc] init] autorelease];
+      [[[sessionConfigClass alloc] init] autorelease];
   sessionConfig.applicationToSimulateOnStart = appSpec;
   sessionConfig.simulatedSystemRoot = systemRoot;
   sessionConfig.localizedClientName = @"chromium";
   sessionConfig.simulatedApplicationStdErrPath = stderrPath;
   sessionConfig.simulatedApplicationStdOutPath = stdoutPath;
   sessionConfig.simulatedApplicationLaunchArgs = appArgs;
   sessionConfig.simulatedApplicationLaunchEnvironment = appEnv;
   sessionConfig.simulatedDeviceFamily = deviceFamily;
   return sessionConfig;
 }
 
 // Builds a simulator session that will use the given delegate.
 DTiPhoneSimulatorSession* BuildSession(SimulatorDelegate* delegate) {
+  Class sessionClass = FindClassByName(@"DTiPhoneSimulatorSession");
   DTiPhoneSimulatorSession* session =
-      [[[DTiPhoneSimulatorSession alloc] init] autorelease];
+      [[[sessionClass alloc] init] autorelease];
   session.delegate = delegate;
   return session;
 }
 
 // Creates a temporary directory with a unique name based on the provided
 // template. The template should not contain any path separators and be suffixed
 // with X's, which will be substituted with a unique alphanumeric string (see
 // 'man mkdtemp' for details). The directory will be created as a subdirectory
 // of NSTemporaryDirectory(). For example, if dirNameTemplate is 'test-XXX',
 // this method would return something like '/path/to/tempdir/test-3n2'.
@@ skipping 74 matching lines @@
       " Will create a new directory if not specified.\n"
       "  -e  Specifies an environment key=value pair that will be"
       " set in the simulated application's environment.\n");
 }
 
 }  // namespace
 
 int main(int argc, char* const argv[]) {
   NSAutoreleasePool* pool = [[NSAutoreleasePool alloc] init];
 
+  // basename() may modify the passed in string and it returns a pointer to an
+  // internal buffer. Give it a copy to modify, and copy what it returns.

[stuartmorgan, 2012/07/30 19:34:21]

You say "give it a copy", but you don't give it the copy. Did you mean
basename(worker)?

[TVL, 2012/07/30 20:10:17]

doh.  fixed.

+  char* worker = strdup(argv[0]);
   char* toolName = basename(argv[0]);
-  if (toolName != NULL)
-    gToolName = toolName;
+  if (toolName != NULL) {
+    toolName = strdup(toolName);
+    if (toolName != NULL)

[stuartmorgan, 2012/07/30 19:34:21]

Do we really need to handle OOM gracefully here? Seems like the chances that the
program is going to run successfully if we OOM on practically the first
allocation is roughly 0, so we may as well just ignore the failure case.

[TVL, 2012/07/30 20:10:17]

I'll remove them if you want, was just trying to be "correct" incase this gets
copied to other places, etc.

+      gToolName = toolName;
+  }
+  if (worker != NULL)

[stuartmorgan, 2012/07/30 19:34:21]

Same here.

+    free(worker);
 
   NSString* appPath = nil;
   NSString* appName = nil;
   NSString* sdkVersion = nil;
   NSString* deviceName = @"iPhone";
   NSString* simHomePath = nil;
   NSMutableArray* appArgs = [NSMutableArray array];
   NSMutableDictionary* appEnv = [NSMutableDictionary dictionary];
 
   // Parse the optional arguments
@@ skipping 41 matching lines @@
     appName = [appPath lastPathComponent];
     while (++optind < argc) {
       [appArgs addObject:[NSString stringWithUTF8String:argv[optind]]];
     }
   } else {
     LogError(@"Unable to parse command line arguments.");
     PrintUsage();
     exit(EXIT_FAILURE);
   }
 
+  // Figure out the developer dir.

[stuartmorgan, 2012/07/30 19:34:21]

Seems like these two comments don't add much, since they are followed by
self-explanatory method names.

[TVL, 2012/07/30 20:10:17]

removed.  Was just following the style of the next two ifs.

+  NSString* developerDir = FindDeveloperDir();
+  if (!developerDir) {
+    LogError(@"Unable to find developer directory.");
+    exit(EXIT_FAILURE);
+  }
+
+  // Load the Simulator Client framework.
+  NSBundle* simulatorFramework = LoadSimulatorFramework(developerDir);
+  if (!simulatorFramework) {
+    LogError(@"Failed to load the Simulator Framework.");
+    exit(EXIT_FAILURE);
+  }
+
   // Make sure the app path provided is legit.
   DTiPhoneSimulatorApplicationSpecifier* appSpec = BuildAppSpec(appPath);
   if (!appSpec) {
     LogError(@"Invalid app path: %@", appPath);
     exit(EXIT_FAILURE);
   }
 
   // Make sure the SDK path provided is legit (or nil).
   DTiPhoneSimulatorSystemRoot* systemRoot = BuildSystemRoot(sdkVersion);
   if (!systemRoot) {
@@ skipping 37 matching lines @@
 
   // Create the config and simulator session.
   DTiPhoneSimulatorSessionConfig* config = BuildSessionConfig(appSpec,
                                                               systemRoot,
                                                               stdioPath,
                                                               stdioPath,
                                                               appArgs,
                                                               appEnv,
                                                               deviceFamily);
   SimulatorDelegate* delegate =
-  [[[SimulatorDelegate alloc] initWithStdioPath:stdioPath] autorelease];
+      [[[SimulatorDelegate alloc] initWithStdioPath:stdioPath] autorelease];
   DTiPhoneSimulatorSession* session = BuildSession(delegate);
 
   // Start the simulator session.
   NSError* error;
   BOOL started = [session requestStartWithConfig:config
                                          timeout:kSessionStartTimeoutSeconds
                                            error:&error];
 
   // Spin the runtime indefinitely. When the delegate gets the message that the
   // app has quit it will exit this program.
   if (started)
     [[NSRunLoop mainRunLoop] run];
   else
     LogError(@"Simulator failed to start: %@", [error localizedDescription]);
 
   // Note that this code is only executed if the simulator fails to start
   // because once the main run loop is started, only the delegate calling
   // exit() will end the program.
   [pool drain];
   return EXIT_FAILURE;
 }