feat(ios): allow for external xctest file

Author: hannojg

packages/platform-ios/src/xctest-agent.ts

@@ -29,6 +29,9 @@ const XCTEST_AGENT_SCHEME_NAME = 'HarnessXCTestAgent';
 const XCTEST_AGENT_PORT_ENV = 'HARNESS_XCTEST_AGENT_PORT';
 const XCTEST_AGENT_TARGET_BUNDLE_ID_ENV =
   'HARNESS_XCTEST_AGENT_TARGET_BUNDLE_ID';
+const XCTEST_AGENT_XCTESTRUN_FILE_ENV = 'HARNESS_IOS_XCTESTRUN_FILE';
+const XCTEST_AGENT_DERIVED_DATA_PATH_ENV =
+  'HARNESS_IOS_XCTEST_DERIVED_DATA_PATH';
 const XCTEST_AGENT_STARTUP_TIMEOUT_MS = 120_000;
 const XCTEST_AGENT_SHUTDOWN_TIMEOUT_MS = 5_000;
 const XCTEST_AGENT_STARTUP_POLL_INTERVAL_MS = 250;
@@ -125,6 +128,34 @@ const getXCTestAgentDerivedDataPath = (target: XCTestAgentTarget): string => {
   return path.join(getXCTestAgentBuildRoot(), target.kind);
 };
 
+const getEnvironmentPath = (name: string): string | null => {
+  const value = process.env[name]?.trim();
+
+  if (!value) {
+    return null;
+  }
+
+  return value;
+};
+
+const getExternalXCTestRunFilePath = (): string | null => {
+  return getEnvironmentPath(XCTEST_AGENT_XCTESTRUN_FILE_ENV);
+};
+
+const getExternalDerivedDataPath = (): string | null => {
+  return getEnvironmentPath(XCTEST_AGENT_DERIVED_DATA_PATH_ENV);
+};
+
+const assertExternalXCTestRunFileExists = (filePath: string) => {
+  if (fs.existsSync(filePath)) {
+    return;
+  }
+
+  throw new Error(
+    `Missing external XCTest run file at ${filePath}. Check ${XCTEST_AGENT_XCTESTRUN_FILE_ENV}.`
+  );
+};
+
 const getXCTestAgentBuildManifestPath = (derivedDataPath: string): string =>
   path.join(derivedDataPath, 'build-manifest.json');
 
@@ -724,6 +755,24 @@ export const createXCTestAgentController = (options: {
       return;
     }
 
+    const externalXCTestRunFilePath = getExternalXCTestRunFilePath();
+    if (externalXCTestRunFilePath) {
+      assertExternalXCTestRunFileExists(externalXCTestRunFilePath);
+
+      const externalDerivedDataPath = getExternalDerivedDataPath();
+      if (externalDerivedDataPath) {
+        preparedDerivedDataPath = externalDerivedDataPath;
+      }
+
+      prepared = true;
+      xctestAgentLogger.info(
+        'Using external XCTest run file for %s target: %s',
+        target.kind,
+        externalXCTestRunFilePath
+      );
+      return;
+    }
+
     const buildInputsHash = getProjectInputsHash();
 
     xctestAgentLogger.debug(
@@ -841,12 +890,23 @@ export const createXCTestAgentController = (options: {
       target.kind
     );
     xctestAgentLogger.debug('Using XCTest agent port %d', port);
+    const externalXCTestRunFilePath = getExternalXCTestRunFilePath();
+    let xcodebuildRunInputArgs: string[];
+
+    if (externalXCTestRunFilePath) {
+      xcodebuildRunInputArgs = ['-xctestrun', externalXCTestRunFilePath];
+    } else {
+      xcodebuildRunInputArgs = [
+        '-project',
+        getXCTestAgentProjectFilePath(),
+        '-scheme',
+        XCTEST_AGENT_SCHEME_NAME,
+      ];
+    }
+
     const xcodebuildArgs = [
       'test-without-building',
-      '-project',
-      getXCTestAgentProjectFilePath(),
-      '-scheme',
-      XCTEST_AGENT_SCHEME_NAME,
+      ...xcodebuildRunInputArgs,
       '-destination',
       getXCTestAgentRunDestination(target),
       '-parallel-testing-enabled',