[MacCatalyst] Added Default Entitlements for MacCatalyst projects #18669

dustin-wojciechowski · 2023-08-08T20:46:49Z

Added default entitlements for MacCatalyst projects. For Debug, an entitlement that allows for using developer tools when developing blazor apps. For release, entitlements required by Apple to publish to the App Store.

Also added unit test to check for entitlements when project is created.

Fixes #18344

…titlement that allows for using developer tools when developing blazor apps. For release, entitlements required by Apple to publish to the App Store. Also added unit test to check for entitlements when project is created.

github-actions · 2023-08-08T20:51:13Z

⚠️ Your code has been reformatted. ⚠️

If this is not desired, add the actions-disable-autoformat label, and revert the reformatting commit.

If files unrelated to your change were modified, try reverting the reformatting commit + merging with the target branch (and push those changes).

mandel-macaque · 2023-08-08T21:09:20Z

dotnet/targets/Xamarin.Shared.Sdk.DefaultItems.targets

+  </PropertyGroup>
+
+  <ItemGroup Condition="'$(EnableDefaultMacCatalystDebugEntitlements)' == 'True' and '$(Configuration)' == 'Debug'">
+    <CustomEntitlements Include="com.apple.security.get-task-allow" Type="boolean" Value="true" />


+1 On debugging: https://developer.apple.com/documentation/security/notarizing_macos_software_before_distribution/resolving_common_notarization_issues#3087731

Being that this isn't part of the Release configuration and only Debug, and that this is something that Xcode adds in itself to enable web debugging, wouldn't this be fine? I'll add an assert in the unit test to make sure it's not being passed into the release configuration.

mandel-macaque · 2023-08-08T21:09:35Z

dotnet/targets/Xamarin.Shared.Sdk.DefaultItems.targets

+  </ItemGroup>
+
+  <ItemGroup Condition="'$(EnableDefaultMacCatalystReleaseEntitlements)' == 'True' and '$(Configuration)' == 'Release'">
+    <CustomEntitlements Include="com.apple.security.app-sandbox" Type="boolean" Value="true" />


+1 since it allows sandboxing on catalyst apps: https://developer.apple.com/documentation/bundleresources/entitlements/com_apple_security_app-sandbox

I was under the impression that Xcode also automatically adds this entitlement for apps that run on MacOS: https://developer.apple.com/documentation/uikit/mac_catalyst/creating_a_mac_version_of_your_ipad_app

@rolfbjarne Should app-sandbox get the same treatment as network.client? MAUI wanted this in our sdk.. can you publish Mac Catalyst apps in the Mac App Store without this entitlement?

can you publish Mac Catalyst apps in the Mac App Store without this entitlement?

No: "To distribute a macOS app through the Mac App Store, you must enable the App Sandbox capability."

dotnet/targets/Xamarin.Shared.Sdk.DefaultItems.targets

haritha-mohan · 2023-08-09T00:48:58Z

tests/dotnet/UnitTests/ProjectTest.cs

+			var executable = GetNativeExecutable (platform, appPath);
+			var foundEntitlements = TryGetEntitlements (executable, out var entitlements);
+			if (configuration == "Release") {
+				Assert.IsTrue (foundEntitlements, "Found in Release");
+				Assert.IsTrue (entitlements!.Get<PBoolean> ("com.apple.security.app-sandbox")?.Value, "com.apple.security.app-sandbox enlistment was not found.");
+				Assert.IsTrue (entitlements!.Get<PBoolean> ("com.apple.security.network.client")?.Value, "com.apple.security.network.client enlistment was not found.");
+			} else if (configuration == "Debug") {
+				Assert.IsTrue (foundEntitlements, "Found in Debug");
+				Assert.IsTrue (entitlements!.Get<PBoolean> ("com.apple.security.get-task-allow")?.Value, "com.apple.security.get-task-allow enlistment was not found.");
+			}


