test: add tests for the JS-based Xcode project generator (#2425)

Author: tido64

ios/app.mjs

@@ -4,7 +4,7 @@ import * as path from "node:path";
 import { URL, fileURLToPath } from "node:url";
 import { loadAppConfig } from "../scripts/appConfig.mjs";
 import { findFile, readTextFile, toVersionNumber } from "../scripts/helpers.js";
-import { cp_r, mkdir_p } from "../scripts/utils/filesystem.mjs";
+import { cp_r, mkdir_p, rm_r } from "../scripts/utils/filesystem.mjs";
 import { generateAssetsCatalogs } from "./assetsCatalog.mjs";
 import { generateEntitlements } from "./entitlements.mjs";
 import { generateInfoPlist } from "./infoPlist.mjs";
@@ -34,13 +34,23 @@ import {
 
 const SUPPORTED_PLATFORMS = ["ios", "macos", "visionos"];
 
+/**
+ * @param {string} platform
+ * @returns {asserts platform is ApplePlatform}
+ */
+function assertSupportedPlatform(platform) {
+  if (!SUPPORTED_PLATFORMS.includes(platform)) {
+    throw new Error(`Unsupported platform: ${platform}`);
+  }
+}
+
 /**
  * @param {string} projectRoot
  * @param {string} destination
  * @returns {void}
  */
 function exportNodeBinaryPath(projectRoot, destination, fs = nodefs) {
-  const node = process.argv0;
+  const node = process.argv[0];
   fs.writeFileSync(
     path.join(projectRoot, ".xcode.env"),
     `export NODE_BINARY='${node}'\n`
@@ -99,7 +109,7 @@ function readPackageVersion(p, fs = nodefs) {
 
 /**
  * @param {string} projectRoot
- * @param {ApplePlatform} targetPlatform
+ * @param {string} targetPlatform
  * @param {JSONObject} options
  * @returns {ProjectConfiguration}
  */
@@ -109,9 +119,7 @@ export function generateProject(
   options,
   fs = nodefs
 ) {
-  if (!SUPPORTED_PLATFORMS.includes(targetPlatform)) {
-    throw new Error(`Unsupported platform: ${targetPlatform}`);
-  }
+  assertSupportedPlatform(targetPlatform);
 
   const appConfig = loadAppConfig(projectRoot, fs);
 
@@ -134,15 +142,19 @@ export function generateProject(
   // Link source files
   const srcDirs = ["ReactTestApp", "ReactTestAppTests", "ReactTestAppUITests"];
   for (const file of srcDirs) {
-    fs.linkSync(projectPath(file, targetPlatform), destination);
+    const symlink = path.join(destination, file);
+    if (fs.existsSync(symlink)) {
+      rm_r(symlink, fs);
+    }
+    fs.symlinkSync(projectPath(file, targetPlatform), symlink);
   }
 
   // Shared code lives in `ios/ReactTestApp/`
   if (targetPlatform !== "ios") {
     const shared = path.join(destination, "Shared");
     if (!fs.existsSync(shared)) {
       const source = new URL("ReactTestApp", import.meta.url);
-      fs.linkSync(fileURLToPath(source), shared);
+      fs.symlinkSync(fileURLToPath(source), shared);
     }
   }
 
@@ -168,8 +180,8 @@ export function generateProject(
 
   /** @type {ProjectConfiguration} */
   const project = {
-    xcodeprojPath: xcodeprojDst,
-    reactNativePath,
+    xcodeprojPath: path.resolve(xcodeprojDst),
+    reactNativePath: path.resolve(reactNativePath),
     reactNativeVersion,
     useNewArch,
     useBridgeless,
@@ -178,9 +190,7 @@ export function generateProject(
     uitestsBuildSettings: {},
   };
 
-  if (isObject(platformConfig)) {
-    applyBuildSettings(platformConfig, project, projectRoot, destination, fs);
-  }
+  applyBuildSettings(platformConfig, project, projectRoot, destination, fs);
 
   const overrides = options["buildSettingOverrides"];
   if (isObject(overrides)) {

ios/assetsCatalog.mjs

@@ -92,7 +92,7 @@ export function generateAssetsCatalogs(
   const xcassets_dst = path.join(destination, path.basename(xcassets_src));
 
   rm_r(xcassets_dst, fs);
-  cp_r(xcassets_src, xcassets_dst, fs);
+  cp_r(xcassets_src, destination, fs);
 
   const platformConfig = appConfig[targetPlatform];
   if (!isObject(platformConfig)) {

ios/utils.mjs

@@ -68,7 +68,7 @@ export function plistFromJSON(source, filename) {
  */
 export function projectPath(p, targetPlatform) {
   const packageDir = path.dirname(path.dirname(fileURLToPath(import.meta.url)));
-  return path.join(packageDir, targetPlatform, p);
+  return path.resolve(packageDir, targetPlatform, p);
 }
 
 /**

ios/xcode.mjs

@@ -9,6 +9,7 @@ import { isObject, isString } from "./utils.mjs";
  * @import {
  *   ApplePlatform,
  *   JSONObject,
+ *   JSONValue,
  *   ProjectConfiguration,
  *   XmlOptions,
  * } from "../scripts/types.js";
@@ -32,7 +33,7 @@ export const USER_HEADER_SEARCH_PATHS = "USER_HEADER_SEARCH_PATHS";
 export const WARNING_CFLAGS = "WARNING_CFLAGS";
 
 /**
- * @param {JSONObject} platformConfig
+ * @param {JSONValue} platformConfig
  * @param {ProjectConfiguration} project
  * @param {string} projectRoot
  * @param {string} destination
@@ -45,7 +46,9 @@ export function applyBuildSettings(
   destination,
   fs = nodefs
 ) {
-  const codeSignEntitlements = platformConfig["codeSignEntitlements"];
+  const config = isObject(platformConfig) ? platformConfig : {};
+
+  const codeSignEntitlements = config["codeSignEntitlements"];
   if (isString(codeSignEntitlements)) {
     const appManifest = findFile("app.json", projectRoot, fs);
     if (!appManifest) {
@@ -58,19 +61,19 @@ export function applyBuildSettings(
     project.buildSettings[CODE_SIGN_ENTITLEMENTS] = relPath;
   }
 
-  const codeSignIdentity = platformConfig["codeSignIdentity"];
+  const codeSignIdentity = config["codeSignIdentity"];
   if (isString(codeSignIdentity)) {
     project.buildSettings[CODE_SIGN_IDENTITY] = codeSignIdentity;
   }
 
-  const developmentTeam = platformConfig["developmentTeam"];
+  const developmentTeam = config["developmentTeam"];
   if (isString(developmentTeam)) {
     project.buildSettings[DEVELOPMENT_TEAM] = developmentTeam;
     project.testsBuildSettings[DEVELOPMENT_TEAM] = developmentTeam;
     project.uitestsBuildSettings[DEVELOPMENT_TEAM] = developmentTeam;
   }
 
-  const bundleIdentifier = platformConfig["bundleIdentifier"];
+  const bundleIdentifier = config["bundleIdentifier"];
   if (isString(bundleIdentifier)) {
     project.buildSettings[PRODUCT_BUNDLE_IDENTIFIER] = bundleIdentifier;
     project.testsBuildSettings[PRODUCT_BUNDLE_IDENTIFIER] =
@@ -79,7 +82,7 @@ export function applyBuildSettings(
       `${bundleIdentifier}UITests`;
   }
 
-  const buildNumber = platformConfig["buildNumber"];
+  const buildNumber = config["buildNumber"];
   project.buildSettings[PRODUCT_BUILD_NUMBER] =
     buildNumber && isString(buildNumber) ? buildNumber : "1";
 
@@ -161,7 +164,7 @@ export function applyUserHeaderSearchPaths({ buildSettings }, destination) {
   const existingPaths = buildSettings[USER_HEADER_SEARCH_PATHS];
   const searchPaths = Array.isArray(existingPaths) ? existingPaths : [];
 
-  searchPaths.push(path.dirname(destination));
+  searchPaths.push(path.resolve(path.dirname(destination)));
 
   buildSettings[USER_HEADER_SEARCH_PATHS] = searchPaths;
 }

scripts/appConfig.mjs

@@ -6,19 +6,17 @@ import { findFile, readJSONFile } from "./helpers.js";
 
 const SOURCE_KEY = Symbol.for("source");
 
-/** @type {JSONObject} */
-let appConfig;
-
 /**
  * @param {string} projectRoot
  * @returns {JSONObject}
  */
 export function loadAppConfig(projectRoot, fs = nodefs) {
-  if (!appConfig) {
-    const configFile = findFile("app.json", projectRoot, fs);
-    appConfig = configFile ? readJSONFile(configFile) : {};
-    appConfig[SOURCE_KEY] = configFile || projectRoot;
-  }
+  const configFile = findFile("app.json", projectRoot, fs);
+
+  /** @type {JSONObject} */
+  const appConfig = configFile ? readJSONFile(configFile, fs) : {};
+  appConfig[SOURCE_KEY] = configFile || projectRoot;
+
   return appConfig;
 }
 

test/fs.mock.ts

@@ -1,11 +1,47 @@
 /* node:coverage disable */
 import type { DirectoryJSON } from "memfs";
 import { fs as memfs, vol } from "memfs";
+import * as path from "node:path";
+import { mkdir_p } from "../scripts/utils/filesystem.mjs";
 
 export const fs = memfs as unknown as typeof import("node:fs");
 
-// Stub `cpSync` until memfs implements it
-fs.cpSync = fs.cpSync ?? (() => undefined);
+// Add simple `cpSync` implementation until memfs implements it
+fs.cpSync =
+  fs.cpSync ??
+  ((src: string, dst: string, options) => {
+    const srcStat = fs.statSync(src);
+    const dstStat = fs.statSync(dst);
+    if (!srcStat.isDirectory()) {
+      const finalDst = dstStat.isDirectory()
+        ? path.join(dst, path.basename(src))
+        : dst;
+      return fs.copyFileSync(src, finalDst);
+    }
+
+    let finalDst: string;
+    if (!dstStat.isDirectory()) {
+      fs.rmSync(dst);
+      finalDst = dst;
+    } else {
+      finalDst = path.join(dst, path.basename(src));
+    }
+
+    mkdir_p(finalDst, fs);
+    for (const filename of fs.readdirSync(src)) {
+      const p = path.join(src, filename);
+      const pStat = fs.statSync(p);
+      if (pStat.isDirectory()) {
+        if (options?.recursive) {
+          fs.cpSync(p, finalDst, options);
+        } else {
+          mkdir_p(path.join(finalDst, filename));
+        }
+      } else {
+        fs.copyFileSync(p, path.join(finalDst, filename));
+      }
+    }
+  });
 
 export function setMockFiles(files: DirectoryJSON = {}) {
   vol.reset();