dist-apple: options::omit_keys leaves a defaulted Info.plist key out (#649 P1)

Author: Sunrisepeak

dist/apple.cppm

@@ -293,6 +293,17 @@ struct options {
     // `NSHighResolutionCapable`) are replaced by the project's value.
     std::string info_plist;
 
+    // DEFAULTED Info.plist KEYS TO LEAVE OUT (0.12.0). A property list has no
+    // null, so `info_plist` can replace a default's value but cannot remove the
+    // key; a project whose other build states neither `NSHighResolutionCapable`
+    // nor `LSRequiresIPhoneOS` names them here (#649 P1). Only the three keys
+    // this member defaults are accepted: a key it derives is refused by name, as
+    // `info_plist` refuses it, and so is any other key, which this member never
+    // writes. A key named here and also set by `info_plist` is refused, because
+    // the two statements contradict each other. A key that does not apply to the
+    // row (`UIDeviceFamily` on macOS) is accepted and changes nothing.
+    std::vector<std::string> omit_keys;
+
     // AN iOS DEVICE BUNDLE'S PROVISIONING PROFILE (0.11.0), manifest-relative or
     // absolute: embedded as `embedded.mobileprovision`, and, when `entitlements`
     // is empty, the source of the entitlements the bundle is signed with (the
@@ -948,6 +959,33 @@ inline plan plan_for(options opt = {}) {
         if (!read_info_plist_fragment(opt.info_plist, extraEntries, replacedKeys, message))
             return refuse(p, "unusable info_plist", message);
     }
+    for (std::size_t i = 0; i < opt.omit_keys.size(); ++i) {
+        const auto& key = opt.omit_keys[i];
+        if (std::ranges::find(derived_plist_keys(), key) != derived_plist_keys().end()) {
+            return refuse(p, "omit_keys names a derived key", std::format(
+                "mcpp.dist.apple: `options::omit_keys` names {}, which this member derives "
+                "from its options and the engine; a derived key cannot be omitted.", key));
+        }
+        if (std::ranges::find(defaulted_plist_keys(), key) == defaulted_plist_keys().end()) {
+            return refuse(p, "omit_keys names a key this member does not default", std::format(
+                "mcpp.dist.apple: `options::omit_keys` names {}, which this member does not "
+                "write; only UIDeviceFamily, LSRequiresIPhoneOS and NSHighResolutionCapable "
+                "can be omitted.", key));
+        }
+        if (std::find(opt.omit_keys.begin(), opt.omit_keys.begin() + static_cast<std::ptrdiff_t>(i), key)
+                != opt.omit_keys.begin() + static_cast<std::ptrdiff_t>(i)) {
+            return refuse(p, "omit_keys names a key twice", std::format(
+                "mcpp.dist.apple: `options::omit_keys` names {} twice.", key));
+        }
+        if (std::ranges::find(replacedKeys, key) != replacedKeys.end()) {
+            return refuse(p, "omit_keys and info_plist name one key", std::format(
+                "mcpp.dist.apple: `options::omit_keys` names {}, and `options::info_plist` ({}) "
+                "sets it; state one of the two.", key, opt.info_plist));
+        }
+    }
+    // An omitted default is written the way a replaced one is: not at all. The
+    // replaced list is what `plist_document` consults, so the two share it.
+    for (auto const& key : opt.omit_keys) replacedKeys.push_back(key);
     if (!opt.entitlements.empty() && !is_file(opt.entitlements)) {
         return refuse(p, "entitlements not found", std::format(
             "mcpp.dist.apple: the entitlements file {} was not found", opt.entitlements));

tests/ios-app-consumer/build.mcpp

@@ -26,8 +26,19 @@ int main() {
     // leave the options as they are, because the script passes every variable
     // to every row. The macOS runner's real pack names the first one too.
     for (const char* v : {"IOS_APP_CONSUMER_INFO_PLIST", "IOS_APP_CONSUMER_PROFILE",
-                          "IOS_APP_CONSUMER_NO_IDENTITY"})
+                          "IOS_APP_CONSUMER_NO_IDENTITY", "IOS_APP_CONSUMER_OMIT_KEYS"})
         mcpp::rerun_if_env_changed(v);
+    // 0.12.0: `options::omit_keys`, comma-separated in the variable.
+    if (const char* v = std::getenv("IOS_APP_CONSUMER_OMIT_KEYS"); v && *v) {
+        std::string list = v;
+        for (std::size_t b = 0; b <= list.size();) {
+            const auto e = list.find(',', b);
+            const auto key = list.substr(b, e == std::string::npos ? std::string::npos : e - b);
+            if (!key.empty()) opt.omit_keys.push_back(key);
+            if (e == std::string::npos) break;
+            b = e + 1;
+        }
+    }
     if (const char* v = std::getenv("IOS_APP_CONSUMER_INFO_PLIST"); v && *v) opt.info_plist = v;
     if (const char* v = std::getenv("IOS_APP_CONSUMER_PROFILE"); v && *v) opt.provisioning_profile = v;
     if (const char* v = std::getenv("IOS_APP_CONSUMER_NO_IDENTITY"); v && *v) opt.identity.clear();

tests/ios-app-consumer/check-ios-plan.sh

@@ -122,6 +122,7 @@ run_row() {
         IOS_APP_CONSUMER_INFO_PLIST="${IOS_APP_CONSUMER_INFO_PLIST:-}" \
         IOS_APP_CONSUMER_PROFILE="${IOS_APP_CONSUMER_PROFILE:-}" \
         IOS_APP_CONSUMER_NO_IDENTITY="${IOS_APP_CONSUMER_NO_IDENTITY:-}" \
+        IOS_APP_CONSUMER_OMIT_KEYS="${IOS_APP_CONSUMER_OMIT_KEYS:-}" \
         "$BIN" > "$log" 2>&1
     echo "$out"
 }
@@ -250,6 +251,40 @@ grep -q 'mcpp.dist.apple.layout' /tmp/ios-plan-sim-derived.log \
 unset IOS_APP_CONSUMER_INFO_PLIST
 echo "ok: an entry this member derives is refused, naming the key"
 
+# ── 0.12.0 ─────────────────────────────────────────────────────────────────
+echo "== 0.12.0: options::omit_keys leaves a defaulted key out =="
+export IOS_APP_CONSUMER_OMIT_KEYS="LSRequiresIPhoneOS"
+outdir=$(run_row simomit ios sim /tmp/ios-plan-sim-omit.log)
+plist="$outdir/IosAppConsumer-Info.plist"
+[ -f "$plist" ] || fail "no Info.plist written with options::omit_keys" /tmp/ios-plan-sim-omit.log
+grep -q '<key>LSRequiresIPhoneOS</key>' "$plist" && fail "LSRequiresIPhoneOS was written although omitted" "$plist"
+grep -q '<key>UIDeviceFamily</key>' "$plist" || fail "omitting one default removed another" "$plist"
+check_terminal_bundle /tmp/ios-plan-sim-omit.log
+export IOS_APP_CONSUMER_OMIT_KEYS="NSHighResolutionCapable,UIDeviceFamily"
+outdir=$(run_row macosomit macos "" /tmp/ios-plan-macos-omit.log)
+plist="$outdir/IosAppConsumer-Info.plist"
+grep -q '<key>NSHighResolutionCapable</key>' "$plist" && fail "NSHighResolutionCapable was written on macOS although omitted" "$plist"
+grep -q '<key>CFBundleExecutable</key>' "$plist" || fail "the macOS plist lost a derived key" "$plist"
+echo "ok: an omitted default is not written, on iOS and on macOS, and the rest of the plist is unchanged"
+
+export IOS_APP_CONSUMER_OMIT_KEYS="CFBundleIdentifier"
+run_row simomitderived ios sim /tmp/ios-plan-sim-omit-derived.log > /dev/null
+grep -q 'names CFBundleIdentifier, which this member derives' /tmp/ios-plan-sim-omit-derived.log \
+    || fail "omitting a derived key was not refused by name" /tmp/ios-plan-sim-omit-derived.log
+grep -q 'mcpp.dist.apple.layout' /tmp/ios-plan-sim-omit-derived.log \
+    && fail "steps were planned although omit_keys was refused" /tmp/ios-plan-sim-omit-derived.log
+export IOS_APP_CONSUMER_OMIT_KEYS="NSCameraUsageDescription"
+run_row simomitother ios sim /tmp/ios-plan-sim-omit-other.log > /dev/null
+grep -q 'names NSCameraUsageDescription, which this member does not write' /tmp/ios-plan-sim-omit-other.log \
+    || fail "omitting a key this member does not default was not refused by name" /tmp/ios-plan-sim-omit-other.log
+export IOS_APP_CONSUMER_OMIT_KEYS="UIDeviceFamily"
+export IOS_APP_CONSUMER_INFO_PLIST="$PWD/info-plist/usage.plist"
+run_row simomitboth ios sim /tmp/ios-plan-sim-omit-both.log > /dev/null
+grep -q 'names UIDeviceFamily, and `options::info_plist`' /tmp/ios-plan-sim-omit-both.log \
+    || fail "a key both omitted and set by info_plist was not refused" /tmp/ios-plan-sim-omit-both.log
+unset IOS_APP_CONSUMER_OMIT_KEYS IOS_APP_CONSUMER_INFO_PLIST
+echo "ok: omitting a derived key, a key this member does not write, or a key info_plist sets is refused by name"
+
 # A provisioning profile is a CMS-signed plist; the member reads the plist from
 # between its markers, so a plan needs only those bytes framed by binary data.
 make_profile() {  # make_profile <file> <application-identifier>