i understand this format is consistent with the other tests.. but i wonder if it may be better to have a separate test per config? it might be a bit more verbose but in the future if there are more entitlements added it might be easier to keep track of and the test failure will speak for itself

otherwise lgtm

Suggested change

var executable = GetNativeExecutable (platform, appPath);

var foundEntitlements = TryGetEntitlements (executable, out var entitlements);

if (configuration == "Release") {

Assert.IsTrue (foundEntitlements, "Found in Release");

Assert.IsTrue (entitlements!.Get<PBoolean> ("com.apple.security.app-sandbox")?.Value, "com.apple.security.app-sandbox enlistment was not found.");

Assert.IsTrue (entitlements!.Get<PBoolean> ("com.apple.security.network.client")?.Value, "com.apple.security.network.client enlistment was not found.");

} else if (configuration == "Debug") {

Assert.IsTrue (foundEntitlements, "Found in Debug");

Assert.IsTrue (entitlements!.Get<PBoolean> ("com.apple.security.get-task-allow")?.Value, "com.apple.security.get-task-allow enlistment was not found.");

}

var executable = GetNativeExecutable (platform, appPath);

TryGetEntitlements (executable, out var entitlements);

if(entitlements is null)

Assert.Fail("no entitlements found");

// debug test

Assert.IsTrue (entitlements.Get<PBoolean> ("com.apple.security.app-sandbox")?.Value, "com.apple.security.app-sandbox enlistment was not found.");

// release test

Assert.IsTrue (entitlements.Get<PBoolean> ("com.apple.security.app-sandbox")?.Value, "com.apple.security.app-sandbox enlistment was not found.");

Assert.IsTrue (entitlements.Get<PBoolean> ("com.apple.security.network.client")?.Value, "com.apple.security.network.client enlistment was not found.");

dotnet/targets/Xamarin.Shared.Sdk.DefaultItems.targets

tests/dotnet/UnitTests/ProjectTest.cs

dotnet/targets/Xamarin.Shared.Sdk.DefaultItems.targets

tj-devel709

Aside from other comments, LGTM! Cool work!

Added missing character. Co-authored-by: Rolf Bjarne Kvinge <rolf@xamarin.com>

vs-mobiletools-engineering-service2 · 2023-08-25T17:37:49Z

✅ API diff for current PR / commit

Legacy Xamarin (No breaking changes)

~~iOS~~ (no change detected)
~~tvOS~~ (no change detected)
~~watchOS~~ (no change detected)
~~macOS~~ (no change detected)

NET (empty diffs)

~~iOS~~: (empty diff detected)
~~tvOS~~: (empty diff detected)
~~MacCatalyst~~: (empty diff detected)
~~macOS~~: (empty diff detected)

✅ API diff vs stable

Legacy Xamarin (No breaking changes)

iOS: vsdrops gist (No breaking changes)
tvOS: vsdrops gist (No breaking changes)
watchOS: vsdrops gist (No breaking changes)
macOS: vsdrops gist (No breaking changes)

.NET (No breaking changes)

iOS: vsdrops gist (No breaking changes)
tvOS: vsdrops gist (No breaking changes)
MacCatalyst: vsdrops gist (No breaking changes)
macOS: vsdrops gist (No breaking changes)
Microsoft.iOS vs Microsoft.MacCatalyst: vsdrops gist

Legacy Xamarin (stable) vs .NET

iOS: vsdrops gist
tvOS: vsdrops gist
macOS: vsdrops gist

✅ Generator diff

Generator diff is empty

Pipeline on Agent
Hash: 2be6ea2f3634c9e494d506fcbb7fdea3d493c2d9 [PR build]

vs-mobiletools-engineering-service2 · 2023-08-26T00:21:23Z

💻 [CI Build] Windows Integration Tests passed 💻

✅ All Windows Integration Tests passed.

Pipeline on Agent
Hash: 2be6ea2f3634c9e494d506fcbb7fdea3d493c2d9 [PR build]

vs-mobiletools-engineering-service2 · 2023-08-26T00:25:22Z

💻 [PR Build] Tests on macOS M1 - Mac Big Sur (11.5) passed 💻

✅ All tests on macOS M1 - Mac Big Sur (11.5) passed.

Pipeline on Agent
Hash: [PR build]

vs-mobiletools-engineering-service2 · 2023-08-26T00:25:27Z

💻 [PR Build] Tests on macOS M1 - Mac Ventura (13.0) passed 💻

✅ All tests on macOS M1 - Mac Ventura (13.0) passed.

Pipeline on Agent
Hash: [PR build]

vs-mobiletools-engineering-service2 · 2023-08-26T00:30:32Z

📚 [PR Build] Artifacts 📚

Packages generated

View packages

Pipeline on Agent
Hash: [PR build]

vs-mobiletools-engineering-service2 · 2023-08-28T13:32:57Z

🚀 [CI Build] Test results 🚀

Test results

✅ All tests passed on VSTS: simulator tests.

🎉 All 235 tests passed 🎉

Tests counts

✅ bcl: All 69 tests passed. Html Report (VSDrops) Download
✅ cecil: All 1 tests passed. Html Report (VSDrops) Download
✅ dotnettests: All 1 tests passed. Html Report (VSDrops) Download
✅ fsharp: All 7 tests passed. Html Report (VSDrops) Download
✅ framework: All 8 tests passed. Html Report (VSDrops) Download
✅ generator: All 2 tests passed. Html Report (VSDrops) Download
✅ interdependent_binding_projects: All 7 tests passed. Html Report (VSDrops) Download
✅ install_source: All 1 tests passed. Html Report (VSDrops) Download
✅ introspection: All 8 tests passed. Html Report (VSDrops) Download
✅ linker: All 65 tests passed. Html Report (VSDrops) Download
✅ mac_binding_project: All 1 tests passed. Html Report (VSDrops) Download
✅ mmp: All 2 tests passed. Html Report (VSDrops) Download
✅ mononative: All 12 tests passed. Html Report (VSDrops) Download
✅ monotouch: All 35 tests passed. [attempt 2] Html Report (VSDrops) Download
✅ msbuild: All 2 tests passed. Html Report (VSDrops) Download
✅ mtouch: All 1 tests passed. Html Report (VSDrops) Download
✅ xammac: All 3 tests passed. Html Report (VSDrops) Download
✅ xcframework: All 8 tests passed. Html Report (VSDrops) Download
✅ xtro: All 2 tests passed. Html Report (VSDrops) Download

Pipeline on Agent
Hash: 2be6ea2f3634c9e494d506fcbb7fdea3d493c2d9 [PR build]

…ects (#18669)" This reverts commit 1b016fa.

…ects" (#19125) Reverts #18669 per discussion in MAUI about sdk defaults.

…ects (xamarin#18669)" This reverts commit 1b016fa.

…r MacCatalyst projects" (#19171) Reverts #18669 per discussion in MAUI about sdk defaults. See dotnet/maui#16355 for more information. Consult teams thread for more information: https://teams.microsoft.com/l/message/19:989ffa44998147aca4ceaf7482967668@thread.skype/1696009594958?tenantId=72f988bf-86f1-41af-91ab-2d7cd011db47&groupId=0056f60b-301f-43ac-bbcf-f356d3c42c92&parentMessageId=1696009594958&teamName=VS%20Client%20Experiences&channelName=MAUI%20??&createdTime=1696009594958 (MSFT only) Backport of #19125 Co-authored-by: dustin-wojciechowski <dustin.wojciechowski@microsoft.com>

…nts for MacCatalyst projects" (#19172) Reverts #18669 per discussion in MAUI about sdk defaults. See dotnet/maui#16355 for more information. Consult teams thread for more information: https://teams.microsoft.com/l/message/19:989ffa44998147aca4ceaf7482967668@thread.skype/1696009594958?tenantId=72f988bf-86f1-41af-91ab-2d7cd011db47&groupId=0056f60b-301f-43ac-bbcf-f356d3c42c92&parentMessageId=1696009594958&teamName=VS%20Client%20Experiences&channelName=MAUI%20??&createdTime=1696009594958 (MSFT only) Backport of #19125 Co-authored-by: dustin-wojciechowski <dustin.wojciechowski@microsoft.com>

dustin-wojciechowski and others added 2 commits August 8, 2023 13:44

Auto-format source code

f43ae76

Merge branch 'main' into dev/default-entitlements-for-maccatalyst

483d2ea

dustin-wojciechowski marked this pull request as ready for review August 8, 2023 20:54

dustin-wojciechowski requested a review from rolfbjarne August 8, 2023 20:55

dustin-wojciechowski added Mac Catalyst Issues affecting Mac Catalyst msbuild Issues affecting our msbuild tasks/targets labels Aug 8, 2023

dalexsoto approved these changes Aug 8, 2023

View reviewed changes

mandel-macaque reviewed Aug 8, 2023

View reviewed changes

This comment has been minimized.

Sign in to view

haritha-mohan approved these changes Aug 9, 2023

View reviewed changes

This comment has been minimized.

Sign in to view

rolfbjarne requested changes Aug 9, 2023

View reviewed changes

dotnet/targets/Xamarin.Shared.Sdk.DefaultItems.targets Outdated Show resolved Hide resolved

tests/dotnet/UnitTests/ProjectTest.cs Outdated Show resolved Hide resolved

tests/dotnet/UnitTests/ProjectTest.cs Outdated Show resolved Hide resolved

mandel-macaque requested changes Aug 9, 2023

View reviewed changes

dotnet/targets/Xamarin.Shared.Sdk.DefaultItems.targets Outdated Show resolved Hide resolved

tj-devel709 approved these changes Aug 9, 2023

View reviewed changes

This was referenced Aug 16, 2023

Remove Debug and Release Entitlements plists and Replace with Custom Entitlements dotnet/maui#16355

Closed

Updated Templates for Blazor apps for MacCatalyst dotnet/maui#14196

Merged

Merge branch 'main' into dev/default-entitlements-for-maccatalyst

4892823

This comment has been minimized.

Sign in to view

Removed network.client entitlement

bcae3c0

This comment has been minimized.

Sign in to view

dustin-wojciechowski and others added 2 commits August 23, 2023 08:11

Update dotnet/targets/Xamarin.Shared.Sdk.DefaultItems.targets

f84522c

Added missing character. Co-authored-by: Rolf Bjarne Kvinge <rolf@xamarin.com>

Merge branch 'main' into dev/default-entitlements-for-maccatalyst

2a79af0

This comment has been minimized.

Sign in to view

rolfbjarne approved these changes Aug 24, 2023

View reviewed changes

This comment has been minimized.

Sign in to view

Merge branch 'main' into dev/default-entitlements-for-maccatalyst

2be6ea2

This comment has been minimized.

Sign in to view

mandel-macaque approved these changes Aug 26, 2023

View reviewed changes

dustin-wojciechowski merged commit 1b016fa into main Aug 28, 2023

dustin-wojciechowski deleted the dev/default-entitlements-for-maccatalyst branch August 28, 2023 16:14

dustin-wojciechowski added a commit that referenced this pull request Oct 4, 2023

Revert "[MacCatalyst] Added Default Entitlements for MacCatalyst proj…

862aa92

…ects (#18669)" This reverts commit 1b016fa.

dustin-wojciechowski mentioned this pull request Oct 4, 2023

Revert "[MacCatalyst] Added Default Entitlements for MacCatalyst projects" #19125

Merged

dustin-wojciechowski added a commit that referenced this pull request Oct 6, 2023

Revert "[MacCatalyst] Added Default Entitlements for MacCatalyst proj…

a64506d

…ects" (#19125) Reverts #18669 per discussion in MAUI about sdk defaults.

vs-mobiletools-engineering-service2 pushed a commit to vs-mobiletools-engineering-service2/xamarin-macios that referenced this pull request Oct 12, 2023

Revert "[MacCatalyst] Added Default Entitlements for MacCatalyst proj…

40e08ac

…ects (xamarin#18669)" This reverts commit 1b016fa.

vs-mobiletools-engineering-service2 mentioned this pull request Oct 12, 2023

[release/8.0.1xx] Revert "[MacCatalyst] Added Default Entitlements for MacCatalyst projects" #19171

Merged

vs-mobiletools-engineering-service2 pushed a commit to vs-mobiletools-engineering-service2/xamarin-macios that referenced this pull request Oct 12, 2023

Revert "[MacCatalyst] Added Default Entitlements for MacCatalyst proj…

c902351

…ects (xamarin#18669)" This reverts commit 1b016fa.

vs-mobiletools-engineering-service2 mentioned this pull request Oct 12, 2023

[release/8.0.1xx-rc2.1] Revert "[MacCatalyst] Added Default Entitlements for MacCatalyst projects" #19172

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[MacCatalyst] Added Default Entitlements for MacCatalyst projects #18669

[MacCatalyst] Added Default Entitlements for MacCatalyst projects #18669

dustin-wojciechowski commented Aug 8, 2023

github-actions bot commented Aug 8, 2023

mandel-macaque Aug 8, 2023

dustin-wojciechowski Aug 21, 2023

mandel-macaque Aug 8, 2023

dustin-wojciechowski Aug 21, 2023

rolfbjarne Aug 24, 2023

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

haritha-mohan Aug 9, 2023

This comment has been minimized.

tj-devel709 left a comment

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

vs-mobiletools-engineering-service2 commented Aug 25, 2023

vs-mobiletools-engineering-service2 commented Aug 26, 2023

vs-mobiletools-engineering-service2 commented Aug 26, 2023

vs-mobiletools-engineering-service2 commented Aug 26, 2023

vs-mobiletools-engineering-service2 commented Aug 26, 2023

This comment has been minimized.

vs-mobiletools-engineering-service2 commented Aug 28, 2023

[MacCatalyst] Added Default Entitlements for MacCatalyst projects #18669

[MacCatalyst] Added Default Entitlements for MacCatalyst projects #18669

Conversation

dustin-wojciechowski commented Aug 8, 2023

github-actions bot commented Aug 8, 2023

⚠️ Your code has been reformatted. ⚠️

mandel-macaque Aug 8, 2023

Choose a reason for hiding this comment

dustin-wojciechowski Aug 21, 2023

Choose a reason for hiding this comment

mandel-macaque Aug 8, 2023

Choose a reason for hiding this comment

dustin-wojciechowski Aug 21, 2023

Choose a reason for hiding this comment

rolfbjarne Aug 24, 2023

Choose a reason for hiding this comment

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

haritha-mohan Aug 9, 2023

Choose a reason for hiding this comment

This comment has been minimized.

tj-devel709 left a comment

Choose a reason for hiding this comment

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

vs-mobiletools-engineering-service2 commented Aug 25, 2023

✅ API diff for current PR / commit

✅ API diff vs stable

✅ Generator diff

vs-mobiletools-engineering-service2 commented Aug 26, 2023

💻 [CI Build] Windows Integration Tests passed 💻

vs-mobiletools-engineering-service2 commented Aug 26, 2023

💻 [PR Build] Tests on macOS M1 - Mac Big Sur (11.5) passed 💻

vs-mobiletools-engineering-service2 commented Aug 26, 2023

💻 [PR Build] Tests on macOS M1 - Mac Ventura (13.0) passed 💻

vs-mobiletools-engineering-service2 commented Aug 26, 2023

📚 [PR Build] Artifacts 📚

Packages generated

This comment has been minimized.

vs-mobiletools-engineering-service2 commented Aug 28, 2023

🚀 [CI Build] Test results 🚀

Test results

Tests counts